| blob | 55c91bb6faf8c7cccb31d359ef87dfbba8dba8e4 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: lisp, languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; 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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
29 ;; This mode is documented in the Emacs manual.
31 ;;; Code:
62 ;; This is probably obsolete since nowadays such features use overlays.
63 ;; ;; Give CR the same syntax as newline, for selective-display.
64 ;; (modify-syntax-entry ?\^m "> " table)
70 ;; Used to be singlequote; changed for flonums.
79 table))
87 table))
100 "define-generic-mode"
103 "define-method-combination"
127 ;; This was originally in autoload.el and is still used there.
158 ;; This might be a (doc)string or a |...| symbol.
161 ;; This is not a string, but a |...| symbol.
162 nil
170 lisp-doc-string-elt-property))))
172 ;; It's a string in a form that can have a docstring.
173 ;; Check whether it's in docstring position.
188 font-lock-doc-face
189 font-lock-string-face))))
190 font-lock-comment-face))
192 ;; The LISP-SYNTAX argument is used by code in inf-lisp.el and is
193 ;; (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
202 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
203 ;; a single docstring. Let's fix it here.
206 ;; Adaptive fill mode gets in the way of auto-fill,
207 ;; and should make no difference for explicit fill
208 ;; because lisp-fill-paragraph should do the job.
209 ;; I believe that newcomment's auto-fill code properly deals with it -stef
210 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
224 ;; Look within the line for a ; following an even number of backslashes
225 ;; after either a non-backslash or the line beginning.
228 ;; Font lock mode uses this only when it KNOWS a comment is starting.
234 ;; Don't get confused by `;' in doc strings when paragraph-filling.
243 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
247 . lisp-font-lock-syntactic-face-function))))
250 "Lisp mode `outline-level' function."
253 1000
254 len)))
261 ;; This gets in the way when viewing a Lisp file in view-mode. As
262 ;; long as [backspace] is mapped into DEL via the
263 ;; function-key-map, this should remain disabled!!
264 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
265 map)
269 "Keymap for Emacs Lisp mode.
273 ()
304 "Byte compile the file containing the current buffer."
311 "Byte-compile the current file (if it has changed), then load compiled code."
316 ;; Recompile if file or buffer has changed since last compilation.
326 "Hook run when entering Emacs Lisp mode."
332 "Hook run when entering Lisp mode."
338 "Hook run when entering Lisp Interaction mode."
344 "Major mode for editing Lisp code to run in Emacs.
345 Commands:
346 Delete converts tabs to spaces as it moves back.
347 Blank lines separate paragraphs. Semicolons start comments.
349 Entry to this mode calls the value of `emacs-lisp-mode-hook'
350 if that value is non-nil."
367 map)
368 "Keymap for ordinary Lisp mode.
372 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
373 Commands:
374 Delete converts tabs to spaces as it moves back.
375 Blank lines separate paragraphs. Semicolons start comments.
377 Note that `run-lisp' may be used either to start an inferior Lisp job
378 or to switch back to an existing one.
380 Entry to this mode calls the value of `lisp-mode-hook'
381 if that value is non-nil."
403 default))))
405 ;; Used in old LispM code.
408 ;; This will do unless inf-lisp.el is loaded.
421 map)
422 "Keymap for Lisp Interaction mode.
427 "Major mode for typing and evaluating Lisp forms.
429 before point, and prints its value into the buffer, advancing point.
430 Note that printing is controlled by `eval-expression-print-length'
431 and `eval-expression-print-level'.
433 Commands:
434 Delete converts tabs to spaces as it moves back.
435 Paragraphs are separated only by blank lines.
436 Semicolons start comments.
438 Entry to this mode calls the value of `lisp-interaction-mode-hook'
442 "Evaluate sexp before point; print value into current buffer.
444 Note that printing the result is controlled by the variables
445 `eval-expression-print-length' and `eval-expression-print-level',
446 which see."
455 "Set up text properties for the output of `eval-last-sexp-1'.
456 BEG and END are the start and end of the output in current-buffer.
457 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
458 alternative printed representations that can be displayed."
464 beg end
466 mouse-face highlight
467 keymap ,map
468 help-echo "RET, mouse-2: toggle abbreviated display"
470 printed-value)))))
474 "Toggle between abbreviated and unabbreviated printed representations."
495 "Return a string representing CHAR as a character rather than as an integer.
496 If CHAR is not a character, return nil."
501 string)
502 ;; Prevent ?A from turning into ?\S-a.
508 ;; What string are we considering using?
512 "?"
524 ;; Verify the string reads a CHAR, not to some other character.
525 ;; If it doesn't, return nil instead.
528 string))))
532 "Evaluate sexp before point; print value in minibuffer.
533 With argument, print output into current buffer."
538 ignore-quotes
539 expr)
542 ;; If this sexp appears to be enclosed in `...'
543 ;; then ignore the surrounding quotes.
548 ;; If we were after `?\e' (or similar case),
549 ;; use the whole thing, not just the `e'.
555 ;; Skip over `#N='s.
565 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
566 ;; `variable' so that the value is returned, not the
567 ;; name
573 ;; If it's an (interactive ...) form, it's more
574 ;; useful to show how an interactive call would
575 ;; use it.
583 expr
585 expr)))))))
594 end)
606 unabbreviated
608 ))))
614 "Evaluate sexp before point; print value in minibuffer.
615 Interactively, with prefix argument, print output into current buffer."
625 value)))
628 "Treat some expressions specially.
629 Reset the `defvar' and `defcustom' variables to the initial value.
630 Reinitialize the face according to the `defface' specification."
631 ;; The code in edebug-defun should be consistent with this, but not
632 ;; the same, since this gets a macroexpended form.
634 form)
638 ;; Force variable to be re-set.
641 ;; `defcustom' is now macroexpanded to
642 ;; `custom-declare-variable' with a quoted value arg.
645 ;; Force variable to be bound.
647 form)
648 ;; `defface' is macroexpanded to `custom-declare-face'.
650 ;; Reset the face.
654 ;; Setting `customized-face' to the new spec after calling
655 ;; the form, but preserving the old saved spec in `saved-face',
656 ;; imitates the situation when the new face spec is set
657 ;; temporarily for the current session in the customize
658 ;; buffer, thus allowing `face-user-default-spec' to use the
659 ;; new customized spec instead of the saved spec.
660 ;; Resetting `saved-face' temporarily to nil is needed to let
661 ;; `defface' change the spec, regardless of a saved spec.
673 "Evaluate defun that point is in or before.
674 The value is displayed in the minibuffer.
675 If the current defun is actually a call to `defvar',
676 then reset the variable using the initial value expression
677 even if the variable already has some other value.
678 \(Normally `defvar' does not change the variable's value
679 if it already has a value.\)
681 With argument, insert value in current buffer after the defun.
682 Return the result of evaluation."
688 ;; Arrange for eval-region to "read" the (possibly) altered form.
689 ;; eval-region handles recording which file defines a function or
690 ;; variable. Re-written using `apply' to avoid capturing
691 ;; variables like `end'.
693 #'eval-region
695 beg end form)
696 ;; Read the form from the buffer, and record where it ends.
703 ;; Alter the form if necessary.
707 ;; Skipping to the end of the specified region
708 ;; will make eval-region return.
711 ;; The result of evaluation has been put onto VALUES. So return it.
715 "Evaluate the top-level form containing point, or after point.
717 If the current defun is actually a call to `defvar' or `defcustom',
718 evaluating it this way resets the variable using its initial value
719 expression even if the variable already has some other value.
720 \(Normally `defvar' and `defcustom' do not alter the value if there
721 already is one.)
723 With a prefix argument, instrument the code for Edebug.
725 If acting on a `defun' for FUNCTION, and the function was
726 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
727 instrumented, just FUNCTION is printed.
729 If not acting on a `defun', the result of evaluation is displayed in
730 the minibuffer. This display is controlled by the variables
731 `eval-expression-print-length' and `eval-expression-print-level',
732 which see."
746 value)))))
748 ;; May still be used by some external Lisp-mode variant.
751 ;; This function just forces a more costly detection of comments (using
752 ;; parse-partial-sexp from beginning-of-defun). I.e. It avoids the problem of
753 ;; taking a `;' inside a string started on another line for a comment starter.
754 ;; Note: `newcomment' gets it right now since we set comment-use-global-state
755 ;; so we could get rid of it. -stef
762 comment-auto-fill-only-comments)
771 "Indent current line as Lisp code.
772 With argument, indent any additional lines of the same expression
773 rigidly along with this one."
780 ;; Don't alter indentation of a ;;; comment line
781 ;; or a line that starts in a string.
784 ;; Single-semicolon comment lines should be indented
785 ;; as comment lines, not as code.
790 nil
793 ;; If initial point was within line's indentation,
794 ;; position after the indentation. Else stay at same point in text.
797 ;; If desired, shift remaining lines of expression the same amount.
812 "Return appropriate indentation for current line as Lisp code.
813 In usual case returns an integer: the column to indent to.
814 If the value is nil, that means don't change the indentation
815 because the line starts inside a string.
817 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
818 This means that following lines at the same level of indentation
819 should not necessarily be indented the same as this line.
820 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
821 is the buffer position of the start of the containing expression."
825 state paren-depth
826 ;; setting this to a number inhibits calling hook
829 calculate-lisp-indent-last-sexp containing-sexp)
833 ;; Find outermost containing sexp
836 ;; Find innermost containing sexp
838 state
843 ;; Position following last unclosed open.
845 ;; Is there a complete sexp since then?
848 ;; Yes, but is there a containing sexp after that?
853 nil
854 ;; Innermost containing sexp found
857 ;; indent-point immediately follows open paren.
858 ;; Don't call hook.
860 ;; Find the start of first element of containing sexp.
863 ;; First element of containing sexp is a list.
864 ;; Indent under that list.
865 )
867 calculate-lisp-indent-last-sexp)
868 ;; This is the first line to start within the containing sexp.
869 ;; It's almost certainly a function call.
871 ;; Containing sexp has nothing before this line
872 ;; except the first element. Indent under that element.
873 nil
874 ;; Skip the first element, find start of second (the first
875 ;; argument of the function call) and indent under.
878 calculate-lisp-indent-last-sexp
882 ;; Indent beneath first sexp on same line as
883 ;; `calculate-lisp-indent-last-sexp'. Again, it's
884 ;; almost certainly a function call.
890 ;; Point is at the point to indent under unless we are inside a string.
891 ;; Call indentation hook except when overridden by lisp-indent-offset
892 ;; or if the desired indentation has already been computed.
895 ;; Inside a string, don't change indentation.
896 nil)
898 ;; Indent by constant offset
903 lisp-indent-function
906 normal-indent))
908 normal-indent))))))
911 "This function is the normal value of the variable `lisp-indent-function'.
912 It is used when indenting a line within a function call, to see if the
913 called function says anything special about how to indent the line.
915 INDENT-POINT is the position where the user typed TAB, or equivalent.
916 Point is located at the point to indent under (for default indentation);
917 STATE is the `parse-partial-sexp' state for that position.
919 If the current line is in a call to a Lisp function
920 which has a non-nil property `lisp-indent-function',
921 that specifies how to do the indentation. The property value can be
922 * `defun', meaning indent `defun'-style;
923 * an integer N, meaning indent the first N arguments specially
924 like ordinary function arguments and then indent any further
925 arguments like a body;
926 * a function to call just as this function was called.
927 If that function returns nil, that means it doesn't specify
928 the indentation.
930 This function also returns nil meaning don't specify the indentation."
936 ;; car of form doesn't seem to be a symbol
939 calculate-lisp-indent-last-sexp))
944 ;; Indent under the list or under the first sexp on the same
945 ;; line as calculate-lisp-indent-last-sexp. Note that first
946 ;; thing on that line has to be complete sexp since we are
947 ;; inside the innermost containing sexp.
952 method)
962 indent-point normal-indent))
972 body-indent containing-form-column)
973 ;; Move to the start of containing form, calculate indentation
974 ;; to use for non-distinguished forms (> count), and move past the
975 ;; function symbol. lisp-indent-function guarantees that there is at
976 ;; least one word or symbol character following open paren of containing
977 ;; form.
983 ;; Now find the start of the last form.
992 ;; Point is sitting on first character of last (or count) sexp.
994 ;; A distinguished form. If it is the first or second form use double
995 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
996 ;; to 2 (the default), this just happens to work the same with if as
997 ;; the older code, but it makes unwind-protect, condition-case,
998 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
999 ;; less hacked, behavior can be obtained by replacing below with
1000 ;; (list normal-indent containing-form-start).
1003 containing-form-start)
1005 ;; A non-distinguished form. Use body-indent if there are no
1006 ;; distinguished forms and this is the first undistinguished form,
1007 ;; or if this is the first undistinguished form and the preceding
1008 ;; distinguished form has indentation at least as great as body-indent.
1011 body-indent
1012 normal-indent))))
1023 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1024 ;; like defun if the first form is placed on the next line, otherwise
1025 ;; it is indented like any other form (i.e. forms line up under first).
1061 "Indent each line of the list starting just after point.
1062 If optional arg ENDPOS is given, indent each line, stopping when
1063 ENDPOS is encountered."
1067 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
1068 ;; so that calculate-lisp-indent will find the beginning of
1069 ;; the defun we are in.
1070 ;; If ENDPOS is nil, it is safe not to scan before point
1071 ;; since every line we indent is more deeply nested than point is.
1074 last-depth bol outer-loop-done inner-loop-done state this-indent)
1076 ;; Get error now if we don't have a complete sexp after point.
1083 inner-loop-done nil)
1084 ;; Parse this line so we can learn the state
1085 ;; to indent the next line.
1086 ;; This inner loop goes through only once
1087 ;; unless a line ends inside a string.
1091 nil nil state))
1093 ;; If the line contains a comment other than the sort
1094 ;; that is indented like code,
1095 ;; indent it now with indent-for-comment.
1096 ;; Comments indented like code are right already.
1097 ;; In any case clear the in-comment flag in the state
1098 ;; because parse-partial-sexp never sees the newlines.
1103 ;; If this line ends inside a string,
1104 ;; go straight to next line, remaining within the inner loop,
1105 ;; and turn off the \-flag.
1128 ;; Now go to the next line and indent it according
1129 ;; to what we learned from parsing the previous one.
1133 ;; But not if the line is blank, or just a comment
1134 ;; (except for double-semi comments; indent them as usual).
1136 nil
1142 starting-point))))
1158 "Indent every line whose first char is between START and END inclusive."
1168 "Indent each line of the list starting just after point, or prettyprint it.
1169 A prefix argument specifies pretty-printing."
1181 ;;;; Lisp paragraph filling commands.
1184 "Value of `fill-column' to use when filling a docstring.
1185 Any non-integer value means do not use a different value of
1186 `fill-column' when filling docstrings."
1193 If any of the current line is a comment, fill the comment or the
1194 paragraph of it that point is in, preserving the comment's indentation
1195 and initial semicolons."
1198 ;; Since fill-comment-paragraph returned nil, that means we're not in
1199 ;; a comment: Point is on a program line; we are interested
1200 ;; particularly in docstring lines.
1201 ;;
1202 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1203 ;; are buffer-local, but we avoid changing them so that they can be set
1204 ;; to make `forward-paragraph' and friends do something the user wants.
1205 ;;
1206 ;; `paragraph-start': The `(' in the character alternative and the
1207 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1208 ;; sexps and backquoted sexps that follow a docstring from being filled
1209 ;; with the docstring. This setting has the consequence of inhibiting
1210 ;; filling many program lines that are not docstrings, which is sensible,
1211 ;; because the user probably asked to fill program lines by accident, or
1212 ;; expecting indentation (perhaps we should try to do indenting in that
1213 ;; case). The `;' and `:' stop the paragraph being filled at following
1214 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1215 ;; escaped to keep font-locking, filling, & paren matching in the source
1216 ;; file happy.
1217 ;;
1218 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1219 ;; a docstring and identifies it as a paragraph separator, so that it
1220 ;; won't be filled. (Since the first line of documentation stands alone
1221 ;; in some contexts, filling should not alter the contents the author has
1222 ;; chosen.) Only the first line of a docstring begins with whitespace
1223 ;; and a quotation mark and ends with a period or (rarely) a comma.
1224 ;;
1225 ;; The `fill-column' is temporarily bound to
1226 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1232 emacs-lisp-docstring-fill-column
1233 fill-column)))
1235 ;; Never return nil.
1236 t))
1239 "Indent all lines of code, starting in the region, sideways by ARG columns.
1240 Does not affect lines starting inside comments or strings, assuming that
1241 the start of the region is not inside them.
1243 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1244 The last is a regexp which, if matched at the beginning of a line,
1245 means don't indent that line."
1256 nil nil state)))
1261 ;; If line does not start in string, indent it
1269 nil nil state))))))
1273 ;; arch-tag: 414c7f93-c245-4b77-8ed5-ed05ef7ff1bf
1274 ;;; lisp-mode.el ends here