| blob | ebdee0673eebb5b4e5b181ced8df5e902bf62841 |
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."
336 \f
345 comment-column))))
351 "Indent current line as Lisp code.
352 With argument, indent any additional lines of the same expression
353 rigidly along with this one."
361 ;; Don't alter indentation of a ;;; comment line
362 ;; or a line that starts in a string.
365 ;; Single-semicolon comment lines should be indented
366 ;; as comment lines, not as code.
371 nil
374 ;; If initial point was within line's indentation,
375 ;; position after the indentation. Else stay at same point in text.
378 ;; If desired, shift remaining lines of expression the same amount.
393 "Return appropriate indentation for current line as Lisp code.
394 In usual case returns an integer: the column to indent to.
395 If the value is nil, that means don't change the indentation
396 because the line starts inside a string.
398 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
399 This means that following lines at the same level of indentation
400 should not necessarily be indented the same as this line.
401 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
402 is the buffer position of the start of the containing expression."
406 state paren-depth
407 ;; setting this to a number inhibits calling hook
410 calculate-lisp-indent-last-sexp containing-sexp)
414 ;; Find outermost containing sexp
417 ;; Find innermost containing sexp
419 state
424 ;; Position following last unclosed open.
426 ;; Is there a complete sexp since then?
429 ;; Yes, but is there a containing sexp after that?
434 nil
435 ;; Innermost containing sexp found
438 ;; indent-point immediately follows open paren.
439 ;; Don't call hook.
441 ;; Find the start of first element of containing sexp.
444 ;; First element of containing sexp is a list.
445 ;; Indent under that list.
446 )
448 calculate-lisp-indent-last-sexp)
449 ;; This is the first line to start within the containing sexp.
450 ;; It's almost certainly a function call.
452 ;; Containing sexp has nothing before this line
453 ;; except the first element. Indent under that element.
454 nil
455 ;; Skip the first element, find start of second (the first
456 ;; argument of the function call) and indent under.
459 calculate-lisp-indent-last-sexp
463 ;; Indent beneath first sexp on same line as
464 ;; calculate-lisp-indent-last-sexp. Again, it's
465 ;; almost certainly a function call.
471 ;; Point is at the point to indent under unless we are inside a string.
472 ;; Call indentation hook except when overridden by lisp-indent-offset
473 ;; or if the desired indentation has already been computed.
476 ;; Inside a string, don't change indentation.
477 nil)
479 ;; Indent by constant offset
484 lisp-indent-function
487 normal-indent))
489 normal-indent))))))
497 ;; car of form doesn't seem to be a a symbol
500 calculate-lisp-indent-last-sexp))
505 ;; Indent under the list or under the first sexp on the same
506 ;; line as calculate-lisp-indent-last-sexp. Note that first
507 ;; thing on that line has to be complete sexp since we are
508 ;; inside the innermost containing sexp.
513 method)
523 indent-point normal-indent))
533 body-indent containing-form-column)
534 ;; Move to the start of containing form, calculate indentation
535 ;; to use for non-distinguished forms (> count), and move past the
536 ;; function symbol. lisp-indent-function guarantees that there is at
537 ;; least one word or symbol character following open paren of containing
538 ;; form.
544 ;; Now find the start of the last form.
553 ;; Point is sitting on first character of last (or count) sexp.
555 ;; A distinguished form. If it is the first or second form use double
556 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
557 ;; to 2 (the default), this just happens to work the same with if as
558 ;; the older code, but it makes unwind-protect, condition-case,
559 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
560 ;; less hacked, behavior can be obtained by replacing below with
561 ;; (list normal-indent containing-form-start).
564 containing-form-start)
566 ;; A non-distinguished form. Use body-indent if there are no
567 ;; distinguished forms and this is the first undistinguished form,
568 ;; or if this is the first undistinguished form and the preceding
569 ;; distinguished form has indentation at least as great as body-indent.
572 body-indent
573 normal-indent))))
583 \f
584 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
585 ;; like defun if the first form is placed on the next line, otherwise
586 ;; it is indented like any other form (i.e. forms line up under first).
615 "Indent each line of the list starting just after point.
616 If optional arg ENDPOS is given, indent each line, stopping when
617 ENDPOS is encountered."
621 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
622 ;; so that calculate-lisp-indent will find the beginning of
623 ;; the defun we are in.
624 ;; If ENDPOS is nil, it is safe not to scan before point
625 ;; since every line we indent is more deeply nested than point is.
628 last-depth bol outer-loop-done inner-loop-done state this-indent)
630 ;; Get error now if we don't have a complete sexp after point.
637 inner-loop-done nil)
638 ;; Parse this line so we can learn the state
639 ;; to indent the next line.
640 ;; This inner loop goes through only once
641 ;; unless a line ends inside a string.
645 nil nil state))
647 ;; If the line contains a comment other than the sort
648 ;; that is indented like code,
649 ;; indent it now with indent-for-comment.
650 ;; Comments indented like code are right already.
651 ;; In any case clear the in-comment flag in the state
652 ;; because parse-partial-sexp never sees the newlines.
657 ;; If this line ends inside a string,
658 ;; go straight to next line, remaining within the inner loop,
659 ;; and turn off the \-flag.
682 ;; Now go to the next line and indent it according
683 ;; to what we learned from parsing the previous one.
687 ;; But not if the line is blank, or just a comment
688 ;; (except for double-semi comments; indent them as usual).
690 nil
696 starting-point))))
711 ;; Indent every line whose first char is between START and END inclusive.
720 \f
721 ;;;; Lisp paragraph filling commands.
725 If any of the current line is a comment, fill the comment or the
726 paragraph of it that point is in, preserving the comment's indentation
727 and initial semicolons."
730 ;; Non-nil if the current line contains a comment.
731 has-comment
733 ;; Non-nil if the current line contains code and a comment.
734 has-code-and-comment
736 ;; If has-comment, the appropriate fill-prefix for the comment.
737 comment-fill-prefix
738 )
740 ;; Figure out what kind of comment we are looking at.
745 ;; A line with nothing but a comment on it?
751 ;; A line with some code, followed by a comment? Remember that the
752 ;; semi which starts the comment shouldn't be part of a string or
753 ;; character.
774 ;; Narrow to include only the comment, and then fill the region.
779 ;; Find the first line we should include in the region to fill.
783 ;; We may have gone too far. Go forward again.
787 ;; Find the beginning of the first line past the region to fill.
793 ;; Lines with only semicolons on them can be paragraph boundaries.
805 ;; If this comment starts on a line with code,
806 ;; include that like in the filling.
812 justify nil
816 nil
819 t))
820 \f
822 "Indent all lines of code, starting in the region, sideways by ARG columns.
823 Does not affect lines starting inside comments or strings, assuming that
824 the start of the region is not inside them.
826 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
827 The last is a regexp which, if matched at the beginning of a line,
828 means don't indent that line."
839 nil nil state)))
844 ;; If line does not start in string, indent it
852 nil nil state))))))
856 ;;; lisp-mode.el ends here