| blob | 718cc35d06a5210bee7dcc3710b76b5e297ae7dc |
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.
143 "Lisp mode `outline-level' function."
145 1000
149 \f
154 ()
160 "Keymap for Emacs Lisp mode.
164 ()
194 "Byte compile the file containing the current buffer."
201 "Byte-compile the current file (if it has changed), then load compiled code."
206 ;; Recompile if file or buffer has changed since last compilation.
216 "Hook run when entering Emacs Lisp mode."
222 "Hook run when entering Lisp mode."
228 "Hook run when entering Lisp Interaction mode."
234 "Major mode for editing Lisp code to run in Emacs.
235 Commands:
236 Delete converts tabs to spaces as it moves back.
237 Blank lines separate paragraphs. Semicolons start comments.
239 Entry to this mode calls the value of `emacs-lisp-mode-hook'
240 if that value is non-nil."
256 map)
257 "Keymap for ordinary Lisp mode.
261 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
262 Commands:
263 Delete converts tabs to spaces as it moves back.
264 Blank lines separate paragraphs. Semicolons start comments.
266 Note that `run-lisp' may be used either to start an inferior Lisp job
267 or to switch back to an existing one.
269 Entry to this mode calls the value of `lisp-mode-hook'
270 if that value is non-nil."
281 ;; This will do unless inf-lisp.el is loaded.
293 map)
294 "Keymap for Lisp Interaction mode.
298 "Major mode for typing and evaluating Lisp forms.
300 before point, and prints its value into the buffer, advancing point.
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'
308 if that value is non-nil."
319 "Evaluate sexp before point; print value into current buffer."
325 \f
327 "Evaluate sexp before point; print value in minibuffer.
328 With argument, print output into current buffer."
333 ignore-quotes
334 expr)
338 ;; If this sexp appears to be enclosed in `...'
339 ;; then ignore the surrounding quotes.
344 ;; If we were after `?\e' (or similar case),
345 ;; use the whole thing, not just the `e'.
351 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
352 ;; `variable' so that the value is returned, not the
353 ;; name
359 ;; If it's an (interactive ...) form, it's more
360 ;; useful to show how an interactive call would
361 ;; use it.
369 expr
371 expr))
378 "Evaluate sexp before point; print value in minibuffer.
379 With argument, print output into current buffer."
389 value)))
391 ;; Change defvar into defconst within FORM,
392 ;; and likewise for other constructs as necessary.
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 defun that point is in or before.
453 The value is displayed in the minibuffer.
454 If the current defun is actually a call to `defvar',
455 then reset the variable using the initial value expression
456 even if the variable already has some other value.
457 \(Normally `defvar' does not change the variable's value
458 if it already has a value.\)
460 With argument, insert value in current buffer after the defun.
461 Return the result of evaluation."
471 value)))
473 \f
482 comment-column))))
499 "Indent current line as Lisp code.
500 With argument, indent any additional lines of the same expression
501 rigidly along with this one."
509 ;; Don't alter indentation of a ;;; comment line
510 ;; or a line that starts in a string.
513 ;; Single-semicolon comment lines should be indented
514 ;; as comment lines, not as code.
519 nil
522 ;; If initial point was within line's indentation,
523 ;; position after the indentation. Else stay at same point in text.
526 ;; If desired, shift remaining lines of expression the same amount.
541 "Return appropriate indentation for current line as Lisp code.
542 In usual case returns an integer: the column to indent to.
543 If the value is nil, that means don't change the indentation
544 because the line starts inside a string.
546 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
547 This means that following lines at the same level of indentation
548 should not necessarily be indented the same as this line.
549 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
550 is the buffer position of the start of the containing expression."
554 state paren-depth
555 ;; setting this to a number inhibits calling hook
558 calculate-lisp-indent-last-sexp containing-sexp)
562 ;; Find outermost containing sexp
565 ;; Find innermost containing sexp
567 state
572 ;; Position following last unclosed open.
574 ;; Is there a complete sexp since then?
577 ;; Yes, but is there a containing sexp after that?
582 nil
583 ;; Innermost containing sexp found
586 ;; indent-point immediately follows open paren.
587 ;; Don't call hook.
589 ;; Find the start of first element of containing sexp.
592 ;; First element of containing sexp is a list.
593 ;; Indent under that list.
594 )
596 calculate-lisp-indent-last-sexp)
597 ;; This is the first line to start within the containing sexp.
598 ;; It's almost certainly a function call.
600 ;; Containing sexp has nothing before this line
601 ;; except the first element. Indent under that element.
602 nil
603 ;; Skip the first element, find start of second (the first
604 ;; argument of the function call) and indent under.
607 calculate-lisp-indent-last-sexp
611 ;; Indent beneath first sexp on same line as
612 ;; `calculate-lisp-indent-last-sexp'. Again, it's
613 ;; almost certainly a function call.
619 ;; Point is at the point to indent under unless we are inside a string.
620 ;; Call indentation hook except when overridden by lisp-indent-offset
621 ;; or if the desired indentation has already been computed.
624 ;; Inside a string, don't change indentation.
625 nil)
627 ;; Indent by constant offset
632 lisp-indent-function
635 normal-indent))
637 normal-indent))))))
645 ;; car of form doesn't seem to be a a symbol
648 calculate-lisp-indent-last-sexp))
653 ;; Indent under the list or under the first sexp on the same
654 ;; line as calculate-lisp-indent-last-sexp. Note that first
655 ;; thing on that line has to be complete sexp since we are
656 ;; inside the innermost containing sexp.
661 method)
671 indent-point normal-indent))
681 body-indent containing-form-column)
682 ;; Move to the start of containing form, calculate indentation
683 ;; to use for non-distinguished forms (> count), and move past the
684 ;; function symbol. lisp-indent-function guarantees that there is at
685 ;; least one word or symbol character following open paren of containing
686 ;; form.
692 ;; Now find the start of the last form.
701 ;; Point is sitting on first character of last (or count) sexp.
703 ;; A distinguished form. If it is the first or second form use double
704 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
705 ;; to 2 (the default), this just happens to work the same with if as
706 ;; the older code, but it makes unwind-protect, condition-case,
707 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
708 ;; less hacked, behavior can be obtained by replacing below with
709 ;; (list normal-indent containing-form-start).
712 containing-form-start)
714 ;; A non-distinguished form. Use body-indent if there are no
715 ;; distinguished forms and this is the first undistinguished form,
716 ;; or if this is the first undistinguished form and the preceding
717 ;; distinguished form has indentation at least as great as body-indent.
720 body-indent
721 normal-indent))))
731 \f
732 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
733 ;; like defun if the first form is placed on the next line, otherwise
734 ;; it is indented like any other form (i.e. forms line up under first).
769 "Indent each line of the list starting just after point.
770 If optional arg ENDPOS is given, indent each line, stopping when
771 ENDPOS is encountered."
775 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
776 ;; so that calculate-lisp-indent will find the beginning of
777 ;; the defun we are in.
778 ;; If ENDPOS is nil, it is safe not to scan before point
779 ;; since every line we indent is more deeply nested than point is.
782 last-depth bol outer-loop-done inner-loop-done state this-indent)
784 ;; Get error now if we don't have a complete sexp after point.
791 inner-loop-done nil)
792 ;; Parse this line so we can learn the state
793 ;; to indent the next line.
794 ;; This inner loop goes through only once
795 ;; unless a line ends inside a string.
799 nil nil state))
801 ;; If the line contains a comment other than the sort
802 ;; that is indented like code,
803 ;; indent it now with indent-for-comment.
804 ;; Comments indented like code are right already.
805 ;; In any case clear the in-comment flag in the state
806 ;; because parse-partial-sexp never sees the newlines.
811 ;; If this line ends inside a string,
812 ;; go straight to next line, remaining within the inner loop,
813 ;; and turn off the \-flag.
836 ;; Now go to the next line and indent it according
837 ;; to what we learned from parsing the previous one.
841 ;; But not if the line is blank, or just a comment
842 ;; (except for double-semi comments; indent them as usual).
844 nil
850 starting-point))))
866 "Indent every line whose first char is between START and END inclusive."
874 \f
875 ;;;; Lisp paragraph filling commands.
879 If any of the current line is a comment, fill the comment or the
880 paragraph of it that point is in, preserving the comment's indentation
881 and initial semicolons."
884 ;; Non-nil if the current line contains a comment.
885 has-comment
887 ;; Non-nil if the current line contains code and a comment.
888 has-code-and-comment
890 ;; If has-comment, the appropriate fill-prefix for the comment.
891 comment-fill-prefix
892 )
894 ;; Figure out what kind of comment we are looking at.
899 ;; A line with nothing but a comment on it?
905 ;; A line with some code, followed by a comment? Remember that the
906 ;; semi which starts the comment shouldn't be part of a string or
907 ;; character.
926 ;; `paragraph-start' is set here (not in the buffer-local
927 ;; variable so that `forward-paragraph' et al work as
928 ;; expected) so that filling (doc) strings works sensibly.
929 ;; Adding the opening paren to avoid the following sexp being
930 ;; filled means that sexps generally aren't filled as normal
931 ;; text, which is probably sensible. The `;' and `:' stop the
932 ;; filled para at following comment lines and keywords
933 ;; (typically in `defcustom').
938 ;; Narrow to include only the comment, and then fill the region.
943 ;; Find the first line we should include in the region to fill.
947 ;; We may have gone too far. Go forward again.
951 ;; Find the beginning of the first line past the region to fill.
957 ;; Lines with only semicolons on them can be paragraph boundaries.
969 ;; If this comment starts on a line with code,
970 ;; include that like in the filling.
976 justify nil
980 nil
983 t))
984 \f
986 "Indent all lines of code, starting in the region, sideways by ARG columns.
987 Does not affect lines starting inside comments or strings, assuming that
988 the start of the region is not inside them.
990 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
991 The last is a regexp which, if matched at the beginning of a line,
992 means don't indent that line."
1003 nil nil state)))
1008 ;; If line does not start in string, indent it
1016 nil nil state))))))
1020 ;;; lisp-mode.el ends here