1 ;;; lisp-mode.el --- Lisp mode, and its idiosyncratic commands.
3 ;; Copyright (C) 1985 Free Software Foundation, Inc.
6 ;; Keywords: lisp, languages
8 ;; This file is part of GNU Emacs.
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)
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.
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.
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 lisp-mode-syntax-table nil
"")
33 (defvar emacs-lisp-mode-syntax-table nil
"")
34 (defvar lisp-mode-abbrev-table nil
"")
36 (if (not emacs-lisp-mode-syntax-table
)
38 (setq emacs-lisp-mode-syntax-table
(make-syntax-table))
40 (modify-syntax-entry i
"_ " emacs-lisp-mode-syntax-table
)
44 (modify-syntax-entry i
"_ " emacs-lisp-mode-syntax-table
)
48 (modify-syntax-entry i
"_ " emacs-lisp-mode-syntax-table
)
52 (modify-syntax-entry i
"_ " emacs-lisp-mode-syntax-table
)
54 (modify-syntax-entry ?
" " emacs-lisp-mode-syntax-table
)
55 (modify-syntax-entry ?
\t " " emacs-lisp-mode-syntax-table
)
56 (modify-syntax-entry ?
\n "> " emacs-lisp-mode-syntax-table
)
57 ;; Give CR the same syntax as newline, for selective-display.
58 (modify-syntax-entry ?\^m
"> " emacs-lisp-mode-syntax-table
)
59 (modify-syntax-entry ?\
; "< " 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 ;; Used to be singlequote; changed for flonums.
64 (modify-syntax-entry ?.
"_ " emacs-lisp-mode-syntax-table
)
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
)))
73 (if (not lisp-mode-syntax-table
)
74 (progn (setq lisp-mode-syntax-table
75 (copy-syntax-table emacs-lisp-mode-syntax-table
))
76 (modify-syntax-entry ?\|
"\" " lisp-mode-syntax-table
)
77 (modify-syntax-entry ?\
[ "_ " lisp-mode-syntax-table
)
78 (modify-syntax-entry ?\
] "_ " lisp-mode-syntax-table
)))
80 (define-abbrev-table 'lisp-mode-abbrev-table
())
82 (defvar lisp-imenu-generic-expression
85 "^\\s-*(def\\(un\\|subst\\|macro\\|advice\\)\\s-+\\([-A-Za-z0-9+]+\\)" 2)
87 "^\\s-*(def\\(var\\|const\\)\\s-+\\([-A-Za-z0-9+]+\\)" 2)
89 "^\\s-*(def\\(type\\|struct\\|class\\|ine-condition\\)\\s-+\\([-A-Za-z0-9+]+\\)"
92 "Imenu generic expression for Lisp mode. See `imenu-generic-expression'.")
94 (defun lisp-mode-variables (lisp-syntax)
96 (set-syntax-table lisp-mode-syntax-table
)))
97 (setq local-abbrev-table lisp-mode-abbrev-table
)
98 (make-local-variable 'paragraph-start
)
99 (setq paragraph-start
(concat page-delimiter
"\\|$" ))
100 (make-local-variable 'paragraph-separate
)
101 (setq paragraph-separate paragraph-start
)
102 (make-local-variable 'paragraph-ignore-fill-prefix
)
103 (setq paragraph-ignore-fill-prefix t
)
104 (make-local-variable 'fill-paragraph-function
)
105 (setq fill-paragraph-function
'lisp-fill-paragraph
)
106 ;; Adaptive fill mode gets in the way of auto-fill,
107 ;; and should make no difference for explicit fill
108 ;; because lisp-fill-paragraph should do the job.
109 (make-local-variable 'adaptive-fill-mode
)
110 (setq adaptive-fill-mode nil
)
111 (make-local-variable 'indent-line-function
)
112 (setq indent-line-function
'lisp-indent-line
)
113 (make-local-variable 'indent-region-function
)
114 (setq indent-region-function
'lisp-indent-region
)
115 (make-local-variable 'parse-sexp-ignore-comments
)
116 (setq parse-sexp-ignore-comments t
)
117 (make-local-variable 'outline-regexp
)
118 (setq outline-regexp
";;; \\|(....")
119 (make-local-variable 'comment-start
)
120 (setq comment-start
";")
121 (make-local-variable 'comment-start-skip
)
122 (setq comment-start-skip
";+ *")
123 (make-local-variable 'comment-column
)
124 (setq comment-column
40)
125 (make-local-variable 'comment-indent-function
)
126 (setq comment-indent-function
'lisp-comment-indent
)
127 (make-local-variable 'imenu-generic-expression
)
128 (setq imenu-generic-expression lisp-imenu-generic-expression
))
130 (defvar shared-lisp-mode-map
()
131 "Keymap for commands shared by all sorts of Lisp modes.")
133 (if shared-lisp-mode-map
135 (setq shared-lisp-mode-map
(make-sparse-keymap))
136 (define-key shared-lisp-mode-map
"\e\C-q" 'indent-sexp
)
137 (define-key shared-lisp-mode-map
"\177" 'backward-delete-char-untabify
))
139 (defvar emacs-lisp-mode-map
()
140 "Keymap for Emacs Lisp mode.
141 All commands in `shared-lisp-mode-map' are inherited by this map.")
143 (if emacs-lisp-mode-map
145 (let ((map (make-sparse-keymap "Emacs-Lisp")))
146 (setq emacs-lisp-mode-map
147 (nconc (make-sparse-keymap) shared-lisp-mode-map
))
148 (define-key emacs-lisp-mode-map
"\e\t" 'lisp-complete-symbol
)
149 (define-key emacs-lisp-mode-map
"\e\C-x" 'eval-defun
)
150 (define-key emacs-lisp-mode-map
[menu-bar
] (make-sparse-keymap))
151 (define-key emacs-lisp-mode-map
[menu-bar emacs-lisp
]
152 (cons "Emacs-Lisp" map
))
153 (define-key map
[edebug-defun
]
154 '("Instrument Function for Debugging" . edebug-defun
))
155 (define-key map
[byte-recompile
]
156 '("Byte-recompile Directory..." . byte-recompile-directory
))
157 (define-key map
[emacs-byte-compile-and-load
]
158 '("Byte-compile And Load" . emacs-lisp-byte-compile-and-load
))
159 (define-key map
[byte-compile
]
160 '("Byte-compile This File" . emacs-lisp-byte-compile
))
161 (define-key map
[separator-eval
] '("--"))
162 (define-key map
[eval-buffer
] '("Evaluate Buffer" . eval-current-buffer
))
163 (define-key map
[eval-region
] '("Evaluate Region" . eval-region
))
164 (define-key map
[eval-sexp
] '("Evaluate Last S-expression" . eval-last-sexp
))
165 (define-key map
[separator-format
] '("--"))
166 (define-key map
[comment-region
] '("Comment Out Region" . comment-region
))
167 (define-key map
[indent-region
] '("Indent Region" . indent-region
))
168 (define-key map
[indent-line
] '("Indent Line" . lisp-indent-line
))
169 (put 'eval-region
'menu-enable
'mark-active
)
170 (put 'comment-region
'menu-enable
'mark-active
)
171 (put 'indent-region
'menu-enable
'mark-active
)))
173 (defun emacs-lisp-byte-compile ()
174 "Byte compile the file containing the current buffer."
177 (byte-compile-file buffer-file-name
)
178 (error "The buffer must be saved in a file first")))
180 (defun emacs-lisp-byte-compile-and-load ()
181 "Byte-compile the current file (if it has changed), then load compiled code."
184 (error "The buffer must be saved in a file first"))
186 ;; Recompile if file or buffer has changed since last compilation.
187 (if (and (buffer-modified-p)
188 (y-or-n-p (format "save buffer %s first? " (buffer-name))))
190 (let ((compiled-file-name (byte-compile-dest-file buffer-file-name
)))
191 (if (file-newer-than-file-p compiled-file-name buffer-file-name
)
192 (load-file compiled-file-name
)
193 (byte-compile-file buffer-file-name t
))))
195 (defun emacs-lisp-mode ()
196 "Major mode for editing Lisp code to run in Emacs.
198 Delete converts tabs to spaces as it moves back.
199 Blank lines separate paragraphs. Semicolons start comments.
200 \\{emacs-lisp-mode-map}
201 Entry to this mode calls the value of `emacs-lisp-mode-hook'
202 if that value is non-nil."
204 (kill-all-local-variables)
205 (use-local-map emacs-lisp-mode-map
)
206 (set-syntax-table emacs-lisp-mode-syntax-table
)
207 (setq major-mode
'emacs-lisp-mode
)
208 (setq mode-name
"Emacs-Lisp")
209 (lisp-mode-variables nil
)
210 (run-hooks 'emacs-lisp-mode-hook
))
212 (defvar lisp-mode-map
()
213 "Keymap for ordinary Lisp mode.
214 All commands in `shared-lisp-mode-map' are inherited by this map.")
219 (nconc (make-sparse-keymap) shared-lisp-mode-map
))
220 (define-key lisp-mode-map
"\e\C-x" 'lisp-eval-defun
)
221 (define-key lisp-mode-map
"\C-c\C-z" 'run-lisp
))
224 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp.
226 Delete converts tabs to spaces as it moves back.
227 Blank lines separate paragraphs. Semicolons start comments.
229 Note that `run-lisp' may be used either to start an inferior Lisp job
230 or to switch back to an existing one.
232 Entry to this mode calls the value of `lisp-mode-hook'
233 if that value is non-nil."
235 (kill-all-local-variables)
236 (use-local-map lisp-mode-map
)
237 (setq major-mode
'lisp-mode
)
238 (setq mode-name
"Lisp")
239 (lisp-mode-variables t
)
240 (set-syntax-table lisp-mode-syntax-table
)
241 (run-hooks 'lisp-mode-hook
))
243 ;; This will do unless shell.el is loaded.
244 (defun lisp-eval-defun nil
245 "Send the current defun to the Lisp process made by \\[run-lisp]."
247 (error "Process lisp does not exist"))
249 (defvar lisp-interaction-mode-map
()
250 "Keymap for Lisp Interaction moe.
251 All commands in `shared-lisp-mode-map' are inherited by this map.")
253 (if lisp-interaction-mode-map
255 (setq lisp-interaction-mode-map
256 (nconc (make-sparse-keymap) shared-lisp-mode-map
))
257 (define-key lisp-interaction-mode-map
"\e\C-x" 'eval-defun
)
258 (define-key lisp-interaction-mode-map
"\e\t" 'lisp-complete-symbol
)
259 (define-key lisp-interaction-mode-map
"\n" 'eval-print-last-sexp
))
261 (defun lisp-interaction-mode ()
262 "Major mode for typing and evaluating Lisp forms.
263 Like Lisp mode except that \\[eval-print-last-sexp] evals the Lisp expression
264 before point, and prints its value into the buffer, advancing point.
267 Delete converts tabs to spaces as it moves back.
268 Paragraphs are separated only by blank lines.
269 Semicolons start comments.
270 \\{lisp-interaction-mode-map}
271 Entry to this mode calls the value of `lisp-interaction-mode-hook'
272 if that value is non-nil."
274 (kill-all-local-variables)
275 (use-local-map lisp-interaction-mode-map
)
276 (setq major-mode
'lisp-interaction-mode
)
277 (setq mode-name
"Lisp Interaction")
278 (set-syntax-table emacs-lisp-mode-syntax-table
)
279 (lisp-mode-variables nil
)
280 (run-hooks 'lisp-interaction-mode-hook
))
282 (defun eval-print-last-sexp ()
283 "Evaluate sexp before point; print value into current buffer."
285 (let ((standard-output (current-buffer)))
290 (defun eval-last-sexp (eval-last-sexp-arg-internal)
291 "Evaluate sexp before point; print value in minibuffer.
292 With argument, print output into current buffer."
294 (let ((standard-output (if eval-last-sexp-arg-internal
(current-buffer) t
))
296 (prin1 (let ((stab (syntax-table)))
297 (eval (unwind-protect
299 (set-syntax-table emacs-lisp-mode-syntax-table
)
302 (narrow-to-region (point-min) opoint
)
303 (read (current-buffer))))
304 (set-syntax-table stab
)))))))
306 (defun eval-defun (eval-defun-arg-internal)
307 "Evaluate defun that point is in or before.
308 Print value in minibuffer.
309 With argument, insert value in current buffer after the defun."
311 (let ((standard-output (if eval-defun-arg-internal
(current-buffer) t
))
312 (form (save-excursion
315 (read (current-buffer)))))
316 (if (and (eq (car form
) 'defvar
)
317 (cdr-safe (cdr-safe form
)))
318 (setq form
(cons 'defconst
(cdr form
))))
319 (prin1 (eval form
))))
321 (defun lisp-comment-indent ()
322 (if (looking-at "\\s<\\s<\\s<")
324 (if (looking-at "\\s<\\s<")
325 (let ((tem (calculate-lisp-indent)))
326 (if (listp tem
) (car tem
) tem
))
327 (skip-chars-backward " \t")
328 (max (if (bolp) 0 (1+ (current-column)))
331 (defconst lisp-indent-offset nil
"")
332 (defconst lisp-indent-function
'lisp-indent-function
"")
334 (defun lisp-indent-line (&optional whole-exp
)
335 "Indent current line as Lisp code.
336 With argument, indent any additional lines of the same expression
337 rigidly along with this one."
339 (let ((indent (calculate-lisp-indent)) shift-amt beg end
340 (pos (- (point-max) (point))))
343 (skip-chars-forward " \t")
344 (if (looking-at "\\s<\\s<\\s<")
345 ;; Don't alter indentation of a ;;; comment line.
346 (goto-char (- (point-max) pos
))
347 (if (and (looking-at "\\s<") (not (looking-at "\\s<\\s<")))
348 ;; Single-semicolon comment lines should be indented
349 ;; as comment lines, not as code.
350 (progn (indent-for-comment) (forward-char -
1))
351 (if (listp indent
) (setq indent
(car indent
)))
352 (setq shift-amt
(- indent
(current-column)))
353 (if (zerop shift-amt
)
355 (delete-region beg
(point))
357 ;; If initial point was within line's indentation,
358 ;; position after the indentation. Else stay at same point in text.
359 (if (> (- (point-max) pos
) (point))
360 (goto-char (- (point-max) pos
)))
361 ;; If desired, shift remaining lines of expression the same amount.
362 (and whole-exp
(not (zerop shift-amt
))
371 (indent-code-rigidly beg end shift-amt
)))))
373 (defvar calculate-lisp-indent-last-sexp
)
375 (defun calculate-lisp-indent (&optional parse-start
)
376 "Return appropriate indentation for current line as Lisp code.
377 In usual case returns an integer: the column to indent to.
378 Can instead return a list, whose car is the column to indent to.
379 This means that following lines at the same level of indentation
380 should not necessarily be indented the same way.
381 The second element of the list is the buffer position
382 of the start of the containing expression."
385 (let ((indent-point (point))
387 ;; setting this to a number inhibits calling hook
390 calculate-lisp-indent-last-sexp containing-sexp
)
392 (goto-char parse-start
)
393 (beginning-of-defun))
394 ;; Find outermost containing sexp
395 (while (< (point) indent-point
)
396 (setq state
(parse-partial-sexp (point) indent-point
0)))
397 ;; Find innermost containing sexp
400 (> (setq paren-depth
(elt state
0)) 0))
402 (setq calculate-lisp-indent-last-sexp
(elt state
2))
403 (setq containing-sexp
(elt state
1))
404 ;; Position following last unclosed open.
405 (goto-char (1+ containing-sexp
))
406 ;; Is there a complete sexp since then?
407 (if (and calculate-lisp-indent-last-sexp
408 (> calculate-lisp-indent-last-sexp
(point)))
409 ;; Yes, but is there a containing sexp after that?
410 (let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
412 (if (setq retry
(car (cdr peek
))) (setq state peek
)))))
415 ;; Innermost containing sexp found
416 (goto-char (1+ containing-sexp
))
417 (if (not calculate-lisp-indent-last-sexp
)
418 ;; indent-point immediately follows open paren.
420 (setq desired-indent
(current-column))
421 ;; Find the start of first element of containing sexp.
422 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
0 t
)
423 (cond ((looking-at "\\s(")
424 ;; First element of containing sexp is a list.
425 ;; Indent under that list.
427 ((> (save-excursion (forward-line 1) (point))
428 calculate-lisp-indent-last-sexp
)
429 ;; This is the first line to start within the containing sexp.
430 ;; It's almost certainly a function call.
431 (if (= (point) calculate-lisp-indent-last-sexp
)
432 ;; Containing sexp has nothing before this line
433 ;; except the first element. Indent under that element.
435 ;; Skip the first element, find start of second (the first
436 ;; argument of the function call) and indent under.
437 (progn (forward-sexp 1)
438 (parse-partial-sexp (point)
439 calculate-lisp-indent-last-sexp
441 (backward-prefix-chars))
443 ;; Indent beneath first sexp on same line as
444 ;; calculate-lisp-indent-last-sexp. Again, it's
445 ;; almost certainly a function call.
446 (goto-char calculate-lisp-indent-last-sexp
)
448 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
450 (backward-prefix-chars)))))
451 ;; Point is at the point to indent under unless we are inside a string.
452 ;; Call indentation hook except when overridden by lisp-indent-offset
453 ;; or if the desired indentation has already been computed.
454 (let ((normal-indent (current-column)))
456 ;; Inside a string, don't change indentation.
457 (goto-char indent-point
)
458 (skip-chars-forward " \t")
460 ((and (integerp lisp-indent-offset
) containing-sexp
)
461 ;; Indent by constant offset
462 (goto-char containing-sexp
)
463 (+ (current-column) lisp-indent-offset
))
465 ((and (boundp 'lisp-indent-function
)
468 (or (funcall lisp-indent-function indent-point state
)
473 (defun lisp-indent-function (indent-point state
)
474 (let ((normal-indent (current-column)))
475 (goto-char (1+ (elt state
1)))
476 (parse-partial-sexp (point) calculate-lisp-indent-last-sexp
0 t
)
477 (if (and (elt state
2)
478 (not (looking-at "\\sw\\|\\s_")))
479 ;; car of form doesn't seem to be a a symbol
481 (if (not (> (save-excursion (forward-line 1) (point))
482 calculate-lisp-indent-last-sexp
))
483 (progn (goto-char calculate-lisp-indent-last-sexp
)
485 (parse-partial-sexp (point)
486 calculate-lisp-indent-last-sexp
0 t
)))
487 ;; Indent under the list or under the first sexp on the same
488 ;; line as calculate-lisp-indent-last-sexp. Note that first
489 ;; thing on that line has to be complete sexp since we are
490 ;; inside the innermost containing sexp.
491 (backward-prefix-chars)
493 (let ((function (buffer-substring (point)
494 (progn (forward-sexp 1) (point))))
496 (setq method
(or (get (intern-soft function
) 'lisp-indent-function
)
497 (get (intern-soft function
) 'lisp-indent-hook
)))
498 (cond ((or (eq method
'defun
)
500 (> (length function
) 3)
501 (string-match "\\`def" function
)))
502 (lisp-indent-defform state indent-point
))
504 (lisp-indent-specform method state
505 indent-point normal-indent
))
507 (funcall method state indent-point
)))))))
509 (defconst lisp-body-indent
2
510 "Number of columns to indent the second line of a `(def...)' form.")
512 (defun lisp-indent-specform (count state indent-point normal-indent
)
513 (let ((containing-form-start (elt state
1))
515 body-indent containing-form-column
)
516 ;; Move to the start of containing form, calculate indentation
517 ;; to use for non-distinguished forms (> count), and move past the
518 ;; function symbol. lisp-indent-function guarantees that there is at
519 ;; least one word or symbol character following open paren of containing
521 (goto-char containing-form-start
)
522 (setq containing-form-column
(current-column))
523 (setq body-indent
(+ lisp-body-indent containing-form-column
))
526 ;; Now find the start of the last form.
527 (parse-partial-sexp (point) indent-point
1 t
)
528 (while (and (< (point) indent-point
)
531 (setq count
(1- count
))
533 (parse-partial-sexp (point) indent-point
1 t
))
535 ;; Point is sitting on first character of last (or count) sexp.
537 ;; A distinguished form. If it is the first or second form use double
538 ;; lisp-body-indent, else normal indent. With lisp-body-indent bound
539 ;; to 2 (the default), this just happens to work the same with if as
540 ;; the older code, but it makes unwind-protect, condition-case,
541 ;; with-output-to-temp-buffer, et. al. much more tasteful. The older,
542 ;; less hacked, behavior can be obtained by replacing below with
543 ;; (list normal-indent containing-form-start).
544 (if (<= (- i count
) 1)
545 (list (+ containing-form-column
(* 2 lisp-body-indent
))
546 containing-form-start
)
547 (list normal-indent containing-form-start
))
548 ;; A non-distinguished form. Use body-indent if there are no
549 ;; distinguished forms and this is the first undistinguished form,
550 ;; or if this is the first undistinguished form and the preceding
551 ;; distinguished form has indentation at least as great as body-indent.
552 (if (or (and (= i
0) (= count
0))
553 (and (= count
0) (<= body-indent normal-indent
)))
557 (defun lisp-indent-defform (state indent-point
)
558 (goto-char (car (cdr state
)))
560 (if (> (point) (car (cdr (cdr state
))))
562 (goto-char (car (cdr state
)))
563 (+ lisp-body-indent
(current-column)))))
566 ;; (put 'progn 'lisp-indent-function 0), say, causes progn to be indented
567 ;; like defun if the first form is placed on the next line, otherwise
568 ;; it is indented like any other form (i.e. forms line up under first).
570 (put 'lambda
'lisp-indent-function
'defun
)
571 (put 'autoload
'lisp-indent-function
'defun
)
572 (put 'progn
'lisp-indent-function
0)
573 (put 'prog1
'lisp-indent-function
1)
574 (put 'prog2
'lisp-indent-function
2)
575 (put 'save-excursion
'lisp-indent-function
0)
576 (put 'save-window-excursion
'lisp-indent-function
0)
577 (put 'save-selected-window
'lisp-indent-function
0)
578 (put 'save-restriction
'lisp-indent-function
0)
579 (put 'save-match-data
'lisp-indent-function
0)
580 (put 'let
'lisp-indent-function
1)
581 (put 'let
* 'lisp-indent-function
1)
582 (put 'while
'lisp-indent-function
1)
583 (put 'if
'lisp-indent-function
2)
584 (put 'catch
'lisp-indent-function
1)
585 (put 'condition-case
'lisp-indent-function
2)
586 (put 'unwind-protect
'lisp-indent-function
1)
587 (put 'with-output-to-temp-buffer
'lisp-indent-function
1)
589 (defun indent-sexp (&optional endpos
)
590 "Indent each line of the list starting just after point.
591 If optional arg ENDPOS is given, indent each line, stopping when
592 ENDPOS is encountered."
594 (let ((indent-stack (list nil
))
596 ;; If ENDPOS is non-nil, use nil as STARTING-POINT
597 ;; so that calculate-lisp-indent will find the beginning of
598 ;; the defun we are in.
599 ;; If ENDPOS is nil, it is safe not to scan before point
600 ;; since every line we indent is more deeply nested than point is.
601 (starting-point (if endpos nil
(point)))
603 last-depth bol outer-loop-done inner-loop-done state this-indent
)
605 ;; Get error now if we don't have a complete sexp after point.
606 (save-excursion (forward-sexp 1)))
608 (setq outer-loop-done nil
)
609 (while (if endpos
(< (point) endpos
)
610 (not outer-loop-done
))
611 (setq last-depth next-depth
613 ;; Parse this line so we can learn the state
614 ;; to indent the next line.
615 ;; This inner loop goes through only once
616 ;; unless a line ends inside a string.
617 (while (and (not inner-loop-done
)
618 (not (setq outer-loop-done
(eobp))))
619 (setq state
(parse-partial-sexp (point) (progn (end-of-line) (point))
621 (setq next-depth
(car state
))
622 ;; If the line contains a comment other than the sort
623 ;; that is indented like code,
624 ;; indent it now with indent-for-comment.
625 ;; Comments indented like code are right already.
626 ;; In any case clear the in-comment flag in the state
627 ;; because parse-partial-sexp never sees the newlines.
628 (if (car (nthcdr 4 state
))
629 (progn (indent-for-comment)
631 (setcar (nthcdr 4 state
) nil
)))
632 ;; If this line ends inside a string,
633 ;; go straight to next line, remaining within the inner loop,
634 ;; and turn off the \-flag.
635 (if (car (nthcdr 3 state
))
638 (setcar (nthcdr 5 state
) nil
))
639 (setq inner-loop-done t
)))
643 (setq indent-stack
(append indent-stack
644 (make-list (- next-depth
) nil
))
645 last-depth
(- last-depth next-depth
)
647 (or outer-loop-done endpos
648 (setq outer-loop-done
(<= next-depth
0)))
651 (while (> last-depth next-depth
)
652 (setq indent-stack
(cdr indent-stack
)
653 last-depth
(1- last-depth
)))
654 (while (< last-depth next-depth
)
655 (setq indent-stack
(cons nil indent-stack
)
656 last-depth
(1+ last-depth
)))
657 ;; Now go to the next line and indent it according
658 ;; to what we learned from parsing the previous one.
661 (skip-chars-forward " \t")
662 ;; But not if the line is blank, or just a comment
663 ;; (except for double-semi comments; indent them as usual).
664 (if (or (eobp) (looking-at "\\s<\\|\n"))
666 (if (and (car indent-stack
)
667 (>= (car indent-stack
) 0))
668 (setq this-indent
(car indent-stack
))
669 (let ((val (calculate-lisp-indent
670 (if (car indent-stack
) (- (car indent-stack
))
674 (setq this-indent val
))
675 (setcar indent-stack
(- (car (cdr val
))))
676 (setq this-indent
(car val
)))))
677 (if (/= (current-column) this-indent
)
678 (progn (delete-region bol
(point))
679 (indent-to this-indent
)))))
681 (setq outer-loop-done
(= (point) last-point
))
682 (setq last-point
(point)))))))
684 ;; Indent every line whose first char is between START and END inclusive.
685 (defun lisp-indent-region (start end
)
687 (let ((endmark (copy-marker end
)))
689 (and (bolp) (not (eolp))
691 (indent-sexp endmark
)
692 (set-marker endmark nil
))))
694 ;;;; Lisp paragraph filling commands.
696 (defun lisp-fill-paragraph (&optional justify
)
697 "Like \\[fill-paragraph], but handle Emacs Lisp comments.
698 If any of the current line is a comment, fill the comment or the
699 paragraph of it that point is in, preserving the comment's indentation
700 and initial semicolons."
703 ;; Non-nil if the current line contains a comment.
706 ;; If has-comment, the appropriate fill-prefix for the comment.
710 ;; Figure out what kind of comment we are looking at.
715 ;; A line with nothing but a comment on it?
716 ((looking-at "[ \t]*;[; \t]*")
718 comment-fill-prefix
(buffer-substring (match-beginning 0)
721 ;; A line with some code, followed by a comment? Remember that the
722 ;; semi which starts the comment shouldn't be part of a string or
726 (narrow-to-region (point-min)
727 (save-excursion (end-of-line) (point)))
728 (while (not (looking-at ";\\|$"))
729 (skip-chars-forward "^;\n\"\\\\?")
731 ((eq (char-after (point)) ?
\\) (forward-char 2))
732 ((memq (char-after (point)) '(?
\" ??
)) (forward-sexp 1))))
733 (looking-at ";+[\t ]*"))
736 (setq comment-fill-prefix
737 (concat (make-string (/ (current-column) 8) ?
\t)
738 (make-string (%
(current-column) 8) ?\
)
739 (buffer-substring (match-beginning 0) (match-end 0)))))))
741 (if (not has-comment
)
742 (fill-paragraph justify
)
744 ;; Narrow to include only the comment, and then fill the region.
749 ;; Find the first line we should include in the region to fill.
751 (while (and (zerop (forward-line -
1))
752 (looking-at "^[ \t]*;")))
753 ;; We may have gone too far. Go forward again.
754 (or (looking-at ".*;")
757 ;; Find the beginning of the first line past the region to fill.
759 (while (progn (forward-line 1)
760 (looking-at "^[ \t]*;")))
763 ;; Lines with only semicolons on them can be paragraph boundaries.
764 (let* ((paragraph-start (concat paragraph-start
"\\|[ \t;]*$"))
765 (paragraph-separate (concat paragraph-start
"\\|[ \t;]*$"))
766 (paragraph-ignore-fill-prefix nil
)
767 (fill-prefix comment-fill-prefix
)
770 (or (bolp) (newline 1))
772 (beg (progn (backward-paragraph) (point))))
773 (fill-region-as-paragraph beg end
777 (if (looking-at fill-prefix
)
779 (re-search-forward comment-start-skip
)
784 (defun indent-code-rigidly (start end arg
&optional nochange-regexp
)
785 "Indent all lines of code, starting in the region, sideways by ARG columns.
786 Does not affect lines starting inside comments or strings, assuming that
787 the start of the region is not inside them.
789 Called from a program, takes args START, END, COLUMNS and NOCHANGE-REGEXP.
790 The last is a regexp which, if matched at the beginning of a line,
791 means don't indent that line."
796 (setq end
(point-marker))
799 (setq state
(parse-partial-sexp (point)
801 (forward-line 1) (point))
803 (while (< (point) end
)
804 (or (car (nthcdr 3 state
))
806 (looking-at nochange-regexp
))
807 ;; If line does not start in string, indent it
808 (let ((indent (current-indentation)))
809 (delete-region (point) (progn (skip-chars-forward " \t") (point)))
811 (indent-to (max 0 (+ indent arg
)) 0))))
812 (setq state
(parse-partial-sexp (point)
814 (forward-line 1) (point))
819 ;;; lisp-mode.el ends here