]> code.delx.au - gnu-emacs/blob - lisp/emacs-lisp/lisp-mode.el
Use imenu-case-fold-search.
[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\\)\\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
152 (nconc (make-sparse-keymap) 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
225 (nconc (make-sparse-keymap) 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
263 (nconc (make-sparse-keymap) 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 (form (save-excursion
346 (end-of-defun)
347 (beginning-of-defun)
348 (read (current-buffer)))))
349 (cond ((and (eq (car form) 'defvar)
350 (cdr-safe (cdr-safe form)))
351 ;; Force variable to be bound.
352 (setq form (cons 'defconst (cdr form))))
353 ((and (eq (car form) 'defcustom)
354 (default-boundp (nth 1 form)))
355 ;; Force variable to be bound.
356 (set-default (nth 1 form) (eval (nth 2 form)))))
357 (prin1 (eval form))))
358 \f
359 (defun lisp-comment-indent ()
360 (if (looking-at "\\s<\\s<\\s<")
361 (current-column)
362 (if (looking-at "\\s<\\s<")
363 (let ((tem (or (calculate-lisp-indent) (current-column))))
364 (if (listp tem) (car tem) tem))
365 (skip-chars-backward " \t")
366 (max (if (bolp) 0 (1+ (current-column)))
367 comment-column))))
368
369 (defun lisp-mode-auto-fill ()
370 (if (> (current-column) (current-fill-column))
371 (if (save-excursion
372 (nth 4 (parse-partial-sexp (save-excursion
373 (beginning-of-defun)
374 (point))
375 (point))))
376 (do-auto-fill)
377 (let ((comment-start nil) (comment-start-skip nil))
378 (do-auto-fill)))))
379
380 (defvar lisp-indent-offset nil "")
381 (defvar lisp-indent-function 'lisp-indent-function "")
382
383 (defun lisp-indent-line (&optional whole-exp)
384 "Indent current line as Lisp code.
385 With argument, indent any additional lines of the same expression
386 rigidly along with this one."
387 (interactive "P")
388 (let ((indent (calculate-lisp-indent)) shift-amt beg end
389 (pos (- (point-max) (point))))
390 (beginning-of-line)
391 (setq beg (point))
392 (skip-chars-forward " \t")
393 (if (or (null indent) (looking-at "\\s<\\s<\\s<"))
394 ;; Don't alter indentation of a ;;; comment line
395 ;; or a line that starts in a string.
396 (goto-char (- (point-max) pos))
397 (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
398 ;; Single-semicolon comment lines should be indented
399 ;; as comment lines, not as code.
400 (progn (indent-for-comment) (forward-char -1))
401 (if (listp indent) (setq indent (car indent)))
402 (setq shift-amt (- indent (current-column)))
403 (if (zerop shift-amt)
404 nil
405 (delete-region beg (point))
406 (indent-to indent)))
407 ;; If initial point was within line's indentation,
408 ;; position after the indentation. Else stay at same point in text.
409 (if (> (- (point-max) pos) (point))
410 (goto-char (- (point-max) pos)))
411 ;; If desired, shift remaining lines of expression the same amount.
412 (and whole-exp (not (zerop shift-amt))
413 (save-excursion
414 (goto-char beg)
415 (forward-sexp 1)
416 (setq end (point))
417 (goto-char beg)
418 (forward-line 1)
419 (setq beg (point))
420 (> end beg))
421 (indent-code-rigidly beg end shift-amt)))))
422
423 (defvar calculate-lisp-indent-last-sexp)
424
425 (defun calculate-lisp-indent (&optional parse-start)
426 "Return appropriate indentation for current line as Lisp code.
427 In usual case returns an integer: the column to indent to.
428 If the value is nil, that means don't change the indentation
429 because the line starts inside a string.
430
431 The value can also be a list of the form (COLUMN CONTAINING-SEXP-START).
432 This means that following lines at the same level of indentation
433 should not necessarily be indented the same as this line.
434 Then COLUMN is the column to indent to, and CONTAINING-SEXP-START
435 is the buffer position of the start of the containing expression."
436 (save-excursion
437 (beginning-of-line)
438 (let ((indent-point (point))
439 state paren-depth
440 ;; setting this to a number inhibits calling hook
441 (desired-indent nil)
442 (retry t)
443 calculate-lisp-indent-last-sexp containing-sexp)
444 (if parse-start
445 (goto-char parse-start)
446 (beginning-of-defun))
447 ;; Find outermost containing sexp
448 (while (< (point) indent-point)
449 (setq state (parse-partial-sexp (point) indent-point 0)))
450 ;; Find innermost containing sexp
451 (while (and retry
452 state
453 (> (setq paren-depth (elt state 0)) 0))
454 (setq retry nil)
455 (setq calculate-lisp-indent-last-sexp (elt state 2))
456 (setq containing-sexp (elt state 1))
457 ;; Position following last unclosed open.
458 (goto-char (1+ containing-sexp))
459 ;; Is there a complete sexp since then?
460 (if (and calculate-lisp-indent-last-sexp
461 (> calculate-lisp-indent-last-sexp (point)))
462 ;; Yes, but is there a containing sexp after that?
463 (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
464 indent-point 0)))
465 (if (setq retry (car (cdr peek))) (setq state peek)))))
466 (if retry
467 nil
468 ;; Innermost containing sexp found
469 (goto-char (1+ containing-sexp))
470 (if (not calculate-lisp-indent-last-sexp)
471 ;; indent-point immediately follows open paren.
472 ;; Don't call hook.
473 (setq desired-indent (current-column))
474 ;; Find the start of first element of containing sexp.
475 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
476 (cond ((looking-at "\\s(")
477 ;; First element of containing sexp is a list.
478 ;; Indent under that list.
479 )
480 ((> (save-excursion (forward-line 1) (point))
481 calculate-lisp-indent-last-sexp)
482 ;; This is the first line to start within the containing sexp.
483 ;; It's almost certainly a function call.
484 (if (= (point) calculate-lisp-indent-last-sexp)
485 ;; Containing sexp has nothing before this line
486 ;; except the first element. Indent under that element.
487 nil
488 ;; Skip the first element, find start of second (the first
489 ;; argument of the function call) and indent under.
490 (progn (forward-sexp 1)
491 (parse-partial-sexp (point)
492 calculate-lisp-indent-last-sexp
493 0 t)))
494 (backward-prefix-chars))
495 (t
496 ;; Indent beneath first sexp on same line as
497 ;; calculate-lisp-indent-last-sexp. Again, it's
498 ;; almost certainly a function call.
499 (goto-char calculate-lisp-indent-last-sexp)
500 (beginning-of-line)
501 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
502 0 t)
503 (backward-prefix-chars)))))
504 ;; Point is at the point to indent under unless we are inside a string.
505 ;; Call indentation hook except when overridden by lisp-indent-offset
506 ;; or if the desired indentation has already been computed.
507 (let ((normal-indent (current-column)))
508 (cond ((elt state 3)
509 ;; Inside a string, don't change indentation.
510 nil)
511 ((and (integerp lisp-indent-offset) containing-sexp)
512 ;; Indent by constant offset
513 (goto-char containing-sexp)
514 (+ (current-column) lisp-indent-offset))
515 (desired-indent)
516 ((and (boundp 'lisp-indent-function)
517 lisp-indent-function
518 (not retry))
519 (or (funcall lisp-indent-function indent-point state)
520 normal-indent))
521 (t
522 normal-indent))))))
523
524 (defun lisp-indent-function (indent-point state)
525 (let ((normal-indent (current-column)))
526 (goto-char (1+ (elt state 1)))
527 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
528 (if (and (elt state 2)
529 (not (looking-at "\\sw\\|\\s_")))
530 ;; car of form doesn't seem to be a a symbol
531 (progn
532 (if (not (> (save-excursion (forward-line 1) (point))
533 calculate-lisp-indent-last-sexp))
534 (progn (goto-char calculate-lisp-indent-last-sexp)
535 (beginning-of-line)
536 (parse-partial-sexp (point)
537 calculate-lisp-indent-last-sexp 0 t)))
538 ;; Indent under the list or under the first sexp on the same
539 ;; line as calculate-lisp-indent-last-sexp. Note that first
540 ;; thing on that line has to be complete sexp since we are
541 ;; inside the innermost containing sexp.
542 (backward-prefix-chars)
543 (current-column))
544 (let ((function (buffer-substring (point)
545 (progn (forward-sexp 1) (point))))
546 method)
547 (setq method (or (get (intern-soft function) 'lisp-indent-function)
548 (get (intern-soft function) 'lisp-indent-hook)))
549 (cond ((or (eq method 'defun)
550 (and (null method)
551 (> (length function) 3)
552 (string-match "\\`def" function)))
553 (lisp-indent-defform state indent-point))
554 ((integerp method)
555 (lisp-indent-specform method state
556 indent-point normal-indent))
557 (method
558 (funcall method state indent-point)))))))
559
560 (defvar lisp-body-indent 2
561 "Number of columns to indent the second line of a `(def...)' form.")
562
563 (defun lisp-indent-specform (count state indent-point normal-indent)
564 (let ((containing-form-start (elt state 1))
565 (i count)
566 body-indent containing-form-column)
567 ;; Move to the start of containing form, calculate indentation
568 ;; to use for non-distinguished forms (> count), and move past the
569 ;; function symbol. lisp-indent-function guarantees that there is at
570 ;; least one word or symbol character following open paren of containing
571 ;; form.
572 (goto-char containing-form-start)
573 (setq containing-form-column (current-column))
574 (setq body-indent (+ lisp-body-indent containing-form-column))
575 (forward-char 1)
576 (forward-sexp 1)
577 ;; Now find the start of the last form.
578 (parse-partial-sexp (point) indent-point 1 t)
579 (while (and (< (point) indent-point)
580 (condition-case ()
581 (progn
582 (setq count (1- count))
583 (forward-sexp 1)
584 (parse-partial-sexp (point) indent-point 1 t))
585 (error nil))))
586 ;; Point is sitting on first character of last (or count) sexp.
587 (if (> count 0)
588 ;; A distinguished form. If it is the first or second form use double
589 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
590 ;; to 2 (the default), this just happens to work the same with if as
591 ;; the older code, but it makes unwind-protect, condition-case,
592 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
593 ;; less hacked, behavior can be obtained by replacing below with
594 ;; (list normal-indent containing-form-start).
595 (if (<= (- i count) 1)
596 (list (+ containing-form-column (* 2 lisp-body-indent))
597 containing-form-start)
598 (list normal-indent containing-form-start))
599 ;; A non-distinguished form. Use body-indent if there are no
600 ;; distinguished forms and this is the first undistinguished form,
601 ;; or if this is the first undistinguished form and the preceding
602 ;; distinguished form has indentation at least as great as body-indent.
603 (if (or (and (= i 0) (= count 0))
604 (and (= count 0) (<= body-indent normal-indent)))
605 body-indent
606 normal-indent))))
607
608 (defun lisp-indent-defform (state indent-point)
609 (goto-char (car (cdr state)))
610 (forward-line 1)
611 (if (> (point) (car (cdr (cdr state))))
612 (progn
613 (goto-char (car (cdr state)))
614 (+ lisp-body-indent (current-column)))))
615
616 \f
617 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
618 ;; like defun if the first form is placed on the next line, otherwise
619 ;; it is indented like any other form (i.e. forms line up under first).
620
621 (put 'lambda 'lisp-indent-function 'defun)
622 (put 'autoload 'lisp-indent-function 'defun)
623 (put 'progn 'lisp-indent-function 0)
624 (put 'prog1 'lisp-indent-function 1)
625 (put 'prog2 'lisp-indent-function 2)
626 (put 'save-excursion 'lisp-indent-function 0)
627 (put 'save-window-excursion 'lisp-indent-function 0)
628 (put 'save-selected-window 'lisp-indent-function 0)
629 (put 'save-restriction 'lisp-indent-function 0)
630 (put 'save-match-data 'lisp-indent-function 0)
631 (put 'save-current-buffer 'lisp-indent-function 0)
632 (put 'with-current-buffer 'lisp-indent-function 1)
633 (put 'combine-after-change-calls 'lisp-indent-function 0)
634 (put 'with-output-to-string 'lisp-indent-function 0)
635 (put 'with-temp-file 'lisp-indent-function 1)
636 (put 'with-temp-buffer 'lisp-indent-function 0)
637 (put 'let 'lisp-indent-function 1)
638 (put 'let* 'lisp-indent-function 1)
639 (put 'while 'lisp-indent-function 1)
640 (put 'if 'lisp-indent-function 2)
641 (put 'catch 'lisp-indent-function 1)
642 (put 'condition-case 'lisp-indent-function 2)
643 (put 'unwind-protect 'lisp-indent-function 1)
644 (put 'with-output-to-temp-buffer 'lisp-indent-function 1)
645 (put 'eval-after-load 'lisp-indent-function 1)
646
647 (defun indent-sexp (&optional endpos)
648 "Indent each line of the list starting just after point.
649 If optional arg ENDPOS is given, indent each line, stopping when
650 ENDPOS is encountered."
651 (interactive)
652 (let ((indent-stack (list nil))
653 (next-depth 0)
654 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
655 ;; so that calculate-lisp-indent will find the beginning of
656 ;; the defun we are in.
657 ;; If ENDPOS is nil, it is safe not to scan before point
658 ;; since every line we indent is more deeply nested than point is.
659 (starting-point (if endpos nil (point)))
660 (last-point (point))
661 last-depth bol outer-loop-done inner-loop-done state this-indent)
662 (or endpos
663 ;; Get error now if we don't have a complete sexp after point.
664 (save-excursion (forward-sexp 1)))
665 (save-excursion
666 (setq outer-loop-done nil)
667 (while (if endpos (< (point) endpos)
668 (not outer-loop-done))
669 (setq last-depth next-depth
670 inner-loop-done nil)
671 ;; Parse this line so we can learn the state
672 ;; to indent the next line.
673 ;; This inner loop goes through only once
674 ;; unless a line ends inside a string.
675 (while (and (not inner-loop-done)
676 (not (setq outer-loop-done (eobp))))
677 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
678 nil nil state))
679 (setq next-depth (car state))
680 ;; If the line contains a comment other than the sort
681 ;; that is indented like code,
682 ;; indent it now with indent-for-comment.
683 ;; Comments indented like code are right already.
684 ;; In any case clear the in-comment flag in the state
685 ;; because parse-partial-sexp never sees the newlines.
686 (if (car (nthcdr 4 state))
687 (progn (indent-for-comment)
688 (end-of-line)
689 (setcar (nthcdr 4 state) nil)))
690 ;; If this line ends inside a string,
691 ;; go straight to next line, remaining within the inner loop,
692 ;; and turn off the \-flag.
693 (if (car (nthcdr 3 state))
694 (progn
695 (forward-line 1)
696 (setcar (nthcdr 5 state) nil))
697 (setq inner-loop-done t)))
698 (and endpos
699 (<= next-depth 0)
700 (progn
701 (setq indent-stack (append indent-stack
702 (make-list (- next-depth) nil))
703 last-depth (- last-depth next-depth)
704 next-depth 0)))
705 (or outer-loop-done endpos
706 (setq outer-loop-done (<= next-depth 0)))
707 (if outer-loop-done
708 (forward-line 1)
709 (while (> last-depth next-depth)
710 (setq indent-stack (cdr indent-stack)
711 last-depth (1- last-depth)))
712 (while (< last-depth next-depth)
713 (setq indent-stack (cons nil indent-stack)
714 last-depth (1+ last-depth)))
715 ;; Now go to the next line and indent it according
716 ;; to what we learned from parsing the previous one.
717 (forward-line 1)
718 (setq bol (point))
719 (skip-chars-forward " \t")
720 ;; But not if the line is blank, or just a comment
721 ;; (except for double-semi comments; indent them as usual).
722 (if (or (eobp) (looking-at "\\s<\\|\n"))
723 nil
724 (if (and (car indent-stack)
725 (>= (car indent-stack) 0))
726 (setq this-indent (car indent-stack))
727 (let ((val (calculate-lisp-indent
728 (if (car indent-stack) (- (car indent-stack))
729 starting-point))))
730 (if (null val)
731 (setq this-indent val)
732 (if (integerp val)
733 (setcar indent-stack
734 (setq this-indent val))
735 (setcar indent-stack (- (car (cdr val))))
736 (setq this-indent (car val))))))
737 (if (and this-indent (/= (current-column) this-indent))
738 (progn (delete-region bol (point))
739 (indent-to this-indent)))))
740 (or outer-loop-done
741 (setq outer-loop-done (= (point) last-point))
742 (setq last-point (point)))))))
743
744 ;; Indent every line whose first char is between START and END inclusive.
745 (defun lisp-indent-region (start end)
746 (save-excursion
747 (let ((endmark (copy-marker end)))
748 (goto-char start)
749 (and (bolp) (not (eolp))
750 (lisp-indent-line))
751 (indent-sexp endmark)
752 (set-marker endmark nil))))
753 \f
754 ;;;; Lisp paragraph filling commands.
755
756 (defun lisp-fill-paragraph (&optional justify)
757 "Like \\[fill-paragraph], but handle Emacs Lisp comments.
758 If any of the current line is a comment, fill the comment or the
759 paragraph of it that point is in, preserving the comment's indentation
760 and initial semicolons."
761 (interactive "P")
762 (let (
763 ;; Non-nil if the current line contains a comment.
764 has-comment
765
766 ;; Non-nil if the current line contains code and a comment.
767 has-code-and-comment
768
769 ;; If has-comment, the appropriate fill-prefix for the comment.
770 comment-fill-prefix
771 )
772
773 ;; Figure out what kind of comment we are looking at.
774 (save-excursion
775 (beginning-of-line)
776 (cond
777
778 ;; A line with nothing but a comment on it?
779 ((looking-at "[ \t]*;[; \t]*")
780 (setq has-comment t
781 comment-fill-prefix (buffer-substring (match-beginning 0)
782 (match-end 0))))
783
784 ;; A line with some code, followed by a comment? Remember that the
785 ;; semi which starts the comment shouldn't be part of a string or
786 ;; character.
787 ((condition-case nil
788 (save-restriction
789 (narrow-to-region (point-min)
790 (save-excursion (end-of-line) (point)))
791 (while (not (looking-at ";\\|$"))
792 (skip-chars-forward "^;\n\"\\\\?")
793 (cond
794 ((eq (char-after (point)) ?\\) (forward-char 2))
795 ((memq (char-after (point)) '(?\" ??)) (forward-sexp 1))))
796 (looking-at ";+[\t ]*"))
797 (error nil))
798 (setq has-comment t has-code-and-comment t)
799 (setq comment-fill-prefix
800 (concat (make-string (/ (current-column) 8) ?\t)
801 (make-string (% (current-column) 8) ?\ )
802 (buffer-substring (match-beginning 0) (match-end 0)))))))
803
804 (if (not has-comment)
805 (fill-paragraph justify)
806
807 ;; Narrow to include only the comment, and then fill the region.
808 (save-excursion
809 (save-restriction
810 (beginning-of-line)
811 (narrow-to-region
812 ;; Find the first line we should include in the region to fill.
813 (save-excursion
814 (while (and (zerop (forward-line -1))
815 (looking-at "^[ \t]*;")))
816 ;; We may have gone too far. Go forward again.
817 (or (looking-at ".*;")
818 (forward-line 1))
819 (point))
820 ;; Find the beginning of the first line past the region to fill.
821 (save-excursion
822 (while (progn (forward-line 1)
823 (looking-at "^[ \t]*;")))
824 (point)))
825
826 ;; Lines with only semicolons on them can be paragraph boundaries.
827 (let* ((paragraph-start (concat paragraph-start "\\|[ \t;]*$"))
828 (paragraph-separate (concat paragraph-start "\\|[ \t;]*$"))
829 (paragraph-ignore-fill-prefix nil)
830 (fill-prefix comment-fill-prefix)
831 (after-line (if has-code-and-comment
832 (save-excursion
833 (forward-line 1) (point))))
834 (end (progn
835 (forward-paragraph)
836 (or (bolp) (newline 1))
837 (point)))
838 ;; If this comment starts on a line with code,
839 ;; include that like in the filling.
840 (beg (progn (backward-paragraph)
841 (if (eq (point) after-line)
842 (forward-line -1))
843 (point))))
844 (fill-region-as-paragraph beg end
845 justify nil
846 (save-excursion
847 (goto-char beg)
848 (if (looking-at fill-prefix)
849 nil
850 (re-search-forward comment-start-skip)
851 (point))))))))
852 t))
853 \f
854 (defun indent-code-rigidly (start end arg &optional nochange-regexp)
855 "Indent all lines of code, starting in the region, sideways by ARG columns.
856 Does not affect lines starting inside comments or strings, assuming that
857 the start of the region is not inside them.
858
859 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
860 The last is a regexp which, if matched at the beginning of a line,
861 means don't indent that line."
862 (interactive "r\np")
863 (let (state)
864 (save-excursion
865 (goto-char end)
866 (setq end (point-marker))
867 (goto-char start)
868 (or (bolp)
869 (setq state (parse-partial-sexp (point)
870 (progn
871 (forward-line 1) (point))
872 nil nil state)))
873 (while (< (point) end)
874 (or (car (nthcdr 3 state))
875 (and nochange-regexp
876 (looking-at nochange-regexp))
877 ;; If line does not start in string, indent it
878 (let ((indent (current-indentation)))
879 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
880 (or (eolp)
881 (indent-to (max 0 (+ indent arg)) 0))))
882 (setq state (parse-partial-sexp (point)
883 (progn
884 (forward-line 1) (point))
885 nil nil state))))))
886
887 (provide 'lisp-mode)
888
889 ;;; lisp-mode.el ends here