From 2241f428f0d4809d00f397aafd97270272e966e0 Mon Sep 17 00:00:00 2001 From: Spencer Baugh Date: Fri, 14 Apr 2023 11:26:49 -0400 Subject: [PATCH] Add a semantic-symref backend which uses xref-matches-in-files When project-files is available, this is a much more efficient fallback than the current grep fallback. Ultimately, this is motivated by making xref-find-references faster by default even in the absence of an index. * lisp/cedet/semantic/symref/project.el: Add. * lisp/cedet/semantic/symref.el (semantic-symref-tool-alist): Add project tool --- lisp/cedet/semantic/symref.el | 2 + lisp/cedet/semantic/symref/project.el | 73 +++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 lisp/cedet/semantic/symref/project.el diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el index 1ebd7ea154b..7dfe892b7e8 100644 --- a/lisp/cedet/semantic/symref.el +++ b/lisp/cedet/semantic/symref.el @@ -93,6 +93,8 @@ semantic-symref-tool-alist idutils) ( (lambda (rootdir) (file-exists-p (expand-file-name "cscope.out" rootdir))) . cscope ) + ( (lambda (rootdir) (project-current nil rootdir)) . + project) ) "Alist of tools usable by `semantic-symref'. Each entry is of the form: diff --git a/lisp/cedet/semantic/symref/project.el b/lisp/cedet/semantic/symref/project.el new file mode 100644 index 00000000000..e822e7a2ba3 --- /dev/null +++ b/lisp/cedet/semantic/symref/project.el @@ -0,0 +1,73 @@ +;;; semantic/symref/project.el --- Symref implementation using project and xref -*- lexical-binding: t; -*- + +;; Copyright (C) 2008-2023 Free Software Foundation, Inc. + +;; Author: Spencer Baugh + +;; This file is part of GNU Emacs. + +;; GNU Emacs is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; GNU Emacs is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with GNU Emacs. If not, see . + +;;; Commentary: +;; +;; Implement the symref tool API using project-files and +;; xref-matches-in-files, which in turn use grep or more efficient +;; tools if available. +;; +;; This is basically a replacement for the symref GREP tool, as a new +;; lowest-common-denominator which works without indices or +;; project-specific configuration. It has better performance than the +;; GREP tool because project-files provides a narrower set of files to +;; search, and xref-matches-in-files is highly efficient. + +(require 'semantic/symref) +(require 'project) +(require 'xref) + +;;; Code: + +;;;###autoload +(defclass semantic-symref-tool-project (semantic-symref-tool-baseclass) () + "A symref tool implementation using project.el. +This uses `xref-matches-in-files' over `project-files'") + +(cl-defmethod semantic-symref-perform-search ((tool semantic-symref-tool-project)) + (pcase-let + (((eieio + searchfor + (searchtype (or 'symbol 'regexp)) + ;; for now, we only really support being called by + ;; xref-backend-references, and this is what it passes. + (resulttype 'line-and-text)) + tool)) + (mapcar + (pcase-lambda + ((cl-struct xref-match-item + summary (location + (cl-struct xref-file-location file line)))) + (list line file summary)) + (xref-matches-in-files searchfor (project-files (project-current)))))) + +(add-to-list 'semantic-symref-tool-alist + '((lambda (rootdir) (project-current nil rootdir)) + . project)) + +(provide 'semantic/symref/project) + +;; Local variables: +;; generated-autoload-file: "../loaddefs.el" +;; generated-autoload-load-name: "semantic/symref/project" +;; End: + +;;; semantic/symref/project.el ends here -- 2.30.2