]> code.delx.au - gnu-emacs/blob - lisp/emacs-lisp/lisp-mode.el
(lisp-imenu-generic-expression):
[gnu-emacs] / lisp / emacs-lisp / lisp-mode.el
1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands.
2
3 ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
4
5 ;; Maintainer: FSF
6 ;; Keywords: lisp, languages
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; The base major mode for editing Lisp code (used also for Emacs Lisp).
28 ;; This mode is documented in the Emacs manual
29
30 ;;; Code:
31
32 (defvar lisp-mode-syntax-table nil "")
33 (defvar emacs-lisp-mode-syntax-table nil "")
34 (defvar lisp-mode-abbrev-table nil "")
35
36 (if (not emacs-lisp-mode-syntax-table)
37 (let ((i 0))
38 (setq emacs-lisp-mode-syntax-table (make-syntax-table))
39 (while (< i ?0)
40 (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table)
41 (setq i (1+ i)))
42 (setq i (1+ ?9))
43 (while (< i ?A)
44 (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table)
45 (setq i (1+ i)))
46 (setq i (1+ ?Z))
47 (while (< i ?a)
48 (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table)
49 (setq i (1+ i)))
50 (setq i (1+ ?z))
51 (while (< i 128)
52 (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table)
53 (setq i (1+ i)))
54 (modify-syntax-entry ? " " emacs-lisp-mode-syntax-table)
55 (modify-syntax-entry ?\t " " emacs-lisp-mode-syntax-table)
56 (modify-syntax-entry ?\f " " emacs-lisp-mode-syntax-table)
57 (modify-syntax-entry ?\n "> " emacs-lisp-mode-syntax-table)
58 ;; Give CR the same syntax as newline, for selective-display.
59 (modify-syntax-entry ?\^m "> " emacs-lisp-mode-syntax-table)
60 (modify-syntax-entry ?\; "< " emacs-lisp-mode-syntax-table)
61 (modify-syntax-entry ?` "' " emacs-lisp-mode-syntax-table)
62 (modify-syntax-entry ?' "' " emacs-lisp-mode-syntax-table)
63 (modify-syntax-entry ?, "' " emacs-lisp-mode-syntax-table)
64 ;; Used to be singlequote; changed for flonums.
65 (modify-syntax-entry ?. "_ " emacs-lisp-mode-syntax-table)
66 (modify-syntax-entry ?# "' " emacs-lisp-mode-syntax-table)
67 (modify-syntax-entry ?\" "\" " emacs-lisp-mode-syntax-table)
68 (modify-syntax-entry ?\\ "\\ " emacs-lisp-mode-syntax-table)
69 (modify-syntax-entry ?\( "() " emacs-lisp-mode-syntax-table)
70 (modify-syntax-entry ?\) ")( " emacs-lisp-mode-syntax-table)
71 (modify-syntax-entry ?\[ "(] " emacs-lisp-mode-syntax-table)
72 (modify-syntax-entry ?\] ")[ " emacs-lisp-mode-syntax-table)))
73
74 (if (not lisp-mode-syntax-table)
75 (progn (setq lisp-mode-syntax-table
76 (copy-syntax-table emacs-lisp-mode-syntax-table))
77 (modify-syntax-entry ?\| "\" " lisp-mode-syntax-table)
78 (modify-syntax-entry ?\[ "_ " lisp-mode-syntax-table)
79 (modify-syntax-entry ?\] "_ " lisp-mode-syntax-table)))
80
81 (define-abbrev-table 'lisp-mode-abbrev-table ())
82
83 (defvar lisp-imenu-generic-expression
84 '(
85 (nil
86 "^\\s-*(def\\(un\\|subst\\|macro\\|advice\\|ine-skeleton\\)\\s-+\\([-A-Za-z0-9+*|:/]+\\)" 2)
87 ("Variables"
88 "^\\s-*(def\\(var\\|const\\|custom\\)\\s-+\\([-A-Za-z0-9+*|:/]+\\)" 2)
89 ("Types"
90 "^\\s-*(def\\(group\\|type\\|struct\\|class\\|ine-condition\\)\\s-+\\([-A-Za-z0-9+*|:/]+\\)"
91 2))
92
93 "Imenu generic expression for Lisp mode. See `imenu-generic-expression'.")
94
95 (defun lisp-mode-variables (lisp-syntax)
96 (cond (lisp-syntax
97 (set-syntax-table lisp-mode-syntax-table)))
98 (setq local-abbrev-table lisp-mode-abbrev-table)
99 (make-local-variable 'paragraph-start)
100 (setq paragraph-start (concat page-delimiter "\\|$" ))
101 (make-local-variable 'paragraph-separate)
102 (setq paragraph-separate paragraph-start)
103 (make-local-variable 'paragraph-ignore-fill-prefix)
104 (setq paragraph-ignore-fill-prefix t)
105 (make-local-variable 'fill-paragraph-function)
106 (setq fill-paragraph-function 'lisp-fill-paragraph)
107 ;; Adaptive fill mode gets in the way of auto-fill,
108 ;; and should make no difference for explicit fill
109 ;; because lisp-fill-paragraph should do the job.
110 (make-local-variable 'adaptive-fill-mode)
111 (setq adaptive-fill-mode nil)
112 (make-local-variable 'normal-auto-fill-function)
113 (setq normal-auto-fill-function 'lisp-mode-auto-fill)
114 (make-local-variable 'indent-line-function)
115 (setq indent-line-function 'lisp-indent-line)
116 (make-local-variable 'indent-region-function)
117 (setq indent-region-function 'lisp-indent-region)
118 (make-local-variable 'parse-sexp-ignore-comments)
119 (setq parse-sexp-ignore-comments t)
120 (make-local-variable 'outline-regexp)
121 (setq outline-regexp ";;; \\|(....")
122 (make-local-variable 'comment-start)
123 (setq comment-start ";")
124 (make-local-variable 'comment-start-skip)
125 ;; Look within the line for a ; following an even number of backslashes
126 ;; after either a non-backslash or the line beginning.
127 (setq comment-start-skip "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\);+ *")
128 (make-local-variable 'comment-column)
129 (setq comment-column 40)
130 (make-local-variable 'comment-indent-function)
131 (setq comment-indent-function 'lisp-comment-indent)
132 (make-local-variable 'imenu-generic-expression)
133 (setq imenu-generic-expression lisp-imenu-generic-expression))
134 \f
135 (defvar shared-lisp-mode-map ()
136 "Keymap for commands shared by all sorts of Lisp modes.")
137
138 (if shared-lisp-mode-map
139 ()
140 (setq shared-lisp-mode-map (make-sparse-keymap))
141 (define-key shared-lisp-mode-map "\e\C-q" 'indent-sexp)
142 (define-key shared-lisp-mode-map "\177" 'backward-delete-char-untabify))
143
144 (defvar emacs-lisp-mode-map ()
145 "Keymap for Emacs Lisp mode.
146 All commands in `shared-lisp-mode-map' are inherited by this map.")
147
148 (if emacs-lisp-mode-map
149 ()
150 (let ((map (make-sparse-keymap "Emacs-Lisp")))
151 (setq emacs-lisp-mode-map (make-sparse-keymap))
152 (set-keymap-parent emacs-lisp-mode-map shared-lisp-mode-map)
153 (define-key emacs-lisp-mode-map "\e\t" 'lisp-complete-symbol)
154 (define-key emacs-lisp-mode-map "\e\C-x" 'eval-defun)
155 (define-key emacs-lisp-mode-map [menu-bar] (make-sparse-keymap))
156 (define-key emacs-lisp-mode-map [menu-bar emacs-lisp]
157 (cons "Emacs-Lisp" map))
158 (define-key map [edebug-defun]
159 '("Instrument Function for Debugging" . edebug-defun))
160 (define-key map [byte-recompile]
161 '("Byte-recompile Directory..." . byte-recompile-directory))
162 (define-key map [emacs-byte-compile-and-load]
163 '("Byte-compile And Load" . emacs-lisp-byte-compile-and-load))
164 (define-key map [byte-compile]
165 '("Byte-compile This File" . emacs-lisp-byte-compile))
166 (define-key map [separator-eval] '("--"))
167 (define-key map [eval-buffer] '("Evaluate Buffer" . eval-current-buffer))
168 (define-key map [eval-region] '("Evaluate Region" . eval-region))
169 (define-key map [eval-sexp] '("Evaluate Last S-expression" . eval-last-sexp))
170 (define-key map [separator-format] '("--"))
171 (define-key map [comment-region] '("Comment Out Region" . comment-region))
172 (define-key map [indent-region] '("Indent Region" . indent-region))
173 (define-key map [indent-line] '("Indent Line" . lisp-indent-line))
174 (put 'eval-region 'menu-enable 'mark-active)
175 (put 'comment-region 'menu-enable 'mark-active)
176 (put 'indent-region 'menu-enable 'mark-active)))
177
178 (defun emacs-lisp-byte-compile ()
179 "Byte compile the file containing the current buffer."
180 (interactive)
181 (if buffer-file-name
182 (byte-compile-file buffer-file-name)
183 (error "The buffer must be saved in a file first")))
184
185 (defun emacs-lisp-byte-compile-and-load ()
186 "Byte-compile the current file (if it has changed), then load compiled code."
187 (interactive)
188 (or buffer-file-name
189 (error "The buffer must be saved in a file first"))
190 (require 'bytecomp)
191 ;; Recompile if file or buffer has changed since last compilation.
192 (if (and (buffer-modified-p)
193 (y-or-n-p (format "save buffer %s first? " (buffer-name))))
194 (save-buffer))
195 (let ((compiled-file-name (byte-compile-dest-file buffer-file-name)))
196 (if (file-newer-than-file-p compiled-file-name buffer-file-name)
197 (load-file compiled-file-name)
198 (byte-compile-file buffer-file-name t))))
199
200 (defun emacs-lisp-mode ()
201 "Major mode for editing Lisp code to run in Emacs.
202 Commands:
203 Delete converts tabs to spaces as it moves back.
204 Blank lines separate paragraphs. Semicolons start comments.
205 \\{emacs-lisp-mode-map}
206 Entry to this mode calls the value of `emacs-lisp-mode-hook'
207 if that value is non-nil."
208 (interactive)
209 (kill-all-local-variables)
210 (use-local-map emacs-lisp-mode-map)
211 (set-syntax-table emacs-lisp-mode-syntax-table)
212 (setq major-mode 'emacs-lisp-mode)
213 (setq mode-name "Emacs-Lisp")
214 (lisp-mode-variables nil)
215 (setq imenu-case-fold-search nil)
216 (run-hooks 'emacs-lisp-mode-hook))
217
218 (defvar lisp-mode-map ()
219 "Keymap for ordinary Lisp mode.
220 All commands in `shared-lisp-mode-map' are inherited by this map.")
221
222 (if lisp-mode-map
223 ()
224 (setq lisp-mode-map (make-sparse-keymap))
225 (set-keymap-parent lisp-mode-map shared-lisp-mode-map)
226 (define-key lisp-mode-map "\e\C-x" 'lisp-eval-defun)
227 (define-key lisp-mode-map "\C-c\C-z" 'run-lisp))
228
229 (defun lisp-mode ()
230 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
231 Commands:
232 Delete converts tabs to spaces as it moves back.
233 Blank lines separate paragraphs. Semicolons start comments.
234 \\{lisp-mode-map}
235 Note that `run-lisp' may be used either to start an inferior Lisp job
236 or to switch back to an existing one.
237
238 Entry to this mode calls the value of `lisp-mode-hook'
239 if that value is non-nil."
240 (interactive)
241 (kill-all-local-variables)
242 (use-local-map lisp-mode-map)
243 (setq major-mode 'lisp-mode)
244 (setq mode-name "Lisp")
245 (lisp-mode-variables t)
246 (setq imenu-case-fold-search t)
247 (set-syntax-table lisp-mode-syntax-table)
248 (run-hooks 'lisp-mode-hook))
249
250 ;; This will do unless shell.el is loaded.
251 (defun lisp-eval-defun nil
252 "Send the current defun to the Lisp process made by \\[run-lisp]."
253 (interactive)
254 (error "Process lisp does not exist"))
255
256 (defvar lisp-interaction-mode-map ()
257 "Keymap for Lisp Interaction moe.
258 All commands in `shared-lisp-mode-map' are inherited by this map.")
259
260 (if lisp-interaction-mode-map
261 ()
262 (setq lisp-interaction-mode-map (make-sparse-keymap))
263 (set-keymap-parent lisp-interaction-mode-map shared-lisp-mode-map)
264 (define-key lisp-interaction-mode-map "\e\C-x" 'eval-defun)
265 (define-key lisp-interaction-mode-map "\e\t" 'lisp-complete-symbol)
266 (define-key lisp-interaction-mode-map "\n" 'eval-print-last-sexp))
267
268 (defun lisp-interaction-mode ()
269 "Major mode for typing and evaluating Lisp forms.
270 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
271 before point, and prints its value into the buffer, advancing point.
272
273 Commands:
274 Delete converts tabs to spaces as it moves back.
275 Paragraphs are separated only by blank lines.
276 Semicolons start comments.
277 \\{lisp-interaction-mode-map}
278 Entry to this mode calls the value of `lisp-interaction-mode-hook'
279 if that value is non-nil."
280 (interactive)
281 (kill-all-local-variables)
282 (use-local-map lisp-interaction-mode-map)
283 (setq major-mode 'lisp-interaction-mode)
284 (setq mode-name "Lisp Interaction")
285 (set-syntax-table emacs-lisp-mode-syntax-table)
286 (lisp-mode-variables nil)
287 (run-hooks 'lisp-interaction-mode-hook))
288
289 (defun eval-print-last-sexp ()
290 "Evaluate sexp before point; print value into current buffer."
291 (interactive)
292 (let ((standard-output (current-buffer)))
293 (terpri)
294 (eval-last-sexp t)
295 (terpri)))
296 \f
297 (defun eval-last-sexp (eval-last-sexp-arg-internal)
298 "Evaluate sexp before point; print value in minibuffer.
299 With argument, print output into current buffer."
300 (interactive "P")
301 (let ((standard-output (if eval-last-sexp-arg-internal (current-buffer) t)))
302 (prin1 (eval (let ((stab (syntax-table))
303 (opoint (point))
304 ignore-quotes
305 expr)
306 (unwind-protect
307 (save-excursion
308 (set-syntax-table emacs-lisp-mode-syntax-table)
309 ;; If this sexp appears to be enclosed in `...'
310 ;; then ignore the surrounding quotes.
311 (setq ignore-quotes
312 (or (eq (following-char) ?\')
313 (eq (preceding-char) ?\')))
314 (forward-sexp -1)
315 (save-restriction
316 ;; vladimir@cs.ualberta.ca 30-Jul-1997: skip ` in
317 ;; `variable' so that the value is returned, not the
318 ;; name
319 (if (and ignore-quotes
320 (eq (following-char) ?`))
321 (forward-char))
322 (narrow-to-region (point-min) opoint)
323 (setq expr (read (current-buffer)))
324 ;; If it's an (interactive ...) form, it's more
325 ;; useful to show how an interactive call would
326 ;; use it.
327 (and (consp expr)
328 (eq (car expr) 'interactive)
329 (setq expr
330 (list 'call-interactively
331 (list 'quote
332 (list 'lambda
333 '(&rest args)
334 expr
335 'args)))))
336 expr))
337 (set-syntax-table stab)))))))
338
339 (defun eval-defun (eval-defun-arg-internal)
340 "Evaluate defun that point is in or before.
341 Print value in minibuffer.
342 With argument, insert value in current buffer after the defun."
343 (interactive "P")
344 (let ((standard-output (if eval-defun-arg-internal (current-buffer) t))
345 beg end form)
346 ;; Read the form from the buffer, and record where it ends.
347 (save-excursion
348 (end-of-defun)
349 (beginning-of-defun)
350 (setq beg (point))
351 (setq form (read (current-buffer)))
352 (setq end (point)))
353 ;; Alter the form if necessary.
354 (cond ((and (eq (car form) 'defvar)
355 (cdr-safe (cdr-safe form)))
356 ;; Force variable to be bound.
357 (setq form (cons 'defconst (cdr form))))
358 ((and (eq (car form) 'defcustom)
359 (default-boundp (nth 1 form)))
360 ;; Force variable to be bound.
361 (set-default (nth 1 form) (eval (nth 2 form)))))
362 ;; Now arrange for eval-region to "read" the (possibly) altered form.
363 ;; eval-region handles recording which file defines a function or variable.
364 (save-excursion
365 (eval-region beg end standard-output
366 #'(lambda (ignore)
367 ;; Skipping to the end of the specified region
368 ;; will make eval-region return.
369 (goto-char end)
370 form)))))
371 \f
372 (defun lisp-comment-indent ()
373 (if (looking-at "\\s<\\s<\\s<")
374 (current-column)
375 (if (looking-at "\\s<\\s<")
376 (let ((tem (or (calculate-lisp-indent) (current-column))))
377 (if (listp tem) (car tem) tem))
378 (skip-chars-backward " \t")
379 (max (if (bolp) 0 (1+ (current-column)))
380 comment-column))))
381
382 (defun lisp-mode-auto-fill ()
383 (if (> (current-column) (current-fill-column))
384 (if (save-excursion
385 (nth 4 (parse-partial-sexp (save-excursion
386 (beginning-of-defun)
387 (point))
388 (point))))
389 (do-auto-fill)
390 (let ((comment-start nil) (comment-start-skip nil))
391 (do-auto-fill)))))
392
393 (defvar lisp-indent-offset nil "")
394 (defvar lisp-indent-function 'lisp-indent-function "")
395
396 (defun lisp-indent-line (&optional whole-exp)
397 "Indent current line as Lisp code.
398 With argument, indent any additional lines of the same expression
399 rigidly along with this one."
400 (interactive "P")
401 (let ((indent (calculate-lisp-indent)) shift-amt beg end
402 (pos (- (point-max) (point))))
403 (beginning-of-line)
404 (setq beg (point))
405 (skip-chars-forward " \t")
406 (if (or (null indent) (looking-at "\\s<\\s<\\s<"))
407 ;; Don't alter indentation of a ;;; comment line
408 ;; or a line that starts in a string.
409 (goto-char (- (point-max) pos))
410 (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
411 ;; Single-semicolon comment lines should be indented
412 ;; as comment lines, not as code.
413 (progn (indent-for-comment) (forward-char -1))
414 (if (listp indent) (setq indent (car indent)))
415 (setq shift-amt (- indent (current-column)))
416 (if (zerop shift-amt)
417 nil
418 (delete-region beg (point))
419 (indent-to indent)))
420 ;; If initial point was within line's indentation,
421 ;; position after the indentation. Else stay at same point in text.
422 (if (> (- (point-max) pos) (point))
423 (goto-char (- (point-max) pos)))
424 ;; If desired, shift remaining lines of expression the same amount.
425 (and whole-exp (not (zerop shift-amt))
426 (save-excursion
427 (goto-char beg)
428 (forward-sexp 1)
429 (setq end (point))
430 (goto-char beg)
431 (forward-line 1)
432 (setq beg (point))
433 (> end beg))
434 (indent-code-rigidly beg end shift-amt)))))
435
436 (defvar calculate-lisp-indent-last-sexp)
437
438 (defun calculate-lisp-indent (&optional parse-start)
439 "Return appropriate indentation for current line as Lisp code.
440 In usual case returns an integer: the column to indent to.
441 If the value is nil, that means don't change the indentation
442 because the line starts inside a string.
443
444 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
445 This means that following lines at the same level of indentation
446 should not necessarily be indented the same as this line.
447 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
448 is the buffer position of the start of the containing expression."
449 (save-excursion
450 (beginning-of-line)
451 (let ((indent-point (point))
452 state paren-depth
453 ;; setting this to a number inhibits calling hook
454 (desired-indent nil)
455 (retry t)
456 calculate-lisp-indent-last-sexp containing-sexp)
457 (if parse-start
458 (goto-char parse-start)
459 (beginning-of-defun))
460 ;; Find outermost containing sexp
461 (while (< (point) indent-point)
462 (setq state (parse-partial-sexp (point) indent-point 0)))
463 ;; Find innermost containing sexp
464 (while (and retry
465 state
466 (> (setq paren-depth (elt state 0)) 0))
467 (setq retry nil)
468 (setq calculate-lisp-indent-last-sexp (elt state 2))
469 (setq containing-sexp (elt state 1))
470 ;; Position following last unclosed open.
471 (goto-char (1+ containing-sexp))
472 ;; Is there a complete sexp since then?
473 (if (and calculate-lisp-indent-last-sexp
474 (> calculate-lisp-indent-last-sexp (point)))
475 ;; Yes, but is there a containing sexp after that?
476 (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
477 indent-point 0)))
478 (if (setq retry (car (cdr peek))) (setq state peek)))))
479 (if retry
480 nil
481 ;; Innermost containing sexp found
482 (goto-char (1+ containing-sexp))
483 (if (not calculate-lisp-indent-last-sexp)
484 ;; indent-point immediately follows open paren.
485 ;; Don't call hook.
486 (setq desired-indent (current-column))
487 ;; Find the start of first element of containing sexp.
488 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
489 (cond ((looking-at "\\s(")
490 ;; First element of containing sexp is a list.
491 ;; Indent under that list.
492 )
493 ((> (save-excursion (forward-line 1) (point))
494 calculate-lisp-indent-last-sexp)
495 ;; This is the first line to start within the containing sexp.
496 ;; It's almost certainly a function call.
497 (if (= (point) calculate-lisp-indent-last-sexp)
498 ;; Containing sexp has nothing before this line
499 ;; except the first element. Indent under that element.
500 nil
501 ;; Skip the first element, find start of second (the first
502 ;; argument of the function call) and indent under.
503 (progn (forward-sexp 1)
504 (parse-partial-sexp (point)
505 calculate-lisp-indent-last-sexp
506 0 t)))
507 (backward-prefix-chars))
508 (t
509 ;; Indent beneath first sexp on same line as
510 ;; calculate-lisp-indent-last-sexp. Again, it's
511 ;; almost certainly a function call.
512 (goto-char calculate-lisp-indent-last-sexp)
513 (beginning-of-line)
514 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
515 0 t)
516 (backward-prefix-chars)))))
517 ;; Point is at the point to indent under unless we are inside a string.
518 ;; Call indentation hook except when overridden by lisp-indent-offset
519 ;; or if the desired indentation has already been computed.
520 (let ((normal-indent (current-column)))
521 (cond ((elt state 3)
522 ;; Inside a string, don't change indentation.
523 nil)
524 ((and (integerp lisp-indent-offset) containing-sexp)
525 ;; Indent by constant offset
526 (goto-char containing-sexp)
527 (+ (current-column) lisp-indent-offset))
528 (desired-indent)
529 ((and (boundp 'lisp-indent-function)
530 lisp-indent-function
531 (not retry))
532 (or (funcall lisp-indent-function indent-point state)
533 normal-indent))
534 (t
535 normal-indent))))))
536
537 (defun lisp-indent-function (indent-point state)
538 (let ((normal-indent (current-column)))
539 (goto-char (1+ (elt state 1)))
540 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
541 (if (and (elt state 2)
542 (not (looking-at "\\sw\\|\\s_")))
543 ;; car of form doesn't seem to be a a symbol
544 (progn
545 (if (not (> (save-excursion (forward-line 1) (point))
546 calculate-lisp-indent-last-sexp))
547 (progn (goto-char calculate-lisp-indent-last-sexp)
548 (beginning-of-line)
549 (parse-partial-sexp (point)
550 calculate-lisp-indent-last-sexp 0 t)))
551 ;; Indent under the list or under the first sexp on the same
552 ;; line as calculate-lisp-indent-last-sexp. Note that first
553 ;; thing on that line has to be complete sexp since we are
554 ;; inside the innermost containing sexp.
555 (backward-prefix-chars)
556 (current-column))
557 (let ((function (buffer-substring (point)
558 (progn (forward-sexp 1) (point))))
559 method)
560 (setq method (or (get (intern-soft function) 'lisp-indent-function)
561 (get (intern-soft function) 'lisp-indent-hook)))
562 (cond ((or (eq method 'defun)
563 (and (null method)
564 (> (length function) 3)
565 (string-match "\\`def" function)))
566 (lisp-indent-defform state indent-point))
567 ((integerp method)
568 (lisp-indent-specform method state
569 indent-point normal-indent))
570 (method
571 (funcall method state indent-point)))))))
572
573 (defvar lisp-body-indent 2
574 "Number of columns to indent the second line of a `(def...)' form.")
575
576 (defun lisp-indent-specform (count state indent-point normal-indent)
577 (let ((containing-form-start (elt state 1))
578 (i count)
579 body-indent containing-form-column)
580 ;; Move to the start of containing form, calculate indentation
581 ;; to use for non-distinguished forms (> count), and move past the
582 ;; function symbol. lisp-indent-function guarantees that there is at
583 ;; least one word or symbol character following open paren of containing
584 ;; form.
585 (goto-char containing-form-start)
586 (setq containing-form-column (current-column))
587 (setq body-indent (+ lisp-body-indent containing-form-column))
588 (forward-char 1)
589 (forward-sexp 1)
590 ;; Now find the start of the last form.
591 (parse-partial-sexp (point) indent-point 1 t)
592 (while (and (< (point) indent-point)
593 (condition-case ()
594 (progn
595 (setq count (1- count))
596 (forward-sexp 1)
597 (parse-partial-sexp (point) indent-point 1 t))
598 (error nil))))
599 ;; Point is sitting on first character of last (or count) sexp.
600 (if (> count 0)
601 ;; A distinguished form. If it is the first or second form use double
602 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
603 ;; to 2 (the default), this just happens to work the same with if as
604 ;; the older code, but it makes unwind-protect, condition-case,
605 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
606 ;; less hacked, behavior can be obtained by replacing below with
607 ;; (list normal-indent containing-form-start).
608 (if (<= (- i count) 1)
609 (list (+ containing-form-column (* 2 lisp-body-indent))
610 containing-form-start)
611 (list normal-indent containing-form-start))
612 ;; A non-distinguished form. Use body-indent if there are no
613 ;; distinguished forms and this is the first undistinguished form,
614 ;; or if this is the first undistinguished form and the preceding
615 ;; distinguished form has indentation at least as great as body-indent.
616 (if (or (and (= i 0) (= count 0))
617 (and (= count 0) (<= body-indent normal-indent)))
618 body-indent
619 normal-indent))))
620
621 (defun lisp-indent-defform (state indent-point)
622 (goto-char (car (cdr state)))
623 (forward-line 1)
624 (if (> (point) (car (cdr (cdr state))))
625 (progn
626 (goto-char (car (cdr state)))
627 (+ lisp-body-indent (current-column)))))
628
629 \f
630 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
631 ;; like defun if the first form is placed on the next line, otherwise
632 ;; it is indented like any other form (i.e. forms line up under first).
633
634 (put 'lambda 'lisp-indent-function 'defun)
635 (put 'autoload 'lisp-indent-function 'defun)
636 (put 'progn 'lisp-indent-function 0)
637 (put 'prog1 'lisp-indent-function 1)
638 (put 'prog2 'lisp-indent-function 2)
639 (put 'save-excursion 'lisp-indent-function 0)
640 (put 'save-window-excursion 'lisp-indent-function 0)
641 (put 'save-selected-window 'lisp-indent-function 0)
642 (put 'save-restriction 'lisp-indent-function 0)
643 (put 'save-match-data 'lisp-indent-function 0)
644 (put 'save-current-buffer 'lisp-indent-function 0)
645 (put 'with-current-buffer 'lisp-indent-function 1)
646 (put 'combine-after-change-calls 'lisp-indent-function 0)
647 (put 'with-output-to-string 'lisp-indent-function 0)
648 (put 'with-temp-file 'lisp-indent-function 1)
649 (put 'with-temp-buffer 'lisp-indent-function 0)
650 (put 'let 'lisp-indent-function 1)
651 (put 'let* 'lisp-indent-function 1)
652 (put 'while 'lisp-indent-function 1)
653 (put 'if 'lisp-indent-function 2)
654 (put 'catch 'lisp-indent-function 1)
655 (put 'condition-case 'lisp-indent-function 2)
656 (put 'unwind-protect 'lisp-indent-function 1)
657 (put 'with-output-to-temp-buffer 'lisp-indent-function 1)
658 (put 'eval-after-load 'lisp-indent-function 1)
659
660 (defun indent-sexp (&optional endpos)
661 "Indent each line of the list starting just after point.
662 If optional arg ENDPOS is given, indent each line, stopping when
663 ENDPOS is encountered."
664 (interactive)
665 (let ((indent-stack (list nil))
666 (next-depth 0)
667 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
668 ;; so that calculate-lisp-indent will find the beginning of
669 ;; the defun we are in.
670 ;; If ENDPOS is nil, it is safe not to scan before point
671 ;; since every line we indent is more deeply nested than point is.
672 (starting-point (if endpos nil (point)))
673 (last-point (point))
674 last-depth bol outer-loop-done inner-loop-done state this-indent)
675 (or endpos
676 ;; Get error now if we don't have a complete sexp after point.
677 (save-excursion (forward-sexp 1)))
678 (save-excursion
679 (setq outer-loop-done nil)
680 (while (if endpos (< (point) endpos)
681 (not outer-loop-done))
682 (setq last-depth next-depth
683 inner-loop-done nil)
684 ;; Parse this line so we can learn the state
685 ;; to indent the next line.
686 ;; This inner loop goes through only once
687 ;; unless a line ends inside a string.
688 (while (and (not inner-loop-done)
689 (not (setq outer-loop-done (eobp))))
690 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
691 nil nil state))
692 (setq next-depth (car state))
693 ;; If the line contains a comment other than the sort
694 ;; that is indented like code,
695 ;; indent it now with indent-for-comment.
696 ;; Comments indented like code are right already.
697 ;; In any case clear the in-comment flag in the state
698 ;; because parse-partial-sexp never sees the newlines.
699 (if (car (nthcdr 4 state))
700 (progn (indent-for-comment)
701 (end-of-line)
702 (setcar (nthcdr 4 state) nil)))
703 ;; If this line ends inside a string,
704 ;; go straight to next line, remaining within the inner loop,
705 ;; and turn off the \-flag.
706 (if (car (nthcdr 3 state))
707 (progn
708 (forward-line 1)
709 (setcar (nthcdr 5 state) nil))
710 (setq inner-loop-done t)))
711 (and endpos
712 (<= next-depth 0)
713 (progn
714 (setq indent-stack (append indent-stack
715 (make-list (- next-depth) nil))
716 last-depth (- last-depth next-depth)
717 next-depth 0)))
718 (or outer-loop-done endpos
719 (setq outer-loop-done (<= next-depth 0)))
720 (if outer-loop-done
721 (forward-line 1)
722 (while (> last-depth next-depth)
723 (setq indent-stack (cdr indent-stack)
724 last-depth (1- last-depth)))
725 (while (< last-depth next-depth)
726 (setq indent-stack (cons nil indent-stack)
727 last-depth (1+ last-depth)))
728 ;; Now go to the next line and indent it according
729 ;; to what we learned from parsing the previous one.
730 (forward-line 1)
731 (setq bol (point))
732 (skip-chars-forward " \t")
733 ;; But not if the line is blank, or just a comment
734 ;; (except for double-semi comments; indent them as usual).
735 (if (or (eobp) (looking-at "\\s<\\|\n"))
736 nil
737 (if (and (car indent-stack)
738 (>= (car indent-stack) 0))
739 (setq this-indent (car indent-stack))
740 (let ((val (calculate-lisp-indent
741 (if (car indent-stack) (- (car indent-stack))
742 starting-point))))
743 (if (null val)
744 (setq this-indent val)
745 (if (integerp val)
746 (setcar indent-stack
747 (setq this-indent val))
748 (setcar indent-stack (- (car (cdr val))))
749 (setq this-indent (car val))))))
750 (if (and this-indent (/= (current-column) this-indent))
751 (progn (delete-region bol (point))
752 (indent-to this-indent)))))
753 (or outer-loop-done
754 (setq outer-loop-done (= (point) last-point))
755 (setq last-point (point)))))))
756
757 ;; Indent every line whose first char is between START and END inclusive.
758 (defun lisp-indent-region (start end)
759 (save-excursion
760 (let ((endmark (copy-marker end)))
761 (goto-char start)
762 (and (bolp) (not (eolp))
763 (lisp-indent-line))
764 (indent-sexp endmark)
765 (set-marker endmark nil))))
766 \f
767 ;;;; Lisp paragraph filling commands.
768
769 (defun lisp-fill-paragraph (&optional justify)
770 "Like \\[fill-paragraph], but handle Emacs Lisp comments.
771 If any of the current line is a comment, fill the comment or the
772 paragraph of it that point is in, preserving the comment's indentation
773 and initial semicolons."
774 (interactive "P")
775 (let (
776 ;; Non-nil if the current line contains a comment.
777 has-comment
778
779 ;; Non-nil if the current line contains code and a comment.
780 has-code-and-comment
781
782 ;; If has-comment, the appropriate fill-prefix for the comment.
783 comment-fill-prefix
784 )
785
786 ;; Figure out what kind of comment we are looking at.
787 (save-excursion
788 (beginning-of-line)
789 (cond
790
791 ;; A line with nothing but a comment on it?
792 ((looking-at "[ \t]*;[; \t]*")
793 (setq has-comment t
794 comment-fill-prefix (buffer-substring (match-beginning 0)
795 (match-end 0))))
796
797 ;; A line with some code, followed by a comment? Remember that the
798 ;; semi which starts the comment shouldn't be part of a string or
799 ;; character.
800 ((condition-case nil
801 (save-restriction
802 (narrow-to-region (point-min)
803 (save-excursion (end-of-line) (point)))
804 (while (not (looking-at ";\\|$"))
805 (skip-chars-forward "^;\n\"\\\\?")
806 (cond
807 ((eq (char-after (point)) ?\\) (forward-char 2))
808 ((memq (char-after (point)) '(?\" ??)) (forward-sexp 1))))
809 (looking-at ";+[\t ]*"))
810 (error nil))
811 (setq has-comment t has-code-and-comment t)
812 (setq comment-fill-prefix
813 (concat (make-string (/ (current-column) 8) ?\t)
814 (make-string (% (current-column) 8) ?\ )
815 (buffer-substring (match-beginning 0) (match-end 0)))))))
816
817 (if (not has-comment)
818 ;; `paragraph-start' is set here (not in the buffer-local
819 ;; variable so that `forward-paragraph' et al work as
820 ;; expected) so that filling (doc) strings works sensibly.
821 ;; Adding the opening paren to avoid the following sexp being
822 ;; filled means that sexps generally aren't filled as normal
823 ;; text, which is probably sensible. The `;' and `:' stop the
824 ;; filled para at following comment lines and keywords
825 ;; (typically in `defcustom').
826 (let ((paragraph-start (concat paragraph-start
827 "\\|\\s-*[\(;:\"]")))
828 (fill-paragraph justify))
829
830 ;; Narrow to include only the comment, and then fill the region.
831 (save-excursion
832 (save-restriction
833 (beginning-of-line)
834 (narrow-to-region
835 ;; Find the first line we should include in the region to fill.
836 (save-excursion
837 (while (and (zerop (forward-line -1))
838 (looking-at "^[ \t]*;")))
839 ;; We may have gone too far. Go forward again.
840 (or (looking-at ".*;")
841 (forward-line 1))
842 (point))
843 ;; Find the beginning of the first line past the region to fill.
844 (save-excursion
845 (while (progn (forward-line 1)
846 (looking-at "^[ \t]*;")))
847 (point)))
848
849 ;; Lines with only semicolons on them can be paragraph boundaries.
850 (let* ((paragraph-start (concat paragraph-start "\\|[ \t;]*$"))
851 (paragraph-separate (concat paragraph-start "\\|[ \t;]*$"))
852 (paragraph-ignore-fill-prefix nil)
853 (fill-prefix comment-fill-prefix)
854 (after-line (if has-code-and-comment
855 (save-excursion
856 (forward-line 1) (point))))
857 (end (progn
858 (forward-paragraph)
859 (or (bolp) (newline 1))
860 (point)))
861 ;; If this comment starts on a line with code,
862 ;; include that like in the filling.
863 (beg (progn (backward-paragraph)
864 (if (eq (point) after-line)
865 (forward-line -1))
866 (point))))
867 (fill-region-as-paragraph beg end
868 justify nil
869 (save-excursion
870 (goto-char beg)
871 (if (looking-at fill-prefix)
872 nil
873 (re-search-forward comment-start-skip)
874 (point))))))))
875 t))
876 \f
877 (defun indent-code-rigidly (start end arg &optional nochange-regexp)
878 "Indent all lines of code, starting in the region, sideways by ARG columns.
879 Does not affect lines starting inside comments or strings, assuming that
880 the start of the region is not inside them.
881
882 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
883 The last is a regexp which, if matched at the beginning of a line,
884 means don't indent that line."
885 (interactive "r\np")
886 (let (state)
887 (save-excursion
888 (goto-char end)
889 (setq end (point-marker))
890 (goto-char start)
891 (or (bolp)
892 (setq state (parse-partial-sexp (point)
893 (progn
894 (forward-line 1) (point))
895 nil nil state)))
896 (while (< (point) end)
897 (or (car (nthcdr 3 state))
898 (and nochange-regexp
899 (looking-at nochange-regexp))
900 ;; If line does not start in string, indent it
901 (let ((indent (current-indentation)))
902 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
903 (or (eolp)
904 (indent-to (max 0 (+ indent arg)) 0))))
905 (setq state (parse-partial-sexp (point)
906 (progn
907 (forward-line 1) (point))
908 nil nil state))))))
909
910 (provide 'lisp-mode)
911
912 ;;; lisp-mode.el ends here