1 ;;; elisp-mode.el --- Emacs Lisp mode -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1999-2015 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 xref-find-function)
232 (defvar xref-identifier-completion-table-function)
233 (defvar project-search-path-function)
234 (lisp-mode-variables nil nil 'elisp)
235 (add-hook 'after-load-functions #'elisp--font-lock-flush-elisp-buffers)
236 (setq-local electric-pair-text-pairs
237 (append '((?\` . ?\') (?‘ . ?’)) electric-pair-text-pairs))
238 (setq-local electric-quote-string t)
239 (setq imenu-case-fold-search nil)
240 (add-function :before-until (local 'eldoc-documentation-function)
241 #'elisp-eldoc-documentation-function)
242 (setq-local xref-find-function #'elisp-xref-find)
243 (setq-local xref-identifier-completion-table-function
244 #'elisp--xref-identifier-completion-table)
245 (setq-local project-search-path-function #'elisp-search-path)
246 (add-hook 'completion-at-point-functions
247 #'elisp-completion-at-point nil 'local))
249 ;; Font-locking support.
251 (defun elisp--font-lock-flush-elisp-buffers (&optional file)
252 ;; FIXME: Aren't we only ever called from after-load-functions?
253 ;; Don't flush during load unless called from after-load-functions.
254 ;; In that case, FILE is non-nil. It's somehow strange that
255 ;; load-in-progress is t when an after-load-function is called since
256 ;; that should run *after* the load...
257 (when (or (not load-in-progress) file)
258 ;; FIXME: If the loaded file did not define any macros, there shouldn't
259 ;; be any need to font-lock-flush all the Elisp buffers.
260 (dolist (buf (buffer-list))
261 (with-current-buffer buf
262 (when (derived-mode-p 'emacs-lisp-mode)
263 ;; So as to take into account new macros that may have been defined
264 ;; by the just-loaded file.
265 (font-lock-flush))))))
267 ;;; Completion at point for Elisp
269 (defun elisp--local-variables-1 (vars sexp)
270 "Return the vars locally bound around the witness, or nil if not found."
276 (`(,(or `let `let*) ,bindings)
278 (when (eq 'let* (car sexp))
279 (dolist (binding (cdr (reverse bindings)))
280 (push (or (car-safe binding) binding) vars)))
281 (elisp--local-variables-1
282 vars (car (cdr-safe (car (last bindings)))))))
283 (`(,(or `let `let*) ,bindings . ,body)
285 (dolist (binding bindings)
286 (push (or (car-safe binding) binding) vars))
287 (elisp--local-variables-1 vars (car (last body)))))
289 ;; FIXME: Look for the witness inside `args'.
291 (`(lambda ,args . ,body)
292 (elisp--local-variables-1
293 (append (remq '&optional (remq '&rest args)) vars)
295 (`(condition-case ,_ ,e) (elisp--local-variables-1 vars e))
296 (`(condition-case ,v ,_ . ,catches)
297 (elisp--local-variables-1
298 (cons v vars) (cdr (car (last catches)))))
300 ;; FIXME: Look for the witness inside sexp.
302 ;; FIXME: Handle `cond'.
304 (elisp--local-variables-1 vars (car (last sexp))))
305 (`elisp--witness--lisp (or vars '(nil)))
307 ;; We didn't find the witness in the last element so we try to
308 ;; backtrack to the last-but-one.
309 (setq sexp (ignore-errors (butlast sexp)))))
312 (defun elisp--local-variables ()
313 "Return a list of locally let-bound variables at point."
315 (skip-syntax-backward "w_")
316 (let* ((ppss (syntax-ppss))
317 (txt (buffer-substring-no-properties (or (car (nth 9 ppss)) (point))
318 (or (nth 8 ppss) (point))))
320 (dolist (p (nth 9 ppss))
321 (push (cdr (syntax-after p)) closer))
322 (setq closer (apply #'string closer))
323 (let* ((sexp (condition-case nil
324 (car (read-from-string
325 (concat txt "elisp--witness--lisp" closer)))
326 ((invalid-read-syntax end-of-file) nil)))
327 (macroexpand-advice (lambda (expander form &rest args)
329 (apply expander form args)
334 (advice-add 'macroexpand :around macroexpand-advice)
335 (macroexpand-all sexp))
336 (advice-remove 'macroexpand macroexpand-advice)))
337 (vars (elisp--local-variables-1 nil sexp)))
339 (mapcar (lambda (var)
341 (not (string-match (symbol-name var) "\\`[&_]"))
342 ;; Eliminate uninterned vars.
347 (defvar elisp--local-variables-completion-table
348 ;; Use `defvar' rather than `defconst' since defconst would purecopy this
349 ;; value, which would doubly fail: it would fail because purecopy can't
350 ;; handle the recursive bytecode object, and it would fail because it would
351 ;; move `lastpos' and `lastvars' to pure space where they'd be immutable!
352 (let ((lastpos nil) (lastvars nil))
353 (letrec ((hookfun (lambda ()
355 (remove-hook 'post-command-hook hookfun))))
356 (completion-table-dynamic
359 (skip-syntax-backward "_w")
360 (let ((newpos (cons (point) (current-buffer))))
361 (unless (equal lastpos newpos)
362 (add-hook 'post-command-hook hookfun)
363 (setq lastpos newpos)
365 (mapcar #'symbol-name (elisp--local-variables))))))
368 (defun elisp--expect-function-p (pos)
369 "Return non-nil if the symbol at point is expected to be a function."
371 (and (eq (char-before pos) ?')
372 (eq (char-before (1- pos)) ?#))
374 (let ((parent (nth 1 (syntax-ppss pos))))
378 (looking-at (concat "(\\(cl-\\)?"
379 (regexp-opt '("declare-function"
380 "function" "defadvice"
384 (eq (match-end 0) pos)))))))
386 (defun elisp--form-quoted-p (pos)
387 "Return non-nil if the form at POS is not evaluated.
388 It can be quoted, or be inside a quoted form."
389 ;; FIXME: Do some macro expansion maybe.
391 (let ((state (syntax-ppss pos)))
392 (or (nth 8 state) ; Code inside strings usually isn't evaluated.
393 ;; FIXME: The 9th element is undocumented.
394 (let ((nesting (cons (point) (reverse (nth 9 state))))
396 (while (and nesting (not res))
397 (goto-char (pop nesting))
399 ((or (eq (char-after) ?\[)
401 (skip-chars-backward " ")
402 (memq (char-before) '(?' ?` ?‘))))
404 ((eq (char-before) ?,)
405 (setq nesting nil))))
408 ;; FIXME: Support for Company brings in features which straddle eldoc.
409 ;; We should consolidate this, so that major modes can provide all that
411 ;; - a function to extract "the reference at point" (may be more complex
412 ;; than a mere string, to distinguish various namespaces).
413 ;; - a function to jump to such a reference.
414 ;; - a function to show the signature/interface of such a reference.
415 ;; - a function to build a help-buffer about that reference.
416 ;; FIXME: Those functions should also be used by the normal completion code in
417 ;; the *Completions* buffer.
419 (defun elisp--company-doc-buffer (str)
420 (let ((symbol (intern-soft str)))
421 ;; FIXME: we really don't want to "display-buffer and then undo it".
422 (save-window-excursion
423 ;; Make sure we don't display it in another frame, otherwise
424 ;; save-window-excursion won't be able to undo it.
425 (let ((display-buffer-overriding-action
426 '(nil . ((inhibit-switch-frame . t)))))
429 ((fboundp symbol) (describe-function symbol))
430 ((boundp symbol) (describe-variable symbol))
431 ((featurep symbol) (describe-package symbol))
432 ((facep symbol) (describe-face symbol))
433 (t (signal 'user-error nil)))
436 (defun elisp--company-doc-string (str)
437 (let* ((symbol (intern-soft str))
438 (doc (if (fboundp symbol)
439 (documentation symbol t)
440 (documentation-property symbol 'variable-documentation t))))
442 (string-match ".*$" doc)
443 (match-string 0 doc))))
445 ;; can't (require 'find-func) in a preloaded file
446 (declare-function find-library-name "find-func" (library))
447 (declare-function find-function-library "find-func" (function &optional l-o v))
449 (defun elisp--company-location (str)
450 (let ((sym (intern-soft str)))
452 ((fboundp sym) (find-definition-noselect sym nil))
453 ((boundp sym) (find-definition-noselect sym 'defvar))
456 (cons (find-file-noselect (find-library-name
459 ((facep sym) (find-definition-noselect sym 'defface)))))
461 (defun elisp-completion-at-point ()
462 "Function used for `completion-at-point-functions' in `emacs-lisp-mode'."
463 (with-syntax-table emacs-lisp-mode-syntax-table
465 (beg (condition-case nil
468 (skip-chars-forward "`',‘#")
472 (unless (or (eq beg (point-max))
473 (member (char-syntax (char-after beg))
479 (skip-chars-backward "'’")
480 (when (>= (point) pos)
483 ;; t if in function position.
484 (funpos (eq (char-before beg) ?\())
485 (quoted (elisp--form-quoted-p beg)))
486 (when (and end (or (not (nth 8 (syntax-ppss)))
487 (memq (char-before beg) '(?` ?‘))))
489 (if (or (not funpos) quoted)
490 ;; FIXME: We could look at the first element of the list and
491 ;; use it to provide a more specific completion table in some
492 ;; cases. E.g. filter out keywords that are not understood by
493 ;; the macro/function being called.
495 ((elisp--expect-function-p beg)
498 :company-doc-buffer #'elisp--company-doc-buffer
499 :company-docsig #'elisp--company-doc-string
500 :company-location #'elisp--company-location))
503 ;; Don't include all symbols (bug#16646).
504 :predicate (lambda (sym)
510 (lambda (str) (if (fboundp (intern-soft str)) " <f>"))
511 :company-doc-buffer #'elisp--company-doc-buffer
512 :company-docsig #'elisp--company-doc-string
513 :company-location #'elisp--company-location))
515 (list nil (completion-table-merge
516 elisp--local-variables-completion-table
517 (apply-partially #'completion-table-with-predicate
521 :company-doc-buffer #'elisp--company-doc-buffer
522 :company-docsig #'elisp--company-doc-string
523 :company-location #'elisp--company-location)))
524 ;; Looks like a funcall position. Let's double check.
529 (progn (up-list -1) (forward-char 1)
530 (let ((c (char-after)))
532 (if (memq (char-syntax c) '(?w ?_))
533 (read (current-buffer))))))
536 ;; FIXME: Rather than hardcode special cases here,
537 ;; we should use something like a symbol-property.
539 (list t (mapcar (lambda (x) (symbol-name (car x)))
541 ;; FIXME: We should include some
542 ;; docstring with each entry.
544 macro-declarations-alist
545 defun-declarations-alist)))))
546 ((and (or `condition-case `condition-case-unless-debug)
547 (guard (save-excursion
552 :predicate (lambda (sym) (get sym 'error-conditions))))
553 ((and (or ?\( `let `let*)
554 (guard (save-excursion
556 (when (eq parent ?\()
559 (looking-at "\\_<let\\*?\\_>"))))
562 :company-doc-buffer #'elisp--company-doc-buffer
563 :company-docsig #'elisp--company-doc-string
564 :company-location #'elisp--company-location))
567 :company-doc-buffer #'elisp--company-doc-buffer
568 :company-docsig #'elisp--company-doc-string
569 :company-location #'elisp--company-location
571 (nconc (list beg end)
572 (if (null (car table-etc))
575 (if (memq (char-syntax (or (char-after end) ?\s))
578 (apply-partially 'completion-table-with-terminator
579 " " (cadr table-etc)))
580 (cddr table-etc)))))))))
582 (define-obsolete-function-alias
583 'lisp-completion-at-point 'elisp-completion-at-point "25.1")
587 (declare-function xref-make-bogus-location "xref" (message))
588 (declare-function xref-make "xref" (summary location))
589 (declare-function xref-collect-references "xref" (symbol dir))
591 (defun elisp-xref-find (action id)
593 ;; FIXME: use information in source near point to filter results:
594 ;; (dvc-log-edit ...) - exclude 'feature
595 ;; (require 'dvc-log-edit) - only 'feature
596 ;; Semantic may provide additional information
599 (let ((sym (intern-soft id)))
601 (elisp--xref-find-definitions sym))))
603 (elisp--xref-find-references id))
605 (elisp--xref-find-apropos id))))
607 ;; WORKAROUND: This is nominally a constant, but the text properties
608 ;; are not preserved thru dump if use defconst. See bug#21237.
609 (defvar elisp--xref-format
610 (let ((str "(%s %s)"))
611 (put-text-property 1 3 'face 'font-lock-keyword-face str)
612 (put-text-property 4 6 'face 'font-lock-function-name-face str)
615 ;; WORKAROUND: This is nominally a constant, but the text properties
616 ;; are not preserved thru dump if use defconst. See bug#21237.
617 (defvar elisp--xref-format-extra
618 (let ((str "(%s %s %s)"))
619 (put-text-property 1 3 'face 'font-lock-keyword-face str)
620 (put-text-property 4 6 'face 'font-lock-function-name-face str)
623 (defvar find-feature-regexp)
625 (defun elisp--xref-make-xref (type symbol file &optional summary)
626 "Return an xref for TYPE SYMBOL in FILE.
627 TYPE must be a type in `find-function-regexp-alist' (use nil for
628 'defun). If SUMMARY is non-nil, use it for the summary;
629 otherwise build the summary from TYPE and SYMBOL."
630 (xref-make (or summary
631 (format elisp--xref-format (or type 'defun) symbol))
632 (xref-make-elisp-location symbol type file)))
634 (defun elisp--xref-find-definitions (symbol)
635 ;; The file name is not known when `symbol' is defined via interactive eval.
637 ;; alphabetical by result type symbol
639 ;; FIXME: advised function; list of advice functions
641 ;; FIXME: aliased variable
643 (when (and (symbolp symbol)
644 (symbol-function symbol)
645 (symbolp (symbol-function symbol)))
647 (let* ((alias-symbol symbol)
648 (alias-file (symbol-file alias-symbol))
649 (real-symbol (symbol-function symbol))
650 (real-file (find-lisp-object-file-name real-symbol 'defun)))
653 (push (elisp--xref-make-xref nil real-symbol real-file) xrefs))
656 (push (elisp--xref-make-xref 'defalias alias-symbol alias-file) xrefs))))
659 (let ((file (find-lisp-object-file-name symbol 'defface)))
661 (push (elisp--xref-make-xref 'defface symbol file) xrefs))))
663 (when (fboundp symbol)
664 (let ((file (find-lisp-object-file-name symbol (symbol-function symbol)))
669 ;; First call to find-lisp-object-file-name for an object
670 ;; defined in C; the doc strings from the C source have
671 ;; not been loaded yet. Second call will return "src/*.c"
672 ;; in file; handled by 't' case below.
673 (push (elisp--xref-make-xref nil symbol (help-C-file-name (symbol-function symbol) 'subr)) xrefs))
675 ((and (setq doc (documentation symbol t))
676 ;; This doc string is defined in cl-macs.el cl-defstruct
677 (string-match "Constructor for objects of type `\\(.*\\)'" doc))
678 ;; `symbol' is a name for the default constructor created by
679 ;; cl-defstruct, so return the location of the cl-defstruct.
680 (let* ((type-name (match-string 1 doc))
681 (type-symbol (intern type-name))
682 (file (find-lisp-object-file-name type-symbol 'define-type))
683 (summary (format elisp--xref-format-extra
685 (concat "(" type-name)
686 (concat "(:constructor " (symbol-name symbol) "))"))))
687 (push (elisp--xref-make-xref 'define-type type-symbol file summary) xrefs)
690 ((setq generic (cl--generic symbol))
691 ;; A generic function. If there is a default method, it
692 ;; will appear in the method table, with no
695 ;; If the default method is declared by the cl-defgeneric
696 ;; declaration, it will have the same location as the
697 ;; cl-defgeneric, so we want to exclude it from the
698 ;; result. In this case, it will have a null doc
699 ;; string. User declarations of default methods may also
700 ;; have null doc strings, but we hope that is
701 ;; rare. Perhaps this heuristic will discourage that.
702 (dolist (method (cl--generic-method-table generic))
703 (let* ((info (cl--generic-method-info method));; qual-string combined-args doconly
704 (specializers (cl--generic-method-specializers method))
705 (met-name (cons symbol specializers))
706 (file (find-lisp-object-file-name met-name 'cl-defmethod)))
708 (or specializers ;; default method has null specializers
709 (nth 2 info))) ;; assuming only co-located default has null doc string
711 (let ((summary (format elisp--xref-format-extra 'cl-defmethod symbol (nth 1 info))))
712 (push (elisp--xref-make-xref 'cl-defmethod met-name file summary) xrefs))
714 (let ((summary (format elisp--xref-format-extra 'cl-defmethod symbol "()")))
715 (push (elisp--xref-make-xref 'cl-defmethod met-name file summary) xrefs))))
718 (if (and (setq doc (documentation symbol t))
719 ;; This doc string is created somewhere in
720 ;; cl--generic-make-function for an implicit
722 (string-match "\n\n(fn ARG &rest ARGS)" doc))
723 ;; This symbol is an implicitly defined defgeneric, so
726 (push (elisp--xref-make-xref 'cl-defgeneric symbol file) xrefs))
730 (push (elisp--xref-make-xref nil symbol file) xrefs))
733 (when (boundp symbol)
735 (let ((file (find-lisp-object-file-name symbol 'defvar)))
739 ;; The doc strings from the C source have not been loaded
740 ;; yet; help-C-file-name does that. Second call will
741 ;; return "src/*.c" in file; handled below.
742 (push (elisp--xref-make-xref 'defvar symbol (help-C-file-name symbol 'var)) xrefs))
744 ((string= "src/" (substring file 0 4))
745 ;; The variable is defined in a C source file; don't check
746 ;; for define-minor-mode.
747 (push (elisp--xref-make-xref 'defvar symbol file) xrefs))
749 ((memq symbol minor-mode-list)
750 ;; The symbol is a minor mode. These should be defined by
751 ;; "define-minor-mode", which means the variable and the
752 ;; function are declared in the same place. So we return only
753 ;; the function, arbitrarily.
755 ;; There is an exception, when the variable is defined in C
756 ;; code, as for abbrev-mode.
758 ;; IMPROVEME: If the user is searching for the identifier at
759 ;; point, we can determine whether it is a variable or
760 ;; function by looking at the source code near point.
762 ;; IMPROVEME: The user may actually be asking "do any
763 ;; variables by this name exist"; we need a way to specify
768 (push (elisp--xref-make-xref 'defvar symbol file) xrefs))
772 (when (featurep symbol)
773 (let ((file (ignore-errors
774 (find-library-name (symbol-name symbol)))))
776 (push (elisp--xref-make-xref 'feature symbol file) xrefs))))
780 (declare-function project-search-path "project")
781 (declare-function project-current "project")
783 (defun elisp--xref-find-references (symbol)
786 (xref-collect-references symbol dir))
787 (project-search-path (project-current))))
789 (defun elisp--xref-find-apropos (regexp)
792 (dolist (sym (apropos-internal regexp))
793 (push (elisp--xref-find-definitions sym) lst))
796 (defvar elisp--xref-identifier-completion-table
797 (apply-partially #'completion-table-with-predicate
806 (defun elisp--xref-identifier-completion-table ()
807 elisp--xref-identifier-completion-table)
809 (cl-defstruct (xref-elisp-location
810 (:constructor xref-make-elisp-location (symbol type file)))
811 "Location of an Emacs Lisp symbol definition."
814 (cl-defmethod xref-location-marker ((l xref-elisp-location))
815 (pcase-let (((cl-struct xref-elisp-location symbol type file) l))
816 (let ((buffer-point (find-function-search-for-symbol symbol type file)))
817 (with-current-buffer (car buffer-point)
818 (goto-char (or (cdr buffer-point) (point-min)))
821 (cl-defmethod xref-location-group ((l xref-elisp-location))
822 (xref-elisp-location-file l))
824 (defun elisp-search-path ()
825 (defvar package-user-dir)
826 (cons package-user-dir load-path))
828 ;;; Elisp Interaction mode
830 (defvar lisp-interaction-mode-map
831 (let ((map (make-sparse-keymap))
832 (menu-map (make-sparse-keymap "Lisp-Interaction")))
833 (set-keymap-parent map lisp-mode-shared-map)
834 (define-key map "\e\C-x" 'eval-defun)
835 (define-key map "\e\C-q" 'indent-pp-sexp)
836 (define-key map "\e\t" 'completion-at-point)
837 (define-key map "\n" 'eval-print-last-sexp)
838 (bindings--define-key map [menu-bar lisp-interaction]
839 (cons "Lisp-Interaction" menu-map))
840 (bindings--define-key menu-map [eval-defun]
841 '(menu-item "Evaluate Defun" eval-defun
842 :help "Evaluate the top-level form containing point, or after point"))
843 (bindings--define-key menu-map [eval-print-last-sexp]
844 '(menu-item "Evaluate and Print" eval-print-last-sexp
845 :help "Evaluate sexp before point; print value into current buffer"))
846 (bindings--define-key menu-map [edebug-defun-lisp-interaction]
847 '(menu-item "Instrument Function for Debugging" edebug-defun
848 :help "Evaluate the top level form point is in, stepping through with Edebug"
850 (bindings--define-key menu-map [indent-pp-sexp]
851 '(menu-item "Indent or Pretty-Print" indent-pp-sexp
852 :help "Indent each line of the list starting just after point, or prettyprint it"))
853 (bindings--define-key menu-map [complete-symbol]
854 '(menu-item "Complete Lisp Symbol" completion-at-point
855 :help "Perform completion on Lisp symbol preceding point"))
857 "Keymap for Lisp Interaction mode.
858 All commands in `lisp-mode-shared-map' are inherited by this map.")
860 (define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
861 "Major mode for typing and evaluating Lisp forms.
862 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
863 before point, and prints its value into the buffer, advancing point.
864 Note that printing is controlled by `eval-expression-print-length'
865 and `eval-expression-print-level'.
868 Delete converts tabs to spaces as it moves back.
869 Paragraphs are separated only by blank lines.
870 Semicolons start comments.
872 \\{lisp-interaction-mode-map}"
875 ;;; Emacs Lisp Byte-Code mode
878 (defconst emacs-list-byte-code-comment-re
879 (concat "\\(#\\)@\\([0-9]+\\) "
880 ;; Make sure it's a docstring and not a lazy-loaded byte-code.
881 "\\(?:[^(]\\|([^\"]\\)")))
883 (defun elisp--byte-code-comment (end &optional _point)
884 "Try to syntactically mark the #@NNN ....^_ docstrings in byte-code files."
885 (let ((ppss (syntax-ppss)))
886 (when (and (nth 4 ppss)
887 (eq (char-after (nth 8 ppss)) ?#))
888 (let* ((n (save-excursion
889 (goto-char (nth 8 ppss))
890 (when (looking-at emacs-list-byte-code-comment-re)
891 (string-to-number (match-string 2)))))
892 ;; `maxdiff' tries to make sure the loop below terminates.
895 (let* ((bchar (match-end 2))
896 (b (position-bytes bchar)))
898 (while (let ((diff (- (position-bytes (point)) b n)))
900 (when (> diff maxdiff) (setq diff maxdiff))
901 (forward-char (- diff))
902 (setq maxdiff (if (> diff 0) diff
903 (max (1- maxdiff) 1)))
906 (put-text-property (1- (point)) (point)
908 (string-to-syntax "> b"))
909 (goto-char end)))))))
911 (defun elisp-byte-code-syntax-propertize (start end)
912 (elisp--byte-code-comment end (point))
914 (syntax-propertize-rules
915 (emacs-list-byte-code-comment-re
916 (1 (prog1 "< b" (elisp--byte-code-comment end (point))))))
920 (add-to-list 'auto-mode-alist '("\\.elc\\'" . elisp-byte-code-mode))
922 (define-derived-mode elisp-byte-code-mode emacs-lisp-mode
924 "Major mode for *.elc files."
925 ;; TODO: Add way to disassemble byte-code under point.
926 (setq-local open-paren-in-column-0-is-defun-start nil)
927 (setq-local syntax-propertize-function
928 #'elisp-byte-code-syntax-propertize))
931 ;;; Globally accessible functionality
933 (defun eval-print-last-sexp (&optional eval-last-sexp-arg-internal)
934 "Evaluate sexp before point; print value into current buffer.
936 Normally, this function truncates long output according to the value
937 of the variables `eval-expression-print-length' and
938 `eval-expression-print-level'. With a prefix argument of zero,
939 however, there is no such truncation. Such a prefix argument
940 also causes integers to be printed in several additional formats
941 \(octal, hexadecimal, and character).
943 If `eval-expression-debug-on-error' is non-nil, which is the default,
944 this command arranges for all errors to enter the debugger."
946 (let ((standard-output (current-buffer)))
948 (eval-last-sexp (or eval-last-sexp-arg-internal t))
952 (defun last-sexp-setup-props (beg end value alt1 alt2)
953 "Set up text properties for the output of `elisp--eval-last-sexp'.
954 BEG and END are the start and end of the output in current-buffer.
955 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
956 alternative printed representations that can be displayed."
957 (let ((map (make-sparse-keymap)))
958 (define-key map "\C-m" 'elisp-last-sexp-toggle-display)
959 (define-key map [down-mouse-2] 'mouse-set-point)
960 (define-key map [mouse-2] 'elisp-last-sexp-toggle-display)
963 `(printed-value (,value ,alt1 ,alt2)
966 help-echo "RET, mouse-2: toggle abbreviated display"
967 rear-nonsticky (mouse-face keymap help-echo
971 (defun elisp-last-sexp-toggle-display (&optional _arg)
972 "Toggle between abbreviated and unabbreviated printed representations."
976 (let ((value (get-text-property (point) 'printed-value)))
978 (let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
981 (end (or (next-single-char-property-change (point) 'printed-value) (point)))
982 (standard-output (current-buffer))
984 (delete-region beg end)
985 (insert (nth 1 value))
987 (setq point (1- (point))))
988 (last-sexp-setup-props beg (point)
992 (goto-char (min (point-max) point)))))))
994 (defun prin1-char (char) ;FIXME: Move it, e.g. to simple.el.
995 "Return a string representing CHAR as a character rather than as an integer.
996 If CHAR is not a character, return nil."
999 (let ((c (event-basic-type char))
1000 (mods (event-modifiers char))
1002 ;; Prevent ?A from turning into ?\S-a.
1003 (if (and (memq 'shift mods)
1004 (zerop (logand char ?\S-\^@))
1005 (not (let ((case-fold-search nil))
1006 (char-equal c (upcase c)))))
1007 (setq c (upcase c) mods nil))
1008 ;; What string are we considering using?
1015 (cond ((eq modif 'super) "\\s-")
1016 (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
1019 ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
1020 ((eq c 127) "\\C-?")
1024 ;; Verify the string reads a CHAR, not to some other character.
1025 ;; If it doesn't, return nil instead.
1027 (= (car (read-from-string string)) char)
1030 (defun elisp--preceding-sexp ()
1031 "Return sexp before the point."
1032 (let ((opoint (point))
1036 (with-syntax-table emacs-lisp-mode-syntax-table
1037 ;; If this sexp appears to be enclosed in `...' or ‘...’
1038 ;; then ignore the surrounding quotes.
1039 (cond ((eq (preceding-char) ?’)
1040 (progn (forward-char -1) (setq opoint (point))))
1041 ((or (eq (following-char) ?\')
1042 (eq (preceding-char) ?\'))
1043 (setq left-quote ?\`)))
1045 ;; If we were after `?\e' (or similar case),
1046 ;; use the whole thing, not just the `e'.
1047 (when (eq (preceding-char) ?\\)
1049 (when (eq (preceding-char) ??)
1052 ;; Skip over hash table read syntax.
1053 (and (> (point) (1+ (point-min)))
1054 (looking-back "#s" (- (point) 2))
1057 ;; Skip over `#N='s.
1058 (when (eq (preceding-char) ?=)
1061 (skip-chars-backward "0-9#=")
1062 (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
1064 (forward-sexp -1))))
1067 (if (eq (following-char) left-quote)
1068 ;; vladimir@cs.ualberta.ca 30-Jul-1997: Skip ` in `variable' so
1069 ;; that the value is returned, not the name.
1071 (when (looking-at ",@?") (goto-char (match-end 0)))
1072 (narrow-to-region (point-min) opoint)
1073 (setq expr (read (current-buffer)))
1074 ;; If it's an (interactive ...) form, it's more useful to show how an
1075 ;; interactive call would use it.
1076 ;; FIXME: Is it really the right place for this?
1077 (when (eq (car-safe expr) 'interactive)
1079 `(call-interactively
1080 (lambda (&rest args) ,expr args))))
1082 (define-obsolete-function-alias 'preceding-sexp 'elisp--preceding-sexp "25.1")
1084 (defun elisp--eval-last-sexp (eval-last-sexp-arg-internal)
1085 "Evaluate sexp before point; print value in the echo area.
1086 If EVAL-LAST-SEXP-ARG-INTERNAL is non-nil, print output into
1087 current buffer. If EVAL-LAST-SEXP-ARG-INTERNAL is `0', print
1088 output with no limit on the length and level of lists, and
1089 include additional formats for integers \(octal, hexadecimal, and
1091 (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
1092 ;; Setup the lexical environment if lexical-binding is enabled.
1093 (elisp--eval-last-sexp-print-value
1094 (eval (eval-sexp-add-defvars (elisp--preceding-sexp)) lexical-binding)
1095 eval-last-sexp-arg-internal)))
1098 (defun elisp--eval-last-sexp-print-value (value &optional eval-last-sexp-arg-internal)
1099 (let ((unabbreviated (let ((print-length nil) (print-level nil))
1100 (prin1-to-string value)))
1101 (print-length (and (not (zerop (prefix-numeric-value
1102 eval-last-sexp-arg-internal)))
1103 eval-expression-print-length))
1104 (print-level (and (not (zerop (prefix-numeric-value
1105 eval-last-sexp-arg-internal)))
1106 eval-expression-print-level))
1111 (let ((str (eval-expression-print-format value)))
1112 (if str (princ str)))
1114 (when (and (bufferp standard-output)
1115 (or (not (null print-length))
1116 (not (null print-level)))
1117 (not (string= unabbreviated
1118 (buffer-substring-no-properties beg end))))
1119 (last-sexp-setup-props beg end value
1121 (buffer-substring-no-properties beg end))
1125 (defvar elisp--eval-last-sexp-fake-value (make-symbol "t"))
1127 (defun eval-sexp-add-defvars (exp &optional pos)
1128 "Prepend EXP with all the `defvar's that precede it in the buffer.
1129 POS specifies the starting position where EXP was found and defaults to point."
1130 (setq exp (macroexpand-all exp)) ;Eager macro-expansion.
1131 (if (not lexical-binding)
1134 (unless pos (setq pos (point)))
1136 (goto-char (point-min))
1137 (while (re-search-forward
1138 "(def\\(?:var\\|const\\|custom\\)[ \t\n]+\\([^; '()\n\t]+\\)"
1140 (let ((var (intern (match-string 1))))
1141 (and (not (special-variable-p var))
1143 (zerop (car (syntax-ppss (match-beginning 0)))))
1145 `(progn ,@(mapcar (lambda (v) `(defvar ,v)) vars) ,exp)))))
1147 (defun eval-last-sexp (eval-last-sexp-arg-internal)
1148 "Evaluate sexp before point; print value in the echo area.
1149 Interactively, with prefix argument, print output into current buffer.
1151 Normally, this function truncates long output according to the value
1152 of the variables `eval-expression-print-length' and
1153 `eval-expression-print-level'. With a prefix argument of zero,
1154 however, there is no such truncation. Such a prefix argument
1155 also causes integers to be printed in several additional formats
1156 \(octal, hexadecimal, and character).
1158 If `eval-expression-debug-on-error' is non-nil, which is the default,
1159 this command arranges for all errors to enter the debugger."
1161 (if (null eval-expression-debug-on-error)
1162 (elisp--eval-last-sexp eval-last-sexp-arg-internal)
1164 (let ((debug-on-error elisp--eval-last-sexp-fake-value))
1165 (cons (elisp--eval-last-sexp eval-last-sexp-arg-internal)
1167 (unless (eq (cdr value) elisp--eval-last-sexp-fake-value)
1168 (setq debug-on-error (cdr value)))
1171 (defun elisp--eval-defun-1 (form)
1172 "Treat some expressions specially.
1173 Reset the `defvar' and `defcustom' variables to the initial value.
1174 \(For `defcustom', use the :set function if there is one.)
1175 Reinitialize the face according to the `defface' specification."
1176 ;; The code in edebug-defun should be consistent with this, but not
1177 ;; the same, since this gets a macroexpanded form.
1178 (cond ((not (listp form))
1180 ((and (eq (car form) 'defvar)
1181 (cdr-safe (cdr-safe form))
1182 (boundp (cadr form)))
1183 ;; Force variable to be re-set.
1184 `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
1185 (setq-default ,(nth 1 form) ,(nth 2 form))))
1186 ;; `defcustom' is now macroexpanded to
1187 ;; `custom-declare-variable' with a quoted value arg.
1188 ((and (eq (car form) 'custom-declare-variable)
1189 (default-boundp (eval (nth 1 form) lexical-binding)))
1190 ;; Force variable to be bound, using :set function if specified.
1191 (let ((setfunc (memq :set form)))
1193 (setq setfunc (car-safe (cdr-safe setfunc)))
1194 (or (functionp setfunc) (setq setfunc nil)))
1195 (funcall (or setfunc 'set-default)
1196 (eval (nth 1 form) lexical-binding)
1197 ;; The second arg is an expression that evaluates to
1198 ;; an expression. The second evaluation is the one
1199 ;; normally performed not by normal execution but by
1200 ;; custom-initialize-set (for example), which does not
1201 ;; use lexical-binding.
1202 (eval (eval (nth 2 form) lexical-binding))))
1204 ;; `defface' is macroexpanded to `custom-declare-face'.
1205 ((eq (car form) 'custom-declare-face)
1207 (let ((face-symbol (eval (nth 1 form) lexical-binding)))
1208 (setq face-new-frame-defaults
1209 (assq-delete-all face-symbol face-new-frame-defaults))
1210 (put face-symbol 'face-defface-spec nil)
1211 (put face-symbol 'face-override-spec nil))
1213 ((eq (car form) 'progn)
1214 (cons 'progn (mapcar #'elisp--eval-defun-1 (cdr form))))
1217 (defun elisp--eval-defun ()
1218 "Evaluate defun that point is in or before.
1219 The value is displayed in the echo area.
1220 If the current defun is actually a call to `defvar',
1221 then reset the variable using the initial value expression
1222 even if the variable already has some other value.
1223 \(Normally `defvar' does not change the variable's value
1224 if it already has a value.\)
1226 Return the result of evaluation."
1227 ;; FIXME: the print-length/level bindings should only be applied while
1228 ;; printing, not while evaluating.
1229 (let ((debug-on-error eval-expression-debug-on-error)
1230 (print-length eval-expression-print-length)
1231 (print-level eval-expression-print-level))
1233 ;; Arrange for eval-region to "read" the (possibly) altered form.
1234 ;; eval-region handles recording which file defines a function or
1236 (let ((standard-output t)
1238 ;; Read the form from the buffer, and record where it ends.
1241 (beginning-of-defun)
1243 (setq form (read (current-buffer)))
1245 ;; Alter the form if necessary.
1246 (let ((form (eval-sexp-add-defvars
1247 (elisp--eval-defun-1 (macroexpand form)))))
1248 (eval-region beg end standard-output
1250 ;; Skipping to the end of the specified region
1251 ;; will make eval-region return.
1254 (let ((str (eval-expression-print-format (car values))))
1255 (if str (princ str)))
1256 ;; The result of evaluation has been put onto VALUES. So return it.
1259 (defun eval-defun (edebug-it)
1260 "Evaluate the top-level form containing point, or after point.
1262 If the current defun is actually a call to `defvar' or `defcustom',
1263 evaluating it this way resets the variable using its initial value
1264 expression (using the defcustom's :set function if there is one), even
1265 if the variable already has some other value. \(Normally `defvar' and
1266 `defcustom' do not alter the value if there already is one.) In an
1267 analogous way, evaluating a `defface' overrides any customizations of
1268 the face, so that it becomes defined exactly as the `defface' expression
1271 If `eval-expression-debug-on-error' is non-nil, which is the default,
1272 this command arranges for all errors to enter the debugger.
1274 With a prefix argument, instrument the code for Edebug.
1276 If acting on a `defun' for FUNCTION, and the function was
1277 instrumented, `Edebug: FUNCTION' is printed in the echo area. If not
1278 instrumented, just FUNCTION is printed.
1280 If not acting on a `defun', the result of evaluation is displayed in
1281 the echo area. This display is controlled by the variables
1282 `eval-expression-print-length' and `eval-expression-print-level',
1287 (eval-defun (not edebug-all-defs)))
1289 (if (null eval-expression-debug-on-error)
1291 (let (new-value value)
1292 (let ((debug-on-error elisp--eval-last-sexp-fake-value))
1293 (setq value (elisp--eval-defun))
1294 (setq new-value debug-on-error))
1295 (unless (eq elisp--eval-last-sexp-fake-value new-value)
1296 (setq debug-on-error new-value))
1301 (defvar elisp--eldoc-last-data (make-vector 3 nil)
1302 "Bookkeeping; elements are as follows:
1303 0 - contains the last symbol read from the buffer.
1304 1 - contains the string last displayed in the echo area for variables,
1305 or argument string for functions.
1306 2 - 'function if function args, 'variable if variable documentation.")
1308 (defun elisp-eldoc-documentation-function ()
1309 "`eldoc-documentation-function' (which see) for Emacs Lisp."
1310 (let ((current-symbol (elisp--current-symbol))
1311 (current-fnsym (elisp--fnsym-in-current-sexp)))
1312 (cond ((null current-fnsym)
1314 ((eq current-symbol (car current-fnsym))
1315 (or (apply #'elisp-get-fnsym-args-string current-fnsym)
1316 (elisp-get-var-docstring current-symbol)))
1318 (or (elisp-get-var-docstring current-symbol)
1319 (apply #'elisp-get-fnsym-args-string current-fnsym))))))
1321 (defun elisp-get-fnsym-args-string (sym &optional index prefix)
1322 "Return a string containing the parameter list of the function SYM.
1323 If SYM is a subr and no arglist is obtainable from the docstring
1324 or elsewhere, return a 1-line docstring."
1327 ((not (and sym (symbolp sym) (fboundp sym))) nil)
1328 ((and (eq sym (aref elisp--eldoc-last-data 0))
1329 (eq 'function (aref elisp--eldoc-last-data 2)))
1330 (aref elisp--eldoc-last-data 1))
1332 (let* ((advertised (gethash (indirect-function sym)
1333 advertised-signature-table t))
1337 ((listp advertised) advertised)
1338 ((setq doc (help-split-fundoc
1339 (condition-case nil (documentation sym t)
1340 (invalid-function nil))
1343 (t (help-function-arglist sym)))))
1344 ;; Stringify, and store before highlighting, downcasing, etc.
1345 (elisp--last-data-store sym (elisp-function-argstring args)
1347 ;; Highlight, truncate.
1349 (elisp--highlight-function-argument
1352 (concat (propertize (symbol-name sym) 'face
1354 'font-lock-function-name-face
1355 'font-lock-keyword-face))
1358 (defun elisp--highlight-function-argument (sym args index prefix)
1359 "Highlight argument INDEX in ARGS list for function SYM.
1360 In the absence of INDEX, just call `eldoc-docstring-format-sym-doc'."
1361 ;; FIXME: This should probably work on the list representation of `args'
1362 ;; rather than its string representation.
1363 ;; FIXME: This function is much too long, we need to split it up!
1366 (argument-face 'eldoc-highlight-function-argument)
1367 (args-lst (mapcar (lambda (x)
1368 (replace-regexp-in-string
1369 "\\`[(]\\|[)]\\'" "" x))
1370 (split-string args))))
1371 ;; Find the current argument in the argument string. We need to
1372 ;; handle `&rest' and informal `...' properly.
1374 ;; FIXME: What to do with optional arguments, like in
1375 ;; (defun NAME ARGLIST [DOCSTRING] BODY...) case?
1376 ;; The problem is there is no robust way to determine if
1377 ;; the current argument is indeed a docstring.
1379 ;; When `&key' is used finding position based on `index'
1380 ;; would be wrong, so find the arg at point and determine
1381 ;; position in ARGS based on this current arg.
1382 (when (string-match "&key" args)
1383 (let* (case-fold-search
1385 (sym-name (symbol-name sym))
1386 (cur-w (current-word))
1387 (args-lst-ak (cdr (member "&key" args-lst)))
1388 (limit (save-excursion
1389 (when (re-search-backward sym-name nil t)
1391 (cur-a (if (and cur-w (string-match ":\\([^ ()]*\\)" cur-w))
1395 (when (re-search-backward ":\\([^()\n]*\\)" limit t)
1396 (setq split (split-string (match-string 1) " " t))
1399 (setq key-have-value t))))))))
1400 ;; If `cur-a' is not one of `args-lst-ak'
1401 ;; assume user is entering an unknown key
1402 ;; referenced in last position in signature.
1403 (other-key-arg (and (stringp cur-a)
1405 (not (member (upcase cur-a) args-lst-ak))
1406 (upcase (car (last args-lst-ak))))))
1407 (unless (string= cur-w sym-name)
1408 ;; The last keyword have already a value
1409 ;; i.e :foo a b and cursor is at b.
1410 ;; If signature have also `&rest'
1411 ;; (assume it is after the `&key' section)
1412 ;; go to the arg after `&rest'.
1413 (if (and key-have-value
1415 (not (re-search-forward ":.*" (point-at-eol) t)))
1416 (string-match "&rest \\([^ ()]*\\)" args))
1417 (setq index nil ; Skip next block based on positional args.
1418 start (match-beginning 1)
1420 ;; If `cur-a' is nil probably cursor is on a positional arg
1421 ;; before `&key', in this case, exit this block and determine
1422 ;; position with `index'.
1423 (when (and cur-a ; A keyword arg (dot removed) or nil.
1425 (concat "\\_<" (upcase cur-a) "\\_>") args)
1427 (concat "\\_<" other-key-arg "\\_>") args)))
1428 (setq index nil ; Skip next block based on positional args.
1429 start (match-beginning 0)
1430 end (match-end 0)))))))
1431 ;; Handle now positional arguments.
1432 (while (and index (>= index 1))
1433 (if (string-match "[^ ()]+" args end)
1435 (setq start (match-beginning 0)
1437 (let ((argument (match-string 0 args)))
1438 (cond ((string= argument "&rest")
1439 ;; All the rest arguments are the same.
1441 ((string= argument "&optional")) ; Skip.
1442 ((string= argument "&allow-other-keys")) ; Skip.
1443 ;; Back to index 0 in ARG1 ARG2 ARG2 ARG3 etc...
1445 ((or (and (string-match-p "\\.\\.\\.\\'" argument)
1446 (string= argument (car (last args-lst))))
1447 (and (string-match-p "\\.\\.\\.\\'"
1448 (substring args 1 (1- (length args))))
1449 (= (length (remove "..." args-lst)) 2)
1450 (> index 1) (eq (logand index 1) 1)))
1453 (setq index (1- index))))))
1454 (setq end (length args)
1456 argument-face 'font-lock-warning-face
1460 (setq doc (copy-sequence args))
1461 (add-text-properties start end (list 'face argument-face) doc))
1462 (setq doc (eldoc-docstring-format-sym-doc prefix doc))
1465 ;; Return a string containing a brief (one-line) documentation string for
1467 (defun elisp-get-var-docstring (sym)
1468 (cond ((not sym) nil)
1469 ((and (eq sym (aref elisp--eldoc-last-data 0))
1470 (eq 'variable (aref elisp--eldoc-last-data 2)))
1471 (aref elisp--eldoc-last-data 1))
1473 (let ((doc (documentation-property sym 'variable-documentation t)))
1475 (let ((doc (eldoc-docstring-format-sym-doc
1476 sym (elisp--docstring-first-line doc)
1477 'font-lock-variable-name-face)))
1478 (elisp--last-data-store sym doc 'variable)))))))
1480 (defun elisp--last-data-store (symbol doc type)
1481 (aset elisp--eldoc-last-data 0 symbol)
1482 (aset elisp--eldoc-last-data 1 doc)
1483 (aset elisp--eldoc-last-data 2 type)
1486 ;; Note that any leading `*' in the docstring (which indicates the variable
1487 ;; is a user option) is removed.
1488 (defun elisp--docstring-first-line (doc)
1490 (substitute-command-keys
1492 ;; Don't use "^" in the regexp below since it may match
1493 ;; anywhere in the doc-string.
1494 (let ((start (if (string-match "\\`\\*" doc) (match-end 0) 0)))
1495 (cond ((string-match "\n" doc)
1496 (substring doc start (match-beginning 0)))
1498 (t (substring doc start))))))))
1500 ;; Return a list of current function name and argument index.
1501 (defun elisp--fnsym-in-current-sexp ()
1503 (let ((argument-index (1- (elisp--beginning-of-sexp))))
1504 ;; If we are at the beginning of function name, this will be -1.
1505 (when (< argument-index 0)
1506 (setq argument-index 0))
1507 ;; Don't do anything if current word is inside a string.
1508 (if (= (or (char-after (1- (point))) 0) ?\")
1510 (list (elisp--current-symbol) argument-index)))))
1512 ;; Move to the beginning of current sexp. Return the number of nested
1513 ;; sexp the point was over or after.
1514 (defun elisp--beginning-of-sexp ()
1515 (let ((parse-sexp-ignore-comments t)
1516 (num-skipped-sexps 0))
1519 ;; First account for the case the point is directly over a
1520 ;; beginning of a nested sexp.
1526 (setq num-skipped-sexps 1)))
1532 (setq num-skipped-sexps (1+ num-skipped-sexps))))))
1536 ;; returns nil unless current word is an interned symbol.
1537 (defun elisp--current-symbol ()
1538 (let ((c (char-after (point))))
1540 (memq (char-syntax c) '(?w ?_))
1541 (intern-soft (current-word)))))
1543 (defun elisp-function-argstring (arglist)
1544 "Return ARGLIST as a string enclosed by ().
1545 ARGLIST is either a string, or a list of strings or symbols."
1546 (let ((str (cond ((stringp arglist) arglist)
1547 ((not (listp arglist)) nil)
1548 (t (help--make-usage-docstring 'toto arglist)))))
1549 (if (and str (string-match "\\`([^ )]+ ?" str))
1550 (replace-match "(" t t str)
1553 (provide 'elisp-mode)
1554 ;;; elisp-mode.el ends here