1 ;;; cl-indent.el --- enhanced lisp-indent mode
3 ;; Copyright (C) 1987, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Richard Mlynarik <mly@eddie.mit.edu>
8 ;; Keywords: lisp, tools
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This package supplies a single entry point, common-lisp-indent-function,
29 ;; which performs indentation in the preferred style for Common Lisp code.
32 ;; (setq lisp-indent-function 'common-lisp-indent-function)
36 (eval-when-compile (require 'cl
))
38 (defgroup lisp-indent nil
39 "Indentation in Lisp."
43 (defcustom lisp-indent-maximum-backtracking
3
44 "Maximum depth to backtrack out from a sublist for structured indentation.
45 If this variable is 0, no backtracking will occur and forms such as `flet'
46 may not be correctly indented."
50 (defcustom lisp-tag-indentation
1
51 "Indentation of tags relative to containing list.
52 This variable is used by the function `lisp-indent-tagbody'."
56 (defcustom lisp-tag-body-indentation
3
57 "Indentation of non-tagged lines relative to containing list.
58 This variable is used by the function `lisp-indent-tagbody' to indent normal
59 lines (lines without tags).
60 The indentation is relative to the indentation of the parenthesis enclosing
61 the special form. If the value is t, the body of tags will be indented
62 as a block at the same indentation as the first s-expression following
63 the tag. In this case, any forms before the first tag are indented
64 by `lisp-body-indent'."
68 (defcustom lisp-backquote-indentation t
69 "Whether or not to indent backquoted lists as code.
70 If nil, indent backquoted lists as data, i.e., like quoted lists."
75 (defcustom lisp-loop-keyword-indentation
3
76 "Indentation of loop keywords in extended loop forms."
81 (defcustom lisp-loop-forms-indentation
5
82 "Indentation of forms in extended loop forms."
87 (defcustom lisp-simple-loop-indentation
3
88 "Indentation of forms in simple loop forms."
92 (defcustom lisp-lambda-list-keyword-alignment nil
93 "Whether to vertically align lambda-list keywords together.
94 If nil (the default), keyworded lambda-list parts are aligned
95 with the initial mandatory arguments, like this:
97 \(defun foo (arg1 arg2 &rest rest
101 If non-nil, alignment is done with the first keyword
102 \(or falls back to the previous case), as in:
104 \(defun foo (arg1 arg2 &rest rest
110 (defcustom lisp-lambda-list-keyword-parameter-indentation
2
111 "Indentation of lambda list keyword parameters.
112 See `lisp-lambda-list-keyword-parameter-alignment'
113 for more information."
117 (defcustom lisp-lambda-list-keyword-parameter-alignment nil
118 "Whether to vertically align lambda-list keyword parameters together.
119 If nil (the default), the parameters are aligned
120 with their corresponding keyword, plus the value of
121 `lisp-lambda-list-keyword-parameter-indentation', like this:
123 \(defun foo (arg1 arg2 &key key1 key2
127 If non-nil, alignment is done with the first parameter
128 \(or falls back to the previous case), as in:
130 \(defun foo (arg1 arg2 &key key1 key2
137 (defvar lisp-indent-defun-method
'(4 &lambda
&body
)
138 "Defun-like indentation method.
139 This applies when the value of the `common-lisp-indent-function' property
143 (defun extended-loop-p (loop-start)
144 "True if an extended loop form starts at LOOP-START."
147 (goto-char loop-start
)
155 (defun common-lisp-loop-part-indentation (indent-point state
)
156 "Compute the indentation of loop form constituents."
157 (let* ((loop-indentation (save-excursion
158 (goto-char (elt state
1))
160 (goto-char indent-point
)
162 (cond ((not (extended-loop-p (elt state
1)))
163 (+ loop-indentation lisp-simple-loop-indentation
))
164 ((looking-at "^\\s-*\\(:?\\sw+\\|;\\)")
165 (+ loop-indentation lisp-loop-keyword-indentation
))
167 (+ loop-indentation lisp-loop-forms-indentation
)))))
170 ;; Cf (info "(elisp)Specification List")
172 (defun common-lisp-indent-function (indent-point state
)
173 "Function to indent the arguments of a Lisp function call.
174 This is suitable for use as the value of the variable
175 `lisp-indent-function'. INDENT-POINT is the point at which the
176 indentation function is called, and STATE is the
177 `parse-partial-sexp' state at that position. Browse the
178 `lisp-indent' customize group for options affecting the behavior
181 If the indentation point is in a call to a Lisp function, that
182 function's `common-lisp-indent-function' property specifies how
183 this function should indent it. Possible values for this
186 * defun, meaning indent according to `lisp-indent-defun-method';
187 i.e., like (4 &lambda &body), as explained below.
189 * any other symbol, meaning a function to call. The function should
190 take the arguments: PATH STATE INDENT-POINT SEXP-COLUMN NORMAL-INDENT.
191 PATH is a list of integers describing the position of point in terms of
192 list-structure with respect to the containing lists. For example, in
193 ((a b c (d foo) f) g), foo has a path of (0 3 1). In other words,
194 to reach foo take the 0th element of the outermost list, then
195 the 3rd element of the next list, and finally the 1st element.
196 STATE and INDENT-POINT are as in the arguments to
197 `common-lisp-indent-function'. SEXP-COLUMN is the column of
198 the open parenthesis of the innermost containing list.
199 NORMAL-INDENT is the column the indentation point was
200 originally in. This function should behave like `lisp-indent-259'.
202 * an integer N, meaning indent the first N arguments like
203 function arguments, and any further arguments like a body.
204 This is equivalent to (4 4 ... &body).
206 * a list. The list element in position M specifies how to indent the Mth
207 function argument. If there are fewer elements than function arguments,
208 the last list element applies to all remaining arguments. The accepted
211 * nil, meaning the default indentation.
213 * an integer, specifying an explicit indentation.
215 * &lambda. Indent the argument (which may be a list) by 4.
217 * &rest. When used, this must be the penultimate element. The
218 element after this one applies to all remaining arguments.
220 * &body. This is equivalent to &rest lisp-body-indent, i.e., indent
221 all remaining elements by `lisp-body-indent'.
223 * &whole. This must be followed by nil, an integer, or a
224 function symbol. This indentation is applied to the
225 associated argument, and as a base indent for all remaining
226 arguments. For example, an integer P means indent this
227 argument by P, and all remaining arguments by P, plus the
228 value specified by their associated list element.
230 * a symbol. A function to call, with the 6 arguments specified above.
232 * a list, with elements as described above. This applies when the
233 associated function argument is itself a list. Each element of the list
234 specifies how to indent the associated argument.
236 For example, the function `case' has an indent property
237 \(4 &rest (&whole 2 &rest 1)), meaning:
238 * indent the first argument by 4.
239 * arguments after the first should be lists, and there may be any number
240 of them. The first list element has an offset of 2, all the rest
241 have an offset of 2+1=3."
242 (if (save-excursion (goto-char (elt state
1))
243 (looking-at "([Ll][Oo][Oo][Pp]"))
244 (common-lisp-loop-part-indentation indent-point state
)
245 (common-lisp-indent-function-1 indent-point state
)))
248 (defun common-lisp-indent-function-1 (indent-point state
)
249 (let ((normal-indent (current-column)))
250 ;; Walk up list levels until we see something
251 ;; which does special things with subforms.
253 ;; Path describes the position of point in terms of
254 ;; list-structure with respect to containing lists.
255 ;; `foo' has a path of (0 3 1) in `((a b c (d foo) f) g)'.
257 ;; set non-nil when somebody works out the indentation to use
259 ;; If non-nil, this is an indentation to use
260 ;; if nothing else specifies it more firmly.
262 (last-point indent-point
)
263 ;; the position of the open-paren of the innermost containing list
264 (containing-form-start (elt state
1))
265 ;; the column of the above
267 ;; Move to start of innermost containing list
268 (goto-char containing-form-start
)
269 (setq sexp-column
(current-column))
271 ;; Look over successively less-deep containing forms
272 (while (and (not calculated
)
273 (< depth lisp-indent-maximum-backtracking
))
274 (let ((containing-sexp (point)))
276 (parse-partial-sexp (point) indent-point
1 t
)
277 ;; Move to the car of the relevant containing form
278 (let (tem function method tentative-defun
)
279 (if (not (looking-at "\\sw\\|\\s_"))
280 ;; This form doesn't seem to start with a symbol
281 (setq function nil method nil
)
284 (setq function
(downcase (buffer-substring-no-properties
287 (setq tem
(intern-soft function
)
288 method
(get tem
'common-lisp-indent-function
))
289 (cond ((and (null method
)
290 (string-match ":[^:]+" function
))
291 ;; The pleblisp package feature
292 (setq function
(substring function
293 (1+ (match-beginning 0)))
294 method
(get (intern-soft function
)
295 'common-lisp-indent-function
)))
297 ;; backwards compatibility
298 (setq method
(get tem
'lisp-indent-function
)))))
300 ;; How far into the containing form is the current form?
301 (if (< (point) indent-point
)
302 (while (condition-case ()
305 (if (>= (point) indent-point
)
307 (parse-partial-sexp (point)
312 (setq path
(cons n path
)))
314 ;; backwards compatibility.
315 (cond ((null function
))
317 (when (null (cdr path
))
318 ;; (package prefix was stripped off above)
319 (cond ((string-match "\\`def"
321 (setq tentative-defun
t))
325 (regexp-opt '("with" "without" "do"))
328 (setq method
'(&lambda
&body
))))))
329 ;; backwards compatibility. Bletch.
331 (setq method lisp-indent-defun-method
)))
333 (cond ((and (or (eq (char-after (1- containing-sexp
)) ?
\')
334 (and (not lisp-backquote-indentation
)
335 (eq (char-after (1- containing-sexp
)) ?\
`)))
336 (not (eq (char-after (- containing-sexp
2)) ?\
#)))
337 ;; No indentation for "'(...)" elements
338 (setq calculated
(1+ sexp-column
)))
339 ((or (eq (char-after (1- containing-sexp
)) ?\
,)
340 (and (eq (char-after (1- containing-sexp
)) ?\
@)
341 (eq (char-after (- containing-sexp
2)) ?\
,)))
342 ;; ",(...)" or ",@(...)"
343 (setq calculated normal-indent
))
344 ((eq (char-after (1- containing-sexp
)) ?\
#)
346 (setq calculated
(1+ sexp-column
)))
348 ;; If this looks like a call to a `def...' form,
349 ;; think about indenting it as one, but do it
350 ;; tentatively for cases like
353 ;; Set both normal-indent and tentative-calculated.
354 ;; The latter ensures this value gets used
355 ;; if there are no relevant containing constructs.
356 ;; The former ensures this value gets used
357 ;; if there is a relevant containing construct
358 ;; but we are nested within the structure levels
359 ;; that it specifies indentation for.
361 (setq tentative-calculated
362 (common-lisp-indent-call-method
363 function lisp-indent-defun-method
364 path state indent-point
365 sexp-column normal-indent
)
366 normal-indent tentative-calculated
)))
368 ;; convenient top-level hack.
369 ;; (also compatible with lisp-indent-function)
370 ;; The number specifies how many `distinguished'
371 ;; forms there are before the body starts
372 ;; Equivalent to (4 4 ... &body)
373 (setq calculated
(cond ((cdr path
)
375 ((<= (car path
) method
)
376 ;; `distinguished' form
377 (list (+ sexp-column
4)
378 containing-form-start
))
379 ((= (car path
) (1+ method
))
381 (+ sexp-column lisp-body-indent
))
387 (common-lisp-indent-call-method
388 function method path state indent-point
389 sexp-column normal-indent
)))))
390 (goto-char containing-sexp
)
391 (setq last-point containing-sexp
)
394 (progn (backward-up-list 1)
395 (setq depth
(1+ depth
)))
396 (error (setq depth lisp-indent-maximum-backtracking
))))))
397 (or calculated tentative-calculated
))))
400 (defun common-lisp-indent-call-method (function method path state indent-point
401 sexp-column normal-indent
)
402 (let ((lisp-indent-error-function function
))
405 path state indent-point
406 sexp-column normal-indent
)
407 (lisp-indent-259 method path state indent-point
408 sexp-column normal-indent
))))
410 ;; Dynamically bound in common-lisp-indent-call-method.
411 (defvar lisp-indent-error-function
)
413 (defun lisp-indent-report-bad-format (m)
414 (error "%s has a badly-formed %s property: %s"
415 ;; Love those free variable references!!
416 lisp-indent-error-function
'common-lisp-indent-function m
))
419 ;; Lambda-list indentation is now done in LISP-INDENT-LAMBDA-LIST.
420 ;; See also `lisp-lambda-list-keyword-alignment',
421 ;; `lisp-lambda-list-keyword-parameter-alignment' and
422 ;; `lisp-lambda-list-keyword-parameter-indentation' -- dvl
424 (defvar lisp-indent-lambda-list-keywords-regexp
426 optional\\|rest\\|key\\|allow-other-keys\\|aux\\|whole\\|body\\|environment\
428 "Regular expression matching lambda-list keywords.")
430 (defun lisp-indent-lambda-list
431 (indent-point sexp-column containing-form-start
)
433 (cond ((save-excursion
434 (goto-char indent-point
)
436 (skip-chars-forward " \t")
438 (looking-at lisp-indent-lambda-list-keywords-regexp
))
439 ;; We're facing a lambda-list keyword.
440 (if lisp-lambda-list-keyword-alignment
441 ;; Align to the first keyword if any, or to the beginning of
444 (goto-char containing-form-start
)
446 (if (re-search-forward
447 lisp-indent-lambda-list-keywords-regexp
450 (goto-char (match-beginning 0))
453 ;; Align to the beginning of the lambda-list.
456 ;; Otherwise, align to the first argument of the last lambda-list
457 ;; keyword, the keyword itself, or the beginning of the
460 (goto-char indent-point
)
464 (if (re-search-backward lisp-indent-lambda-list-keywords-regexp
465 containing-form-start t
)
468 (goto-char (match-beginning 0))
470 (indented-keyword-posn
472 lisp-lambda-list-keyword-parameter-indentation
)))
473 (goto-char (match-end 0))
474 (skip-chars-forward " \t")
476 indented-keyword-posn
477 (if lisp-lambda-list-keyword-parameter-alignment
479 indented-keyword-posn
)))
480 (1+ sexp-column
))))))))
482 ;; Blame the crufty control structure on dynamic scoping
484 (defun lisp-indent-259
485 (method path state indent-point sexp-column normal-indent
)
488 (containing-form-start (elt state
1))
490 ;; Isn't tail-recursion wonderful?
492 ;; This while loop is for destructuring.
493 ;; p is set to (cdr p) each iteration.
494 (if (not (consp method
)) (lisp-indent-report-bad-format method
))
499 ;; This while loop is for advancing along a method
500 ;; until the relevant (possibly &rest/&body) pattern
502 ;; n is set to (1- n) and method to (cdr method)
504 (setq tem
(car method
))
506 (or (eq tem
'nil
) ;default indentation
507 (eq tem
'&lambda
) ;lambda list
508 (and (eq tem
'&body
) (null (cdr method
)))
511 (null (cddr method
)))
512 (integerp tem
) ;explicit indentation specified
513 (and (consp tem
) ;destructuring
514 (eq (car tem
) '&whole
)
515 (or (symbolp (cadr tem
))
516 (integerp (cadr tem
))))
517 (and (symbolp tem
) ;a function to call to do the work.
519 (lisp-indent-report-bad-format method
))
521 (cond ((and tail
(not (consp tem
)))
522 ;; indent tail of &rest in same way as first elt of rest
523 (throw 'exit normal-indent
))
525 ;; &body means (&rest <lisp-body-indent>)
527 (if (and (= n
0) ;first body form
528 (null p
)) ;not in subforms
533 ;; this pattern holds for all remaining forms
536 method
(cdr method
)))
538 ;; try next element of pattern
542 ;; Too few elements in pattern.
543 (throw 'exit normal-indent
)))
545 (throw 'exit
(if (consp normal-indent
)
547 (list normal-indent containing-form-start
))))
551 (list (+ sexp-column
4) containing-form-start
))
553 ;; Indentation within a lambda-list. -- dvl
554 (list (lisp-indent-lambda-list
557 containing-form-start
)
558 containing-form-start
))
563 (if (null p
) ;not in subforms
564 (list (+ sexp-column tem
) containing-form-start
)
566 ((symbolp tem
) ;a function to call
568 (funcall tem path state indent-point
569 sexp-column normal-indent
)))
571 ;; must be a destructing frob
574 (setq method
(cddr tem
)
576 (setq tem
(cadr tem
))
582 containing-form-start
))
584 (list (+ sexp-column tem
)
585 containing-form-start
))
587 (funcall tem path state indent-point
588 sexp-column normal-indent
))))))))))))
590 (defun lisp-indent-tagbody (path state indent-point sexp-column normal-indent
)
591 (if (not (null (cdr path
)))
594 (goto-char indent-point
)
596 (skip-chars-forward " \t")
597 (list (cond ((looking-at "\\sw\\|\\s_")
599 (+ sexp-column lisp-tag-indentation
))
600 ((integerp lisp-tag-body-indentation
)
601 (+ sexp-column lisp-tag-body-indentation
))
602 ((eq lisp-tag-body-indentation
't
)
604 (progn (backward-sexp 1) (current-column))
605 (error (1+ sexp-column
))))
606 (t (+ sexp-column lisp-body-indent
)))
607 ; (cond ((integerp lisp-tag-body-indentation)
608 ; (+ sexp-column lisp-tag-body-indentation))
609 ; ((eq lisp-tag-body-indentation 't)
612 ; (+ sexp-column lisp-body-indent)))
616 (defun lisp-indent-do (path state indent-point sexp-column normal-indent
)
617 (if (>= (car path
) 3)
618 (let ((lisp-tag-body-indentation lisp-body-indent
))
619 (funcall (function lisp-indent-tagbody
)
620 path state indent-point sexp-column normal-indent
))
621 (funcall (function lisp-indent-259
)
623 ;; the following causes weird indentation
626 (&whole nil
&rest
1))
627 path state indent-point sexp-column normal-indent
)))
630 ;; LISP-INDENT-DEFMETHOD now supports the presence of more than one method
631 ;; qualifier and indents the method's lambda list properly. -- dvl
632 (defun lisp-indent-defmethod
633 (path state indent-point sexp-column normal-indent
)
636 (if (and (>= (car path
) 3)
641 (skip-chars-forward " \t\n")
642 (while (looking-at "\\sw\\|\\s_")
645 (skip-chars-forward " \t\n"))
647 (append '(4) (make-list nqual
4) '(&lambda
&body
))
648 (get 'defun
'common-lisp-indent-function
)))
649 path state indent-point sexp-column normal-indent
))
652 (defun lisp-indent-function-lambda-hack (path state indent-point
653 sexp-column normal-indent
)
654 ;; indent (function (lambda () <newline> <body-forms>)) kludgily.
655 (if (or (cdr path
) ; wtf?
657 ;; line up under previous body form
659 ;; line up under function rather than under lambda in order to
660 ;; conserve horizontal space. (Which is what #' is for.)
665 (if (looking-at "\\(lisp:+\\)?function\\(\\Sw\\|\\S_\\)")
666 (+ lisp-body-indent -
1 (current-column))
667 (+ sexp-column lisp-body-indent
)))
668 (error (+ sexp-column lisp-body-indent
)))))
673 (case (4 &rest
(&whole
2 &rest
1)))
680 (cond (&rest
(&whole
2 &rest
1)))
682 (defclass (6 4 (&whole
2 &rest
1) (&whole
2 &rest
1)))
683 (defconstant . defvar
)
684 (defcustom (4 2 2 2))
685 (defparameter . defvar
)
686 (defconst . defcustom
)
687 (define-condition . defclass
)
688 (define-modify-macro (4 &lambda
&body
))
689 (defsetf (4 &lambda
4 &body
))
690 (defun (4 &lambda
&body
))
691 (defgeneric (4 &lambda
&body
))
692 (define-setf-method . defun
)
693 (define-setf-expander . defun
)
697 (defmethod lisp-indent-defmethod)
699 (defstruct ((&whole
4 &rest
(&whole
2 &rest
1))
700 &rest
(&whole
2 &rest
1)))
702 ((&whole
6 &rest
1) 4 &body
))
705 (dolist ((&whole
4 2 1) &body
))
708 (flet ((&whole
4 &rest
(&whole
1 &lambda
&body
)) &body
))
711 (generic-flet . flet
)
712 (generic-labels . flet
)
713 (handler-case (4 &rest
(&whole
2 &lambda
&body
)))
714 (restart-case . handler-case
)
717 ;; single-else style (then and else equally indented)
719 (lambda (&lambda
&rest lisp-indent-function-lambda-hack
))
720 (let ((&whole
4 &rest
(&whole
1 1 2)) &body
))
722 (compiler-let . let
) ;barf
726 ;(loop lisp-indent-loop)
727 (:method
(&lambda
&body
)) ; in `defgeneric'
728 (multiple-value-bind ((&whole
6 &rest
1) 4 &body
))
729 (multiple-value-call (4 &body
))
730 (multiple-value-prog1 1)
731 (multiple-value-setq (4 2))
732 (multiple-value-setf . multiple-value-setq
)
733 (pprint-logical-block (4 2))
734 (print-unreadable-object ((&whole
4 1 &rest
1) &body
))
735 ;; Combines the worst features of BLOCK, LET and TAGBODY
736 (prog (&lambda
&rest lisp-indent-tagbody
))
743 (return-from (nil &body
))
744 (symbol-macrolet . let
)
745 (tagbody lisp-indent-tagbody
)
748 (unwind-protect (5 &body
))
750 (with-accessors . multiple-value-bind
)
751 (with-condition-restarts . multiple-value-bind
)
752 (with-output-to-string (4 2))
753 (with-slots . multiple-value-bind
)
754 (with-standard-io-syntax (2)))))
756 (put (car el
) 'common-lisp-indent-function
757 (if (symbolp (cdr el
))
758 (get (cdr el
) 'common-lisp-indent-function
)
773 ; (flet ((foo (bar baz zap)
791 ;(put 'while 'common-lisp-indent-function 1)
792 ;(put 'defwrapper'common-lisp-indent-function ...)
793 ;(put 'def 'common-lisp-indent-function ...)
794 ;(put 'defflavor 'common-lisp-indent-function ...)
795 ;(put 'defsubst 'common-lisp-indent-function ...)
797 ;(put 'with-restart 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
798 ;(put 'restart-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (* 1)))))
799 ;(put 'define-condition 'common-lisp-indent-function '((1 6) (2 6 ((&whole 1))) (3 4 ((&whole 1))) (4 &body)))
800 ;(put 'with-condition-handler 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
801 ;(put 'condition-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (1 3) (2 &body)))))
802 ;(put 'defclass 'common-lisp-indent-function '((&whole 2 &rest (&whole 2 &rest 1) &rest (&whole 2 &rest 1)))
803 ;(put 'defgeneric 'common-lisp-indent-function 'defun)
805 ;;; cl-indent.el ends here