| blob | adc16ef0833ac628be72e276b9a42d99dc2e1e07 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands.
3 ;; Copyright (C) 1985, 1986, 1999, 2000 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))
110 ;; Adaptive fill mode gets in the way of auto-fill,
111 ;; and should make no difference for explicit fill
112 ;; because lisp-fill-paragraph should do the job.
130 ;; Look within the line for a ; following an even number of backslashes
131 ;; after either a non-backslash or the line beginning.
145 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2)
150 "Lisp mode `outline-level' function."
152 1000
161 ;; This gets in the way when viewing a Lisp file in view-mode. As
162 ;; long as [backspace] is mapped into DEL via the
163 ;; function-key-map, this should remain disabled!!
164 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
165 map)
169 "Keymap for Emacs Lisp mode.
173 ()
203 "Byte compile the file containing the current buffer."
210 "Byte-compile the current file (if it has changed), then load compiled code."
215 ;; Recompile if file or buffer has changed since last compilation.
225 "Hook run when entering Emacs Lisp mode."
231 "Hook run when entering Lisp mode."
237 "Hook run when entering Lisp Interaction mode."
243 "Major mode for editing Lisp code to run in Emacs.
244 Commands:
245 Delete converts tabs to spaces as it moves back.
246 Blank lines separate paragraphs. Semicolons start comments.
248 Entry to this mode calls the value of `emacs-lisp-mode-hook'
249 if that value is non-nil."
258 map)
259 "Keymap for ordinary Lisp mode.
263 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
264 Commands:
265 Delete converts tabs to spaces as it moves back.
266 Blank lines separate paragraphs. Semicolons start comments.
268 Note that `run-lisp' may be used either to start an inferior Lisp job
269 or to switch back to an existing one.
271 Entry to this mode calls the value of `lisp-mode-hook'
272 if that value is non-nil."
277 ;; This will do unless inf-lisp.el is loaded.
289 map)
290 "Keymap for Lisp Interaction mode.
294 "Major mode for typing and evaluating Lisp forms.
296 before point, and prints its value into the buffer, advancing point.
298 Commands:
299 Delete converts tabs to spaces as it moves back.
300 Paragraphs are separated only by blank lines.
301 Semicolons start comments.
303 Entry to this mode calls the value of `lisp-interaction-mode-hook'
307 "Evaluate sexp before point; print value into current buffer."
315 "Evaluate sexp before point; print value in minibuffer.
316 With argument, print output into current buffer."
321 ignore-quotes
322 expr)
326 ;; If this sexp appears to be enclosed in `...'
327 ;; then ignore the surrounding quotes.
332 ;; If we were after `?\e' (or similar case),
333 ;; use the whole thing, not just the `e'.
339 ;; Skip over `#N='s.
349 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
350 ;; `variable' so that the value is returned, not the
351 ;; name
357 ;; If it's an (interactive ...) form, it's more
358 ;; useful to show how an interactive call would
359 ;; use it.
367 expr
369 expr))
376 "Evaluate sexp before point; print value in minibuffer.
377 With argument, print output into current buffer."
387 value)))
390 "Change defvar into defconst within FORM.
391 Likewise for other constructs as necessary."
392 ;; The code in edebug-defun should be consistent with this, but not
393 ;; the same, since this gets a macroexpended form.
396 ;; Force variable to be bound.
398 ;; `defcustom' is now macroexpanded to
399 ;; `custom-declare-variable' with a quoted value arg.
402 ;; Force variable to be bound.
404 form)
410 "Evaluate defun that point is in or before.
411 The value is displayed in the minibuffer.
412 If the current defun is actually a call to `defvar',
413 then reset the variable using the initial value expression
414 even if the variable already has some other value.
415 \(Normally `defvar' does not change the variable's value
416 if it already has a value.\)
418 With argument, insert value in current buffer after the defun.
419 Return the result of evaluation."
425 ;; Arrange for eval-region to "read" the (possibly) altered form.
426 ;; eval-region handles recording which file defines a function or
427 ;; variable. Re-written using `apply' to avoid capturing
428 ;; variables like `end'.
430 #'eval-region
432 beg end form)
433 ;; Read the form from the buffer, and record where it ends.
440 ;; Alter the form if necessary, changing defvar into defconst, etc.
444 ;; Skipping to the end of the specified region
445 ;; will make eval-region return.
448 ;; The result of evaluation has been put onto VALUES. So return it.
452 "Evaluate the top-level form containing point, or after point.
454 If the current defun is actually a call to `defvar', then reset the
455 variable using its initial value expression even if the variable
456 already has some other value. (Normally `defvar' does not change the
457 variable's value if it already has a value.)
459 With a prefix argument, instrument the code for Edebug.
461 If acting on a `defun' for FUNCTION, and the function was
462 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
463 instrumented, just FUNCTION is printed.
465 If not acting on a `defun', the result of evaluation is displayed in
466 the minibuffer."
480 value)))))
491 comment-column))))
508 "Indent current line as Lisp code.
509 With argument, indent any additional lines of the same expression
510 rigidly along with this one."
518 ;; Don't alter indentation of a ;;; comment line
519 ;; or a line that starts in a string.
522 ;; Single-semicolon comment lines should be indented
523 ;; as comment lines, not as code.
528 nil
531 ;; If initial point was within line's indentation,
532 ;; position after the indentation. Else stay at same point in text.
535 ;; If desired, shift remaining lines of expression the same amount.
550 "Return appropriate indentation for current line as Lisp code.
551 In usual case returns an integer: the column to indent to.
552 If the value is nil, that means don't change the indentation
553 because the line starts inside a string.
555 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
556 This means that following lines at the same level of indentation
557 should not necessarily be indented the same as this line.
558 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
559 is the buffer position of the start of the containing expression."
563 state paren-depth
564 ;; setting this to a number inhibits calling hook
567 calculate-lisp-indent-last-sexp containing-sexp)
571 ;; Find outermost containing sexp
574 ;; Find innermost containing sexp
576 state
581 ;; Position following last unclosed open.
583 ;; Is there a complete sexp since then?
586 ;; Yes, but is there a containing sexp after that?
591 nil
592 ;; Innermost containing sexp found
595 ;; indent-point immediately follows open paren.
596 ;; Don't call hook.
598 ;; Find the start of first element of containing sexp.
601 ;; First element of containing sexp is a list.
602 ;; Indent under that list.
603 )
605 calculate-lisp-indent-last-sexp)
606 ;; This is the first line to start within the containing sexp.
607 ;; It's almost certainly a function call.
609 ;; Containing sexp has nothing before this line
610 ;; except the first element. Indent under that element.
611 nil
612 ;; Skip the first element, find start of second (the first
613 ;; argument of the function call) and indent under.
616 calculate-lisp-indent-last-sexp
620 ;; Indent beneath first sexp on same line as
621 ;; `calculate-lisp-indent-last-sexp'. Again, it's
622 ;; almost certainly a function call.
628 ;; Point is at the point to indent under unless we are inside a string.
629 ;; Call indentation hook except when overridden by lisp-indent-offset
630 ;; or if the desired indentation has already been computed.
633 ;; Inside a string, don't change indentation.
634 nil)
636 ;; Indent by constant offset
641 lisp-indent-function
644 normal-indent))
646 normal-indent))))))
654 ;; car of form doesn't seem to be a a symbol
657 calculate-lisp-indent-last-sexp))
662 ;; Indent under the list or under the first sexp on the same
663 ;; line as calculate-lisp-indent-last-sexp. Note that first
664 ;; thing on that line has to be complete sexp since we are
665 ;; inside the innermost containing sexp.
670 method)
680 indent-point normal-indent))
690 body-indent containing-form-column)
691 ;; Move to the start of containing form, calculate indentation
692 ;; to use for non-distinguished forms (> count), and move past the
693 ;; function symbol. lisp-indent-function guarantees that there is at
694 ;; least one word or symbol character following open paren of containing
695 ;; form.
701 ;; Now find the start of the last form.
710 ;; Point is sitting on first character of last (or count) sexp.
712 ;; A distinguished form. If it is the first or second form use double
713 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
714 ;; to 2 (the default), this just happens to work the same with if as
715 ;; the older code, but it makes unwind-protect, condition-case,
716 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
717 ;; less hacked, behavior can be obtained by replacing below with
718 ;; (list normal-indent containing-form-start).
721 containing-form-start)
723 ;; A non-distinguished form. Use body-indent if there are no
724 ;; distinguished forms and this is the first undistinguished form,
725 ;; or if this is the first undistinguished form and the preceding
726 ;; distinguished form has indentation at least as great as body-indent.
729 body-indent
730 normal-indent))))
741 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
742 ;; like defun if the first form is placed on the next line, otherwise
743 ;; it is indented like any other form (i.e. forms line up under first).
778 "Indent each line of the list starting just after point.
779 If optional arg ENDPOS is given, indent each line, stopping when
780 ENDPOS is encountered."
784 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
785 ;; so that calculate-lisp-indent will find the beginning of
786 ;; the defun we are in.
787 ;; If ENDPOS is nil, it is safe not to scan before point
788 ;; since every line we indent is more deeply nested than point is.
791 last-depth bol outer-loop-done inner-loop-done state this-indent)
793 ;; Get error now if we don't have a complete sexp after point.
800 inner-loop-done nil)
801 ;; Parse this line so we can learn the state
802 ;; to indent the next line.
803 ;; This inner loop goes through only once
804 ;; unless a line ends inside a string.
808 nil nil state))
810 ;; If the line contains a comment other than the sort
811 ;; that is indented like code,
812 ;; indent it now with indent-for-comment.
813 ;; Comments indented like code are right already.
814 ;; In any case clear the in-comment flag in the state
815 ;; because parse-partial-sexp never sees the newlines.
820 ;; If this line ends inside a string,
821 ;; go straight to next line, remaining within the inner loop,
822 ;; and turn off the \-flag.
845 ;; Now go to the next line and indent it according
846 ;; to what we learned from parsing the previous one.
850 ;; But not if the line is blank, or just a comment
851 ;; (except for double-semi comments; indent them as usual).
853 nil
859 starting-point))))
875 "Indent every line whose first char is between START and END inclusive."
884 ;;;; Lisp paragraph filling commands.
888 If any of the current line is a comment, fill the comment or the
889 paragraph of it that point is in, preserving the comment's indentation
890 and initial semicolons."
893 ;; Non-nil if the current line contains a comment.
894 has-comment
896 ;; Non-nil if the current line contains code and a comment.
897 has-code-and-comment
899 ;; If has-comment, the appropriate fill-prefix for the comment.
900 comment-fill-prefix
901 )
903 ;; Figure out what kind of comment we are looking at.
908 ;; A line with nothing but a comment on it?
914 ;; A line with some code, followed by a comment? Remember that the
915 ;; semi which starts the comment shouldn't be part of a string or
916 ;; character.
935 ;; `paragraph-start' is set here (not in the buffer-local
936 ;; variable so that `forward-paragraph' et al work as
937 ;; expected) so that filling (doc) strings works sensibly.
938 ;; Adding the opening paren to avoid the following sexp being
939 ;; filled means that sexps generally aren't filled as normal
940 ;; text, which is probably sensible. The `;' and `:' stop the
941 ;; filled para at following comment lines and keywords
942 ;; (typically in `defcustom').
947 ;; Narrow to include only the comment, and then fill the region.
952 ;; Find the first line we should include in the region to fill.
956 ;; We may have gone too far. Go forward again.
960 ;; Find the beginning of the first line past the region to fill.
966 ;; Lines with only semicolons on them can be paragraph boundaries.
978 ;; If this comment starts on a line with code,
979 ;; include that like in the filling.
985 justify nil
989 nil
992 t))
995 "Indent all lines of code, starting in the region, sideways by ARG columns.
996 Does not affect lines starting inside comments or strings, assuming that
997 the start of the region is not inside them.
999 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1000 The last is a regexp which, if matched at the beginning of a line,
1001 means don't indent that line."
1012 nil nil state)))
1017 ;; If line does not start in string, indent it
1025 nil nil state))))))
1029 ;;; lisp-mode.el ends here