| blob | 4576f5cd6badb822678dfba7249fb405702790fb |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1986, 1999-2015 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 <http://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:
58 ;; Non-break space acts as whitespace.
63 ;; This is probably obsolete since nowadays such features use overlays.
64 ;; ;; Give CR the same syntax as newline, for selective-display.
65 ;; (modify-syntax-entry ?\^m "> " table)
71 ;; Used to be singlequote; changed for flonums.
78 table)
87 table)
100 ;; Elisp.
104 "define-global-minor-mode"
105 "define-globalized-minor-mode"
108 "cl-define-compiler-macro"
109 ;; CL.
112 "define-method-combination"
113 ;; CLOS and EIEIO
115 t))
124 ;; CL
125 "defconstant"
127 t))
130 ;; For `defvar', we ignore (defvar FOO) constructs.
143 ;; CL
146 ;; CLOS and EIEIO
148 t))
154 ;; This was originally in autoload.el and is still used there.
167 ;;;; Font-lock support.
184 nil)))
185 res))
188 "Heuristically determine whether POS is an evaluated position."
210 symbol-end))
224 ;; FIXME: Move to elisp-mode.el.
229 limit t)
246 ;; Elisp constructs. Now they are update dynamically
247 ;; from obarray but they are also used for setting up
248 ;; the keywords for Common Lisp.
259 ;; Common-Lisp constructs supported by EIEIO. FIXME: namespace.
262 ;; Common-Lisp constructs supported by cl-lib.
266 ;; Common-Lisp constructs not supported by cl-lib.
269 ;; "define-function"??
293 ;; Elisp and Common Lisp definers.
296 el-fdefs el-vdefs el-tdefs
299 eieio-fdefs eieio-tdefs)
300 t)))
303 cl-lib-fdefs cl-lib-tdefs
304 eieio-fdefs eieio-tdefs
305 cl-fdefs cl-vdefs cl-tdefs)
306 t)))
307 ;; Common Lisp keywords (Elisp keywords are handled dynamically).
310 ;; Elisp and Common Lisp "errors".
313 cl-lib-errs)
314 lisp-errs el-errs)
315 t)))
328 ;; Any whitespace and defined object.
337 ;; If match-string 2 is non-nil, we encountered a
338 ;; form like (defalias (intern (concat s "-p"))),
339 ;; unless match-string 4 is also there. Then its a
340 ;; defmethod with (setf foo) as name.
344 font-lock-function-name-face)))
345 nil t))
346 ;; Emacs Lisp autoload cookies. Supports the slightly different
347 ;; forms used by mh-e, calendar, etc.
354 ;; Any whitespace and defined object.
366 nil t)))
373 lisp-el-font-lock-keywords-1
376 ;; Control structures. Common Lisp forms.
378 ;; Exit/Feature symbols as constants.
383 ;; Erroneous structures.
386 ;; Words inside \\[] tend to be for `substitute-command-keys'.
389 ;; Words inside ‘’ and '' and `' tend to be symbol names.
393 ;; Constant values.
396 ;; ELisp and CLisp `&' keywords as types.
398 . font-lock-type-face)
399 ;; ELisp regexp grouping constructs
402 ;; The following loop is needed to continue searching after matches
403 ;; that do not occur in strings. The associated regexp matches one
404 ;; of `\\\\' `\\(' `\\(?:' `\\|' `\\)'. `\\\\' has been included to
405 ;; avoid highlighting, for example, `\\(' in `\\\\('.
406 (while (re-search-forward "\\(\\\\\\\\\\)\\(?:\\(\\\\\\\\\\)\\|\\((\\(?:\\?[0-9]*:\\)?\\|[|)]\\)\\)" bound t)
415 ;; This is too general -- rms.
416 ;; A user complained that he has functions whose names start with `do'
417 ;; and that they get the wrong color.
418 ;; ;; CL `with-' and `do-' constructs
419 ;;("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
423 ))
428 lisp-cl-font-lock-keywords-1
431 ;; Control structures. Common Lisp forms.
433 ;; Exit/Feature symbols as constants.
438 ;; Erroneous structures.
441 ;; Words inside ‘’ and '' and `' tend to be symbol names.
445 ;; Constant values.
448 ;; ELisp and CLisp `&' keywords as types.
450 . font-lock-type-face)
451 ;; This is too general -- rms.
452 ;; A user complained that he has functions whose names start with `do'
453 ;; and that they get the wrong color.
454 ;; ;; CL `with-' and `do-' constructs
455 ;;("(\\(\\(do-\\|with-\\)\\(\\s_\\|\\w\\)*\\)" 1 font-lock-keyword-face)
459 ))
480 lisp-doc-string-elt-property))))
482 ;; It's a string in a form that can have a docstring.
483 ;; Check whether it's in docstring position.
509 ;; This might be a (doc)string or a |...| symbol.
512 ;; This is not a string, but a |...| symbol.
513 nil
517 font-lock-doc-face
518 font-lock-string-face))))
519 font-lock-comment-face))
522 elisp)
523 "Common initialization routine for lisp modes.
524 The LISP-SYNTAX argument is used by code in inf-lisp.el and is
525 \(uselessly) passed from pp.el, chistory.el, gnus-kill.el and
526 score-mode.el. KEYWORDS-CASE-INSENSITIVE non-nil means that for
527 font-lock keywords will not be case sensitive."
532 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
533 ;; a single docstring. Let's fix it here.
536 ;; Adaptive fill mode gets in the way of auto-fill,
537 ;; and should make no difference for explicit fill
538 ;; because lisp-fill-paragraph should do the job.
539 ;; I believe that newcomment's auto-fill code properly deals with it -stef
540 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
552 ;; (setq-local syntax-begin-function 'beginning-of-defun) ;;Bug#16247.
555 lisp-el-font-lock-keywords-1
556 lisp-el-font-lock-keywords-2)
558 lisp-cl-font-lock-keywords-1
559 lisp-cl-font-lock-keywords-2))
560 nil ,keywords-case-insensitive nil nil
564 . lisp-font-lock-syntactic-face-function)))
570 "Lisp mode `outline-level' function."
573 1000
574 len)))
577 "Return the name of the defun at point, or nil."
580 ;; If we are now precisely at the beginning of a defun, make sure
581 ;; beginning-of-defun finds that one rather than the previous one.
584 ;; Make sure we are really inside the defun found, not after it.
592 ;; Skip the defining construct name, typically "defun" or
593 ;; "defvar".
595 ;; The second element is usually a symbol being defined. If it
596 ;; is not, use the first symbol in it.
607 ;; This gets in the way when viewing a Lisp file in view-mode. As
608 ;; long as [backspace] is mapped into DEL via the
609 ;; function-key-map, this should remain disabled!!
610 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
611 map)
615 "Hook run when entering Lisp mode."
621 "Hook run when entering Lisp Interaction mode."
629 ;;; Generic Lisp mode.
647 map)
648 "Keymap for ordinary Lisp mode.
652 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
653 Commands:
654 Delete converts tabs to spaces as it moves back.
655 Blank lines separate paragraphs. Semicolons start comments.
658 Note that `run-lisp' may be used either to start an inferior Lisp job
659 or to switch back to an existing one."
671 default))))
673 ;; Used in old LispM code.
676 ;; This will do unless inf-lisp.el is loaded.
682 ;; May still be used by some external Lisp-mode variant.
688 "If non-nil, indent second line of expressions that many more columns."
695 "A function to be called by `calculate-lisp-indent'.
696 It indents the arguments of a Lisp function call. This function
697 should accept two arguments: the indent-point, and the
698 `parse-partial-sexp' state at that position. One option for this
699 function is `common-lisp-indent-function'."
704 "Indent current line as Lisp code.
705 With argument, indent any additional lines of the same expression
706 rigidly along with this one."
713 ;; Don't alter indentation of a ;;; comment line
714 ;; or a line that starts in a string.
715 ;; FIXME: inconsistency: comment-indent moves ;;; to column 0.
718 ;; Single-semicolon comment lines should be indented
719 ;; as comment lines, not as code.
724 nil
727 ;; If initial point was within line's indentation,
728 ;; position after the indentation. Else stay at same point in text.
735 "Return appropriate indentation for current line as Lisp code.
736 In usual case returns an integer: the column to indent to.
737 If the value is nil, that means don't change the indentation
738 because the line starts inside a string.
740 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
741 This means that following lines at the same level of indentation
742 should not necessarily be indented the same as this line.
743 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
744 is the buffer position of the start of the containing expression."
748 state
749 ;; setting this to a number inhibits calling hook
752 calculate-lisp-indent-last-sexp containing-sexp)
756 ;; Find outermost containing sexp
759 ;; Find innermost containing sexp
761 state
766 ;; Position following last unclosed open.
768 ;; Is there a complete sexp since then?
771 ;; Yes, but is there a containing sexp after that?
776 nil
777 ;; Innermost containing sexp found
780 ;; indent-point immediately follows open paren.
781 ;; Don't call hook.
783 ;; Find the start of first element of containing sexp.
786 ;; First element of containing sexp is a list.
787 ;; Indent under that list.
788 )
790 calculate-lisp-indent-last-sexp)
791 ;; This is the first line to start within the containing sexp.
792 ;; It's almost certainly a function call.
794 ;; Containing sexp has nothing before this line
795 ;; except the first element. Indent under that element.
796 nil
797 ;; Skip the first element, find start of second (the first
798 ;; argument of the function call) and indent under.
801 calculate-lisp-indent-last-sexp
805 ;; Indent beneath first sexp on same line as
806 ;; `calculate-lisp-indent-last-sexp'. Again, it's
807 ;; almost certainly a function call.
813 ;; Point is at the point to indent under unless we are inside a string.
814 ;; Call indentation hook except when overridden by lisp-indent-offset
815 ;; or if the desired indentation has already been computed.
818 ;; Inside a string, don't change indentation.
819 nil)
821 ;; Indent by constant offset
824 ;; in this case calculate-lisp-indent-last-sexp is not nil
827 ;; try to align the parameters of a known function
831 ;; If the function has no special alignment
832 ;; or it does not apply to this argument,
833 ;; try to align a constant-symbol under the last
834 ;; preceding constant symbol, if there is such one of
835 ;; the last 2 preceding symbols, in the previous
836 ;; uncommented line.
841 ;; The last sexp may not be at the indentation
842 ;; where it begins, so find that one, instead.
845 ;; Handle prefix characters and whitespace
846 ;; following an open paren. (Bug#1012)
855 (> calculate-lisp-indent-last-sexp
861 indent)
869 indent))
870 ;; another symbols or constants not preceded by a constant
871 ;; as defined above.
872 normal-indent))
873 ;; in this case calculate-lisp-indent-last-sexp is nil
876 normal-indent))))))
879 "This function is the normal value of the variable `lisp-indent-function'.
880 The function `calculate-lisp-indent' calls this to determine
881 if the arguments of a Lisp function call should be indented specially.
883 INDENT-POINT is the position at which the line being indented begins.
884 Point is located at the point to indent under (for default indentation);
885 STATE is the `parse-partial-sexp' state for that position.
887 If the current line is in a call to a Lisp function that has a non-nil
888 property `lisp-indent-function' (or the deprecated `lisp-indent-hook'),
889 it specifies how to indent. The property value can be:
891 * `defun', meaning indent `defun'-style
892 (this is also the case if there is no property and the function
895 * an integer N, meaning indent the first N arguments specially
896 (like ordinary function arguments), and then indent any further
897 arguments like a body;
899 * a function to call that returns the indentation (or nil).
900 `lisp-indent-function' calls this function with the same two arguments
901 that it itself received.
903 This function returns either the indentation to use, or nil if the
904 Lisp function does not specify a special indentation."
910 ;; car of form doesn't seem to be a symbol
913 calculate-lisp-indent-last-sexp))
918 ;; Indent under the list or under the first sexp on the same
919 ;; line as calculate-lisp-indent-last-sexp. Note that first
920 ;; thing on that line has to be complete sexp since we are
921 ;; inside the innermost containing sexp.
926 method)
937 indent-point normal-indent))
942 "Number of columns to indent the second line of a `(def...)' form."
950 body-indent containing-form-column)
951 ;; Move to the start of containing form, calculate indentation
952 ;; to use for non-distinguished forms (> count), and move past the
953 ;; function symbol. lisp-indent-function guarantees that there is at
954 ;; least one word or symbol character following open paren of containing
955 ;; form.
961 ;; Now find the start of the last form.
970 ;; Point is sitting on first character of last (or count) sexp.
972 ;; A distinguished form. If it is the first or second form use double
973 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
974 ;; to 2 (the default), this just happens to work the same with if as
975 ;; the older code, but it makes unwind-protect, condition-case,
976 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
977 ;; less hacked, behavior can be obtained by replacing below with
978 ;; (list normal-indent containing-form-start).
981 containing-form-start)
983 ;; A non-distinguished form. Use body-indent if there are no
984 ;; distinguished forms and this is the first undistinguished form,
985 ;; or if this is the first undistinguished form and the preceding
986 ;; distinguished form has indentation at least as great as body-indent.
989 body-indent
990 normal-indent))))
1001 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1002 ;; like defun if the first form is placed on the next line, otherwise
1003 ;; it is indented like any other form (i.e. forms line up under first).
1024 "Indent each line of the list starting just after point.
1025 If optional arg ENDPOS is given, indent each line, stopping when
1026 ENDPOS is encountered."
1030 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
1031 ;; so that calculate-lisp-indent will find the beginning of
1032 ;; the defun we are in.
1033 ;; If ENDPOS is nil, it is safe not to scan before point
1034 ;; since every line we indent is more deeply nested than point is.
1037 last-depth bol outer-loop-done inner-loop-done state this-indent)
1039 ;; Get error now if we don't have a complete sexp after point.
1046 inner-loop-done nil)
1047 ;; Parse this line so we can learn the state
1048 ;; to indent the next line.
1049 ;; This inner loop goes through only once
1050 ;; unless a line ends inside a string.
1054 nil nil state))
1056 ;; If the line contains a comment other than the sort
1057 ;; that is indented like code,
1058 ;; indent it now with indent-for-comment.
1059 ;; Comments indented like code are right already.
1060 ;; In any case clear the in-comment flag in the state
1061 ;; because parse-partial-sexp never sees the newlines.
1066 ;; If this line ends inside a string,
1067 ;; go straight to next line, remaining within the inner loop,
1068 ;; and turn off the \-flag.
1082 ;; Decide whether to exit.
1084 ;; If we have already reached the specified end,
1085 ;; give up and do not reindent this line.
1088 ;; If no specified end, we are done if we have finished one sexp.
1098 ;; Now indent the next line according
1099 ;; to what we learned from parsing the previous one.
1102 ;; But not if the line is blank, or just a comment
1103 ;; (except for double-semi comments; indent them as usual).
1105 nil
1111 starting-point))))
1127 "Indent each line of the list starting just after point, or prettyprint it.
1128 A prefix argument specifies pretty-printing."
1140 ;;;; Lisp paragraph filling commands.
1143 "Value of `fill-column' to use when filling a docstring.
1144 Any non-integer value means do not use a different value of
1145 `fill-column' when filling docstrings."
1154 If any of the current line is a comment, fill the comment or the
1155 paragraph of it that point is in, preserving the comment's indentation
1156 and initial semicolons."
1159 ;; Since fill-comment-paragraph returned nil, that means we're not in
1160 ;; a comment: Point is on a program line; we are interested
1161 ;; particularly in docstring lines.
1162 ;;
1163 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1164 ;; are buffer-local, but we avoid changing them so that they can be set
1165 ;; to make `forward-paragraph' and friends do something the user wants.
1166 ;;
1167 ;; `paragraph-start': The `(' in the character alternative and the
1168 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1169 ;; sexps and backquoted sexps that follow a docstring from being filled
1170 ;; with the docstring. This setting has the consequence of inhibiting
1171 ;; filling many program lines that are not docstrings, which is sensible,
1172 ;; because the user probably asked to fill program lines by accident, or
1173 ;; expecting indentation (perhaps we should try to do indenting in that
1174 ;; case). The `;' and `:' stop the paragraph being filled at following
1175 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1176 ;; escaped to keep font-locking, filling, & paren matching in the source
1177 ;; file happy.
1178 ;;
1179 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1180 ;; a docstring and identifies it as a paragraph separator, so that it
1181 ;; won't be filled. (Since the first line of documentation stands alone
1182 ;; in some contexts, filling should not alter the contents the author has
1183 ;; chosen.) Only the first line of a docstring begins with whitespace
1184 ;; and a quotation mark and ends with a period or (rarely) a comma.
1185 ;;
1186 ;; The `fill-column' is temporarily bound to
1187 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1194 emacs-lisp-docstring-fill-column
1195 fill-column)))
1197 ;; Never return nil.
1198 t))
1201 "Indent all lines of code, starting in the region, sideways by ARG columns.
1202 Does not affect lines starting inside comments or strings, assuming that
1203 the start of the region is not inside them.
1205 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1206 The last is a regexp which, if matched at the beginning of a line,
1207 means don't indent that line."
1218 nil nil state)))
1223 ;; If line does not start in string, indent it
1231 nil nil state))))))
1235 ;;; lisp-mode.el ends here