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 15:05:05 +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="17684"; 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 14:06:29 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 1pBy2m-0004MA-SG for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 01 Jan 2023 14:06:28 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pBy2P-000897-1K; Sun, 01 Jan 2023 08:06: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 1pBy2M-00088j-OO for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 08:06: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 1pBy2M-0006TC-FW for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 08:06:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pBy2L-0004et-TW for bug-gnu-emacs@gnu.org; Sun, 01 Jan 2023 08:06:01 -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 13:06:01 +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.167257834117877 (code B ref 60407); Sun, 01 Jan 2023 13:06:01 +0000 Original-Received: (at 60407) by debbugs.gnu.org; 1 Jan 2023 13:05:41 +0000 Original-Received: from localhost ([127.0.0.1]:40439 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBy20-0004eH-M0 for submit@debbugs.gnu.org; Sun, 01 Jan 2023 08:05:41 -0500 Original-Received: from mail-yw1-f176.google.com ([209.85.128.176]:44966) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBy1x-0004e2-Jc for 60407@debbugs.gnu.org; Sun, 01 Jan 2023 08:05:39 -0500 Original-Received: by mail-yw1-f176.google.com with SMTP id 00721157ae682-48641a481dfso186444377b3.11 for <60407@debbugs.gnu.org>; Sun, 01 Jan 2023 05:05:37 -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=+Rfa60O02YKdEjg0Pmf0Lf8m6h6m4IdZOfqt02ru3RU=; b=kwagOFx5O1aMJ8sDzVs/QNvoJMhdw3s7u6XN+zU/0LYD+pu0Q5yCtS1l1e70qE/2Qq cqcultL9ApEb4zYSL35EfZ5Fi7ZaC2G3JdPBN7IymYAMhS+p2zkOjPsnhfkxf0nsdgUv VP0t0qQNnk5fmESbO/2QW8+1YM3Kql71IxLnSWr5pKlQwlwoJbgC6BdmOsdbm2PypJLl GIG6gKKDwSxXos/KzkRGcfLRzYCpWk0IHnEj1qLE2iry6aCwZX8A50/kt4bOejnjHYRx Ej6EtYV7xykPhY5k3SFDpFnZinKB9uMC7wmPBXzUyR6H583FUt0I4jQRkwbRscVbqmJe NfIA== 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=+Rfa60O02YKdEjg0Pmf0Lf8m6h6m4IdZOfqt02ru3RU=; b=ZSUMUx2xbFl9zRNjh8Y44eHHk+IOARVeg5EC3OQvo2CpC2ydNzIxQzfPsKSrDRgltb uUa/RsdFXy3dFMHD3urKNoLYWyX5OCx1cPwdvwYIT4CnB3n0PXM+XzgLYVUoYCfsQK/3 7EKpP7Y/OHk7P5EuFi0AxPVNuP0+xnoBpRSTTzYTBZRNd9W8X+5OR8mBj+SpJ+PVeD2H m3w/vefLxJ3s5GQcgReBb1j65xgicpTAb8yMl0UT/14Ydr3EHaxoqrK9qbp+beI/HIgb XCMP5Er/ALzLUikseV1TolfSe3tRfTwuyl5ELQ8x89mwf5OYBxSJ/P44AJHpMPvD7aJ9 kcVQ== X-Gm-Message-State: AFqh2koK0WD7+g4OgDLvilkmtbwxNLz5fZlpIN/7zrnnqF3r9A8cz9W/ 2cKPzlT2MHNbm4r7OjvysrEiwIetcwMJTVXK+L8= X-Google-Smtp-Source: AMrXdXufpxjhaI9xS3Cd06jN939xywUwGrasI3Au0j72RZ+j6RGoFJiUFgMbOEbpRag2KqlAGpDTm7JqtW+zRfS/moo= X-Received: by 2002:a0d:e5c7:0:b0:39a:afeb:f519 with SMTP id o190-20020a0de5c7000000b0039aafebf519mr3964772ywe.146.1672578331632; Sun, 01 Jan 2023 05:05:31 -0800 (PST) In-Reply-To: <83y1qm39o3.fsf@gnu.org> 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:252242 Archived-At: 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 > > > > > > > >