Source

prog-modes / cl-indent.el

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
;;; cl-indent.el --- enhanced lisp-indent mode

;; Copyright (C) 1987 Free Software Foundation, Inc.

;; Author: Richard Mlynarik <mly@eddie.mit.edu>
;; Created: July 1987
;; Maintainer: FSF
;; Keywords: lisp, tools

;; This file is part of XEmacs.

;; XEmacs is free software; you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; XEmacs is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with XEmacs; see the file COPYING.  If not, write to the Free
;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
;; 02111-1307, USA.

;;; Synched up with: FSF 19.34

;;; Commentary:

;; This package supplies a single entry point, common-lisp-indent-function,
;; which performs indentation in the preferred style for Common Lisp code.
;; To enable it:
;;
;; (setq lisp-indent-function 'common-lisp-indent-function)

;;>> TODO
;; :foo
;;   bar
;; :baz
;;   zap
;; &key (like &body)??

;; &rest 1 in lambda-lists doesn't work
;;  -- really want (foo bar
;;                  baz)
;;     not (foo bar
;;              baz)
;;  Need something better than &rest for such cases

;;; Code:

(defgroup lisp-indent nil
  "Enhanced lisp-indent mode."
  :group 'lisp)


(defcustom lisp-indent-maximum-backtracking 3
  "*Maximum depth to backtrack out from a sublist for structured indentation.
If this variable is  0, no backtracking will occur and forms such as flet
may not be correctly indented."
  :type 'integer
  :group 'lisp-indent)

(defcustom lisp-tag-indentation 1
  "*Indentation of tags relative to containing list.
This variable is used by the function `lisp-indent-tagbody'."
  :type 'integer
  :group 'lisp-indent)

(defcustom lisp-tag-body-indentation 3
  "*Indentation of non-tagged lines relative to containing list.
This variable is used by the function `lisp-indent-tagbody' to indent normal
lines (lines without tags).
The indentation is relative to the indentation of the parenthesis enclosing
the special form.  If the value is t, the body of tags will be indented
as a block at the same indentation as the first s-expression following
the tag.  In this case, any forms before the first tag are indented
by `lisp-body-indent'."
  :type 'integer
  :group 'lisp-indent)


;;;###autoload
(defun common-lisp-indent-function (indent-point state)
  (let ((normal-indent (current-column)))
    ;; Walk up list levels until we see something
    ;;  which does special things with subforms.
    (let ((depth 0)
	  ;; Path describes the position of point in terms of
	  ;;  list-structure with respect to containing lists.
	  ;; `foo' has a path of (0 4 1) in `((a b c (d foo) f) g)'
	  (path ())
	  ;; set non-nil when somebody works out the indentation to use
	  calculated
	  (last-point indent-point)
	  ;; the position of the open-paren of the innermost containing list
	  (containing-form-start (elt state 1))
	  ;; the column of the above
	  sexp-column)
      ;; Move to start of innermost containing list
      (goto-char containing-form-start)
      (setq sexp-column (current-column))
      ;; Look over successively less-deep containing forms
      (while (and (not calculated)
		  (< depth lisp-indent-maximum-backtracking))
	(let ((containing-sexp (point)))
	  (forward-char 1)
	  (parse-partial-sexp (point) indent-point 1 t)
	  ;; Move to the car of the relevant containing form
	  (let (tem function method)
	    (if (not (looking-at "\\sw\\|\\s_"))
		;; This form doesn't seem to start with a symbol
		(setq function nil method nil)
	      (setq tem (point))
	      (forward-sexp 1)
	      (setq function (downcase (buffer-substring tem (point))))
	      (goto-char tem)
	      (setq tem (intern-soft function)
		    method (get tem 'common-lisp-indent-function))
	      (cond ((and (null method)
			  (string-match ":[^:]+" function))
		     ;; The pleblisp package feature
		     (setq function (substring function
					       (1+ (match-beginning 0)))
			   method (get (intern-soft function)
				       'common-lisp-indent-function)))
		    ((and (null method))
		     ;; backwards compatibility
		     (setq method (get tem 'lisp-indent-function)))))
	    (let ((n 0))
	      ;; How far into the containing form is the current form?
	      (if (< (point) indent-point)
		  (while (condition-case ()
			     (progn
			       (forward-sexp 1)
			       (if (>= (point) indent-point)
				   nil
				 (parse-partial-sexp (point)
						     indent-point 1 t)
				 (setq n (1+ n))
				 t))
			   (error nil))))
	      (setq path (cons n path)))

	    ;; backwards compatibility.
	    (cond ((null function))
		  ((null method)
		   (if (null (cdr path))
		       ;; (package prefix was stripped off above)
		       (setq method (cond ((string-match "\\`def"
							 function)
					   '(4 (&whole 4 &rest 1) &body))
					  ((string-match "\\`\\(with\\|do\\)-"
							 function)
					   '(4 &body))))))
		  ;; backwards compatibility.  Bletch.
		  ((eq method 'defun)
		   (setq method '(4 (&whole 4 &rest 1) &body))))

	    (cond ((and (memq (char-after (1- containing-sexp)) '(?\' ?\`))
			(not (eql (char-after (- containing-sexp 2)) ?\#)))
		   ;; No indentation for "'(...)" elements
		   (setq calculated (1+ sexp-column)))
		  ((or (eql (char-after (1- containing-sexp)) ?\,)
		       (and (eql (char-after (1- containing-sexp)) ?\@)
			    (eql (char-after (- containing-sexp 2)) ?\,)))
		   ;; ",(...)" or ",@(...)"
		   (setq calculated normal-indent))
		  ((eql (char-after (1- containing-sexp)) ?\#)
		   ;; "#(...)"
		   (setq calculated (1+ sexp-column)))
		  ((null method))
		  ((integerp method)
		   ;; convenient top-level hack.
		   ;;  (also compatible with lisp-indent-function)
		   ;; The number specifies how many `distinguished'
		   ;;  forms there are before the body starts
		   ;; Equivalent to (4 4 ... &body)
		   (setq calculated (cond ((cdr path)
					   normal-indent)
					  ((<= (car path) method)
					   ;; `distinguished' form
					   (list (+ sexp-column 4)
						 containing-form-start))
					  ((= (car path) (1+ method))
					   ;; first body form.
					   (+ sexp-column lisp-body-indent))
					  (t
					   ;; other body form
					   normal-indent))))
		  ((symbolp method)
		   (setq calculated (funcall method
					     path state indent-point
					     sexp-column normal-indent)))
		  (t
		   (setq calculated (lisp-indent-259
				      method path state indent-point
				      sexp-column normal-indent)))))
	  (goto-char containing-sexp)
	  (setq last-point containing-sexp)
	  (if (not calculated)
	      (condition-case ()
		   (progn (backward-up-list 1)
			  (setq depth (1+ depth)))
		(error (setq depth lisp-indent-maximum-backtracking))))))
      calculated)))


(defun lisp-indent-report-bad-format (m)
  (error "%s has a badly-formed %s property: %s"
	 ;; Love those free variable references!!
	 function 'common-lisp-indent-function m))

;; Blame the crufty control structure on dynamic scoping
;;  -- not on me!
(defun lisp-indent-259 (method path state indent-point
			sexp-column normal-indent)
  (catch 'exit
    (let ((p path)
	  (containing-form-start (elt state 1))
	  n tem tail)
      ;; Isn't tail-recursion wonderful?
      (while p
	;; This while loop is for destructuring.
	;; p is set to (cdr p) each iteration.
	(if (not (consp method)) (lisp-indent-report-bad-format method))
	(setq n (1- (car p))
	      p (cdr p)
	      tail nil)
	(while n
	  ;; This while loop is for advancing along a method
	  ;; until the relevant (possibly &rest/&body) pattern
	  ;; is reached.
	  ;; n is set to (1- n) and method to (cdr method)
	  ;; each iteration.
	  (setq tem (car method))

	  (or (eq tem 'nil)             ;default indentation
;             (eq tem '&lambda)         ;abbrev for (&whole 4 (&rest 1))
	      (and (eq tem '&body) (null (cdr method)))
	      (and (eq tem '&rest)
		   (consp (cdr method)) (null (cdr (cdr method))))
	      (integerp tem)            ;explicit indentation specified
	      (and (consp tem)          ;destructuring
		   (eq (car tem) '&whole)
		   (or (symbolp (car (cdr tem)))
		       (integerp (car (cdr tem)))))
	      (and (symbolp tem)        ;a function to call to do the work.
		   (null (cdr method)))
	      (lisp-indent-report-bad-format method))

	  (cond ((and tail (not (consp tem)))
		 ;; indent tail of &rest in same way as first elt of rest
		 (throw 'exit normal-indent))
		((eq tem '&body)
		 ;; &body means (&rest <lisp-body-indent>)
		 (throw 'exit
		   (if (and (= n 0)     ;first body form
			    (null p))   ;not in subforms
		       (+ sexp-column
			  lisp-body-indent)
		       normal-indent)))
		((eq tem '&rest)
		 ;; this pattern holds for all remaining forms
		 (setq tail (> n 0)
		       n 0
		       method (cdr method)))
		((> n 0)
		 ;; try next element of pattern
		 (setq n (1- n)
		       method (cdr method))
		 (if (< n 0)
		     ;; Too few elements in pattern.
		     (throw 'exit normal-indent)))
		((eq tem 'nil)
		 (throw 'exit (list normal-indent containing-form-start)))
;               ((eq tem '&lambda)
;                ;; abbrev for (&whole 4 &rest 1)
;                (throw 'exit
;                  (cond ((null p)
;                         (list (+ sexp-column 4) containing-form-start))
;                        ((null (cdr p))
;                         (+ sexp-column 1))
;                        (t normal-indent))))
		((integerp tem)
		 (throw 'exit
		   (if (null p)         ;not in subforms
		       (list (+ sexp-column tem) containing-form-start)
		       normal-indent)))
		((symbolp tem)          ;a function to call
		 (throw 'exit
		   (funcall tem path state indent-point
			    sexp-column normal-indent)))
		(t
		 ;; must be a destructing frob
		 (if (not (null p))
		     ;; descend
		     (setq method (cdr (cdr tem))
			   n nil)
		   (setq tem (car (cdr tem)))
		   (throw 'exit
		     (cond (tail
			    normal-indent)
			   ((eq tem 'nil)
			    (list normal-indent
				  containing-form-start))
			   ((integerp tem)
			    (list (+ sexp-column tem)
				  containing-form-start))
			   (t
			    (funcall tem path state indent-point
				     sexp-column normal-indent))))))))))))

(defun lisp-indent-tagbody (path state indent-point sexp-column normal-indent)
  (if (not (null (cdr path)))
      normal-indent
    (save-excursion
      (goto-char indent-point)
      (beginning-of-line)
      (skip-chars-forward " \t")
      (list (cond ((looking-at "\\sw\\|\\s_")
		   ;; a tagbody tag
		   (+ sexp-column lisp-tag-indentation))
		  ((integerp lisp-tag-body-indentation)
		   (+ sexp-column lisp-tag-body-indentation))
		  ((eq lisp-tag-body-indentation 't)
		   (condition-case ()
		       (progn (backward-sexp 1) (current-column))
		     (error (1+ sexp-column))))
		  (t (+ sexp-column lisp-body-indent)))
;            (cond ((integerp lisp-tag-body-indentation)
;                   (+ sexp-column lisp-tag-body-indentation))
;                  ((eq lisp-tag-body-indentation 't)
;                   normal-indent)
;                  (t
;                   (+ sexp-column lisp-body-indent)))
	    (elt state 1)
	    ))))

(defun lisp-indent-do (path state indent-point sexp-column normal-indent)
  (if (>= (car path) 3)
      (let ((lisp-tag-body-indentation lisp-body-indent))
	(funcall (function lisp-indent-tagbody)
		 path state indent-point sexp-column normal-indent))
    (funcall (function lisp-indent-259)
	     '((&whole nil &rest
		;; the following causes weird indentation
		;;(&whole 1 1 2 nil)
		)
	       (&whole nil &rest 1))
	     path state indent-point sexp-column normal-indent)))

(defun lisp-indent-function-lambda-hack (path state indent-point
					 sexp-column normal-indent)
  ;; indent (function (lambda () <newline> <body-forms>)) kludgily.
  (if (or (cdr path) ; wtf?
	  (> (car path) 3))
      ;; line up under previous body form
      normal-indent
    ;; line up under function rather than under lambda in order to
    ;;  conserve horizontal space.  (Which is what #' is for.)
    (condition-case ()
	(save-excursion
	  (backward-up-list 2)
	  (forward-char 1)
	  (if (looking-at "\\(lisp:+\\)?function\\(\\Sw\\|\\S_\\)")
	      (+ lisp-body-indent -1 (current-column))
	      (+ sexp-column lisp-body-indent)))
       (error (+ sexp-column lisp-body-indent)))))

;; XEmacs change
(defun lisp-indent-defmethod (path state indent-point
			      sexp-column normal-indent)
  ;; Look for a method combination specifier...
  (let* ((combined (if (and (>= (car path) 3)
			    (null (cdr path)))
		       (save-excursion
			 (goto-char (car (cdr state)))
			 (forward-char)
			 (forward-sexp)
			 (forward-sexp)
			 (forward-sexp)
			 (backward-sexp)
			 ;; don't look only for a colon: we would catch
			 ;; before, after and around methods, but we would
			 ;; miss method combination types -- dvl
			 (if (not (looking-at "("))
			     t
			   nil))
		     nil))
	 (method (if combined
		     '(4 4 (&whole 4 &rest 1) &body)
		   '(4 (&whole 4 &rest 1) &body))))
    (funcall (function lisp-indent-259)
	     method
	     path state indent-point sexp-column normal-indent)))


(let ((l '((block 1)
	   (catch 1)
	   (case        (4 &rest (&whole 2 &rest 1)))
	   (ccase . case) (ecase . case)
	   (typecase . case) (etypecase . case) (ctypecase . case)
	   (catch 1)
	   (cond        (&rest (&whole 2 &rest 1)))
	   (block 1)
	   (defvar      (4 2 2))
	   (defconstant . defvar) (defparameter . defvar)
	   (define-modify-macro
			(4 &body))
	   (define-setf-method
			(4 (&whole 4 &rest 1) &body))
	   (defsetf     (4 (&whole 4 &rest 1) 4 &body))
	   (defun       (4 (&whole 4 &rest 1) &body))
	   (defmacro . defun) (deftype . defun)
	   ;; XEmacs change
	   (defmethod lisp-indent-defmethod)
	   (defstruct   ((&whole 4 &rest (&whole 2 &rest 1))
			 &rest (&whole 2 &rest 1)))
	   (destructuring-bind
			((&whole 6 &rest 1) 4 &body))
	   (do          lisp-indent-do)
	   (do* . do)
	   (dolist      ((&whole 4 2 1) &body))
	   (dotimes . dolist)
	   (eval-when	1)
	   (flet        ((&whole 4 &rest (&whole 1 (&whole 4 &rest 1) &body))
			 &body))
	   (labels . flet)
	   (macrolet . flet)
	   ;; `else-body' style
	   (if          (nil nil &body))
	   ;; single-else style (then and else equally indented)
	   (if          (&rest nil))
	   ;(lambda     ((&whole 4 &rest 1) &body))
	   (lambda      ((&whole 4 &rest 1)
			 &rest lisp-indent-function-lambda-hack))
	   (let         ((&whole 4 &rest (&whole 1 1 2)) &body))
	   (let* . let)
	   (compiler-let . let) ;barf
	   (locally	1)
	   ;(loop ...)
	   (multiple-value-bind
			((&whole 6 &rest 1) 4 &body))
	   (multiple-value-call
			(4 &body))
	   (multiple-value-list 1)
	   (multiple-value-prog1 1)
	   (multiple-value-setq
			(4 2))
	   ;; Combines the worst features of BLOCK, LET and TAGBODY
	   (prog        ((&whole 4 &rest 1) &rest lisp-indent-tagbody))
	   (prog* . prog)
	   (prog1 1)
	   (prog2 2)
	   (progn 0)
	   (progv       (4 4 &body))
	   (return 0)
	   (return-from (nil &body))
	   (tagbody     lisp-indent-tagbody)
	   (throw 1)
	   (unless 1)
	   (unwind-protect
			(5 &body))
	   (when 1))))
  (while l
    (put (car (car l)) 'common-lisp-indent-function
	 (if (symbolp (cdr (car l)))
	     (get (cdr (car l)) 'common-lisp-indent-function)
	     (car (cdr (car l)))))
    (setq l (cdr l))))


;(defun foo (x)
;  (tagbody
;   foo
;     (bar)
;   baz
;     (when (losing)
;       (with-big-loser
;           (yow)
;         ((lambda ()
;            foo)
;          big)))
;     (flet ((foo (bar baz zap)
;              (zip))
;            (zot ()
;              quux))
;       (do ()
;           ((lose)
;            (foo 1))
;         (quux)
;        foo
;         (lose))
;       (cond ((x)
;              (win 1 2
;                   (foo)))
;             (t
;              (lose
;                3))))))


;(put 'while    'common-lisp-indent-function 1)
;(put 'defwrapper'common-lisp-indent-function ...)
;(put 'def 'common-lisp-indent-function ...)
;(put 'defflavor        'common-lisp-indent-function ...)
;(put 'defsubst 'common-lisp-indent-function ...)

;(put 'with-restart 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
;(put 'restart-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (* 1)))))
;(put 'define-condition 'common-lisp-indent-function '((1 6) (2 6 ((* 1))) (3 4 ((* 1))) (4 &body)))
;(put 'with-condition-handler 'common-lisp-indent-function '((1 4 ((* 1))) (2 &body)))
;(put 'condition-case 'common-lisp-indent-function '((1 4) (* 2 ((0 1) (1 3) (2 &body)))))

;;; cl-indent.el ends here
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.