1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands
3 ;; Copyright (C) 1985, 1986, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Keywords: lisp, languages
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
28 ;; This mode is documented in the Emacs manual.
32 (defvar font-lock-comment-face
)
33 (defvar font-lock-doc-face
)
34 (defvar font-lock-keywords-case-fold-search
)
35 (defvar font-lock-string-face
)
37 (defvar lisp-mode-abbrev-table nil
)
39 (define-abbrev-table 'lisp-mode-abbrev-table
())
41 (defvar emacs-lisp-mode-syntax-table
42 (let ((table (make-syntax-table)))
45 (modify-syntax-entry i
"_ " table
)
49 (modify-syntax-entry i
"_ " table
)
53 (modify-syntax-entry i
"_ " table
)
57 (modify-syntax-entry i
"_ " table
)
59 (modify-syntax-entry ?\s
" " table
)
60 ;; Non-break space acts as whitespace.
61 (modify-syntax-entry ?
\x8a0 " " table
)
62 (modify-syntax-entry ?
\t " " table
)
63 (modify-syntax-entry ?
\f " " table
)
64 (modify-syntax-entry ?
\n "> " table
)
65 ;; This is probably obsolete since nowadays such features use overlays.
66 ;; ;; Give CR the same syntax as newline, for selective-display.
67 ;; (modify-syntax-entry ?\^m "> " table)
68 (modify-syntax-entry ?\
; "< " table)
69 (modify-syntax-entry ?
` "' " table
)
70 (modify-syntax-entry ?
' "' " table
)
71 (modify-syntax-entry ?
, "' " table
)
72 (modify-syntax-entry ?
@ "' " table
)
73 ;; Used to be singlequote; changed for flonums.
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
)
81 (modify-syntax-entry ?\
] ")[ " table
))
83 "Syntax table used in `emacs-lisp-mode'.")
85 (defvar lisp-mode-syntax-table
86 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table
)))
87 (modify-syntax-entry ?\
[ "_ " table
)
88 (modify-syntax-entry ?\
] "_ " table
)
89 (modify-syntax-entry ?
# "' 14" table
)
90 (modify-syntax-entry ?|
"\" 23bn" table
)
92 "Syntax table used in `lisp-mode'.")
94 (defvar lisp-imenu-generic-expression
97 (purecopy (concat "^\\s-*("
100 '("defun" "defun*" "defsubst" "defmacro"
101 "defadvice" "define-skeleton"
102 "define-minor-mode" "define-global-minor-mode"
103 "define-globalized-minor-mode"
104 "define-derived-mode" "define-generic-mode"
105 "define-compiler-macro" "define-modify-macro"
106 "defsetf" "define-setf-expander"
107 "define-method-combination"
108 "defgeneric" "defmethod") t
))
109 "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
111 (list (purecopy "Variables")
112 (purecopy (concat "^\\s-*("
115 '("defvar" "defconst" "defconstant" "defcustom"
116 "defparameter" "define-symbol-macro") t
))
117 "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
119 (list (purecopy "Types")
120 (purecopy (concat "^\\s-*("
123 '("defgroup" "deftheme" "deftype" "defstruct"
124 "defclass" "define-condition" "define-widget"
125 "defface" "defpackage") t
))
126 "\\s-+'?\\(\\(\\sw\\|\\s_\\)+\\)"))
129 "Imenu generic expression for Lisp mode. See `imenu-generic-expression'.")
131 ;; This was originally in autoload.el and is still used there.
132 (put 'autoload
'doc-string-elt
3)
133 (put 'defun
'doc-string-elt
3)
134 (put 'defun
* 'doc-string-elt
3)
135 (put 'defvar
'doc-string-elt
3)
136 (put 'defcustom
'doc-string-elt
3)
137 (put 'deftheme
'doc-string-elt
2)
138 (put 'deftype
'doc-string-elt
3)
139 (put 'defconst
'doc-string-elt
3)
140 (put 'defmacro
'doc-string-elt
3)
141 (put 'defmacro
* 'doc-string-elt
3)
142 (put 'defsubst
'doc-string-elt
3)
143 (put 'defstruct
'doc-string-elt
2)
144 (put 'define-skeleton
'doc-string-elt
2)
145 (put 'define-derived-mode
'doc-string-elt
4)
146 (put 'define-compilation-mode
'doc-string-elt
3)
147 (put 'easy-mmode-define-minor-mode
'doc-string-elt
2)
148 (put 'define-minor-mode
'doc-string-elt
2)
149 (put 'easy-mmode-define-global-mode
'doc-string-elt
2)
150 (put 'define-global-minor-mode
'doc-string-elt
2)
151 (put 'define-globalized-minor-mode
'doc-string-elt
2)
152 (put 'define-generic-mode
'doc-string-elt
7)
153 (put 'define-ibuffer-filter
'doc-string-elt
2)
154 (put 'define-ibuffer-op
'doc-string-elt
3)
155 (put 'define-ibuffer-sorter
'doc-string-elt
2)
156 (put 'lambda
'doc-string-elt
2)
157 (put 'defalias
'doc-string-elt
3)
158 (put 'defvaralias
'doc-string-elt
3)
159 (put 'define-category
'doc-string-elt
2)
160 (put 'define-overloadable-function
'doc-string-elt
3)
162 (defvar lisp-doc-string-elt-property
'doc-string-elt
163 "The symbol property that holds the docstring position info.")
165 (defun lisp-font-lock-syntactic-face-function (state)
167 ;; This might be a (doc)string or a |...| symbol.
168 (let ((startpos (nth 8 state
)))
169 (if (eq (char-after startpos
) ?|
)
170 ;; This is not a string, but a |...| symbol.
172 (let* ((listbeg (nth 1 state
))
173 (firstsym (and listbeg
176 (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
178 (docelt (and firstsym
(get (intern-soft firstsym
)
179 lisp-doc-string-elt-property
))))
181 ;; It's a string in a form that can have a docstring.
182 ;; Check whether it's in docstring position.
184 (when (functionp docelt
)
185 (goto-char (match-end 1))
186 (setq docelt
(funcall docelt
)))
190 (while (and (> docelt
0) (< (point) startpos
)
191 (progn (forward-sexp 1) t
))
192 (setq docelt
(1- docelt
)))
194 (and (zerop docelt
) (<= (point) startpos
)
195 (progn (forward-comment (point-max)) t
)
196 (= (point) (nth 8 state
)))))
198 font-lock-string-face
))))
199 font-lock-comment-face
))
201 (defun lisp-mode-variables (&optional lisp-syntax keywords-case-insensitive
)
202 "Common initialization routine for lisp modes.
203 The LISP-SYNTAX argument is used by code in inf-lisp.el and is
204 \(uselessly) passed from pp.el, chistory.el, gnus-kill.el and
205 score-mode.el. KEYWORDS-CASE-INSENSITIVE non-nil means that for
206 font-lock keywords will not be case sensitive."
208 (set-syntax-table lisp-mode-syntax-table
))
209 (setq local-abbrev-table lisp-mode-abbrev-table
)
210 (make-local-variable 'paragraph-ignore-fill-prefix
)
211 (setq paragraph-ignore-fill-prefix t
)
212 (make-local-variable 'fill-paragraph-function
)
213 (setq fill-paragraph-function
'lisp-fill-paragraph
)
214 ;; Adaptive fill mode gets the fill wrong for a one-line paragraph made of
215 ;; a single docstring. Let's fix it here.
216 (set (make-local-variable 'adaptive-fill-function
)
217 (lambda () (if (looking-at "\\s-+\"[^\n\"]+\"\\s-*$") "")))
218 ;; Adaptive fill mode gets in the way of auto-fill,
219 ;; and should make no difference for explicit fill
220 ;; because lisp-fill-paragraph should do the job.
221 ;; I believe that newcomment's auto-fill code properly deals with it -stef
222 ;;(set (make-local-variable 'adaptive-fill-mode) nil)
223 (make-local-variable 'indent-line-function
)
224 (setq indent-line-function
'lisp-indent-line
)
225 (make-local-variable 'outline-regexp
)
226 (setq outline-regexp
";;;\\(;* [^ \t\n]\\|###autoload\\)\\|(")
227 (make-local-variable 'outline-level
)
228 (setq outline-level
'lisp-outline-level
)
229 (make-local-variable 'comment-start
)
230 (setq comment-start
";")
231 (make-local-variable 'comment-start-skip
)
232 ;; Look within the line for a ; following an even number of backslashes
233 ;; after either a non-backslash or the line beginning.
234 (setq comment-start-skip
"\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\);+ *")
235 (make-local-variable 'font-lock-comment-start-skip
)
236 ;; Font lock mode uses this only when it KNOWS a comment is starting.
237 (setq font-lock-comment-start-skip
";+ *")
238 (make-local-variable 'comment-add
)
239 (setq comment-add
1) ;default to `;;' in comment-region
240 (make-local-variable 'comment-column
)
241 (setq comment-column
40)
242 ;; Don't get confused by `;' in doc strings when paragraph-filling.
243 (set (make-local-variable 'comment-use-global-state
) t
)
244 (make-local-variable 'imenu-generic-expression
)
245 (setq imenu-generic-expression lisp-imenu-generic-expression
)
246 (make-local-variable 'multibyte-syntax-as-symbol
)
247 (setq multibyte-syntax-as-symbol t
)
248 (set (make-local-variable 'syntax-begin-function
) 'beginning-of-defun
)
249 (setq font-lock-defaults
250 `((lisp-font-lock-keywords
251 lisp-font-lock-keywords-1 lisp-font-lock-keywords-2
)
252 nil
,keywords-case-insensitive
(("+-*/.<>=!?$%_&~^:@" .
"w")) nil
253 (font-lock-mark-block-function . mark-defun
)
254 (font-lock-syntactic-face-function
255 . lisp-font-lock-syntactic-face-function
))))
257 (defun lisp-outline-level ()
258 "Lisp mode `outline-level' function."
259 (let ((len (- (match-end 0) (match-beginning 0))))
260 (if (looking-at "(\\|;;;###autoload")
264 (defvar lisp-mode-shared-map
265 (let ((map (make-sparse-keymap)))
266 (define-key map
"\e\C-q" 'indent-sexp
)
267 (define-key map
"\177" 'backward-delete-char-untabify
)
268 ;; This gets in the way when viewing a Lisp file in view-mode. As
269 ;; long as [backspace] is mapped into DEL via the
270 ;; function-key-map, this should remain disabled!!
271 ;;;(define-key map [backspace] 'backward-delete-char-untabify)
273 "Keymap for commands shared by all sorts of Lisp modes.")
275 (defvar emacs-lisp-mode-map
276 (let ((map (make-sparse-keymap "Emacs-Lisp"))
277 (menu-map (make-sparse-keymap "Emacs-Lisp"))
278 (lint-map (make-sparse-keymap))
279 (prof-map (make-sparse-keymap))
280 (tracing-map (make-sparse-keymap)))
281 (set-keymap-parent map lisp-mode-shared-map
)
282 (define-key map
"\e\t" 'completion-at-point
)
283 (define-key map
"\e\C-x" 'eval-defun
)
284 (define-key map
"\e\C-q" 'indent-pp-sexp
)
285 (define-key map
[menu-bar emacs-lisp
] (cons (purecopy "Emacs-Lisp") menu-map
))
286 (define-key menu-map
[eldoc]
287 `(menu-item ,(purecopy "Auto-Display Documentation Strings") eldoc-mode
288 :button (:toggle . (bound-and-true-p eldoc-mode))
289 :help ,(purecopy "Display the documentation string for the item under cursor")))
290 (define-key menu-map [checkdoc]
291 `(menu-item ,(purecopy "Check Documentation Strings") checkdoc
292 :help ,(purecopy "Check documentation strings for style requirements")))
293 (define-key menu-map [re-builder]
294 `(menu-item ,(purecopy "Construct Regexp") re-builder
295 :help ,(purecopy "Construct a regexp interactively")))
296 (define-key menu-map [tracing] (cons (purecopy "Tracing") tracing-map))
297 (define-key tracing-map [tr-a]
298 `(menu-item ,(purecopy "Untrace All") untrace-all
299 :help ,(purecopy "Untrace all currently traced functions")))
300 (define-key tracing-map [tr-uf]
301 `(menu-item ,(purecopy "Untrace function...") untrace-function
302 :help ,(purecopy "Untrace function, and possibly activate all remaining advice")))
303 (define-key tracing-map [tr-sep] menu-bar-separator)
304 (define-key tracing-map [tr-q]
305 `(menu-item ,(purecopy "Trace Function Quietly...") trace-function-background
306 :help ,(purecopy "Trace the function with trace output going quietly to a buffer")))
307 (define-key tracing-map [tr-f]
308 `(menu-item ,(purecopy "Trace Function...") trace-function
309 :help ,(purecopy "Trace the function given as an argument")))
310 (define-key menu-map [profiling] (cons (purecopy "Profiling") prof-map))
311 (define-key prof-map [prof-restall]
312 `(menu-item ,(purecopy "Remove Instrumentation for All Functions") elp-restore-all
313 :help ,(purecopy "Restore the original definitions of all functions being profiled")))
314 (define-key prof-map [prof-restfunc]
315 `(menu-item ,(purecopy "Remove Instrumentation for Function...") elp-restore-function
316 :help ,(purecopy "Restore an instrumented function to its original definition")))
318 (define-key prof-map [sep-rem] menu-bar-separator)
319 (define-key prof-map [prof-resall]
320 `(menu-item ,(purecopy "Reset Counters for All Functions") elp-reset-all
321 :help ,(purecopy "Reset the profiling information for all functions being profiled")))
322 (define-key prof-map [prof-resfunc]
323 `(menu-item ,(purecopy "Reset Counters for Function...") elp-reset-function
324 :help ,(purecopy "Reset the profiling information for a function")))
325 (define-key prof-map [prof-res]
326 `(menu-item ,(purecopy "Show Profiling Results") elp-results
327 :help ,(purecopy "Display current profiling results")))
328 (define-key prof-map [prof-pack]
329 `(menu-item ,(purecopy "Instrument Package...") elp-instrument-package
330 :help ,(purecopy "Instrument for profiling all function that start with a prefix")))
331 (define-key prof-map [prof-func]
332 `(menu-item ,(purecopy "Instrument Function...") elp-instrument-function
333 :help ,(purecopy "Instrument a function for profiling")))
334 (define-key menu-map [lint] (cons (purecopy "Linting") lint-map))
335 (define-key lint-map [lint-di]
336 `(menu-item ,(purecopy "Lint Directory...") elint-directory
337 :help ,(purecopy "Lint a directory")))
338 (define-key lint-map [lint-f]
339 `(menu-item ,(purecopy "Lint File...") elint-file
340 :help ,(purecopy "Lint a file")))
341 (define-key lint-map [lint-b]
342 `(menu-item ,(purecopy "Lint Buffer") elint-current-buffer
343 :help ,(purecopy "Lint the current buffer")))
344 (define-key lint-map [lint-d]
345 `(menu-item ,(purecopy "Lint Defun") elint-defun
346 :help ,(purecopy "Lint the function at point")))
347 (define-key menu-map [edebug-defun]
348 `(menu-item ,(purecopy "Instrument Function for Debugging") edebug-defun
349 :help ,(purecopy "Evaluate the top level form point is in, stepping through with Edebug")
350 :keys ,(purecopy "C-u C-M-x")))
351 (define-key menu-map [separator-byte] menu-bar-separator)
352 (define-key menu-map [disas]
353 `(menu-item ,(purecopy "Disassemble Byte Compiled Object...") disassemble
354 :help ,(purecopy "Print disassembled code for OBJECT in a buffer")))
355 (define-key menu-map [byte-recompile]
356 `(menu-item ,(purecopy "Byte-recompile Directory...") byte-recompile-directory
357 :help ,(purecopy "Recompile every `.el' file in DIRECTORY that needs recompilation")))
358 (define-key menu-map [emacs-byte-compile-and-load]
359 `(menu-item ,(purecopy "Byte-compile and Load") emacs-lisp-byte-compile-and-load
360 :help ,(purecopy "Byte-compile the current file (if it has changed), then load compiled code")))
361 (define-key menu-map [byte-compile]
362 `(menu-item ,(purecopy "Byte-compile this File") emacs-lisp-byte-compile
363 :help ,(purecopy "Byte compile the file containing the current buffer")))
364 (define-key menu-map [separator-eval] menu-bar-separator)
365 (define-key menu-map [ielm]
366 `(menu-item ,(purecopy "Interactive Expression Evaluation") ielm
367 :help ,(purecopy "Interactively evaluate Emacs Lisp expressions")))
368 (define-key menu-map [eval-buffer]
369 `(menu-item ,(purecopy "Evaluate Buffer") eval-buffer
370 :help ,(purecopy "Execute the current buffer as Lisp code")))
371 (define-key menu-map [eval-region]
372 `(menu-item ,(purecopy "Evaluate Region") eval-region
373 :help ,(purecopy "Execute the region as Lisp code")
374 :enable mark-active))
375 (define-key menu-map [eval-sexp]
376 `(menu-item ,(purecopy "Evaluate Last S-expression") eval-last-sexp
377 :help ,(purecopy "Evaluate sexp before point; print value in minibuffer")))
378 (define-key menu-map [separator-format] menu-bar-separator)
379 (define-key menu-map [comment-region]
380 `(menu-item ,(purecopy "Comment Out Region") comment-region
381 :help ,(purecopy "Comment or uncomment each line in the region")
382 :enable mark-active))
383 (define-key menu-map [indent-region]
384 `(menu-item ,(purecopy "Indent Region") indent-region
385 :help ,(purecopy "Indent each nonblank line in the region")
386 :enable mark-active))
387 (define-key menu-map [indent-line]
388 `(menu-item ,(purecopy "Indent Line") lisp-indent-line))
390 "Keymap for Emacs Lisp mode.
391 All commands in `lisp-mode-shared-map' are inherited by this map.")
393 (defun emacs-lisp-byte-compile ()
394 "Byte compile the file containing the current buffer."
397 (byte-compile-file buffer-file-name)
398 (error "The buffer must be saved in a file first")))
400 (defun emacs-lisp-byte-compile-and-load ()
401 "Byte-compile the current file (if it has changed), then load compiled code."
404 (error "The buffer must be saved in a file first"))
406 ;; Recompile if file or buffer has changed since last compilation.
407 (if (and (buffer-modified-p)
408 (y-or-n-p (format "Save buffer %s first? " (buffer-name))))
410 (byte-recompile-file buffer-file-name nil 0 t))
412 (defcustom emacs-lisp-mode-hook nil
413 "Hook run when entering Emacs Lisp mode."
414 :options '(turn-on-eldoc-mode imenu-add-menubar-index checkdoc-minor-mode)
418 (defcustom lisp-mode-hook nil
419 "Hook run when entering Lisp mode."
420 :options '(imenu-add-menubar-index)
424 (defcustom lisp-interaction-mode-hook nil
425 "Hook run when entering Lisp Interaction mode."
426 :options '(turn-on-eldoc-mode)
430 (define-derived-mode emacs-lisp-mode prog-mode "Emacs-Lisp"
431 "Major mode for editing Lisp code to run in Emacs.
433 Delete converts tabs to spaces as it moves back.
434 Blank lines separate paragraphs. Semicolons start comments.
436 \\{emacs-lisp-mode-map}
437 Entry to this mode calls the value of `emacs-lisp-mode-hook'
438 if that value is non-nil."
440 (lisp-mode-variables)
441 (setq imenu-case-fold-search nil)
442 (add-hook 'completion-at-point-functions
443 'lisp-completion-at-point nil 'local))
445 (defvar lisp-mode-map
446 (let ((map (make-sparse-keymap))
447 (menu-map (make-sparse-keymap "Lisp")))
448 (set-keymap-parent map lisp-mode-shared-map)
449 (define-key map "\e\C-x" 'lisp-eval-defun)
450 (define-key map "\C-c\C-z" 'run-lisp)
451 (define-key map [menu-bar lisp] (cons (purecopy "Lisp") menu-map))
452 (define-key menu-map [run-lisp]
453 `(menu-item ,(purecopy "Run inferior Lisp") run-lisp
454 :help ,(purecopy "Run an inferior Lisp process, input and output via buffer `*inferior-lisp*'")))
455 (define-key menu-map [ev-def]
456 `(menu-item ,(purecopy "Eval defun") lisp-eval-defun
457 :help ,(purecopy "Send the current defun to the Lisp process made by M-x run-lisp")))
458 (define-key menu-map [ind-sexp]
459 `(menu-item ,(purecopy "Indent sexp") indent-sexp
460 :help ,(purecopy "Indent each line of the list starting just after point")))
462 "Keymap for ordinary Lisp mode.
463 All commands in `lisp-mode-shared-map' are inherited by this map.")
465 (define-derived-mode lisp-mode prog-mode "Lisp"
466 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
468 Delete converts tabs to spaces as it moves back.
469 Blank lines separate paragraphs. Semicolons start comments.
472 Note that `run-lisp' may be used either to start an inferior Lisp job
473 or to switch back to an existing one.
475 Entry to this mode calls the value of `lisp-mode-hook'
476 if that value is non-nil."
477 (lisp-mode-variables nil t)
478 (set (make-local-variable 'find-tag-default-function) 'lisp-find-tag-default)
479 (make-local-variable 'comment-start-skip)
480 (setq comment-start-skip
481 "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(;+\\|#|\\) *")
482 (setq imenu-case-fold-search t))
484 (defun lisp-find-tag-default ()
485 (let ((default (find-tag-default)))
486 (when (stringp default)
487 (if (string-match ":+" default)
488 (substring default (match-end 0))
491 ;; Used in old LispM code.
492 (defalias 'common-lisp-mode 'lisp-mode)
494 ;; This will do unless inf-lisp.el is loaded.
495 (defun lisp-eval-defun (&optional and-go)
496 "Send the current defun to the Lisp process made by \\[run-lisp]."
498 (error "Process lisp does not exist"))
500 (defvar lisp-interaction-mode-map
501 (let ((map (make-sparse-keymap))
502 (menu-map (make-sparse-keymap "Lisp-Interaction")))
503 (set-keymap-parent map lisp-mode-shared-map)
504 (define-key map "\e\C-x" 'eval-defun)
505 (define-key map "\e\C-q" 'indent-pp-sexp)
506 (define-key map "\e\t" 'completion-at-point)
507 (define-key map "\n" 'eval-print-last-sexp)
508 (define-key map [menu-bar lisp-interaction] (cons (purecopy "Lisp-Interaction") menu-map))
509 (define-key menu-map [eval-defun]
510 `(menu-item ,(purecopy "Evaluate Defun") eval-defun
511 :help ,(purecopy "Evaluate the top-level form containing point, or after point")))
512 (define-key menu-map [eval-print-last-sexp]
513 `(menu-item ,(purecopy "Evaluate and print") eval-print-last-sexp
514 :help ,(purecopy "Evaluate sexp before point; print value into current buffer")))
515 (define-key menu-map [edebug-defun-lisp-interaction]
516 `(menu-item ,(purecopy "Instrument Function for Debugging") edebug-defun
517 :help ,(purecopy "Evaluate the top level form point is in, stepping through with Edebug")
518 :keys ,(purecopy "C-u C-M-x")))
519 (define-key menu-map [indent-pp-sexp]
520 `(menu-item ,(purecopy "Indent or Pretty-Print") indent-pp-sexp
521 :help ,(purecopy "Indent each line of the list starting just after point, or prettyprint it")))
522 (define-key menu-map [complete-symbol]
523 `(menu-item ,(purecopy "Complete Lisp Symbol") completion-at-point
524 :help ,(purecopy "Perform completion on Lisp symbol preceding point")))
526 "Keymap for Lisp Interaction mode.
527 All commands in `lisp-mode-shared-map' are inherited by this map.")
529 (defvar lisp-interaction-mode-abbrev-table lisp-mode-abbrev-table)
530 (define-derived-mode lisp-interaction-mode emacs-lisp-mode "Lisp Interaction"
531 "Major mode for typing and evaluating Lisp forms.
532 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
533 before point, and prints its value into the buffer, advancing point.
534 Note that printing is controlled by `eval-expression-print-length'
535 and `eval-expression-print-level'.
538 Delete converts tabs to spaces as it moves back.
539 Paragraphs are separated only by blank lines.
540 Semicolons start comments.
542 \\{lisp-interaction-mode-map}
543 Entry to this mode calls the value of `lisp-interaction-mode-hook'
544 if that value is non-nil.")
546 (defun eval-print-last-sexp ()
547 "Evaluate sexp before point; print value into current buffer.
549 If `eval-expression-debug-on-error' is non-nil, which is the default,
550 this command arranges for all errors to enter the debugger.
552 Note that printing the result is controlled by the variables
553 `eval-expression-print-length' and `eval-expression-print-level',
556 (let ((standard-output (current-buffer)))
562 (defun last-sexp-setup-props (beg end value alt1 alt2)
563 "Set up text properties for the output of `eval-last-sexp-1'.
564 BEG and END are the start and end of the output in current-buffer.
565 VALUE is the Lisp value printed, ALT1 and ALT2 are strings for the
566 alternative printed representations that can be displayed."
567 (let ((map (make-sparse-keymap)))
568 (define-key map "\C-m" 'last-sexp-toggle-display)
569 (define-key map [down-mouse-2] 'mouse-set-point)
570 (define-key map [mouse-2] 'last-sexp-toggle-display)
573 `(printed-value (,value ,alt1 ,alt2)
576 help-echo "RET, mouse-2: toggle abbreviated display"
577 rear-nonsticky (mouse-face keymap help-echo
581 (defun last-sexp-toggle-display (&optional arg)
582 "Toggle between abbreviated and unabbreviated printed representations."
586 (let ((value (get-text-property (point) 'printed-value)))
588 (let ((beg (or (previous-single-property-change (min (point-max) (1+ (point)))
591 (end (or (next-single-char-property-change (point) 'printed-value) (point)))
592 (standard-output (current-buffer))
594 (delete-region beg end)
595 (insert (nth 1 value))
597 (setq point (1- (point))))
598 (last-sexp-setup-props beg (point)
602 (goto-char (min (point-max) point)))))))
604 (defun prin1-char (char)
605 "Return a string representing CHAR as a character rather than as an integer.
606 If CHAR is not a character, return nil."
609 (let ((c (event-basic-type char))
610 (mods (event-modifiers char))
612 ;; Prevent ?A from turning into ?\S-a.
613 (if (and (memq 'shift mods)
614 (zerop (logand char ?\S-\^@))
615 (not (let ((case-fold-search nil))
616 (char-equal c (upcase c)))))
617 (setq c (upcase c) mods nil))
618 ;; What string are we considering using?
625 (cond ((eq modif 'super) "\\s-")
626 (t (string ?\\ (upcase (aref (symbol-name modif) 0)) ?-))))
629 ((memq c '(?\; ?\( ?\) ?\{ ?\} ?\[ ?\] ?\" ?\' ?\\)) (string ?\\ c))
634 ;; Verify the string reads a CHAR, not to some other character.
635 ;; If it doesn't, return nil instead.
637 (= (car (read-from-string string)) char)
641 (defun preceding-sexp ()
642 "Return sexp before the point."
643 (let ((opoint (point))
647 (with-syntax-table emacs-lisp-mode-syntax-table
648 ;; If this sexp appears to be enclosed in `...'
649 ;; then ignore the surrounding quotes.
651 (or (eq (following-char) ?\')
652 (eq (preceding-char) ?\')))
654 ;; If we were after `?\e' (or similar case),
655 ;; use the whole thing, not just the `e'.
656 (when (eq (preceding-char) ?\\)
658 (when (eq (preceding-char) ??)
661 ;; Skip over hash table read syntax.
662 (and (> (point) (1+ (point-min)))
663 (looking-back "#s" (- (point) 2))
667 (when (eq (preceding-char) ?=)
670 (skip-chars-backward "0-9#=")
671 (setq labeled-p (looking-at "\\(#[0-9]+=\\)+")))
676 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
677 ;; `variable' so that the value is returned, not the
679 (if (and ignore-quotes
680 (eq (following-char) ?`))
682 (narrow-to-region (point-min) opoint)
683 (setq expr (read (current-buffer)))
684 ;; If it's an (interactive ...) form, it's more
685 ;; useful to show how an interactive call would
688 (eq (car expr) 'interactive)
690 (list 'call-interactively
699 (defun eval-last-sexp-1 (eval-last-sexp-arg-internal)
700 "Evaluate sexp before point; print value in minibuffer.
701 With argument, print output into current buffer."
702 (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
703 ;; Setup the lexical environment if lexical-binding is enabled.
704 (eval-last-sexp-print-value (eval (preceding-sexp) lexical-binding))))
707 (defun eval-last-sexp-print-value (value)
708 (let ((unabbreviated (let ((print-length nil) (print-level nil))
709 (prin1-to-string value)))
710 (print-length eval-expression-print-length)
711 (print-level eval-expression-print-level)
716 (let ((str (eval-expression-print-format value)))
717 (if str (princ str)))
719 (when (and (bufferp standard-output)
720 (or (not (null print-length))
721 (not (null print-level)))
722 (not (string= unabbreviated
723 (buffer-substring-no-properties beg end))))
724 (last-sexp-setup-props beg end value
726 (buffer-substring-no-properties beg end))
730 (defvar eval-last-sexp-fake-value (make-symbol "t"))
732 (defun eval-last-sexp (eval-last-sexp-arg-internal)
733 "Evaluate sexp before point; print value in minibuffer.
734 Interactively, with prefix argument, print output into current buffer.
735 Truncates long output according to the value of the variables
736 `eval-expression-print-length' and `eval-expression-print-level'.
738 If `eval-expression-debug-on-error' is non-nil, which is the default,
739 this command arranges for all errors to enter the debugger."
741 (if (null eval-expression-debug-on-error)
742 (eval-last-sexp-1 eval-last-sexp-arg-internal)
744 (let ((debug-on-error eval-last-sexp-fake-value))
745 (cons (eval-last-sexp-1 eval-last-sexp-arg-internal)
747 (unless (eq (cdr value) eval-last-sexp-fake-value)
748 (setq debug-on-error (cdr value)))
751 (defun eval-defun-1 (form)
752 "Treat some expressions specially.
753 Reset the `defvar' and `defcustom' variables to the initial value.
754 Reinitialize the face according to the `defface' specification."
755 ;; The code in edebug-defun should be consistent with this, but not
756 ;; the same, since this gets a macroexpended form.
757 (cond ((not (listp form))
759 ((and (eq (car form) 'defvar)
760 (cdr-safe (cdr-safe form))
761 (boundp (cadr form)))
762 ;; Force variable to be re-set.
763 `(progn (defvar ,(nth 1 form) nil ,@(nthcdr 3 form))
764 (setq-default ,(nth 1 form) ,(nth 2 form))))
765 ;; `defcustom' is now macroexpanded to
766 ;; `custom-declare-variable' with a quoted value arg.
767 ((and (eq (car form) 'custom-declare-variable)
768 (default-boundp (eval (nth 1 form) lexical-binding)))
769 ;; Force variable to be bound.
770 (set-default (eval (nth 1 form) lexical-binding)
771 (eval (nth 1 (nth 2 form)) lexical-binding))
773 ;; `defface' is macroexpanded to `custom-declare-face'.
774 ((eq (car form) 'custom-declare-face)
776 (setq face-new-frame-defaults
777 (assq-delete-all (eval (nth 1 form) lexical-binding)
778 face-new-frame-defaults))
779 (put (eval (nth 1 form) lexical-binding) 'face-defface-spec nil)
780 ;; Setting `customized-face' to the new spec after calling
781 ;; the form, but preserving the old saved spec in `saved-face',
782 ;; imitates the situation when the new face spec is set
783 ;; temporarily for the current session in the customize
784 ;; buffer, thus allowing `face-user-default-spec' to use the
785 ;; new customized spec instead of the saved spec.
786 ;; Resetting `saved-face' temporarily to nil is needed to let
787 ;; `defface' change the spec, regardless of a saved spec.
789 (put ,(nth 1 form) 'saved-face
790 ',(get (eval (nth 1 form) lexical-binding)
792 (put ,(nth 1 form) 'customized-face
794 (put (eval (nth 1 form) lexical-binding) 'saved-face nil)))
795 ((eq (car form) 'progn)
796 (cons 'progn (mapcar 'eval-defun-1 (cdr form))))
799 (defun eval-defun-2 ()
800 "Evaluate defun that point is in or before.
801 The value is displayed in the minibuffer.
802 If the current defun is actually a call to `defvar',
803 then reset the variable using the initial value expression
804 even if the variable already has some other value.
805 \(Normally `defvar' does not change the variable's value
806 if it already has a value.\)
808 With argument, insert value in current buffer after the defun.
809 Return the result of evaluation."
811 ;; FIXME: the print-length/level bindings should only be applied while
812 ;; printing, not while evaluating.
813 (let ((debug-on-error eval-expression-debug-on-error)
814 (print-length eval-expression-print-length)
815 (print-level eval-expression-print-level))
817 ;; Arrange for eval-region to "read" the (possibly) altered form.
818 ;; eval-region handles recording which file defines a function or
819 ;; variable. Re-written using `apply' to avoid capturing
820 ;; variables like `end'.
823 (let ((standard-output t)
825 ;; Read the form from the buffer, and record where it ends.
830 (setq form (read (current-buffer)))
832 ;; Alter the form if necessary.
833 (setq form (eval-defun-1 (macroexpand form)))
834 (list beg end standard-output
836 ;; Skipping to the end of the specified region
837 ;; will make eval-region return.
840 ;; The result of evaluation has been put onto VALUES. So return it.
843 (defun eval-defun (edebug-it)
844 "Evaluate the top-level form containing point, or after point.
846 If the current defun is actually a call to `defvar' or `defcustom',
847 evaluating it this way resets the variable using its initial value
848 expression even if the variable already has some other value.
849 \(Normally `defvar' and `defcustom' do not alter the value if there
850 already is one.) In an analogous way, evaluating a `defface'
851 overrides any customizations of the face, so that it becomes
852 defined exactly as the `defface' expression says.
854 If `eval-expression-debug-on-error' is non-nil, which is the default,
855 this command arranges for all errors to enter the debugger.
857 With a prefix argument, instrument the code for Edebug.
859 If acting on a `defun' for FUNCTION, and the function was
860 instrumented, `Edebug: FUNCTION' is printed in the minibuffer. If not
861 instrumented, just FUNCTION is printed.
863 If not acting on a `defun', the result of evaluation is displayed in
864 the minibuffer. This display is controlled by the variables
865 `eval-expression-print-length' and `eval-expression-print-level',
870 (eval-defun (not edebug-all-defs)))
872 (if (null eval-expression-debug-on-error)
874 (let ((old-value (make-symbol "t")) new-value value)
875 (let ((debug-on-error old-value))
876 (setq value (eval-defun-2))
877 (setq new-value debug-on-error))
878 (unless (eq old-value new-value)
879 (setq debug-on-error new-value))
882 ;; May still be used by some external Lisp-mode variant.
883 (define-obsolete-function-alias 'lisp-comment-indent
884 'comment-indent-default "22.1")
885 (define-obsolete-function-alias 'lisp-mode-auto-fill 'do-auto-fill "23.1")
887 (defcustom lisp-indent-offset nil
888 "If non-nil, indent second line of expressions that many more columns."
890 :type '(choice (const nil) integer))
891 (put 'lisp-indent-offset 'safe-local-variable
892 (lambda (x) (or (null x) (integerp x))))
894 (defcustom lisp-indent-function 'lisp-indent-function
895 "A function to be called by `calculate-lisp-indent'.
896 It indents the arguments of a Lisp function call. This function
897 should accept two arguments: the indent-point, and the
898 `parse-partial-sexp' state at that position. One option for this
899 function is `common-lisp-indent-function'."
903 (defun lisp-indent-line (&optional whole-exp)
904 "Indent current line as Lisp code.
905 With argument, indent any additional lines of the same expression
906 rigidly along with this one."
908 (let ((indent (calculate-lisp-indent)) shift-amt end
909 (pos (- (point-max) (point)))
910 (beg (progn (beginning-of-line) (point))))
911 (skip-chars-forward " \t")
912 (if (or (null indent) (looking-at "\\s<\\s<\\s<"))
913 ;; Don't alter indentation of a ;;; comment line
914 ;; or a line that starts in a string.
915 (goto-char (- (point-max) pos))
916 (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
917 ;; Single-semicolon comment lines should be indented
918 ;; as comment lines, not as code.
919 (progn (indent-for-comment) (forward-char -1))
920 (if (listp indent) (setq indent (car indent)))
921 (setq shift-amt (- indent (current-column)))
922 (if (zerop shift-amt)
924 (delete-region beg (point))
926 ;; If initial point was within line's indentation,
927 ;; position after the indentation. Else stay at same point in text.
928 (if (> (- (point-max) pos) (point))
929 (goto-char (- (point-max) pos)))
930 ;; If desired, shift remaining lines of expression the same amount.
931 (and whole-exp (not (zerop shift-amt))
940 (indent-code-rigidly beg end shift-amt)))))
942 (defvar calculate-lisp-indent-last-sexp)
944 (defun calculate-lisp-indent (&optional parse-start)
945 "Return appropriate indentation for current line as Lisp code.
946 In usual case returns an integer: the column to indent to.
947 If the value is nil, that means don't change the indentation
948 because the line starts inside a string.
950 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
951 This means that following lines at the same level of indentation
952 should not necessarily be indented the same as this line.
953 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
954 is the buffer position of the start of the containing expression."
957 (let ((indent-point (point))
959 ;; setting this to a number inhibits calling hook
962 calculate-lisp-indent-last-sexp containing-sexp)
964 (goto-char parse-start)
965 (beginning-of-defun))
966 ;; Find outermost containing sexp
967 (while (< (point) indent-point)
968 (setq state (parse-partial-sexp (point) indent-point 0)))
969 ;; Find innermost containing sexp
972 (> (setq paren-depth (elt state 0)) 0))
974 (setq calculate-lisp-indent-last-sexp (elt state 2))
975 (setq containing-sexp (elt state 1))
976 ;; Position following last unclosed open.
977 (goto-char (1+ containing-sexp))
978 ;; Is there a complete sexp since then?
979 (if (and calculate-lisp-indent-last-sexp
980 (> calculate-lisp-indent-last-sexp (point)))
981 ;; Yes, but is there a containing sexp after that?
982 (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
984 (if (setq retry (car (cdr peek))) (setq state peek)))))
987 ;; Innermost containing sexp found
988 (goto-char (1+ containing-sexp))
989 (if (not calculate-lisp-indent-last-sexp)
990 ;; indent-point immediately follows open paren.
992 (setq desired-indent (current-column))
993 ;; Find the start of first element of containing sexp.
994 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
995 (cond ((looking-at "\\s(")
996 ;; First element of containing sexp is a list.
997 ;; Indent under that list.
999 ((> (save-excursion (forward-line 1) (point))
1000 calculate-lisp-indent-last-sexp)
1001 ;; This is the first line to start within the containing sexp.
1002 ;; It's almost certainly a function call.
1003 (if (= (point) calculate-lisp-indent-last-sexp)
1004 ;; Containing sexp has nothing before this line
1005 ;; except the first element. Indent under that element.
1007 ;; Skip the first element, find start of second (the first
1008 ;; argument of the function call) and indent under.
1009 (progn (forward-sexp 1)
1010 (parse-partial-sexp (point)
1011 calculate-lisp-indent-last-sexp
1013 (backward-prefix-chars))
1015 ;; Indent beneath first sexp on same line as
1016 ;; `calculate-lisp-indent-last-sexp'. Again, it's
1017 ;; almost certainly a function call.
1018 (goto-char calculate-lisp-indent-last-sexp)
1020 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
1022 (backward-prefix-chars)))))
1023 ;; Point is at the point to indent under unless we are inside a string.
1024 ;; Call indentation hook except when overridden by lisp-indent-offset
1025 ;; or if the desired indentation has already been computed.
1026 (let ((normal-indent (current-column)))
1027 (cond ((elt state 3)
1028 ;; Inside a string, don't change indentation.
1030 ((and (integerp lisp-indent-offset) containing-sexp)
1031 ;; Indent by constant offset
1032 (goto-char containing-sexp)
1033 (+ (current-column) lisp-indent-offset))
1034 ;; in this case calculate-lisp-indent-last-sexp is not nil
1035 (calculate-lisp-indent-last-sexp
1037 ;; try to align the parameters of a known function
1038 (and lisp-indent-function
1040 (funcall lisp-indent-function indent-point state))
1041 ;; If the function has no special alignment
1042 ;; or it does not apply to this argument,
1043 ;; try to align a constant-symbol under the last
1044 ;; preceding constant symbol, if there is such one of
1045 ;; the last 2 preceding symbols, in the previous
1046 ;; uncommented line.
1047 (and (save-excursion
1048 (goto-char indent-point)
1049 (skip-chars-forward " \t")
1051 ;; The last sexp may not be at the indentation
1052 ;; where it begins, so find that one, instead.
1054 (goto-char calculate-lisp-indent-last-sexp)
1055 ;; Handle prefix characters and whitespace
1056 ;; following an open paren. (Bug#1012)
1057 (backward-prefix-chars)
1058 (while (and (not (looking-back "^[ \t]*\\|([ \t]+"))
1059 (or (not containing-sexp)
1060 (< (1+ containing-sexp) (point))))
1062 (backward-prefix-chars))
1063 (setq calculate-lisp-indent-last-sexp (point)))
1064 (> calculate-lisp-indent-last-sexp
1066 (goto-char (1+ containing-sexp))
1067 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1069 (let ((parse-sexp-ignore-comments t)
1071 (goto-char calculate-lisp-indent-last-sexp)
1072 (or (and (looking-at ":")
1073 (setq indent (current-column)))
1074 (and (< (line-beginning-position)
1075 (prog2 (backward-sexp) (point)))
1077 (setq indent (current-column))))
1079 ;; another symbols or constants not preceded by a constant
1080 ;; as defined above.
1082 ;; in this case calculate-lisp-indent-last-sexp is nil
1087 (defun lisp-indent-function (indent-point state)
1088 "This function is the normal value of the variable `lisp-indent-function'.
1089 It is used when indenting a line within a function call, to see if the
1090 called function says anything special about how to indent the line.
1092 INDENT-POINT is the position where the user typed TAB, or equivalent.
1093 Point is located at the point to indent under (for default indentation);
1094 STATE is the `parse-partial-sexp' state for that position.
1096 If the current line is in a call to a Lisp function
1097 which has a non-nil property `lisp-indent-function',
1098 that specifies how to do the indentation. The property value can be
1099 * `defun', meaning indent `defun'-style;
1100 * an integer N, meaning indent the first N arguments specially
1101 like ordinary function arguments and then indent any further
1102 arguments like a body;
1103 * a function to call just as this function was called.
1104 If that function returns nil, that means it doesn't specify
1107 This function also returns nil meaning don't specify the indentation."
1108 (let ((normal-indent (current-column)))
1109 (goto-char (1+ (elt state 1)))
1110 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
1111 (if (and (elt state 2)
1112 (not (looking-at "\\sw\\|\\s_")))
1113 ;; car of form doesn't seem to be a symbol
1115 (if (not (> (save-excursion (forward-line 1) (point))
1116 calculate-lisp-indent-last-sexp))
1117 (progn (goto-char calculate-lisp-indent-last-sexp)
1119 (parse-partial-sexp (point)
1120 calculate-lisp-indent-last-sexp 0 t)))
1121 ;; Indent under the list or under the first sexp on the same
1122 ;; line as calculate-lisp-indent-last-sexp. Note that first
1123 ;; thing on that line has to be complete sexp since we are
1124 ;; inside the innermost containing sexp.
1125 (backward-prefix-chars)
1127 (let ((function (buffer-substring (point)
1128 (progn (forward-sexp 1) (point))))
1130 (setq method (or (get (intern-soft function) 'lisp-indent-function)
1131 (get (intern-soft function) 'lisp-indent-hook)))
1132 (cond ((or (eq method 'defun)
1134 (> (length function) 3)
1135 (string-match "\\`def" function)))
1136 (lisp-indent-defform state indent-point))
1138 (lisp-indent-specform method state
1139 indent-point normal-indent))
1141 (funcall method indent-point state)))))))
1143 (defcustom lisp-body-indent 2
1144 "Number of columns to indent the second line of a `(def...)' form."
1147 (put 'lisp-body-indent 'safe-local-variable 'integerp)
1149 (defun lisp-indent-specform (count state indent-point normal-indent)
1150 (let ((containing-form-start (elt state 1))
1152 body-indent containing-form-column)
1153 ;; Move to the start of containing form, calculate indentation
1154 ;; to use for non-distinguished forms (> count), and move past the
1155 ;; function symbol. lisp-indent-function guarantees that there is at
1156 ;; least one word or symbol character following open paren of containing
1158 (goto-char containing-form-start)
1159 (setq containing-form-column (current-column))
1160 (setq body-indent (+ lisp-body-indent containing-form-column))
1163 ;; Now find the start of the last form.
1164 (parse-partial-sexp (point) indent-point 1 t)
1165 (while (and (< (point) indent-point)
1168 (setq count (1- count))
1170 (parse-partial-sexp (point) indent-point 1 t))
1172 ;; Point is sitting on first character of last (or count) sexp.
1174 ;; A distinguished form. If it is the first or second form use double
1175 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
1176 ;; to 2 (the default), this just happens to work the same with if as
1177 ;; the older code, but it makes unwind-protect, condition-case,
1178 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
1179 ;; less hacked, behavior can be obtained by replacing below with
1180 ;; (list normal-indent containing-form-start).
1181 (if (<= (- i count) 1)
1182 (list (+ containing-form-column (* 2 lisp-body-indent))
1183 containing-form-start)
1184 (list normal-indent containing-form-start))
1185 ;; A non-distinguished form. Use body-indent if there are no
1186 ;; distinguished forms and this is the first undistinguished form,
1187 ;; or if this is the first undistinguished form and the preceding
1188 ;; distinguished form has indentation at least as great as body-indent.
1189 (if (or (and (= i 0) (= count 0))
1190 (and (= count 0) (<= body-indent normal-indent)))
1194 (defun lisp-indent-defform (state indent-point)
1195 (goto-char (car (cdr state)))
1197 (if (> (point) (car (cdr (cdr state))))
1199 (goto-char (car (cdr state)))
1200 (+ lisp-body-indent (current-column)))))
1203 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
1204 ;; like defun if the first form is placed on the next line, otherwise
1205 ;; it is indented like any other form (i.e. forms line up under first).
1207 (put 'lambda 'lisp-indent-function 'defun)
1208 (put 'autoload 'lisp-indent-function 'defun)
1209 (put 'progn 'lisp-indent-function 0)
1210 (put 'prog1 'lisp-indent-function 1)
1211 (put 'prog2 'lisp-indent-function 2)
1212 (put 'save-excursion 'lisp-indent-function 0)
1213 (put 'save-window-excursion 'lisp-indent-function 0)
1214 (put 'save-restriction 'lisp-indent-function 0)
1215 (put 'save-match-data 'lisp-indent-function 0)
1216 (put 'save-current-buffer 'lisp-indent-function 0)
1217 (put 'let 'lisp-indent-function 1)
1218 (put 'let* 'lisp-indent-function 1)
1219 (put 'while 'lisp-indent-function 1)
1220 (put 'if 'lisp-indent-function 2)
1221 (put 'catch 'lisp-indent-function 1)
1222 (put 'condition-case 'lisp-indent-function 2)
1223 (put 'unwind-protect 'lisp-indent-function 1)
1224 (put 'with-output-to-temp-buffer 'lisp-indent-function 1)
1226 (defun indent-sexp (&optional endpos)
1227 "Indent each line of the list starting just after point.
1228 If optional arg ENDPOS is given, indent each line, stopping when
1229 ENDPOS is encountered."
1231 (let ((indent-stack (list nil))
1233 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
1234 ;; so that calculate-lisp-indent will find the beginning of
1235 ;; the defun we are in.
1236 ;; If ENDPOS is nil, it is safe not to scan before point
1237 ;; since every line we indent is more deeply nested than point is.
1238 (starting-point (if endpos nil (point)))
1239 (last-point (point))
1240 last-depth bol outer-loop-done inner-loop-done state this-indent)
1242 ;; Get error now if we don't have a complete sexp after point.
1243 (save-excursion (forward-sexp 1)))
1245 (setq outer-loop-done nil)
1246 (while (if endpos (< (point) endpos)
1247 (not outer-loop-done))
1248 (setq last-depth next-depth
1249 inner-loop-done nil)
1250 ;; Parse this line so we can learn the state
1251 ;; to indent the next line.
1252 ;; This inner loop goes through only once
1253 ;; unless a line ends inside a string.
1254 (while (and (not inner-loop-done)
1255 (not (setq outer-loop-done (eobp))))
1256 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
1258 (setq next-depth (car state))
1259 ;; If the line contains a comment other than the sort
1260 ;; that is indented like code,
1261 ;; indent it now with indent-for-comment.
1262 ;; Comments indented like code are right already.
1263 ;; In any case clear the in-comment flag in the state
1264 ;; because parse-partial-sexp never sees the newlines.
1265 (if (car (nthcdr 4 state))
1266 (progn (indent-for-comment)
1268 (setcar (nthcdr 4 state) nil)))
1269 ;; If this line ends inside a string,
1270 ;; go straight to next line, remaining within the inner loop,
1271 ;; and turn off the \-flag.
1272 (if (car (nthcdr 3 state))
1275 (setcar (nthcdr 5 state) nil))
1276 (setq inner-loop-done t)))
1280 (setq indent-stack (nconc indent-stack
1281 (make-list (- next-depth) nil))
1282 last-depth (- last-depth next-depth)
1285 ;; Decide whether to exit.
1287 ;; If we have already reached the specified end,
1288 ;; give up and do not reindent this line.
1289 (if (<= endpos (point))
1290 (setq outer-loop-done t))
1291 ;; If no specified end, we are done if we have finished one sexp.
1292 (if (<= next-depth 0)
1293 (setq outer-loop-done t)))
1294 (unless outer-loop-done
1295 (while (> last-depth next-depth)
1296 (setq indent-stack (cdr indent-stack)
1297 last-depth (1- last-depth)))
1298 (while (< last-depth next-depth)
1299 (setq indent-stack (cons nil indent-stack)
1300 last-depth (1+ last-depth)))
1301 ;; Now indent the next line according
1302 ;; to what we learned from parsing the previous one.
1304 (skip-chars-forward " \t")
1305 ;; But not if the line is blank, or just a comment
1306 ;; (except for double-semi comments; indent them as usual).
1307 (if (or (eobp) (looking-at "\\s<\\|\n"))
1309 (if (and (car indent-stack)
1310 (>= (car indent-stack) 0))
1311 (setq this-indent (car indent-stack))
1312 (let ((val (calculate-lisp-indent
1313 (if (car indent-stack) (- (car indent-stack))
1316 (setq this-indent val)
1318 (setcar indent-stack
1319 (setq this-indent val))
1320 (setcar indent-stack (- (car (cdr val))))
1321 (setq this-indent (car val))))))
1322 (if (and this-indent (/= (current-column) this-indent))
1323 (progn (delete-region bol (point))
1324 (indent-to this-indent)))))
1326 (setq outer-loop-done (= (point) last-point))
1327 (setq last-point (point)))))))
1329 (defun indent-pp-sexp (&optional arg)
1330 "Indent each line of the list starting just after point, or prettyprint it.
1331 A prefix argument specifies pretty-printing."
1336 (narrow-to-region (point) (progn (forward-sexp 1) (point)))
1338 (goto-char (point-max))
1339 (if (eq (char-before) ?\n)
1340 (delete-char -1)))))
1343 ;;;; Lisp paragraph filling commands.
1345 (defcustom emacs-lisp-docstring-fill-column 65
1346 "Value of `fill-column' to use when filling a docstring.
1347 Any non-integer value means do not use a different value of
1348 `fill-column' when filling docstrings."
1349 :type '(choice (integer)
1350 (const :tag "Use the current `fill-column'" t))
1353 (defun lisp-fill-paragraph (&optional justify)
1354 "Like \\[fill-paragraph], but handle Emacs Lisp comments and docstrings.
1355 If any of the current line is a comment, fill the comment or the
1356 paragraph of it that point is in, preserving the comment's indentation
1357 and initial semicolons."
1359 (or (fill-comment-paragraph justify)
1360 ;; Since fill-comment-paragraph returned nil, that means we're not in
1361 ;; a comment: Point is on a program line; we are interested
1362 ;; particularly in docstring lines.
1364 ;; We bind `paragraph-start' and `paragraph-separate' temporarily. They
1365 ;; are buffer-local, but we avoid changing them so that they can be set
1366 ;; to make `forward-paragraph' and friends do something the user wants.
1368 ;; `paragraph-start': The `(' in the character alternative and the
1369 ;; left-singlequote plus `(' sequence after the \\| alternative prevent
1370 ;; sexps and backquoted sexps that follow a docstring from being filled
1371 ;; with the docstring. This setting has the consequence of inhibiting
1372 ;; filling many program lines that are not docstrings, which is sensible,
1373 ;; because the user probably asked to fill program lines by accident, or
1374 ;; expecting indentation (perhaps we should try to do indenting in that
1375 ;; case). The `;' and `:' stop the paragraph being filled at following
1376 ;; comment lines and at keywords (e.g., in `defcustom'). Left parens are
1377 ;; escaped to keep font-locking, filling, & paren matching in the source
1380 ;; `paragraph-separate': A clever regexp distinguishes the first line of
1381 ;; a docstring and identifies it as a paragraph separator, so that it
1382 ;; won't be filled. (Since the first line of documentation stands alone
1383 ;; in some contexts, filling should not alter the contents the author has
1384 ;; chosen.) Only the first line of a docstring begins with whitespace
1385 ;; and a quotation mark and ends with a period or (rarely) a comma.
1387 ;; The `fill-column' is temporarily bound to
1388 ;; `emacs-lisp-docstring-fill-column' if that value is an integer.
1389 (let ((paragraph-start (concat paragraph-start
1390 "\\|\\s-*\\([(;:\"]\\|`(\\|#'(\\)"))
1392 (concat paragraph-separate "\\|\\s-*\".*[,\\.]$"))
1393 (fill-column (if (and (integerp emacs-lisp-docstring-fill-column)
1394 (derived-mode-p 'emacs-lisp-mode))
1395 emacs-lisp-docstring-fill-column
1397 (fill-paragraph justify))
1398 ;; Never return nil.
1401 (defun indent-code-rigidly (start end arg &optional nochange-regexp)
1402 "Indent all lines of code, starting in the region, sideways by ARG columns.
1403 Does not affect lines starting inside comments or strings, assuming that
1404 the start of the region is not inside them.
1406 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
1407 The last is a regexp which, if matched at the beginning of a line,
1408 means don't indent that line."
1409 (interactive "r\np")
1413 (setq end (point-marker))
1416 (setq state (parse-partial-sexp (point)
1418 (forward-line 1) (point))
1420 (while (< (point) end)
1421 (or (car (nthcdr 3 state))
1422 (and nochange-regexp
1423 (looking-at nochange-regexp))
1424 ;; If line does not start in string, indent it
1425 (let ((indent (current-indentation)))
1426 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
1428 (indent-to (max 0 (+ indent arg)) 0))))
1429 (setq state (parse-partial-sexp (point)
1431 (forward-line 1) (point))
1434 (provide 'lisp-mode)
1436 ;;; lisp-mode.el ends here