From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.devel,gmane.emacs.orgmode Subject: Re: [FR] Allow flattened imenu index Date: Mon, 11 Dec 2023 19:20:51 +0200 Organization: LINKOV.NET Message-ID: <86zfyg3jgs.fsf@mail.linkov.net> References: <87plzgbalt.fsf@localhost> <87msujskxg.fsf@localhost> <835y17y5qu.fsf@gnu.org> <874jgrsiyy.fsf@localhost> <86r0jv8efr.fsf@mail.linkov.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25377"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/30.0.50 (x86_64-pc-linux-gnu) Cc: Ihor Radchenko , Eli Zaretskii , Morgan.J.Smith@outlook.com, emacs-orgmode@gnu.org, 58131@debbugs.gnu.org, emacs-devel@gnu.org To: =?iso-8859-1?Q?Jo=E3o_T=E1vora?= Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Dec 11 18:22:50 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rCjzV-0006T3-Na for ged-emacs-devel@m.gmane-mx.org; Mon, 11 Dec 2023 18:22:49 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rCjyY-0005HU-RZ; Mon, 11 Dec 2023 12:21:50 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rCjyX-0005HI-I8; Mon, 11 Dec 2023 12:21:49 -0500 Original-Received: from relay6-d.mail.gandi.net ([2001:4b98:dc4:8::226]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rCjyU-0002j5-9b; Mon, 11 Dec 2023 12:21:49 -0500 Original-Received: by mail.gandi.net (Postfix) with ESMTPSA id AE18EC0006; Mon, 11 Dec 2023 17:21:41 +0000 (UTC) In-Reply-To: (=?iso-8859-1?Q?=22Jo=E3o_T=E1vora=22's?= message of "Mon, 11 Dec 2023 11:51:03 +0000") X-GND-Sasl: juri@linkov.net Received-SPF: pass client-ip=2001:4b98:dc4:8::226; envelope-from=juri@linkov.net; helo=relay6-d.mail.gandi.net X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:313706 gmane.emacs.orgmode:158545 Archived-At: >> menu1 >> sub-item1 >> sub-item2 >> >> could be flattened to >> >> menu1 -> sub-item1 >> menu1 -> sub-item2 > > By the way, this seems to be exactly what the breadcrumb-jump command > in my breadcrumb.el package does. Goes reasonably well with a flex/fuzzy > completion style. It would be great to have some form of breadcrumb-jump in imenu.el since it's useful on its own even for someone who doesn't use breadcrumbs. > You can look at it for an implementation idea. Just be sure to do this > flattening at the presentation level (i.e. M-x imenu), not at the > internal representation level. Here are some observations while testing on emacs/test/manual/etags/ruby-src/test.rb. Both ruby-mode and ruby-ts-mode provide a list that is already flat: ruby-mode: ModuleExample ModuleExample#ModuleExample.module_class_method ModuleExample#module_instance_method ModuleExample::ClassExample ModuleExample::ClassExample#+ ModuleExample::ClassExample#ClassExample.class_method ModuleExample::ClassExample#instance_method ruby-ts-mode: ModuleExample ModuleExample#module_instance_method ModuleExample.module_class_method ModuleExample::ClassExample ModuleExample::ClassExample#+ ModuleExample::ClassExample#instance_method ModuleExample::ClassExample.class_method When eglot is enabled then imenu-create-index-function returns a tree. What is interesting is that breadcrumb-jump already correctly handles both a flat list and a tree: a flat list in breadcrumb-jump completions is exactly the same as in 'imenu': ModuleExample ModuleExample#module_instance_method ModuleExample.module_class_method ModuleExample::ClassExample ModuleExample::ClassExample#+ ModuleExample::ClassExample#instance_method ModuleExample::ClassExample.class_method a tree from eglot in breadcrumb-jump completions: Class > ModuleExample > ClassExample Method > ClassExample > class_method Method > ModuleExample > module_class_method Method > ModuleExample > module_instance_method Method > ModuleExample::ClassExample > + Method > ModuleExample::ClassExample > instance_method Module > > ModuleExample is still usable even without special characters like "#". > It shouldn't be needed here at all, but in case anyone's thinking > about it, please avoid messing with imenu's internal representation of > hierarchies as that structure is relied upon by many extensions (not just > mine, but several others). Even certain things supported by certain > imenu-presenting frontends (like "special elements") are not supported by > other frontends. It's a bit of a mess. The symbols holding/describing > this representation (imenu--index-alist, maybe others) are incorrectly > named '--' but they are most definitely externally visible and used > customization points. Indeed, it's unfortunate that imenu--make-index-alist and imenu--index-alist are named as internal.