| blob | d5588f3811fb54fe54747e1004d89f5585cc7452 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006 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))
103 "define-method-combination"
127 ;; This was originally in autoload.el and is still used there.
160 ;; This might be a (doc)string or a |...| symbol.
163 ;; This is not a string, but a |...| symbol.
164 nil
172 lisp-doc-string-elt-property))))
174 ;; It's a string in a form that can have a docstring.
175 ;; Check whether it's in docstring position.
190 font-lock-doc-face
191 font-lock-string-face))))
192 font-lock-comment-face))
194 ;; The LISP-SYNTAX argument is used by code in inf-lisp.el and is
195 ;; (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
204 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
205 ;; a single docstring. Let's fix it here.
208 ;; Adaptive fill mode gets in the way of auto-fill,
209 ;; and should make no difference for explicit fill
210 ;; because lisp-fill-paragraph should do the job.
211 ;; I believe that newcomment's auto-fill code properly deals with it -stef
212 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
226 ;; Look within the line for a ; following an even number of backslashes
227 ;; after either a non-backslash or the line beginning.
230 ;; Font lock mode uses this only when it KNOWS a comment is starting.
236 ;; Don't get confused by `;' in doc strings when paragraph-filling.
245 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
249 . lisp-font-lock-syntactic-face-function))))
252 "Lisp mode `outline-level' function."
255 1000
256 len)))
263 ;; This gets in the way when viewing a Lisp file in view-mode. As
264 ;; long as [backspace] is mapped into DEL via the
265 ;; function-key-map, this should remain disabled!!
266 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
267 map)
271 "Keymap for Emacs Lisp mode.
275 ()
306 "Byte compile the file containing the current buffer."
313 "Byte-compile the current file (if it has changed), then load compiled code."
318 ;; Recompile if file or buffer has changed since last compilation.
328 "Hook run when entering Emacs Lisp mode."
334 "Hook run when entering Lisp mode."
340 "Hook run when entering Lisp Interaction mode."
346 "Major mode for editing Lisp code to run in Emacs.
347 Commands:
348 Delete converts tabs to spaces as it moves back.
349 Blank lines separate paragraphs. Semicolons start comments.
351 Entry to this mode calls the value of `emacs-lisp-mode-hook'
352 if that value is non-nil."
369 map)
370 "Keymap for ordinary Lisp mode.
374 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
375 Commands:
376 Delete converts tabs to spaces as it moves back.
377 Blank lines separate paragraphs. Semicolons start comments.
379 Note that `run-lisp' may be used either to start an inferior Lisp job
380 or to switch back to an existing one.
382 Entry to this mode calls the value of `lisp-mode-hook'
383 if that value is non-nil."
405 default))))
407 ;; Used in old LispM code.
410 ;; This will do unless inf-lisp.el is loaded.
423 map)
424 "Keymap for Lisp Interaction mode.
429 "Major mode for typing and evaluating Lisp forms.
431 before point, and prints its value into the buffer, advancing point.
432 Note that printing is controlled by `eval-expression-print-length'
433 and `eval-expression-print-level'.
435 Commands:
436 Delete converts tabs to spaces as it moves back.
437 Paragraphs are separated only by blank lines.
438 Semicolons start comments.
440 Entry to this mode calls the value of `lisp-interaction-mode-hook'
444 "Evaluate sexp before point; print value into current buffer.
446 If `eval-expression-debug-on-error' is non-nil, which is the default,
447 this command arranges for all errors to enter the debugger.
449 Note that printing the result is controlled by the variables
450 `eval-expression-print-length' and `eval-expression-print-level',
451 which see."
460 "Set up text properties for the output of `eval-last-sexp-1'.
461 BEG and END are the start and end of the output in current-buffer.
462 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
463 alternative printed representations that can be displayed."
469 beg end
471 mouse-face highlight
472 keymap ,map
473 help-echo "RET, mouse-2: toggle abbreviated display"
475 printed-value)))))
479 "Toggle between abbreviated and unabbreviated printed representations."
500 "Return a string representing CHAR as a character rather than as an integer.
501 If CHAR is not a character, return nil."
506 string)
507 ;; Prevent ?A from turning into ?\S-a.
513 ;; What string are we considering using?
517 "?"
529 ;; Verify the string reads a CHAR, not to some other character.
530 ;; If it doesn't, return nil instead.
533 string))))
537 "Evaluate sexp before point; print value in minibuffer.
538 With argument, print output into current buffer."
543 ignore-quotes
544 expr)
547 ;; If this sexp appears to be enclosed in `...'
548 ;; then ignore the surrounding quotes.
553 ;; If we were after `?\e' (or similar case),
554 ;; use the whole thing, not just the `e'.
560 ;; Skip over `#N='s.
570 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
571 ;; `variable' so that the value is returned, not the
572 ;; name
578 ;; If it's an (interactive ...) form, it's more
579 ;; useful to show how an interactive call would
580 ;; use it.
588 expr
590 expr)))))))
599 end)
611 unabbreviated
613 ))))
619 "Evaluate sexp before point; print value in minibuffer.
620 Interactively, with prefix argument, print output into current buffer.
622 If `eval-expression-debug-on-error' is non-nil, which is the default,
623 this command arranges for all errors to enter the debugger."
633 value)))
636 "Treat some expressions specially.
637 Reset the `defvar' and `defcustom' variables to the initial value.
638 Reinitialize the face according to the `defface' specification."
639 ;; The code in edebug-defun should be consistent with this, but not
640 ;; the same, since this gets a macroexpended form.
642 form)
646 ;; Force variable to be re-set.
649 ;; `defcustom' is now macroexpanded to
650 ;; `custom-declare-variable' with a quoted value arg.
653 ;; Force variable to be bound.
655 form)
656 ;; `defface' is macroexpanded to `custom-declare-face'.
658 ;; Reset the face.
662 ;; Setting `customized-face' to the new spec after calling
663 ;; the form, but preserving the old saved spec in `saved-face',
664 ;; imitates the situation when the new face spec is set
665 ;; temporarily for the current session in the customize
666 ;; buffer, thus allowing `face-user-default-spec' to use the
667 ;; new customized spec instead of the saved spec.
668 ;; Resetting `saved-face' temporarily to nil is needed to let
669 ;; `defface' change the spec, regardless of a saved spec.
681 "Evaluate defun that point is in or before.
682 The value is displayed in the minibuffer.
683 If the current defun is actually a call to `defvar',
684 then reset the variable using the initial value expression
685 even if the variable already has some other value.
686 \(Normally `defvar' does not change the variable's value
687 if it already has a value.\)
689 With argument, insert value in current buffer after the defun.
690 Return the result of evaluation."
696 ;; Arrange for eval-region to "read" the (possibly) altered form.
697 ;; eval-region handles recording which file defines a function or
698 ;; variable. Re-written using `apply' to avoid capturing
699 ;; variables like `end'.
701 #'eval-region
703 beg end form)
704 ;; Read the form from the buffer, and record where it ends.
711 ;; Alter the form if necessary.
715 ;; Skipping to the end of the specified region
716 ;; will make eval-region return.
719 ;; The result of evaluation has been put onto VALUES. So return it.
723 "Evaluate the top-level form containing point, or after point.
725 If the current defun is actually a call to `defvar' or `defcustom',
726 evaluating it this way resets the variable using its initial value
727 expression even if the variable already has some other value.
728 \(Normally `defvar' and `defcustom' do not alter the value if there
729 already is one.)
731 If `eval-expression-debug-on-error' is non-nil, which is the default,
732 this command arranges for all errors to enter the debugger.
734 With a prefix argument, instrument the code for Edebug.
736 If acting on a `defun' for FUNCTION, and the function was
737 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
738 instrumented, just FUNCTION is printed.
740 If not acting on a `defun', the result of evaluation is displayed in
741 the minibuffer. This display is controlled by the variables
742 `eval-expression-print-length' and `eval-expression-print-level',
743 which see."
757 value)))))
759 ;; May still be used by some external Lisp-mode variant.
762 ;; This function just forces a more costly detection of comments (using
763 ;; parse-partial-sexp from beginning-of-defun). I.e. It avoids the problem of
764 ;; taking a `;' inside a string started on another line for a comment starter.
765 ;; Note: `newcomment' gets it right now since we set comment-use-global-state
766 ;; so we could get rid of it. -stef
773 comment-auto-fill-only-comments)
782 "Indent current line as Lisp code.
783 With argument, indent any additional lines of the same expression
784 rigidly along with this one."
791 ;; Don't alter indentation of a ;;; comment line
792 ;; or a line that starts in a string.
795 ;; Single-semicolon comment lines should be indented
796 ;; as comment lines, not as code.
801 nil
804 ;; If initial point was within line's indentation,
805 ;; position after the indentation. Else stay at same point in text.
808 ;; If desired, shift remaining lines of expression the same amount.
823 "Return appropriate indentation for current line as Lisp code.
824 In usual case returns an integer: the column to indent to.
825 If the value is nil, that means don't change the indentation
826 because the line starts inside a string.
828 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
829 This means that following lines at the same level of indentation
830 should not necessarily be indented the same as this line.
831 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
832 is the buffer position of the start of the containing expression."
836 state paren-depth
837 ;; setting this to a number inhibits calling hook
840 calculate-lisp-indent-last-sexp containing-sexp)
844 ;; Find outermost containing sexp
847 ;; Find innermost containing sexp
849 state
854 ;; Position following last unclosed open.
856 ;; Is there a complete sexp since then?
859 ;; Yes, but is there a containing sexp after that?
864 nil
865 ;; Innermost containing sexp found
868 ;; indent-point immediately follows open paren.
869 ;; Don't call hook.
871 ;; Find the start of first element of containing sexp.
874 ;; First element of containing sexp is a list.
875 ;; Indent under that list.
876 )
878 calculate-lisp-indent-last-sexp)
879 ;; This is the first line to start within the containing sexp.
880 ;; It's almost certainly a function call.
882 ;; Containing sexp has nothing before this line
883 ;; except the first element. Indent under that element.
884 nil
885 ;; Skip the first element, find start of second (the first
886 ;; argument of the function call) and indent under.
889 calculate-lisp-indent-last-sexp
893 ;; Indent beneath first sexp on same line as
894 ;; `calculate-lisp-indent-last-sexp'. Again, it's
895 ;; almost certainly a function call.
901 ;; Point is at the point to indent under unless we are inside a string.
902 ;; Call indentation hook except when overridden by lisp-indent-offset
903 ;; or if the desired indentation has already been computed.
906 ;; Inside a string, don't change indentation.
907 nil)
909 ;; Indent by constant offset
914 lisp-indent-function
917 normal-indent))
919 normal-indent))))))
922 "This function is the normal value of the variable `lisp-indent-function'.
923 It is used when indenting a line within a function call, to see if the
924 called function says anything special about how to indent the line.
926 INDENT-POINT is the position where the user typed TAB, or equivalent.
927 Point is located at the point to indent under (for default indentation);
928 STATE is the `parse-partial-sexp' state for that position.
930 If the current line is in a call to a Lisp function
931 which has a non-nil property `lisp-indent-function',
932 that specifies how to do the indentation. The property value can be
933 * `defun', meaning indent `defun'-style;
934 * an integer N, meaning indent the first N arguments specially
935 like ordinary function arguments and then indent any further
936 arguments like a body;
937 * a function to call just as this function was called.
938 If that function returns nil, that means it doesn't specify
939 the indentation.
941 This function also returns nil meaning don't specify the indentation."
947 ;; car of form doesn't seem to be a symbol
950 calculate-lisp-indent-last-sexp))
955 ;; Indent under the list or under the first sexp on the same
956 ;; line as calculate-lisp-indent-last-sexp. Note that first
957 ;; thing on that line has to be complete sexp since we are
958 ;; inside the innermost containing sexp.
963 method)
973 indent-point normal-indent))
983 body-indent containing-form-column)
984 ;; Move to the start of containing form, calculate indentation
985 ;; to use for non-distinguished forms (> count), and move past the
986 ;; function symbol. lisp-indent-function guarantees that there is at
987 ;; least one word or symbol character following open paren of containing
988 ;; form.
994 ;; Now find the start of the last form.
1003 ;; Point is sitting on first character of last (or count) sexp.
1005 ;; A distinguished form. If it is the first or second form use double
1006 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
1007 ;; to 2 (the default), this just happens to work the same with if as
1008 ;; the older code, but it makes unwind-protect, condition-case,
1009 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
1010 ;; less hacked, behavior can be obtained by replacing below with
1011 ;; (list normal-indent containing-form-start).
1014 containing-form-start)
1016 ;; A non-distinguished form. Use body-indent if there are no
1017 ;; distinguished forms and this is the first undistinguished form,
1018 ;; or if this is the first undistinguished form and the preceding
1019 ;; distinguished form has indentation at least as great as body-indent.
1022 body-indent
1023 normal-indent))))
1034 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1035 ;; like defun if the first form is placed on the next line, otherwise
1036 ;; it is indented like any other form (i.e. forms line up under first).
1072 "Indent each line of the list starting just after point.
1073 If optional arg ENDPOS is given, indent each line, stopping when
1074 ENDPOS is encountered."
1078 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
1079 ;; so that calculate-lisp-indent will find the beginning of
1080 ;; the defun we are in.
1081 ;; If ENDPOS is nil, it is safe not to scan before point
1082 ;; since every line we indent is more deeply nested than point is.
1085 last-depth bol outer-loop-done inner-loop-done state this-indent)
1087 ;; Get error now if we don't have a complete sexp after point.
1094 inner-loop-done nil)
1095 ;; Parse this line so we can learn the state
1096 ;; to indent the next line.
1097 ;; This inner loop goes through only once
1098 ;; unless a line ends inside a string.
1102 nil nil state))
1104 ;; If the line contains a comment other than the sort
1105 ;; that is indented like code,
1106 ;; indent it now with indent-for-comment.
1107 ;; Comments indented like code are right already.
1108 ;; In any case clear the in-comment flag in the state
1109 ;; because parse-partial-sexp never sees the newlines.
1114 ;; If this line ends inside a string,
1115 ;; go straight to next line, remaining within the inner loop,
1116 ;; and turn off the \-flag.
1139 ;; Now go to the next line and indent it according
1140 ;; to what we learned from parsing the previous one.
1144 ;; But not if the line is blank, or just a comment
1145 ;; (except for double-semi comments; indent them as usual).
1147 nil
1153 starting-point))))
1169 "Indent every line whose first char is between START and END inclusive."
1179 "Indent each line of the list starting just after point, or prettyprint it.
1180 A prefix argument specifies pretty-printing."
1192 ;;;; Lisp paragraph filling commands.
1195 "Value of `fill-column' to use when filling a docstring.
1196 Any non-integer value means do not use a different value of
1197 `fill-column' when filling docstrings."
1204 If any of the current line is a comment, fill the comment or the
1205 paragraph of it that point is in, preserving the comment's indentation
1206 and initial semicolons."
1209 ;; Since fill-comment-paragraph returned nil, that means we're not in
1210 ;; a comment: Point is on a program line; we are interested
1211 ;; particularly in docstring lines.
1212 ;;
1213 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1214 ;; are buffer-local, but we avoid changing them so that they can be set
1215 ;; to make `forward-paragraph' and friends do something the user wants.
1216 ;;
1217 ;; `paragraph-start': The `(' in the character alternative and the
1218 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1219 ;; sexps and backquoted sexps that follow a docstring from being filled
1220 ;; with the docstring. This setting has the consequence of inhibiting
1221 ;; filling many program lines that are not docstrings, which is sensible,
1222 ;; because the user probably asked to fill program lines by accident, or
1223 ;; expecting indentation (perhaps we should try to do indenting in that
1224 ;; case). The `;' and `:' stop the paragraph being filled at following
1225 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1226 ;; escaped to keep font-locking, filling, & paren matching in the source
1227 ;; file happy.
1228 ;;
1229 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1230 ;; a docstring and identifies it as a paragraph separator, so that it
1231 ;; won't be filled. (Since the first line of documentation stands alone
1232 ;; in some contexts, filling should not alter the contents the author has
1233 ;; chosen.) Only the first line of a docstring begins with whitespace
1234 ;; and a quotation mark and ends with a period or (rarely) a comma.
1235 ;;
1236 ;; The `fill-column' is temporarily bound to
1237 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1243 emacs-lisp-docstring-fill-column
1244 fill-column)))
1246 ;; Never return nil.
1247 t))
1250 "Indent all lines of code, starting in the region, sideways by ARG columns.
1251 Does not affect lines starting inside comments or strings, assuming that
1252 the start of the region is not inside them.
1254 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1255 The last is a regexp which, if matched at the beginning of a line,
1256 means don't indent that line."
1267 nil nil state)))
1272 ;; If line does not start in string, indent it
1280 nil nil state))))))
1284 ;; arch-tag: 414c7f93-c245-4b77-8ed5-ed05ef7ff1bf
1285 ;;; lisp-mode.el ends here