| blob | 6e476ab8fcf903775e8cb6b832968573333d9901 |
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))
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
162 ;; This gets in the way when viewing a Lisp file in view-mode. As
163 ;; long as [backspace] is mapped into DEL via the
164 ;; function-key-map, this should remain disabled!!
165 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
166 map)
170 "Keymap for Emacs Lisp mode.
174 ()
204 "Byte compile the file containing the current buffer."
211 "Byte-compile the current file (if it has changed), then load compiled code."
216 ;; Recompile if file or buffer has changed since last compilation.
226 "Hook run when entering Emacs Lisp mode."
232 "Hook run when entering Lisp mode."
238 "Hook run when entering Lisp Interaction mode."
244 "Major mode for editing Lisp code to run in Emacs.
245 Commands:
246 Delete converts tabs to spaces as it moves back.
247 Blank lines separate paragraphs. Semicolons start comments.
249 Entry to this mode calls the value of `emacs-lisp-mode-hook'
250 if that value is non-nil."
259 map)
260 "Keymap for ordinary Lisp mode.
264 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
265 Commands:
266 Delete converts tabs to spaces as it moves back.
267 Blank lines separate paragraphs. Semicolons start comments.
269 Note that `run-lisp' may be used either to start an inferior Lisp job
270 or to switch back to an existing one.
272 Entry to this mode calls the value of `lisp-mode-hook'
273 if that value is non-nil."
279 ;; This will do unless inf-lisp.el is loaded.
291 map)
292 "Keymap for Lisp Interaction mode.
296 "Major mode for typing and evaluating Lisp forms.
298 before point, and prints its value into the buffer, advancing point.
299 Note that printing is controled by `eval-expression-print-length'
300 and `eval-expression-print-level'.
302 Commands:
303 Delete converts tabs to spaces as it moves back.
304 Paragraphs are separated only by blank lines.
305 Semicolons start comments.
307 Entry to this mode calls the value of `lisp-interaction-mode-hook'
311 "Evaluate sexp before point; print value into current buffer."
319 "Evaluate sexp before point; print value in minibuffer.
320 With argument, print output into current buffer."
325 ignore-quotes
326 expr)
330 ;; If this sexp appears to be enclosed in `...'
331 ;; then ignore the surrounding quotes.
336 ;; If we were after `?\e' (or similar case),
337 ;; use the whole thing, not just the `e'.
343 ;; Skip over `#N='s.
353 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
354 ;; `variable' so that the value is returned, not the
355 ;; name
361 ;; If it's an (interactive ...) form, it's more
362 ;; useful to show how an interactive call would
363 ;; use it.
371 expr
373 expr))
380 "Evaluate sexp before point; print value in minibuffer.
381 Interactively, with prefix argument, print output into current buffer."
391 value)))
394 "Change defvar into defconst within FORM.
395 Likewise for other constructs as necessary."
396 ;; The code in edebug-defun should be consistent with this, but not
397 ;; the same, since this gets a macroexpended form.
400 ;; Force variable to be bound.
402 ;; `defcustom' is now macroexpanded to
403 ;; `custom-declare-variable' with a quoted value arg.
406 ;; Force variable to be bound.
408 form)
414 "Evaluate defun that point is in or before.
415 The value is displayed in the minibuffer.
416 If the current defun is actually a call to `defvar',
417 then reset the variable using the initial value expression
418 even if the variable already has some other value.
419 \(Normally `defvar' does not change the variable's value
420 if it already has a value.\)
422 With argument, insert value in current buffer after the defun.
423 Return the result of evaluation."
429 ;; Arrange for eval-region to "read" the (possibly) altered form.
430 ;; eval-region handles recording which file defines a function or
431 ;; variable. Re-written using `apply' to avoid capturing
432 ;; variables like `end'.
434 #'eval-region
436 beg end form)
437 ;; Read the form from the buffer, and record where it ends.
444 ;; Alter the form if necessary, changing defvar into defconst, etc.
448 ;; Skipping to the end of the specified region
449 ;; will make eval-region return.
452 ;; The result of evaluation has been put onto VALUES. So return it.
456 "Evaluate the top-level form containing point, or after point.
458 If the current defun is actually a call to `defvar', then reset the
459 variable using its initial value expression even if the variable
460 already has some other value. (Normally `defvar' does not change the
461 variable's value if it already has a value.)
463 With a prefix argument, instrument the code for Edebug.
465 If acting on a `defun' for FUNCTION, and the function was
466 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
467 instrumented, just FUNCTION is printed.
469 If not acting on a `defun', the result of evaluation is displayed in
470 the minibuffer."
484 value)))))
495 comment-column))))
513 "Indent current line as Lisp code.
514 With argument, indent any additional lines of the same expression
515 rigidly along with this one."
523 ;; Don't alter indentation of a ;;; comment line
524 ;; or a line that starts in a string.
527 ;; Single-semicolon comment lines should be indented
528 ;; as comment lines, not as code.
533 nil
536 ;; If initial point was within line's indentation,
537 ;; position after the indentation. Else stay at same point in text.
540 ;; If desired, shift remaining lines of expression the same amount.
555 "Return appropriate indentation for current line as Lisp code.
556 In usual case returns an integer: the column to indent to.
557 If the value is nil, that means don't change the indentation
558 because the line starts inside a string.
560 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
561 This means that following lines at the same level of indentation
562 should not necessarily be indented the same as this line.
563 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
564 is the buffer position of the start of the containing expression."
568 state paren-depth
569 ;; setting this to a number inhibits calling hook
572 calculate-lisp-indent-last-sexp containing-sexp)
576 ;; Find outermost containing sexp
579 ;; Find innermost containing sexp
581 state
586 ;; Position following last unclosed open.
588 ;; Is there a complete sexp since then?
591 ;; Yes, but is there a containing sexp after that?
596 nil
597 ;; Innermost containing sexp found
600 ;; indent-point immediately follows open paren.
601 ;; Don't call hook.
603 ;; Find the start of first element of containing sexp.
606 ;; First element of containing sexp is a list.
607 ;; Indent under that list.
608 )
610 calculate-lisp-indent-last-sexp)
611 ;; This is the first line to start within the containing sexp.
612 ;; It's almost certainly a function call.
614 ;; Containing sexp has nothing before this line
615 ;; except the first element. Indent under that element.
616 nil
617 ;; Skip the first element, find start of second (the first
618 ;; argument of the function call) and indent under.
621 calculate-lisp-indent-last-sexp
625 ;; Indent beneath first sexp on same line as
626 ;; `calculate-lisp-indent-last-sexp'. Again, it's
627 ;; almost certainly a function call.
633 ;; Point is at the point to indent under unless we are inside a string.
634 ;; Call indentation hook except when overridden by lisp-indent-offset
635 ;; or if the desired indentation has already been computed.
638 ;; Inside a string, don't change indentation.
639 nil)
641 ;; Indent by constant offset
646 lisp-indent-function
649 normal-indent))
651 normal-indent))))))
659 ;; car of form doesn't seem to be a a symbol
662 calculate-lisp-indent-last-sexp))
667 ;; Indent under the list or under the first sexp on the same
668 ;; line as calculate-lisp-indent-last-sexp. Note that first
669 ;; thing on that line has to be complete sexp since we are
670 ;; inside the innermost containing sexp.
675 method)
685 indent-point normal-indent))
695 body-indent containing-form-column)
696 ;; Move to the start of containing form, calculate indentation
697 ;; to use for non-distinguished forms (> count), and move past the
698 ;; function symbol. lisp-indent-function guarantees that there is at
699 ;; least one word or symbol character following open paren of containing
700 ;; form.
706 ;; Now find the start of the last form.
715 ;; Point is sitting on first character of last (or count) sexp.
717 ;; A distinguished form. If it is the first or second form use double
718 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
719 ;; to 2 (the default), this just happens to work the same with if as
720 ;; the older code, but it makes unwind-protect, condition-case,
721 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
722 ;; less hacked, behavior can be obtained by replacing below with
723 ;; (list normal-indent containing-form-start).
726 containing-form-start)
728 ;; A non-distinguished form. Use body-indent if there are no
729 ;; distinguished forms and this is the first undistinguished form,
730 ;; or if this is the first undistinguished form and the preceding
731 ;; distinguished form has indentation at least as great as body-indent.
734 body-indent
735 normal-indent))))
746 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
747 ;; like defun if the first form is placed on the next line, otherwise
748 ;; it is indented like any other form (i.e. forms line up under first).
783 "Indent each line of the list starting just after point.
784 If optional arg ENDPOS is given, indent each line, stopping when
785 ENDPOS is encountered."
789 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
790 ;; so that calculate-lisp-indent will find the beginning of
791 ;; the defun we are in.
792 ;; If ENDPOS is nil, it is safe not to scan before point
793 ;; since every line we indent is more deeply nested than point is.
796 last-depth bol outer-loop-done inner-loop-done state this-indent)
798 ;; Get error now if we don't have a complete sexp after point.
805 inner-loop-done nil)
806 ;; Parse this line so we can learn the state
807 ;; to indent the next line.
808 ;; This inner loop goes through only once
809 ;; unless a line ends inside a string.
813 nil nil state))
815 ;; If the line contains a comment other than the sort
816 ;; that is indented like code,
817 ;; indent it now with indent-for-comment.
818 ;; Comments indented like code are right already.
819 ;; In any case clear the in-comment flag in the state
820 ;; because parse-partial-sexp never sees the newlines.
825 ;; If this line ends inside a string,
826 ;; go straight to next line, remaining within the inner loop,
827 ;; and turn off the \-flag.
850 ;; Now go to the next line and indent it according
851 ;; to what we learned from parsing the previous one.
855 ;; But not if the line is blank, or just a comment
856 ;; (except for double-semi comments; indent them as usual).
858 nil
864 starting-point))))
880 "Indent every line whose first char is between START and END inclusive."
889 ;;;; Lisp paragraph filling commands.
893 If any of the current line is a comment, fill the comment or the
894 paragraph of it that point is in, preserving the comment's indentation
895 and initial semicolons."
898 ;; Non-nil if the current line contains a comment.
899 has-comment
901 ;; Non-nil if the current line contains code and a comment.
902 has-code-and-comment
904 ;; If has-comment, the appropriate fill-prefix for the comment.
905 comment-fill-prefix
906 )
908 ;; Figure out what kind of comment we are looking at.
913 ;; A line with nothing but a comment on it?
919 ;; A line with some code, followed by a comment? Remember that the
920 ;; semi which starts the comment shouldn't be part of a string or
921 ;; character.
940 ;; `paragraph-start' is set here (not in the buffer-local
941 ;; variable so that `forward-paragraph' et al work as
942 ;; expected) so that filling (doc) strings works sensibly.
943 ;; Adding the opening paren to avoid the following sexp being
944 ;; filled means that sexps generally aren't filled as normal
945 ;; text, which is probably sensible. The `;' and `:' stop the
946 ;; filled para at following comment lines and keywords
947 ;; (typically in `defcustom').
952 ;; Narrow to include only the comment, and then fill the region.
957 ;; Find the first line we should include in the region to fill.
961 ;; We may have gone too far. Go forward again.
965 ;; Find the beginning of the first line past the region to fill.
971 ;; Lines with only semicolons on them can be paragraph boundaries.
983 ;; If this comment starts on a line with code,
984 ;; include that like in the filling.
990 justify nil
994 nil
997 t))
1000 "Indent all lines of code, starting in the region, sideways by ARG columns.
1001 Does not affect lines starting inside comments or strings, assuming that
1002 the start of the region is not inside them.
1004 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1005 The last is a regexp which, if matched at the beginning of a line,
1006 means don't indent that line."
1017 nil nil state)))
1022 ;; If line does not start in string, indent it
1030 nil nil state))))))
1034 ;;; lisp-mode.el ends here