| blob | f7484c8e712e5b4f4864adf1f13b221241931050 |
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands.
3 ;; Copyright (C) 1985, 1986, 1999 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:
58 ;; Give CR the same syntax as newline, for selective-display.
64 ;; Used to be singlequote; changed for flonums.
73 ;; All non-word multibyte characters should be `symbol'.
79 emacs-lisp-mode-syntax-table))))
92 '(
115 ;; Adaptive fill mode gets in the way of auto-fill,
116 ;; and should make no difference for explicit fill
117 ;; because lisp-fill-paragraph should do the job.
133 ;; Look within the line for a ; following an even number of backslashes
134 ;; after either a non-backslash or the line beginning.
142 \f
147 ()
153 "Keymap for Emacs Lisp mode.
157 ()
187 "Byte compile the file containing the current buffer."
194 "Byte-compile the current file (if it has changed), then load compiled code."
199 ;; Recompile if file or buffer has changed since last compilation.
209 "Major mode for editing Lisp code to run in Emacs.
210 Commands:
211 Delete converts tabs to spaces as it moves back.
212 Blank lines separate paragraphs. Semicolons start comments.
214 Entry to this mode calls the value of `emacs-lisp-mode-hook'
215 if that value is non-nil."
227 "Keymap for ordinary Lisp mode.
231 ()
238 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
239 Commands:
240 Delete converts tabs to spaces as it moves back.
241 Blank lines separate paragraphs. Semicolons start comments.
243 Note that `run-lisp' may be used either to start an inferior Lisp job
244 or to switch back to an existing one.
246 Entry to this mode calls the value of `lisp-mode-hook'
247 if that value is non-nil."
258 ;; This will do unless shell.el is loaded.
265 "Keymap for Lisp Interaction mode.
269 ()
277 "Major mode for typing and evaluating Lisp forms.
279 before point, and prints its value into the buffer, advancing point.
281 Commands:
282 Delete converts tabs to spaces as it moves back.
283 Paragraphs are separated only by blank lines.
284 Semicolons start comments.
286 Entry to this mode calls the value of `lisp-interaction-mode-hook'
287 if that value is non-nil."
298 "Evaluate sexp before point; print value into current buffer."
304 \f
306 "Evaluate sexp before point; print value in minibuffer.
307 With argument, print output into current buffer."
312 ignore-quotes
313 expr)
317 ;; If this sexp appears to be enclosed in `...'
318 ;; then ignore the surrounding quotes.
324 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
325 ;; `variable' so that the value is returned, not the
326 ;; name
332 ;; If it's an (interactive ...) form, it's more
333 ;; useful to show how an interactive call would
334 ;; use it.
342 expr
344 expr))
348 "Evaluate defun that point is in or before.
349 The value is displayed in the minibuffer.
350 If the current defun is actually a call to `defvar',
351 then reset the variable using the initial value expression
352 even if the variable already has some other value.
353 \(Normally `defvar' does not change the variable's value
354 if it already has a value.\)
356 With argument, insert value in current buffer after the defun.
357 Return the result of evaluation."
360 ;; Arrange for eval-region to "read" the (possibly) altered form.
361 ;; eval-region handles recording which file defines a function or
362 ;; variable. Re-written using `apply' to avoid capturing
363 ;; variables like `end'.
365 #'eval-region
367 beg end form)
368 ;; Read the form from the buffer, and record where it ends.
375 ;; Alter the form if necessary.
378 ;; Force variable to be bound.
382 ;; Force variable to be bound.
386 ;; Skipping to the end of the specified region
387 ;; will make eval-region return.
390 ;; The result of evaluation has been put onto VALUES. So return it.
392 \f
401 comment-column))))
418 "Indent current line as Lisp code.
419 With argument, indent any additional lines of the same expression
420 rigidly along with this one."
428 ;; Don't alter indentation of a ;;; comment line
429 ;; or a line that starts in a string.
432 ;; Single-semicolon comment lines should be indented
433 ;; as comment lines, not as code.
438 nil
441 ;; If initial point was within line's indentation,
442 ;; position after the indentation. Else stay at same point in text.
445 ;; If desired, shift remaining lines of expression the same amount.
460 "Return appropriate indentation for current line as Lisp code.
461 In usual case returns an integer: the column to indent to.
462 If the value is nil, that means don't change the indentation
463 because the line starts inside a string.
465 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
466 This means that following lines at the same level of indentation
467 should not necessarily be indented the same as this line.
468 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
469 is the buffer position of the start of the containing expression."
473 state paren-depth
474 ;; setting this to a number inhibits calling hook
477 calculate-lisp-indent-last-sexp containing-sexp)
481 ;; Find outermost containing sexp
484 ;; Find innermost containing sexp
486 state
491 ;; Position following last unclosed open.
493 ;; Is there a complete sexp since then?
496 ;; Yes, but is there a containing sexp after that?
501 nil
502 ;; Innermost containing sexp found
505 ;; indent-point immediately follows open paren.
506 ;; Don't call hook.
508 ;; Find the start of first element of containing sexp.
511 ;; First element of containing sexp is a list.
512 ;; Indent under that list.
513 )
515 calculate-lisp-indent-last-sexp)
516 ;; This is the first line to start within the containing sexp.
517 ;; It's almost certainly a function call.
519 ;; Containing sexp has nothing before this line
520 ;; except the first element. Indent under that element.
521 nil
522 ;; Skip the first element, find start of second (the first
523 ;; argument of the function call) and indent under.
526 calculate-lisp-indent-last-sexp
530 ;; Indent beneath first sexp on same line as
531 ;; calculate-lisp-indent-last-sexp. Again, it's
532 ;; almost certainly a function call.
538 ;; Point is at the point to indent under unless we are inside a string.
539 ;; Call indentation hook except when overridden by lisp-indent-offset
540 ;; or if the desired indentation has already been computed.
543 ;; Inside a string, don't change indentation.
544 nil)
546 ;; Indent by constant offset
551 lisp-indent-function
554 normal-indent))
556 normal-indent))))))
564 ;; car of form doesn't seem to be a a symbol
567 calculate-lisp-indent-last-sexp))
572 ;; Indent under the list or under the first sexp on the same
573 ;; line as calculate-lisp-indent-last-sexp. Note that first
574 ;; thing on that line has to be complete sexp since we are
575 ;; inside the innermost containing sexp.
580 method)
590 indent-point normal-indent))
600 body-indent containing-form-column)
601 ;; Move to the start of containing form, calculate indentation
602 ;; to use for non-distinguished forms (> count), and move past the
603 ;; function symbol. lisp-indent-function guarantees that there is at
604 ;; least one word or symbol character following open paren of containing
605 ;; form.
611 ;; Now find the start of the last form.
620 ;; Point is sitting on first character of last (or count) sexp.
622 ;; A distinguished form. If it is the first or second form use double
623 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
624 ;; to 2 (the default), this just happens to work the same with if as
625 ;; the older code, but it makes unwind-protect, condition-case,
626 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
627 ;; less hacked, behavior can be obtained by replacing below with
628 ;; (list normal-indent containing-form-start).
631 containing-form-start)
633 ;; A non-distinguished form. Use body-indent if there are no
634 ;; distinguished forms and this is the first undistinguished form,
635 ;; or if this is the first undistinguished form and the preceding
636 ;; distinguished form has indentation at least as great as body-indent.
639 body-indent
640 normal-indent))))
650 \f
651 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
652 ;; like defun if the first form is placed on the next line, otherwise
653 ;; it is indented like any other form (i.e. forms line up under first).
683 "Indent each line of the list starting just after point.
684 If optional arg ENDPOS is given, indent each line, stopping when
685 ENDPOS is encountered."
689 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
690 ;; so that calculate-lisp-indent will find the beginning of
691 ;; the defun we are in.
692 ;; If ENDPOS is nil, it is safe not to scan before point
693 ;; since every line we indent is more deeply nested than point is.
696 last-depth bol outer-loop-done inner-loop-done state this-indent)
698 ;; Get error now if we don't have a complete sexp after point.
705 inner-loop-done nil)
706 ;; Parse this line so we can learn the state
707 ;; to indent the next line.
708 ;; This inner loop goes through only once
709 ;; unless a line ends inside a string.
713 nil nil state))
715 ;; If the line contains a comment other than the sort
716 ;; that is indented like code,
717 ;; indent it now with indent-for-comment.
718 ;; Comments indented like code are right already.
719 ;; In any case clear the in-comment flag in the state
720 ;; because parse-partial-sexp never sees the newlines.
725 ;; If this line ends inside a string,
726 ;; go straight to next line, remaining within the inner loop,
727 ;; and turn off the \-flag.
750 ;; Now go to the next line and indent it according
751 ;; to what we learned from parsing the previous one.
755 ;; But not if the line is blank, or just a comment
756 ;; (except for double-semi comments; indent them as usual).
758 nil
764 starting-point))))
779 ;; Indent every line whose first char is between START and END inclusive.
788 \f
789 ;;;; Lisp paragraph filling commands.
793 If any of the current line is a comment, fill the comment or the
794 paragraph of it that point is in, preserving the comment's indentation
795 and initial semicolons."
798 ;; Non-nil if the current line contains a comment.
799 has-comment
801 ;; Non-nil if the current line contains code and a comment.
802 has-code-and-comment
804 ;; If has-comment, the appropriate fill-prefix for the comment.
805 comment-fill-prefix
806 )
808 ;; Figure out what kind of comment we are looking at.
813 ;; A line with nothing but a comment on it?
819 ;; A line with some code, followed by a comment? Remember that the
820 ;; semi which starts the comment shouldn't be part of a string or
821 ;; character.
840 ;; `paragraph-start' is set here (not in the buffer-local
841 ;; variable so that `forward-paragraph' et al work as
842 ;; expected) so that filling (doc) strings works sensibly.
843 ;; Adding the opening paren to avoid the following sexp being
844 ;; filled means that sexps generally aren't filled as normal
845 ;; text, which is probably sensible. The `;' and `:' stop the
846 ;; filled para at following comment lines and keywords
847 ;; (typically in `defcustom').
852 ;; Narrow to include only the comment, and then fill the region.
857 ;; Find the first line we should include in the region to fill.
861 ;; We may have gone too far. Go forward again.
865 ;; Find the beginning of the first line past the region to fill.
871 ;; Lines with only semicolons on them can be paragraph boundaries.
883 ;; If this comment starts on a line with code,
884 ;; include that like in the filling.
890 justify nil
894 nil
897 t))
898 \f
900 "Indent all lines of code, starting in the region, sideways by ARG columns.
901 Does not affect lines starting inside comments or strings, assuming that
902 the start of the region is not inside them.
904 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
905 The last is a regexp which, if matched at the beginning of a line,
906 means don't indent that line."
917 nil nil state)))
922 ;; If line does not start in string, indent it
930 nil nil state))))))
934 ;;; lisp-mode.el ends here