From a7a90284bbe5a55dd0a4cdd0759698787db0a4be Mon Sep 17 00:00:00 2001 From: Dieter Wilhelm Date: Wed, 4 Jan 2023 20:50:15 +0100 Subject: [PATCH] Provide in Info manuals links of symbols to their help documentation * lisp/info-xref.el contains all the necessary code. It is separated from the original code - for the moment - with lines of semi-colons. --- lisp/info-xref.el | 494 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 451 insertions(+), 43 deletions(-) diff --git a/lisp/info-xref.el b/lisp/info-xref.el index a910f38af84..6677ade1328 100644 --- a/lisp/info-xref.el +++ b/lisp/info-xref.el @@ -1,4 +1,4 @@ -;;; info-xref.el --- check external references in an Info document -*- lexical-binding: t -*- +;;; info-xref.el --- Cross references in an Info document -*- lexical-binding: t -*- ;; Copyright (C) 2003-2023 Free Software Foundation, Inc. @@ -38,6 +38,119 @@ ;; `M-x info-xref-docstrings' checks docstring "Info node ..." hyperlinks in ;; source files (and other files). +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +;; This library provides links of symbols (functions, variables, +;; faces) within Emacs' Info viewer to their builtin help +;; documentation. This linking is done, when the symbol names in +;; texinfo documentations (like the Emacs- and Elisp manual) are + +;; 1. Quoted symbol names like `quoted-symbol' or: + +;; 2. Function names are prefixed by M-x, for example M-x +;; function-name or are quoted and prefixed like `M-x function-name'. + +;; 3. Function names appearing behind the following forms, which +;; occur, for example, in the Elisp manual: + +;; -- Special Form: function-name +;; -- Command: +;; -- Function: +;; -- Macro: + +;; 4. And variables names behind the following text: + +;; -- User Option: variable-name +;; -- Variable: + +;; In any case all symbol names must be known to Emacs, i.e. their +;; names are found in the variable `obarray'. + +;; You can follow the additional links with the usual Info +;; keybindings. The customisation variable +;; `mouse-1-click-follows-link' is influencing the clicking behavior +;; (and the tooltips) of the links, the variable's default is 450 +;; (milli seconds) setting it to nil means only clicking with mouse-2 +;; is following the link (hint: Drew Adams). + +;; The link color of symbols - referencing their builtin documentation +;; - is distinct from links which are referencing further Info +;; documentation. + +;; Inform is checking if the Info documents are relevant Elisp and +;; Emacs related files to avoid false positives. Please see the +;; customization variable `inform-none-emacs-or-elisp-documents'. + +;; The code uses mostly mechanisms from Emacs' lisp/help-mode.el file. + +;;; Change Log: + +;; 1.3: + +;; Inform is checking if the Info documents are relevant Elisp and +;; Emacs related files to avoid false positives. + +;; 1.2: + +;; Link Elisp descriptions of symbols to their help documentation, +;; like the following function example: -- Function: eval form + +;; Distinguish color of texinfo links (`link' type) and Help links +;; (`font-lock-function-name-face') + +;;; TODO: + +;; Currently inconsistent link colors to help buffers: In *info* +;; different as in *Help* buffers! + +;; Check the application `inform-xref-symbol-regexp' for additional +;; symbol prefixes without quoting of symbol-names + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Does the following belong to customize.el? + +;; Generalise linking to "customization buffers" for the "easy +;; customization" info documentation see also the customization +;; section in the elisp manual + +;; - distinguish the Customization-links from Help- and Info-links +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +;;; Ideas: + +;; Link the help buffers back to higher level info manual subjects, +;; similar to help-fns+.el from Drew Adams. + +;; Twice clicking or RETurning removes *Help* buffer (idea: Drew +;; Adams) + +;; Different colors for different symbol types (idea: Drew Adams) see +;; package helpful and info+ / info-colors on Melpa and see +;; font-lock.el for common faces. + +;; - Do we need to indicate an already visited Help link with a +;; different color? + +;; - Would it be be good to overtake all colors of package +;; "info-colors"? + +;; - Do we need to distinguish the link FONTS? No, difficult to read! + +;; Back / Forward button in help buffer - back to info buffer or +;; remain in help mode? + +;; Linking of standard symbol properties? + +;; - (info "(elisp) Standard Properties") + +;; Elisp manual examples: +;; (symbol-name 'car) ... ? + +;; Shortening the verbose texinfo URLs? But how to handle the changed +;; indentation? + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + ;;; History: ;; Version 3 - new M-x info-xref-docstrings, use compilation-mode @@ -297,16 +410,16 @@ info-xref-check (interactive (list (let* ((default-filename - (cond ((eq major-mode 'Info-mode) - Info-current-file) - ((eq major-mode 'texinfo-mode) - ;; look for @setfilename like makeinfo.el does - (save-excursion - (goto-char (point-min)) - (if (re-search-forward - "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*" - (line-beginning-position 100) t) - (expand-file-name (match-string 1))))))) + (cond ((eq major-mode 'Info-mode) + Info-current-file) + ((eq major-mode 'texinfo-mode) + ;; look for @setfilename like makeinfo.el does + (save-excursion + (goto-char (point-min)) + (if (re-search-forward + "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*" + (line-beginning-position 100) t) + (expand-file-name (match-string 1))))))) (prompt (if default-filename (format "Info file (%s): " default-filename) "Info file: "))) @@ -367,24 +480,24 @@ info-xref-all-info-files (defun info-xref-check-list (filename-list) "Check external references in info documents in FILENAME-LIST." (info-xref-with-output - (dolist (info-xref-filename filename-list) - (setq info-xref-xfile-alist nil) - (let ((info-xref-output-heading - (format "Info file %s\n" info-xref-filename))) - (with-temp-message (format "Looking at %s" info-xref-filename) - (with-temp-buffer - (info-insert-file-contents info-xref-filename) - (goto-char (point-min)) - (if (search-forward "\^_\nIndirect:\n" nil t) - (let ((dir (file-name-directory info-xref-filename))) - (while (looking-at "\\(.*\\): [0-9]+\n") - (let ((info-xref-filename - (expand-file-name (match-string 1) dir))) - (with-temp-buffer - (info-insert-file-contents info-xref-filename) - (info-xref-check-buffer))) - (forward-line))) - (info-xref-check-buffer)))))))) + (dolist (info-xref-filename filename-list) + (setq info-xref-xfile-alist nil) + (let ((info-xref-output-heading + (format "Info file %s\n" info-xref-filename))) + (with-temp-message (format "Looking at %s" info-xref-filename) + (with-temp-buffer + (info-insert-file-contents info-xref-filename) + (goto-char (point-min)) + (if (search-forward "\^_\nIndirect:\n" nil t) + (let ((dir (file-name-directory info-xref-filename))) + (while (looking-at "\\(.*\\): [0-9]+\n") + (let ((info-xref-filename + (expand-file-name (match-string 1) dir))) + (with-temp-buffer + (info-insert-file-contents info-xref-filename) + (info-xref-check-buffer))) + (forward-line))) + (info-xref-check-buffer)))))))) (defconst info-xref-node-re "\\(?1:\\(([^)]*)\\)[^.,]+\\)" "Regexp with subexp 1 matching (manual)node.") @@ -513,7 +626,7 @@ info-xref-docstrings the sources handy." (interactive (let* ((default (and buffer-file-name - (file-relative-name buffer-file-name))) + (file-relative-name buffer-file-name))) (prompt (if default (format "Filename with wildcards (%s): " default) @@ -539,23 +652,318 @@ info-xref-docstrings (setq info-xref-xfile-alist nil) ;; "not found"s once per file (info-xref-with-file info-xref-filename - (goto-char (point-min)) - (while (re-search-forward help-xref-info-regexp nil t) - (let ((node (match-string 2))) - (save-excursion - (goto-char (match-beginning 2)) ;; start of node as error position + (goto-char (point-min)) + (while (re-search-forward help-xref-info-regexp nil t) + (let ((node (match-string 2))) + (save-excursion + (goto-char (match-beginning 2)) ;; start of node as error position + + ;; skip nodes with "%" as probably `format' strings such as in + ;; info-look.el + (unless (string-search "%" node) + + ;; "(emacs)" is the default manual for docstring hyperlinks, + ;; per `help-make-xrefs' + (unless (string-match "\\`(" node) + (setq node (concat "(emacs)" node))) + + (info-xref-check-node node))))))))) - ;; skip nodes with "%" as probably `format' strings such as in - ;; info-look.el - (unless (string-search "%" node) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - ;; "(emacs)" is the default manual for docstring hyperlinks, - ;; per `help-make-xrefs' - (unless (string-match "\\`(" node) - (setq node (concat "(emacs)" node))) +(require 'button) +(require 'cl-lib) +(require 'help-mode) ;redundant? - (info-xref-check-node node))))))))) +;; activate inform without manually loading it. Is there a better way? +;; ;;;###autoload (require 'info-xref) +;; this is spawning lisp/info-xref.el's definition to 'info! This +;; group is sorted now in 'docs and 'info! -FIXME- +(defgroup info-xref nil + "Customisation 'info-xref' subgroup of info. +Check external cross-references in Info documents and provide +hyperlinks from symbols to their help documentation." + :group 'info) + +;;;###autoload +(defcustom info-xref-make-xref-flag t + "Non-nil means create symbol links in info buffers." + :type '(choice (const :tag "Create links" t) + (const :tag "Do not link" nil)) + :group 'info-xref) + +(require 'cl-seq) +;; Info-director-list must be initialised +(info-initialize) +(defvar Info-xref-emacs-info-dir-content + (mapcar 'file-name-nondirectory ;'file-name-sans-extension + (directory-files + (car + ;; search for the main Emacs' info/ directory + (cl-member "[^.]emacs" Info-directory-list :test 'string-match-p)) + ;; don't list "." and ".." + t "[^.]$")) + "List of file names in Emacs' own info/ directory.") + +;; Turn into regexp list necessary? Stefan +;; Switch to alist with explanation of file name? +(defcustom info-xref-none-emacs-or-elisp-documents + '("aarm2012" ; Stefan: Ada manual, Elpa archive + "arm2012" ; Stefan: Ada manual + "sicp" ; T.V: Structure and Interpretation of Computer Programs, + ; Melpa archive + ) + "List of all none GNU-Emacs or Elisp documentation. +Or other documents not to be checked for linking to their help +documentation. The list must contains only the base name of the +files (without their file name extension \".info\")." + :type '(repeat string) + :group 'info-xref) + +(defun Info-xref-check-docu-p () + "Check if the current info file is relevant to Emacs. +That means `Info-current-file' is either found in Emacs' info/ +directory or in `package-user-dir' and is not included in the +`info-xref-none-emacs-or-elisp-documents' list." + (let* ((ifile Info-current-file) + (ifi (when ifile + (file-name-sans-extension + (file-name-nondirectory ifile)))) + (pdir (when (boundp 'package-user-dir) + (expand-file-name + package-user-dir))) + (ifiles Info-xref-emacs-info-dir-content) + (ndocu info-xref-none-emacs-or-elisp-documents)) + (and ifile + (or (assoc-string (concat ifi ".info") ifiles) + ;; info files might be archived! + (assoc-string (concat ifi ".info.gz") ifiles) + (when pdir (string-match pdir ifile))) + (not (assoc-string ifi ndocu))))) + +(defvar describe-symbol-backends) ;from help-mode.el +(defvar help-xref-following) ;dito + +;; this toggles the complete linking process +;;;###autoload +(when info-xref-make-xref-flag + (add-hook 'Info-selection-hook 'Info-xref-make-xrefs)) + +(defface Info-xref-color + '((t (:inherit font-lock-doc-face + ;; font-lock-preprocessor-face ; similar to link face (default) + ;; font-lock-builtin-face ; similar (default Emacs) + ;; font-lock-function-name-face ; similar (default) + ;; Info-xref-face + ))) + "Face for the `symbol' reference items in `info' nodes." + :group 'info-colors) + +;; Button types + +(define-button-type 'Info-xref + 'link t ;for Info-next-reference-or-link + 'follow-link t + 'face 'Info-xref-color + 'action #'Info-xref-button-action) + +(define-button-type 'Info-xref-function + :supertype 'Info-xref + 'Info-xref-function 'describe-function + 'Info-xref-echo (purecopy "mouse-2, RET: describe this function")) + +(define-button-type 'Info-xref-variable + :supertype 'Info-xref + 'Info-xref-function 'describe-variable + 'Info-xref-echo (purecopy "mouse-2, RET: describe this variable")) + +(define-button-type 'Info-xref-face + :supertype 'Info-xref + 'Info-xref-function 'describe-face + 'Info-xref-echo (purecopy "mouse-2, RET: describe this face")) + +(define-button-type 'Info-xref-symbol + :supertype 'Info-xref + 'Info-xref-function #'describe-symbol + 'Info-xref-echo (purecopy "mouse-2, RET: describe this symbol")) + +(define-button-type 'Info-xref-function-def + :supertype 'Info-xref + 'Info-xref-function (lambda (fun &optional file type) + (or file + (setq file (find-lisp-object-file-name fun type))) + (if (not file) + (message "Unable to find defining file") + (require 'find-func) + (when (eq file 'C-source) + (setq file + (help-C-file-name (indirect-function fun) 'fun))) + ;; Don't use find-function-noselect because it follows + ;; aliases (which fails for built-in functions). + (let ((location + (find-function-search-for-symbol fun type file))) + (pop-to-buffer (car location)) + (run-hooks 'find-function-after-hook) + (if (cdr location) + (goto-char (cdr location)) + (message "Unable to find location in file"))))) + 'Info-xref-echo (purecopy "mouse-2, RET: find function's definition")) + +;; Functions + +(defun Info-xref-button-action (button) + "Call BUTTON's help function." + (Info-xref-do-xref nil + (button-get button 'Info-xref-function) + (button-get button 'Info-xref-args))) + +(defun Info-xref-do-xref (_pos function args) + "Call the help cross-reference function FUNCTION with args ARGS. +Things are set up properly so that the resulting `help-buffer' has +a proper [back] button." + ;; There is a reference at point. Follow it. + (let ((help-xref-following nil)) + (apply + function (if (eq function 'info) + (append args (list (generate-new-buffer-name "*info*")))args)))) + +(defun Info-xref-button (match-number type &rest args) + "Make a hyperlink for cross-reference text previously matched. +MATCH-NUMBER is the subexpression of interest in the last matched +regexp. TYPE is the type of button to use. Any remaining arguments are +passed to the button's Info-xref-function when it is invoked. +See `Info-xref-make-xrefs' Don't forget ARGS." ; -TODO- + ;; Don't mung properties we've added specially in some instances. + (unless (button-at (match-beginning match-number)) + ;; (message "Creating button: %s." args) + (make-text-button (match-beginning match-number) + (match-end match-number) + 'type type 'Info-xref-args args))) + +(defconst Info-xref-symbol-regexp + (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|" ; Link to var + "\\(function\\|command\\|call\\)\\|" ; Link to function + "\\(face\\)\\|" ; Link to face + "\\(symbol\\|program\\|property\\)\\|" ; Don't link + "\\(source \\(?:code \\)?\\(?:of\\|for\\)\\)\\)" + "[ \t\n]+\\)?" + ;; Note starting with word-syntax character: + "['`‘]\\(\\sw\\(\\sw\\|\\s_\\)+\\|`\\)['’]")) + "Regexp matching doc string references to symbols. + +The words preceding the quoted symbol can be used in doc strings to +distinguish references to variables, functions and symbols.") + +;;;###autoload +(defun Info-xref-make-xrefs (&optional buffer) + "Parse and hyperlink documentation cross-references in the given BUFFER. + +Find cross-reference information in a buffer and activate such cross +references for selection with `help-follow'. Cross-references have +the canonical form `...' and the type of reference may be +disambiguated by the preceding word(s) used in +`Info-xref-symbol-regexp'. + +Function names are also prefixed by \"M-x\", for example \"M-x +function-name\" or are quoted and prefixed like `M-x +function-name'. + +Also Function names appearing behind the following forms, which +occur, for example, in the Elisp manual: + + -- Special Form: function-name + -- Command: + -- Function: + -- Macro: + +And variables names behind the following text: + + -- User Option: variable-name + -- Variable: + +Faces only get cross-referenced if preceded or followed by the +word `face'. Variables without variable documentation do not get +cross-referenced, unless preceded by the word `variable' or +`option'." + (interactive "b") + (when (Info-xref-check-docu-p) + (with-current-buffer (or buffer (current-buffer)) + (save-excursion + (goto-char (point-min)) + ;; Skip the header-type info, though it might be useful to parse + ;; it at some stage (e.g. "function in `library'"). + ;; (forward-paragraph) + (with-silent-modifications ;from Stefan + (let (;(stab (syntax-table)) + (case-fold-search t) + (inhibit-read-only t)) + (with-syntax-table emacs-lisp-mode-syntax-table + ;; Quoted symbols + (save-excursion + (while (re-search-forward Info-xref-symbol-regexp nil t) + (let* ((data (match-string 8)) + (sym (intern-soft data))) + (if sym + (cond + ((match-string 3) ; `variable' &c + (and (or (boundp sym) ; `variable' doesn't ensure + ; it's actually bound + (get sym 'variable-documentation)) + (Info-xref-button 8 'Info-xref-variable sym))) + ((match-string 4) ; `function' &c + (and (fboundp sym) ; similarly + (Info-xref-button 8 'Info-xref-function sym))) + ((match-string 5) ; `face' + (and (facep sym) + (Info-xref-button 8 'Info-xref-face sym))) + ((match-string 6)) ; nothing for `symbol' + ((match-string 7) + (Info-xref-button 8 'Info-xref-function-def sym)) + ((cl-some (lambda (x) (funcall (nth 1 x) sym)) + describe-symbol-backends) + (Info-xref-button 8 'Info-xref-symbol sym))))))) + + ;; (info "(elisp) Eval") + ;; Elisp manual -- Special Form: + ;; -- Command: + ;; -- Function: function-name function + ;; -- Macro: + (save-excursion + (while (re-search-forward + "-- \\(Special Form:\\|Command:\\|Function:\\|Macro:\\) " + nil t) + (looking-at "\\(\\sw\\|\\s_\\)+") + (let ((sym (intern-soft (match-string 0)))) + (if (fboundp sym) + (Info-xref-button 0 'Info-xref-function sym))))) + + ;; -- User Option: + ;; -- Variable: variable-name + (save-excursion + (while (re-search-forward + "-- \\(User Option:\\|Variable:\\) " + nil t) + (looking-at "\\(\\sw\\|\\s_\\)+") + (let ((sym (intern-soft (match-string 0)))) + (if (boundp sym) + (Info-xref-button 0 'Info-xref-variable sym))))) + + ;; M-x prefixed functions + (save-excursion + (while (re-search-forward + ;; Assume command name is only word and symbol + ;; characters to get things like `use M-x foo->bar'. + ;; Command required to end with word constituent + ;; to avoid `.' at end of a sentence. + ;; "\\