| blob | 7cae7a92a7b1a751886e43f891642cf7429ac483 |
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.
313 Note that printing the result is controlled by the variables
314 `eval-expression-print-length' and `eval-expression-print-level',
315 which see."
324 "Set up text properties for the output of `eval-last-sexp-1'.
325 BEG and END are the start and end of the output in current-buffer.
326 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
327 alternative printed representations that can be displayed."
333 beg end
335 mouse-face highlight
336 keymap ,map
337 help-echo "RET, mouse-2: toggle abbreviated display"
339 printed-value)))))
343 "Toggle between abbreviated and unabbreviated printed representations."
361 "Evaluate sexp before point; print value in minibuffer.
362 With argument, print output into current buffer."
367 ignore-quotes
368 expr)
372 ;; If this sexp appears to be enclosed in `...'
373 ;; then ignore the surrounding quotes.
378 ;; If we were after `?\e' (or similar case),
379 ;; use the whole thing, not just the `e'.
385 ;; Skip over `#N='s.
395 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
396 ;; `variable' so that the value is returned, not the
397 ;; name
403 ;; If it's an (interactive ...) form, it's more
404 ;; useful to show how an interactive call would
405 ;; use it.
413 expr
415 expr))
422 end)
431 unabbreviated
433 )))))
437 "Evaluate sexp before point; print value in minibuffer.
438 Interactively, with prefix argument, print output into current buffer."
448 value)))
451 "Change defvar into defconst within FORM.
452 Likewise for other constructs as necessary."
453 ;; The code in edebug-defun should be consistent with this, but not
454 ;; the same, since this gets a macroexpended form.
457 ;; Force variable to be bound.
459 ;; `defcustom' is now macroexpanded to
460 ;; `custom-declare-variable' with a quoted value arg.
463 ;; Force variable to be bound.
465 form)
471 "Evaluate defun that point is in or before.
472 The value is displayed in the minibuffer.
473 If the current defun is actually a call to `defvar',
474 then reset the variable using the initial value expression
475 even if the variable already has some other value.
476 \(Normally `defvar' does not change the variable's value
477 if it already has a value.\)
479 With argument, insert value in current buffer after the defun.
480 Return the result of evaluation."
486 ;; Arrange for eval-region to "read" the (possibly) altered form.
487 ;; eval-region handles recording which file defines a function or
488 ;; variable. Re-written using `apply' to avoid capturing
489 ;; variables like `end'.
491 #'eval-region
493 beg end form)
494 ;; Read the form from the buffer, and record where it ends.
501 ;; Alter the form if necessary, changing defvar into defconst, etc.
505 ;; Skipping to the end of the specified region
506 ;; will make eval-region return.
509 ;; The result of evaluation has been put onto VALUES. So return it.
513 "Evaluate the top-level form containing point, or after point.
515 If the current defun is actually a call to `defvar', then reset the
516 variable using its initial value expression even if the variable
517 already has some other value. (Normally `defvar' does not change the
518 variable's value if it already has a value.)
520 With a prefix argument, instrument the code for Edebug.
522 If acting on a `defun' for FUNCTION, and the function was
523 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
524 instrumented, just FUNCTION is printed.
526 If not acting on a `defun', the result of evaluation is displayed in
527 the minibuffer. This display is controlled by the variables
528 `eval-expression-print-length' and `eval-expression-print-level',
529 which see."
543 value)))))
554 comment-column))))
572 "Indent current line as Lisp code.
573 With argument, indent any additional lines of the same expression
574 rigidly along with this one."
582 ;; Don't alter indentation of a ;;; comment line
583 ;; or a line that starts in a string.
586 ;; Single-semicolon comment lines should be indented
587 ;; as comment lines, not as code.
592 nil
595 ;; If initial point was within line's indentation,
596 ;; position after the indentation. Else stay at same point in text.
599 ;; If desired, shift remaining lines of expression the same amount.
614 "Return appropriate indentation for current line as Lisp code.
615 In usual case returns an integer: the column to indent to.
616 If the value is nil, that means don't change the indentation
617 because the line starts inside a string.
619 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
620 This means that following lines at the same level of indentation
621 should not necessarily be indented the same as this line.
622 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
623 is the buffer position of the start of the containing expression."
627 state paren-depth
628 ;; setting this to a number inhibits calling hook
631 calculate-lisp-indent-last-sexp containing-sexp)
635 ;; Find outermost containing sexp
638 ;; Find innermost containing sexp
640 state
645 ;; Position following last unclosed open.
647 ;; Is there a complete sexp since then?
650 ;; Yes, but is there a containing sexp after that?
655 nil
656 ;; Innermost containing sexp found
659 ;; indent-point immediately follows open paren.
660 ;; Don't call hook.
662 ;; Find the start of first element of containing sexp.
665 ;; First element of containing sexp is a list.
666 ;; Indent under that list.
667 )
669 calculate-lisp-indent-last-sexp)
670 ;; This is the first line to start within the containing sexp.
671 ;; It's almost certainly a function call.
673 ;; Containing sexp has nothing before this line
674 ;; except the first element. Indent under that element.
675 nil
676 ;; Skip the first element, find start of second (the first
677 ;; argument of the function call) and indent under.
680 calculate-lisp-indent-last-sexp
684 ;; Indent beneath first sexp on same line as
685 ;; `calculate-lisp-indent-last-sexp'. Again, it's
686 ;; almost certainly a function call.
692 ;; Point is at the point to indent under unless we are inside a string.
693 ;; Call indentation hook except when overridden by lisp-indent-offset
694 ;; or if the desired indentation has already been computed.
697 ;; Inside a string, don't change indentation.
698 nil)
700 ;; Indent by constant offset
705 lisp-indent-function
708 normal-indent))
710 normal-indent))))))
718 ;; car of form doesn't seem to be a a symbol
721 calculate-lisp-indent-last-sexp))
726 ;; Indent under the list or under the first sexp on the same
727 ;; line as calculate-lisp-indent-last-sexp. Note that first
728 ;; thing on that line has to be complete sexp since we are
729 ;; inside the innermost containing sexp.
734 method)
744 indent-point normal-indent))
754 body-indent containing-form-column)
755 ;; Move to the start of containing form, calculate indentation
756 ;; to use for non-distinguished forms (> count), and move past the
757 ;; function symbol. lisp-indent-function guarantees that there is at
758 ;; least one word or symbol character following open paren of containing
759 ;; form.
765 ;; Now find the start of the last form.
774 ;; Point is sitting on first character of last (or count) sexp.
776 ;; A distinguished form. If it is the first or second form use double
777 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
778 ;; to 2 (the default), this just happens to work the same with if as
779 ;; the older code, but it makes unwind-protect, condition-case,
780 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
781 ;; less hacked, behavior can be obtained by replacing below with
782 ;; (list normal-indent containing-form-start).
785 containing-form-start)
787 ;; A non-distinguished form. Use body-indent if there are no
788 ;; distinguished forms and this is the first undistinguished form,
789 ;; or if this is the first undistinguished form and the preceding
790 ;; distinguished form has indentation at least as great as body-indent.
793 body-indent
794 normal-indent))))
805 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
806 ;; like defun if the first form is placed on the next line, otherwise
807 ;; it is indented like any other form (i.e. forms line up under first).
842 "Indent each line of the list starting just after point.
843 If optional arg ENDPOS is given, indent each line, stopping when
844 ENDPOS is encountered."
848 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
849 ;; so that calculate-lisp-indent will find the beginning of
850 ;; the defun we are in.
851 ;; If ENDPOS is nil, it is safe not to scan before point
852 ;; since every line we indent is more deeply nested than point is.
855 last-depth bol outer-loop-done inner-loop-done state this-indent)
857 ;; Get error now if we don't have a complete sexp after point.
864 inner-loop-done nil)
865 ;; Parse this line so we can learn the state
866 ;; to indent the next line.
867 ;; This inner loop goes through only once
868 ;; unless a line ends inside a string.
872 nil nil state))
874 ;; If the line contains a comment other than the sort
875 ;; that is indented like code,
876 ;; indent it now with indent-for-comment.
877 ;; Comments indented like code are right already.
878 ;; In any case clear the in-comment flag in the state
879 ;; because parse-partial-sexp never sees the newlines.
884 ;; If this line ends inside a string,
885 ;; go straight to next line, remaining within the inner loop,
886 ;; and turn off the \-flag.
909 ;; Now go to the next line and indent it according
910 ;; to what we learned from parsing the previous one.
914 ;; But not if the line is blank, or just a comment
915 ;; (except for double-semi comments; indent them as usual).
917 nil
923 starting-point))))
939 "Indent every line whose first char is between START and END inclusive."
948 ;;;; Lisp paragraph filling commands.
952 If any of the current line is a comment, fill the comment or the
953 paragraph of it that point is in, preserving the comment's indentation
954 and initial semicolons."
957 ;; Non-nil if the current line contains a comment.
958 has-comment
960 ;; Non-nil if the current line contains code and a comment.
961 has-code-and-comment
963 ;; If has-comment, the appropriate fill-prefix for the comment.
964 comment-fill-prefix
965 )
967 ;; Figure out what kind of comment we are looking at.
972 ;; A line with nothing but a comment on it?
978 ;; A line with some code, followed by a comment? Remember that the
979 ;; semi which starts the comment shouldn't be part of a string or
980 ;; character.
999 ;; `paragraph-start' is set here (not in the buffer-local
1000 ;; variable so that `forward-paragraph' et al work as
1001 ;; expected) so that filling (doc) strings works sensibly.
1002 ;; Adding the opening paren to avoid the following sexp being
1003 ;; filled means that sexps generally aren't filled as normal
1004 ;; text, which is probably sensible. The `;' and `:' stop the
1005 ;; filled para at following comment lines and keywords
1006 ;; (typically in `defcustom').
1011 ;; Narrow to include only the comment, and then fill the region.
1016 ;; Find the first line we should include in the region to fill.
1020 ;; We may have gone too far. Go forward again.
1024 ;; Find the beginning of the first line past the region to fill.
1030 ;; Lines with only semicolons on them can be paragraph boundaries.
1042 ;; If this comment starts on a line with code,
1043 ;; include that like in the filling.
1049 justify nil
1053 nil
1056 t))
1059 "Indent all lines of code, starting in the region, sideways by ARG columns.
1060 Does not affect lines starting inside comments or strings, assuming that
1061 the start of the region is not inside them.
1063 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1064 The last is a regexp which, if matched at the beginning of a line,
1065 means don't indent that line."
1076 nil nil state)))
1081 ;; If line does not start in string, indent it
1089 nil nil state))))))
1093 ;;; lisp-mode.el ends here