| blob | 04d00a2bdb5791a04e55e71ae7cc78e2d829547c |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: lisp, languages
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
28 ;; This mode is documented in the Emacs manual.
30 ;;; Code:
56 ;; Give CR the same syntax as newline, for selective-display.
63 ;; Used to be singlequote; changed for flonums.
72 table))
80 table))
95 "define-method-combination"
119 ;; This was originally in autoload.el and is still used there.
135 ;; define-global-mode has no explicit docstring.
144 ;; This might be a docstring.
157 font-lock-doc-face
158 font-lock-string-face)
159 font-lock-comment-face))
161 ;; The LISP-SYNTAX argument is used by code in inf-lisp.el and is
162 ;; (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
171 ;; Adaptive fill mode gets in the way of auto-fill,
172 ;; and should make no difference for explicit fill
173 ;; because lisp-fill-paragraph should do the job.
174 ;; I believe that newcomment's auto-fill code properly deals with it -stef
175 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
191 ;; Look within the line for a ; following an even number of backslashes
192 ;; after either a non-backslash or the line beginning.
207 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
211 . lisp-font-lock-syntactic-face-function))))
214 "Lisp mode `outline-level' function."
216 1000
226 ;; This gets in the way when viewing a Lisp file in view-mode. As
227 ;; long as [backspace] is mapped into DEL via the
228 ;; function-key-map, this should remain disabled!!
229 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
230 map)
234 "Keymap for Emacs Lisp mode.
238 ()
268 "Byte compile the file containing the current buffer."
275 "Byte-compile the current file (if it has changed), then load compiled code."
280 ;; Recompile if file or buffer has changed since last compilation.
290 "Hook run when entering Emacs Lisp mode."
296 "Hook run when entering Lisp mode."
302 "Hook run when entering Lisp Interaction mode."
308 "Major mode for editing Lisp code to run in Emacs.
309 Commands:
310 Delete converts tabs to spaces as it moves back.
311 Blank lines separate paragraphs. Semicolons start comments.
313 Entry to this mode calls the value of `emacs-lisp-mode-hook'
314 if that value is non-nil."
331 map)
332 "Keymap for ordinary Lisp mode.
336 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
337 Commands:
338 Delete converts tabs to spaces as it moves back.
339 Blank lines separate paragraphs. Semicolons start comments.
341 Note that `run-lisp' may be used either to start an inferior Lisp job
342 or to switch back to an existing one.
344 Entry to this mode calls the value of `lisp-mode-hook'
345 if that value is non-nil."
361 ;; Used in old LispM code.
364 ;; This will do unless inf-lisp.el is loaded.
376 map)
377 "Keymap for Lisp Interaction mode.
382 "Major mode for typing and evaluating Lisp forms.
384 before point, and prints its value into the buffer, advancing point.
385 Note that printing is controlled by `eval-expression-print-length'
386 and `eval-expression-print-level'.
388 Commands:
389 Delete converts tabs to spaces as it moves back.
390 Paragraphs are separated only by blank lines.
391 Semicolons start comments.
393 Entry to this mode calls the value of `lisp-interaction-mode-hook'
397 "Evaluate sexp before point; print value into current buffer.
399 Note that printing the result is controlled by the variables
400 `eval-expression-print-length' and `eval-expression-print-level',
401 which see."
410 "Set up text properties for the output of `eval-last-sexp-1'.
411 BEG and END are the start and end of the output in current-buffer.
412 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
413 alternative printed representations that can be displayed."
419 beg end
421 mouse-face highlight
422 keymap ,map
423 help-echo "RET, mouse-2: toggle abbreviated display"
425 printed-value)))))
429 "Toggle between abbreviated and unabbreviated printed representations."
450 "Return a string representing CHAR as a character rather than as an integer.
451 If CHAR is not a character, return nil."
455 "?"
464 "Evaluate sexp before point; print value in minibuffer.
465 With argument, print output into current buffer."
470 ignore-quotes
471 expr)
474 ;; If this sexp appears to be enclosed in `...'
475 ;; then ignore the surrounding quotes.
480 ;; If we were after `?\e' (or similar case),
481 ;; use the whole thing, not just the `e'.
487 ;; Skip over `#N='s.
497 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
498 ;; `variable' so that the value is returned, not the
499 ;; name
505 ;; If it's an (interactive ...) form, it's more
506 ;; useful to show how an interactive call would
507 ;; use it.
515 expr
517 expr)))))))
527 end)
539 unabbreviated
541 ))))
545 "Evaluate sexp before point; print value in minibuffer.
546 Interactively, with prefix argument, print output into current buffer."
556 value)))
559 "Change defvar into defconst within FORM.
560 Likewise for other constructs as necessary."
561 ;; The code in edebug-defun should be consistent with this, but not
562 ;; the same, since this gets a macroexpended form.
564 form)
568 ;; Force variable to be re-set.
571 ;; `defcustom' is now macroexpanded to
572 ;; `custom-declare-variable' with a quoted value arg.
575 ;; Force variable to be bound.
577 form)
583 "Evaluate defun that point is in or before.
584 The value is displayed in the minibuffer.
585 If the current defun is actually a call to `defvar',
586 then reset the variable using the initial value expression
587 even if the variable already has some other value.
588 \(Normally `defvar' does not change the variable's value
589 if it already has a value.\)
591 With argument, insert value in current buffer after the defun.
592 Return the result of evaluation."
598 ;; Arrange for eval-region to "read" the (possibly) altered form.
599 ;; eval-region handles recording which file defines a function or
600 ;; variable. Re-written using `apply' to avoid capturing
601 ;; variables like `end'.
603 #'eval-region
605 beg end form)
606 ;; Read the form from the buffer, and record where it ends.
613 ;; Alter the form if necessary, changing defvar into defconst, etc.
617 ;; Skipping to the end of the specified region
618 ;; will make eval-region return.
621 ;; The result of evaluation has been put onto VALUES. So return it.
625 "Evaluate the top-level form containing point, or after point.
627 If the current defun is actually a call to `defvar' or `defcustom',
628 evaluating it this way resets the variable using its initial value
629 expression even if the variable already has some other value.
630 \(Normally `defvar' and `defcustom' do not alter the value if there
631 already is one.)
633 With a prefix argument, instrument the code for Edebug.
635 If acting on a `defun' for FUNCTION, and the function was
636 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
637 instrumented, just FUNCTION is printed.
639 If not acting on a `defun', the result of evaluation is displayed in
640 the minibuffer. This display is controlled by the variables
641 `eval-expression-print-length' and `eval-expression-print-level',
642 which see."
656 value)))))
657 \f
667 comment-column))))
669 ;; This function just forces a more costly detection of comments (using
670 ;; parse-partial-sexp from beginning-of-defun). I.e. It avoids the problem of
671 ;; taking a `;' inside a string started on another line for a comment starter.
672 ;; Note: `newcomment' gets it right in 99% of the cases if you're using
673 ;; font-lock, anyway, so we could get rid of it. -stef
680 comment-auto-fill-only-comments)
689 "Indent current line as Lisp code.
690 With argument, indent any additional lines of the same expression
691 rigidly along with this one."
698 ;; Don't alter indentation of a ;;; comment line
699 ;; or a line that starts in a string.
702 ;; Single-semicolon comment lines should be indented
703 ;; as comment lines, not as code.
708 nil
711 ;; If initial point was within line's indentation,
712 ;; position after the indentation. Else stay at same point in text.
715 ;; If desired, shift remaining lines of expression the same amount.
730 "Return appropriate indentation for current line as Lisp code.
731 In usual case returns an integer: the column to indent to.
732 If the value is nil, that means don't change the indentation
733 because the line starts inside a string.
735 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
736 This means that following lines at the same level of indentation
737 should not necessarily be indented the same as this line.
738 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
739 is the buffer position of the start of the containing expression."
743 state paren-depth
744 ;; setting this to a number inhibits calling hook
747 calculate-lisp-indent-last-sexp containing-sexp)
751 ;; Find outermost containing sexp
754 ;; Find innermost containing sexp
756 state
761 ;; Position following last unclosed open.
763 ;; Is there a complete sexp since then?
766 ;; Yes, but is there a containing sexp after that?
771 nil
772 ;; Innermost containing sexp found
775 ;; indent-point immediately follows open paren.
776 ;; Don't call hook.
778 ;; Find the start of first element of containing sexp.
781 ;; First element of containing sexp is a list.
782 ;; Indent under that list.
783 )
785 calculate-lisp-indent-last-sexp)
786 ;; This is the first line to start within the containing sexp.
787 ;; It's almost certainly a function call.
789 ;; Containing sexp has nothing before this line
790 ;; except the first element. Indent under that element.
791 nil
792 ;; Skip the first element, find start of second (the first
793 ;; argument of the function call) and indent under.
796 calculate-lisp-indent-last-sexp
800 ;; Indent beneath first sexp on same line as
801 ;; `calculate-lisp-indent-last-sexp'. Again, it's
802 ;; almost certainly a function call.
808 ;; Point is at the point to indent under unless we are inside a string.
809 ;; Call indentation hook except when overridden by lisp-indent-offset
810 ;; or if the desired indentation has already been computed.
813 ;; Inside a string, don't change indentation.
814 nil)
816 ;; Indent by constant offset
821 lisp-indent-function
824 normal-indent))
826 normal-indent))))))
829 "This function is the normal value of the variable `lisp-indent-function'.
830 It is used when indenting a line within a function call, to see if the
831 called function says anything special about how to indent the line.
833 INDENT-POINT is the position where the user typed TAB, or equivalent.
834 Point is located at the point to indent under (for default indentation);
835 STATE is the `parse-partial-sexp' state for that position.
837 If the current line is in a call to a Lisp function
838 which has a non-nil property `lisp-indent-function',
839 that specifies how to do the indentation. The property value can be
840 * `defun', meaning indent `defun'-style;
841 * an integer N, meaning indent the first N arguments specially
842 like ordinary function arguments and then indent any further
843 aruments like a body;
844 * a function to call just as this function was called.
845 If that function returns nil, that means it doesn't specify
846 the indentation.
848 This function also returns nil meaning don't specify the indentation."
854 ;; car of form doesn't seem to be a symbol
857 calculate-lisp-indent-last-sexp))
862 ;; Indent under the list or under the first sexp on the same
863 ;; line as calculate-lisp-indent-last-sexp. Note that first
864 ;; thing on that line has to be complete sexp since we are
865 ;; inside the innermost containing sexp.
870 method)
880 indent-point normal-indent))
890 body-indent containing-form-column)
891 ;; Move to the start of containing form, calculate indentation
892 ;; to use for non-distinguished forms (> count), and move past the
893 ;; function symbol. lisp-indent-function guarantees that there is at
894 ;; least one word or symbol character following open paren of containing
895 ;; form.
901 ;; Now find the start of the last form.
910 ;; Point is sitting on first character of last (or count) sexp.
912 ;; A distinguished form. If it is the first or second form use double
913 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
914 ;; to 2 (the default), this just happens to work the same with if as
915 ;; the older code, but it makes unwind-protect, condition-case,
916 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
917 ;; less hacked, behavior can be obtained by replacing below with
918 ;; (list normal-indent containing-form-start).
921 containing-form-start)
923 ;; A non-distinguished form. Use body-indent if there are no
924 ;; distinguished forms and this is the first undistinguished form,
925 ;; or if this is the first undistinguished form and the preceding
926 ;; distinguished form has indentation at least as great as body-indent.
929 body-indent
930 normal-indent))))
941 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
942 ;; like defun if the first form is placed on the next line, otherwise
943 ;; it is indented like any other form (i.e. forms line up under first).
979 "Indent each line of the list starting just after point.
980 If optional arg ENDPOS is given, indent each line, stopping when
981 ENDPOS is encountered."
985 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
986 ;; so that calculate-lisp-indent will find the beginning of
987 ;; the defun we are in.
988 ;; If ENDPOS is nil, it is safe not to scan before point
989 ;; since every line we indent is more deeply nested than point is.
992 last-depth bol outer-loop-done inner-loop-done state this-indent)
994 ;; Get error now if we don't have a complete sexp after point.
1001 inner-loop-done nil)
1002 ;; Parse this line so we can learn the state
1003 ;; to indent the next line.
1004 ;; This inner loop goes through only once
1005 ;; unless a line ends inside a string.
1009 nil nil state))
1011 ;; If the line contains a comment other than the sort
1012 ;; that is indented like code,
1013 ;; indent it now with indent-for-comment.
1014 ;; Comments indented like code are right already.
1015 ;; In any case clear the in-comment flag in the state
1016 ;; because parse-partial-sexp never sees the newlines.
1021 ;; If this line ends inside a string,
1022 ;; go straight to next line, remaining within the inner loop,
1023 ;; and turn off the \-flag.
1046 ;; Now go to the next line and indent it according
1047 ;; to what we learned from parsing the previous one.
1051 ;; But not if the line is blank, or just a comment
1052 ;; (except for double-semi comments; indent them as usual).
1054 nil
1060 starting-point))))
1076 "Indent every line whose first char is between START and END inclusive."
1085 ;;;; Lisp paragraph filling commands.
1088 "Value of `fill-column' to use when filling a docstring.
1089 Any non-integer value means do not use a different value of
1090 `fill-column' when filling docstrings."
1097 If any of the current line is a comment, fill the comment or the
1098 paragraph of it that point is in, preserving the comment's indentation
1099 and initial semicolons."
1102 ;; Point is on a program line (a line no comment); we are interested
1103 ;; particularly in docstring lines.
1104 ;;
1105 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1106 ;; are buffer-local, but we avoid changing them so that they can be set
1107 ;; to make `forward-paragraph' and friends do something the user wants.
1108 ;;
1109 ;; `paragraph-start': The `(' in the character alternative and the
1110 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1111 ;; sexps and backquoted sexps that follow a docstring from being filled
1112 ;; with the docstring. This setting has the consequence of inhibiting
1113 ;; filling many program lines that are not docstrings, which is sensible,
1114 ;; because the user probably asked to fill program lines by accident, or
1115 ;; expecting indentation (perhaps we should try to do indenting in that
1116 ;; case). The `;' and `:' stop the paragraph being filled at following
1117 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1118 ;; escaped to keep font-locking, filling, & paren matching in the source
1119 ;; file happy.
1120 ;;
1121 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1122 ;; a docstring and identifies it as a paragraph separator, so that it
1123 ;; won't be filled. (Since the first line of documentation stands alone
1124 ;; in some contexts, filling should not alter the contents the author has
1125 ;; chosen.) Only the first line of a docstring begins with whitespace
1126 ;; and a quotation mark and ends with a period or (rarely) a comma.
1127 ;;
1128 ;; The `fill-column' is temporarily bound to
1129 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1135 emacs-lisp-docstring-fill-column
1136 fill-column)))
1138 ;; Never return nil.
1139 t))
1142 "Indent all lines of code, starting in the region, sideways by ARG columns.
1143 Does not affect lines starting inside comments or strings, assuming that
1144 the start of the region is not inside them.
1146 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1147 The last is a regexp which, if matched at the beginning of a line,
1148 means don't indent that line."
1159 nil nil state)))
1164 ;; If line does not start in string, indent it
1172 nil nil state))))))
1176 ;;; arch-tag: 414c7f93-c245-4b77-8ed5-ed05ef7ff1bf
1177 ;;; lisp-mode.el ends here