| blob | be328b30329ab0b7c3e8b1e5c8e6b9001ce45ff7 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands.
3 ;; Copyright (C) 1985, 1986 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:
57 ;; Give CR the same syntax as newline, for selective-display.
63 ;; Used to be singlequote; changed for flonums.
83 '(
106 ;; Adaptive fill mode gets in the way of auto-fill,
107 ;; and should make no difference for explicit fill
108 ;; because lisp-fill-paragraph should do the job.
122 ;; Look within the line for a ; following an even number of backslashes
123 ;; after either a non-backslash or the line beginning.
131 \f
136 ()
142 "Keymap for Emacs Lisp mode.
146 ()
176 "Byte compile the file containing the current buffer."
183 "Byte-compile the current file (if it has changed), then load compiled code."
188 ;; Recompile if file or buffer has changed since last compilation.
198 "Major mode for editing Lisp code to run in Emacs.
199 Commands:
200 Delete converts tabs to spaces as it moves back.
201 Blank lines separate paragraphs. Semicolons start comments.
203 Entry to this mode calls the value of `emacs-lisp-mode-hook'
204 if that value is non-nil."
215 "Keymap for ordinary Lisp mode.
219 ()
226 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
227 Commands:
228 Delete converts tabs to spaces as it moves back.
229 Blank lines separate paragraphs. Semicolons start comments.
231 Note that `run-lisp' may be used either to start an inferior Lisp job
232 or to switch back to an existing one.
234 Entry to this mode calls the value of `lisp-mode-hook'
235 if that value is non-nil."
245 ;; This will do unless shell.el is loaded.
252 "Keymap for Lisp Interaction moe.
256 ()
264 "Major mode for typing and evaluating Lisp forms.
266 before point, and prints its value into the buffer, advancing point.
268 Commands:
269 Delete converts tabs to spaces as it moves back.
270 Paragraphs are separated only by blank lines.
271 Semicolons start comments.
273 Entry to this mode calls the value of `lisp-interaction-mode-hook'
274 if that value is non-nil."
285 "Evaluate sexp before point; print value into current buffer."
291 \f
293 "Evaluate sexp before point; print value in minibuffer.
294 With argument, print output into current buffer."
299 expr)
307 ;; If it's an (interactive ...) form, it's more
308 ;; useful to show how an interactive call would
309 ;; use it.
317 expr
319 expr))
323 "Evaluate defun that point is in or before.
324 Print value in minibuffer.
325 With argument, insert value in current buffer after the defun."
334 ;; Force variable to be bound.
338 ;; Force variable to be bound.
341 \f
350 comment-column))))
356 "Indent current line as Lisp code.
357 With argument, indent any additional lines of the same expression
358 rigidly along with this one."
366 ;; Don't alter indentation of a ;;; comment line
367 ;; or a line that starts in a string.
370 ;; Single-semicolon comment lines should be indented
371 ;; as comment lines, not as code.
376 nil
379 ;; If initial point was within line's indentation,
380 ;; position after the indentation. Else stay at same point in text.
383 ;; If desired, shift remaining lines of expression the same amount.
398 "Return appropriate indentation for current line as Lisp code.
399 In usual case returns an integer: the column to indent to.
400 If the value is nil, that means don't change the indentation
401 because the line starts inside a string.
403 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
404 This means that following lines at the same level of indentation
405 should not necessarily be indented the same as this line.
406 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
407 is the buffer position of the start of the containing expression."
411 state paren-depth
412 ;; setting this to a number inhibits calling hook
415 calculate-lisp-indent-last-sexp containing-sexp)
419 ;; Find outermost containing sexp
422 ;; Find innermost containing sexp
424 state
429 ;; Position following last unclosed open.
431 ;; Is there a complete sexp since then?
434 ;; Yes, but is there a containing sexp after that?
439 nil
440 ;; Innermost containing sexp found
443 ;; indent-point immediately follows open paren.
444 ;; Don't call hook.
446 ;; Find the start of first element of containing sexp.
449 ;; First element of containing sexp is a list.
450 ;; Indent under that list.
451 )
453 calculate-lisp-indent-last-sexp)
454 ;; This is the first line to start within the containing sexp.
455 ;; It's almost certainly a function call.
457 ;; Containing sexp has nothing before this line
458 ;; except the first element. Indent under that element.
459 nil
460 ;; Skip the first element, find start of second (the first
461 ;; argument of the function call) and indent under.
464 calculate-lisp-indent-last-sexp
468 ;; Indent beneath first sexp on same line as
469 ;; calculate-lisp-indent-last-sexp. Again, it's
470 ;; almost certainly a function call.
476 ;; Point is at the point to indent under unless we are inside a string.
477 ;; Call indentation hook except when overridden by lisp-indent-offset
478 ;; or if the desired indentation has already been computed.
481 ;; Inside a string, don't change indentation.
482 nil)
484 ;; Indent by constant offset
489 lisp-indent-function
492 normal-indent))
494 normal-indent))))))
502 ;; car of form doesn't seem to be a a symbol
505 calculate-lisp-indent-last-sexp))
510 ;; Indent under the list or under the first sexp on the same
511 ;; line as calculate-lisp-indent-last-sexp. Note that first
512 ;; thing on that line has to be complete sexp since we are
513 ;; inside the innermost containing sexp.
518 method)
528 indent-point normal-indent))
538 body-indent containing-form-column)
539 ;; Move to the start of containing form, calculate indentation
540 ;; to use for non-distinguished forms (> count), and move past the
541 ;; function symbol. lisp-indent-function guarantees that there is at
542 ;; least one word or symbol character following open paren of containing
543 ;; form.
549 ;; Now find the start of the last form.
558 ;; Point is sitting on first character of last (or count) sexp.
560 ;; A distinguished form. If it is the first or second form use double
561 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
562 ;; to 2 (the default), this just happens to work the same with if as
563 ;; the older code, but it makes unwind-protect, condition-case,
564 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
565 ;; less hacked, behavior can be obtained by replacing below with
566 ;; (list normal-indent containing-form-start).
569 containing-form-start)
571 ;; A non-distinguished form. Use body-indent if there are no
572 ;; distinguished forms and this is the first undistinguished form,
573 ;; or if this is the first undistinguished form and the preceding
574 ;; distinguished form has indentation at least as great as body-indent.
577 body-indent
578 normal-indent))))
588 \f
589 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
590 ;; like defun if the first form is placed on the next line, otherwise
591 ;; it is indented like any other form (i.e. forms line up under first).
620 "Indent each line of the list starting just after point.
621 If optional arg ENDPOS is given, indent each line, stopping when
622 ENDPOS is encountered."
626 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
627 ;; so that calculate-lisp-indent will find the beginning of
628 ;; the defun we are in.
629 ;; If ENDPOS is nil, it is safe not to scan before point
630 ;; since every line we indent is more deeply nested than point is.
633 last-depth bol outer-loop-done inner-loop-done state this-indent)
635 ;; Get error now if we don't have a complete sexp after point.
642 inner-loop-done nil)
643 ;; Parse this line so we can learn the state
644 ;; to indent the next line.
645 ;; This inner loop goes through only once
646 ;; unless a line ends inside a string.
650 nil nil state))
652 ;; If the line contains a comment other than the sort
653 ;; that is indented like code,
654 ;; indent it now with indent-for-comment.
655 ;; Comments indented like code are right already.
656 ;; In any case clear the in-comment flag in the state
657 ;; because parse-partial-sexp never sees the newlines.
662 ;; If this line ends inside a string,
663 ;; go straight to next line, remaining within the inner loop,
664 ;; and turn off the \-flag.
687 ;; Now go to the next line and indent it according
688 ;; to what we learned from parsing the previous one.
692 ;; But not if the line is blank, or just a comment
693 ;; (except for double-semi comments; indent them as usual).
695 nil
701 starting-point))))
716 ;; Indent every line whose first char is between START and END inclusive.
725 \f
726 ;;;; Lisp paragraph filling commands.
730 If any of the current line is a comment, fill the comment or the
731 paragraph of it that point is in, preserving the comment's indentation
732 and initial semicolons."
735 ;; Non-nil if the current line contains a comment.
736 has-comment
738 ;; Non-nil if the current line contains code and a comment.
739 has-code-and-comment
741 ;; If has-comment, the appropriate fill-prefix for the comment.
742 comment-fill-prefix
743 )
745 ;; Figure out what kind of comment we are looking at.
750 ;; A line with nothing but a comment on it?
756 ;; A line with some code, followed by a comment? Remember that the
757 ;; semi which starts the comment shouldn't be part of a string or
758 ;; character.
779 ;; Narrow to include only the comment, and then fill the region.
784 ;; Find the first line we should include in the region to fill.
788 ;; We may have gone too far. Go forward again.
792 ;; Find the beginning of the first line past the region to fill.
798 ;; Lines with only semicolons on them can be paragraph boundaries.
810 ;; If this comment starts on a line with code,
811 ;; include that like in the filling.
817 justify nil
821 nil
824 t))
825 \f
827 "Indent all lines of code, starting in the region, sideways by ARG columns.
828 Does not affect lines starting inside comments or strings, assuming that
829 the start of the region is not inside them.
831 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
832 The last is a regexp which, if matched at the beginning of a line,
833 means don't indent that line."
844 nil nil state)))
849 ;; If line does not start in string, indent it
857 nil nil state))))))
861 ;;; lisp-mode.el ends here