| blob | 171f059d09f8b494ff8c0ed716a17d3187e0be86 |
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."
441 "Evaluate sexp before point; print value in minibuffer.
442 With argument, print output into current buffer."
447 ignore-quotes
448 expr)
452 ;; If this sexp appears to be enclosed in `...'
453 ;; then ignore the surrounding quotes.
458 ;; If we were after `?\e' (or similar case),
459 ;; use the whole thing, not just the `e'.
465 ;; Skip over `#N='s.
475 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
476 ;; `variable' so that the value is returned, not the
477 ;; name
483 ;; If it's an (interactive ...) form, it's more
484 ;; useful to show how an interactive call would
485 ;; use it.
493 expr
495 expr))
502 end)
512 unabbreviated
514 ))))))
518 "Evaluate sexp before point; print value in minibuffer.
519 Interactively, with prefix argument, print output into current buffer."
529 value)))
532 "Change defvar into defconst within FORM.
533 Likewise for other constructs as necessary."
534 ;; The code in edebug-defun should be consistent with this, but not
535 ;; the same, since this gets a macroexpended form.
537 form)
540 ;; Force variable to be bound.
542 ;; `defcustom' is now macroexpanded to
543 ;; `custom-declare-variable' with a quoted value arg.
546 ;; Force variable to be bound.
548 form)
554 "Evaluate defun that point is in or before.
555 The value is displayed in the minibuffer.
556 If the current defun is actually a call to `defvar',
557 then reset the variable using the initial value expression
558 even if the variable already has some other value.
559 \(Normally `defvar' does not change the variable's value
560 if it already has a value.\)
562 With argument, insert value in current buffer after the defun.
563 Return the result of evaluation."
569 ;; Arrange for eval-region to "read" the (possibly) altered form.
570 ;; eval-region handles recording which file defines a function or
571 ;; variable. Re-written using `apply' to avoid capturing
572 ;; variables like `end'.
574 #'eval-region
576 beg end form)
577 ;; Read the form from the buffer, and record where it ends.
584 ;; Alter the form if necessary, changing defvar into defconst, etc.
588 ;; Skipping to the end of the specified region
589 ;; will make eval-region return.
592 ;; The result of evaluation has been put onto VALUES. So return it.
596 "Evaluate the top-level form containing point, or after point.
598 If the current defun is actually a call to `defvar' or `defcustom',
599 evaluating it this way resets the variable using its initial value
600 expression even if the variable already has some other value.
601 \(Normally `defvar' and `defcustom' do not alter the value if there
602 already is one.)
604 With a prefix argument, instrument the code for Edebug.
606 If acting on a `defun' for FUNCTION, and the function was
607 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
608 instrumented, just FUNCTION is printed.
610 If not acting on a `defun', the result of evaluation is displayed in
611 the minibuffer. This display is controlled by the variables
612 `eval-expression-print-length' and `eval-expression-print-level',
613 which see."
627 value)))))
638 comment-column))))
640 ;; This function just forces a more costly detection of comments (using
641 ;; parse-partial-sexp from beginning-of-defun). I.e. It avoids the problem of
642 ;; taking a `;' inside a string started on another line for a comment starter.
643 ;; Note: `newcomment' gets it right in 99% of the cases if you're using
644 ;; font-lock, anyway, so we could get rid of it. -stef
651 comment-auto-fill-only-comments)
660 "Indent current line as Lisp code.
661 With argument, indent any additional lines of the same expression
662 rigidly along with this one."
669 ;; Don't alter indentation of a ;;; comment line
670 ;; or a line that starts in a string.
673 ;; Single-semicolon comment lines should be indented
674 ;; as comment lines, not as code.
679 nil
682 ;; If initial point was within line's indentation,
683 ;; position after the indentation. Else stay at same point in text.
686 ;; If desired, shift remaining lines of expression the same amount.
701 "Return appropriate indentation for current line as Lisp code.
702 In usual case returns an integer: the column to indent to.
703 If the value is nil, that means don't change the indentation
704 because the line starts inside a string.
706 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
707 This means that following lines at the same level of indentation
708 should not necessarily be indented the same as this line.
709 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
710 is the buffer position of the start of the containing expression."
714 state paren-depth
715 ;; setting this to a number inhibits calling hook
718 calculate-lisp-indent-last-sexp containing-sexp)
722 ;; Find outermost containing sexp
725 ;; Find innermost containing sexp
727 state
732 ;; Position following last unclosed open.
734 ;; Is there a complete sexp since then?
737 ;; Yes, but is there a containing sexp after that?
742 nil
743 ;; Innermost containing sexp found
746 ;; indent-point immediately follows open paren.
747 ;; Don't call hook.
749 ;; Find the start of first element of containing sexp.
752 ;; First element of containing sexp is a list.
753 ;; Indent under that list.
754 )
756 calculate-lisp-indent-last-sexp)
757 ;; This is the first line to start within the containing sexp.
758 ;; It's almost certainly a function call.
760 ;; Containing sexp has nothing before this line
761 ;; except the first element. Indent under that element.
762 nil
763 ;; Skip the first element, find start of second (the first
764 ;; argument of the function call) and indent under.
767 calculate-lisp-indent-last-sexp
771 ;; Indent beneath first sexp on same line as
772 ;; `calculate-lisp-indent-last-sexp'. Again, it's
773 ;; almost certainly a function call.
779 ;; Point is at the point to indent under unless we are inside a string.
780 ;; Call indentation hook except when overridden by lisp-indent-offset
781 ;; or if the desired indentation has already been computed.
784 ;; Inside a string, don't change indentation.
785 nil)
787 ;; Indent by constant offset
792 lisp-indent-function
795 normal-indent))
797 normal-indent))))))
800 "This function is the normal value of the variable `lisp-indent-function'.
801 It is used when indenting a line within a function call, to see if the
802 called function says anything special about how to indent the line.
804 INDENT-POINT is the position where the user typed TAB, or equivalent.
805 Point is located at the point to indent under (for default indentation);
806 STATE is the `parse-partial-sexp' state for that position.
808 If the current line is in a call to a Lisp function
809 which has a non-nil property `lisp-indent-function',
810 that specifies how to do the indentation. The property value can be
811 * `defun', meaning indent `defun'-style;
812 * an integer N, meaning indent the first N arguments specially
813 like ordinary function arguments and then indent any further
814 aruments like a body;
815 * a function to call just as this function was called.
816 If that function returns nil, that means it doesn't specify
817 the indentation.
819 This function also returns nil meaning don't specify the indentation."
825 ;; car of form doesn't seem to be a symbol
828 calculate-lisp-indent-last-sexp))
833 ;; Indent under the list or under the first sexp on the same
834 ;; line as calculate-lisp-indent-last-sexp. Note that first
835 ;; thing on that line has to be complete sexp since we are
836 ;; inside the innermost containing sexp.
841 method)
851 indent-point normal-indent))
861 body-indent containing-form-column)
862 ;; Move to the start of containing form, calculate indentation
863 ;; to use for non-distinguished forms (> count), and move past the
864 ;; function symbol. lisp-indent-function guarantees that there is at
865 ;; least one word or symbol character following open paren of containing
866 ;; form.
872 ;; Now find the start of the last form.
881 ;; Point is sitting on first character of last (or count) sexp.
883 ;; A distinguished form. If it is the first or second form use double
884 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
885 ;; to 2 (the default), this just happens to work the same with if as
886 ;; the older code, but it makes unwind-protect, condition-case,
887 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
888 ;; less hacked, behavior can be obtained by replacing below with
889 ;; (list normal-indent containing-form-start).
892 containing-form-start)
894 ;; A non-distinguished form. Use body-indent if there are no
895 ;; distinguished forms and this is the first undistinguished form,
896 ;; or if this is the first undistinguished form and the preceding
897 ;; distinguished form has indentation at least as great as body-indent.
900 body-indent
901 normal-indent))))
912 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
913 ;; like defun if the first form is placed on the next line, otherwise
914 ;; it is indented like any other form (i.e. forms line up under first).
950 "Indent each line of the list starting just after point.
951 If optional arg ENDPOS is given, indent each line, stopping when
952 ENDPOS is encountered."
956 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
957 ;; so that calculate-lisp-indent will find the beginning of
958 ;; the defun we are in.
959 ;; If ENDPOS is nil, it is safe not to scan before point
960 ;; since every line we indent is more deeply nested than point is.
963 last-depth bol outer-loop-done inner-loop-done state this-indent)
965 ;; Get error now if we don't have a complete sexp after point.
972 inner-loop-done nil)
973 ;; Parse this line so we can learn the state
974 ;; to indent the next line.
975 ;; This inner loop goes through only once
976 ;; unless a line ends inside a string.
980 nil nil state))
982 ;; If the line contains a comment other than the sort
983 ;; that is indented like code,
984 ;; indent it now with indent-for-comment.
985 ;; Comments indented like code are right already.
986 ;; In any case clear the in-comment flag in the state
987 ;; because parse-partial-sexp never sees the newlines.
992 ;; If this line ends inside a string,
993 ;; go straight to next line, remaining within the inner loop,
994 ;; and turn off the \-flag.
1017 ;; Now go to the next line and indent it according
1018 ;; to what we learned from parsing the previous one.
1022 ;; But not if the line is blank, or just a comment
1023 ;; (except for double-semi comments; indent them as usual).
1025 nil
1031 starting-point))))
1047 "Indent every line whose first char is between START and END inclusive."
1056 ;;;; Lisp paragraph filling commands.
1060 If any of the current line is a comment, fill the comment or the
1061 paragraph of it that point is in, preserving the comment's indentation
1062 and initial semicolons."
1065 ;; `paragraph-start' is set here (not in the buffer-local
1066 ;; variable so that `forward-paragraph' et al work as
1067 ;; expected) so that filling (doc) strings works sensibly.
1068 ;; Adding the opening paren to avoid the following sexp being
1069 ;; filled means that sexps generally aren't filled as normal
1070 ;; text, which is probably sensible. The `;' and `:' stop the
1071 ;; filled para at following comment lines and keywords
1072 ;; (typically in `defcustom').
1075 ;; Avoid filling the first line of docstring.
1079 ;; Never return nil.
1080 t))
1083 "Indent all lines of code, starting in the region, sideways by ARG columns.
1084 Does not affect lines starting inside comments or strings, assuming that
1085 the start of the region is not inside them.
1087 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1088 The last is a regexp which, if matched at the beginning of a line,
1089 means don't indent that line."
1100 nil nil state)))
1105 ;; If line does not start in string, indent it
1113 nil nil state))))))
1117 ;;; lisp-mode.el ends here