1 ;;; elisp-mode.el --- Emacs Lisp mode -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1999-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: lisp, languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; The major mode for editing Emacs Lisp code.
27 ;; This mode is documented in the Emacs manual.
33 (eval-when-compile (require 'cl-lib))
35 (define-abbrev-table 'emacs-lisp-mode-abbrev-table ()
36 "Abbrev table for Emacs Lisp mode.
37 It has `lisp-mode-abbrev-table' as its parent."
38 :parents (list lisp-mode-abbrev-table))
40 (defvar emacs-lisp-mode-syntax-table
41 (let ((table (make-syntax-table lisp--mode-syntax-table)))
42 (modify-syntax-entry ?\[ "(] " table)
43 (modify-syntax-entry ?\] ")[ " table)
45 "Syntax table used in `emacs-lisp-mode'.")
47 (defvar emacs-lisp-mode-map
48 (let ((map (make-sparse-keymap "Emacs-Lisp"))
49 (menu-map (make-sparse-keymap "Emacs-Lisp"))
50 (lint-map (make-sparse-keymap))
51 (prof-map (make-sparse-keymap))
52 (tracing-map (make-sparse-keymap)))
53 (set-keymap-parent map lisp-mode-shared-map)
54 (define-key map "\e\t" 'completion-at-point)
55 (define-key map "\e\C-x" 'eval-defun)
56 (define-key map "\e\C-q" 'indent-pp-sexp)
57 (bindings--define-key map [menu-bar emacs-lisp]
58 (cons "Emacs-Lisp" menu-map))
59 (bindings--define-key menu-map [eldoc]
60 '(menu-item "Auto-Display Documentation Strings" eldoc-mode
61 :button (:toggle . (bound-and-true-p eldoc-mode))
62 :help "Display the documentation string for the item under cursor"))
63 (bindings--define-key menu-map [checkdoc]
64 '(menu-item "Check Documentation Strings" checkdoc
65 :help "Check documentation strings for style requirements"))
66 (bindings--define-key menu-map [re-builder]
67 '(menu-item "Construct Regexp" re-builder
68 :help "Construct a regexp interactively"))
69 (bindings--define-key menu-map [tracing] (cons "Tracing" tracing-map))
70 (bindings--define-key tracing-map [tr-a]
71 '(menu-item "Untrace All" untrace-all
72 :help "Untrace all currently traced functions"))
73 (bindings--define-key tracing-map [tr-uf]
74 '(menu-item "Untrace Function..." untrace-function
75 :help "Untrace function, and possibly activate all remaining advice"))
76 (bindings--define-key tracing-map [tr-sep] menu-bar-separator)
77 (bindings--define-key tracing-map [tr-q]
78 '(menu-item "Trace Function Quietly..." trace-function-background
79 :help "Trace the function with trace output going quietly to a buffer"))
80 (bindings--define-key tracing-map [tr-f]
81 '(menu-item "Trace Function..." trace-function
82 :help "Trace the function given as an argument"))
83 (bindings--define-key menu-map [profiling] (cons "Profiling" prof-map))
84 (bindings--define-key prof-map [prof-restall]
85 '(menu-item "Remove Instrumentation for All Functions" elp-restore-all
86 :help "Restore the original definitions of all functions being profiled"))
87 (bindings--define-key prof-map [prof-restfunc]
88 '(menu-item "Remove Instrumentation for Function..." elp-restore-function
89 :help "Restore an instrumented function to its original definition"))
91 (bindings--define-key prof-map [sep-rem] menu-bar-separator)
92 (bindings--define-key prof-map [prof-resall]
93 '(menu-item "Reset Counters for All Functions" elp-reset-all
94 :help "Reset the profiling information for all functions being profiled"))
95 (bindings--define-key prof-map [prof-resfunc]
96 '(menu-item "Reset Counters for Function..." elp-reset-function
97 :help "Reset the profiling information for a function"))
98 (bindings--define-key prof-map [prof-res]
99 '(menu-item "Show Profiling Results" elp-results
100 :help "Display current profiling results"))
101 (bindings--define-key prof-map [prof-pack]
102 '(menu-item "Instrument Package..." elp-instrument-package
103 :help "Instrument for profiling all function that start with a prefix"))
104 (bindings--define-key prof-map [prof-func]
105 '(menu-item "Instrument Function..." elp-instrument-function
106 :help "Instrument a function for profiling"))
107 ;; Maybe this should be in a separate submenu from the ELP stuff?
108 (bindings--define-key prof-map [sep-natprof] menu-bar-separator)
109 (bindings--define-key prof-map [prof-natprof-stop]
110 '(menu-item "Stop Native Profiler" profiler-stop
111 :help "Stop recording profiling information"
112 :enable (and (featurep 'profiler)
113 (profiler-running-p))))
114 (bindings--define-key prof-map [prof-natprof-report]
115 '(menu-item "Show Profiler Report" profiler-report
116 :help "Show the current profiler report"
117 :enable (and (featurep 'profiler)
118 (profiler-running-p))))
119 (bindings--define-key prof-map [prof-natprof-start]
120 '(menu-item "Start Native Profiler..." profiler-start
121 :help "Start recording profiling information"))
123 (bindings--define-key menu-map [lint] (cons "Linting" lint-map))
124 (bindings--define-key lint-map [lint-di]
125 '(menu-item "Lint Directory..." elint-directory
126 :help "Lint a directory"))
127 (bindings--define-key lint-map [lint-f]
128 '(menu-item "Lint File..." elint-file
129 :help "Lint a file"))
130 (bindings--define-key lint-map [lint-b]
131 '(menu-item "Lint Buffer" elint-current-buffer
132 :help "Lint the current buffer"))
133 (bindings--define-key lint-map [lint-d]
134 '(menu-item "Lint Defun" elint-defun
135 :help "Lint the function at point"))
136 (bindings--define-key menu-map [edebug-defun]
137 '(menu-item "Instrument Function for Debugging" edebug-defun
138 :help "Evaluate the top level form point is in, stepping through with Edebug"
140 (bindings--define-key menu-map [separator-byte] menu-bar-separator)
141 (bindings--define-key menu-map [disas]
142 '(menu-item "Disassemble Byte Compiled Object..." disassemble
143 :help "Print disassembled code for OBJECT in a buffer"))
144 (bindings--define-key menu-map [byte-recompile]
145 '(menu-item "Byte-recompile Directory..." byte-recompile-directory
146 :help "Recompile every `.el' file in DIRECTORY that needs recompilation"))
147 (bindings--define-key menu-map [emacs-byte-compile-and-load]
148 '(menu-item "Byte-compile and Load" emacs-lisp-byte-compile-and-load
149 :help "Byte-compile the current file (if it has changed), then load compiled code"))
150 (bindings--define-key menu-map [byte-compile]
151 '(menu-item "Byte-compile This File" emacs-lisp-byte-compile
152 :help "Byte compile the file containing the current buffer"))
153 (bindings--define-key menu-map [separator-eval] menu-bar-separator)
154 (bindings--define-key menu-map [ielm]
155 '(menu-item "Interactive Expression Evaluation" ielm
156 :help "Interactively evaluate Emacs Lisp expressions"))
157 (bindings--define-key menu-map [eval-buffer]
158 '(menu-item "Evaluate Buffer" eval-buffer
159 :help "Execute the current buffer as Lisp code"))
160 (bindings--define-key menu-map [eval-region]
161 '(menu-item "Evaluate Region" eval-region
162 :help "Execute the region as Lisp code"
163 :enable mark-active))
164 (bindings--define-key menu-map [eval-sexp]
165 '(menu-item "Evaluate Last S-expression" eval-last-sexp
166 :help "Evaluate sexp before point; print value in echo area"))
167 (bindings--define-key menu-map [separator-format] menu-bar-separator)
168 (bindings--define-key menu-map [comment-region]
169 '(menu-item "Comment Out Region" comment-region
170 :help "Comment or uncomment each line in the region"
171 :enable mark-active))
172 (bindings--define-key menu-map [indent-region]
173 '(menu-item "Indent Region" indent-region
174 :help "Indent each nonblank line in the region"
175 :enable mark-active))
176 (bindings--define-key menu-map [indent-line]
177 '(menu-item "Indent Line" lisp-indent-line))
179 "Keymap for Emacs Lisp mode.
180 All commands in `lisp-mode-shared-map' are inherited by this map.")
182 (defun emacs-lisp-byte-compile ()
183 "Byte compile the file containing the current buffer."
186 (byte-compile-file buffer-file-name)
187 (error "The buffer must be saved in a file first")))
189 (defun emacs-lisp-byte-compile-and-load ()
190 "Byte-compile the current file (if it has changed), then load compiled code."
193 (error "The buffer must be saved in a file first"))
195 ;; Recompile if file or buffer has changed since last compilation.
196 (if (and (buffer-modified-p)
197 (y-or-n-p (format "Save buffer %s first? " (buffer-name))))
199 (byte-recompile-file buffer-file-name nil 0 t))
201 (defun emacs-lisp-macroexpand ()
202 "Macroexpand the form after point.
203 Comments in the form will be lost."
205 (let* ((start (point))
206 (exp (read (current-buffer)))
207 ;; Compute it before, since it may signal errors.
208 (new (macroexpand-1 exp)))
210 (message "Not a macro call, nothing to expand")
211 (delete-region start (point))
212 (pp new (current-buffer))
213 (if (bolp) (delete-char -1))
214 (indent-region start (point)))))
216 (defcustom emacs-lisp-mode-hook nil
217 "Hook run when entering Emacs Lisp mode."
218 :options '(eldoc-mode imenu-add-menubar-index checkdoc-minor-mode)
223 (define-derived-mode emacs-lisp-mode prog-mode "Emacs-Lisp"
224 "Major mode for editing Lisp code to run in Emacs.
226 Delete converts tabs to spaces as it moves back.
227 Blank lines separate paragraphs. Semicolons start comments.
229 \\{emacs-lisp-mode-map}"
231 (defvar project-vc-external-roots-function)
232 (lisp-mode-variables nil nil 'elisp)
233 (add-hook 'after-load-functions #'elisp--font-lock-flush-elisp-buffers)
234 (setq-local electric-pair-text-pairs
235 (append '((?\` . ?\') (?‘ . ?’)) electric-pair-text-pairs))
236 (setq-local electric-quote-string t)
237 (setq imenu-case-fold-search nil)
238 (add-function :before-until (local 'eldoc-documentation-function)
239 #'elisp-eldoc-documentation-function)
240 (add-hook 'xref-backend-functions #'elisp--xref-backend nil t)
241 (setq-local project-vc-external-roots-function #'elisp-load-path-roots)
242 (add-hook 'completion-at-point-functions
243 #'elisp-completion-at-point nil 'local))
245 ;; Font-locking support.
247 (defun elisp--font-lock-flush-elisp-buffers (&optional file)
248 ;; We're only ever called from after-load-functions, load-in-progress can
249 ;; still be t in case of nested loads.
250 (when (or (not load-in-progress) file)
251 ;; FIXME: If the loaded file did not define any macros, there shouldn't
252 ;; be any need to font-lock-flush all the Elisp buffers.
253 (dolist (buf (buffer-list))
254 (with-current-buffer buf
255 (when (derived-mode-p 'emacs-lisp-mode)
256 ;; So as to take into account new macros that may have been defined
257 ;; by the just-loaded file.
258 (font-lock-flush))))))
260 ;;; Completion at point for Elisp
262 (defun elisp--local-variables-1 (vars sexp)
263 "Return the vars locally bound around the witness, or nil if not found."
269 (`(,(or `let `let*) ,bindings)
271 (when (eq 'let* (car sexp))
272 (dolist (binding (cdr (reverse bindings)))
273 (push (or (car-safe binding) binding) vars)))
274 (elisp--local-variables-1
275 vars (car (cdr-safe (car (last bindings)))))))
276 (`(,(or `let `let*) ,bindings . ,body)
278 (dolist (binding bindings)
279 (push (or (car-safe binding) binding) vars))
280 (elisp--local-variables-1 vars (car (last body)))))
282 ;; FIXME: Look for the witness inside `args'.
284 (`(lambda ,args . ,body)
285 (elisp--local-variables-1
286 (append (remq '&optional (remq '&rest args)) vars)
288 (`(condition-case ,_ ,e) (elisp--local-variables-1 vars e))
289 (`(condition-case ,v ,_ . ,catches)
290 (elisp--local-variables-1
291 (cons v vars) (cdr (car (last catches)))))
293 ;; FIXME: Look for the witness inside sexp.
295 ;; FIXME: Handle `cond'.
297 (elisp--local-variables-1 vars (car (last sexp))))
298 (`elisp--witness--lisp (or vars '(nil)))
300 ;; We didn't find the witness in the last element so we try to
301 ;; backtrack to the last-but-one.
302 (setq sexp (ignore-errors (butlast sexp)))))
305 (defun elisp--local-variables ()
306 "Return a list of locally let-bound variables at point."
308 (skip-syntax-backward "w_")
309 (let* ((ppss (syntax-ppss))
310 (txt (buffer-substring-no-properties (or (car (nth 9 ppss)) (point))
311 (or (nth 8 ppss) (point))))
313 (dolist (p (nth 9 ppss))
314 (push (cdr (syntax-after p)) closer))
315 (setq closer (apply #'string closer))
316 (let* ((sexp (condition-case nil
317 (car (read-from-string
318 (concat txt "elisp--witness--lisp" closer)))
319 ((invalid-read-syntax end-of-file) nil)))
320 (macroexpand-advice (lambda (expander form &rest args)
322 (apply expander form args)
327 (advice-add 'macroexpand :around macroexpand-advice)
328 (macroexpand-all sexp))
329 (advice-remove 'macroexpand macroexpand-advice)))
330 (vars (elisp--local-variables-1 nil sexp)))
332 (mapcar (lambda (var)
334 (not (string-match (symbol-name var) "\\`[&_]"))
335 ;; Eliminate uninterned vars.
340 (defvar elisp--local-variables-completion-table
341 ;; Use `defvar' rather than `defconst' since defconst would purecopy this
342 ;; value, which would doubly fail: it would fail because purecopy can't
343 ;; handle the recursive bytecode object, and it would fail because it would
344 ;; move `lastpos' and `lastvars' to pure space where they'd be immutable!
345 (let ((lastpos nil) (lastvars nil))
346 (letrec ((hookfun (lambda ()
348 (remove-hook 'post-command-hook hookfun))))
349 (completion-table-dynamic
352 (skip-syntax-backward "_w")
353 (let ((newpos (cons (point) (current-buffer))))
354 (unless (equal lastpos newpos)
355 (add-hook 'post-command-hook hookfun)
356 (setq lastpos newpos)
358 (mapcar #'symbol-name (elisp--local-variables))))))
361 (defun elisp--expect-function-p (pos)
362 "Return non-nil if the symbol at point is expected to be a function."
364 (and (eq (char-before pos) ?')
365 (eq (char-before (1- pos)) ?#))
367 (let ((parent (nth 1 (syntax-ppss pos))))
371 (looking-at (concat "(\\(cl-\\)?"
372 (regexp-opt '("declare-function"
373 "function" "defadvice"
377 (eq (match-end 0) pos)))))))
379 (defun elisp--form-quoted-p (pos)
380 "Return non-nil if the form at POS is not evaluated.
381 It can be quoted, or be inside a quoted form."
382 ;; FIXME: Do some macro expansion maybe.
384 (let ((state (syntax-ppss pos)))
385 (or (nth 8 state) ; Code inside strings usually isn't evaluated.
386 ;; FIXME: The 9th element is undocumented.
387 (let ((nesting (cons (point) (reverse (nth 9 state))))
389 (while (and nesting (not res))
390 (goto-char (pop nesting))
392 ((or (eq (char-after) ?\[)
394 (skip-chars-backward " ")
395 (memq (char-before) '(?' ?` ?‘))))
397 ((eq (char-before) ?,)
398 (setq nesting nil))))
401 ;; FIXME: Support for Company brings in features which straddle eldoc.
402 ;; We should consolidate this, so that major modes can provide all that
404 ;; - a function to extract "the reference at point" (may be more complex
405 ;; than a mere string, to distinguish various namespaces).
406 ;; - a function to jump to such a reference.
407 ;; - a function to show the signature/interface of such a reference.
408 ;; - a function to build a help-buffer about that reference.
409 ;; FIXME: Those functions should also be used by the normal completion code in
410 ;; the *Completions* buffer.
412 (defun elisp--company-doc-buffer (str)
413 (let ((symbol (intern-soft str)))
414 ;; FIXME: we really don't want to "display-buffer and then undo it".
415 (save-window-excursion
416 ;; Make sure we don't display it in another frame, otherwise
417 ;; save-window-excursion won't be able to undo it.
418 (let ((display-buffer-overriding-action
419 '(nil . ((inhibit-switch-frame . t)))))
422 ((fboundp symbol) (describe-function symbol))
423 ((boundp symbol) (describe-variable symbol))
424 ((featurep symbol) (describe-package symbol))
425 ((facep symbol) (describe-face symbol))
426 (t (signal 'user-error nil)))
429 (defun elisp--company-doc-string (str)
430 (let* ((symbol (intern-soft str))
431 (doc (if (fboundp symbol)
432 (documentation symbol t)
433 (documentation-property symbol 'variable-documentation t))))
435 (string-match ".*$" doc)
436 (match-string 0 doc))))
438 ;; can't (require 'find-func) in a preloaded file
439 (declare-function find-library-name "find-func" (library))
440 (declare-function find-function-library "find-func" (function &optional l-o v))
442 (defun elisp--company-location (str)
443 (let ((sym (intern-soft str)))
445 ((fboundp sym) (find-definition-noselect sym nil))
446 ((boundp sym) (find-definition-noselect sym 'defvar))
449 (cons (find-file-noselect (find-library-name
452 ((facep sym) (find-definition-noselect sym 'defface)))))
454 (defun elisp-completion-at-point ()
455 "Function used for `completion-at-point-functions' in `emacs-lisp-mode'."
456 (with-syntax-table emacs-lisp-mode-syntax-table
458 (beg (condition-case nil
461 (skip-chars-forward "`',‘#")
465 (unless (or (eq beg (point-max))
466 (member (char-syntax (char-after beg))
472 (skip-chars-backward "'’")
473 (when (>= (point) pos)
476 ;; t if in function position.
477 (funpos (eq (char-before beg) ?\())
478 (quoted (elisp--form-quoted-p beg)))
479 (when (and end (or (not (nth 8 (syntax-ppss)))
480 (memq (char-before beg) '(?` ?‘))))
482 (if (or (not funpos) quoted)
483 ;; FIXME: We could look at the first element of the list and
484 ;; use it to provide a more specific completion table in some
485 ;; cases. E.g. filter out keywords that are not understood by
486 ;; the macro/function being called.
488 ((elisp--expect-function-p beg)
491 :company-doc-buffer #'elisp--company-doc-buffer
492 :company-docsig #'elisp--company-doc-string
493 :company-location #'elisp--company-location))
496 ;; Don't include all symbols (bug#16646).
497 :predicate (lambda (sym)
503 (lambda (str) (if (fboundp (intern-soft str)) " <f>"))
504 :company-doc-buffer #'elisp--company-doc-buffer
505 :company-docsig #'elisp--company-doc-string
506 :company-location #'elisp--company-location))
508 (list nil (completion-table-merge
509 elisp--local-variables-completion-table
510 (apply-partially #'completion-table-with-predicate
514 :company-doc-buffer #'elisp--company-doc-buffer
515 :company-docsig #'elisp--company-doc-string
516 :company-location #'elisp--company-location)))
517 ;; Looks like a funcall position. Let's double check.
522 (progn (up-list -1) (forward-char 1)
523 (let ((c (char-after)))
525 (if (memq (char-syntax c) '(?w ?_))
526 (read (current-buffer))))))
529 ;; FIXME: Rather than hardcode special cases here,
530 ;; we should use something like a symbol-property.
532 (list t (mapcar (lambda (x) (symbol-name (car x)))
534 ;; FIXME: We should include some
535 ;; docstring with each entry.
537 macro-declarations-alist
538 defun-declarations-alist)))))
539 ((and (or `condition-case `condition-case-unless-debug)
540 (guard (save-excursion
545 :predicate (lambda (sym) (get sym 'error-conditions))))
546 ((and (or ?\( `let `let*)
547 (guard (save-excursion
549 (when (eq parent ?\()
552 (looking-at "\\_<let\\*?\\_>"))))
555 :company-doc-buffer #'elisp--company-doc-buffer
556 :company-docsig #'elisp--company-doc-string
557 :company-location #'elisp--company-location))
560 :company-doc-buffer #'elisp--company-doc-buffer
561 :company-docsig #'elisp--company-doc-string
562 :company-location #'elisp--company-location
564 (nconc (list beg end)
565 (if (null (car table-etc))
568 (if (memq (char-syntax (or (char-after end) ?\s))
571 (apply-partially 'completion-table-with-terminator
572 " " (cadr table-etc)))
573 (cddr table-etc)))))))))
575 (defun lisp-completion-at-point (&optional _predicate)
576 (declare (obsolete elisp-completion-at-point "25.1"))
577 (elisp-completion-at-point))
581 (declare-function xref-make-bogus-location "xref" (message))
582 (declare-function xref-make "xref" (summary location))
583 (declare-function xref-collect-references "xref" (symbol dir))
585 (defun elisp--xref-backend () 'elisp)
587 ;; WORKAROUND: This is nominally a constant, but the text properties
588 ;; are not preserved thru dump if use defconst. See bug#21237.
589 (defvar elisp--xref-format
590 (let ((str "(%s %s)"))
591 (put-text-property 1 3 'face 'font-lock-keyword-face str)
592 (put-text-property 4 6 'face 'font-lock-function-name-face str)
595 ;; WORKAROUND: This is nominally a constant, but the text properties
596 ;; are not preserved thru dump if use defconst. See bug#21237.
597 (defvar elisp--xref-format-extra
598 (let ((str "(%s %s %s)"))
599 (put-text-property 1 3 'face 'font-lock-keyword-face str)
600 (put-text-property 4 6 'face 'font-lock-function-name-face str)
603 (defvar find-feature-regexp);; in find-func.el
605 (defun elisp--xref-make-xref (type symbol file &optional summary)
606 "Return an xref for TYPE SYMBOL in FILE.
607 TYPE must be a type in `find-function-regexp-alist' (use nil for
608 'defun). If SUMMARY is non-nil, use it for the summary;
609 otherwise build the summary from TYPE and SYMBOL."
610 (xref-make (or summary
611 (format elisp--xref-format (or type 'defun) symbol))
612 (xref-make-elisp-location symbol type file)))
614 (defvar elisp-xref-find-def-functions nil
615 "List of functions to be run from `elisp--xref-find-definitions' to add additional xrefs.
616 Called with one arg; the symbol whose definition is desired.
617 Each function should return a list of xrefs, or nil; the first
618 non-nil result supercedes the xrefs produced by
619 `elisp--xref-find-definitions'.")
621 (cl-defmethod xref-backend-definitions ((_backend (eql elisp)) identifier)
623 ;; FIXME: use information in source near point to filter results:
624 ;; (dvc-log-edit ...) - exclude 'feature
625 ;; (require 'dvc-log-edit) - only 'feature
626 ;; Semantic may provide additional information
628 (let ((sym (intern-soft identifier)))
630 (elisp--xref-find-definitions sym))))
632 (defun elisp--xref-find-definitions (symbol)
633 ;; The file name is not known when `symbol' is defined via interactive eval.
636 (let ((temp elisp-xref-find-def-functions))
637 (while (and (null xrefs)
639 (setq xrefs (append xrefs (funcall (pop temp) symbol)))))
642 ;; alphabetical by result type symbol
644 ;; FIXME: advised function; list of advice functions
645 ;; FIXME: aliased variable
647 ;; Coding system symbols do not appear in ‘load-history’,
648 ;; so we can’t get a location for them.
650 (when (and (symbolp symbol)
651 (symbol-function symbol)
652 (symbolp (symbol-function symbol)))
654 (let* ((alias-symbol symbol)
655 (alias-file (symbol-file alias-symbol))
656 (real-symbol (symbol-function symbol))
657 (real-file (find-lisp-object-file-name real-symbol 'defun)))
660 (push (elisp--xref-make-xref nil real-symbol real-file) xrefs))
663 (push (elisp--xref-make-xref 'defalias alias-symbol alias-file) xrefs))))
666 (let ((file (find-lisp-object-file-name symbol 'defface)))
668 (push (elisp--xref-make-xref 'defface symbol file) xrefs))))
670 (when (fboundp symbol)
671 (let ((file (find-lisp-object-file-name symbol (symbol-function symbol)))
676 ;; First call to find-lisp-object-file-name for an object
677 ;; defined in C; the doc strings from the C source have
678 ;; not been loaded yet. Second call will return "src/*.c"
679 ;; in file; handled by 't' case below.
680 (push (elisp--xref-make-xref nil symbol (help-C-file-name (symbol-function symbol) 'subr)) xrefs))
682 ((and (setq doc (documentation symbol t))
683 ;; This doc string is defined in cl-macs.el cl-defstruct
684 (string-match "Constructor for objects of type `\\(.*\\)'" doc))
685 ;; `symbol' is a name for the default constructor created by
686 ;; cl-defstruct, so return the location of the cl-defstruct.
687 (let* ((type-name (match-string 1 doc))
688 (type-symbol (intern type-name))
689 (file (find-lisp-object-file-name type-symbol 'define-type))
690 (summary (format elisp--xref-format-extra
692 (concat "(" type-name)
693 (concat "(:constructor " (symbol-name symbol) "))"))))
694 (push (elisp--xref-make-xref 'define-type type-symbol file summary) xrefs)
697 ((setq generic (cl--generic symbol))
698 ;; FIXME: move this to elisp-xref-find-def-functions, in cl-generic.el
700 ;; A generic function. If there is a default method, it
701 ;; will appear in the method table, with no
704 ;; If the default method is declared by the cl-defgeneric
705 ;; declaration, it will have the same location as the
706 ;; cl-defgeneric, so we want to exclude it from the
707 ;; result. In this case, it will have a null doc
708 ;; string. User declarations of default methods may also
709 ;; have null doc strings, but we hope that is
710 ;; rare. Perhaps this heuristic will discourage that.
711 (dolist (method (cl--generic-method-table generic))
712 (let* ((info (cl--generic-method-info method));; qual-string combined-args doconly
713 (specializers (cl--generic-method-specializers method))
715 (met-name (cons symbol specializers))
716 (file (find-lisp-object-file-name met-name 'cl-defmethod)))
717 (dolist (item specializers)
718 ;; default method has all 't' in specializers
719 (setq non-default (or non-default (not (equal t item)))))
723 (nth 2 info))) ;; assuming only co-located default has null doc string
725 (let ((summary (format elisp--xref-format-extra 'cl-defmethod symbol (nth 1 info))))
726 (push (elisp--xref-make-xref 'cl-defmethod met-name file summary) xrefs))
728 (let ((summary (format elisp--xref-format-extra 'cl-defmethod symbol "()")))
729 (push (elisp--xref-make-xref 'cl-defmethod met-name file summary) xrefs))))
732 (if (and (setq doc (documentation symbol t))
733 ;; This doc string is created somewhere in
734 ;; cl--generic-make-function for an implicit
736 (string-match "\n\n(fn ARG &rest ARGS)" doc))
737 ;; This symbol is an implicitly defined defgeneric, so
740 (push (elisp--xref-make-xref 'cl-defgeneric symbol file) xrefs))
744 (push (elisp--xref-make-xref nil symbol file) xrefs))
747 (when (boundp symbol)
749 (let ((file (find-lisp-object-file-name symbol 'defvar)))
753 ;; The doc strings from the C source have not been loaded
754 ;; yet; help-C-file-name does that. Second call will
755 ;; return "src/*.c" in file; handled below.
756 (push (elisp--xref-make-xref 'defvar symbol (help-C-file-name symbol 'var)) xrefs))
758 ((string= "src/" (substring file 0 4))
759 ;; The variable is defined in a C source file; don't check
760 ;; for define-minor-mode.
761 (push (elisp--xref-make-xref 'defvar symbol file) xrefs))
763 ((memq symbol minor-mode-list)
764 ;; The symbol is a minor mode. These should be defined by
765 ;; "define-minor-mode", which means the variable and the
766 ;; function are declared in the same place. So we return only
767 ;; the function, arbitrarily.
769 ;; There is an exception, when the variable is defined in C
770 ;; code, as for abbrev-mode.
772 ;; IMPROVEME: If the user is searching for the identifier at
773 ;; point, we can determine whether it is a variable or
774 ;; function by looking at the source code near point.
776 ;; IMPROVEME: The user may actually be asking "do any
777 ;; variables by this name exist"; we need a way to specify
782 (push (elisp--xref-make-xref 'defvar symbol file) xrefs))
786 (when (featurep symbol)
787 (let ((file (ignore-errors
788 (find-library-name (symbol-name symbol)))))
790 (push (elisp--xref-make-xref 'feature symbol file) xrefs))))
795 (declare-function project-external-roots "project")
797 (cl-defmethod xref-backend-apropos ((_backend (eql elisp)) regexp)
800 (dolist (sym (apropos-internal regexp))
801 (push (elisp--xref-find-definitions sym) lst))
804 (defvar elisp--xref-identifier-completion-table
805 (apply-partially #'completion-table-with-predicate
814 (cl-defmethod xref-backend-identifier-completion-table ((_backend (eql elisp)))
815 elisp--xref-identifier-completion-table)
817 (cl-defstruct (xref-elisp-location
818 (:constructor xref-make-elisp-location (symbol type file)))
819 "Location of an Emacs Lisp symbol definition."
822 (cl-defmethod xref-location-marker ((l xref-elisp-location))
823 (pcase-let (((cl-struct xref-elisp-location symbol type file) l))
824 (let ((buffer-point (find-function-search-for-symbol symbol type file)))
825 (with-current-buffer (car buffer-point)
827 (goto-char (or (cdr buffer-point) (point-min)))
830 (cl-defmethod xref-location-group ((l xref-elisp-location))
831 (xref-elisp-location-file l))
833 (defun elisp-load-path-roots ()
834 (if (boundp 'package-user-dir)
835 (cons package-user-dir load-path)
838 ;;; Elisp Interaction mode
840 (defvar lisp-interaction-mode-map
841 (let ((map (make-sparse-keymap))
842 (menu-map (make-sparse-keymap "Lisp-Interaction")))
843 (set-keymap-parent map lisp-mode-shared-map)
844 (define-key map "\e\C-x" 'eval-defun)
845 (define-key map "\e\C-q" 'indent-pp-sexp)
846 (define-key map "\e\t" 'completion-at-point)
847 (define-key map "\n" 'eval-print-last-sexp)
848 (bindings--define-key map [menu-bar lisp-interaction]
849 (cons "Lisp-Interaction" menu-map))
850 (bindings--define-key menu-map [eval-defun]
851 '(menu-item "Evaluate Defun" eval-defun
852 :help "Evaluate the top-level form containing point, or after point"))
853 (bindings--define-key menu-map [eval-print-last-sexp]
854 '(menu-item "Evaluate and Print" eval-print-last-sexp
855 :help "Evaluate sexp before point; print value into current buffer"))
856 (bindings--define-key menu-map [edebug-defun-lisp-interaction]
857 '(menu-item "Instrument Function for Debugging" edebug-defun
858 :help "Evaluate the top level form point is in, stepping through with Edebug"
860 (bindings--define-key menu-map [indent-pp-sexp]
861 '(menu-item "Indent or Pretty-Print" indent-pp-sexp
862 :help "Indent each line of the list starting just after point, or prettyprint it"))
863 (bindings--define-key menu-map [complete-symbol]
864 '(menu-item "Complete Lisp Symbol" completion-at-point
865 :help "Perform completion on Lisp symbol preceding point"))
867 "Keymap for Lisp Interaction mode.
868 All commands in `lisp-mode-shared-map' are inherited by this map.")
870 (define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
871 "Major mode for typing and evaluating Lisp forms.
872 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
873 before point, and prints its value into the buffer, advancing point.
874 Note that printing is controlled by `eval-expression-print-length'
875 and `eval-expression-print-level'.
878 Delete converts tabs to spaces as it moves back.
879 Paragraphs are separated only by blank lines.
880 Semicolons start comments.
882 \\{lisp-interaction-mode-map}"
885 ;;; Emacs Lisp Byte-Code mode
888 (defconst emacs-list-byte-code-comment-re
889 (concat "\\(#\\)@\\([0-9]+\\) "
890 ;; Make sure it's a docstring and not a lazy-loaded byte-code.
891 "\\(?:[^(]\\|([^\"]\\)")))
893 (defun elisp--byte-code-comment (end &optional _point)
894 "Try to syntactically mark the #@NNN ....^_ docstrings in byte-code files."
895 (let ((ppss (syntax-ppss)))
896 (when (and (nth 4 ppss)
897 (eq (char-after (nth 8 ppss)) ?#))
898 (let* ((n (save-excursion
899 (goto-char (nth 8 ppss))
900 (when (looking-at emacs-list-byte-code-comment-re)
901 (string-to-number (match-string 2)))))
902 ;; `maxdiff' tries to make sure the loop below terminates.
905 (let* ((bchar (match-end 2))
906 (b (position-bytes bchar)))
908 (while (let ((diff (- (position-bytes (point)) b n)))
910 (when (> diff maxdiff) (setq diff maxdiff))
911 (forward-char (- diff))
912 (setq maxdiff (if (> diff 0) diff
913 (max (1- maxdiff) 1)))
916 (put-text-property (1- (point)) (point)
918 (string-to-syntax "> b"))
919 (goto-char end)))))))
921 (defun elisp-byte-code-syntax-propertize (start end)
923 (elisp--byte-code-comment end (point))
925 (syntax-propertize-rules
926 (emacs-list-byte-code-comment-re
927 (1 (prog1 "< b" (elisp--byte-code-comment end (point))))))
931 (add-to-list 'auto-mode-alist '("\\.elc\\'" . elisp-byte-code-mode))
933 (define-derived-mode elisp-byte-code-mode emacs-lisp-mode
935 "Major mode for *.elc files."
936 ;; TODO: Add way to disassemble byte-code under point.
937 (setq-local open-paren-in-column-0-is-defun-start nil)
938 (setq-local syntax-propertize-function
939 #'elisp-byte-code-syntax-propertize))
942 ;;; Globally accessible functionality
944 (defun eval-print-last-sexp (&optional eval-last-sexp-arg-internal)
945 "Evaluate sexp before point; print value into current buffer.
947 Normally, this function truncates long output according to the value
948 of the variables `eval-expression-print-length' and
949 `eval-expression-print-level'. With a prefix argument of zero,
950 however, there is no such truncation. Such a prefix argument
951 also causes integers to be printed in several additional formats
952 \(octal, hexadecimal, and character).
954 If `eval-expression-debug-on-error' is non-nil, which is the default,
955 this command arranges for all errors to enter the debugger."
957 (let ((standard-output (current-buffer)))
959 (eval-last-sexp (or eval-last-sexp-arg-internal t))
963 (defun last-sexp-setup-props (beg end value alt1 alt2)
964 "Set up text properties for the output of `elisp--eval-last-sexp'.
965 BEG and END are the start and end of the output in current-buffer.
966 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
967 alternative printed representations that can be displayed."
968 (let ((map (make-sparse-keymap)))
969 (define-key map "\C-m" 'elisp-last-sexp-toggle-display)
970 (define-key map [down-mouse-2] 'mouse-set-point)
971 (define-key map [mouse-2] 'elisp-last-sexp-toggle-display)
974 `(printed-value (,value ,alt1 ,alt2)
977 help-echo "RET, mouse-2: toggle abbreviated display"
978 rear-nonsticky (mouse-face keymap help-echo
982 (defun elisp-last-sexp-toggle-display (&optional _arg)
983 "Toggle between abbreviated and unabbreviated printed representations."
987 (let ((value (get-text-property (point) 'printed-value)))
989 (let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
992 (end (or (next-single-char-property-change (point) 'printed-value) (point)))
993 (standard-output (current-buffer))
995 (delete-region beg end)
996 (insert (nth 1 value))
998 (setq point (1- (point))))
999 (last-sexp-setup-props beg (point)
1003 (goto-char (min (point-max) point)))))))
1005 (defun prin1-char (char) ;FIXME: Move it, e.g. to simple.el.
1006 "Return a string representing CHAR as a character rather than as an integer.
1007 If CHAR is not a character, return nil."
1008 (and (integerp char)
1010 (let ((c (event-basic-type char))
1011 (mods (event-modifiers char))
1013 ;; Prevent ?A from turning into ?\S-a.
1014 (if (and (memq 'shift mods)
1015 (zerop (logand char ?\S-\^@))
1016 (not (let ((case-fold-search nil))
1017 (char-equal c (upcase c)))))
1018 (setq c (upcase c) mods nil))
1019 ;; What string are we considering using?
1026 (cond ((eq modif 'super) "\\s-")
1027 (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
1030 ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
1031 ((eq c 127) "\\C-?")
1035 ;; Verify the string reads a CHAR, not to some other character.
1036 ;; If it doesn't, return nil instead.
1038 (= (car (read-from-string string)) char)
1041 (defun elisp--preceding-sexp ()
1042 "Return sexp before the point."
1043 (let ((opoint (point))
1047 (with-syntax-table emacs-lisp-mode-syntax-table
1048 ;; If this sexp appears to be enclosed in `...' or ‘...’
1049 ;; then ignore the surrounding quotes.
1050 (cond ((eq (preceding-char) ?’)
1051 (progn (forward-char -1) (setq opoint (point))))
1052 ((or (eq (following-char) ?\')
1053 (eq (preceding-char) ?\'))
1054 (setq left-quote ?\`)))
1056 ;; When after a named character literal, skip over the entire
1057 ;; literal, not only its last word.
1058 (when (= (preceding-char) ?})
1059 (let ((begin (save-excursion
1061 (skip-syntax-backward "w-")
1063 (when (looking-at-p "\\\\N{") (point)))))
1064 (when begin (goto-char begin))))
1067 ;; If we were after `?\e' (or similar case),
1068 ;; use the whole thing, not just the `e'.
1069 (when (eq (preceding-char) ?\\)
1071 (when (eq (preceding-char) ??)
1074 ;; Skip over hash table read syntax.
1075 (and (> (point) (1+ (point-min)))
1076 (looking-back "#s" (- (point) 2))
1079 ;; Skip over `#N='s.
1080 (when (eq (preceding-char) ?=)
1083 (skip-chars-backward "0-9#=")
1084 (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
1086 (forward-sexp -1))))
1089 (if (eq (following-char) left-quote)
1090 ;; vladimir@cs.ualberta.ca 30-Jul-1997: Skip ` in `variable' so
1091 ;; that the value is returned, not the name.
1093 (when (looking-at ",@?") (goto-char (match-end 0)))
1094 (narrow-to-region (point-min) opoint)
1095 (setq expr (read (current-buffer)))
1096 ;; If it's an (interactive ...) form, it's more useful to show how an
1097 ;; interactive call would use it.
1098 ;; FIXME: Is it really the right place for this?
1099 (when (eq (car-safe expr) 'interactive)
1101 `(call-interactively
1102 (lambda (&rest args) ,expr args))))
1104 (define-obsolete-function-alias 'preceding-sexp 'elisp--preceding-sexp "25.1")
1106 (defun elisp--eval-last-sexp (eval-last-sexp-arg-internal)
1107 "Evaluate sexp before point; print value in the echo area.
1108 If EVAL-LAST-SEXP-ARG-INTERNAL is non-nil, print output into
1109 current buffer. If EVAL-LAST-SEXP-ARG-INTERNAL is `0', print
1110 output with no limit on the length and level of lists, and
1111 include additional formats for integers \(octal, hexadecimal, and
1113 (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
1114 ;; Setup the lexical environment if lexical-binding is enabled.
1115 (elisp--eval-last-sexp-print-value
1116 (eval (eval-sexp-add-defvars (elisp--preceding-sexp)) lexical-binding)
1117 eval-last-sexp-arg-internal)))
1119 (defun elisp--eval-last-sexp-print-value (value &optional eval-last-sexp-arg-internal)
1120 (let ((unabbreviated (let ((print-length nil) (print-level nil))
1121 (prin1-to-string value)))
1122 (print-length (and (not (zerop (prefix-numeric-value
1123 eval-last-sexp-arg-internal)))
1124 eval-expression-print-length))
1125 (print-level (and (not (zerop (prefix-numeric-value
1126 eval-last-sexp-arg-internal)))
1127 eval-expression-print-level))
1132 (let ((str (eval-expression-print-format value)))
1133 (if str (princ str)))
1135 (when (and (bufferp standard-output)
1136 (or (not (null print-length))
1137 (not (null print-level)))
1138 (not (string= unabbreviated
1139 (buffer-substring-no-properties beg end))))
1140 (last-sexp-setup-props beg end value
1142 (buffer-substring-no-properties beg end))
1146 (defvar elisp--eval-last-sexp-fake-value (make-symbol "t"))
1148 (defun eval-sexp-add-defvars (exp &optional pos)
1149 "Prepend EXP with all the `defvar's that precede it in the buffer.
1150 POS specifies the starting position where EXP was found and defaults to point."
1151 (setq exp (macroexpand-all exp)) ;Eager macro-expansion.
1152 (if (not lexical-binding)
1155 (unless pos (setq pos (point)))
1157 (goto-char (point-min))
1158 (while (re-search-forward
1159 "(def\\(?:var\\|const\\|custom\\)[ \t\n]+\\([^; '()\n\t]+\\)"
1161 (let ((var (intern (match-string 1))))
1162 (and (not (special-variable-p var))
1164 (zerop (car (syntax-ppss (match-beginning 0)))))
1166 `(progn ,@(mapcar (lambda (v) `(defvar ,v)) vars) ,exp)))))
1168 (defun eval-last-sexp (eval-last-sexp-arg-internal)
1169 "Evaluate sexp before point; print value in the echo area.
1170 Interactively, with prefix argument, print output into current buffer.
1172 Normally, this function truncates long output according to the value
1173 of the variables `eval-expression-print-length' and
1174 `eval-expression-print-level'. With a prefix argument of zero,
1175 however, there is no such truncation. Such a prefix argument
1176 also causes integers to be printed in several additional formats
1177 \(octal, hexadecimal, and character).
1179 If `eval-expression-debug-on-error' is non-nil, which is the default,
1180 this command arranges for all errors to enter the debugger."
1182 (if (null eval-expression-debug-on-error)
1183 (elisp--eval-last-sexp eval-last-sexp-arg-internal)
1185 (let ((debug-on-error elisp--eval-last-sexp-fake-value))
1186 (cons (elisp--eval-last-sexp eval-last-sexp-arg-internal)
1188 (unless (eq (cdr value) elisp--eval-last-sexp-fake-value)
1189 (setq debug-on-error (cdr value)))
1192 (defun elisp--eval-defun-1 (form)
1193 "Treat some expressions specially.
1194 Reset the `defvar' and `defcustom' variables to the initial value.
1195 \(For `defcustom', use the :set function if there is one.)
1196 Reinitialize the face according to the `defface' specification."
1197 ;; The code in edebug-defun should be consistent with this, but not
1198 ;; the same, since this gets a macroexpanded form.
1199 (cond ((not (listp form))
1201 ((and (eq (car form) 'defvar)
1202 (cdr-safe (cdr-safe form))
1203 (boundp (cadr form)))
1204 ;; Force variable to be re-set.
1205 `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
1206 (setq-default ,(nth 1 form) ,(nth 2 form))))
1207 ;; `defcustom' is now macroexpanded to
1208 ;; `custom-declare-variable' with a quoted value arg.
1209 ((and (eq (car form) 'custom-declare-variable)
1210 (default-boundp (eval (nth 1 form) lexical-binding)))
1211 ;; Force variable to be bound, using :set function if specified.
1212 (let ((setfunc (memq :set form)))
1214 (setq setfunc (car-safe (cdr-safe setfunc)))
1215 (or (functionp setfunc) (setq setfunc nil)))
1216 (funcall (or setfunc 'set-default)
1217 (eval (nth 1 form) lexical-binding)
1218 ;; The second arg is an expression that evaluates to
1219 ;; an expression. The second evaluation is the one
1220 ;; normally performed not by normal execution but by
1221 ;; custom-initialize-set (for example), which does not
1222 ;; use lexical-binding.
1223 (eval (eval (nth 2 form) lexical-binding))))
1225 ;; `defface' is macroexpanded to `custom-declare-face'.
1226 ((eq (car form) 'custom-declare-face)
1228 (let ((face-symbol (eval (nth 1 form) lexical-binding)))
1229 (setq face-new-frame-defaults
1230 (assq-delete-all face-symbol face-new-frame-defaults))
1231 (put face-symbol 'face-defface-spec nil)
1232 (put face-symbol 'face-override-spec nil))
1234 ((eq (car form) 'progn)
1235 (cons 'progn (mapcar #'elisp--eval-defun-1 (cdr form))))
1238 (defun elisp--eval-defun ()
1239 "Evaluate defun that point is in or before.
1240 The value is displayed in the echo area.
1241 If the current defun is actually a call to `defvar',
1242 then reset the variable using the initial value expression
1243 even if the variable already has some other value.
1244 \(Normally `defvar' does not change the variable's value
1245 if it already has a value.)
1247 Return the result of evaluation."
1248 ;; FIXME: the print-length/level bindings should only be applied while
1249 ;; printing, not while evaluating.
1250 (let ((debug-on-error eval-expression-debug-on-error)
1251 (print-length eval-expression-print-length)
1252 (print-level eval-expression-print-level))
1254 ;; Arrange for eval-region to "read" the (possibly) altered form.
1255 ;; eval-region handles recording which file defines a function or
1257 (let ((standard-output t)
1259 ;; Read the form from the buffer, and record where it ends.
1262 (beginning-of-defun)
1264 (setq form (read (current-buffer)))
1266 ;; Alter the form if necessary.
1267 (let ((form (eval-sexp-add-defvars
1268 (elisp--eval-defun-1 (macroexpand form)))))
1269 (eval-region beg end standard-output
1271 ;; Skipping to the end of the specified region
1272 ;; will make eval-region return.
1275 (let ((str (eval-expression-print-format (car values))))
1276 (if str (princ str)))
1277 ;; The result of evaluation has been put onto VALUES. So return it.
1280 (defun eval-defun (edebug-it)
1281 "Evaluate the top-level form containing point, or after point.
1283 If the current defun is actually a call to `defvar' or `defcustom',
1284 evaluating it this way resets the variable using its initial value
1285 expression (using the defcustom's :set function if there is one), even
1286 if the variable already has some other value. \(Normally `defvar' and
1287 `defcustom' do not alter the value if there already is one.) In an
1288 analogous way, evaluating a `defface' overrides any customizations of
1289 the face, so that it becomes defined exactly as the `defface' expression
1292 If `eval-expression-debug-on-error' is non-nil, which is the default,
1293 this command arranges for all errors to enter the debugger.
1295 With a prefix argument, instrument the code for Edebug.
1297 If acting on a `defun' for FUNCTION, and the function was
1298 instrumented, `Edebug: FUNCTION' is printed in the echo area. If not
1299 instrumented, just FUNCTION is printed.
1301 If not acting on a `defun', the result of evaluation is displayed in
1302 the echo area. This display is controlled by the variables
1303 `eval-expression-print-length' and `eval-expression-print-level',
1308 (eval-defun (not edebug-all-defs)))
1310 (if (null eval-expression-debug-on-error)
1312 (let (new-value value)
1313 (let ((debug-on-error elisp--eval-last-sexp-fake-value))
1314 (setq value (elisp--eval-defun))
1315 (setq new-value debug-on-error))
1316 (unless (eq elisp--eval-last-sexp-fake-value new-value)
1317 (setq debug-on-error new-value))
1322 (defvar elisp--eldoc-last-data (make-vector 3 nil)
1323 "Bookkeeping; elements are as follows:
1324 0 - contains the last symbol read from the buffer.
1325 1 - contains the string last displayed in the echo area for variables,
1326 or argument string for functions.
1327 2 - `function' if function args, `variable' if variable documentation.")
1329 (defun elisp-eldoc-documentation-function ()
1330 "`eldoc-documentation-function' (which see) for Emacs Lisp."
1331 (let ((current-symbol (elisp--current-symbol))
1332 (current-fnsym (elisp--fnsym-in-current-sexp)))
1333 (cond ((null current-fnsym)
1335 ((eq current-symbol (car current-fnsym))
1336 (or (apply #'elisp-get-fnsym-args-string current-fnsym)
1337 (elisp-get-var-docstring current-symbol)))
1339 (or (elisp-get-var-docstring current-symbol)
1340 (apply #'elisp-get-fnsym-args-string current-fnsym))))))
1342 (defun elisp-get-fnsym-args-string (sym &optional index prefix)
1343 "Return a string containing the parameter list of the function SYM.
1344 If SYM is a subr and no arglist is obtainable from the docstring
1345 or elsewhere, return a 1-line docstring."
1348 ((not (and sym (symbolp sym) (fboundp sym))) nil)
1349 ((and (eq sym (aref elisp--eldoc-last-data 0))
1350 (eq 'function (aref elisp--eldoc-last-data 2)))
1351 (aref elisp--eldoc-last-data 1))
1353 (let* ((advertised (gethash (indirect-function sym)
1354 advertised-signature-table t))
1358 ((listp advertised) advertised)
1359 ((setq doc (help-split-fundoc
1360 (condition-case nil (documentation sym t)
1361 (invalid-function nil))
1364 (t (help-function-arglist sym)))))
1365 ;; Stringify, and store before highlighting, downcasing, etc.
1366 (elisp--last-data-store sym (elisp-function-argstring args)
1368 ;; Highlight, truncate.
1370 (elisp--highlight-function-argument
1373 (concat (propertize (symbol-name sym) 'face
1375 'font-lock-function-name-face
1376 'font-lock-keyword-face))
1379 (defun elisp--highlight-function-argument (sym args index prefix)
1380 "Highlight argument INDEX in ARGS list for function SYM.
1381 In the absence of INDEX, just call `eldoc-docstring-format-sym-doc'."
1382 ;; FIXME: This should probably work on the list representation of `args'
1383 ;; rather than its string representation.
1384 ;; FIXME: This function is much too long, we need to split it up!
1387 (argument-face 'eldoc-highlight-function-argument)
1388 (args-lst (mapcar (lambda (x)
1389 (replace-regexp-in-string
1390 "\\`[(]\\|[)]\\'" "" x))
1391 (split-string args))))
1392 ;; Find the current argument in the argument string. We need to
1393 ;; handle `&rest' and informal `...' properly.
1395 ;; FIXME: What to do with optional arguments, like in
1396 ;; (defun NAME ARGLIST [DOCSTRING] BODY...) case?
1397 ;; The problem is there is no robust way to determine if
1398 ;; the current argument is indeed a docstring.
1400 ;; When `&key' is used finding position based on `index'
1401 ;; would be wrong, so find the arg at point and determine
1402 ;; position in ARGS based on this current arg.
1403 (when (string-match "&key" args)
1404 (let* (case-fold-search
1406 (sym-name (symbol-name sym))
1407 (cur-w (current-word))
1408 (args-lst-ak (cdr (member "&key" args-lst)))
1409 (limit (save-excursion
1410 (when (re-search-backward sym-name nil t)
1412 (cur-a (if (and cur-w (string-match ":\\([^ ()]*\\)" cur-w))
1416 (when (re-search-backward ":\\([^()\n]*\\)" limit t)
1417 (setq split (split-string (match-string 1) " " t))
1420 (setq key-have-value t))))))))
1421 ;; If `cur-a' is not one of `args-lst-ak'
1422 ;; assume user is entering an unknown key
1423 ;; referenced in last position in signature.
1424 (other-key-arg (and (stringp cur-a)
1426 (not (member (upcase cur-a) args-lst-ak))
1427 (upcase (car (last args-lst-ak))))))
1428 (unless (string= cur-w sym-name)
1429 ;; The last keyword have already a value
1430 ;; i.e :foo a b and cursor is at b.
1431 ;; If signature have also `&rest'
1432 ;; (assume it is after the `&key' section)
1433 ;; go to the arg after `&rest'.
1434 (if (and key-have-value
1436 (not (re-search-forward ":.*" (point-at-eol) t)))
1437 (string-match "&rest \\([^ ()]*\\)" args))
1438 (setq index nil ; Skip next block based on positional args.
1439 start (match-beginning 1)
1441 ;; If `cur-a' is nil probably cursor is on a positional arg
1442 ;; before `&key', in this case, exit this block and determine
1443 ;; position with `index'.
1444 (when (and cur-a ; A keyword arg (dot removed) or nil.
1446 (concat "\\_<" (upcase cur-a) "\\_>") args)
1448 (concat "\\_<" other-key-arg "\\_>") args)))
1449 (setq index nil ; Skip next block based on positional args.
1450 start (match-beginning 0)
1451 end (match-end 0)))))))
1452 ;; Handle now positional arguments.
1453 (while (and index (>= index 1))
1454 (if (string-match "[^ ()]+" args end)
1456 (setq start (match-beginning 0)
1458 (let ((argument (match-string 0 args)))
1459 (cond ((string= argument "&rest")
1460 ;; All the rest arguments are the same.
1462 ((string= argument "&optional")) ; Skip.
1463 ((string= argument "&allow-other-keys")) ; Skip.
1464 ;; Back to index 0 in ARG1 ARG2 ARG2 ARG3 etc...
1466 ((or (and (string-match-p "\\.\\.\\.\\'" argument)
1467 (string= argument (car (last args-lst))))
1468 (and (string-match-p "\\.\\.\\.\\'"
1469 (substring args 1 (1- (length args))))
1470 (= (length (remove "..." args-lst)) 2)
1471 (> index 1) (eq (logand index 1) 1)))
1474 (setq index (1- index))))))
1475 (setq end (length args)
1477 argument-face 'font-lock-warning-face
1481 (setq doc (copy-sequence args))
1482 (add-text-properties start end (list 'face argument-face) doc))
1483 (setq doc (eldoc-docstring-format-sym-doc prefix doc))
1486 ;; Return a string containing a brief (one-line) documentation string for
1488 (defun elisp-get-var-docstring (sym)
1489 (cond ((not sym) nil)
1490 ((and (eq sym (aref elisp--eldoc-last-data 0))
1491 (eq 'variable (aref elisp--eldoc-last-data 2)))
1492 (aref elisp--eldoc-last-data 1))
1494 (let ((doc (documentation-property sym 'variable-documentation t)))
1496 (let ((doc (eldoc-docstring-format-sym-doc
1497 sym (elisp--docstring-first-line doc)
1498 'font-lock-variable-name-face)))
1499 (elisp--last-data-store sym doc 'variable)))))))
1501 (defun elisp--last-data-store (symbol doc type)
1502 (aset elisp--eldoc-last-data 0 symbol)
1503 (aset elisp--eldoc-last-data 1 doc)
1504 (aset elisp--eldoc-last-data 2 type)
1507 ;; Note that any leading `*' in the docstring (which indicates the variable
1508 ;; is a user option) is removed.
1509 (defun elisp--docstring-first-line (doc)
1511 (substitute-command-keys
1513 ;; Don't use "^" in the regexp below since it may match
1514 ;; anywhere in the doc-string.
1515 (let ((start (if (string-match "\\`\\*" doc) (match-end 0) 0)))
1516 (cond ((string-match "\n" doc)
1517 (substring doc start (match-beginning 0)))
1519 (t (substring doc start))))))))
1521 ;; Return a list of current function name and argument index.
1522 (defun elisp--fnsym-in-current-sexp ()
1524 (let ((argument-index (1- (elisp--beginning-of-sexp))))
1525 ;; If we are at the beginning of function name, this will be -1.
1526 (when (< argument-index 0)
1527 (setq argument-index 0))
1528 ;; Don't do anything if current word is inside a string.
1529 (if (= (or (char-after (1- (point))) 0) ?\")
1531 (list (elisp--current-symbol) argument-index)))))
1533 ;; Move to the beginning of current sexp. Return the number of nested
1534 ;; sexp the point was over or after.
1535 (defun elisp--beginning-of-sexp ()
1536 (let ((parse-sexp-ignore-comments t)
1537 (num-skipped-sexps 0))
1540 ;; First account for the case the point is directly over a
1541 ;; beginning of a nested sexp.
1547 (setq num-skipped-sexps 1)))
1553 (setq num-skipped-sexps (1+ num-skipped-sexps))))))
1557 ;; returns nil unless current word is an interned symbol.
1558 (defun elisp--current-symbol ()
1559 (let ((c (char-after (point))))
1561 (memq (char-syntax c) '(?w ?_))
1562 (intern-soft (current-word)))))
1564 (defun elisp-function-argstring (arglist)
1565 "Return ARGLIST as a string enclosed by ().
1566 ARGLIST is either a string, or a list of strings or symbols."
1567 (let ((str (cond ((stringp arglist) arglist)
1568 ((not (listp arglist)) nil)
1569 (t (substitute-command-keys
1570 (help--make-usage-docstring 'toto arglist))))))
1571 (if (and str (string-match "\\`([^ )]+ ?" str))
1572 (replace-match "(" t t str)
1575 (provide 'elisp-mode)
1576 ;;; elisp-mode.el ends here