From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Evgeni Kolev Newsgroups: gmane.emacs.bugs Subject: bug#60407: [PATCH] Update go-ts-mode to use Imenu facility Date: Sun, 1 Jan 2023 19:08:11 +0200 Message-ID: References: <83y1qm39o3.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7294"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Randy Taylor , 60407@debbugs.gnu.org, Yuan Fu To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jan 01 18:09:15 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 1pC1pj-0001hh-0c for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 01 Jan 2023 18:09:15 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pC1pZ-0002Bk-0R; Sun, 01 Jan 2023 12:09:05 -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 1pC1pX-0002BJ-4V for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 12:09:03 -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 1pC1pW-0003nd-Iv for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 12:09:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pC1pW-0003Qt-BR for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 12:09:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Evgeni Kolev Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 01 Jan 2023 17:09: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.167259292613171 (code B ref 60407); Sun, 01 Jan 2023 17:09:02 +0000 Original-Received: (at 60407) by debbugs.gnu.org; 1 Jan 2023 17:08:46 +0000 Original-Received: from localhost ([127.0.0.1]:41619 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pC1pF-0003QK-Jc for submit@debbugs.gnu.org; Sun, 01 Jan 2023 12:08:46 -0500 Original-Received: from mail-yb1-f176.google.com ([209.85.219.176]:45961) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pC1pD-0003Q6-9d for 60407@debbugs.gnu.org; Sun, 01 Jan 2023 12:08:44 -0500 Original-Received: by mail-yb1-f176.google.com with SMTP id n78so28297266yba.12 for <60407@debbugs.gnu.org>; Sun, 01 Jan 2023 09:08:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=sK2Ou2Lmo1iR772sYaV7Gn95/bjwjNrWxIa7xOELCd4=; b=YI2j3yFOPlcB8SUH9DjVpQpShOEJVzR0JpySG2egCwaWSCnqaECE0+UXy6YfS5dzuA xSPZGgFCudv5DCh6W8vle8kMbXVEZzGimTSSWDN/DSNyzmvAyL+vtkcFNSftDhOG/TMG gCY2qBw0yRVpVkf9ZrGN3tWY3prEKw+7TtNIEc1Pz/PzyicNlTaA1oOdySTe5RXQV2Z5 89Ic8xTcs/Fqg/+/p1/zbPovfACe6KvgEvjgvq5nIE5EyoFn2wsitQTk+uN/jja4Su7n yj5PoLyBuY8ba3zCAr2JRI4440P6nASfRzesHuxPk1c5dxQkUi/PJlCEJ0A/pnL1JfPc OVkw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=sK2Ou2Lmo1iR772sYaV7Gn95/bjwjNrWxIa7xOELCd4=; b=H7gCAXnmAu277fbm6HjcXp5Pf210dKIse4xWKlarfOEV1EL7uDnN5nkiHRBSwBexD8 FN/ThmdzIOSB+6sCBUcQU+QP7+TNp74QmceMRuGhCEsq/rqS63Up6XFJ3HnY+Ujce38c 02WRy9vduI3UGiDpJxhO6EuoRsULyxSTs08l20+EQjTcoRB3vTko+v5hCGBjqhDkCYUa SkWf0RrANFT7fpXBo17UKTelcgwAxEJ3utZJ43dtiiowk83V4c5mYFaCYlFqfMU2LDGz N71JvPpBG9i4wVNLj8QDVGoOFPmYROwcYaBEN3kdymkkA2o8hifCKN05nd5+BiBsABcG x/iw== X-Gm-Message-State: AFqh2koTc0IlJ1ZQDuLKofe0J6fUrh6ohNtwmd0OXJ25ztGVAKA8UeBy aIlqdihiiXWpdGipmm9kz5W+Z/mUsTrJ7SlbKKU= X-Google-Smtp-Source: AMrXdXuIsierQu7ERU0D1i+8aoa0PTNdJzXYD1XXLCypyFv+gsrjBkvpn1lTwGW5eZ1ux1UuvWs7tfwuG4kQsQRL6gc= X-Received: by 2002:a25:bf8c:0:b0:708:c3d2:a2bd with SMTP id l12-20020a25bf8c000000b00708c3d2a2bdmr4916381ybk.138.1672592917471; Sun, 01 Jan 2023 09:08:37 -0800 (PST) In-Reply-To: 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:252255 Archived-At: As I mentioned in the start of the mail thread - go-ts-mode's Imenu puts Go interfaces and structs in the same "Type" bucket. This can be improved in go-ts-mode. I'm providing a second patch below which splits the interfaces and structs into their own Imenu categories. Please let me know if I should provide the second patch later, in a separate thread, after the first patch is finished. I'm assuming it's simpler to review the patches together. If it's not - I'll provide them in a way to make the review easier, just let me know. The second patch is below. commit a5c4a0b25e0385516ad1f8c3444830111d467843 Author: Evgeni Kolev Date: Sun Jan 1 18:57:26 2023 +0200 Improve go-ts-mode Imenu go-ts-mode Imenu is improved to distinguish between Go interfaces and structs. Previously both were put in "Type" category. Now each has its own category: "Interface" and "Struct" respectively. * lisp/progmodes/go-ts-mode.el (go-ts-mode--interface-node-p) (go-ts-mode--struct-node-p): New functions. diff --git a/lisp/progmodes/go-ts-mode.el b/lisp/progmodes/go-ts-mode.el index c6c1c61d9f4..cb8d740727a 100644 --- a/lisp/progmodes/go-ts-mode.el +++ b/lisp/progmodes/go-ts-mode.el @@ -194,13 +194,14 @@ go-ts-mode (setq-local treesit-defun-type-regexp (regexp-opt '("method_declaration" "function_declaration" - "type_spec"))) + "type_declaration"))) (setq-local treesit-defun-name-function #'go-ts-mode--defun-name) ;; Imenu. (setq-local treesit-simple-imenu-settings `(("Function" "\\`function_declaration\\'" nil nil) - ("Type" "\\`type_spec\\'" nil nil) + ("Interface" "\\`type_declaration\\'" go-ts-mode--interface-node-p nil) + ("Struct" "\\`type_declaration\\'" go-ts-mode--struct-node-p nil) ("Method" "\\`method_declaration\\'" nil nil))) ;; Indent. @@ -223,13 +224,30 @@ go-ts-mode--defun-name 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") + "method_declaration") (treesit-node-text (treesit-node-child-by-field-name node "name") + t)) + ((or "type_declaration") + (treesit-node-text + (treesit-node-child-by-field-name + (treesit-node-child node 0 t) "name") t)))) +(defun go-ts-mode--interface-node-p (node) + "Return t if NODE is a Go interface." + (string-equal "interface_type" + (treesit-node-type + (treesit-node-child-by-field-name + (treesit-node-child node 0 t) "type")))) + +(defun go-ts-mode--struct-node-p (node) + "Return t if NODE is a Go struct" + (string-equal "struct_type" (treesit-node-type + (treesit-node-child-by-field-name + (treesit-node-child node 0 t) "type")))) + ;; go.mod support. (defvar go-mod-ts-mode--syntax-table On Sun, Jan 1, 2023 at 3:05 PM Evgeni Kolev wrote: > > To illustrate the change, here's a comparison before VS after (VS eglot). > > I'm using a sample .go file (at the bottom of this mail). > > Before: > 4 candidates: > Function: measure > Type: geometry > Type: rect > Type: circle > > After: > 8 candidates: > Function: measure > Type: geometry > Type: rect > Type: circle > Method: area > Method: perim > Method: area > Method: perim > > For comparison, here's eglot's Imenu (using Go's gopls language server): > 13 candidates: > Interface: geometry > Struct: rect > Struct: circle > Field.rect: width > Field.rect: height > Field.circle: radius > Method.geometry: area > Method.geometry: perim > Method: (rect).area > Method: (rect).perim > Method: (circle).area > Method: (circle).perim > Function: measure > > Sample .go file: > > > type geometry interface { > > area() float64 > > perim() float64 > > } > > > > type rect struct { > > width, height float64 > > } > > > > type circle struct { > > radius float64 > > } > > > > func (r rect) area() float64 { > > return r.width * r.height > > } > > > > func (r rect) perim() float64 { > > return 2*r.width + 2*r.height > > } > > > > func (c circle) area() float64 { > > return math.Pi * c.radius * c.radius > > } > > > > func (c circle) perim() float64 { > > return 2 * math.Pi * c.radius > > } > > > > func measure(g geometry) { > > fmt.Println(g) > > fmt.Println(g.area()) > > fmt.Println(g.perim()) > > } > > On Sun, Jan 1, 2023 at 11:07 AM Eli Zaretskii wrote: > > > > > 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 > > > > > > > > > > > >