1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985-1986, 1999-2011 Free Software Foundation, Inc.
6 ;; Keywords: lisp, languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
27 ;; This mode is documented in the Emacs manual.
31 (defvar font-lock-comment-face
)
32 (defvar font-lock-doc-face
)
33 (defvar font-lock-keywords-case-fold-search
)
34 (defvar font-lock-string-face
)
36 (defvar lisp-mode-abbrev-table nil
)
38 (define-abbrev-table 'lisp-mode-abbrev-table
())
40 (defvar emacs-lisp-mode-syntax-table
41 (let ((table (make-syntax-table))
44 (modify-syntax-entry i
"_ " table
)
48 (modify-syntax-entry i
"_ " table
)
52 (modify-syntax-entry i
"_ " table
)
56 (modify-syntax-entry i
"_ " table
)
58 (modify-syntax-entry ?\s
" " table
)
59 ;; Non-break space acts as whitespace.
60 (modify-syntax-entry ?
\x8a0 " " table
)
61 (modify-syntax-entry ?
\t " " table
)
62 (modify-syntax-entry ?
\f " " table
)
63 (modify-syntax-entry ?
\n "> " table
)
64 ;; This is probably obsolete since nowadays such features use overlays.
65 ;; ;; Give CR the same syntax as newline, for selective-display.
66 ;; (modify-syntax-entry ?\^m "> " table)
67 (modify-syntax-entry ?\
; "< " table)
68 (modify-syntax-entry ?
` "' " table
)
69 (modify-syntax-entry ?
' "' " table
)
70 (modify-syntax-entry ?
, "' " table
)
71 (modify-syntax-entry ?
@ "' " table
)
72 ;; Used to be singlequote; changed for flonums.
73 (modify-syntax-entry ?.
"_ " table
)
74 (modify-syntax-entry ?
# "' " table
)
75 (modify-syntax-entry ?
\" "\" " table
)
76 (modify-syntax-entry ?
\\ "\\ " table
)
77 (modify-syntax-entry ?\
( "() " table
)
78 (modify-syntax-entry ?\
) ")( " table
)
79 (modify-syntax-entry ?\
[ "(] " table
)
80 (modify-syntax-entry ?\
] ")[ " table
)
82 "Syntax table used in `emacs-lisp-mode'.")
84 (defvar lisp-mode-syntax-table
85 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table
)))
86 (modify-syntax-entry ?\
[ "_ " table
)
87 (modify-syntax-entry ?\
] "_ " table
)
88 (modify-syntax-entry ?
# "' 14" table
)
89 (modify-syntax-entry ?|
"\" 23bn" table
)
91 "Syntax table used in `lisp-mode'.")
93 (defvar lisp-imenu-generic-expression
96 (purecopy (concat "^\\s-*("
99 '("defun" "defun*" "defsubst" "defmacro"
100 "defadvice" "define-skeleton"
101 "define-minor-mode" "define-global-minor-mode"
102 "define-globalized-minor-mode"
103 "define-derived-mode" "define-generic-mode"
104 "define-compiler-macro" "define-modify-macro"
105 "defsetf" "define-setf-expander"
106 "define-method-combination"
107 "defgeneric" "defmethod") t
))
108 "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
110 (list (purecopy "Variables")
111 (purecopy (concat "^\\s-*("
114 '("defvar" "defconst" "defconstant" "defcustom"
115 "defparameter" "define-symbol-macro") t
))
116 "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
118 (list (purecopy "Types")
119 (purecopy (concat "^\\s-*("
122 '("defgroup" "deftheme" "deftype" "defstruct"
123 "defclass" "define-condition" "define-widget"
124 "defface" "defpackage") t
))
125 "\\s-+'?\\(\\(\\sw\\|\\s_\\)+\\)"))
128 "Imenu generic expression for Lisp mode. See `imenu-generic-expression'.")
130 ;; This was originally in autoload.el and is still used there.
131 (put 'autoload
'doc-string-elt
3)
132 (put 'defun
'doc-string-elt
3)
133 (put 'defun
* 'doc-string-elt
3)
134 (put 'defvar
'doc-string-elt
3)
135 (put 'defcustom
'doc-string-elt
3)
136 (put 'deftheme
'doc-string-elt
2)
137 (put 'deftype
'doc-string-elt
3)
138 (put 'defconst
'doc-string-elt
3)
139 (put 'defmacro
'doc-string-elt
3)
140 (put 'defmacro
* 'doc-string-elt
3)
141 (put 'defsubst
'doc-string-elt
3)
142 (put 'defstruct
'doc-string-elt
2)
143 (put 'define-skeleton
'doc-string-elt
2)
144 (put 'define-derived-mode
'doc-string-elt
4)
145 (put 'define-compilation-mode
'doc-string-elt
3)
146 (put 'easy-mmode-define-minor-mode
'doc-string-elt
2)
147 (put 'define-minor-mode
'doc-string-elt
2)
148 (put 'easy-mmode-define-global-mode
'doc-string-elt
2)
149 (put 'define-global-minor-mode
'doc-string-elt
2)
150 (put 'define-globalized-minor-mode
'doc-string-elt
2)
151 (put 'define-generic-mode
'doc-string-elt
7)
152 (put 'define-ibuffer-filter
'doc-string-elt
2)
153 (put 'define-ibuffer-op
'doc-string-elt
3)
154 (put 'define-ibuffer-sorter
'doc-string-elt
2)
155 (put 'lambda
'doc-string-elt
2)
156 (put 'defalias
'doc-string-elt
3)
157 (put 'defvaralias
'doc-string-elt
3)
158 (put 'define-category
'doc-string-elt
2)
159 (put 'define-overloadable-function
'doc-string-elt
3)
161 (defvar lisp-doc-string-elt-property
'doc-string-elt
162 "The symbol property that holds the docstring position info.")
164 (defun lisp-font-lock-syntactic-face-function (state)
166 ;; This might be a (doc)string or a |...| symbol.
167 (let ((startpos (nth 8 state
)))
168 (if (eq (char-after startpos
) ?|
)
169 ;; This is not a string, but a |...| symbol.
171 (let* ((listbeg (nth 1 state
))
172 (firstsym (and listbeg
175 (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
177 (docelt (and firstsym
(get (intern-soft firstsym
)
178 lisp-doc-string-elt-property
))))
180 ;; It's a string in a form that can have a docstring.
181 ;; Check whether it's in docstring position.
183 (when (functionp docelt
)
184 (goto-char (match-end 1))
185 (setq docelt
(funcall docelt
)))
189 (while (and (> docelt
0) (< (point) startpos
)
190 (progn (forward-sexp 1) t
))
191 (setq docelt
(1- docelt
)))
193 (and (zerop docelt
) (<= (point) startpos
)
194 (progn (forward-comment (point-max)) t
)
195 (= (point) (nth 8 state
)))))
197 font-lock-string-face
))))
198 font-lock-comment-face
))
200 (defun lisp-mode-variables (&optional lisp-syntax keywords-case-insensitive
)
201 "Common initialization routine for lisp modes.
202 The LISP-SYNTAX argument is used by code in inf-lisp.el and is
203 \(uselessly) passed from pp.el, chistory.el, gnus-kill.el and
204 score-mode.el. KEYWORDS-CASE-INSENSITIVE non-nil means that for
205 font-lock keywords will not be case sensitive."
207 (set-syntax-table lisp-mode-syntax-table
))
208 (setq local-abbrev-table lisp-mode-abbrev-table
)
209 (make-local-variable 'paragraph-ignore-fill-prefix
)
210 (setq paragraph-ignore-fill-prefix t
)
211 (make-local-variable 'fill-paragraph-function
)
212 (setq fill-paragraph-function
'lisp-fill-paragraph
)
213 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
214 ;; a single docstring. Let's fix it here.
215 (set (make-local-variable 'adaptive-fill-function
)
216 (lambda () (if (looking-at "\\s-+\"[^\n\"]+\"\\s-*$") "")))
217 ;; Adaptive fill mode gets in the way of auto-fill,
218 ;; and should make no difference for explicit fill
219 ;; because lisp-fill-paragraph should do the job.
220 ;; I believe that newcomment's auto-fill code properly deals with it -stef
221 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
222 (make-local-variable 'indent-line-function
)
223 (setq indent-line-function
'lisp-indent-line
)
224 (make-local-variable 'outline-regexp
)
225 (setq outline-regexp
";;;\\(;* [^ \t\n]\\|###autoload\\)\\|(")
226 (make-local-variable 'outline-level
)
227 (setq outline-level
'lisp-outline-level
)
228 (make-local-variable 'comment-start
)
229 (setq comment-start
";")
230 (make-local-variable 'comment-start-skip
)
231 ;; Look within the line for a ; following an even number of backslashes
232 ;; after either a non-backslash or the line beginning.
233 (setq comment-start-skip
"\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\);+ *")
234 (make-local-variable 'font-lock-comment-start-skip
)
235 ;; Font lock mode uses this only when it KNOWS a comment is starting.
236 (setq font-lock-comment-start-skip
";+ *")
237 (make-local-variable 'comment-add
)
238 (setq comment-add
1) ;default to `;;' in comment-region
239 (make-local-variable 'comment-column
)
240 (setq comment-column
40)
241 ;; Don't get confused by `;' in doc strings when paragraph-filling.
242 (set (make-local-variable 'comment-use-global-state
) t
)
243 (make-local-variable 'imenu-generic-expression
)
244 (setq imenu-generic-expression lisp-imenu-generic-expression
)
245 (make-local-variable 'multibyte-syntax-as-symbol
)
246 (setq multibyte-syntax-as-symbol t
)
247 (set (make-local-variable 'syntax-begin-function
) 'beginning-of-defun
)
248 (setq font-lock-defaults
249 `((lisp-font-lock-keywords
250 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2
)
251 nil
,keywords-case-insensitive
(("+-*/.<>=!?$%_&~^:@" .
"w")) nil
252 (font-lock-mark-block-function . mark-defun
)
253 (font-lock-syntactic-face-function
254 . lisp-font-lock-syntactic-face-function
))))
256 (defun lisp-outline-level ()
257 "Lisp mode `outline-level' function."
258 (let ((len (- (match-end 0) (match-beginning 0))))
259 (if (looking-at "(\\|;;;###autoload")
263 (defvar lisp-mode-shared-map
264 (let ((map (make-sparse-keymap)))
265 (define-key map
"\e\C-q" 'indent-sexp
)
266 (define-key map
"\177" 'backward-delete-char-untabify
)
267 ;; This gets in the way when viewing a Lisp file in view-mode. As
268 ;; long as [backspace] is mapped into DEL via the
269 ;; function-key-map, this should remain disabled!!
270 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
272 "Keymap for commands shared by all sorts of Lisp modes.")
274 (defvar emacs-lisp-mode-map
275 (let ((map (make-sparse-keymap "Emacs-Lisp"))
276 (menu-map (make-sparse-keymap "Emacs-Lisp"))
277 (lint-map (make-sparse-keymap))
278 (prof-map (make-sparse-keymap))
279 (tracing-map (make-sparse-keymap)))
280 (set-keymap-parent map lisp-mode-shared-map
)
281 (define-key map
"\e\t" 'completion-at-point
)
282 (define-key map
"\e\C-x" 'eval-defun
)
283 (define-key map
"\e\C-q" 'indent-pp-sexp
)
284 (define-key map
[menu-bar emacs-lisp
] (cons (purecopy "Emacs-Lisp") menu-map
))
285 (define-key menu-map
[eldoc]
286 `(menu-item ,(purecopy "Auto-Display Documentation Strings") eldoc-mode
287 :button (:toggle . (bound-and-true-p eldoc-mode))
288 :help ,(purecopy "Display the documentation string for the item under cursor")))
289 (define-key menu-map [checkdoc]
290 `(menu-item ,(purecopy "Check Documentation Strings") checkdoc
291 :help ,(purecopy "Check documentation strings for style requirements")))
292 (define-key menu-map [re-builder]
293 `(menu-item ,(purecopy "Construct Regexp") re-builder
294 :help ,(purecopy "Construct a regexp interactively")))
295 (define-key menu-map [tracing] (cons (purecopy "Tracing") tracing-map))
296 (define-key tracing-map [tr-a]
297 `(menu-item ,(purecopy "Untrace All") untrace-all
298 :help ,(purecopy "Untrace all currently traced functions")))
299 (define-key tracing-map [tr-uf]
300 `(menu-item ,(purecopy "Untrace function...") untrace-function
301 :help ,(purecopy "Untrace function, and possibly activate all remaining advice")))
302 (define-key tracing-map [tr-sep] menu-bar-separator)
303 (define-key tracing-map [tr-q]
304 `(menu-item ,(purecopy "Trace Function Quietly...") trace-function-background
305 :help ,(purecopy "Trace the function with trace output going quietly to a buffer")))
306 (define-key tracing-map [tr-f]
307 `(menu-item ,(purecopy "Trace Function...") trace-function
308 :help ,(purecopy "Trace the function given as an argument")))
309 (define-key menu-map [profiling] (cons (purecopy "Profiling") prof-map))
310 (define-key prof-map [prof-restall]
311 `(menu-item ,(purecopy "Remove Instrumentation for All Functions") elp-restore-all
312 :help ,(purecopy "Restore the original definitions of all functions being profiled")))
313 (define-key prof-map [prof-restfunc]
314 `(menu-item ,(purecopy "Remove Instrumentation for Function...") elp-restore-function
315 :help ,(purecopy "Restore an instrumented function to its original definition")))
317 (define-key prof-map [sep-rem] menu-bar-separator)
318 (define-key prof-map [prof-resall]
319 `(menu-item ,(purecopy "Reset Counters for All Functions") elp-reset-all
320 :help ,(purecopy "Reset the profiling information for all functions being profiled")))
321 (define-key prof-map [prof-resfunc]
322 `(menu-item ,(purecopy "Reset Counters for Function...") elp-reset-function
323 :help ,(purecopy "Reset the profiling information for a function")))
324 (define-key prof-map [prof-res]
325 `(menu-item ,(purecopy "Show Profiling Results") elp-results
326 :help ,(purecopy "Display current profiling results")))
327 (define-key prof-map [prof-pack]
328 `(menu-item ,(purecopy "Instrument Package...") elp-instrument-package
329 :help ,(purecopy "Instrument for profiling all function that start with a prefix")))
330 (define-key prof-map [prof-func]
331 `(menu-item ,(purecopy "Instrument Function...") elp-instrument-function
332 :help ,(purecopy "Instrument a function for profiling")))
333 (define-key menu-map [lint] (cons (purecopy "Linting") lint-map))
334 (define-key lint-map [lint-di]
335 `(menu-item ,(purecopy "Lint Directory...") elint-directory
336 :help ,(purecopy "Lint a directory")))
337 (define-key lint-map [lint-f]
338 `(menu-item ,(purecopy "Lint File...") elint-file
339 :help ,(purecopy "Lint a file")))
340 (define-key lint-map [lint-b]
341 `(menu-item ,(purecopy "Lint Buffer") elint-current-buffer
342 :help ,(purecopy "Lint the current buffer")))
343 (define-key lint-map [lint-d]
344 `(menu-item ,(purecopy "Lint Defun") elint-defun
345 :help ,(purecopy "Lint the function at point")))
346 (define-key menu-map [edebug-defun]
347 `(menu-item ,(purecopy "Instrument Function for Debugging") edebug-defun
348 :help ,(purecopy "Evaluate the top level form point is in, stepping through with Edebug")
349 :keys ,(purecopy "C-u C-M-x")))
350 (define-key menu-map [separator-byte] menu-bar-separator)
351 (define-key menu-map [disas]
352 `(menu-item ,(purecopy "Disassemble Byte Compiled Object...") disassemble
353 :help ,(purecopy "Print disassembled code for OBJECT in a buffer")))
354 (define-key menu-map [byte-recompile]
355 `(menu-item ,(purecopy "Byte-recompile Directory...") byte-recompile-directory
356 :help ,(purecopy "Recompile every `.el' file in DIRECTORY that needs recompilation")))
357 (define-key menu-map [emacs-byte-compile-and-load]
358 `(menu-item ,(purecopy "Byte-compile and Load") emacs-lisp-byte-compile-and-load
359 :help ,(purecopy "Byte-compile the current file (if it has changed), then load compiled code")))
360 (define-key menu-map [byte-compile]
361 `(menu-item ,(purecopy "Byte-compile this File") emacs-lisp-byte-compile
362 :help ,(purecopy "Byte compile the file containing the current buffer")))
363 (define-key menu-map [separator-eval] menu-bar-separator)
364 (define-key menu-map [ielm]
365 `(menu-item ,(purecopy "Interactive Expression Evaluation") ielm
366 :help ,(purecopy "Interactively evaluate Emacs Lisp expressions")))
367 (define-key menu-map [eval-buffer]
368 `(menu-item ,(purecopy "Evaluate Buffer") eval-buffer
369 :help ,(purecopy "Execute the current buffer as Lisp code")))
370 (define-key menu-map [eval-region]
371 `(menu-item ,(purecopy "Evaluate Region") eval-region
372 :help ,(purecopy "Execute the region as Lisp code")
373 :enable mark-active))
374 (define-key menu-map [eval-sexp]
375 `(menu-item ,(purecopy "Evaluate Last S-expression") eval-last-sexp
376 :help ,(purecopy "Evaluate sexp before point; print value in minibuffer")))
377 (define-key menu-map [separator-format] menu-bar-separator)
378 (define-key menu-map [comment-region]
379 `(menu-item ,(purecopy "Comment Out Region") comment-region
380 :help ,(purecopy "Comment or uncomment each line in the region")
381 :enable mark-active))
382 (define-key menu-map [indent-region]
383 `(menu-item ,(purecopy "Indent Region") indent-region
384 :help ,(purecopy "Indent each nonblank line in the region")
385 :enable mark-active))
386 (define-key menu-map [indent-line]
387 `(menu-item ,(purecopy "Indent Line") lisp-indent-line))
389 "Keymap for Emacs Lisp mode.
390 All commands in `lisp-mode-shared-map' are inherited by this map.")
392 (defun emacs-lisp-byte-compile ()
393 "Byte compile the file containing the current buffer."
396 (byte-compile-file buffer-file-name)
397 (error "The buffer must be saved in a file first")))
399 (defun emacs-lisp-byte-compile-and-load ()
400 "Byte-compile the current file (if it has changed), then load compiled code."
403 (error "The buffer must be saved in a file first"))
405 ;; Recompile if file or buffer has changed since last compilation.
406 (if (and (buffer-modified-p)
407 (y-or-n-p (format "Save buffer %s first? " (buffer-name))))
409 (byte-recompile-file buffer-file-name nil 0 t))
411 (defcustom emacs-lisp-mode-hook nil
412 "Hook run when entering Emacs Lisp mode."
413 :options '(turn-on-eldoc-mode imenu-add-menubar-index checkdoc-minor-mode)
417 (defcustom lisp-mode-hook nil
418 "Hook run when entering Lisp mode."
419 :options '(imenu-add-menubar-index)
423 (defcustom lisp-interaction-mode-hook nil
424 "Hook run when entering Lisp Interaction mode."
425 :options '(turn-on-eldoc-mode)
429 (define-derived-mode emacs-lisp-mode prog-mode "Emacs-Lisp"
430 "Major mode for editing Lisp code to run in Emacs.
432 Delete converts tabs to spaces as it moves back.
433 Blank lines separate paragraphs. Semicolons start comments.
435 \\{emacs-lisp-mode-map}
436 Entry to this mode calls the value of `emacs-lisp-mode-hook'
437 if that value is non-nil."
439 (lisp-mode-variables)
440 (setq imenu-case-fold-search nil)
441 (add-hook 'completion-at-point-functions
442 'lisp-completion-at-point nil 'local))
444 (defvar lisp-mode-map
445 (let ((map (make-sparse-keymap))
446 (menu-map (make-sparse-keymap "Lisp")))
447 (set-keymap-parent map lisp-mode-shared-map)
448 (define-key map "\e\C-x" 'lisp-eval-defun)
449 (define-key map "\C-c\C-z" 'run-lisp)
450 (define-key map [menu-bar lisp] (cons (purecopy "Lisp") menu-map))
451 (define-key menu-map [run-lisp]
452 `(menu-item ,(purecopy "Run inferior Lisp") run-lisp
453 :help ,(purecopy "Run an inferior Lisp process, input and output via buffer `*inferior-lisp*'")))
454 (define-key menu-map [ev-def]
455 `(menu-item ,(purecopy "Eval defun") lisp-eval-defun
456 :help ,(purecopy "Send the current defun to the Lisp process made by M-x run-lisp")))
457 (define-key menu-map [ind-sexp]
458 `(menu-item ,(purecopy "Indent sexp") indent-sexp
459 :help ,(purecopy "Indent each line of the list starting just after point")))
461 "Keymap for ordinary Lisp mode.
462 All commands in `lisp-mode-shared-map' are inherited by this map.")
464 (define-derived-mode lisp-mode prog-mode "Lisp"
465 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
467 Delete converts tabs to spaces as it moves back.
468 Blank lines separate paragraphs. Semicolons start comments.
471 Note that `run-lisp' may be used either to start an inferior Lisp job
472 or to switch back to an existing one.
474 Entry to this mode calls the value of `lisp-mode-hook'
475 if that value is non-nil."
476 (lisp-mode-variables nil t)
477 (set (make-local-variable 'find-tag-default-function) 'lisp-find-tag-default)
478 (make-local-variable 'comment-start-skip)
479 (setq comment-start-skip
480 "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(;+\\|#|\\) *")
481 (setq imenu-case-fold-search t))
483 (defun lisp-find-tag-default ()
484 (let ((default (find-tag-default)))
485 (when (stringp default)
486 (if (string-match ":+" default)
487 (substring default (match-end 0))
490 ;; Used in old LispM code.
491 (defalias 'common-lisp-mode 'lisp-mode)
493 ;; This will do unless inf-lisp.el is loaded.
494 (defun lisp-eval-defun (&optional and-go)
495 "Send the current defun to the Lisp process made by \\[run-lisp]."
497 (error "Process lisp does not exist"))
499 (defvar lisp-interaction-mode-map
500 (let ((map (make-sparse-keymap))
501 (menu-map (make-sparse-keymap "Lisp-Interaction")))
502 (set-keymap-parent map lisp-mode-shared-map)
503 (define-key map "\e\C-x" 'eval-defun)
504 (define-key map "\e\C-q" 'indent-pp-sexp)
505 (define-key map "\e\t" 'completion-at-point)
506 (define-key map "\n" 'eval-print-last-sexp)
507 (define-key map [menu-bar lisp-interaction] (cons (purecopy "Lisp-Interaction") menu-map))
508 (define-key menu-map [eval-defun]
509 `(menu-item ,(purecopy "Evaluate Defun") eval-defun
510 :help ,(purecopy "Evaluate the top-level form containing point, or after point")))
511 (define-key menu-map [eval-print-last-sexp]
512 `(menu-item ,(purecopy "Evaluate and print") eval-print-last-sexp
513 :help ,(purecopy "Evaluate sexp before point; print value into current buffer")))
514 (define-key menu-map [edebug-defun-lisp-interaction]
515 `(menu-item ,(purecopy "Instrument Function for Debugging") edebug-defun
516 :help ,(purecopy "Evaluate the top level form point is in, stepping through with Edebug")
517 :keys ,(purecopy "C-u C-M-x")))
518 (define-key menu-map [indent-pp-sexp]
519 `(menu-item ,(purecopy "Indent or Pretty-Print") indent-pp-sexp
520 :help ,(purecopy "Indent each line of the list starting just after point, or prettyprint it")))
521 (define-key menu-map [complete-symbol]
522 `(menu-item ,(purecopy "Complete Lisp Symbol") completion-at-point
523 :help ,(purecopy "Perform completion on Lisp symbol preceding point")))
525 "Keymap for Lisp Interaction mode.
526 All commands in `lisp-mode-shared-map' are inherited by this map.")
528 (define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
529 "Major mode for typing and evaluating Lisp forms.
530 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
531 before point, and prints its value into the buffer, advancing point.
532 Note that printing is controlled by `eval-expression-print-length'
533 and `eval-expression-print-level'.
536 Delete converts tabs to spaces as it moves back.
537 Paragraphs are separated only by blank lines.
538 Semicolons start comments.
540 \\{lisp-interaction-mode-map}
541 Entry to this mode calls the value of `lisp-interaction-mode-hook'
542 if that value is non-nil.")
544 (defun eval-print-last-sexp ()
545 "Evaluate sexp before point; print value into current buffer.
547 If `eval-expression-debug-on-error' is non-nil, which is the default,
548 this command arranges for all errors to enter the debugger.
550 Note that printing the result is controlled by the variables
551 `eval-expression-print-length' and `eval-expression-print-level',
554 (let ((standard-output (current-buffer)))
560 (defun last-sexp-setup-props (beg end value alt1 alt2)
561 "Set up text properties for the output of `eval-last-sexp-1'.
562 BEG and END are the start and end of the output in current-buffer.
563 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
564 alternative printed representations that can be displayed."
565 (let ((map (make-sparse-keymap)))
566 (define-key map "\C-m" 'last-sexp-toggle-display)
567 (define-key map [down-mouse-2] 'mouse-set-point)
568 (define-key map [mouse-2] 'last-sexp-toggle-display)
571 `(printed-value (,value ,alt1 ,alt2)
574 help-echo "RET, mouse-2: toggle abbreviated display"
575 rear-nonsticky (mouse-face keymap help-echo
579 (defun last-sexp-toggle-display (&optional arg)
580 "Toggle between abbreviated and unabbreviated printed representations."
584 (let ((value (get-text-property (point) 'printed-value)))
586 (let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
589 (end (or (next-single-char-property-change (point) 'printed-value) (point)))
590 (standard-output (current-buffer))
592 (delete-region beg end)
593 (insert (nth 1 value))
595 (setq point (1- (point))))
596 (last-sexp-setup-props beg (point)
600 (goto-char (min (point-max) point)))))))
602 (defun prin1-char (char)
603 "Return a string representing CHAR as a character rather than as an integer.
604 If CHAR is not a character, return nil."
607 (let ((c (event-basic-type char))
608 (mods (event-modifiers char))
610 ;; Prevent ?A from turning into ?\S-a.
611 (if (and (memq 'shift mods)
612 (zerop (logand char ?\S-\^@))
613 (not (let ((case-fold-search nil))
614 (char-equal c (upcase c)))))
615 (setq c (upcase c) mods nil))
616 ;; What string are we considering using?
623 (cond ((eq modif 'super) "\\s-")
624 (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
627 ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
632 ;; Verify the string reads a CHAR, not to some other character.
633 ;; If it doesn't, return nil instead.
635 (= (car (read-from-string string)) char)
639 (defun preceding-sexp ()
640 "Return sexp before the point."
641 (let ((opoint (point))
645 (with-syntax-table emacs-lisp-mode-syntax-table
646 ;; If this sexp appears to be enclosed in `...'
647 ;; then ignore the surrounding quotes.
649 (or (eq (following-char) ?\')
650 (eq (preceding-char) ?\')))
652 ;; If we were after `?\e' (or similar case),
653 ;; use the whole thing, not just the `e'.
654 (when (eq (preceding-char) ?\\)
656 (when (eq (preceding-char) ??)
659 ;; Skip over hash table read syntax.
660 (and (> (point) (1+ (point-min)))
661 (looking-back "#s" (- (point) 2))
665 (when (eq (preceding-char) ?=)
668 (skip-chars-backward "0-9#=")
669 (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
674 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
675 ;; `variable' so that the value is returned, not the
677 (if (and ignore-quotes
678 (eq (following-char) ?`))
680 (narrow-to-region (point-min) opoint)
681 (setq expr (read (current-buffer)))
682 ;; If it's an (interactive ...) form, it's more
683 ;; useful to show how an interactive call would
686 (eq (car expr) 'interactive)
688 (list 'call-interactively
697 (defun eval-last-sexp-1 (eval-last-sexp-arg-internal)
698 "Evaluate sexp before point; print value in minibuffer.
699 With argument, print output into current buffer."
700 (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
701 ;; Setup the lexical environment if lexical-binding is enabled.
702 (eval-last-sexp-print-value
703 (eval (eval-sexp-add-defvars (preceding-sexp)) lexical-binding))))
706 (defun eval-last-sexp-print-value (value)
707 (let ((unabbreviated (let ((print-length nil) (print-level nil))
708 (prin1-to-string value)))
709 (print-length eval-expression-print-length)
710 (print-level eval-expression-print-level)
715 (let ((str (eval-expression-print-format value)))
716 (if str (princ str)))
718 (when (and (bufferp standard-output)
719 (or (not (null print-length))
720 (not (null print-level)))
721 (not (string= unabbreviated
722 (buffer-substring-no-properties beg end))))
723 (last-sexp-setup-props beg end value
725 (buffer-substring-no-properties beg end))
729 (defvar eval-last-sexp-fake-value (make-symbol "t"))
731 (defun eval-sexp-add-defvars (exp &optional pos)
732 "Prepend EXP with all the `defvar's that precede it in the buffer.
733 POS specifies the starting position where EXP was found and defaults to point."
734 (if (not lexical-binding)
737 (unless pos (setq pos (point)))
739 (goto-char (point-min))
740 (while (re-search-forward
741 "^(def\\(?:var\\|const\\|custom\\)[ \t\n]+\\([^; '()\n\t]+\\)"
743 (let ((var (intern (match-string 1))))
744 (unless (special-variable-p var)
746 `(progn ,@(mapcar (lambda (v) `(defvar ,v)) vars) ,exp)))))
748 (defun eval-last-sexp (eval-last-sexp-arg-internal)
749 "Evaluate sexp before point; print value in minibuffer.
750 Interactively, with prefix argument, print output into current buffer.
751 Truncates long output according to the value of the variables
752 `eval-expression-print-length' and `eval-expression-print-level'.
754 If `eval-expression-debug-on-error' is non-nil, which is the default,
755 this command arranges for all errors to enter the debugger."
757 (if (null eval-expression-debug-on-error)
758 (eval-last-sexp-1 eval-last-sexp-arg-internal)
760 (let ((debug-on-error eval-last-sexp-fake-value))
761 (cons (eval-last-sexp-1 eval-last-sexp-arg-internal)
763 (unless (eq (cdr value) eval-last-sexp-fake-value)
764 (setq debug-on-error (cdr value)))
767 (defun eval-defun-1 (form)
768 "Treat some expressions specially.
769 Reset the `defvar' and `defcustom' variables to the initial value.
770 Reinitialize the face according to the `defface' specification."
771 ;; The code in edebug-defun should be consistent with this, but not
772 ;; the same, since this gets a macroexpended form.
773 (cond ((not (listp form))
775 ((and (eq (car form) 'defvar)
776 (cdr-safe (cdr-safe form))
777 (boundp (cadr form)))
778 ;; Force variable to be re-set.
779 `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
780 (setq-default ,(nth 1 form) ,(nth 2 form))))
781 ;; `defcustom' is now macroexpanded to
782 ;; `custom-declare-variable' with a quoted value arg.
783 ((and (eq (car form) 'custom-declare-variable)
784 (default-boundp (eval (nth 1 form) lexical-binding)))
785 ;; Force variable to be bound.
786 (set-default (eval (nth 1 form) lexical-binding)
787 (eval (nth 1 (nth 2 form)) lexical-binding))
789 ;; `defface' is macroexpanded to `custom-declare-face'.
790 ((eq (car form) 'custom-declare-face)
792 (let ((face-symbol (eval (nth 1 form) lexical-binding)))
793 (setq face-new-frame-defaults
794 (assq-delete-all face-symbol face-new-frame-defaults))
795 (put face-symbol 'face-defface-spec nil)
796 (put face-symbol 'face-documentation (nth 3 form))
797 ;; Setting `customized-face' to the new spec after calling
798 ;; the form, but preserving the old saved spec in `saved-face',
799 ;; imitates the situation when the new face spec is set
800 ;; temporarily for the current session in the customize
801 ;; buffer, thus allowing `face-user-default-spec' to use the
802 ;; new customized spec instead of the saved spec.
803 ;; Resetting `saved-face' temporarily to nil is needed to let
804 ;; `defface' change the spec, regardless of a saved spec.
806 (put ,(nth 1 form) 'saved-face
807 ',(get face-symbol 'saved-face))
808 (put ,(nth 1 form) 'customized-face
810 (put face-symbol 'saved-face nil))))
811 ((eq (car form) 'progn)
812 (cons 'progn (mapcar 'eval-defun-1 (cdr form))))
815 (defun eval-defun-2 ()
816 "Evaluate defun that point is in or before.
817 The value is displayed in the minibuffer.
818 If the current defun is actually a call to `defvar',
819 then reset the variable using the initial value expression
820 even if the variable already has some other value.
821 \(Normally `defvar' does not change the variable's value
822 if it already has a value.\)
824 With argument, insert value in current buffer after the defun.
825 Return the result of evaluation."
827 ;; FIXME: the print-length/level bindings should only be applied while
828 ;; printing, not while evaluating.
829 (let ((debug-on-error eval-expression-debug-on-error)
830 (print-length eval-expression-print-length)
831 (print-level eval-expression-print-level))
833 ;; Arrange for eval-region to "read" the (possibly) altered form.
834 ;; eval-region handles recording which file defines a function or
835 ;; variable. Re-written using `apply' to avoid capturing
836 ;; variables like `end'.
839 (let ((standard-output t)
841 ;; Read the form from the buffer, and record where it ends.
846 (setq form (eval-sexp-add-defvars (read (current-buffer))))
848 ;; Alter the form if necessary.
849 (setq form (eval-defun-1 (macroexpand form)))
850 (list beg end standard-output
852 ;; Skipping to the end of the specified region
853 ;; will make eval-region return.
856 ;; The result of evaluation has been put onto VALUES. So return it.
859 (defun eval-defun (edebug-it)
860 "Evaluate the top-level form containing point, or after point.
862 If the current defun is actually a call to `defvar' or `defcustom',
863 evaluating it this way resets the variable using its initial value
864 expression even if the variable already has some other value.
865 \(Normally `defvar' and `defcustom' do not alter the value if there
866 already is one.) In an analogous way, evaluating a `defface'
867 overrides any customizations of the face, so that it becomes
868 defined exactly as the `defface' expression says.
870 If `eval-expression-debug-on-error' is non-nil, which is the default,
871 this command arranges for all errors to enter the debugger.
873 With a prefix argument, instrument the code for Edebug.
875 If acting on a `defun' for FUNCTION, and the function was
876 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
877 instrumented, just FUNCTION is printed.
879 If not acting on a `defun', the result of evaluation is displayed in
880 the minibuffer. This display is controlled by the variables
881 `eval-expression-print-length' and `eval-expression-print-level',
886 (eval-defun (not edebug-all-defs)))
888 (if (null eval-expression-debug-on-error)
890 (let ((old-value (make-symbol "t")) new-value value)
891 (let ((debug-on-error old-value))
892 (setq value (eval-defun-2))
893 (setq new-value debug-on-error))
894 (unless (eq old-value new-value)
895 (setq debug-on-error new-value))
898 ;; May still be used by some external Lisp-mode variant.
899 (define-obsolete-function-alias 'lisp-comment-indent
900 'comment-indent-default "22.1")
901 (define-obsolete-function-alias 'lisp-mode-auto-fill 'do-auto-fill "23.1")
903 (defcustom lisp-indent-offset nil
904 "If non-nil, indent second line of expressions that many more columns."
906 :type '(choice (const nil) integer))
907 (put 'lisp-indent-offset 'safe-local-variable
908 (lambda (x) (or (null x) (integerp x))))
910 (defcustom lisp-indent-function 'lisp-indent-function
911 "A function to be called by `calculate-lisp-indent'.
912 It indents the arguments of a Lisp function call. This function
913 should accept two arguments: the indent-point, and the
914 `parse-partial-sexp' state at that position. One option for this
915 function is `common-lisp-indent-function'."
919 (defun lisp-indent-line (&optional whole-exp)
920 "Indent current line as Lisp code.
921 With argument, indent any additional lines of the same expression
922 rigidly along with this one."
924 (let ((indent (calculate-lisp-indent)) shift-amt end
925 (pos (- (point-max) (point)))
926 (beg (progn (beginning-of-line) (point))))
927 (skip-chars-forward " \t")
928 (if (or (null indent) (looking-at "\\s<\\s<\\s<"))
929 ;; Don't alter indentation of a ;;; comment line
930 ;; or a line that starts in a string.
931 (goto-char (- (point-max) pos))
932 (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
933 ;; Single-semicolon comment lines should be indented
934 ;; as comment lines, not as code.
935 (progn (indent-for-comment) (forward-char -1))
936 (if (listp indent) (setq indent (car indent)))
937 (setq shift-amt (- indent (current-column)))
938 (if (zerop shift-amt)
940 (delete-region beg (point))
942 ;; If initial point was within line's indentation,
943 ;; position after the indentation. Else stay at same point in text.
944 (if (> (- (point-max) pos) (point))
945 (goto-char (- (point-max) pos)))
946 ;; If desired, shift remaining lines of expression the same amount.
947 (and whole-exp (not (zerop shift-amt))
956 (indent-code-rigidly beg end shift-amt)))))
958 (defvar calculate-lisp-indent-last-sexp)
960 (defun calculate-lisp-indent (&optional parse-start)
961 "Return appropriate indentation for current line as Lisp code.
962 In usual case returns an integer: the column to indent to.
963 If the value is nil, that means don't change the indentation
964 because the line starts inside a string.
966 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
967 This means that following lines at the same level of indentation
968 should not necessarily be indented the same as this line.
969 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
970 is the buffer position of the start of the containing expression."
973 (let ((indent-point (point))
975 ;; setting this to a number inhibits calling hook
978 calculate-lisp-indent-last-sexp containing-sexp)
980 (goto-char parse-start)
981 (beginning-of-defun))
982 ;; Find outermost containing sexp
983 (while (< (point) indent-point)
984 (setq state (parse-partial-sexp (point) indent-point 0)))
985 ;; Find innermost containing sexp
988 (> (setq paren-depth (elt state 0)) 0))
990 (setq calculate-lisp-indent-last-sexp (elt state 2))
991 (setq containing-sexp (elt state 1))
992 ;; Position following last unclosed open.
993 (goto-char (1+ containing-sexp))
994 ;; Is there a complete sexp since then?
995 (if (and calculate-lisp-indent-last-sexp
996 (> calculate-lisp-indent-last-sexp (point)))
997 ;; Yes, but is there a containing sexp after that?
998 (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
1000 (if (setq retry (car (cdr peek))) (setq state peek)))))
1003 ;; Innermost containing sexp found
1004 (goto-char (1+ containing-sexp))
1005 (if (not calculate-lisp-indent-last-sexp)
1006 ;; indent-point immediately follows open paren.
1008 (setq desired-indent (current-column))
1009 ;; Find the start of first element of containing sexp.
1010 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1011 (cond ((looking-at "\\s(")
1012 ;; First element of containing sexp is a list.
1013 ;; Indent under that list.
1015 ((> (save-excursion (forward-line 1) (point))
1016 calculate-lisp-indent-last-sexp)
1017 ;; This is the first line to start within the containing sexp.
1018 ;; It's almost certainly a function call.
1019 (if (= (point) calculate-lisp-indent-last-sexp)
1020 ;; Containing sexp has nothing before this line
1021 ;; except the first element. Indent under that element.
1023 ;; Skip the first element, find start of second (the first
1024 ;; argument of the function call) and indent under.
1025 (progn (forward-sexp 1)
1026 (parse-partial-sexp (point)
1027 calculate-lisp-indent-last-sexp
1029 (backward-prefix-chars))
1031 ;; Indent beneath first sexp on same line as
1032 ;; `calculate-lisp-indent-last-sexp'. Again, it's
1033 ;; almost certainly a function call.
1034 (goto-char calculate-lisp-indent-last-sexp)
1036 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
1038 (backward-prefix-chars)))))
1039 ;; Point is at the point to indent under unless we are inside a string.
1040 ;; Call indentation hook except when overridden by lisp-indent-offset
1041 ;; or if the desired indentation has already been computed.
1042 (let ((normal-indent (current-column)))
1043 (cond ((elt state 3)
1044 ;; Inside a string, don't change indentation.
1046 ((and (integerp lisp-indent-offset) containing-sexp)
1047 ;; Indent by constant offset
1048 (goto-char containing-sexp)
1049 (+ (current-column) lisp-indent-offset))
1050 ;; in this case calculate-lisp-indent-last-sexp is not nil
1051 (calculate-lisp-indent-last-sexp
1053 ;; try to align the parameters of a known function
1054 (and lisp-indent-function
1056 (funcall lisp-indent-function indent-point state))
1057 ;; If the function has no special alignment
1058 ;; or it does not apply to this argument,
1059 ;; try to align a constant-symbol under the last
1060 ;; preceding constant symbol, if there is such one of
1061 ;; the last 2 preceding symbols, in the previous
1062 ;; uncommented line.
1063 (and (save-excursion
1064 (goto-char indent-point)
1065 (skip-chars-forward " \t")
1067 ;; The last sexp may not be at the indentation
1068 ;; where it begins, so find that one, instead.
1070 (goto-char calculate-lisp-indent-last-sexp)
1071 ;; Handle prefix characters and whitespace
1072 ;; following an open paren. (Bug#1012)
1073 (backward-prefix-chars)
1074 (while (and (not (looking-back "^[ \t]*\\|([ \t]+"))
1075 (or (not containing-sexp)
1076 (< (1+ containing-sexp) (point))))
1078 (backward-prefix-chars))
1079 (setq calculate-lisp-indent-last-sexp (point)))
1080 (> calculate-lisp-indent-last-sexp
1082 (goto-char (1+ containing-sexp))
1083 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1085 (let ((parse-sexp-ignore-comments t)
1087 (goto-char calculate-lisp-indent-last-sexp)
1088 (or (and (looking-at ":")
1089 (setq indent (current-column)))
1090 (and (< (line-beginning-position)
1091 (prog2 (backward-sexp) (point)))
1093 (setq indent (current-column))))
1095 ;; another symbols or constants not preceded by a constant
1096 ;; as defined above.
1098 ;; in this case calculate-lisp-indent-last-sexp is nil
1103 (defun lisp-indent-function (indent-point state)
1104 "This function is the normal value of the variable `lisp-indent-function'.
1105 It is used when indenting a line within a function call, to see if the
1106 called function says anything special about how to indent the line.
1108 INDENT-POINT is the position where the user typed TAB, or equivalent.
1109 Point is located at the point to indent under (for default indentation);
1110 STATE is the `parse-partial-sexp' state for that position.
1112 If the current line is in a call to a Lisp function
1113 which has a non-nil property `lisp-indent-function',
1114 that specifies how to do the indentation. The property value can be
1115 * `defun', meaning indent `defun'-style;
1116 * an integer N, meaning indent the first N arguments specially
1117 like ordinary function arguments and then indent any further
1118 arguments like a body;
1119 * a function to call just as this function was called.
1120 If that function returns nil, that means it doesn't specify
1123 This function also returns nil meaning don't specify the indentation."
1124 (let ((normal-indent (current-column)))
1125 (goto-char (1+ (elt state 1)))
1126 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1127 (if (and (elt state 2)
1128 (not (looking-at "\\sw\\|\\s_")))
1129 ;; car of form doesn't seem to be a symbol
1131 (if (not (> (save-excursion (forward-line 1) (point))
1132 calculate-lisp-indent-last-sexp))
1133 (progn (goto-char calculate-lisp-indent-last-sexp)
1135 (parse-partial-sexp (point)
1136 calculate-lisp-indent-last-sexp 0 t)))
1137 ;; Indent under the list or under the first sexp on the same
1138 ;; line as calculate-lisp-indent-last-sexp. Note that first
1139 ;; thing on that line has to be complete sexp since we are
1140 ;; inside the innermost containing sexp.
1141 (backward-prefix-chars)
1143 (let ((function (buffer-substring (point)
1144 (progn (forward-sexp 1) (point))))
1146 (setq method (or (get (intern-soft function) 'lisp-indent-function)
1147 (get (intern-soft function) 'lisp-indent-hook)))
1148 (cond ((or (eq method 'defun)
1150 (> (length function) 3)
1151 (string-match "\\`def" function)))
1152 (lisp-indent-defform state indent-point))
1154 (lisp-indent-specform method state
1155 indent-point normal-indent))
1157 (funcall method indent-point state)))))))
1159 (defcustom lisp-body-indent 2
1160 "Number of columns to indent the second line of a `(def...)' form."
1163 (put 'lisp-body-indent 'safe-local-variable 'integerp)
1165 (defun lisp-indent-specform (count state indent-point normal-indent)
1166 (let ((containing-form-start (elt state 1))
1168 body-indent containing-form-column)
1169 ;; Move to the start of containing form, calculate indentation
1170 ;; to use for non-distinguished forms (> count), and move past the
1171 ;; function symbol. lisp-indent-function guarantees that there is at
1172 ;; least one word or symbol character following open paren of containing
1174 (goto-char containing-form-start)
1175 (setq containing-form-column (current-column))
1176 (setq body-indent (+ lisp-body-indent containing-form-column))
1179 ;; Now find the start of the last form.
1180 (parse-partial-sexp (point) indent-point 1 t)
1181 (while (and (< (point) indent-point)
1184 (setq count (1- count))
1186 (parse-partial-sexp (point) indent-point 1 t))
1188 ;; Point is sitting on first character of last (or count) sexp.
1190 ;; A distinguished form. If it is the first or second form use double
1191 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
1192 ;; to 2 (the default), this just happens to work the same with if as
1193 ;; the older code, but it makes unwind-protect, condition-case,
1194 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
1195 ;; less hacked, behavior can be obtained by replacing below with
1196 ;; (list normal-indent containing-form-start).
1197 (if (<= (- i count) 1)
1198 (list (+ containing-form-column (* 2 lisp-body-indent))
1199 containing-form-start)
1200 (list normal-indent containing-form-start))
1201 ;; A non-distinguished form. Use body-indent if there are no
1202 ;; distinguished forms and this is the first undistinguished form,
1203 ;; or if this is the first undistinguished form and the preceding
1204 ;; distinguished form has indentation at least as great as body-indent.
1205 (if (or (and (= i 0) (= count 0))
1206 (and (= count 0) (<= body-indent normal-indent)))
1210 (defun lisp-indent-defform (state indent-point)
1211 (goto-char (car (cdr state)))
1213 (if (> (point) (car (cdr (cdr state))))
1215 (goto-char (car (cdr state)))
1216 (+ lisp-body-indent (current-column)))))
1219 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1220 ;; like defun if the first form is placed on the next line, otherwise
1221 ;; it is indented like any other form (i.e. forms line up under first).
1223 (put 'lambda 'lisp-indent-function 'defun)
1224 (put 'autoload 'lisp-indent-function 'defun)
1225 (put 'progn 'lisp-indent-function 0)
1226 (put 'prog1 'lisp-indent-function 1)
1227 (put 'prog2 'lisp-indent-function 2)
1228 (put 'save-excursion 'lisp-indent-function 0)
1229 (put 'save-restriction 'lisp-indent-function 0)
1230 (put 'save-match-data 'lisp-indent-function 0)
1231 (put 'save-current-buffer 'lisp-indent-function 0)
1232 (put 'let 'lisp-indent-function 1)
1233 (put 'let* 'lisp-indent-function 1)
1234 (put 'while 'lisp-indent-function 1)
1235 (put 'if 'lisp-indent-function 2)
1236 (put 'catch 'lisp-indent-function 1)
1237 (put 'condition-case 'lisp-indent-function 2)
1238 (put 'unwind-protect 'lisp-indent-function 1)
1239 (put 'with-output-to-temp-buffer 'lisp-indent-function 1)
1241 (defun indent-sexp (&optional endpos)
1242 "Indent each line of the list starting just after point.
1243 If optional arg ENDPOS is given, indent each line, stopping when
1244 ENDPOS is encountered."
1246 (let ((indent-stack (list nil))
1248 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
1249 ;; so that calculate-lisp-indent will find the beginning of
1250 ;; the defun we are in.
1251 ;; If ENDPOS is nil, it is safe not to scan before point
1252 ;; since every line we indent is more deeply nested than point is.
1253 (starting-point (if endpos nil (point)))
1254 (last-point (point))
1255 last-depth bol outer-loop-done inner-loop-done state this-indent)
1257 ;; Get error now if we don't have a complete sexp after point.
1258 (save-excursion (forward-sexp 1)))
1260 (setq outer-loop-done nil)
1261 (while (if endpos (< (point) endpos)
1262 (not outer-loop-done))
1263 (setq last-depth next-depth
1264 inner-loop-done nil)
1265 ;; Parse this line so we can learn the state
1266 ;; to indent the next line.
1267 ;; This inner loop goes through only once
1268 ;; unless a line ends inside a string.
1269 (while (and (not inner-loop-done)
1270 (not (setq outer-loop-done (eobp))))
1271 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
1273 (setq next-depth (car state))
1274 ;; If the line contains a comment other than the sort
1275 ;; that is indented like code,
1276 ;; indent it now with indent-for-comment.
1277 ;; Comments indented like code are right already.
1278 ;; In any case clear the in-comment flag in the state
1279 ;; because parse-partial-sexp never sees the newlines.
1280 (if (car (nthcdr 4 state))
1281 (progn (indent-for-comment)
1283 (setcar (nthcdr 4 state) nil)))
1284 ;; If this line ends inside a string,
1285 ;; go straight to next line, remaining within the inner loop,
1286 ;; and turn off the \-flag.
1287 (if (car (nthcdr 3 state))
1290 (setcar (nthcdr 5 state) nil))
1291 (setq inner-loop-done t)))
1295 (setq indent-stack (nconc indent-stack
1296 (make-list (- next-depth) nil))
1297 last-depth (- last-depth next-depth)
1300 ;; Decide whether to exit.
1302 ;; If we have already reached the specified end,
1303 ;; give up and do not reindent this line.
1304 (if (<= endpos (point))
1305 (setq outer-loop-done t))
1306 ;; If no specified end, we are done if we have finished one sexp.
1307 (if (<= next-depth 0)
1308 (setq outer-loop-done t)))
1309 (unless outer-loop-done
1310 (while (> last-depth next-depth)
1311 (setq indent-stack (cdr indent-stack)
1312 last-depth (1- last-depth)))
1313 (while (< last-depth next-depth)
1314 (setq indent-stack (cons nil indent-stack)
1315 last-depth (1+ last-depth)))
1316 ;; Now indent the next line according
1317 ;; to what we learned from parsing the previous one.
1319 (skip-chars-forward " \t")
1320 ;; But not if the line is blank, or just a comment
1321 ;; (except for double-semi comments; indent them as usual).
1322 (if (or (eobp) (looking-at "\\s<\\|\n"))
1324 (if (and (car indent-stack)
1325 (>= (car indent-stack) 0))
1326 (setq this-indent (car indent-stack))
1327 (let ((val (calculate-lisp-indent
1328 (if (car indent-stack) (- (car indent-stack))
1331 (setq this-indent val)
1333 (setcar indent-stack
1334 (setq this-indent val))
1335 (setcar indent-stack (- (car (cdr val))))
1336 (setq this-indent (car val))))))
1337 (if (and this-indent (/= (current-column) this-indent))
1338 (progn (delete-region bol (point))
1339 (indent-to this-indent)))))
1341 (setq outer-loop-done (= (point) last-point))
1342 (setq last-point (point)))))))
1344 (defun indent-pp-sexp (&optional arg)
1345 "Indent each line of the list starting just after point, or prettyprint it.
1346 A prefix argument specifies pretty-printing."
1351 (narrow-to-region (point) (progn (forward-sexp 1) (point)))
1353 (goto-char (point-max))
1354 (if (eq (char-before) ?\n)
1355 (delete-char -1)))))
1358 ;;;; Lisp paragraph filling commands.
1360 (defcustom emacs-lisp-docstring-fill-column 65
1361 "Value of `fill-column' to use when filling a docstring.
1362 Any non-integer value means do not use a different value of
1363 `fill-column' when filling docstrings."
1364 :type '(choice (integer)
1365 (const :tag "Use the current `fill-column'" t))
1368 (defun lisp-fill-paragraph (&optional justify)
1369 "Like \\[fill-paragraph], but handle Emacs Lisp comments and docstrings.
1370 If any of the current line is a comment, fill the comment or the
1371 paragraph of it that point is in, preserving the comment's indentation
1372 and initial semicolons."
1374 (or (fill-comment-paragraph justify)
1375 ;; Since fill-comment-paragraph returned nil, that means we're not in
1376 ;; a comment: Point is on a program line; we are interested
1377 ;; particularly in docstring lines.
1379 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1380 ;; are buffer-local, but we avoid changing them so that they can be set
1381 ;; to make `forward-paragraph' and friends do something the user wants.
1383 ;; `paragraph-start': The `(' in the character alternative and the
1384 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1385 ;; sexps and backquoted sexps that follow a docstring from being filled
1386 ;; with the docstring. This setting has the consequence of inhibiting
1387 ;; filling many program lines that are not docstrings, which is sensible,
1388 ;; because the user probably asked to fill program lines by accident, or
1389 ;; expecting indentation (perhaps we should try to do indenting in that
1390 ;; case). The `;' and `:' stop the paragraph being filled at following
1391 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1392 ;; escaped to keep font-locking, filling, & paren matching in the source
1395 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1396 ;; a docstring and identifies it as a paragraph separator, so that it
1397 ;; won't be filled. (Since the first line of documentation stands alone
1398 ;; in some contexts, filling should not alter the contents the author has
1399 ;; chosen.) Only the first line of a docstring begins with whitespace
1400 ;; and a quotation mark and ends with a period or (rarely) a comma.
1402 ;; The `fill-column' is temporarily bound to
1403 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1404 (let ((paragraph-start (concat paragraph-start
1405 "\\|\\s-*\\([(;:\"]\\|`(\\|#'(\\)"))
1407 (concat paragraph-separate "\\|\\s-*\".*[,\\.]$"))
1408 (fill-column (if (and (integerp emacs-lisp-docstring-fill-column)
1409 (derived-mode-p 'emacs-lisp-mode))
1410 emacs-lisp-docstring-fill-column
1412 (fill-paragraph justify))
1413 ;; Never return nil.
1416 (defun indent-code-rigidly (start end arg &optional nochange-regexp)
1417 "Indent all lines of code, starting in the region, sideways by ARG columns.
1418 Does not affect lines starting inside comments or strings, assuming that
1419 the start of the region is not inside them.
1421 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1422 The last is a regexp which, if matched at the beginning of a line,
1423 means don't indent that line."
1424 (interactive "r\np")
1428 (setq end (point-marker))
1431 (setq state (parse-partial-sexp (point)
1433 (forward-line 1) (point))
1435 (while (< (point) end)
1436 (or (car (nthcdr 3 state))
1437 (and nochange-regexp
1438 (looking-at nochange-regexp))
1439 ;; If line does not start in string, indent it
1440 (let ((indent (current-indentation)))
1441 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
1443 (indent-to (max 0 (+ indent arg)) 0))))
1444 (setq state (parse-partial-sexp (point)
1446 (forward-line 1) (point))
1449 (provide 'lisp-mode)
1451 ;;; lisp-mode.el ends here