comparison lisp/emacs-lisp/cl-indent.el @ 103513:93c102cc8dd2

Remove leading "*" from defcustom docs. Refill.
author Glenn Morris <rgm@gnu.org>
date Mon, 22 Jun 2009 06:27:00 +0000
parents 4470991d3249
children 1d1d5d9bd884
comparison
equal deleted inserted replaced
103512:ce2fc4a55d15 103513:93c102cc8dd2
51 "Indentation in Lisp." 51 "Indentation in Lisp."
52 :group 'lisp) 52 :group 'lisp)
53 53
54 54
55 (defcustom lisp-indent-maximum-backtracking 3 55 (defcustom lisp-indent-maximum-backtracking 3
56 "*Maximum depth to backtrack out from a sublist for structured indentation. 56 "Maximum depth to backtrack out from a sublist for structured indentation.
57 If this variable is 0, no backtracking will occur and forms such as `flet' 57 If this variable is 0, no backtracking will occur and forms such as `flet'
58 may not be correctly indented." 58 may not be correctly indented."
59 :type 'integer 59 :type 'integer
60 :group 'lisp-indent) 60 :group 'lisp-indent)
61 61
62 (defcustom lisp-tag-indentation 1 62 (defcustom lisp-tag-indentation 1
63 "*Indentation of tags relative to containing list. 63 "Indentation of tags relative to containing list.
64 This variable is used by the function `lisp-indent-tagbody'." 64 This variable is used by the function `lisp-indent-tagbody'."
65 :type 'integer 65 :type 'integer
66 :group 'lisp-indent) 66 :group 'lisp-indent)
67 67
68 (defcustom lisp-tag-body-indentation 3 68 (defcustom lisp-tag-body-indentation 3
69 "*Indentation of non-tagged lines relative to containing list. 69 "Indentation of non-tagged lines relative to containing list.
70 This variable is used by the function `lisp-indent-tagbody' to indent normal 70 This variable is used by the function `lisp-indent-tagbody' to indent normal
71 lines (lines without tags). 71 lines (lines without tags).
72 The indentation is relative to the indentation of the parenthesis enclosing 72 The indentation is relative to the indentation of the parenthesis enclosing
73 the special form. If the value is t, the body of tags will be indented 73 the special form. If the value is t, the body of tags will be indented
74 as a block at the same indentation as the first s-expression following 74 as a block at the same indentation as the first s-expression following
76 by `lisp-body-indent'." 76 by `lisp-body-indent'."
77 :type 'integer 77 :type 'integer
78 :group 'lisp-indent) 78 :group 'lisp-indent)
79 79
80 (defcustom lisp-backquote-indentation t 80 (defcustom lisp-backquote-indentation t
81 "*Whether or not to indent backquoted lists as code. 81 "Whether or not to indent backquoted lists as code.
82 If nil, indent backquoted lists as data, i.e., like quoted lists." 82 If nil, indent backquoted lists as data, i.e., like quoted lists."
83 :type 'boolean 83 :type 'boolean
84 :group 'lisp-indent) 84 :group 'lisp-indent)
85 85
86 86
87 (defcustom lisp-loop-keyword-indentation 3 87 (defcustom lisp-loop-keyword-indentation 3
88 "*Indentation of loop keywords in extended loop forms." 88 "Indentation of loop keywords in extended loop forms."
89 :type 'integer 89 :type 'integer
90 :group 'lisp-indent) 90 :group 'lisp-indent)
91 91
92 92
93 (defcustom lisp-loop-forms-indentation 5 93 (defcustom lisp-loop-forms-indentation 5
94 "*Indentation of forms in extended loop forms." 94 "Indentation of forms in extended loop forms."
95 :type 'integer 95 :type 'integer
96 :group 'lisp-indent) 96 :group 'lisp-indent)
97 97
98 98
99 (defcustom lisp-simple-loop-indentation 3 99 (defcustom lisp-simple-loop-indentation 3
100 "*Indentation of forms in simple loop forms." 100 "Indentation of forms in simple loop forms."
101 :type 'integer 101 :type 'integer
102 :group 'lisp-indent) 102 :group 'lisp-indent)
103 103
104 104
105 (defvar lisp-indent-error-function)
106 (defvar lisp-indent-defun-method '(4 &lambda &body) 105 (defvar lisp-indent-defun-method '(4 &lambda &body)
107 "Indentation for function with `common-lisp-indent-function' property `defun'.") 106 "Indentation for function with `common-lisp-indent-function' property `defun'.")
108 107
109 108
110 (defun extended-loop-p (loop-start) 109 (defun extended-loop-p (loop-start)
371 (funcall method 370 (funcall method
372 path state indent-point 371 path state indent-point
373 sexp-column normal-indent) 372 sexp-column normal-indent)
374 (lisp-indent-259 method path state indent-point 373 (lisp-indent-259 method path state indent-point
375 sexp-column normal-indent)))) 374 sexp-column normal-indent))))
375
376 ;; Dynamically bound in common-lisp-indent-call-method.
377 (defvar lisp-indent-error-function)
376 378
377 (defun lisp-indent-report-bad-format (m) 379 (defun lisp-indent-report-bad-format (m)
378 (error "%s has a badly-formed %s property: %s" 380 (error "%s has a badly-formed %s property: %s"
379 ;; Love those free variable references!! 381 ;; Love those free variable references!!
380 lisp-indent-error-function 'common-lisp-indent-function m)) 382 lisp-indent-error-function 'common-lisp-indent-function m))
556 558
557 559
558 560
559 (let ((l '((block 1) 561 (let ((l '((block 1)
560 (case (4 &rest (&whole 2 &rest 1))) 562 (case (4 &rest (&whole 2 &rest 1)))
561 (ccase . case) (ecase . case) 563 (ccase . case)
562 (typecase . case) (etypecase . case) (ctypecase . case) 564 (ecase . case)
565 (typecase . case)
566 (etypecase . case)
567 (ctypecase . case)
563 (catch 1) 568 (catch 1)
564 (cond (&rest (&whole 2 &rest 1))) 569 (cond (&rest (&whole 2 &rest 1)))
565 (defvar (4 2 2)) 570 (defvar (4 2 2))
566 (defclass (6 4 (&whole 2 &rest 1) (&whole 2 &rest 1))) 571 (defclass (6 4 (&whole 2 &rest 1) (&whole 2 &rest 1)))
567 (defconstant . defvar) 572 (defconstant . defvar)
572 (define-modify-macro (4 &lambda &body)) 577 (define-modify-macro (4 &lambda &body))
573 (defsetf (4 &lambda 4 &body)) 578 (defsetf (4 &lambda 4 &body))
574 (defun (4 &lambda &body)) 579 (defun (4 &lambda &body))
575 (define-setf-method . defun) 580 (define-setf-method . defun)
576 (define-setf-expander . defun) 581 (define-setf-expander . defun)
577 (defmacro . defun) (defsubst . defun) (deftype . defun) 582 (defmacro . defun)
583 (defsubst . defun)
584 (deftype . defun)
578 (defmethod lisp-indent-defmethod) 585 (defmethod lisp-indent-defmethod)
579 (defpackage (4 2)) 586 (defpackage (4 2))
580 (defstruct ((&whole 4 &rest (&whole 2 &rest 1)) 587 (defstruct ((&whole 4 &rest (&whole 2 &rest 1))
581 &rest (&whole 2 &rest 1))) 588 &rest (&whole 2 &rest 1)))
582 (destructuring-bind 589 (destructuring-bind
587 (dotimes . dolist) 594 (dotimes . dolist)
588 (eval-when 1) 595 (eval-when 1)
589 (flet ((&whole 4 &rest (&whole 1 &lambda &body)) &body)) 596 (flet ((&whole 4 &rest (&whole 1 &lambda &body)) &body))
590 (labels . flet) 597 (labels . flet)
591 (macrolet . flet) 598 (macrolet . flet)
592 (generic-flet . flet) (generic-labels . flet) 599 (generic-flet . flet)
600 (generic-labels . flet)
593 (handler-case (4 &rest (&whole 2 &lambda &body))) 601 (handler-case (4 &rest (&whole 2 &lambda &body)))
594 (restart-case . handler-case) 602 (restart-case . handler-case)
595 ;; `else-body' style 603 ;; `else-body' style
596 (if (nil nil &body)) 604 (if (nil nil &body))
597 ;; single-else style (then and else equally indented) 605 ;; single-else style (then and else equally indented)
598 (if (&rest nil)) 606 (if (&rest nil))
599 (lambda (&lambda &rest lisp-indent-function-lambda-hack)) 607 (lambda (&lambda &rest lisp-indent-function-lambda-hack))
600 (let ((&whole 4 &rest (&whole 1 1 2)) &body)) 608 (let ((&whole 4 &rest (&whole 1 1 2)) &body))
601 (let* . let) 609 (let* . let)
602 (compiler-let . let) ;barf 610 (compiler-let . let) ;barf
603 (handler-bind . let) (restart-bind . let) 611 (handler-bind . let)
612 (restart-bind . let)
604 (locally 1) 613 (locally 1)
605 ;(loop lisp-indent-loop) 614 ;(loop lisp-indent-loop)
606 (:method (&lambda &body)) ; in `defgeneric' 615 (:method (&lambda &body)) ; in `defgeneric'
607 (multiple-value-bind ((&whole 6 &rest 1) 4 &body)) 616 (multiple-value-bind ((&whole 6 &rest 1) 4 &body))
608 (multiple-value-call (4 &body)) 617 (multiple-value-call (4 &body))