1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
7 ;; 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
))
83 (defvar lisp-mode-syntax-table
84 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table
)))
85 (modify-syntax-entry ?\
[ "_ " table
)
86 (modify-syntax-entry ?\
] "_ " table
)
87 (modify-syntax-entry ?
# "' 14b" table
)
88 (modify-syntax-entry ?|
"\" 23bn" table
)
91 (defvar lisp-imenu-generic-expression
94 (purecopy (concat "^\\s-*("
97 '("defun" "defun*" "defsubst" "defmacro"
98 "defadvice" "define-skeleton"
99 "define-minor-mode" "define-global-minor-mode"
100 "define-globalized-minor-mode"
101 "define-derived-mode" "define-generic-mode"
102 "define-compiler-macro" "define-modify-macro"
103 "defsetf" "define-setf-expander"
104 "define-method-combination"
105 "defgeneric" "defmethod") t
))
106 "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
108 (list (purecopy "Variables")
109 (purecopy (concat "^\\s-*("
112 '("defvar" "defconst" "defconstant" "defcustom"
113 "defparameter" "define-symbol-macro") t
))
114 "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
116 (list (purecopy "Types")
117 (purecopy (concat "^\\s-*("
120 '("defgroup" "deftheme" "deftype" "defstruct"
121 "defclass" "define-condition" "define-widget"
122 "defface" "defpackage") t
))
123 "\\s-+'?\\(\\(\\sw\\|\\s_\\)+\\)"))
126 "Imenu generic expression for Lisp mode. See `imenu-generic-expression'.")
128 ;; This was originally in autoload.el and is still used there.
129 (put 'autoload
'doc-string-elt
3)
130 (put 'defun
'doc-string-elt
3)
131 (put 'defun
* 'doc-string-elt
3)
132 (put 'defvar
'doc-string-elt
3)
133 (put 'defcustom
'doc-string-elt
3)
134 (put 'deftheme
'doc-string-elt
2)
135 (put 'defconst
'doc-string-elt
3)
136 (put 'defmacro
'doc-string-elt
3)
137 (put 'defmacro
* 'doc-string-elt
3)
138 (put 'defsubst
'doc-string-elt
3)
139 (put 'defstruct
'doc-string-elt
2)
140 (put 'define-skeleton
'doc-string-elt
2)
141 (put 'define-derived-mode
'doc-string-elt
4)
142 (put 'define-compilation-mode
'doc-string-elt
3)
143 (put 'easy-mmode-define-minor-mode
'doc-string-elt
2)
144 (put 'define-minor-mode
'doc-string-elt
2)
145 (put 'easy-mmode-define-global-mode
'doc-string-elt
2)
146 (put 'define-global-minor-mode
'doc-string-elt
2)
147 (put 'define-globalized-minor-mode
'doc-string-elt
2)
148 (put 'define-generic-mode
'doc-string-elt
7)
149 (put 'define-ibuffer-filter
'doc-string-elt
2)
150 (put 'define-ibuffer-op
'doc-string-elt
3)
151 (put 'define-ibuffer-sorter
'doc-string-elt
2)
152 (put 'lambda
'doc-string-elt
2)
153 (put 'defalias
'doc-string-elt
3)
154 (put 'defvaralias
'doc-string-elt
3)
155 (put 'define-category
'doc-string-elt
2)
157 (defvar lisp-doc-string-elt-property
'doc-string-elt
158 "The symbol property that holds the docstring position info.")
160 (defun lisp-font-lock-syntactic-face-function (state)
162 ;; This might be a (doc)string or a |...| symbol.
163 (let ((startpos (nth 8 state
)))
164 (if (eq (char-after startpos
) ?|
)
165 ;; This is not a string, but a |...| symbol.
167 (let* ((listbeg (nth 1 state
))
168 (firstsym (and listbeg
171 (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
173 (docelt (and firstsym
(get (intern-soft firstsym
)
174 lisp-doc-string-elt-property
))))
176 ;; It's a string in a form that can have a docstring.
177 ;; Check whether it's in docstring position.
179 (when (functionp docelt
)
180 (goto-char (match-end 1))
181 (setq docelt
(funcall docelt
)))
185 (while (and (> docelt
0) (< (point) startpos
)
186 (progn (forward-sexp 1) t
))
187 (setq docelt
(1- docelt
)))
189 (and (zerop docelt
) (<= (point) startpos
)
190 (progn (forward-comment (point-max)) t
)
191 (= (point) (nth 8 state
)))))
193 font-lock-string-face
))))
194 font-lock-comment-face
))
196 (defun lisp-mode-variables (&optional lisp-syntax keywords-case-insensitive
)
197 "Common initialization routine for lisp modes.
198 The LISP-SYNTAX argument is used by code in inf-lisp.el and is
199 (uselessly) passed from pp.el, chistory.el, gnus-kill.el and score-mode.el
200 KEYWORDS-CASE-SENSITIVE means that for font-lock keywords will not be case sensitive."
202 (set-syntax-table lisp-mode-syntax-table
))
203 (setq local-abbrev-table lisp-mode-abbrev-table
)
204 (make-local-variable 'paragraph-ignore-fill-prefix
)
205 (setq paragraph-ignore-fill-prefix t
)
206 (make-local-variable 'fill-paragraph-function
)
207 (setq fill-paragraph-function
'lisp-fill-paragraph
)
208 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
209 ;; a single docstring. Let's fix it here.
210 (set (make-local-variable 'adaptive-fill-function
)
211 (lambda () (if (looking-at "\\s-+\"[^\n\"]+\"\\s-*$") "")))
212 ;; Adaptive fill mode gets in the way of auto-fill,
213 ;; and should make no difference for explicit fill
214 ;; because lisp-fill-paragraph should do the job.
215 ;; I believe that newcomment's auto-fill code properly deals with it -stef
216 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
217 (make-local-variable 'indent-line-function
)
218 (setq indent-line-function
'lisp-indent-line
)
219 (make-local-variable 'parse-sexp-ignore-comments
)
220 (setq parse-sexp-ignore-comments t
)
221 (make-local-variable 'outline-regexp
)
222 (setq outline-regexp
";;;\\(;* [^ \t\n]\\|###autoload\\)\\|(")
223 (make-local-variable 'outline-level
)
224 (setq outline-level
'lisp-outline-level
)
225 (make-local-variable 'comment-start
)
226 (setq comment-start
";")
227 (make-local-variable 'comment-start-skip
)
228 ;; Look within the line for a ; following an even number of backslashes
229 ;; after either a non-backslash or the line beginning.
230 (setq comment-start-skip
"\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\);+ *")
231 (make-local-variable 'font-lock-comment-start-skip
)
232 ;; Font lock mode uses this only when it KNOWS a comment is starting.
233 (setq font-lock-comment-start-skip
";+ *")
234 (make-local-variable 'comment-add
)
235 (setq comment-add
1) ;default to `;;' in comment-region
236 (make-local-variable 'comment-column
)
237 (setq comment-column
40)
238 ;; Don't get confused by `;' in doc strings when paragraph-filling.
239 (set (make-local-variable 'comment-use-global-state
) t
)
240 (make-local-variable 'imenu-generic-expression
)
241 (setq imenu-generic-expression lisp-imenu-generic-expression
)
242 (make-local-variable 'multibyte-syntax-as-symbol
)
243 (setq multibyte-syntax-as-symbol t
)
244 (set (make-local-variable 'syntax-begin-function
) 'beginning-of-defun
)
245 (setq font-lock-defaults
246 `((lisp-font-lock-keywords
247 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2
)
248 nil
,keywords-case-insensitive
(("+-*/.<>=!?$%_&~^:@" .
"w")) nil
249 (font-lock-mark-block-function . mark-defun
)
250 (font-lock-syntactic-face-function
251 . lisp-font-lock-syntactic-face-function
))))
253 (defun lisp-outline-level ()
254 "Lisp mode `outline-level' function."
255 (let ((len (- (match-end 0) (match-beginning 0))))
256 (if (looking-at "(\\|;;;###autoload")
260 (defvar lisp-mode-shared-map
261 (let ((map (make-sparse-keymap)))
262 (define-key map
"\e\C-q" 'indent-sexp
)
263 (define-key map
"\177" 'backward-delete-char-untabify
)
264 ;; This gets in the way when viewing a Lisp file in view-mode. As
265 ;; long as [backspace] is mapped into DEL via the
266 ;; function-key-map, this should remain disabled!!
267 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
269 "Keymap for commands shared by all sorts of Lisp modes.")
271 (defvar emacs-lisp-mode-map
272 (let ((map (make-sparse-keymap "Emacs-Lisp"))
273 (menu-map (make-sparse-keymap "Emacs-Lisp"))
274 (prof-map (make-sparse-keymap))
275 (tracing-map (make-sparse-keymap)))
276 (set-keymap-parent map lisp-mode-shared-map
)
277 (define-key map
"\e\t" 'lisp-complete-symbol
)
278 (define-key map
"\e\C-x" 'eval-defun
)
279 (define-key map
"\e\C-q" 'indent-pp-sexp
)
280 (define-key map
[menu-bar emacs-lisp
] (cons "Emacs-Lisp" menu-map
))
281 (define-key menu-map
[eldoc]
282 '(menu-item "Auto-Display Documentation Strings" eldoc-mode
283 :button (:toggle . (bound-and-true-p eldoc-mode))
284 :help "Display the documentation string for the item under cursor"))
285 (define-key menu-map [checkdoc]
286 '(menu-item "Check Documentation Strings" checkdoc
287 :help "Check documentation strings for style requirements"))
288 (define-key menu-map [re-builder]
289 '(menu-item "Construct Regexp" re-builder
290 :help "Construct a regexp interactively"))
291 (define-key menu-map [tracing] (cons "Tracing" tracing-map))
292 (define-key tracing-map [tr-a]
293 '(menu-item "Untrace all" untrace-all
294 :help "Untraces all currently traced functions"))
295 (define-key tracing-map [tr-uf]
296 '(menu-item "Untrace function..." untrace-function
297 :help "Untraces FUNCTION and possibly activates all remaining advice"))
298 (define-key tracing-map [tr-sep] '("--"))
299 (define-key tracing-map [tr-q]
300 '(menu-item "Trace function quietly..." trace-function-background
301 :help "Trace the function with trace output going quietly to a buffer"))
302 (define-key tracing-map [tr-f]
303 '(menu-item "Trace function..." trace-function
304 :help "Trace the function given as a argument"))
305 (define-key menu-map [profiling] (cons "Profiling" prof-map))
306 (define-key prof-map [prof-restall]
307 '(menu-item "Remove Instrumentation for All Functions" elp-restore-all
308 :help "Restore the original definitions of all functions being profiled"))
309 (define-key prof-map [prof-restfunc]
310 '(menu-item "Remove Instrumentation for Function..." elp-restore-function
311 :help "Restore an instrumented function to its original definition"))
313 (define-key prof-map [sep-rem] '("--"))
314 (define-key prof-map [prof-resall]
315 '(menu-item "Reset Counters for All Functions" elp-reset-all
316 :help "Reset the profiling information for all functions being profiled"))
317 (define-key prof-map [prof-resfunc]
318 '(menu-item "Reset Counters for Function..." elp-reset-function
319 :help "Reset the profiling information for a function"))
320 (define-key prof-map [prof-res]
321 '(menu-item "Show Profiling Results" elp-results
322 :help "Display current profiling results"))
323 (define-key prof-map [prof-pack]
324 '(menu-item "Instrument Package..." elp-instrument-package
325 :help "Instrument for profiling all function that start with a prefix"))
326 (define-key prof-map [prof-func]
327 '(menu-item "Instrument Function..." elp-instrument-function
328 :help "Instrument a function for profiling"))
329 (define-key menu-map [edebug-defun]
330 '(menu-item "Instrument Function for Debugging" edebug-defun
331 :help "Evaluate the top level form point is in, stepping through with Edebug"
333 (define-key menu-map [separator-byte] '("--"))
334 (define-key menu-map [disas]
335 '(menu-item "Disassemble byte compiled object..." disassemble
336 :help "Print disassembled code for OBJECT in a buffer"))
337 (define-key menu-map [byte-recompile]
338 '(menu-item "Byte-recompile Directory..." byte-recompile-directory
339 :help "Recompile every `.el' file in DIRECTORY that needs recompilation"))
340 (define-key menu-map [emacs-byte-compile-and-load]
341 '(menu-item "Byte-compile And Load" emacs-lisp-byte-compile-and-load
342 :help "Byte-compile the current file (if it has changed), then load compiled code"))
343 (define-key menu-map [byte-compile]
344 '(menu-item "Byte-compile This File" emacs-lisp-byte-compile
345 :help "Byte compile the file containing the current buffer"))
346 (define-key menu-map [separator-eval] '("--"))
347 (define-key menu-map [ielm]
348 '(menu-item "Interactive Expression Evaluation" ielm
349 :help "Interactively evaluate Emacs Lisp expressions"))
350 (define-key menu-map [eval-buffer]
351 '(menu-item "Evaluate Buffer" eval-buffer
352 :help "Execute the current buffer as Lisp code"))
353 (define-key menu-map [eval-region]
354 '(menu-item "Evaluate Region" eval-region
355 :help "Execute the region as Lisp code"
356 :enable mark-active))
357 (define-key menu-map [eval-sexp]
358 '(menu-item "Evaluate Last S-expression" eval-last-sexp
359 :help "Evaluate sexp before point; print value in minibuffer"))
360 (define-key menu-map [separator-format] '("--"))
361 (define-key menu-map [comment-region]
362 '(menu-item "Comment Out Region" comment-region
363 :help "Comment or uncomment each line in the region"
364 :enable mark-active))
365 (define-key menu-map [indent-region]
366 '(menu-item "Indent Region" indent-region
367 :help "Indent each nonblank line in the region"
368 :enable mark-active))
369 (define-key menu-map [indent-line] '("Indent Line" . lisp-indent-line))
371 "Keymap for Emacs Lisp mode.
372 All commands in `lisp-mode-shared-map' are inherited by this map.")
374 (defun emacs-lisp-byte-compile ()
375 "Byte compile the file containing the current buffer."
378 (byte-compile-file buffer-file-name)
379 (error "The buffer must be saved in a file first")))
381 (defun emacs-lisp-byte-compile-and-load ()
382 "Byte-compile the current file (if it has changed), then load compiled code."
385 (error "The buffer must be saved in a file first"))
387 ;; Recompile if file or buffer has changed since last compilation.
388 (if (and (buffer-modified-p)
389 (y-or-n-p (format "Save buffer %s first? " (buffer-name))))
391 (let ((compiled-file-name (byte-compile-dest-file buffer-file-name)))
392 (if (file-newer-than-file-p compiled-file-name buffer-file-name)
393 (load-file compiled-file-name)
394 (byte-compile-file buffer-file-name t))))
396 (defcustom emacs-lisp-mode-hook nil
397 "Hook run when entering Emacs Lisp mode."
398 :options '(turn-on-eldoc-mode imenu-add-menubar-index checkdoc-minor-mode)
402 (defcustom lisp-mode-hook nil
403 "Hook run when entering Lisp mode."
404 :options '(imenu-add-menubar-index)
408 (defcustom lisp-interaction-mode-hook nil
409 "Hook run when entering Lisp Interaction mode."
410 :options '(turn-on-eldoc-mode)
414 (defun emacs-lisp-mode ()
415 "Major mode for editing Lisp code to run in Emacs.
417 Delete converts tabs to spaces as it moves back.
418 Blank lines separate paragraphs. Semicolons start comments.
419 \\{emacs-lisp-mode-map}
420 Entry to this mode calls the value of `emacs-lisp-mode-hook'
421 if that value is non-nil."
423 (kill-all-local-variables)
424 (use-local-map emacs-lisp-mode-map)
425 (set-syntax-table emacs-lisp-mode-syntax-table)
426 (setq major-mode 'emacs-lisp-mode)
427 (setq mode-name "Emacs-Lisp")
428 (lisp-mode-variables)
429 (setq imenu-case-fold-search nil)
430 (run-mode-hooks 'emacs-lisp-mode-hook))
431 (put 'emacs-lisp-mode 'custom-mode-group 'lisp)
433 (defvar lisp-mode-map
434 (let ((map (make-sparse-keymap))
435 (menu-map (make-sparse-keymap "Lisp")))
436 (set-keymap-parent map lisp-mode-shared-map)
437 (define-key map "\e\C-x" 'lisp-eval-defun)
438 (define-key map "\C-c\C-z" 'run-lisp)
439 (define-key map [menu-bar lisp] (cons "Lisp" menu-map))
440 (define-key menu-map [run-lisp]
441 '(menu-item "Run inferior Lisp" run-lisp
442 :help "Run an inferior Lisp process, input and output via buffer `*inferior-lisp*'"))
443 (define-key menu-map [ev-def]
444 '(menu-item "Eval defun" lisp-eval-defun
445 :help "Send the current defun to the Lisp process made by M-x run-lisp"))
446 (define-key menu-map [ind-sexp]
447 '(menu-item "Indent sexp" indent-sexp
448 :help "Indent each line of the list starting just after point"))
450 "Keymap for ordinary Lisp mode.
451 All commands in `lisp-mode-shared-map' are inherited by this map.")
454 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
456 Delete converts tabs to spaces as it moves back.
457 Blank lines separate paragraphs. Semicolons start comments.
459 Note that `run-lisp' may be used either to start an inferior Lisp job
460 or to switch back to an existing one.
462 Entry to this mode calls the value of `lisp-mode-hook'
463 if that value is non-nil."
465 (kill-all-local-variables)
466 (use-local-map lisp-mode-map)
467 (setq major-mode 'lisp-mode)
468 (setq mode-name "Lisp")
469 (lisp-mode-variables nil t)
470 (make-local-variable 'comment-start-skip)
471 (setq comment-start-skip
472 "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(;+\\|#|\\) *")
473 (setq imenu-case-fold-search t)
474 (set-syntax-table lisp-mode-syntax-table)
475 (run-mode-hooks 'lisp-mode-hook))
476 (put 'lisp-mode 'find-tag-default-function 'lisp-find-tag-default)
478 (defun lisp-find-tag-default ()
479 (let ((default (find-tag-default)))
480 (when (stringp default)
481 (if (string-match ":+" default)
482 (substring default (match-end 0))
485 ;; Used in old LispM code.
486 (defalias 'common-lisp-mode 'lisp-mode)
488 ;; This will do unless inf-lisp.el is loaded.
489 (defun lisp-eval-defun (&optional and-go)
490 "Send the current defun to the Lisp process made by \\[run-lisp]."
492 (error "Process lisp does not exist"))
494 (defvar lisp-interaction-mode-map
495 (let ((map (make-sparse-keymap))
496 (menu-map (make-sparse-keymap "Lisp-Interaction")))
497 (set-keymap-parent map lisp-mode-shared-map)
498 (define-key map "\e\C-x" 'eval-defun)
499 (define-key map "\e\C-q" 'indent-pp-sexp)
500 (define-key map "\e\t" 'lisp-complete-symbol)
501 (define-key map "\n" 'eval-print-last-sexp)
502 (define-key map [menu-bar lisp-interaction] (cons "Lisp-Interaction" menu-map))
503 (define-key menu-map [eval-defun]
504 '(menu-item "Evaluate Defun" eval-defun
505 :help "Evaluate the top-level form containing point, or after point"))
506 (define-key menu-map [eval-print-last-sexp]
507 '(menu-item "Evaluate and print" eval-print-last-sexp
508 :help "Evaluate sexp before point; print value into current buffer"))
509 (define-key menu-map [edebug-defun-lisp-interaction]
510 '(menu-item "Instrument Function for Debugging" edebug-defun
511 :help "Evaluate the top level form point is in, stepping through with Edebug"
513 (define-key menu-map [indent-pp-sexp]
514 '(menu-item "Indent or Pretty-Print" indent-pp-sexp
515 :help "Indent each line of the list starting just after point, or prettyprint it"))
516 (define-key menu-map [lisp-complete-symbol]
517 '(menu-item "Complete Lisp Symbol" lisp-complete-symbol
518 :help "Perform completion on Lisp symbol preceding point"))
520 "Keymap for Lisp Interaction mode.
521 All commands in `lisp-mode-shared-map' are inherited by this map.")
523 (defvar lisp-interaction-mode-abbrev-table lisp-mode-abbrev-table)
524 (define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
525 "Major mode for typing and evaluating Lisp forms.
526 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
527 before point, and prints its value into the buffer, advancing point.
528 Note that printing is controlled by `eval-expression-print-length'
529 and `eval-expression-print-level'.
532 Delete converts tabs to spaces as it moves back.
533 Paragraphs are separated only by blank lines.
534 Semicolons start comments.
535 \\{lisp-interaction-mode-map}
536 Entry to this mode calls the value of `lisp-interaction-mode-hook'
537 if that value is non-nil.")
539 (defun eval-print-last-sexp ()
540 "Evaluate sexp before point; print value into current buffer.
542 If `eval-expression-debug-on-error' is non-nil, which is the default,
543 this command arranges for all errors to enter the debugger.
545 Note that printing the result is controlled by the variables
546 `eval-expression-print-length' and `eval-expression-print-level',
549 (let ((standard-output (current-buffer)))
555 (defun last-sexp-setup-props (beg end value alt1 alt2)
556 "Set up text properties for the output of `eval-last-sexp-1'.
557 BEG and END are the start and end of the output in current-buffer.
558 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
559 alternative printed representations that can be displayed."
560 (let ((map (make-sparse-keymap)))
561 (define-key map "\C-m" 'last-sexp-toggle-display)
562 (define-key map [down-mouse-2] 'mouse-set-point)
563 (define-key map [mouse-2] 'last-sexp-toggle-display)
566 `(printed-value (,value ,alt1 ,alt2)
569 help-echo "RET, mouse-2: toggle abbreviated display"
570 rear-nonsticky (mouse-face keymap help-echo
574 (defun last-sexp-toggle-display (&optional arg)
575 "Toggle between abbreviated and unabbreviated printed representations."
579 (let ((value (get-text-property (point) 'printed-value)))
581 (let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
584 (end (or (next-single-char-property-change (point) 'printed-value) (point)))
585 (standard-output (current-buffer))
587 (delete-region beg end)
588 (insert (nth 1 value))
590 (setq point (1- (point))))
591 (last-sexp-setup-props beg (point)
595 (goto-char (min (point-max) point)))))))
597 (defun prin1-char (char)
598 "Return a string representing CHAR as a character rather than as an integer.
599 If CHAR is not a character, return nil."
602 (let ((c (event-basic-type char))
603 (mods (event-modifiers char))
605 ;; Prevent ?A from turning into ?\S-a.
606 (if (and (memq 'shift mods)
607 (zerop (logand char ?\S-\^@))
608 (not (let ((case-fold-search nil))
609 (char-equal c (upcase c)))))
610 (setq c (upcase c) mods nil))
611 ;; What string are we considering using?
618 (cond ((eq modif 'super) "\\s-")
619 (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
622 ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
627 ;; Verify the string reads a CHAR, not to some other character.
628 ;; If it doesn't, return nil instead.
630 (= (car (read-from-string string)) char)
634 (defun preceding-sexp ()
635 "Return sexp before the point."
636 (let ((opoint (point))
640 (with-syntax-table emacs-lisp-mode-syntax-table
641 ;; If this sexp appears to be enclosed in `...'
642 ;; then ignore the surrounding quotes.
644 (or (eq (following-char) ?\')
645 (eq (preceding-char) ?\')))
647 ;; If we were after `?\e' (or similar case),
648 ;; use the whole thing, not just the `e'.
649 (when (eq (preceding-char) ?\\)
651 (when (eq (preceding-char) ??)
655 (when (eq (preceding-char) ?=)
658 (skip-chars-backward "0-9#=")
659 (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
664 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
665 ;; `variable' so that the value is returned, not the
667 (if (and ignore-quotes
668 (eq (following-char) ?`))
670 (narrow-to-region (point-min) opoint)
671 (setq expr (read (current-buffer)))
672 ;; If it's an (interactive ...) form, it's more
673 ;; useful to show how an interactive call would
676 (eq (car expr) 'interactive)
678 (list 'call-interactively
687 (defun eval-last-sexp-1 (eval-last-sexp-arg-internal)
688 "Evaluate sexp before point; print value in minibuffer.
689 With argument, print output into current buffer."
690 (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
691 (eval-last-sexp-print-value (eval (preceding-sexp)))))
694 (defun eval-last-sexp-print-value (value)
695 (let ((unabbreviated (let ((print-length nil) (print-level nil))
696 (prin1-to-string value)))
697 (print-length eval-expression-print-length)
698 (print-level eval-expression-print-level)
703 (let ((str (eval-expression-print-format value)))
704 (if str (princ str)))
706 (when (and (bufferp standard-output)
707 (or (not (null print-length))
708 (not (null print-level)))
709 (not (string= unabbreviated
710 (buffer-substring-no-properties beg end))))
711 (last-sexp-setup-props beg end value
713 (buffer-substring-no-properties beg end))
717 (defvar eval-last-sexp-fake-value (make-symbol "t"))
719 (defun eval-last-sexp (eval-last-sexp-arg-internal)
720 "Evaluate sexp before point; print value in minibuffer.
721 Interactively, with prefix argument, print output into current buffer.
723 If `eval-expression-debug-on-error' is non-nil, which is the default,
724 this command arranges for all errors to enter the debugger."
726 (if (null eval-expression-debug-on-error)
727 (eval-last-sexp-1 eval-last-sexp-arg-internal)
729 (let ((debug-on-error eval-last-sexp-fake-value))
730 (cons (eval-last-sexp-1 eval-last-sexp-arg-internal)
732 (unless (eq (cdr value) eval-last-sexp-fake-value)
733 (setq debug-on-error (cdr value)))
736 (defun eval-defun-1 (form)
737 "Treat some expressions specially.
738 Reset the `defvar' and `defcustom' variables to the initial value.
739 Reinitialize the face according to the `defface' specification."
740 ;; The code in edebug-defun should be consistent with this, but not
741 ;; the same, since this gets a macroexpended form.
742 (cond ((not (listp form))
744 ((and (eq (car form) 'defvar)
745 (cdr-safe (cdr-safe form))
746 (boundp (cadr form)))
747 ;; Force variable to be re-set.
748 `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
749 (setq-default ,(nth 1 form) ,(nth 2 form))))
750 ;; `defcustom' is now macroexpanded to
751 ;; `custom-declare-variable' with a quoted value arg.
752 ((and (eq (car form) 'custom-declare-variable)
753 (default-boundp (eval (nth 1 form))))
754 ;; Force variable to be bound.
755 (set-default (eval (nth 1 form)) (eval (nth 1 (nth 2 form))))
757 ;; `defface' is macroexpanded to `custom-declare-face'.
758 ((eq (car form) 'custom-declare-face)
760 (setq face-new-frame-defaults
761 (assq-delete-all (eval (nth 1 form)) face-new-frame-defaults))
762 (put (eval (nth 1 form)) 'face-defface-spec nil)
763 ;; Setting `customized-face' to the new spec after calling
764 ;; the form, but preserving the old saved spec in `saved-face',
765 ;; imitates the situation when the new face spec is set
766 ;; temporarily for the current session in the customize
767 ;; buffer, thus allowing `face-user-default-spec' to use the
768 ;; new customized spec instead of the saved spec.
769 ;; Resetting `saved-face' temporarily to nil is needed to let
770 ;; `defface' change the spec, regardless of a saved spec.
772 (put ,(nth 1 form) 'saved-face
773 ',(get (eval (nth 1 form)) 'saved-face))
774 (put ,(nth 1 form) 'customized-face
776 (put (eval (nth 1 form)) 'saved-face nil)))
777 ((eq (car form) 'progn)
778 (cons 'progn (mapcar 'eval-defun-1 (cdr form))))
781 (defun eval-defun-2 ()
782 "Evaluate defun that point is in or before.
783 The value is displayed in the minibuffer.
784 If the current defun is actually a call to `defvar',
785 then reset the variable using the initial value expression
786 even if the variable already has some other value.
787 \(Normally `defvar' does not change the variable's value
788 if it already has a value.\)
790 With argument, insert value in current buffer after the defun.
791 Return the result of evaluation."
793 ;; FIXME: the print-length/level bindings should only be applied while
794 ;; printing, not while evaluating.
795 (let ((debug-on-error eval-expression-debug-on-error)
796 (print-length eval-expression-print-length)
797 (print-level eval-expression-print-level))
799 ;; Arrange for eval-region to "read" the (possibly) altered form.
800 ;; eval-region handles recording which file defines a function or
801 ;; variable. Re-written using `apply' to avoid capturing
802 ;; variables like `end'.
805 (let ((standard-output t)
807 ;; Read the form from the buffer, and record where it ends.
812 (setq form (read (current-buffer)))
814 ;; Alter the form if necessary.
815 (setq form (eval-defun-1 (macroexpand form)))
816 (list beg end standard-output
818 ;; Skipping to the end of the specified region
819 ;; will make eval-region return.
822 ;; The result of evaluation has been put onto VALUES. So return it.
825 (defun eval-defun (edebug-it)
826 "Evaluate the top-level form containing point, or after point.
828 If the current defun is actually a call to `defvar' or `defcustom',
829 evaluating it this way resets the variable using its initial value
830 expression even if the variable already has some other value.
831 \(Normally `defvar' and `defcustom' do not alter the value if there
832 already is one.) In an analogous way, evaluating a `defface'
833 overrides any customizations of the face, so that it becomes
834 defined exactly as the `defface' expression says.
836 If `eval-expression-debug-on-error' is non-nil, which is the default,
837 this command arranges for all errors to enter the debugger.
839 With a prefix argument, instrument the code for Edebug.
841 If acting on a `defun' for FUNCTION, and the function was
842 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
843 instrumented, just FUNCTION is printed.
845 If not acting on a `defun', the result of evaluation is displayed in
846 the minibuffer. This display is controlled by the variables
847 `eval-expression-print-length' and `eval-expression-print-level',
852 (eval-defun (not edebug-all-defs)))
854 (if (null eval-expression-debug-on-error)
856 (let ((old-value (make-symbol "t")) new-value value)
857 (let ((debug-on-error old-value))
858 (setq value (eval-defun-2))
859 (setq new-value debug-on-error))
860 (unless (eq old-value new-value)
861 (setq debug-on-error new-value))
864 ;; May still be used by some external Lisp-mode variant.
865 (define-obsolete-function-alias 'lisp-comment-indent
866 'comment-indent-default "22.1")
867 (define-obsolete-function-alias 'lisp-mode-auto-fill 'do-auto-fill "23.1")
869 (defcustom lisp-indent-offset nil
870 "If non-nil, indent second line of expressions that many more columns."
872 :type '(choice (const nil) integer))
873 (put 'lisp-body-indent 'safe-local-variable
874 (lambda (x) (or (null x) (integerp x))))
876 (defvar lisp-indent-function 'lisp-indent-function)
878 (defun lisp-indent-line (&optional whole-exp)
879 "Indent current line as Lisp code.
880 With argument, indent any additional lines of the same expression
881 rigidly along with this one."
883 (let ((indent (calculate-lisp-indent)) shift-amt end
884 (pos (- (point-max) (point)))
885 (beg (progn (beginning-of-line) (point))))
886 (skip-chars-forward " \t")
887 (if (or (null indent) (looking-at "\\s<\\s<\\s<"))
888 ;; Don't alter indentation of a ;;; comment line
889 ;; or a line that starts in a string.
890 (goto-char (- (point-max) pos))
891 (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
892 ;; Single-semicolon comment lines should be indented
893 ;; as comment lines, not as code.
894 (progn (indent-for-comment) (forward-char -1))
895 (if (listp indent) (setq indent (car indent)))
896 (setq shift-amt (- indent (current-column)))
897 (if (zerop shift-amt)
899 (delete-region beg (point))
901 ;; If initial point was within line's indentation,
902 ;; position after the indentation. Else stay at same point in text.
903 (if (> (- (point-max) pos) (point))
904 (goto-char (- (point-max) pos)))
905 ;; If desired, shift remaining lines of expression the same amount.
906 (and whole-exp (not (zerop shift-amt))
915 (indent-code-rigidly beg end shift-amt)))))
917 (defvar calculate-lisp-indent-last-sexp)
919 (defun calculate-lisp-indent (&optional parse-start)
920 "Return appropriate indentation for current line as Lisp code.
921 In usual case returns an integer: the column to indent to.
922 If the value is nil, that means don't change the indentation
923 because the line starts inside a string.
925 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
926 This means that following lines at the same level of indentation
927 should not necessarily be indented the same as this line.
928 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
929 is the buffer position of the start of the containing expression."
932 (let ((indent-point (point))
934 ;; setting this to a number inhibits calling hook
937 calculate-lisp-indent-last-sexp containing-sexp)
939 (goto-char parse-start)
940 (beginning-of-defun))
941 ;; Find outermost containing sexp
942 (while (< (point) indent-point)
943 (setq state (parse-partial-sexp (point) indent-point 0)))
944 ;; Find innermost containing sexp
947 (> (setq paren-depth (elt state 0)) 0))
949 (setq calculate-lisp-indent-last-sexp (elt state 2))
950 (setq containing-sexp (elt state 1))
951 ;; Position following last unclosed open.
952 (goto-char (1+ containing-sexp))
953 ;; Is there a complete sexp since then?
954 (if (and calculate-lisp-indent-last-sexp
955 (> calculate-lisp-indent-last-sexp (point)))
956 ;; Yes, but is there a containing sexp after that?
957 (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
959 (if (setq retry (car (cdr peek))) (setq state peek)))))
962 ;; Innermost containing sexp found
963 (goto-char (1+ containing-sexp))
964 (if (not calculate-lisp-indent-last-sexp)
965 ;; indent-point immediately follows open paren.
967 (setq desired-indent (current-column))
968 ;; Find the start of first element of containing sexp.
969 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
970 (cond ((looking-at "\\s(")
971 ;; First element of containing sexp is a list.
972 ;; Indent under that list.
974 ((> (save-excursion (forward-line 1) (point))
975 calculate-lisp-indent-last-sexp)
976 ;; This is the first line to start within the containing sexp.
977 ;; It's almost certainly a function call.
978 (if (= (point) calculate-lisp-indent-last-sexp)
979 ;; Containing sexp has nothing before this line
980 ;; except the first element. Indent under that element.
982 ;; Skip the first element, find start of second (the first
983 ;; argument of the function call) and indent under.
984 (progn (forward-sexp 1)
985 (parse-partial-sexp (point)
986 calculate-lisp-indent-last-sexp
988 (backward-prefix-chars))
990 ;; Indent beneath first sexp on same line as
991 ;; `calculate-lisp-indent-last-sexp'. Again, it's
992 ;; almost certainly a function call.
993 (goto-char calculate-lisp-indent-last-sexp)
995 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
997 (backward-prefix-chars)))))
998 ;; Point is at the point to indent under unless we are inside a string.
999 ;; Call indentation hook except when overridden by lisp-indent-offset
1000 ;; or if the desired indentation has already been computed.
1001 (let ((normal-indent (current-column)))
1002 (cond ((elt state 3)
1003 ;; Inside a string, don't change indentation.
1005 ((and (integerp lisp-indent-offset) containing-sexp)
1006 ;; Indent by constant offset
1007 (goto-char containing-sexp)
1008 (+ (current-column) lisp-indent-offset))
1009 ;; in this case calculate-lisp-indent-last-sexp is not nil
1010 (calculate-lisp-indent-last-sexp
1012 ;; try to align the parameters of a known function
1013 (and lisp-indent-function
1015 (funcall lisp-indent-function indent-point state))
1016 ;; If the function has no special alignment
1017 ;; or it does not apply to this argument,
1018 ;; try to align a constant-symbol under the last
1019 ;; preceding constant symbol, if there is such one of
1020 ;; the last 2 preceding symbols, in the previous
1021 ;; uncommented line.
1022 (and (save-excursion
1023 (goto-char indent-point)
1024 (skip-chars-forward " \t")
1026 ;; The last sexp may not be at the indentation
1027 ;; where it begins, so find that one, instead.
1029 (goto-char calculate-lisp-indent-last-sexp)
1030 ;; Handle prefix characters and whitespace
1031 ;; following an open paren. (Bug#1012)
1032 (backward-prefix-chars)
1033 (while (and (not (looking-back "^[ \t]*\\|([ \t]+"))
1034 (or (not containing-sexp)
1035 (< (1+ containing-sexp) (point))))
1037 (backward-prefix-chars))
1038 (setq calculate-lisp-indent-last-sexp (point)))
1039 (> calculate-lisp-indent-last-sexp
1041 (goto-char (1+ containing-sexp))
1042 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1044 (let ((parse-sexp-ignore-comments t)
1046 (goto-char calculate-lisp-indent-last-sexp)
1047 (or (and (looking-at ":")
1048 (setq indent (current-column)))
1049 (and (< (save-excursion (beginning-of-line) (point))
1050 (prog2 (backward-sexp) (point)))
1052 (setq indent (current-column))))
1054 ;; another symbols or constants not preceded by a constant
1055 ;; as defined above.
1057 ;; in this case calculate-lisp-indent-last-sexp is nil
1062 (defun lisp-indent-function (indent-point state)
1063 "This function is the normal value of the variable `lisp-indent-function'.
1064 It is used when indenting a line within a function call, to see if the
1065 called function says anything special about how to indent the line.
1067 INDENT-POINT is the position where the user typed TAB, or equivalent.
1068 Point is located at the point to indent under (for default indentation);
1069 STATE is the `parse-partial-sexp' state for that position.
1071 If the current line is in a call to a Lisp function
1072 which has a non-nil property `lisp-indent-function',
1073 that specifies how to do the indentation. The property value can be
1074 * `defun', meaning indent `defun'-style;
1075 * an integer N, meaning indent the first N arguments specially
1076 like ordinary function arguments and then indent any further
1077 arguments like a body;
1078 * a function to call just as this function was called.
1079 If that function returns nil, that means it doesn't specify
1082 This function also returns nil meaning don't specify the indentation."
1083 (let ((normal-indent (current-column)))
1084 (goto-char (1+ (elt state 1)))
1085 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1086 (if (and (elt state 2)
1087 (not (looking-at "\\sw\\|\\s_")))
1088 ;; car of form doesn't seem to be a symbol
1090 (if (not (> (save-excursion (forward-line 1) (point))
1091 calculate-lisp-indent-last-sexp))
1092 (progn (goto-char calculate-lisp-indent-last-sexp)
1094 (parse-partial-sexp (point)
1095 calculate-lisp-indent-last-sexp 0 t)))
1096 ;; Indent under the list or under the first sexp on the same
1097 ;; line as calculate-lisp-indent-last-sexp. Note that first
1098 ;; thing on that line has to be complete sexp since we are
1099 ;; inside the innermost containing sexp.
1100 (backward-prefix-chars)
1102 (let ((function (buffer-substring (point)
1103 (progn (forward-sexp 1) (point))))
1105 (setq method (or (get (intern-soft function) 'lisp-indent-function)
1106 (get (intern-soft function) 'lisp-indent-hook)))
1107 (cond ((or (eq method 'defun)
1109 (> (length function) 3)
1110 (string-match "\\`def" function)))
1111 (lisp-indent-defform state indent-point))
1113 (lisp-indent-specform method state
1114 indent-point normal-indent))
1116 (funcall method indent-point state)))))))
1118 (defcustom lisp-body-indent 2
1119 "Number of columns to indent the second line of a `(def...)' form."
1122 (put 'lisp-body-indent 'safe-local-variable 'integerp)
1124 (defun lisp-indent-specform (count state indent-point normal-indent)
1125 (let ((containing-form-start (elt state 1))
1127 body-indent containing-form-column)
1128 ;; Move to the start of containing form, calculate indentation
1129 ;; to use for non-distinguished forms (> count), and move past the
1130 ;; function symbol. lisp-indent-function guarantees that there is at
1131 ;; least one word or symbol character following open paren of containing
1133 (goto-char containing-form-start)
1134 (setq containing-form-column (current-column))
1135 (setq body-indent (+ lisp-body-indent containing-form-column))
1138 ;; Now find the start of the last form.
1139 (parse-partial-sexp (point) indent-point 1 t)
1140 (while (and (< (point) indent-point)
1143 (setq count (1- count))
1145 (parse-partial-sexp (point) indent-point 1 t))
1147 ;; Point is sitting on first character of last (or count) sexp.
1149 ;; A distinguished form. If it is the first or second form use double
1150 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
1151 ;; to 2 (the default), this just happens to work the same with if as
1152 ;; the older code, but it makes unwind-protect, condition-case,
1153 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
1154 ;; less hacked, behavior can be obtained by replacing below with
1155 ;; (list normal-indent containing-form-start).
1156 (if (<= (- i count) 1)
1157 (list (+ containing-form-column (* 2 lisp-body-indent))
1158 containing-form-start)
1159 (list normal-indent containing-form-start))
1160 ;; A non-distinguished form. Use body-indent if there are no
1161 ;; distinguished forms and this is the first undistinguished form,
1162 ;; or if this is the first undistinguished form and the preceding
1163 ;; distinguished form has indentation at least as great as body-indent.
1164 (if (or (and (= i 0) (= count 0))
1165 (and (= count 0) (<= body-indent normal-indent)))
1169 (defun lisp-indent-defform (state indent-point)
1170 (goto-char (car (cdr state)))
1172 (if (> (point) (car (cdr (cdr state))))
1174 (goto-char (car (cdr state)))
1175 (+ lisp-body-indent (current-column)))))
1178 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1179 ;; like defun if the first form is placed on the next line, otherwise
1180 ;; it is indented like any other form (i.e. forms line up under first).
1182 (put 'lambda 'lisp-indent-function 'defun)
1183 (put 'autoload 'lisp-indent-function 'defun)
1184 (put 'progn 'lisp-indent-function 0)
1185 (put 'prog1 'lisp-indent-function 1)
1186 (put 'prog2 'lisp-indent-function 2)
1187 (put 'save-excursion 'lisp-indent-function 0)
1188 (put 'save-window-excursion 'lisp-indent-function 0)
1189 (put 'save-selected-window 'lisp-indent-function 0)
1190 (put 'save-restriction 'lisp-indent-function 0)
1191 (put 'save-match-data 'lisp-indent-function 0)
1192 (put 'save-current-buffer 'lisp-indent-function 0)
1193 (put 'with-current-buffer 'lisp-indent-function 1)
1194 (put 'combine-after-change-calls 'lisp-indent-function 0)
1195 (put 'with-output-to-string 'lisp-indent-function 0)
1196 (put 'with-temp-file 'lisp-indent-function 1)
1197 (put 'with-temp-buffer 'lisp-indent-function 0)
1198 (put 'with-temp-message 'lisp-indent-function 1)
1199 (put 'with-syntax-table 'lisp-indent-function 1)
1200 (put 'let 'lisp-indent-function 1)
1201 (put 'let* 'lisp-indent-function 1)
1202 (put 'while 'lisp-indent-function 1)
1203 (put 'if 'lisp-indent-function 2)
1204 (put 'read-if 'lisp-indent-function 2)
1205 (put 'catch 'lisp-indent-function 1)
1206 (put 'condition-case 'lisp-indent-function 2)
1207 (put 'unwind-protect 'lisp-indent-function 1)
1208 (put 'with-output-to-temp-buffer 'lisp-indent-function 1)
1209 (put 'eval-after-load 'lisp-indent-function 1)
1210 (put 'dolist 'lisp-indent-function 1)
1211 (put 'dotimes 'lisp-indent-function 1)
1212 (put 'when 'lisp-indent-function 1)
1213 (put 'unless 'lisp-indent-function 1)
1215 (defun indent-sexp (&optional endpos)
1216 "Indent each line of the list starting just after point.
1217 If optional arg ENDPOS is given, indent each line, stopping when
1218 ENDPOS is encountered."
1220 (let ((indent-stack (list nil))
1222 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
1223 ;; so that calculate-lisp-indent will find the beginning of
1224 ;; the defun we are in.
1225 ;; If ENDPOS is nil, it is safe not to scan before point
1226 ;; since every line we indent is more deeply nested than point is.
1227 (starting-point (if endpos nil (point)))
1228 (last-point (point))
1229 last-depth bol outer-loop-done inner-loop-done state this-indent)
1231 ;; Get error now if we don't have a complete sexp after point.
1232 (save-excursion (forward-sexp 1)))
1234 (setq outer-loop-done nil)
1235 (while (if endpos (< (point) endpos)
1236 (not outer-loop-done))
1237 (setq last-depth next-depth
1238 inner-loop-done nil)
1239 ;; Parse this line so we can learn the state
1240 ;; to indent the next line.
1241 ;; This inner loop goes through only once
1242 ;; unless a line ends inside a string.
1243 (while (and (not inner-loop-done)
1244 (not (setq outer-loop-done (eobp))))
1245 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
1247 (setq next-depth (car state))
1248 ;; If the line contains a comment other than the sort
1249 ;; that is indented like code,
1250 ;; indent it now with indent-for-comment.
1251 ;; Comments indented like code are right already.
1252 ;; In any case clear the in-comment flag in the state
1253 ;; because parse-partial-sexp never sees the newlines.
1254 (if (car (nthcdr 4 state))
1255 (progn (indent-for-comment)
1257 (setcar (nthcdr 4 state) nil)))
1258 ;; If this line ends inside a string,
1259 ;; go straight to next line, remaining within the inner loop,
1260 ;; and turn off the \-flag.
1261 (if (car (nthcdr 3 state))
1264 (setcar (nthcdr 5 state) nil))
1265 (setq inner-loop-done t)))
1269 (setq indent-stack (nconc indent-stack
1270 (make-list (- next-depth) nil))
1271 last-depth (- last-depth next-depth)
1274 ;; Decide whether to exit.
1276 ;; If we have already reached the specified end,
1277 ;; give up and do not reindent this line.
1278 (if (<= endpos (point))
1279 (setq outer-loop-done t))
1280 ;; If no specified end, we are done if we have finished one sexp.
1281 (if (<= next-depth 0)
1282 (setq outer-loop-done t)))
1283 (unless outer-loop-done
1284 (while (> last-depth next-depth)
1285 (setq indent-stack (cdr indent-stack)
1286 last-depth (1- last-depth)))
1287 (while (< last-depth next-depth)
1288 (setq indent-stack (cons nil indent-stack)
1289 last-depth (1+ last-depth)))
1290 ;; Now indent the next line according
1291 ;; to what we learned from parsing the previous one.
1293 (skip-chars-forward " \t")
1294 ;; But not if the line is blank, or just a comment
1295 ;; (except for double-semi comments; indent them as usual).
1296 (if (or (eobp) (looking-at "\\s<\\|\n"))
1298 (if (and (car indent-stack)
1299 (>= (car indent-stack) 0))
1300 (setq this-indent (car indent-stack))
1301 (let ((val (calculate-lisp-indent
1302 (if (car indent-stack) (- (car indent-stack))
1305 (setq this-indent val)
1307 (setcar indent-stack
1308 (setq this-indent val))
1309 (setcar indent-stack (- (car (cdr val))))
1310 (setq this-indent (car val))))))
1311 (if (and this-indent (/= (current-column) this-indent))
1312 (progn (delete-region bol (point))
1313 (indent-to this-indent)))))
1315 (setq outer-loop-done (= (point) last-point))
1316 (setq last-point (point)))))))
1318 (defun lisp-indent-region (start end)
1319 "Indent every line whose first char is between START and END inclusive."
1321 (let ((endmark (copy-marker end)))
1323 (and (bolp) (not (eolp))
1325 (indent-sexp endmark)
1326 (set-marker endmark nil))))
1328 (defun indent-pp-sexp (&optional arg)
1329 "Indent each line of the list starting just after point, or prettyprint it.
1330 A prefix argument specifies pretty-printing."
1335 (narrow-to-region (point) (progn (forward-sexp 1) (point)))
1337 (goto-char (point-max))
1338 (if (eq (char-before) ?\n)
1339 (delete-char -1)))))
1342 ;;;; Lisp paragraph filling commands.
1344 (defcustom emacs-lisp-docstring-fill-column 65
1345 "Value of `fill-column' to use when filling a docstring.
1346 Any non-integer value means do not use a different value of
1347 `fill-column' when filling docstrings."
1348 :type '(choice (integer)
1349 (const :tag "Use the current `fill-column'" t))
1352 (defun lisp-fill-paragraph (&optional justify)
1353 "Like \\[fill-paragraph], but handle Emacs Lisp comments and docstrings.
1354 If any of the current line is a comment, fill the comment or the
1355 paragraph of it that point is in, preserving the comment's indentation
1356 and initial semicolons."
1358 (or (fill-comment-paragraph justify)
1359 ;; Since fill-comment-paragraph returned nil, that means we're not in
1360 ;; a comment: Point is on a program line; we are interested
1361 ;; particularly in docstring lines.
1363 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1364 ;; are buffer-local, but we avoid changing them so that they can be set
1365 ;; to make `forward-paragraph' and friends do something the user wants.
1367 ;; `paragraph-start': The `(' in the character alternative and the
1368 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1369 ;; sexps and backquoted sexps that follow a docstring from being filled
1370 ;; with the docstring. This setting has the consequence of inhibiting
1371 ;; filling many program lines that are not docstrings, which is sensible,
1372 ;; because the user probably asked to fill program lines by accident, or
1373 ;; expecting indentation (perhaps we should try to do indenting in that
1374 ;; case). The `;' and `:' stop the paragraph being filled at following
1375 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1376 ;; escaped to keep font-locking, filling, & paren matching in the source
1379 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1380 ;; a docstring and identifies it as a paragraph separator, so that it
1381 ;; won't be filled. (Since the first line of documentation stands alone
1382 ;; in some contexts, filling should not alter the contents the author has
1383 ;; chosen.) Only the first line of a docstring begins with whitespace
1384 ;; and a quotation mark and ends with a period or (rarely) a comma.
1386 ;; The `fill-column' is temporarily bound to
1387 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1388 (let ((paragraph-start (concat paragraph-start
1389 "\\|\\s-*\\([(;:\"]\\|`(\\|#'(\\)"))
1391 (concat paragraph-separate "\\|\\s-*\".*[,\\.]$"))
1392 (fill-column (if (and (integerp emacs-lisp-docstring-fill-column)
1393 (derived-mode-p 'emacs-lisp-mode))
1394 emacs-lisp-docstring-fill-column
1396 (fill-paragraph justify))
1397 ;; Never return nil.
1400 (defun indent-code-rigidly (start end arg &optional nochange-regexp)
1401 "Indent all lines of code, starting in the region, sideways by ARG columns.
1402 Does not affect lines starting inside comments or strings, assuming that
1403 the start of the region is not inside them.
1405 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1406 The last is a regexp which, if matched at the beginning of a line,
1407 means don't indent that line."
1408 (interactive "r\np")
1412 (setq end (point-marker))
1415 (setq state (parse-partial-sexp (point)
1417 (forward-line 1) (point))
1419 (while (< (point) end)
1420 (or (car (nthcdr 3 state))
1421 (and nochange-regexp
1422 (looking-at nochange-regexp))
1423 ;; If line does not start in string, indent it
1424 (let ((indent (current-indentation)))
1425 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
1427 (indent-to (max 0 (+ indent arg)) 0))))
1428 (setq state (parse-partial-sexp (point)
1430 (forward-line 1) (point))
1433 (provide 'lisp-mode)
1435 ;; arch-tag: 414c7f93-c245-4b77-8ed5-ed05ef7ff1bf
1436 ;;; lisp-mode.el ends here