code.delx.au - gnu-emacs/blob - lisp/progmodes/elisp-mode.el

   1 ;;; elisp-mode.el --- Emacs Lisp mode  -*- lexical-binding:t -*-
   2
   3 ;; Copyright (C) 1985-1986, 1999-2015 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: emacs-devel@gnu.org
   6 ;; Keywords: lisp, languages
   7 ;; Package: emacs
   8
   9 ;; This file is part of GNU Emacs.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 ;;; Commentary:
  25
  26 ;; The major mode for editing Emacs Lisp code.
  27 ;; This mode is documented in the Emacs manual.
  28
  29 ;;; Code:
  30
  31 (require 'cl-generic)
  32 (require 'lisp-mode)
  33 (eval-when-compile (require 'cl-lib))
  34
  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))
  39
  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)
  44     table)
  45   "Syntax table used in `emacs-lisp-mode'.")
  46
  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"))
  90
  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"))
 122
 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"
 139                   :keys "C-u C-M-x"))
 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))
 178     map)
 179   "Keymap for Emacs Lisp mode.
 180 All commands in `lisp-mode-shared-map' are inherited by this map.")
 181
 182 (defun emacs-lisp-byte-compile ()
 183   "Byte compile the file containing the current buffer."
 184   (interactive)
 185   (if buffer-file-name
 186       (byte-compile-file buffer-file-name)
 187     (error "The buffer must be saved in a file first")))
 188
 189 (defun emacs-lisp-byte-compile-and-load ()
 190   "Byte-compile the current file (if it has changed), then load compiled code."
 191   (interactive)
 192   (or buffer-file-name
 193       (error "The buffer must be saved in a file first"))
 194   (require 'bytecomp)
 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))))
 198       (save-buffer))
 199   (byte-recompile-file buffer-file-name nil 0 t))
 200
 201 (defun emacs-lisp-macroexpand ()
 202   "Macroexpand the form after point.
 203 Comments in the form will be lost."
 204   (interactive)
 205   (let* ((start (point))
 206          (exp (read (current-buffer)))
 207          ;; Compute it before, since it may signal errors.
 208          (new (macroexpand-1 exp)))
 209     (if (equal exp new)
 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)))))
 215
 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)
 219   :type 'hook
 220   :group 'lisp)
 221
 222 ;;;###autoload
 223 (define-derived-mode emacs-lisp-mode prog-mode "Emacs-Lisp"
 224   "Major mode for editing Lisp code to run in Emacs.
 225 Commands:
 226 Delete converts tabs to spaces as it moves back.
 227 Blank lines separate paragraphs.  Semicolons start comments.
 228
 229 \\{emacs-lisp-mode-map}"
 230   :group 'lisp
 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))
 248
 249 ;; Font-locking support.
 250
 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))))))
 266
 267 ;;; Completion at point for Elisp
 268
 269 (defun elisp--local-variables-1 (vars sexp)
 270   "Return the vars locally bound around the witness, or nil if not found."
 271   (let (res)
 272     (while
 273         (unless
 274             (setq res
 275                   (pcase sexp
 276                     (`(,(or `let `let*) ,bindings)
 277                      (let ((vars vars))
 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)
 284                      (let ((vars vars))
 285                        (dolist (binding bindings)
 286                          (push (or (car-safe binding) binding) vars))
 287                        (elisp--local-variables-1 vars (car (last body)))))
 288                     (`(lambda ,_args)
 289                      ;; FIXME: Look for the witness inside `args'.
 290                      (setq sexp nil))
 291                     (`(lambda ,args . ,body)
 292                      (elisp--local-variables-1
 293                       (append (remq '&optional (remq '&rest args)) vars)
 294                       (car (last body))))
 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)))))
 299                     (`(quote . ,_)
 300                      ;; FIXME: Look for the witness inside sexp.
 301                      (setq sexp nil))
 302                     ;; FIXME: Handle `cond'.
 303                     (`(,_ . ,_)
 304                      (elisp--local-variables-1 vars (car (last sexp))))
 305                     (`elisp--witness--lisp (or vars '(nil)))
 306                     (_ 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)))))
 310     res))
 311
 312 (defun elisp--local-variables ()
 313   "Return a list of locally let-bound variables at point."
 314   (save-excursion
 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))))
 319            (closer ()))
 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)
 328                                    (condition-case nil
 329                                        (apply expander form args)
 330                                      (error form))))
 331              (sexp
 332               (unwind-protect
 333                   (progn
 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)))
 338         (delq nil
 339               (mapcar (lambda (var)
 340                         (and (symbolp var)
 341                              (not (string-match (symbol-name var) "\\`[&_]"))
 342                              ;; Eliminate uninterned vars.
 343                              (intern-soft var)
 344                              var))
 345                       vars))))))
 346
 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 ()
 354                         (setq lastpos nil)
 355                         (remove-hook 'post-command-hook hookfun))))
 356       (completion-table-dynamic
 357        (lambda (_string)
 358          (save-excursion
 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)
 364                (setq lastvars
 365                      (mapcar #'symbol-name (elisp--local-variables))))))
 366          lastvars)))))
 367
 368 (defun elisp--expect-function-p (pos)
 369   "Return non-nil if the symbol at point is expected to be a function."
 370   (or
 371    (and (eq (char-before pos) ?')
 372         (eq (char-before (1- pos)) ?#))
 373    (save-excursion
 374      (let ((parent (nth 1 (syntax-ppss pos))))
 375        (when parent
 376          (goto-char parent)
 377          (and
 378           (looking-at (concat "(\\(cl-\\)?"
 379                               (regexp-opt '("declare-function"
 380                                             "function" "defadvice"
 381                                             "callf" "callf2"
 382                                             "defsetf"))
 383                               "[ \t\r\n]+"))
 384           (eq (match-end 0) pos)))))))
 385
 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.
 390   (save-excursion
 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))))
 395                 res)
 396             (while (and nesting (not res))
 397               (goto-char (pop nesting))
 398               (cond
 399                ((or (eq (char-after) ?\[)
 400                     (progn
 401                       (skip-chars-backward " ")
 402                       (memq (char-before) '(?' ?` ?‘))))
 403                 (setq res t))
 404                ((eq (char-before) ?,)
 405                 (setq nesting nil))))
 406             res)))))
 407
 408 ;; FIXME: Support for Company brings in features which straddle eldoc.
 409 ;; We should consolidate this, so that major modes can provide all that
 410 ;; data all at once:
 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.
 418
 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)))))
 427         (ignore-errors
 428           (cond
 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)))
 434           (help-buffer))))))
 435
 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))))
 441     (and (stringp doc)
 442          (string-match ".*$" doc)
 443          (match-string 0 doc))))
 444
 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))
 448
 449 (defun elisp--company-location (str)
 450   (let ((sym (intern-soft str)))
 451     (cond
 452      ((fboundp sym) (find-definition-noselect sym nil))
 453      ((boundp sym) (find-definition-noselect sym 'defvar))
 454      ((featurep sym)
 455       (require 'find-func)
 456       (cons (find-file-noselect (find-library-name
 457                                  (symbol-name sym)))
 458             0))
 459      ((facep sym) (find-definition-noselect sym 'defface)))))
 460
 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
 464     (let* ((pos (point))
 465            (beg (condition-case nil
 466                     (save-excursion
 467                       (backward-sexp 1)
 468                       (skip-chars-forward "`',‘#")
 469                       (point))
 470                   (scan-error pos)))
 471            (end
 472             (unless (or (eq beg (point-max))
 473                         (member (char-syntax (char-after beg))
 474                                 '(?\s ?\" ?\( ?\))))
 475               (condition-case nil
 476                   (save-excursion
 477                     (goto-char beg)
 478                     (forward-sexp 1)
 479                     (skip-chars-backward "'’")
 480                     (when (>= (point) pos)
 481                       (point)))
 482                 (scan-error 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) '(?` ?‘))))
 488         (let ((table-etc
 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.
 494                    (cond
 495                     ((elisp--expect-function-p beg)
 496                      (list nil obarray
 497                            :predicate #'fboundp
 498                            :company-doc-buffer #'elisp--company-doc-buffer
 499                            :company-docsig #'elisp--company-doc-string
 500                            :company-location #'elisp--company-location))
 501                     (quoted
 502                      (list nil obarray
 503                            ;; Don't include all symbols (bug#16646).
 504                            :predicate (lambda (sym)
 505                                         (or (boundp sym)
 506                                             (fboundp sym)
 507                                             (featurep sym)
 508                                             (symbol-plist sym)))
 509                            :annotation-function
 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))
 514                     (t
 515                      (list nil (completion-table-merge
 516                                 elisp--local-variables-completion-table
 517                                 (apply-partially #'completion-table-with-predicate
 518                                                  obarray
 519                                                  #'boundp
 520                                                  'strict))
 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.
 525                  (save-excursion
 526                    (goto-char (1- beg))
 527                    (let ((parent
 528                           (condition-case nil
 529                               (progn (up-list -1) (forward-char 1)
 530                                      (let ((c (char-after)))
 531                                        (if (eq c ?\() ?\(
 532                                          (if (memq (char-syntax c) '(?w ?_))
 533                                              (read (current-buffer))))))
 534                             (error nil))))
 535                      (pcase parent
 536                        ;; FIXME: Rather than hardcode special cases here,
 537                        ;; we should use something like a symbol-property.
 538                        (`declare
 539                         (list t (mapcar (lambda (x) (symbol-name (car x)))
 540                                         (delete-dups
 541                                          ;; FIXME: We should include some
 542                                          ;; docstring with each entry.
 543                                          (append
 544                                           macro-declarations-alist
 545                                           defun-declarations-alist)))))
 546                        ((and (or `condition-case `condition-case-unless-debug)
 547                              (guard (save-excursion
 548                                       (ignore-errors
 549                                         (forward-sexp 2)
 550                                         (< (point) beg)))))
 551                         (list t obarray
 552                               :predicate (lambda (sym) (get sym 'error-conditions))))
 553                        ((and (or ?\( `let `let*)
 554                              (guard (save-excursion
 555                                       (goto-char (1- beg))
 556                                       (when (eq parent ?\()
 557                                         (up-list -1))
 558                                       (forward-symbol -1)
 559                                       (looking-at "\\_<let\\*?\\_>"))))
 560                         (list t obarray
 561                               :predicate #'boundp
 562                               :company-doc-buffer #'elisp--company-doc-buffer
 563                               :company-docsig #'elisp--company-doc-string
 564                               :company-location #'elisp--company-location))
 565                        (_ (list nil obarray
 566                                 :predicate #'fboundp
 567                                 :company-doc-buffer #'elisp--company-doc-buffer
 568                                 :company-docsig #'elisp--company-doc-string
 569                                 :company-location #'elisp--company-location
 570                                 ))))))))
 571           (nconc (list beg end)
 572                  (if (null (car table-etc))
 573                      (cdr table-etc)
 574                    (cons
 575                     (if (memq (char-syntax (or (char-after end) ?\s))
 576                               '(?\s ?>))
 577                         (cadr table-etc)
 578                       (apply-partially 'completion-table-with-terminator
 579                                        " " (cadr table-etc)))
 580                     (cddr table-etc)))))))))
 581
 582 (define-obsolete-function-alias
 583   'lisp-completion-at-point 'elisp-completion-at-point "25.1")
 584
 585 ;;; Xref backend
 586
 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))
 590
 591 (defun elisp-xref-find (action id)
 592   (require 'find-func)
 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
 597   (pcase action
 598     (`definitions
 599       (let ((sym (intern-soft id)))
 600         (when sym
 601           (elisp--xref-find-definitions sym))))
 602     (`references
 603      (elisp--xref-find-references id))
 604     (`apropos
 605      (elisp--xref-find-apropos id))))
 606
 607 (defconst elisp--xref-format
 608   (let ((str "(%s %s)"))
 609     (put-text-property 1 3 'face 'font-lock-keyword-face str)
 610     (put-text-property 4 6 'face 'font-lock-function-name-face str)
 611     str))
 612
 613 (defconst elisp--xref-format-extra
 614   (let ((str "(%s %s %s)"))
 615     (put-text-property 1 3 'face 'font-lock-keyword-face str)
 616     (put-text-property 4 6 'face 'font-lock-function-name-face str)
 617     str))
 618
 619 (defcustom find-feature-regexp
 620   (concat "(provide +'%s)")
 621   "The regexp used by `xref-find-definitions' to search for a feature definition.
 622 Note it must contain a `%s' at the place where `format'
 623 should insert the feature name."
 624   :type 'regexp
 625   :group 'xref
 626   :version "25.0")
 627
 628 (defcustom find-alias-regexp
 629   "(\\(defalias +'\\|def\\(const\\|face\\) +\\)%s"
 630   "The regexp used by `xref-find-definitions' to search for an alias definition.
 631 Note it must contain a `%s' at the place where `format'
 632 should insert the feature name."
 633   :type 'regexp
 634   :group 'xref
 635   :version "25.0")
 636
 637 (with-eval-after-load 'find-func
 638   (defvar find-function-regexp-alist)
 639   (add-to-list 'find-function-regexp-alist (cons 'feature 'find-feature-regexp))
 640   (add-to-list 'find-function-regexp-alist (cons 'defalias 'find-alias-regexp)))
 641
 642 (defun elisp--xref-make-xref (type symbol file &optional summary)
 643   "Return an xref for TYPE SYMBOL in FILE.
 644 TYPE must be a type in 'find-function-regexp-alist' (use nil for
 645 'defun).  If SUMMARY is non-nil, use it for the summary;
 646 otherwise build the summary from TYPE and SYMBOL."
 647   (xref-make (or summary
 648                  (format elisp--xref-format (or type 'defun) symbol))
 649              (xref-make-elisp-location symbol type file)))
 650
 651 (defun elisp--xref-find-definitions (symbol)
 652   ;; The file name is not known when `symbol' is defined via interactive eval.
 653   (let (xrefs)
 654     ;; alphabetical by result type symbol
 655
 656     ;; FIXME: advised function; list of advice functions
 657
 658     ;; FIXME: aliased variable
 659
 660     (when (and (symbolp symbol)
 661                (symbol-function symbol)
 662                (symbolp (symbol-function symbol)))
 663       ;; aliased function
 664       (let* ((alias-symbol symbol)
 665              (alias-file (symbol-file alias-symbol))
 666              (real-symbol  (symbol-function symbol))
 667              (real-file (find-lisp-object-file-name real-symbol 'defun)))
 668
 669         (when real-file
 670           (push (elisp--xref-make-xref nil real-symbol real-file) xrefs))
 671
 672         (when alias-file
 673           (push (elisp--xref-make-xref 'defalias alias-symbol alias-file) xrefs))))
 674
 675     (when (facep symbol)
 676       (let ((file (find-lisp-object-file-name symbol 'defface)))
 677         (when file
 678           (push (elisp--xref-make-xref 'defface symbol file) xrefs))))
 679
 680     (when (fboundp symbol)
 681       (let ((file (find-lisp-object-file-name symbol (symbol-function symbol)))
 682             generic doc)
 683         (when file
 684           (cond
 685            ((eq file 'C-source)
 686             ;; First call to find-lisp-object-file-name (for this
 687             ;; symbol?); C-source has not been cached yet.
 688             ;; Second call will return "src/*.c" in file; handled by 't' case below.
 689             (push (elisp--xref-make-xref nil symbol (help-C-file-name (symbol-function symbol) 'subr)) xrefs))
 690
 691            ((and (setq doc (documentation symbol t))
 692                  ;; This doc string is defined in cl-macs.el cl-defstruct
 693                  (string-match "Constructor for objects of type `\\(.*\\)'" doc))
 694             ;; `symbol' is a name for the default constructor created by
 695             ;; cl-defstruct, so return the location of the cl-defstruct.
 696             (let* ((type-name (match-string 1 doc))
 697                    (type-symbol (intern type-name))
 698                    (file (find-lisp-object-file-name type-symbol 'define-type))
 699                    (summary (format elisp--xref-format-extra
 700                                     'cl-defstruct
 701                                     (concat "(" type-name)
 702                                     (concat "(:constructor " (symbol-name symbol) "))"))))
 703               (push (elisp--xref-make-xref 'define-type type-symbol file summary) xrefs)
 704               ))
 705
 706            ((setq generic (cl--generic symbol))
 707             (dolist (method (cl--generic-method-table generic))
 708               (let* ((info (cl--generic-method-info method))
 709                      (met-name (cons symbol (cl--generic-method-specializers method)))
 710                      (descr (format elisp--xref-format-extra 'cl-defmethod symbol (nth 1 info)))
 711                      (file (find-lisp-object-file-name met-name 'cl-defmethod)))
 712                 (when file
 713                   (push (elisp--xref-make-xref 'cl-defmethod met-name file descr) xrefs))
 714                 ))
 715
 716             (let ((descr (format elisp--xref-format 'cl-defgeneric symbol)))
 717               (push (elisp--xref-make-xref nil symbol file descr) xrefs))
 718             )
 719
 720            (t
 721             (push (elisp--xref-make-xref nil symbol file) xrefs))
 722            ))))
 723
 724     (when (boundp symbol)
 725       (let ((file (find-lisp-object-file-name symbol 'defvar)))
 726         (when file
 727           (when (eq file 'C-source)
 728             (setq file (help-C-file-name symbol 'var)))
 729           (push (elisp--xref-make-xref 'defvar symbol file) xrefs))))
 730
 731     (when (featurep symbol)
 732       (let ((file (ignore-errors
 733                     (find-library-name (symbol-name symbol)))))
 734         (when file
 735           (push (elisp--xref-make-xref 'feature symbol file) xrefs))))
 736
 737     xrefs))
 738
 739 (declare-function project-search-path "project")
 740 (declare-function project-current "project")
 741
 742 (defun elisp--xref-find-references (symbol)
 743   (cl-mapcan
 744    (lambda (dir)
 745      (xref-collect-references symbol dir))
 746    (project-search-path (project-current))))
 747
 748 (defun elisp--xref-find-apropos (regexp)
 749   (apply #'nconc
 750          (let (lst)
 751            (dolist (sym (apropos-internal regexp))
 752             (push (elisp--xref-find-definitions sym) lst))
 753            (nreverse lst))))
 754
 755 (defvar elisp--xref-identifier-completion-table
 756   (apply-partially #'completion-table-with-predicate
 757                    obarray
 758                    (lambda (sym)
 759                      (or (boundp sym)
 760                          (fboundp sym)
 761                          (featurep sym)
 762                          (facep sym)))
 763                    'strict))
 764
 765 (defun elisp--xref-identifier-completion-table ()
 766   elisp--xref-identifier-completion-table)
 767
 768 (cl-defstruct (xref-elisp-location
 769                (:constructor xref-make-elisp-location (symbol type file)))
 770   "Location of an Emacs Lisp symbol definition."
 771   symbol type file)
 772
 773 (cl-defmethod xref-location-marker ((l xref-elisp-location))
 774   (pcase-let (((cl-struct xref-elisp-location symbol type file) l))
 775     (let ((buffer-point (find-function-search-for-symbol symbol type file)))
 776       (with-current-buffer (car buffer-point)
 777         (goto-char (or (cdr buffer-point) (point-min)))
 778         (point-marker)))))
 779
 780 (cl-defmethod xref-location-group ((l xref-elisp-location))
 781   (xref-elisp-location-file l))
 782
 783 (defun elisp-search-path ()
 784   (defvar package-user-dir)
 785   (cons package-user-dir load-path))
 786
 787 ;;; Elisp Interaction mode
 788
 789 (defvar lisp-interaction-mode-map
 790   (let ((map (make-sparse-keymap))
 791         (menu-map (make-sparse-keymap "Lisp-Interaction")))
 792     (set-keymap-parent map lisp-mode-shared-map)
 793     (define-key map "\e\C-x" 'eval-defun)
 794     (define-key map "\e\C-q" 'indent-pp-sexp)
 795     (define-key map "\e\t" 'completion-at-point)
 796     (define-key map "\n" 'eval-print-last-sexp)
 797     (bindings--define-key map [menu-bar lisp-interaction]
 798       (cons "Lisp-Interaction" menu-map))
 799     (bindings--define-key menu-map [eval-defun]
 800       '(menu-item "Evaluate Defun" eval-defun
 801                   :help "Evaluate the top-level form containing point, or after point"))
 802     (bindings--define-key menu-map [eval-print-last-sexp]
 803       '(menu-item "Evaluate and Print" eval-print-last-sexp
 804                   :help "Evaluate sexp before point; print value into current buffer"))
 805     (bindings--define-key menu-map [edebug-defun-lisp-interaction]
 806       '(menu-item "Instrument Function for Debugging" edebug-defun
 807                   :help "Evaluate the top level form point is in, stepping through with Edebug"
 808                   :keys "C-u C-M-x"))
 809     (bindings--define-key menu-map [indent-pp-sexp]
 810       '(menu-item "Indent or Pretty-Print" indent-pp-sexp
 811                   :help "Indent each line of the list starting just after point, or prettyprint it"))
 812     (bindings--define-key menu-map [complete-symbol]
 813       '(menu-item "Complete Lisp Symbol" completion-at-point
 814                   :help "Perform completion on Lisp symbol preceding point"))
 815     map)
 816   "Keymap for Lisp Interaction mode.
 817 All commands in `lisp-mode-shared-map' are inherited by this map.")
 818
 819 (define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
 820   "Major mode for typing and evaluating Lisp forms.
 821 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
 822 before point, and prints its value into the buffer, advancing point.
 823 Note that printing is controlled by `eval-expression-print-length'
 824 and `eval-expression-print-level'.
 825
 826 Commands:
 827 Delete converts tabs to spaces as it moves back.
 828 Paragraphs are separated only by blank lines.
 829 Semicolons start comments.
 830
 831 \\{lisp-interaction-mode-map}"
 832   :abbrev-table nil)
 833
 834 ;;; Emacs Lisp Byte-Code mode
 835
 836 (eval-and-compile
 837   (defconst emacs-list-byte-code-comment-re
 838     (concat "\\(#\\)@\\([0-9]+\\) "
 839             ;; Make sure it's a docstring and not a lazy-loaded byte-code.
 840             "\\(?:[^(]\\|([^\"]\\)")))
 841
 842 (defun elisp--byte-code-comment (end &optional _point)
 843   "Try to syntactically mark the #@NNN ....^_ docstrings in byte-code files."
 844   (let ((ppss (syntax-ppss)))
 845     (when (and (nth 4 ppss)
 846                (eq (char-after (nth 8 ppss)) ?#))
 847       (let* ((n (save-excursion
 848                   (goto-char (nth 8 ppss))
 849                   (when (looking-at emacs-list-byte-code-comment-re)
 850                     (string-to-number (match-string 2)))))
 851              ;; `maxdiff' tries to make sure the loop below terminates.
 852              (maxdiff n))
 853         (when n
 854           (let* ((bchar (match-end 2))
 855                  (b (position-bytes bchar)))
 856             (goto-char (+ b n))
 857             (while (let ((diff (- (position-bytes (point)) b n)))
 858                      (unless (zerop diff)
 859                        (when (> diff maxdiff) (setq diff maxdiff))
 860                        (forward-char (- diff))
 861                        (setq maxdiff (if (> diff 0) diff
 862                                        (max (1- maxdiff) 1)))
 863                        t))))
 864           (if (<= (point) end)
 865               (put-text-property (1- (point)) (point)
 866                                  'syntax-table
 867                                  (string-to-syntax "> b"))
 868             (goto-char end)))))))
 869
 870 (defun elisp-byte-code-syntax-propertize (start end)
 871   (elisp--byte-code-comment end (point))
 872   (funcall
 873    (syntax-propertize-rules
 874     (emacs-list-byte-code-comment-re
 875      (1 (prog1 "< b" (elisp--byte-code-comment end (point))))))
 876    start end))
 877
 878 ;;;###autoload
 879 (add-to-list 'auto-mode-alist '("\\.elc\\'" . elisp-byte-code-mode))
 880 ;;;###autoload
 881 (define-derived-mode elisp-byte-code-mode emacs-lisp-mode
 882   "Elisp-Byte-Code"
 883   "Major mode for *.elc files."
 884   ;; TODO: Add way to disassemble byte-code under point.
 885   (setq-local open-paren-in-column-0-is-defun-start nil)
 886   (setq-local syntax-propertize-function
 887               #'elisp-byte-code-syntax-propertize))
 888
 889
 890 ;;; Globally accessible functionality
 891
 892 (defun eval-print-last-sexp (&optional eval-last-sexp-arg-internal)
 893   "Evaluate sexp before point; print value into current buffer.
 894
 895 Normally, this function truncates long output according to the value
 896 of the variables `eval-expression-print-length' and
 897 `eval-expression-print-level'.  With a prefix argument of zero,
 898 however, there is no such truncation.  Such a prefix argument
 899 also causes integers to be printed in several additional formats
 900 \(octal, hexadecimal, and character).
 901
 902 If `eval-expression-debug-on-error' is non-nil, which is the default,
 903 this command arranges for all errors to enter the debugger."
 904   (interactive "P")
 905   (let ((standard-output (current-buffer)))
 906     (terpri)
 907     (eval-last-sexp (or eval-last-sexp-arg-internal t))
 908     (terpri)))
 909
 910
 911 (defun last-sexp-setup-props (beg end value alt1 alt2)
 912   "Set up text properties for the output of `elisp--eval-last-sexp'.
 913 BEG and END are the start and end of the output in current-buffer.
 914 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
 915 alternative printed representations that can be displayed."
 916   (let ((map (make-sparse-keymap)))
 917     (define-key map "\C-m" 'elisp-last-sexp-toggle-display)
 918     (define-key map [down-mouse-2] 'mouse-set-point)
 919     (define-key map [mouse-2] 'elisp-last-sexp-toggle-display)
 920     (add-text-properties
 921      beg end
 922      `(printed-value (,value ,alt1 ,alt2)
 923                      mouse-face highlight
 924                      keymap ,map
 925                      help-echo "RET, mouse-2: toggle abbreviated display"
 926                      rear-nonsticky (mouse-face keymap help-echo
 927                                                 printed-value)))))
 928
 929
 930 (defun elisp-last-sexp-toggle-display (&optional _arg)
 931   "Toggle between abbreviated and unabbreviated printed representations."
 932   (interactive "P")
 933   (save-restriction
 934     (widen)
 935     (let ((value (get-text-property (point) 'printed-value)))
 936       (when value
 937         (let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
 938                                                         'printed-value)
 939                        (point)))
 940               (end (or (next-single-char-property-change (point) 'printed-value) (point)))
 941               (standard-output (current-buffer))
 942               (point (point)))
 943           (delete-region beg end)
 944           (insert (nth 1 value))
 945           (or (= beg point)
 946               (setq point (1- (point))))
 947           (last-sexp-setup-props beg (point)
 948                                  (nth 0 value)
 949                                  (nth 2 value)
 950                                  (nth 1 value))
 951           (goto-char (min (point-max) point)))))))
 952
 953 (defun prin1-char (char)                ;FIXME: Move it, e.g. to simple.el.
 954   "Return a string representing CHAR as a character rather than as an integer.
 955 If CHAR is not a character, return nil."
 956   (and (integerp char)
 957        (eventp char)
 958        (let ((c (event-basic-type char))
 959              (mods (event-modifiers char))
 960              string)
 961          ;; Prevent ?A from turning into ?\S-a.
 962          (if (and (memq 'shift mods)
 963                   (zerop (logand char ?\S-\^@))
 964                   (not (let ((case-fold-search nil))
 965                          (char-equal c (upcase c)))))
 966              (setq c (upcase c) mods nil))
 967          ;; What string are we considering using?
 968          (condition-case nil
 969              (setq string
 970                    (concat
 971                     "?"
 972                     (mapconcat
 973                      (lambda (modif)
 974                        (cond ((eq modif 'super) "\\s-")
 975                              (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
 976                      mods "")
 977                     (cond
 978                      ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
 979                      ((eq c 127) "\\C-?")
 980                      (t
 981                       (string c)))))
 982            (error nil))
 983          ;; Verify the string reads a CHAR, not to some other character.
 984          ;; If it doesn't, return nil instead.
 985          (and string
 986               (= (car (read-from-string string)) char)
 987               string))))
 988
 989 (defun elisp--preceding-sexp ()
 990   "Return sexp before the point."
 991   (let ((opoint (point))
 992         (left-quote ?‘)
 993         expr)
 994     (save-excursion
 995       (with-syntax-table emacs-lisp-mode-syntax-table
 996         ;; If this sexp appears to be enclosed in `...' or ‘...’
 997         ;; then ignore the surrounding quotes.
 998         (cond ((eq (preceding-char) ?’)
 999                (progn (forward-char -1) (setq opoint (point))))
1000               ((or (eq (following-char) ?\')
1001                    (eq (preceding-char) ?\'))
1002                (setq left-quote ?\`)))
1003         (forward-sexp -1)
1004         ;; If we were after `?\e' (or similar case),
1005         ;; use the whole thing, not just the `e'.
1006         (when (eq (preceding-char) ?\\)
1007           (forward-char -1)
1008           (when (eq (preceding-char) ??)
1009             (forward-char -1)))
1010
1011         ;; Skip over hash table read syntax.
1012         (and (> (point) (1+ (point-min)))
1013              (looking-back "#s" (- (point) 2))
1014              (forward-char -2))
1015
1016         ;; Skip over `#N='s.
1017         (when (eq (preceding-char) ?=)
1018           (let (labeled-p)
1019             (save-excursion
1020               (skip-chars-backward "0-9#=")
1021               (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
1022             (when labeled-p
1023               (forward-sexp -1))))
1024
1025         (save-restriction
1026           (if (eq (following-char) left-quote)
1027               ;; vladimir@cs.ualberta.ca 30-Jul-1997: Skip ` in `variable' so
1028               ;; that the value is returned, not the name.
1029               (forward-char))
1030           (when (looking-at ",@?") (goto-char (match-end 0)))
1031           (narrow-to-region (point-min) opoint)
1032           (setq expr (read (current-buffer)))
1033           ;; If it's an (interactive ...) form, it's more useful to show how an
1034           ;; interactive call would use it.
1035           ;; FIXME: Is it really the right place for this?
1036           (when (eq (car-safe expr) 'interactive)
1037                (setq expr
1038                   `(call-interactively
1039                     (lambda (&rest args) ,expr args))))
1040           expr)))))
1041 (define-obsolete-function-alias 'preceding-sexp 'elisp--preceding-sexp "25.1")
1042
1043 (defun elisp--eval-last-sexp (eval-last-sexp-arg-internal)
1044   "Evaluate sexp before point; print value in the echo area.
1045 If EVAL-LAST-SEXP-ARG-INTERNAL is non-nil, print output into
1046 current buffer.  If EVAL-LAST-SEXP-ARG-INTERNAL is `0', print
1047 output with no limit on the length and level of lists, and
1048 include additional formats for integers \(octal, hexadecimal, and
1049 character)."
1050   (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
1051     ;; Setup the lexical environment if lexical-binding is enabled.
1052     (elisp--eval-last-sexp-print-value
1053      (eval (eval-sexp-add-defvars (elisp--preceding-sexp)) lexical-binding)
1054      eval-last-sexp-arg-internal)))
1055
1056
1057 (defun elisp--eval-last-sexp-print-value (value &optional eval-last-sexp-arg-internal)
1058   (let ((unabbreviated (let ((print-length nil) (print-level nil))
1059                          (prin1-to-string value)))
1060         (print-length (and (not (zerop (prefix-numeric-value
1061                                         eval-last-sexp-arg-internal)))
1062                            eval-expression-print-length))
1063         (print-level (and (not (zerop (prefix-numeric-value
1064                                        eval-last-sexp-arg-internal)))
1065                           eval-expression-print-level))
1066         (beg (point))
1067         end)
1068     (prog1
1069         (prin1 value)
1070       (let ((str (eval-expression-print-format value)))
1071         (if str (princ str)))
1072       (setq end (point))
1073       (when (and (bufferp standard-output)
1074                  (or (not (null print-length))
1075                      (not (null print-level)))
1076                  (not (string= unabbreviated
1077                                (buffer-substring-no-properties beg end))))
1078         (last-sexp-setup-props beg end value
1079                                unabbreviated
1080                                (buffer-substring-no-properties beg end))
1081         ))))
1082
1083
1084 (defvar elisp--eval-last-sexp-fake-value (make-symbol "t"))
1085
1086 (defun eval-sexp-add-defvars (exp &optional pos)
1087   "Prepend EXP with all the `defvar's that precede it in the buffer.
1088 POS specifies the starting position where EXP was found and defaults to point."
1089   (setq exp (macroexpand-all exp))      ;Eager macro-expansion.
1090   (if (not lexical-binding)
1091       exp
1092     (save-excursion
1093       (unless pos (setq pos (point)))
1094       (let ((vars ()))
1095         (goto-char (point-min))
1096         (while (re-search-forward
1097                 "(def\\(?:var\\|const\\|custom\\)[ \t\n]+\\([^; '()\n\t]+\\)"
1098                 pos t)
1099           (let ((var (intern (match-string 1))))
1100             (and (not (special-variable-p var))
1101                  (save-excursion
1102                    (zerop (car (syntax-ppss (match-beginning 0)))))
1103               (push var vars))))
1104         `(progn ,@(mapcar (lambda (v) `(defvar ,v)) vars) ,exp)))))
1105
1106 (defun eval-last-sexp (eval-last-sexp-arg-internal)
1107   "Evaluate sexp before point; print value in the echo area.
1108 Interactively, with prefix argument, print output into current buffer.
1109
1110 Normally, this function truncates long output according to the value
1111 of the variables `eval-expression-print-length' and
1112 `eval-expression-print-level'.  With a prefix argument of zero,
1113 however, there is no such truncation.  Such a prefix argument
1114 also causes integers to be printed in several additional formats
1115 \(octal, hexadecimal, and character).
1116
1117 If `eval-expression-debug-on-error' is non-nil, which is the default,
1118 this command arranges for all errors to enter the debugger."
1119   (interactive "P")
1120   (if (null eval-expression-debug-on-error)
1121       (elisp--eval-last-sexp eval-last-sexp-arg-internal)
1122     (let ((value
1123            (let ((debug-on-error elisp--eval-last-sexp-fake-value))
1124              (cons (elisp--eval-last-sexp eval-last-sexp-arg-internal)
1125                    debug-on-error))))
1126       (unless (eq (cdr value) elisp--eval-last-sexp-fake-value)
1127         (setq debug-on-error (cdr value)))
1128       (car value))))
1129
1130 (defun elisp--eval-defun-1 (form)
1131   "Treat some expressions specially.
1132 Reset the `defvar' and `defcustom' variables to the initial value.
1133 \(For `defcustom', use the :set function if there is one.)
1134 Reinitialize the face according to the `defface' specification."
1135   ;; The code in edebug-defun should be consistent with this, but not
1136   ;; the same, since this gets a macroexpanded form.
1137   (cond ((not (listp form))
1138          form)
1139         ((and (eq (car form) 'defvar)
1140               (cdr-safe (cdr-safe form))
1141               (boundp (cadr form)))
1142          ;; Force variable to be re-set.
1143          `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
1144                  (setq-default ,(nth 1 form) ,(nth 2 form))))
1145         ;; `defcustom' is now macroexpanded to
1146         ;; `custom-declare-variable' with a quoted value arg.
1147         ((and (eq (car form) 'custom-declare-variable)
1148               (default-boundp (eval (nth 1 form) lexical-binding)))
1149          ;; Force variable to be bound, using :set function if specified.
1150          (let ((setfunc (memq :set form)))
1151            (when setfunc
1152              (setq setfunc (car-safe (cdr-safe setfunc)))
1153              (or (functionp setfunc) (setq setfunc nil)))
1154            (funcall (or setfunc 'set-default)
1155                     (eval (nth 1 form) lexical-binding)
1156                     ;; The second arg is an expression that evaluates to
1157                     ;; an expression.  The second evaluation is the one
1158                     ;; normally performed not by normal execution but by
1159                     ;; custom-initialize-set (for example), which does not
1160                     ;; use lexical-binding.
1161                     (eval (eval (nth 2 form) lexical-binding))))
1162          form)
1163         ;; `defface' is macroexpanded to `custom-declare-face'.
1164         ((eq (car form) 'custom-declare-face)
1165          ;; Reset the face.
1166          (let ((face-symbol (eval (nth 1 form) lexical-binding)))
1167            (setq face-new-frame-defaults
1168                  (assq-delete-all face-symbol face-new-frame-defaults))
1169            (put face-symbol 'face-defface-spec nil)
1170            (put face-symbol 'face-override-spec nil))
1171          form)
1172         ((eq (car form) 'progn)
1173          (cons 'progn (mapcar #'elisp--eval-defun-1 (cdr form))))
1174         (t form)))
1175
1176 (defun elisp--eval-defun ()
1177   "Evaluate defun that point is in or before.
1178 The value is displayed in the echo area.
1179 If the current defun is actually a call to `defvar',
1180 then reset the variable using the initial value expression
1181 even if the variable already has some other value.
1182 \(Normally `defvar' does not change the variable's value
1183 if it already has a value.\)
1184
1185 Return the result of evaluation."
1186   ;; FIXME: the print-length/level bindings should only be applied while
1187   ;; printing, not while evaluating.
1188   (let ((debug-on-error eval-expression-debug-on-error)
1189         (print-length eval-expression-print-length)
1190         (print-level eval-expression-print-level))
1191     (save-excursion
1192       ;; Arrange for eval-region to "read" the (possibly) altered form.
1193       ;; eval-region handles recording which file defines a function or
1194       ;; variable.
1195       (let ((standard-output t)
1196             beg end form)
1197         ;; Read the form from the buffer, and record where it ends.
1198         (save-excursion
1199           (end-of-defun)
1200           (beginning-of-defun)
1201           (setq beg (point))
1202           (setq form (read (current-buffer)))
1203           (setq end (point)))
1204         ;; Alter the form if necessary.
1205         (let ((form (eval-sexp-add-defvars
1206                      (elisp--eval-defun-1 (macroexpand form)))))
1207           (eval-region beg end standard-output
1208                        (lambda (_ignore)
1209                          ;; Skipping to the end of the specified region
1210                          ;; will make eval-region return.
1211                          (goto-char end)
1212                          form))))))
1213   (let ((str (eval-expression-print-format (car values))))
1214     (if str (princ str)))
1215   ;; The result of evaluation has been put onto VALUES.  So return it.
1216   (car values))
1217
1218 (defun eval-defun (edebug-it)
1219   "Evaluate the top-level form containing point, or after point.
1220
1221 If the current defun is actually a call to `defvar' or `defcustom',
1222 evaluating it this way resets the variable using its initial value
1223 expression (using the defcustom's :set function if there is one), even
1224 if the variable already has some other value.  \(Normally `defvar' and
1225 `defcustom' do not alter the value if there already is one.)  In an
1226 analogous way, evaluating a `defface' overrides any customizations of
1227 the face, so that it becomes defined exactly as the `defface' expression
1228 says.
1229
1230 If `eval-expression-debug-on-error' is non-nil, which is the default,
1231 this command arranges for all errors to enter the debugger.
1232
1233 With a prefix argument, instrument the code for Edebug.
1234
1235 If acting on a `defun' for FUNCTION, and the function was
1236 instrumented, `Edebug: FUNCTION' is printed in the echo area.  If not
1237 instrumented, just FUNCTION is printed.
1238
1239 If not acting on a `defun', the result of evaluation is displayed in
1240 the echo area.  This display is controlled by the variables
1241 `eval-expression-print-length' and `eval-expression-print-level',
1242 which see."
1243   (interactive "P")
1244   (cond (edebug-it
1245          (require 'edebug)
1246          (eval-defun (not edebug-all-defs)))
1247         (t
1248          (if (null eval-expression-debug-on-error)
1249              (elisp--eval-defun)
1250            (let (new-value value)
1251              (let ((debug-on-error elisp--eval-last-sexp-fake-value))
1252                (setq value (elisp--eval-defun))
1253                (setq new-value debug-on-error))
1254              (unless (eq elisp--eval-last-sexp-fake-value new-value)
1255                (setq debug-on-error new-value))
1256              value)))))
1257
1258 ;;; ElDoc Support
1259
1260 (defvar elisp--eldoc-last-data (make-vector 3 nil)
1261   "Bookkeeping; elements are as follows:
1262   0 - contains the last symbol read from the buffer.
1263   1 - contains the string last displayed in the echo area for variables,
1264       or argument string for functions.
1265   2 - 'function if function args, 'variable if variable documentation.")
1266
1267 (defun elisp-eldoc-documentation-function ()
1268   "`eldoc-documentation-function' (which see) for Emacs Lisp."
1269   (let ((current-symbol (elisp--current-symbol))
1270         (current-fnsym  (elisp--fnsym-in-current-sexp)))
1271     (cond ((null current-fnsym)
1272            nil)
1273           ((eq current-symbol (car current-fnsym))
1274            (or (apply #'elisp-get-fnsym-args-string current-fnsym)
1275                (elisp-get-var-docstring current-symbol)))
1276           (t
1277            (or (elisp-get-var-docstring current-symbol)
1278                (apply #'elisp-get-fnsym-args-string current-fnsym))))))
1279
1280 (defun elisp-get-fnsym-args-string (sym &optional index prefix)
1281   "Return a string containing the parameter list of the function SYM.
1282 If SYM is a subr and no arglist is obtainable from the docstring
1283 or elsewhere, return a 1-line docstring."
1284   (let ((argstring
1285          (cond
1286           ((not (and sym (symbolp sym) (fboundp sym))) nil)
1287           ((and (eq sym (aref elisp--eldoc-last-data 0))
1288                 (eq 'function (aref elisp--eldoc-last-data 2)))
1289            (aref elisp--eldoc-last-data 1))
1290           (t
1291            (let* ((advertised (gethash (indirect-function sym)
1292                                        advertised-signature-table t))
1293                   doc
1294                   (args
1295                    (cond
1296                     ((listp advertised) advertised)
1297                     ((setq doc (help-split-fundoc
1298                                 (condition-case nil (documentation sym t)
1299                                   (invalid-function nil))
1300                                 sym))
1301                      (car doc))
1302                     (t (help-function-arglist sym)))))
1303              ;; Stringify, and store before highlighting, downcasing, etc.
1304              (elisp--last-data-store sym (elisp-function-argstring args)
1305                                     'function))))))
1306     ;; Highlight, truncate.
1307     (if argstring
1308         (elisp--highlight-function-argument
1309          sym argstring index
1310          (or prefix
1311              (concat (propertize (symbol-name sym) 'face
1312                                  (if (functionp sym)
1313                                      'font-lock-function-name-face
1314                                    'font-lock-keyword-face))
1315                      ": "))))))
1316
1317 (defun elisp--highlight-function-argument (sym args index prefix)
1318   "Highlight argument INDEX in ARGS list for function SYM.
1319 In the absence of INDEX, just call `eldoc-docstring-format-sym-doc'."
1320   ;; FIXME: This should probably work on the list representation of `args'
1321   ;; rather than its string representation.
1322   ;; FIXME: This function is much too long, we need to split it up!
1323   (let ((start          nil)
1324         (end            0)
1325         (argument-face  'eldoc-highlight-function-argument)
1326         (args-lst (mapcar (lambda (x)
1327                             (replace-regexp-in-string
1328                              "\\`[(]\\|[)]\\'" "" x))
1329                           (split-string args))))
1330     ;; Find the current argument in the argument string.  We need to
1331     ;; handle `&rest' and informal `...' properly.
1332     ;;
1333     ;; FIXME: What to do with optional arguments, like in
1334     ;;        (defun NAME ARGLIST [DOCSTRING] BODY...) case?
1335     ;;        The problem is there is no robust way to determine if
1336     ;;        the current argument is indeed a docstring.
1337
1338     ;; When `&key' is used finding position based on `index'
1339     ;; would be wrong, so find the arg at point and determine
1340     ;; position in ARGS based on this current arg.
1341     (when (string-match "&key" args)
1342       (let* (case-fold-search
1343              key-have-value
1344              (sym-name (symbol-name sym))
1345              (cur-w (current-word))
1346              (args-lst-ak (cdr (member "&key" args-lst)))
1347              (limit (save-excursion
1348                       (when (re-search-backward sym-name nil t)
1349                         (match-end 0))))
1350              (cur-a (if (and cur-w (string-match ":\\([^ ()]*\\)" cur-w))
1351                         (substring cur-w 1)
1352                       (save-excursion
1353                         (let (split)
1354                           (when (re-search-backward ":\\([^()\n]*\\)" limit t)
1355                             (setq split (split-string (match-string 1) " " t))
1356                             (prog1 (car split)
1357                               (when (cdr split)
1358                                 (setq key-have-value t))))))))
1359              ;; If `cur-a' is not one of `args-lst-ak'
1360              ;; assume user is entering an unknown key
1361              ;; referenced in last position in signature.
1362              (other-key-arg (and (stringp cur-a)
1363                                  args-lst-ak
1364                                  (not (member (upcase cur-a) args-lst-ak))
1365                                  (upcase (car (last args-lst-ak))))))
1366         (unless (string= cur-w sym-name)
1367           ;; The last keyword have already a value
1368           ;; i.e :foo a b and cursor is at b.
1369           ;; If signature have also `&rest'
1370           ;; (assume it is after the `&key' section)
1371           ;; go to the arg after `&rest'.
1372           (if (and key-have-value
1373                    (save-excursion
1374                      (not (re-search-forward ":.*" (point-at-eol) t)))
1375                    (string-match "&rest \\([^ ()]*\\)" args))
1376               (setq index nil ; Skip next block based on positional args.
1377                     start (match-beginning 1)
1378                     end   (match-end 1))
1379             ;; If `cur-a' is nil probably cursor is on a positional arg
1380             ;; before `&key', in this case, exit this block and determine
1381             ;; position with `index'.
1382             (when (and cur-a     ; A keyword arg (dot removed) or nil.
1383                        (or (string-match
1384                             (concat "\\_<" (upcase cur-a) "\\_>") args)
1385                            (string-match
1386                             (concat "\\_<" other-key-arg "\\_>") args)))
1387               (setq index nil ; Skip next block based on positional args.
1388                     start (match-beginning 0)
1389                     end   (match-end 0)))))))
1390     ;; Handle now positional arguments.
1391     (while (and index (>= index 1))
1392       (if (string-match "[^ ()]+" args end)
1393           (progn
1394             (setq start (match-beginning 0)
1395                   end   (match-end 0))
1396             (let ((argument (match-string 0 args)))
1397               (cond ((string= argument "&rest")
1398                      ;; All the rest arguments are the same.
1399                      (setq index 1))
1400                     ((string= argument "&optional"))         ; Skip.
1401                     ((string= argument "&allow-other-keys")) ; Skip.
1402                     ;; Back to index 0 in ARG1 ARG2 ARG2 ARG3 etc...
1403                     ;; like in `setq'.
1404                     ((or (and (string-match-p "\\.\\.\\.\\'" argument)
1405                               (string= argument (car (last args-lst))))
1406                          (and (string-match-p "\\.\\.\\.\\'"
1407                                               (substring args 1 (1- (length args))))
1408                               (= (length (remove "..." args-lst)) 2)
1409                               (> index 1) (eq (logand index 1) 1)))
1410                      (setq index 0))
1411                     (t
1412                      (setq index (1- index))))))
1413         (setq end           (length args)
1414               start         (1- end)
1415               argument-face 'font-lock-warning-face
1416               index         0)))
1417     (let ((doc args))
1418       (when start
1419         (setq doc (copy-sequence args))
1420         (add-text-properties start end (list 'face argument-face) doc))
1421       (setq doc (eldoc-docstring-format-sym-doc prefix doc))
1422       doc)))
1423
1424 ;; Return a string containing a brief (one-line) documentation string for
1425 ;; the variable.
1426 (defun elisp-get-var-docstring (sym)
1427   (cond ((not sym) nil)
1428         ((and (eq sym (aref elisp--eldoc-last-data 0))
1429               (eq 'variable (aref elisp--eldoc-last-data 2)))
1430          (aref elisp--eldoc-last-data 1))
1431         (t
1432          (let ((doc (documentation-property sym 'variable-documentation t)))
1433            (when doc
1434              (let ((doc (eldoc-docstring-format-sym-doc
1435                          sym (elisp--docstring-first-line doc)
1436                          'font-lock-variable-name-face)))
1437                (elisp--last-data-store sym doc 'variable)))))))
1438
1439 (defun elisp--last-data-store (symbol doc type)
1440   (aset elisp--eldoc-last-data 0 symbol)
1441   (aset elisp--eldoc-last-data 1 doc)
1442   (aset elisp--eldoc-last-data 2 type)
1443   doc)
1444
1445 ;; Note that any leading `*' in the docstring (which indicates the variable
1446 ;; is a user option) is removed.
1447 (defun elisp--docstring-first-line (doc)
1448   (and (stringp doc)
1449        (substitute-command-keys
1450         (save-match-data
1451           ;; Don't use "^" in the regexp below since it may match
1452           ;; anywhere in the doc-string.
1453           (let ((start (if (string-match "\\`\\*" doc) (match-end 0) 0)))
1454             (cond ((string-match "\n" doc)
1455                    (substring doc start (match-beginning 0)))
1456                   ((zerop start) doc)
1457                   (t (substring doc start))))))))
1458 \f
1459 ;; Return a list of current function name and argument index.
1460 (defun elisp--fnsym-in-current-sexp ()
1461   (save-excursion
1462     (let ((argument-index (1- (elisp--beginning-of-sexp))))
1463       ;; If we are at the beginning of function name, this will be -1.
1464       (when (< argument-index 0)
1465         (setq argument-index 0))
1466       ;; Don't do anything if current word is inside a string.
1467       (if (= (or (char-after (1- (point))) 0) ?\")
1468           nil
1469         (list (elisp--current-symbol) argument-index)))))
1470
1471 ;; Move to the beginning of current sexp.  Return the number of nested
1472 ;; sexp the point was over or after.
1473 (defun elisp--beginning-of-sexp ()
1474   (let ((parse-sexp-ignore-comments t)
1475         (num-skipped-sexps 0))
1476     (condition-case _
1477         (progn
1478           ;; First account for the case the point is directly over a
1479           ;; beginning of a nested sexp.
1480           (condition-case _
1481               (let ((p (point)))
1482                 (forward-sexp -1)
1483                 (forward-sexp 1)
1484                 (when (< (point) p)
1485                   (setq num-skipped-sexps 1)))
1486             (error))
1487           (while
1488               (let ((p (point)))
1489                 (forward-sexp -1)
1490                 (when (< (point) p)
1491                   (setq num-skipped-sexps (1+ num-skipped-sexps))))))
1492       (error))
1493     num-skipped-sexps))
1494
1495 ;; returns nil unless current word is an interned symbol.
1496 (defun elisp--current-symbol ()
1497   (let ((c (char-after (point))))
1498     (and c
1499          (memq (char-syntax c) '(?w ?_))
1500          (intern-soft (current-word)))))
1501
1502 (defun elisp-function-argstring (arglist)
1503   "Return ARGLIST as a string enclosed by ().
1504 ARGLIST is either a string, or a list of strings or symbols."
1505   (let ((str (cond ((stringp arglist) arglist)
1506                    ((not (listp arglist)) nil)
1507                    (t (help--make-usage-docstring 'toto arglist)))))
1508     (if (and str (string-match "\\`([^ )]+ ?" str))
1509         (replace-match "(" t t str)
1510       str)))
1511
1512 (provide 'elisp-mode)
1513 ;;; elisp-mode.el ends here