| blob | bb815481bf005b7f445d4e63d11967de6ed7de1f |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2003, 2004, 2005
4 ;; 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., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, 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:
57 ;; Give CR the same syntax as newline, for selective-display.
64 ;; Used to be singlequote; changed for flonums.
73 table))
81 table))
94 "define-generic-mode"
97 "define-method-combination"
121 ;; This was originally in autoload.el and is still used there.
138 ;; define-global-mode has no explicit docstring.
147 ;; This might be a docstring.
160 font-lock-doc-face
161 font-lock-string-face)
162 font-lock-comment-face))
164 ;; The LISP-SYNTAX argument is used by code in inf-lisp.el and is
165 ;; (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
174 ;; Adaptive fill mode gets in the way of auto-fill,
175 ;; and should make no difference for explicit fill
176 ;; because lisp-fill-paragraph should do the job.
177 ;; I believe that newcomment's auto-fill code properly deals with it -stef
178 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
192 ;; Look within the line for a ; following an even number of backslashes
193 ;; after either a non-backslash or the line beginning.
196 ;; Font lock mode uses this only when it KNOWS a comment is starting.
202 ;; Don't get confused by `;' in doc strings when paragraph-filling.
211 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
215 . lisp-font-lock-syntactic-face-function))))
218 "Lisp mode `outline-level' function."
221 1000
222 len)))
229 ;; This gets in the way when viewing a Lisp file in view-mode. As
230 ;; long as [backspace] is mapped into DEL via the
231 ;; function-key-map, this should remain disabled!!
232 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
233 map)
237 "Keymap for Emacs Lisp mode.
241 ()
272 "Byte compile the file containing the current buffer."
279 "Byte-compile the current file (if it has changed), then load compiled code."
284 ;; Recompile if file or buffer has changed since last compilation.
294 "Hook run when entering Emacs Lisp mode."
300 "Hook run when entering Lisp mode."
306 "Hook run when entering Lisp Interaction mode."
312 "Major mode for editing Lisp code to run in Emacs.
313 Commands:
314 Delete converts tabs to spaces as it moves back.
315 Blank lines separate paragraphs. Semicolons start comments.
317 Entry to this mode calls the value of `emacs-lisp-mode-hook'
318 if that value is non-nil."
335 map)
336 "Keymap for ordinary Lisp mode.
340 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
341 Commands:
342 Delete converts tabs to spaces as it moves back.
343 Blank lines separate paragraphs. Semicolons start comments.
345 Note that `run-lisp' may be used either to start an inferior Lisp job
346 or to switch back to an existing one.
348 Entry to this mode calls the value of `lisp-mode-hook'
349 if that value is non-nil."
371 default))))
373 ;; Used in old LispM code.
376 ;; This will do unless inf-lisp.el is loaded.
389 map)
390 "Keymap for Lisp Interaction mode.
395 "Major mode for typing and evaluating Lisp forms.
397 before point, and prints its value into the buffer, advancing point.
398 Note that printing is controlled by `eval-expression-print-length'
399 and `eval-expression-print-level'.
401 Commands:
402 Delete converts tabs to spaces as it moves back.
403 Paragraphs are separated only by blank lines.
404 Semicolons start comments.
406 Entry to this mode calls the value of `lisp-interaction-mode-hook'
410 "Evaluate sexp before point; print value into current buffer.
412 Note that printing the result is controlled by the variables
413 `eval-expression-print-length' and `eval-expression-print-level',
414 which see."
423 "Set up text properties for the output of `eval-last-sexp-1'.
424 BEG and END are the start and end of the output in current-buffer.
425 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
426 alternative printed representations that can be displayed."
432 beg end
434 mouse-face highlight
435 keymap ,map
436 help-echo "RET, mouse-2: toggle abbreviated display"
438 printed-value)))))
442 "Toggle between abbreviated and unabbreviated printed representations."
463 "Return a string representing CHAR as a character rather than as an integer.
464 If CHAR is not a character, return nil."
469 string)
470 ;; Prevent ?A from turning into ?\S-a.
476 ;; What string are we considering using?
480 "?"
492 ;; Verify the string reads a CHAR, not to some other character.
493 ;; If it doesn't, return nil instead.
496 string))))
500 "Evaluate sexp before point; print value in minibuffer.
501 With argument, print output into current buffer."
506 ignore-quotes
507 expr)
510 ;; If this sexp appears to be enclosed in `...'
511 ;; then ignore the surrounding quotes.
516 ;; If we were after `?\e' (or similar case),
517 ;; use the whole thing, not just the `e'.
523 ;; Skip over `#N='s.
533 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
534 ;; `variable' so that the value is returned, not the
535 ;; name
541 ;; If it's an (interactive ...) form, it's more
542 ;; useful to show how an interactive call would
543 ;; use it.
551 expr
553 expr)))))))
562 end)
574 unabbreviated
576 ))))
582 "Evaluate sexp before point; print value in minibuffer.
583 Interactively, with prefix argument, print output into current buffer."
593 value)))
596 "Treat some expressions specially.
597 Reset the `defvar' and `defcustom' variables to the initial value.
598 Reinitialize the face according to the `defface' specification."
599 ;; The code in edebug-defun should be consistent with this, but not
600 ;; the same, since this gets a macroexpended form.
602 form)
606 ;; Force variable to be re-set.
609 ;; `defcustom' is now macroexpanded to
610 ;; `custom-declare-variable' with a quoted value arg.
613 ;; Force variable to be bound.
615 form)
616 ;; `defface' is macroexpanded to `custom-declare-face'.
618 ;; Reset the face.
622 form)
628 "Evaluate defun that point is in or before.
629 The value is displayed in the minibuffer.
630 If the current defun is actually a call to `defvar',
631 then reset the variable using the initial value expression
632 even if the variable already has some other value.
633 \(Normally `defvar' does not change the variable's value
634 if it already has a value.\)
636 With argument, insert value in current buffer after the defun.
637 Return the result of evaluation."
643 ;; Arrange for eval-region to "read" the (possibly) altered form.
644 ;; eval-region handles recording which file defines a function or
645 ;; variable. Re-written using `apply' to avoid capturing
646 ;; variables like `end'.
648 #'eval-region
650 beg end form)
651 ;; Read the form from the buffer, and record where it ends.
658 ;; Alter the form if necessary.
662 ;; Skipping to the end of the specified region
663 ;; will make eval-region return.
666 ;; The result of evaluation has been put onto VALUES. So return it.
670 "Evaluate the top-level form containing point, or after point.
672 If the current defun is actually a call to `defvar' or `defcustom',
673 evaluating it this way resets the variable using its initial value
674 expression even if the variable already has some other value.
675 \(Normally `defvar' and `defcustom' do not alter the value if there
676 already is one.)
678 With a prefix argument, instrument the code for Edebug.
680 If acting on a `defun' for FUNCTION, and the function was
681 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
682 instrumented, just FUNCTION is printed.
684 If not acting on a `defun', the result of evaluation is displayed in
685 the minibuffer. This display is controlled by the variables
686 `eval-expression-print-length' and `eval-expression-print-level',
687 which see."
701 value)))))
702 \f
712 comment-column))))
714 ;; This function just forces a more costly detection of comments (using
715 ;; parse-partial-sexp from beginning-of-defun). I.e. It avoids the problem of
716 ;; taking a `;' inside a string started on another line for a comment starter.
717 ;; Note: `newcomment' gets it right now since we set comment-use-global-state
718 ;; so we could get rid of it. -stef
725 comment-auto-fill-only-comments)
734 "Indent current line as Lisp code.
735 With argument, indent any additional lines of the same expression
736 rigidly along with this one."
743 ;; Don't alter indentation of a ;;; comment line
744 ;; or a line that starts in a string.
747 ;; Single-semicolon comment lines should be indented
748 ;; as comment lines, not as code.
753 nil
756 ;; If initial point was within line's indentation,
757 ;; position after the indentation. Else stay at same point in text.
760 ;; If desired, shift remaining lines of expression the same amount.
775 "Return appropriate indentation for current line as Lisp code.
776 In usual case returns an integer: the column to indent to.
777 If the value is nil, that means don't change the indentation
778 because the line starts inside a string.
780 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
781 This means that following lines at the same level of indentation
782 should not necessarily be indented the same as this line.
783 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
784 is the buffer position of the start of the containing expression."
788 state paren-depth
789 ;; setting this to a number inhibits calling hook
792 calculate-lisp-indent-last-sexp containing-sexp)
796 ;; Find outermost containing sexp
799 ;; Find innermost containing sexp
801 state
806 ;; Position following last unclosed open.
808 ;; Is there a complete sexp since then?
811 ;; Yes, but is there a containing sexp after that?
816 nil
817 ;; Innermost containing sexp found
820 ;; indent-point immediately follows open paren.
821 ;; Don't call hook.
823 ;; Find the start of first element of containing sexp.
826 ;; First element of containing sexp is a list.
827 ;; Indent under that list.
828 )
830 calculate-lisp-indent-last-sexp)
831 ;; This is the first line to start within the containing sexp.
832 ;; It's almost certainly a function call.
834 ;; Containing sexp has nothing before this line
835 ;; except the first element. Indent under that element.
836 nil
837 ;; Skip the first element, find start of second (the first
838 ;; argument of the function call) and indent under.
841 calculate-lisp-indent-last-sexp
845 ;; Indent beneath first sexp on same line as
846 ;; `calculate-lisp-indent-last-sexp'. Again, it's
847 ;; almost certainly a function call.
853 ;; Point is at the point to indent under unless we are inside a string.
854 ;; Call indentation hook except when overridden by lisp-indent-offset
855 ;; or if the desired indentation has already been computed.
858 ;; Inside a string, don't change indentation.
859 nil)
861 ;; Indent by constant offset
866 lisp-indent-function
869 normal-indent))
871 normal-indent))))))
874 "This function is the normal value of the variable `lisp-indent-function'.
875 It is used when indenting a line within a function call, to see if the
876 called function says anything special about how to indent the line.
878 INDENT-POINT is the position where the user typed TAB, or equivalent.
879 Point is located at the point to indent under (for default indentation);
880 STATE is the `parse-partial-sexp' state for that position.
882 If the current line is in a call to a Lisp function
883 which has a non-nil property `lisp-indent-function',
884 that specifies how to do the indentation. The property value can be
885 * `defun', meaning indent `defun'-style;
886 * an integer N, meaning indent the first N arguments specially
887 like ordinary function arguments and then indent any further
888 arguments like a body;
889 * a function to call just as this function was called.
890 If that function returns nil, that means it doesn't specify
891 the indentation.
893 This function also returns nil meaning don't specify the indentation."
899 ;; car of form doesn't seem to be a symbol
902 calculate-lisp-indent-last-sexp))
907 ;; Indent under the list or under the first sexp on the same
908 ;; line as calculate-lisp-indent-last-sexp. Note that first
909 ;; thing on that line has to be complete sexp since we are
910 ;; inside the innermost containing sexp.
915 method)
925 indent-point normal-indent))
935 body-indent containing-form-column)
936 ;; Move to the start of containing form, calculate indentation
937 ;; to use for non-distinguished forms (> count), and move past the
938 ;; function symbol. lisp-indent-function guarantees that there is at
939 ;; least one word or symbol character following open paren of containing
940 ;; form.
946 ;; Now find the start of the last form.
955 ;; Point is sitting on first character of last (or count) sexp.
957 ;; A distinguished form. If it is the first or second form use double
958 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
959 ;; to 2 (the default), this just happens to work the same with if as
960 ;; the older code, but it makes unwind-protect, condition-case,
961 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
962 ;; less hacked, behavior can be obtained by replacing below with
963 ;; (list normal-indent containing-form-start).
966 containing-form-start)
968 ;; A non-distinguished form. Use body-indent if there are no
969 ;; distinguished forms and this is the first undistinguished form,
970 ;; or if this is the first undistinguished form and the preceding
971 ;; distinguished form has indentation at least as great as body-indent.
974 body-indent
975 normal-indent))))
986 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
987 ;; like defun if the first form is placed on the next line, otherwise
988 ;; 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.
1091 ;; Now go to the next line and indent it according
1092 ;; to what we learned from parsing the previous one.
1096 ;; But not if the line is blank, or just a comment
1097 ;; (except for double-semi comments; indent them as usual).
1099 nil
1105 starting-point))))
1121 "Indent every line whose first char is between START and END inclusive."
1131 "Indent each line of the list starting just after point, or prettyprint it.
1132 A prefix argument specifies pretty-printing."
1144 ;;;; Lisp paragraph filling commands.
1147 "Value of `fill-column' to use when filling a docstring.
1148 Any non-integer value means do not use a different value of
1149 `fill-column' when filling docstrings."
1156 If any of the current line is a comment, fill the comment or the
1157 paragraph of it that point is in, preserving the comment's indentation
1158 and initial semicolons."
1161 ;; Since fill-comment-paragraph returned nil, that means we're not in
1162 ;; a comment: Point is on a program line; we are interested
1163 ;; particularly in docstring lines.
1164 ;;
1165 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1166 ;; are buffer-local, but we avoid changing them so that they can be set
1167 ;; to make `forward-paragraph' and friends do something the user wants.
1168 ;;
1169 ;; `paragraph-start': The `(' in the character alternative and the
1170 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1171 ;; sexps and backquoted sexps that follow a docstring from being filled
1172 ;; with the docstring. This setting has the consequence of inhibiting
1173 ;; filling many program lines that are not docstrings, which is sensible,
1174 ;; because the user probably asked to fill program lines by accident, or
1175 ;; expecting indentation (perhaps we should try to do indenting in that
1176 ;; case). The `;' and `:' stop the paragraph being filled at following
1177 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1178 ;; escaped to keep font-locking, filling, & paren matching in the source
1179 ;; file happy.
1180 ;;
1181 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1182 ;; a docstring and identifies it as a paragraph separator, so that it
1183 ;; won't be filled. (Since the first line of documentation stands alone
1184 ;; in some contexts, filling should not alter the contents the author has
1185 ;; chosen.) Only the first line of a docstring begins with whitespace
1186 ;; and a quotation mark and ends with a period or (rarely) a comma.
1187 ;;
1188 ;; The `fill-column' is temporarily bound to
1189 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1195 emacs-lisp-docstring-fill-column
1196 fill-column)))
1198 ;; Never return nil.
1199 t))
1202 "Indent all lines of code, starting in the region, sideways by ARG columns.
1203 Does not affect lines starting inside comments or strings, assuming that
1204 the start of the region is not inside them.
1206 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1207 The last is a regexp which, if matched at the beginning of a line,
1208 means don't indent that line."
1219 nil nil state)))
1224 ;; If line does not start in string, indent it
1232 nil nil state))))))
1236 ;; arch-tag: 414c7f93-c245-4b77-8ed5-ed05ef7ff1bf
1237 ;;; lisp-mode.el ends here