From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#60407: [PATCH] Update go-ts-mode to use Imenu facility Date: Sun, 01 Jan 2023 11:07:24 +0200 Message-ID: <83y1qm39o3.fsf@gnu.org> References: Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="12425"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 60407@debbugs.gnu.org, Yuan Fu To: Evgeni Kolev , Randy Taylor Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jan 01 10:08:12 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1pBuKB-00033F-Ao for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 01 Jan 2023 10:08:11 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pBuK4-0000FA-TY; Sun, 01 Jan 2023 04:08:04 -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 1pBuK2-0000Eq-TS for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 04:08:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pBuK2-0008St-LH for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 04:08:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pBuK2-00023O-GZ for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 04:08:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 01 Jan 2023 09:08:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60407 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 60407-submit@debbugs.gnu.org id=B60407.16725640487849 (code B ref 60407); Sun, 01 Jan 2023 09:08:02 +0000 Original-Received: (at 60407) by debbugs.gnu.org; 1 Jan 2023 09:07:28 +0000 Original-Received: from localhost ([127.0.0.1]:40276 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBuJU-00022X-0s for submit@debbugs.gnu.org; Sun, 01 Jan 2023 04:07:28 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:51078) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBuJS-00022L-A4 for 60407@debbugs.gnu.org; Sun, 01 Jan 2023 04:07:26 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pBuJM-0008Pa-PF; Sun, 01 Jan 2023 04:07:20 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=gdyNmF5eNANcs3XMFhrlO9DxSFq9baZ7QOQ/qE0mDe0=; b=XQjVGBWjcDu4 GERSyVKFO4gqVdvvhPbZlvXkeo5AwM1bqa2yCEEPlIFWIeUVPzJJ/YdWO+VKOIWDTRFmMbzlfxJKU t4m6uvIUIpqM7fudYSaF8N+abWaPy3DDf68QeAzc14XOO+m/U7SS6Ki4O9t35Poj03oAdYR5sq8/2 U37qEhsXizeKOMo3TZC22Rc7rnjKCbC/BGQKmhJsvEhg4ZCg4u7NkmE80KfhIDiIAhOrdcIGi1JOL 0c+25xFWWGVdvIBFiQmGHg7I9QCNc3GjmcMKHIdPAQBSTlCmO6GOiSLQ1Ls9nnI72XY22CYEGbCcQ iFI0L5w6JDolbF81uiCHFA==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pBuJM-0006nv-7f; Sun, 01 Jan 2023 04:07:20 -0500 In-Reply-To: (message from Evgeni Kolev on Thu, 29 Dec 2022 18:05:49 +0200) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:252228 Archived-At: > From: Evgeni Kolev > Date: Thu, 29 Dec 2022 18:05:49 +0200 > > This patch updates go-ts-mode to use Imenu facility added in > https://git.savannah.gnu.org/cgit/emacs.git/commit/?h=emacs-29&id=b39dc7ab27a696a8607ab859aeff3c71509231f5 > > The Imenu items are extended to support "Method", in addition to > "Function" and "Type". > > The current Imenu approach uses "type_spec" to identify "Type" which > acts as a catch-all for many Go constructs, for example struct and > interface definitions. This catch-all approach is not optimal because > structs and interfaces are put in the same "Type" bucket. In a > follow-up patch I'll try to change the approach and have separate > "Interface" and "Struct" types. > > The patch is below. Randy, Yuan, are you looking into this? > commit 71ff7b21fe92167313bd1761b68b6e6fd879b09f > Author: Evgeni Kolev > Date: Thu Dec 29 17:49:40 2022 +0200 > > Update go-ts-mode to use Imenu facility > > go-ts-mode is updated to use the Imenu facility added in commit > b39dc7ab27a696a8607ab859aeff3c71509231f5. > > The Imenu items are extended to support "Method", in addition to > "Function" and "Type". > > * lisp/progmodes/go-ts-mode.el (go-ts-mode--imenu-1) (go-ts-mode--imenu): > Remove functions. > (go-ts-mode--defun-name): New function. > > diff --git a/lisp/progmodes/go-ts-mode.el b/lisp/progmodes/go-ts-mode.el > index 124d9b044a2..c6c1c61d9f4 100644 > --- a/lisp/progmodes/go-ts-mode.el > +++ b/lisp/progmodes/go-ts-mode.el > @@ -173,44 +173,6 @@ go-ts-mode--font-lock-settings > '((ERROR) @font-lock-warning-face)) > "Tree-sitter font-lock settings for `go-ts-mode'.") > > -(defun go-ts-mode--imenu () > - "Return Imenu alist for the current buffer." > - (let* ((node (treesit-buffer-root-node)) > - (func-tree (treesit-induce-sparse-tree > - node "function_declaration" nil 1000)) > - (type-tree (treesit-induce-sparse-tree > - node "type_spec" nil 1000)) > - (func-index (go-ts-mode--imenu-1 func-tree)) > - (type-index (go-ts-mode--imenu-1 type-tree))) > - (append > - (when func-index `(("Function" . ,func-index))) > - (when type-index `(("Type" . ,type-index)))))) > - > -(defun go-ts-mode--imenu-1 (node) > - "Helper for `go-ts-mode--imenu'. > -Find string representation for NODE and set marker, then recurse > -the subtrees." > - (let* ((ts-node (car node)) > - (children (cdr node)) > - (subtrees (mapcan #'go-ts-mode--imenu-1 > - children)) > - (name (when ts-node > - (treesit-node-text > - (pcase (treesit-node-type ts-node) > - ("function_declaration" > - (treesit-node-child-by-field-name ts-node "name")) > - ("type_spec" > - (treesit-node-child-by-field-name ts-node "name")))))) > - (marker (when ts-node > - (set-marker (make-marker) > - (treesit-node-start ts-node))))) > - (cond > - ((or (null ts-node) (null name)) subtrees) > - (subtrees > - `((,name ,(cons name marker) ,@subtrees))) > - (t > - `((,name . ,marker)))))) > - > ;;;###autoload > (add-to-list 'auto-mode-alist '("\\.go\\'" . go-ts-mode)) > > @@ -228,9 +190,18 @@ go-ts-mode > (setq-local comment-end "") > (setq-local comment-start-skip (rx "//" (* (syntax whitespace)))) > > + ;; Navigation. > + (setq-local treesit-defun-type-regexp > + (regexp-opt '("method_declaration" > + "function_declaration" > + "type_spec"))) > + (setq-local treesit-defun-name-function #'go-ts-mode--defun-name) > + > ;; Imenu. > - (setq-local imenu-create-index-function #'go-ts-mode--imenu) > - (setq-local which-func-functions nil) > + (setq-local treesit-simple-imenu-settings > + `(("Function" "\\`function_declaration\\'" nil nil) > + ("Type" "\\`type_spec\\'" nil nil) > + ("Method" "\\`method_declaration\\'" nil nil))) > > ;; Indent. > (setq-local indent-tabs-mode t > @@ -247,6 +218,18 @@ go-ts-mode > > (treesit-major-mode-setup))) > > +(defun go-ts-mode--defun-name (node) > + "Return the defun name of NODE. > +Return nil if there is no name or if NODE is not a defun node." > + (pcase (treesit-node-type node) > + ((or "function_declaration" > + "method_declaration" > + "type_spec") > + (treesit-node-text > + (treesit-node-child-by-field-name > + node "name") > + t)))) > + > ;; go.mod support. > > (defvar go-mod-ts-mode--syntax-table > > > >