| blob | 94be5acd6d30409f630d88b727e1de05032cf4c1 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1999-2018 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: lisp, languages
7 ;; Package: emacs
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 <https://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
27 ;; This mode is documented in the Emacs manual.
29 ;;; Code:
60 ;; Non-break space acts as whitespace.
65 ;; This is probably obsolete since nowadays such features use overlays.
66 ;; ;; Give CR the same syntax as newline, for selective-display.
67 ;; (modify-syntax-entry ?\^m "> " table)
73 ;; Used to be singlequote; changed for flonums.
80 table)
89 table)
102 ;; Elisp.
106 "define-global-minor-mode"
107 "define-globalized-minor-mode"
109 "ert-deftest"
112 "cl-defmethod"
113 ;; CL.
116 "define-method-combination"
117 ;; CLOS and EIEIO
119 t))
128 ;; CL
129 "defconstant"
131 t))
134 ;; For `defvar'/`defvar-local', we ignore (defvar FOO) constructs.
148 ;; CL
151 ;; CLOS and EIEIO
153 t))
159 ;; This was originally in autoload.el and is still used there.
167 ;; CL
177 ;;;; Font-lock support.
194 nil)))
195 res))
198 "Heuristically determine whether POS is an evaluated position."
220 symbol-end))
234 ;; FIXME: Move to elisp-mode.el.
239 limit t)
249 "Like `let*', but allow for compile time optimization.
250 Use BINDINGS as in regular `let*', but in BODY each usage should
251 be wrapped in `eval-when-compile'.
252 This will generate compile-time constants from BINDINGS."
258 macroexpand-all-environment)
271 ;; Don't highlight the \( introduced because of
272 ;; `open-paren-in-column-0-is-defun-start'.
278 beg0 end0)))))
291 ;; Elisp constructs. Now they are update dynamically
292 ;; from obarray but they are also used for setting up
293 ;; the keywords for Common Lisp.
304 ;; Common-Lisp constructs supported by EIEIO. FIXME: namespace.
307 ;; Common-Lisp constructs supported by cl-lib.
311 ;; Common-Lisp constructs not supported by cl-lib.
314 ;; "define-function"??
338 ;; Elisp and Common Lisp definers.
341 el-fdefs el-vdefs el-tdefs
344 eieio-fdefs eieio-tdefs)
345 t)))
348 cl-lib-fdefs cl-lib-tdefs
349 eieio-fdefs eieio-tdefs
350 cl-fdefs cl-vdefs cl-tdefs)
351 t)))
352 ;; Common Lisp keywords (Elisp keywords are handled dynamically).
355 ;; Elisp and Common Lisp "errors".
358 cl-lib-errs)
359 lisp-errs el-errs)
360 t)))
373 ;; Any whitespace and defined object.
382 ;; If match-string 2 is non-nil, we encountered a
383 ;; form like (defalias (intern (concat s "-p"))),
384 ;; unless match-string 4 is also there. Then its a
385 ;; defmethod with (setf foo) as name.
389 font-lock-function-name-face)))
390 nil t))
391 ;; Emacs Lisp autoload cookies. Supports the slightly different
392 ;; forms used by mh-e, calendar, etc.
399 ;; Any whitespace and defined object.
411 font-lock-function-name-face)))
412 nil t)))
419 lisp-el-font-lock-keywords-1
422 ;; Erroneous structures.
425 ;; Control structures. Common Lisp forms.
427 ;; Exit/Feature symbols as constants.
432 ;; Words inside \\[] tend to be for `substitute-command-keys'.
435 ;; Ineffective backslashes (typically in need of doubling).
438 ;; Words inside ‘’ and `' tend to be symbol names.
442 ;; Constant values.
445 ;; ELisp and CLisp `&' keywords as types.
447 . font-lock-type-face)
448 ;; ELisp regexp grouping constructs
451 ;; The following loop is needed to continue searching after matches
452 ;; that do not occur in strings. The associated regexp matches one
453 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
454 ;; avoid highlighting, for example, `\\(' in `\\\\('.
455 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?[0-9]*:\\)?\\|[|)]\\)\\)" bound t)
464 ;; This is too general -- rms.
465 ;; A user complained that he has functions whose names start with `do'
466 ;; and that they get the wrong color.
467 ;; ;; CL `with-' and `do-' constructs
468 ;;("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
472 ))
477 lisp-cl-font-lock-keywords-1
480 ;; Control structures. Common Lisp forms.
482 ;; Exit/Feature symbols as constants.
487 ;; Erroneous structures.
490 ;; Words inside ‘’ and `' tend to be symbol names.
494 ;; Constant values.
497 ;; ELisp and CLisp `&' keywords as types.
499 . font-lock-type-face)
500 ;; This is too general -- rms.
501 ;; A user complained that he has functions whose names start with `do'
502 ;; and that they get the wrong color.
503 ;; ;; CL `with-' and `do-' constructs
504 ;;("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
508 ))
519 "Return true if a doc string may occur at STARTPOS inside a list.
520 LISTBEG is the position of the start of the innermost list
521 containing STARTPOS."
532 lisp-doc-string-elt-property))))
534 ;; It's a string in a form that can have a docstring.
535 ;; Check whether it's in docstring position.
552 "Return true if `:documentation' symbol ends at STARTPOS inside a list.
553 LISTBEG is the position of the start of the innermost list
554 containing STARTPOS."
563 "Return syntactic face function for the position represented by STATE.
564 STATE is a `parse-partial-sexp' state, and the returned function is the
565 Lisp font lock syntactic face function."
567 ;; This might be a (doc)string or a |...| symbol.
570 ;; This is not a string, but a |...| symbol.
571 nil
575 font-lock-doc-face
576 font-lock-string-face))))
577 font-lock-comment-face))
580 "Return fill prefix found at point.
581 Value for `adaptive-fill-function'."
582 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
583 ;; a single docstring. Let's fix it here.
587 elisp)
588 "Common initialization routine for lisp modes.
589 The LISP-SYNTAX argument is used by code in inf-lisp.el and is
590 \(uselessly) passed from pp.el, chistory.el, gnus-kill.el and
591 score-mode.el. KEYWORDS-CASE-INSENSITIVE non-nil means that for
592 font-lock keywords will not be case sensitive."
598 ;; Adaptive fill mode gets in the way of auto-fill,
599 ;; and should make no difference for explicit fill
600 ;; because lisp-fill-paragraph should do the job.
601 ;; I believe that newcomment's auto-fill code properly deals with it -stef
602 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
616 ;; (setq-local syntax-begin-function 'beginning-of-defun) ;;Bug#16247.
619 lisp-el-font-lock-keywords-1
620 lisp-el-font-lock-keywords-2)
622 lisp-cl-font-lock-keywords-1
623 lisp-cl-font-lock-keywords-2))
624 nil ,keywords-case-insensitive nil nil
628 . lisp-font-lock-syntactic-face-function)))
634 "Lisp mode `outline-level' function."
637 1000
638 len)))
641 "Return the name of the defun at point, or nil."
644 ;; If we are now precisely at the beginning of a defun, make sure
645 ;; beginning-of-defun finds that one rather than the previous one.
648 ;; Make sure we are really inside the defun found, not after it.
656 ;; Skip the defining construct name, typically "defun" or
657 ;; "defvar".
659 ;; The second element is usually a symbol being defined. If it
660 ;; is not, use the first symbol in it.
671 ;; This gets in the way when viewing a Lisp file in view-mode. As
672 ;; long as [backspace] is mapped into DEL via the
673 ;; function-key-map, this should remain disabled!!
674 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
675 map)
679 "Hook run when entering Lisp mode."
685 "Hook run when entering Lisp Interaction mode."
690 ;;; Generic Lisp mode.
708 map)
709 "Keymap for ordinary Lisp mode.
713 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
714 Commands:
715 Delete converts tabs to spaces as it moves back.
716 Blank lines separate paragraphs. Semicolons start comments.
719 Note that `run-lisp' may be used either to start an inferior Lisp job
720 or to switch back to an existing one."
732 default))))
734 ;; Used in old LispM code.
740 "Like `comment-indent-default', but don't put space after open paren."
747 nil)))
753 "If non-nil, indent second line of expressions that many more columns."
760 "A function to be called by `calculate-lisp-indent'.
761 It indents the arguments of a Lisp function call. This function
762 should accept two arguments: the indent-point, and the
763 `parse-partial-sexp' state at that position. One option for this
764 function is `common-lisp-indent-function'."
769 "Return Parse-Partial-Sexp State at POS, defaulting to point.
770 Like `syntax-ppss' but includes the character address of the last
771 complete sexp in the innermost containing list at position
772 2 (counting from 0). This is important for lisp indentation."
778 pss)))
782 (:constructor lisp-indent-initial-state
786 stack ;; Cached indentation, per depth.
787 ppss
788 ppss-point)
791 "Move to next line and return calculated indent for it.
792 STATE is updated by side effect, the first state should be
793 created by `lisp-indent-initial-state'. This function may move
794 by more than one line to cross a string literal."
797 state)
800 ;; Parse this line so we can learn the state to indent the
801 ;; next line.
805 nil nil ppss))
806 ;; Preserve last sexp of state (position 2) for
807 ;; `calculate-lisp-indent', if we're at the same depth.
812 ;; Skip over newlines within strings.
826 indent-stack)))))
835 ;; This only happens if we're in a string.
842 "Indent region as Lisp code, efficiently."
847 ;; The default `indent-region-line-by-line' doesn't hold a running
848 ;; parse state, which forces each indent call to reparse from the
849 ;; beginning. That has O(n^2) complexity.
866 "Indent current line as Lisp code."
873 ;; Don't alter indentation of a ;;; comment line
874 ;; or a line that starts in a string.
875 ;; FIXME: inconsistency: comment-indent moves ;;; to column 0.
878 ;; Single-semicolon comment lines should be indented
879 ;; as comment lines, not as code.
883 ;; If initial point was within line's indentation,
884 ;; position after the indentation. Else stay at same point in text.
891 "Return appropriate indentation for current line as Lisp code.
892 In usual case returns an integer: the column to indent to.
893 If the value is nil, that means don't change the indentation
894 because the line starts inside a string.
896 PARSE-START may be a buffer position to start parsing from, or a
897 parse state as returned by calling `parse-partial-sexp' up to the
898 beginning of the current line.
900 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
901 This means that following lines at the same level of indentation
902 should not necessarily be indented the same as this line.
903 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
904 is the buffer position of the start of the containing expression."
908 state
909 ;; setting this to a number inhibits calling hook
912 calculate-lisp-indent-last-sexp containing-sexp)
918 ;; Find outermost containing sexp
921 ;; Find innermost containing sexp
923 state
928 ;; Position following last unclosed open.
930 ;; Is there a complete sexp since then?
933 ;; Yes, but is there a containing sexp after that?
938 nil
939 ;; Innermost containing sexp found
942 ;; indent-point immediately follows open paren.
943 ;; Don't call hook.
945 ;; Find the start of first element of containing sexp.
948 ;; First element of containing sexp is a list.
949 ;; Indent under that list.
950 )
952 calculate-lisp-indent-last-sexp)
953 ;; This is the first line to start within the containing sexp.
954 ;; It's almost certainly a function call.
956 ;; Containing sexp has nothing before this line
957 ;; except the first element. Indent under that element.
958 nil
959 ;; Skip the first element, find start of second (the first
960 ;; argument of the function call) and indent under.
963 calculate-lisp-indent-last-sexp
967 ;; Indent beneath first sexp on same line as
968 ;; `calculate-lisp-indent-last-sexp'. Again, it's
969 ;; almost certainly a function call.
975 ;; Point is at the point to indent under unless we are inside a string.
976 ;; Call indentation hook except when overridden by lisp-indent-offset
977 ;; or if the desired indentation has already been computed.
980 ;; Inside a string, don't change indentation.
981 nil)
983 ;; Indent by constant offset
986 ;; in this case calculate-lisp-indent-last-sexp is not nil
989 ;; try to align the parameters of a known function
993 ;; If the function has no special alignment
994 ;; or it does not apply to this argument,
995 ;; try to align a constant-symbol under the last
996 ;; preceding constant symbol, if there is such one of
997 ;; the last 2 preceding symbols, in the previous
998 ;; uncommented line.
1003 ;; The last sexp may not be at the indentation
1004 ;; where it begins, so find that one, instead.
1007 ;; Handle prefix characters and whitespace
1008 ;; following an open paren. (Bug#1012)
1017 (> calculate-lisp-indent-last-sexp
1023 indent)
1031 indent))
1032 ;; another symbols or constants not preceded by a constant
1033 ;; as defined above.
1034 normal-indent))
1035 ;; in this case calculate-lisp-indent-last-sexp is nil
1038 normal-indent))))))
1041 "This function is the normal value of the variable `lisp-indent-function'.
1042 The function `calculate-lisp-indent' calls this to determine
1043 if the arguments of a Lisp function call should be indented specially.
1045 INDENT-POINT is the position at which the line being indented begins.
1046 Point is located at the point to indent under (for default indentation);
1047 STATE is the `parse-partial-sexp' state for that position.
1049 If the current line is in a call to a Lisp function that has a non-nil
1050 property `lisp-indent-function' (or the deprecated `lisp-indent-hook'),
1051 it specifies how to indent. The property value can be:
1053 * `defun', meaning indent `defun'-style
1054 (this is also the case if there is no property and the function
1057 * an integer N, meaning indent the first N arguments specially
1058 (like ordinary function arguments), and then indent any further
1059 arguments like a body;
1061 * a function to call that returns the indentation (or nil).
1062 `lisp-indent-function' calls this function with the same two arguments
1063 that it itself received.
1065 This function returns either the indentation to use, or nil if the
1066 Lisp function does not specify a special indentation."
1072 ;; car of form doesn't seem to be a symbol
1075 calculate-lisp-indent-last-sexp))
1080 ;; Indent under the list or under the first sexp on the same
1081 ;; line as calculate-lisp-indent-last-sexp. Note that first
1082 ;; thing on that line has to be complete sexp since we are
1083 ;; inside the innermost containing sexp.
1088 method)
1099 indent-point normal-indent))
1104 "Number of columns to indent the second line of a `(def...)' form."
1112 body-indent containing-form-column)
1113 ;; Move to the start of containing form, calculate indentation
1114 ;; to use for non-distinguished forms (> count), and move past the
1115 ;; function symbol. lisp-indent-function guarantees that there is at
1116 ;; least one word or symbol character following open paren of containing
1117 ;; form.
1123 ;; Now find the start of the last form.
1132 ;; Point is sitting on first character of last (or count) sexp.
1134 ;; A distinguished form. If it is the first or second form use double
1135 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
1136 ;; to 2 (the default), this just happens to work the same with if as
1137 ;; the older code, but it makes unwind-protect, condition-case,
1138 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
1139 ;; less hacked, behavior can be obtained by replacing below with
1140 ;; (list normal-indent containing-form-start).
1143 containing-form-start)
1145 ;; A non-distinguished form. Use body-indent if there are no
1146 ;; distinguished forms and this is the first undistinguished form,
1147 ;; or if this is the first undistinguished form and the preceding
1148 ;; distinguished form has indentation at least as great as body-indent.
1151 body-indent
1152 normal-indent))))
1163 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1164 ;; like defun if the first form is placed on the next line, otherwise
1165 ;; it is indented like any other form (i.e. forms line up under first).
1186 "Indent each line of the list starting just after point.
1187 If optional arg ENDPOS is given, indent each line, stopping when
1188 ENDPOS is encountered."
1191 ;; We need a marker because we modify the buffer
1192 ;; text preceding endpos.
1195 ;; Get error now if we don't have a complete sexp
1196 ;; after point.
1201 ;; If the line contains a comment indent it now with
1202 ;; `indent-for-comment'.
1210 ;; Indent the next line, unless it's blank, or just a
1211 ;; comment (we will `indent-for-comment' the latter).
1216 t))))
1220 "Indent each line of the list starting just after point, or prettyprint it.
1221 A prefix argument specifies pretty-printing."
1233 ;;;; Lisp paragraph filling commands.
1236 "Value of `fill-column' to use when filling a docstring.
1237 Any non-integer value means do not use a different value of
1238 `fill-column' when filling docstrings."
1247 If any of the current line is a comment, fill the comment or the
1248 paragraph of it that point is in, preserving the comment's indentation
1249 and initial semicolons."
1252 ;; Since fill-comment-paragraph returned nil, that means we're not in
1253 ;; a comment: Point is on a program line; we are interested
1254 ;; particularly in docstring lines.
1255 ;;
1256 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1257 ;; are buffer-local, but we avoid changing them so that they can be set
1258 ;; to make `forward-paragraph' and friends do something the user wants.
1259 ;;
1260 ;; `paragraph-start': The `(' in the character alternative and the
1261 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1262 ;; sexps and backquoted sexps that follow a docstring from being filled
1263 ;; with the docstring. This setting has the consequence of inhibiting
1264 ;; filling many program lines that are not docstrings, which is sensible,
1265 ;; because the user probably asked to fill program lines by accident, or
1266 ;; expecting indentation (perhaps we should try to do indenting in that
1267 ;; case). The `;' and `:' stop the paragraph being filled at following
1268 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1269 ;; escaped to keep font-locking, filling, & paren matching in the source
1270 ;; file happy. The `:' must be preceded by whitespace so that keywords
1271 ;; inside of the docstring don't start new paragraphs (Bug#7751).
1272 ;;
1273 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1274 ;; a docstring and identifies it as a paragraph separator, so that it
1275 ;; won't be filled. (Since the first line of documentation stands alone
1276 ;; in some contexts, filling should not alter the contents the author has
1277 ;; chosen.) Only the first line of a docstring begins with whitespace
1278 ;; and a quotation mark and ends with a period or (rarely) a comma.
1279 ;;
1280 ;; The `fill-column' is temporarily bound to
1281 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1289 emacs-lisp-docstring-fill-column
1290 fill-column)))
1292 ;; Never return nil.
1293 t))
1296 "Indent all lines of code, starting in the region, sideways by ARG columns.
1297 Does not affect lines starting inside comments or strings, assuming that
1298 the start of the region is not inside them.
1300 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1301 The last is a regexp which, if matched at the beginning of a line,
1302 means don't indent that line."
1313 nil nil state)))
1318 ;; If line does not start in string, indent it
1326 nil nil state))))))
1330 ;;; lisp-mode.el ends here