| blob | f060563f17570947effe4473ece7d02f3b918e63 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands.
3 ;; Copyright (C) 1985 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
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 ;;; Code:
26 ;;; Commentary:
28 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
29 ;; This mode is documented in the Emacs manual
31 ;;; Code:
63 ;; Used to be singlequote; changed for flonums.
106 \f
111 ()
119 "Keymap for Emacs Lisp mode.
123 ()
130 "Major mode for editing Lisp code to run in Emacs.
131 Commands:
132 Delete converts tabs to spaces as it moves back.
133 Blank lines separate paragraphs. Semicolons start comments.
135 Entry to this mode calls the value of `emacs-lisp-mode-hook'
136 if that value is non-nil."
147 "Keymap for ordinary Lisp mode.
151 ()
158 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
159 Commands:
160 Delete converts tabs to spaces as it moves back.
161 Blank lines separate paragraphs. Semicolons start comments.
163 Note that `run-lisp' may be used either to start an inferior Lisp job
164 or to switch back to an existing one.
166 Entry to this mode calls the value of `lisp-mode-hook'
167 if that value is non-nil."
177 ;; This will do unless shell.el is loaded.
184 "Keymap for Lisp Interaction moe.
188 ()
196 "Major mode for typing and evaluating Lisp forms.
198 before point, and prints its value into the buffer, advancing point.
200 Commands:
201 Delete converts tabs to spaces as it moves back.
202 Paragraphs are separated only by blank lines.
203 Semicolons start comments.
205 Entry to this mode calls the value of `lisp-interaction-mode-hook'
206 if that value is non-nil."
217 "Evaluate sexp before point; print value into current buffer."
223 \f
225 "Evaluate sexp before point; print value in minibuffer.
226 With argument, print output into current buffer."
241 "Evaluate defun that point is in or before.
242 Print value in minibuffer.
243 With argument, insert value in current buffer after the defun."
250 \f
259 comment-column))))
265 "Indent current line as Lisp code.
266 With argument, indent any additional lines of the same expression
267 rigidly along with this one."
275 ;; Don't alter indentation of a ;;; comment line.
278 ;; Single-semicolon comment lines should be indented
279 ;; as comment lines, not as code.
284 nil
287 ;; If initial point was within line's indentation,
288 ;; position after the indentation. Else stay at same point in text.
291 ;; If desired, shift remaining lines of expression the same amount.
304 "Return appropriate indentation for current line as Lisp code.
305 In usual case returns an integer: the column to indent to.
306 Can instead return a list, whose car is the column to indent to.
307 This means that following lines at the same level of indentation
308 should not necessarily be indented the same way.
309 The second element of the list is the buffer position
310 of the start of the containing expression."
314 state paren-depth
315 ;; setting this to a number inhibits calling hook
318 last-sexp containing-sexp)
322 ;; Find outermost containing sexp
325 ;; Find innermost containing sexp
327 state
332 ;; Position following last unclosed open.
334 ;; Is there a complete sexp since then?
336 ;; Yes, but is there a containing sexp after that?
340 nil
341 ;; Innermost containing sexp found
344 ;; indent-point immediately follows open paren.
345 ;; Don't call hook.
347 ;; Find the start of first element of containing sexp.
350 ;; First element of containing sexp is a list.
351 ;; Indent under that list.
352 )
354 last-sexp)
355 ;; This is the first line to start within the containing sexp.
356 ;; It's almost certainly a function call.
358 ;; Containing sexp has nothing before this line
359 ;; except the first element. Indent under that element.
360 nil
361 ;; Skip the first element, find start of second (the first
362 ;; argument of the function call) and indent under.
367 ;; Indent beneath first sexp on same line as last-sexp.
368 ;; Again, it's almost certainly a function call.
373 ;; Point is at the point to indent under unless we are inside a string.
374 ;; Call indentation hook except when overridden by lisp-indent-offset
375 ;; or if the desired indentation has already been computed.
378 ;; Inside a string, don't change indentation.
383 ;; Indent by constant offset
388 lisp-indent-function
391 normal-indent))
393 normal-indent))))))
401 ;; car of form doesn't seem to be a a symbol
404 last-sexp))
408 ;; Indent under the list or under the first sexp on the
409 ;; same line as last-sexp. Note that first thing on that
410 ;; line has to be complete sexp since we are inside the
411 ;; innermost containing sexp.
416 method)
426 indent-point normal-indent))
436 body-indent containing-form-column)
437 ;; Move to the start of containing form, calculate indentation
438 ;; to use for non-distinguished forms (> count), and move past the
439 ;; function symbol. lisp-indent-function guarantees that there is at
440 ;; least one word or symbol character following open paren of containing
441 ;; form.
447 ;; Now find the start of the last form.
456 ;; Point is sitting on first character of last (or count) sexp.
458 ;; A distinguished form. If it is the first or second form use double
459 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
460 ;; to 2 (the default), this just happens to work the same with if as
461 ;; the older code, but it makes unwind-protect, condition-case,
462 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
463 ;; less hacked, behavior can be obtained by replacing below with
464 ;; (list normal-indent containing-form-start).
467 containing-form-start)
469 ;; A non-distinguished form. Use body-indent if there are no
470 ;; distinguished forms and this is the first undistinguished form,
471 ;; or if this is the first undistinguished form and the preceding
472 ;; distinguished form has indentation at least as great as body-indent.
475 body-indent
476 normal-indent))))
486 \f
487 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
488 ;; like defun if the first form is placed on the next line, otherwise
489 ;; it is indented like any other form (i.e. forms line up under first).
510 "Indent each line of the list starting just after point.
511 If optional arg ENDPOS is given, indent each line, stopping when
512 ENDPOS is encountered."
518 last-depth bol outer-loop-done inner-loop-done state this-indent)
519 ;; Get error now if we don't have a complete sexp after point.
526 inner-loop-done nil)
527 ;; Parse this line so we can learn the state
528 ;; to indent the next line.
529 ;; This inner loop goes through only once
530 ;; unless a line ends inside a string.
534 nil nil state))
536 ;; If the line contains a comment other than the sort
537 ;; that is indented like code,
538 ;; indent it now with indent-for-comment.
539 ;; Comments indented like code are right already.
540 ;; In any case clear the in-comment flag in the state
541 ;; because parse-partial-sexp never sees the newlines.
546 ;; If this line ends inside a string,
547 ;; go straight to next line, remaining within the inner loop,
548 ;; and turn off the \-flag.
571 ;; Now go to the next line and indent it according
572 ;; to what we learned from parsing the previous one.
576 ;; But not if the line is blank, or just a comment
577 ;; (except for double-semi comments; indent them as usual).
579 nil
585 starting-point))))
598 ;; Indent every line whose first char is between START and END inclusive.
607 \f
608 ;;;; Lisp paragraph filling commands.
612 If any of the current line is a comment, fill the comment or the
613 paragraph of it that point is in, preserving the comment's indentation
614 and initial semicolons."
617 ;; Non-nil if the current line contains a comment.
618 has-comment
620 ;; If has-comment, the appropriate fill-prefix for the comment.
621 comment-fill-prefix
622 )
624 ;; Figure out what kind of comment we are looking at.
629 ;; A line with nothing but a comment on it?
635 ;; A line with some code, followed by a comment? Remember that the
636 ;; semi which starts the comment shouldn't be part of a string or
637 ;; character.
653 ;; Narrow to include only the comment, and then fill the region.
656 ;; Find the first line we should include in the region to fill.
660 ;; We may have gone to far. Go forward again.
664 ;; Find the beginning of the first line past the region to fill.
670 ;; Lines with only semicolons on them can be paragraph boundaries.
676 \f
678 "Indent all lines of code, starting in the region, sideways by ARG columns.
679 Does not affect lines starting inside comments or strings, assuming that
680 the start of the region is not inside them.
682 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
683 The last is a regexp which, if matched at the beginning of a line,
684 means don't indent that line."
695 nil nil state)))
700 ;; If line does not start in string, indent it
708 nil nil state))))))
712 ;;; lisp-mode.el ends here