1 ;;; cl-indent.el --- enhanced lisp-indent mode
3 ;; Copyright (C) 1987, 2000-2014 Free Software Foundation, Inc.
5 ;; Author: Richard Mlynarik <mly@eddie.mit.edu>
7 ;; Maintainer: emacs-devel@gnu.org
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
111 (defcustom lisp-lambda-list-keyword-parameter-indentation
2
112 "Indentation of lambda list keyword parameters.
113 See `lisp-lambda-list-keyword-parameter-alignment'
114 for more information."
119 (defcustom lisp-lambda-list-keyword-parameter-alignment nil
120 "Whether to vertically align lambda-list keyword parameters together.
121 If nil (the default), the parameters are aligned
122 with their corresponding keyword, plus the value of
123 `lisp-lambda-list-keyword-parameter-indentation', like this:
125 \(defun foo (arg1 arg2 &key key1 key2
129 If non-nil, alignment is done with the first parameter
130 \(or falls back to the previous case), as in:
132 \(defun foo (arg1 arg2 &key key1 key2
140 (defvar lisp-indent-defun-method
'(4 &lambda
&body
)
141 "Defun-like indentation method.
142 This applies when the value of the `common-lisp-indent-function' property
146 (defun extended-loop-p (loop-start)
147 "True if an extended loop form starts at LOOP-START."
150 (goto-char loop-start
)
158 (defun common-lisp-loop-part-indentation (indent-point state
)
159 "Compute the indentation of loop form constituents."
160 (let* ((loop-indentation (save-excursion
161 (goto-char (elt state
1))
163 (goto-char indent-point
)
166 (cond ((not (extended-loop-p (elt state
1)))
167 (+ loop-indentation lisp-simple-loop-indentation
))
168 ((looking-at "^\\s-*\\(:?\\sw+\\|;\\)")
169 (+ loop-indentation lisp-loop-keyword-indentation
))
171 (+ loop-indentation lisp-loop-forms-indentation
)))
172 ;; Tell the caller that the next line needs recomputation, even
173 ;; though it doesn't start a sexp.
177 ;; Cf (info "(elisp)Specification List")
179 (defun common-lisp-indent-function (indent-point state
)
180 "Function to indent the arguments of a Lisp function call.
181 This is suitable for use as the value of the variable
182 `lisp-indent-function'. INDENT-POINT is the point at which the
183 indentation function is called, and STATE is the
184 `parse-partial-sexp' state at that position. Browse the
185 `lisp-indent' customize group for options affecting the behavior
188 If the indentation point is in a call to a Lisp function, that
189 function's `common-lisp-indent-function' property specifies how
190 this function should indent it. Possible values for this
193 * defun, meaning indent according to `lisp-indent-defun-method';
194 i.e., like (4 &lambda &body), as explained below.
196 * any other symbol, meaning a function to call. The function should
197 take the arguments: PATH STATE INDENT-POINT SEXP-COLUMN NORMAL-INDENT.
198 PATH is a list of integers describing the position of point in terms of
199 list-structure with respect to the containing lists. For example, in
200 ((a b c (d foo) f) g), foo has a path of (0 3 1). In other words,
201 to reach foo take the 0th element of the outermost list, then
202 the 3rd element of the next list, and finally the 1st element.
203 STATE and INDENT-POINT are as in the arguments to
204 `common-lisp-indent-function'. SEXP-COLUMN is the column of
205 the open parenthesis of the innermost containing list.
206 NORMAL-INDENT is the column the indentation point was
207 originally in. This function should behave like `lisp-indent-259'.
209 * an integer N, meaning indent the first N arguments like
210 function arguments, and any further arguments like a body.
211 This is equivalent to (4 4 ... &body).
213 * a list. The list element in position M specifies how to indent the Mth
214 function argument. If there are fewer elements than function arguments,
215 the last list element applies to all remaining arguments. The accepted
218 * nil, meaning the default indentation.
220 * an integer, specifying an explicit indentation.
222 * &lambda. Indent the argument (which may be a list) by 4.
224 * &rest. When used, this must be the penultimate element. The
225 element after this one applies to all remaining arguments.
227 * &body. This is equivalent to &rest lisp-body-indent, i.e., indent
228 all remaining elements by `lisp-body-indent'.
230 * &whole. This must be followed by nil, an integer, or a
231 function symbol. This indentation is applied to the
232 associated argument, and as a base indent for all remaining
233 arguments. For example, an integer P means indent this
234 argument by P, and all remaining arguments by P, plus the
235 value specified by their associated list element.
237 * a symbol. A function to call, with the 6 arguments specified above.
239 * a list, with elements as described above. This applies when the
240 associated function argument is itself a list. Each element of the list
241 specifies how to indent the associated argument.
243 For example, the function `case' has an indent property
244 \(4 &rest (&whole 2 &rest 1)), meaning:
245 * indent the first argument by 4.
246 * arguments after the first should be lists, and there may be any number
247 of them. The first list element has an offset of 2, all the rest
248 have an offset of 2+1=3."
249 (if (save-excursion (goto-char (elt state
1))
250 (looking-at "([Ll][Oo][Oo][Pp]"))
251 (common-lisp-loop-part-indentation indent-point state
)
252 (common-lisp-indent-function-1 indent-point state
)))
255 (defun common-lisp-indent-function-1 (indent-point state
)
256 (let ((normal-indent (current-column)))
257 ;; Walk up list levels until we see something
258 ;; which does special things with subforms.
260 ;; Path describes the position of point in terms of
261 ;; list-structure with respect to containing lists.
262 ;; `foo' has a path of (0 3 1) in `((a b c (d foo) f) g)'.
264 ;; set non-nil when somebody works out the indentation to use
266 ;; If non-nil, this is an indentation to use
267 ;; if nothing else specifies it more firmly.
269 (last-point indent-point
)
270 ;; the position of the open-paren of the innermost containing list
271 (containing-form-start (elt state
1))
272 ;; the column of the above
274 ;; Move to start of innermost containing list
275 (goto-char containing-form-start
)
276 (setq sexp-column
(current-column))
278 ;; Look over successively less-deep containing forms
279 (while (and (not calculated
)
280 (< depth lisp-indent-maximum-backtracking
))
281 (let ((containing-sexp (point)))
283 (parse-partial-sexp (point) indent-point
1 t
)
284 ;; Move to the car of the relevant containing form
285 (let (tem function method tentative-defun
)
286 (if (not (looking-at "\\sw\\|\\s_"))
287 ;; This form doesn't seem to start with a symbol
288 (setq function nil method nil
)
291 (setq function
(downcase (buffer-substring-no-properties
294 (setq tem
(intern-soft function
)
295 method
(get tem
'common-lisp-indent-function
))
296 (cond ((and (null method
)
297 (string-match ":[^:]+" function
))
298 ;; The pleblisp package feature
299 (setq function
(substring function
300 (1+ (match-beginning 0)))
301 method
(get (intern-soft function
)
302 'common-lisp-indent-function
)))
304 ;; backwards compatibility
305 (setq method
(get tem
'lisp-indent-function
)))))
307 ;; How far into the containing form is the current form?
308 (if (< (point) indent-point
)
309 (while (condition-case ()
312 (if (>= (point) indent-point
)
314 (parse-partial-sexp (point)
319 (setq path
(cons n path
)))
321 ;; backwards compatibility.
322 (cond ((null function
))
324 (when (null (cdr path
))
325 ;; (package prefix was stripped off above)
326 (cond ((string-match "\\`def"
328 (setq tentative-defun
t))
332 (regexp-opt '("with" "without" "do"))
335 (setq method
'(&lambda
&body
))))))
336 ;; backwards compatibility. Bletch.
338 (setq method lisp-indent-defun-method
)))
340 (cond ((and (or (eq (char-after (1- containing-sexp
)) ?
\')
341 (and (not lisp-backquote-indentation
)
342 (eq (char-after (1- containing-sexp
)) ?\
`)))
343 (not (eq (char-after (- containing-sexp
2)) ?\
#)))
344 ;; No indentation for "'(...)" elements
345 (setq calculated
(1+ sexp-column
)))
346 ((or (eq (char-after (1- containing-sexp
)) ?\
,)
347 (and (eq (char-after (1- containing-sexp
)) ?\
@)
348 (eq (char-after (- containing-sexp
2)) ?\
,)))
349 ;; ",(...)" or ",@(...)"
350 (setq calculated normal-indent
))
351 ((eq (char-after (1- containing-sexp
)) ?\
#)
353 (setq calculated
(1+ sexp-column
)))
355 ;; If this looks like a call to a `def...' form,
356 ;; think about indenting it as one, but do it
357 ;; tentatively for cases like
360 ;; Set both normal-indent and tentative-calculated.
361 ;; The latter ensures this value gets used
362 ;; if there are no relevant containing constructs.
363 ;; The former ensures this value gets used
364 ;; if there is a relevant containing construct
365 ;; but we are nested within the structure levels
366 ;; that it specifies indentation for.
368 (setq tentative-calculated
369 (common-lisp-indent-call-method
370 function lisp-indent-defun-method
371 path state indent-point
372 sexp-column normal-indent
)
373 normal-indent tentative-calculated
)))
375 ;; convenient top-level hack.
376 ;; (also compatible with lisp-indent-function)
377 ;; The number specifies how many `distinguished'
378 ;; forms there are before the body starts
379 ;; Equivalent to (4 4 ... &body)
380 (setq calculated
(cond ((cdr path
)
382 ((<= (car path
) method
)
383 ;; `distinguished' form
384 (list (+ sexp-column
4)
385 containing-form-start
))
386 ((= (car path
) (1+ method
))
388 (+ sexp-column lisp-body-indent
))
394 (common-lisp-indent-call-method
395 function method path state indent-point
396 sexp-column normal-indent
)))))
397 (goto-char containing-sexp
)
398 (setq last-point containing-sexp
)
401 (progn (backward-up-list 1)
402 (setq depth
(1+ depth
)))
403 (error (setq depth lisp-indent-maximum-backtracking
))))))
404 (or calculated tentative-calculated
))))
407 (defun common-lisp-indent-call-method (function method path state indent-point
408 sexp-column normal-indent
)
409 (let ((lisp-indent-error-function function
))
412 path state indent-point
413 sexp-column normal-indent
)
414 (lisp-indent-259 method path state indent-point
415 sexp-column normal-indent
))))
417 ;; Dynamically bound in common-lisp-indent-call-method.
418 (defvar lisp-indent-error-function
)
420 (defun lisp-indent-report-bad-format (m)
421 (error "%s has a badly-formed %s property: %s"
422 ;; Love those free variable references!!
423 lisp-indent-error-function
'common-lisp-indent-function m
))
426 ;; Lambda-list indentation is now done in LISP-INDENT-LAMBDA-LIST.
427 ;; See also `lisp-lambda-list-keyword-alignment',
428 ;; `lisp-lambda-list-keyword-parameter-alignment' and
429 ;; `lisp-lambda-list-keyword-parameter-indentation' -- dvl
431 (defvar lisp-indent-lambda-list-keywords-regexp
433 optional\\|rest\\|key\\|allow-other-keys\\|aux\\|whole\\|body\\|environment\
435 "Regular expression matching lambda-list keywords.")
437 (defun lisp-indent-lambda-list
438 (indent-point sexp-column containing-form-start
)
440 (cond ((save-excursion
441 (goto-char indent-point
)
443 (skip-chars-forward " \t")
445 (looking-at lisp-indent-lambda-list-keywords-regexp
))
446 ;; We're facing a lambda-list keyword.
447 (if lisp-lambda-list-keyword-alignment
448 ;; Align to the first keyword if any, or to the beginning of
451 (goto-char containing-form-start
)
453 (if (re-search-forward
454 lisp-indent-lambda-list-keywords-regexp
457 (goto-char (match-beginning 0))
460 ;; Align to the beginning of the lambda-list.
463 ;; Otherwise, align to the first argument of the last lambda-list
464 ;; keyword, the keyword itself, or the beginning of the
467 (goto-char indent-point
)
471 (if (re-search-backward lisp-indent-lambda-list-keywords-regexp
472 containing-form-start t
)
475 (goto-char (match-beginning 0))
477 (indented-keyword-posn
479 lisp-lambda-list-keyword-parameter-indentation
)))
480 (goto-char (match-end 0))
481 (skip-chars-forward " \t")
483 indented-keyword-posn
484 (if lisp-lambda-list-keyword-parameter-alignment
486 indented-keyword-posn
)))
487 (1+ sexp-column
))))))))
489 ;; Blame the crufty control structure on dynamic scoping
491 (defun lisp-indent-259
492 (method path state indent-point sexp-column normal-indent
)
495 (containing-form-start (elt state
1))
497 ;; Isn't tail-recursion wonderful?
499 ;; This while loop is for destructuring.
500 ;; p is set to (cdr p) each iteration.
501 (if (not (consp method
)) (lisp-indent-report-bad-format method
))
506 ;; This while loop is for advancing along a method
507 ;; until the relevant (possibly &rest/&body) pattern
509 ;; n is set to (1- n) and method to (cdr method)
511 (setq tem
(car method
))
513 (or (eq tem
'nil
) ;default indentation
514 (eq tem
'&lambda
) ;lambda list
515 (and (eq tem
'&body
) (null (cdr method
)))
518 (null (cddr method
)))
519 (integerp tem
) ;explicit indentation specified
520 (and (consp tem
) ;destructuring
521 (eq (car tem
) '&whole
)
522 (or (symbolp (cadr tem
))
523 (integerp (cadr tem
))))
524 (and (symbolp tem
) ;a function to call to do the work.
526 (lisp-indent-report-bad-format method
))
528 (cond ((and tail
(not (consp tem
)))
529 ;; indent tail of &rest in same way as first elt of rest
530 (throw 'exit normal-indent
))
532 ;; &body means (&rest <lisp-body-indent>)
534 (if (and (= n
0) ;first body form
535 (null p
)) ;not in subforms
540 ;; this pattern holds for all remaining forms
543 method
(cdr method
)))
545 ;; try next element of pattern
549 ;; Too few elements in pattern.
550 (throw 'exit normal-indent
)))
552 (throw 'exit
(if (consp normal-indent
)
554 (list normal-indent containing-form-start
))))
558 (list (+ sexp-column
4) containing-form-start
))
560 ;; Indentation within a lambda-list. -- dvl
561 (list (lisp-indent-lambda-list
564 containing-form-start
)
565 containing-form-start
))
570 (if (null p
) ;not in subforms
571 (list (+ sexp-column tem
) containing-form-start
)
573 ((symbolp tem
) ;a function to call
575 (funcall tem path state indent-point
576 sexp-column normal-indent
)))
578 ;; must be a destructing frob
581 (setq method
(cddr tem
)
583 (setq tem
(cadr tem
))
589 containing-form-start
))
591 (list (+ sexp-column tem
)
592 containing-form-start
))
594 (funcall tem path state indent-point
595 sexp-column normal-indent
))))))))))))
597 (defun lisp-indent-tagbody (path state indent-point sexp-column normal-indent
)
598 (if (not (null (cdr path
)))
601 (goto-char indent-point
)
603 (skip-chars-forward " \t")
604 (list (cond ((looking-at "\\sw\\|\\s_")
606 (+ sexp-column lisp-tag-indentation
))
607 ((integerp lisp-tag-body-indentation
)
608 (+ sexp-column lisp-tag-body-indentation
))
609 ((eq lisp-tag-body-indentation
't
)
611 (progn (backward-sexp 1) (current-column))
612 (error (1+ sexp-column
))))
613 (t (+ sexp-column lisp-body-indent
)))
614 ; (cond ((integerp lisp-tag-body-indentation)
615 ; (+ sexp-column lisp-tag-body-indentation))
616 ; ((eq lisp-tag-body-indentation 't)
619 ; (+ sexp-column lisp-body-indent)))
623 (defun lisp-indent-do (path state indent-point sexp-column normal-indent
)
624 (if (>= (car path
) 3)
625 (let ((lisp-tag-body-indentation lisp-body-indent
))
626 (funcall (function lisp-indent-tagbody
)
627 path state indent-point sexp-column normal-indent
))
628 (funcall (function lisp-indent-259
)
630 ;; the following causes weird indentation
633 (&whole nil
&rest
1))
634 path state indent-point sexp-column normal-indent
)))
637 ;; LISP-INDENT-DEFMETHOD now supports the presence of more than one method
638 ;; qualifier and indents the method's lambda list properly. -- dvl
639 (defun lisp-indent-defmethod
640 (path state indent-point sexp-column normal-indent
)
643 (if (and (>= (car path
) 3)
648 (skip-chars-forward " \t\n")
649 (while (looking-at "\\sw\\|\\s_")
652 (skip-chars-forward " \t\n"))
654 (append '(4) (make-list nqual
4) '(&lambda
&body
))
655 (get 'defun
'common-lisp-indent-function
)))
656 path state indent-point sexp-column normal-indent
))
659 (defun lisp-indent-function-lambda-hack (path state indent-point
660 sexp-column normal-indent
)
661 ;; indent (function (lambda () <newline> <body-forms>)) kludgily.
662 (if (or (cdr path
) ; wtf?
664 ;; line up under previous body form
666 ;; line up under function rather than under lambda in order to
667 ;; conserve horizontal space. (Which is what #' is for.)
672 (if (looking-at "\\(lisp:+\\)?function\\(\\Sw\\|\\S_\\)")
673 (+ lisp-body-indent -
1 (current-column))
674 (+ sexp-column lisp-body-indent
)))
675 (error (+ sexp-column lisp-body-indent
)))))
680 (case (4 &rest
(&whole
2 &rest
1)))
687 (cond (&rest
(&whole
2 &rest
1)))
689 (defclass (6 4 (&whole
2 &rest
1) (&whole
2 &rest
1)))
690 (defconstant . defvar
)
691 (defcustom (4 2 2 2))
692 (defparameter . defvar
)
693 (defconst . defcustom
)
694 (define-condition . defclass
)
695 (define-modify-macro (4 &lambda
&body
))
696 (defsetf (4 &lambda
4 &body
))
697 (defun (4 &lambda
&body
))
698 (defgeneric (4 &lambda
&body
))
699 (define-setf-method . defun
)
700 (define-setf-expander . defun
)
704 (defmethod lisp-indent-defmethod)
706 (defstruct ((&whole
4 &rest
(&whole
2 &rest
1))
707 &rest
(&whole
2 &rest
1)))
709 ((&whole
6 &rest
1) 4 &body
))
712 (dolist ((&whole
4 2 1) &body
))
715 (flet ((&whole
4 &rest
(&whole
1 &lambda
&body
)) &body
))
718 (generic-flet . flet
)
719 (generic-labels . flet
)
720 (handler-case (4 &rest
(&whole
2 &lambda
&body
)))
721 (restart-case . handler-case
)
724 ;; single-else style (then and else equally indented)
726 (lambda (&lambda
&rest lisp-indent-function-lambda-hack
))
727 (let ((&whole
4 &rest
(&whole
1 1 2)) &body
))
729 (compiler-let . let
) ;barf
733 ;(loop lisp-indent-loop)
734 (:method
(&lambda
&body
)) ; in `defgeneric'
735 (multiple-value-bind ((&whole
6 &rest
1) 4 &body
))
736 (multiple-value-call (4 &body
))
737 (multiple-value-prog1 1)
738 (multiple-value-setq (4 2))
739 (multiple-value-setf . multiple-value-setq
)
740 (pprint-logical-block (4 2))
741 (print-unreadable-object ((&whole
4 1 &rest
1) &body
))
742 ;; Combines the worst features of BLOCK, LET and TAGBODY
743 (prog (&lambda
&rest lisp-indent-tagbody
))
750 (return-from (nil &body
))
751 (symbol-macrolet . let
)
752 (tagbody lisp-indent-tagbody
)
755 (unwind-protect (5 &body
))
757 (with-accessors . multiple-value-bind
)
758 (with-condition-restarts . multiple-value-bind
)
759 (with-compilation-unit (&lambda
&body
))
760 (with-output-to-string (4 2))
761 (with-slots . multiple-value-bind
)
762 (with-standard-io-syntax (2)))))
764 (put (car el
) 'common-lisp-indent-function
765 (if (symbolp (cdr el
))
766 (get (cdr el
) 'common-lisp-indent-function
)
781 ; (flet ((foo (bar baz zap)
799 ;(put 'while 'common-lisp-indent-function 1)
800 ;(put 'defwrapper'common-lisp-indent-function ...)
801 ;(put 'def 'common-lisp-indent-function ...)
802 ;(put 'defflavor 'common-lisp-indent-function ...)
803 ;(put 'defsubst 'common-lisp-indent-function ...)
805 ;(put 'with-restart 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
806 ;(put 'restart-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (* 1)))))
807 ;(put 'define-condition 'common-lisp-indent-function '((1 6) (2 6 ((&whole 1))) (3 4 ((&whole 1))) (4 &body)))
808 ;(put 'with-condition-handler 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
809 ;(put 'condition-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (1 3) (2 &body)))))
810 ;(put 'defclass 'common-lisp-indent-function '((&whole 2 &rest (&whole 2 &rest 1) &rest (&whole 2 &rest 1)))
811 ;(put 'defgeneric 'common-lisp-indent-function 'defun)
815 ;;; cl-indent.el ends here