| blob | f48ecf8be69f945d491ba275bc847a9af6b3590a |
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 mode `outline-level' function."
147 1000
151 \f
156 ()
162 "Keymap for Emacs Lisp mode.
166 ()
196 "Byte compile the file containing the current buffer."
203 "Byte-compile the current file (if it has changed), then load compiled code."
208 ;; Recompile if file or buffer has changed since last compilation.
218 "Hook run when entering Emacs Lisp mode."
224 "Hook run when entering Lisp mode."
230 "Hook run when entering Lisp Interaction mode."
236 "Major mode for editing Lisp code to run in Emacs.
237 Commands:
238 Delete converts tabs to spaces as it moves back.
239 Blank lines separate paragraphs. Semicolons start comments.
241 Entry to this mode calls the value of `emacs-lisp-mode-hook'
242 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."
283 ;; This will do unless inf-lisp.el is loaded.
295 map)
296 "Keymap for Lisp Interaction mode.
300 "Major mode for typing and evaluating Lisp forms.
302 before point, and prints its value into the buffer, advancing point.
304 Commands:
305 Delete converts tabs to spaces as it moves back.
306 Paragraphs are separated only by blank lines.
307 Semicolons start comments.
309 Entry to this mode calls the value of `lisp-interaction-mode-hook'
310 if that value is non-nil."
321 "Evaluate sexp before point; print value into current buffer."
327 \f
329 "Evaluate sexp before point; print value in minibuffer.
330 With argument, print output into current buffer."
335 ignore-quotes
336 expr)
340 ;; If this sexp appears to be enclosed in `...'
341 ;; then ignore the surrounding quotes.
346 ;; If we were after `?\e' (or similar case),
347 ;; use the whole thing, not just the `e'.
353 ;; Skip over `#N='s.
363 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
364 ;; `variable' so that the value is returned, not the
365 ;; name
371 ;; If it's an (interactive ...) form, it's more
372 ;; useful to show how an interactive call would
373 ;; use it.
381 expr
383 expr))
390 "Evaluate sexp before point; print value in minibuffer.
391 With argument, print output into current buffer."
401 value)))
403 ;; Change defvar into defconst within FORM,
404 ;; and likewise for other constructs as necessary.
408 ;; Force variable to be bound.
410 ;; `defcustom' is now macroexpanded to
411 ;; `custom-declare-variable' with a quoted value arg.
414 ;; Force variable to be bound.
416 form)
422 "Evaluate defun that point is in or before.
423 The value is displayed in the minibuffer.
424 If the current defun is actually a call to `defvar',
425 then reset the variable using the initial value expression
426 even if the variable already has some other value.
427 \(Normally `defvar' does not change the variable's value
428 if it already has a value.\)
430 With argument, insert value in current buffer after the defun.
431 Return the result of evaluation."
437 ;; Arrange for eval-region to "read" the (possibly) altered form.
438 ;; eval-region handles recording which file defines a function or
439 ;; variable. Re-written using `apply' to avoid capturing
440 ;; variables like `end'.
442 #'eval-region
444 beg end form)
445 ;; Read the form from the buffer, and record where it ends.
452 ;; Alter the form if necessary, changing defvar into defconst, etc.
456 ;; Skipping to the end of the specified region
457 ;; will make eval-region return.
460 ;; The result of evaluation has been put onto VALUES. So return it.
464 "Evaluate the top-level form containing point, or after point.
466 If the current defun is actually a call to `defvar', then reset the
467 variable using its initial value expression even if the variable
468 already has some other value. (Normally `defvar' does not change the
469 variable's value if it already has a value.)
471 With a prefix argument, instrument the code for Edebug.
473 If acting on a `defun' for FUNCTION, and the function was
474 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
475 instrumented, just FUNCTION is printed.
477 If not acting on a `defun', the result of evaluation is displayed in
478 the minibuffer."
492 value)))))
494 \f
503 comment-column))))
520 "Indent current line as Lisp code.
521 With argument, indent any additional lines of the same expression
522 rigidly along with this one."
530 ;; Don't alter indentation of a ;;; comment line
531 ;; or a line that starts in a string.
534 ;; Single-semicolon comment lines should be indented
535 ;; as comment lines, not as code.
540 nil
543 ;; If initial point was within line's indentation,
544 ;; position after the indentation. Else stay at same point in text.
547 ;; If desired, shift remaining lines of expression the same amount.
562 "Return appropriate indentation for current line as Lisp code.
563 In usual case returns an integer: the column to indent to.
564 If the value is nil, that means don't change the indentation
565 because the line starts inside a string.
567 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
568 This means that following lines at the same level of indentation
569 should not necessarily be indented the same as this line.
570 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
571 is the buffer position of the start of the containing expression."
575 state paren-depth
576 ;; setting this to a number inhibits calling hook
579 calculate-lisp-indent-last-sexp containing-sexp)
583 ;; Find outermost containing sexp
586 ;; Find innermost containing sexp
588 state
593 ;; Position following last unclosed open.
595 ;; Is there a complete sexp since then?
598 ;; Yes, but is there a containing sexp after that?
603 nil
604 ;; Innermost containing sexp found
607 ;; indent-point immediately follows open paren.
608 ;; Don't call hook.
610 ;; Find the start of first element of containing sexp.
613 ;; First element of containing sexp is a list.
614 ;; Indent under that list.
615 )
617 calculate-lisp-indent-last-sexp)
618 ;; This is the first line to start within the containing sexp.
619 ;; It's almost certainly a function call.
621 ;; Containing sexp has nothing before this line
622 ;; except the first element. Indent under that element.
623 nil
624 ;; Skip the first element, find start of second (the first
625 ;; argument of the function call) and indent under.
628 calculate-lisp-indent-last-sexp
632 ;; Indent beneath first sexp on same line as
633 ;; `calculate-lisp-indent-last-sexp'. Again, it's
634 ;; almost certainly a function call.
640 ;; Point is at the point to indent under unless we are inside a string.
641 ;; Call indentation hook except when overridden by lisp-indent-offset
642 ;; or if the desired indentation has already been computed.
645 ;; Inside a string, don't change indentation.
646 nil)
648 ;; Indent by constant offset
653 lisp-indent-function
656 normal-indent))
658 normal-indent))))))
666 ;; car of form doesn't seem to be a a symbol
669 calculate-lisp-indent-last-sexp))
674 ;; Indent under the list or under the first sexp on the same
675 ;; line as calculate-lisp-indent-last-sexp. Note that first
676 ;; thing on that line has to be complete sexp since we are
677 ;; inside the innermost containing sexp.
682 method)
692 indent-point normal-indent))
702 body-indent containing-form-column)
703 ;; Move to the start of containing form, calculate indentation
704 ;; to use for non-distinguished forms (> count), and move past the
705 ;; function symbol. lisp-indent-function guarantees that there is at
706 ;; least one word or symbol character following open paren of containing
707 ;; form.
713 ;; Now find the start of the last form.
722 ;; Point is sitting on first character of last (or count) sexp.
724 ;; A distinguished form. If it is the first or second form use double
725 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
726 ;; to 2 (the default), this just happens to work the same with if as
727 ;; the older code, but it makes unwind-protect, condition-case,
728 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
729 ;; less hacked, behavior can be obtained by replacing below with
730 ;; (list normal-indent containing-form-start).
733 containing-form-start)
735 ;; A non-distinguished form. Use body-indent if there are no
736 ;; distinguished forms and this is the first undistinguished form,
737 ;; or if this is the first undistinguished form and the preceding
738 ;; distinguished form has indentation at least as great as body-indent.
741 body-indent
742 normal-indent))))
752 \f
753 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
754 ;; like defun if the first form is placed on the next line, otherwise
755 ;; it is indented like any other form (i.e. forms line up under first).
790 "Indent each line of the list starting just after point.
791 If optional arg ENDPOS is given, indent each line, stopping when
792 ENDPOS is encountered."
796 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
797 ;; so that calculate-lisp-indent will find the beginning of
798 ;; the defun we are in.
799 ;; If ENDPOS is nil, it is safe not to scan before point
800 ;; since every line we indent is more deeply nested than point is.
803 last-depth bol outer-loop-done inner-loop-done state this-indent)
805 ;; Get error now if we don't have a complete sexp after point.
812 inner-loop-done nil)
813 ;; Parse this line so we can learn the state
814 ;; to indent the next line.
815 ;; This inner loop goes through only once
816 ;; unless a line ends inside a string.
820 nil nil state))
822 ;; If the line contains a comment other than the sort
823 ;; that is indented like code,
824 ;; indent it now with indent-for-comment.
825 ;; Comments indented like code are right already.
826 ;; In any case clear the in-comment flag in the state
827 ;; because parse-partial-sexp never sees the newlines.
832 ;; If this line ends inside a string,
833 ;; go straight to next line, remaining within the inner loop,
834 ;; and turn off the \-flag.
857 ;; Now go to the next line and indent it according
858 ;; to what we learned from parsing the previous one.
862 ;; But not if the line is blank, or just a comment
863 ;; (except for double-semi comments; indent them as usual).
865 nil
871 starting-point))))
887 "Indent every line whose first char is between START and END inclusive."
895 \f
896 ;;;; Lisp paragraph filling commands.
900 If any of the current line is a comment, fill the comment or the
901 paragraph of it that point is in, preserving the comment's indentation
902 and initial semicolons."
905 ;; Non-nil if the current line contains a comment.
906 has-comment
908 ;; Non-nil if the current line contains code and a comment.
909 has-code-and-comment
911 ;; If has-comment, the appropriate fill-prefix for the comment.
912 comment-fill-prefix
913 )
915 ;; Figure out what kind of comment we are looking at.
920 ;; A line with nothing but a comment on it?
926 ;; A line with some code, followed by a comment? Remember that the
927 ;; semi which starts the comment shouldn't be part of a string or
928 ;; character.
947 ;; `paragraph-start' is set here (not in the buffer-local
948 ;; variable so that `forward-paragraph' et al work as
949 ;; expected) so that filling (doc) strings works sensibly.
950 ;; Adding the opening paren to avoid the following sexp being
951 ;; filled means that sexps generally aren't filled as normal
952 ;; text, which is probably sensible. The `;' and `:' stop the
953 ;; filled para at following comment lines and keywords
954 ;; (typically in `defcustom').
959 ;; Narrow to include only the comment, and then fill the region.
964 ;; Find the first line we should include in the region to fill.
968 ;; We may have gone too far. Go forward again.
972 ;; Find the beginning of the first line past the region to fill.
978 ;; Lines with only semicolons on them can be paragraph boundaries.
990 ;; If this comment starts on a line with code,
991 ;; include that like in the filling.
997 justify nil
1001 nil
1004 t))
1005 \f
1007 "Indent all lines of code, starting in the region, sideways by ARG columns.
1008 Does not affect lines starting inside comments or strings, assuming that
1009 the start of the region is not inside them.
1011 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1012 The last is a regexp which, if matched at the beginning of a line,
1013 means don't indent that line."
1024 nil nil state)))
1029 ;; If line does not start in string, indent it
1037 nil nil state))))))
1041 ;;; lisp-mode.el ends here