| blob | 6c084c409df617169cf0f0f065bf4c48b875c36d |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001 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.
62 ;; Used to be singlequote; changed for flonums.
71 table))
79 table))
94 "define-method-combination"
118 ;; This was originally in autoload.el and is still used there.
134 ;; define-global-mode has no explicit docstring.
143 ;; This might be a docstring.
155 font-lock-doc-face
156 font-lock-string-face)
157 font-lock-comment-face))
159 ;; The LISP-SYNTAX argument is used by code in inf-lisp.el and is
160 ;; (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
169 ;; Adaptive fill mode gets in the way of auto-fill,
170 ;; and should make no difference for explicit fill
171 ;; because lisp-fill-paragraph should do the job.
172 ;; I believe that newcomment's auto-fill code properly deals with it -stef
173 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
189 ;; Look within the line for a ; following an even number of backslashes
190 ;; after either a non-backslash or the line beginning.
205 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
209 . lisp-font-lock-syntactic-face-function))))
212 "Lisp mode `outline-level' function."
214 1000
224 ;; This gets in the way when viewing a Lisp file in view-mode. As
225 ;; long as [backspace] is mapped into DEL via the
226 ;; function-key-map, this should remain disabled!!
227 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
228 map)
232 "Keymap for Emacs Lisp mode.
236 ()
266 "Byte compile the file containing the current buffer."
273 "Byte-compile the current file (if it has changed), then load compiled code."
278 ;; Recompile if file or buffer has changed since last compilation.
288 "Hook run when entering Emacs Lisp mode."
294 "Hook run when entering Lisp mode."
300 "Hook run when entering Lisp Interaction mode."
306 "Major mode for editing Lisp code to run in Emacs.
307 Commands:
308 Delete converts tabs to spaces as it moves back.
309 Blank lines separate paragraphs. Semicolons start comments.
311 Entry to this mode calls the value of `emacs-lisp-mode-hook'
312 if that value is non-nil."
328 map)
329 "Keymap for ordinary Lisp mode.
333 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
334 Commands:
335 Delete converts tabs to spaces as it moves back.
336 Blank lines separate paragraphs. Semicolons start comments.
338 Note that `run-lisp' may be used either to start an inferior Lisp job
339 or to switch back to an existing one.
341 Entry to this mode calls the value of `lisp-mode-hook'
342 if that value is non-nil."
358 ;; This will do unless inf-lisp.el is loaded.
370 map)
371 "Keymap for Lisp Interaction mode.
376 "Major mode for typing and evaluating Lisp forms.
378 before point, and prints its value into the buffer, advancing point.
379 Note that printing is controlled by `eval-expression-print-length'
380 and `eval-expression-print-level'.
382 Commands:
383 Delete converts tabs to spaces as it moves back.
384 Paragraphs are separated only by blank lines.
385 Semicolons start comments.
387 Entry to this mode calls the value of `lisp-interaction-mode-hook'
391 "Evaluate sexp before point; print value into current buffer.
393 Note that printing the result is controlled by the variables
394 `eval-expression-print-length' and `eval-expression-print-level',
395 which see."
404 "Set up text properties for the output of `eval-last-sexp-1'.
405 BEG and END are the start and end of the output in current-buffer.
406 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
407 alternative printed representations that can be displayed."
413 beg end
415 mouse-face highlight
416 keymap ,map
417 help-echo "RET, mouse-2: toggle abbreviated display"
419 printed-value)))))
423 "Toggle between abbreviated and unabbreviated printed representations."
425 ;; Normally this command won't be called at end of line.
426 ;; But when the end of the line is also the end of the buffer,
427 ;; it does get called. For consistency, pretend it was not called.
447 "Evaluate sexp before point; print value in minibuffer.
448 With argument, print output into current buffer."
453 ignore-quotes
454 expr)
458 ;; If this sexp appears to be enclosed in `...'
459 ;; then ignore the surrounding quotes.
464 ;; If we were after `?\e' (or similar case),
465 ;; use the whole thing, not just the `e'.
471 ;; Skip over `#N='s.
481 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
482 ;; `variable' so that the value is returned, not the
483 ;; name
489 ;; If it's an (interactive ...) form, it's more
490 ;; useful to show how an interactive call would
491 ;; use it.
499 expr
501 expr))
508 end)
518 unabbreviated
520 ))))))
524 "Evaluate sexp before point; print value in minibuffer.
525 Interactively, with prefix argument, print output into current buffer."
535 value)))
538 "Change defvar into defconst within FORM.
539 Likewise for other constructs as necessary."
540 ;; The code in edebug-defun should be consistent with this, but not
541 ;; the same, since this gets a macroexpended form.
543 form)
546 ;; Force variable to be bound.
548 ;; `defcustom' is now macroexpanded to
549 ;; `custom-declare-variable' with a quoted value arg.
552 ;; Force variable to be bound.
554 form)
560 "Evaluate defun that point is in or before.
561 The value is displayed in the minibuffer.
562 If the current defun is actually a call to `defvar',
563 then reset the variable using the initial value expression
564 even if the variable already has some other value.
565 \(Normally `defvar' does not change the variable's value
566 if it already has a value.\)
568 With argument, insert value in current buffer after the defun.
569 Return the result of evaluation."
575 ;; Arrange for eval-region to "read" the (possibly) altered form.
576 ;; eval-region handles recording which file defines a function or
577 ;; variable. Re-written using `apply' to avoid capturing
578 ;; variables like `end'.
580 #'eval-region
582 beg end form)
583 ;; Read the form from the buffer, and record where it ends.
590 ;; Alter the form if necessary, changing defvar into defconst, etc.
594 ;; Skipping to the end of the specified region
595 ;; will make eval-region return.
598 ;; The result of evaluation has been put onto VALUES. So return it.
602 "Evaluate the top-level form containing point, or after point.
604 If the current defun is actually a call to `defvar' or `defcustom',
605 evaluating it this way resets the variable using its initial value
606 expression even if the variable already has some other value.
607 \(Normally `defvar' and `defcustom' do not alter the value if there
608 already is one.)
610 With a prefix argument, instrument the code for Edebug.
612 If acting on a `defun' for FUNCTION, and the function was
613 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
614 instrumented, just FUNCTION is printed.
616 If not acting on a `defun', the result of evaluation is displayed in
617 the minibuffer. This display is controlled by the variables
618 `eval-expression-print-length' and `eval-expression-print-level',
619 which see."
633 value)))))
634 \f
644 comment-column))))
646 ;; This function just forces a more costly detection of comments (using
647 ;; parse-partial-sexp from beginning-of-defun). I.e. It avoids the problem of
648 ;; taking a `;' inside a string started on another line for a comment starter.
649 ;; Note: `newcomment' gets it right in 99% of the cases if you're using
650 ;; font-lock, anyway, so we could get rid of it. -stef
657 comment-auto-fill-only-comments)
666 "Indent current line as Lisp code.
667 With argument, indent any additional lines of the same expression
668 rigidly along with this one."
675 ;; Don't alter indentation of a ;;; comment line
676 ;; or a line that starts in a string.
679 ;; Single-semicolon comment lines should be indented
680 ;; as comment lines, not as code.
685 nil
688 ;; If initial point was within line's indentation,
689 ;; position after the indentation. Else stay at same point in text.
692 ;; If desired, shift remaining lines of expression the same amount.
707 "Return appropriate indentation for current line as Lisp code.
708 In usual case returns an integer: the column to indent to.
709 If the value is nil, that means don't change the indentation
710 because the line starts inside a string.
712 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
713 This means that following lines at the same level of indentation
714 should not necessarily be indented the same as this line.
715 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
716 is the buffer position of the start of the containing expression."
720 state paren-depth
721 ;; setting this to a number inhibits calling hook
724 calculate-lisp-indent-last-sexp containing-sexp)
728 ;; Find outermost containing sexp
731 ;; Find innermost containing sexp
733 state
738 ;; Position following last unclosed open.
740 ;; Is there a complete sexp since then?
743 ;; Yes, but is there a containing sexp after that?
748 nil
749 ;; Innermost containing sexp found
752 ;; indent-point immediately follows open paren.
753 ;; Don't call hook.
755 ;; Find the start of first element of containing sexp.
758 ;; First element of containing sexp is a list.
759 ;; Indent under that list.
760 )
762 calculate-lisp-indent-last-sexp)
763 ;; This is the first line to start within the containing sexp.
764 ;; It's almost certainly a function call.
766 ;; Containing sexp has nothing before this line
767 ;; except the first element. Indent under that element.
768 nil
769 ;; Skip the first element, find start of second (the first
770 ;; argument of the function call) and indent under.
773 calculate-lisp-indent-last-sexp
777 ;; Indent beneath first sexp on same line as
778 ;; `calculate-lisp-indent-last-sexp'. Again, it's
779 ;; almost certainly a function call.
785 ;; Point is at the point to indent under unless we are inside a string.
786 ;; Call indentation hook except when overridden by lisp-indent-offset
787 ;; or if the desired indentation has already been computed.
790 ;; Inside a string, don't change indentation.
791 nil)
793 ;; Indent by constant offset
798 lisp-indent-function
801 normal-indent))
803 normal-indent))))))
806 "This function is the normal value of the variable `lisp-indent-function'.
807 It is used when indenting a line within a function call, to see if the
808 called function says anything special about how to indent the line.
810 INDENT-POINT is the position where the user typed TAB, or equivalent.
811 Point is located at the point to indent under (for default indentation);
812 STATE is the `parse-partial-sexp' state for that position.
814 If the current line is in a call to a Lisp function
815 which has a non-nil property `lisp-indent-function',
816 that specifies how to do the indentation. The property value can be
817 * `defun', meaning indent `defun'-style;
818 * an integer N, meaning indent the first N arguments specially
819 like ordinary function arguments and then indent any further
820 aruments like a body;
821 * a function to call just as this function was called.
822 If that function returns nil, that means it doesn't specify
823 the indentation.
825 This function also returns nil meaning don't specify the indentation."
831 ;; car of form doesn't seem to be a symbol
834 calculate-lisp-indent-last-sexp))
839 ;; Indent under the list or under the first sexp on the same
840 ;; line as calculate-lisp-indent-last-sexp. Note that first
841 ;; thing on that line has to be complete sexp since we are
842 ;; inside the innermost containing sexp.
847 method)
857 indent-point normal-indent))
867 body-indent containing-form-column)
868 ;; Move to the start of containing form, calculate indentation
869 ;; to use for non-distinguished forms (> count), and move past the
870 ;; function symbol. lisp-indent-function guarantees that there is at
871 ;; least one word or symbol character following open paren of containing
872 ;; form.
878 ;; Now find the start of the last form.
887 ;; Point is sitting on first character of last (or count) sexp.
889 ;; A distinguished form. If it is the first or second form use double
890 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
891 ;; to 2 (the default), this just happens to work the same with if as
892 ;; the older code, but it makes unwind-protect, condition-case,
893 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
894 ;; less hacked, behavior can be obtained by replacing below with
895 ;; (list normal-indent containing-form-start).
898 containing-form-start)
900 ;; A non-distinguished form. Use body-indent if there are no
901 ;; distinguished forms and this is the first undistinguished form,
902 ;; or if this is the first undistinguished form and the preceding
903 ;; distinguished form has indentation at least as great as body-indent.
906 body-indent
907 normal-indent))))
918 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
919 ;; like defun if the first form is placed on the next line, otherwise
920 ;; it is indented like any other form (i.e. forms line up under first).
956 "Indent each line of the list starting just after point.
957 If optional arg ENDPOS is given, indent each line, stopping when
958 ENDPOS is encountered."
962 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
963 ;; so that calculate-lisp-indent will find the beginning of
964 ;; the defun we are in.
965 ;; If ENDPOS is nil, it is safe not to scan before point
966 ;; since every line we indent is more deeply nested than point is.
969 last-depth bol outer-loop-done inner-loop-done state this-indent)
971 ;; Get error now if we don't have a complete sexp after point.
978 inner-loop-done nil)
979 ;; Parse this line so we can learn the state
980 ;; to indent the next line.
981 ;; This inner loop goes through only once
982 ;; unless a line ends inside a string.
986 nil nil state))
988 ;; If the line contains a comment other than the sort
989 ;; that is indented like code,
990 ;; indent it now with indent-for-comment.
991 ;; Comments indented like code are right already.
992 ;; In any case clear the in-comment flag in the state
993 ;; because parse-partial-sexp never sees the newlines.
998 ;; If this line ends inside a string,
999 ;; go straight to next line, remaining within the inner loop,
1000 ;; and turn off the \-flag.
1023 ;; Now go to the next line and indent it according
1024 ;; to what we learned from parsing the previous one.
1028 ;; But not if the line is blank, or just a comment
1029 ;; (except for double-semi comments; indent them as usual).
1031 nil
1037 starting-point))))
1053 "Indent every line whose first char is between START and END inclusive."
1062 ;;;; Lisp paragraph filling commands.
1065 "Value of `fill-column' to use when filling a docstring.
1066 Any non-integer value means do not use a different value of
1067 `fill-column' when filling docstrings."
1074 If any of the current line is a comment, fill the comment or the
1075 paragraph of it that point is in, preserving the comment's indentation
1076 and initial semicolons."
1079 ;; Point is on a program line (a line no comment); we are interested
1080 ;; particularly in docstring lines.
1081 ;;
1082 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1083 ;; are buffer-local, but we avoid changing them so that they can be set
1084 ;; to make `forward-paragraph' and friends do something the user wants.
1085 ;;
1086 ;; `paragraph-start': The `(' in the character alternative and the
1087 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1088 ;; sexps and backquoted sexps that follow a docstring from being filled
1089 ;; with the docstring. This setting has the consequence of inhibiting
1090 ;; filling many program lines that are not docstrings, which is sensible,
1091 ;; because the user probably asked to fill program lines by accident, or
1092 ;; expecting indentation (perhaps we should try to do indenting in that
1093 ;; case). The `;' and `:' stop the paragraph being filled at following
1094 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1095 ;; escaped to keep font-locking, filling, & paren matching in the source
1096 ;; file happy.
1097 ;;
1098 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1099 ;; a docstring and identifies it as a paragraph separator, so that it
1100 ;; won't be filled. (Since the first line of documentation stands alone
1101 ;; in some contexts, filling should not alter the contents the author has
1102 ;; chosen.) Only the first line of a docstring begins with whitespace
1103 ;; and a quotation mark and ends with a period or (rarely) a comma.
1104 ;;
1105 ;; The `fill-column' is temporarily bound to
1106 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1112 emacs-lisp-docstring-fill-column
1113 fill-column)))
1115 ;; Never return nil.
1116 t))
1119 "Indent all lines of code, starting in the region, sideways by ARG columns.
1120 Does not affect lines starting inside comments or strings, assuming that
1121 the start of the region is not inside them.
1123 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1124 The last is a regexp which, if matched at the beginning of a line,
1125 means don't indent that line."
1136 nil nil state)))
1141 ;; If line does not start in string, indent it
1149 nil nil state))))))
1153 ;;; lisp-mode.el ends here