cl-macs.el 119 KB
Newer Older
1
;;; cl-macs.el --- Common Lisp macros  -*- lexical-binding: t; coding: utf-8 -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1993, 2001-2015 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

;; Author: Dave Gillespie <daveg@synaptics.com>
6
;; Old-Version: 2.02
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Keywords: extensions
8
;; Package: emacs
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; GNU Emacs 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

Richard M. Stallman's avatar
Richard M. Stallman committed
25
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

;; These are extensions to Emacs Lisp that provide a degree of
;; Common Lisp compatibility, beyond what is already built-in
;; in Emacs Lisp.
;;
;; This package was written by Dave Gillespie; it is a complete
;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
;;
;; Bug reports, comments, and suggestions are welcome!

;; This file contains the portions of the Common Lisp extensions
;; package which should be autoloaded, but need only be present
;; if the compiler or interpreter is used---this file is not
;; necessary for executing compiled code.

;; See cl.el for Change Log.


Richard M. Stallman's avatar
Richard M. Stallman committed
44
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
45

46
(require 'cl-lib)
47
(require 'macroexp)
48 49
;; `gv' is required here because cl-macs can be loaded before loaddefs.el.
(require 'gv)
Richard M. Stallman's avatar
Richard M. Stallman committed
50

51
(defmacro cl--pop2 (place)
52
  (declare (debug edebug-sexps))
53 54
  `(prog1 (car (cdr ,place))
     (setq ,place (cdr (cdr ,place)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
55

56 57
(defvar cl--optimize-safety)
(defvar cl--optimize-speed)
Richard M. Stallman's avatar
Richard M. Stallman committed
58 59 60

;;; Initialization.

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
;; Place compiler macros at the beginning, otherwise uses of the corresponding
;; functions can lead to recursive-loads that prevent the calls from
;; being optimized.

;;;###autoload
(defun cl--compiler-macro-list* (_form arg &rest others)
  (let* ((args (reverse (cons arg others)))
	 (form (car args)))
    (while (setq args (cdr args))
      (setq form `(cons ,(car args) ,form)))
    form))

;;;###autoload
(defun cl--compiler-macro-cXXr (form x)
  (let* ((head (car form))
         (n (symbol-name (car form)))
         (i (- (length n) 2)))
    (if (not (string-match "c[ad]+r\\'" n))
        (if (and (fboundp head) (symbolp (symbol-function head)))
            (cl--compiler-macro-cXXr (cons (symbol-function head) (cdr form))
                                     x)
          (error "Compiler macro for cXXr applied to non-cXXr form"))
      (while (> i (match-beginning 0))
        (setq x (list (if (eq (aref n i) ?a) 'car 'cdr) x))
        (setq i (1- i)))
      x)))

88 89 90
;;; Some predicates for analyzing Lisp forms.
;; These are used by various
;; macro expanders to optimize the results in certain common cases.
Richard M. Stallman's avatar
Richard M. Stallman committed
91

92
(defconst cl--simple-funcs '(car cdr nth aref elt if and or + - 1+ 1- min max
93
			    car-safe cdr-safe progn prog1 prog2))
94
(defconst cl--safe-funcs '(* / % length memq list vector vectorp
95 96
			  < > <= >= = error))

97 98
(defun cl--simple-expr-p (x &optional size)
  "Check if no side effects, and executes quickly."
99
  (or size (setq size 10))
100
  (if (and (consp x) (not (memq (car x) '(quote function cl-function))))
101
      (and (symbolp (car x))
102
	   (or (memq (car x) cl--simple-funcs)
103 104 105 106
	       (get (car x) 'side-effect-free))
	   (progn
	     (setq size (1- size))
	     (while (and (setq x (cdr x))
107
			 (setq size (cl--simple-expr-p (car x) size))))
108 109 110
	     (and (null x) (>= size 0) size)))
    (and (> size 0) (1- size))))

111 112
(defun cl--simple-exprs-p (xs)
  (while (and xs (cl--simple-expr-p (car xs)))
113 114 115
    (setq xs (cdr xs)))
  (not xs))

116 117
(defun cl--safe-expr-p (x)
  "Check if no side effects."
118
  (or (not (and (consp x) (not (memq (car x) '(quote function cl-function)))))
119
      (and (symbolp (car x))
120 121
	   (or (memq (car x) cl--simple-funcs)
	       (memq (car x) cl--safe-funcs)
122 123
	       (get (car x) 'side-effect-free))
	   (progn
124
	     (while (and (setq x (cdr x)) (cl--safe-expr-p (car x))))
125 126 127
	     (null x)))))

;;; Check if constant (i.e., no side effects or dependencies).
128
(defun cl--const-expr-p (x)
129 130
  (cond ((consp x)
	 (or (eq (car x) 'quote)
131
	     (and (memq (car x) '(function cl-function))
132 133 134 135 136
		  (or (symbolp (nth 1 x))
		      (and (eq (car-safe (nth 1 x)) 'lambda) 'func)))))
	((symbolp x) (and (memq x '(nil t)) t))
	(t t)))

137
(defun cl--const-expr-val (x)
Daniel Colascione's avatar
Daniel Colascione committed
138
  "Return the value of X known at compile-time.
139 140 141 142
If X is not known at compile time, return nil.  Before testing
whether X is known at compile time, macroexpand it completely in
`macroexpand-all-environment'."
  (let ((x (macroexpand-all x macroexpand-all-environment)))
Daniel Colascione's avatar
Daniel Colascione committed
143
    (if (macroexp-const-p x)
144
        (if (consp x) (nth 1 x) x))))
145

146 147
(defun cl--expr-contains (x y)
  "Count number of times X refers to Y.  Return nil for 0 times."
148
  ;; FIXME: This is naive, and it will cl-count Y as referred twice in
149 150 151
  ;; (let ((Y 1)) Y) even though it should be 0.  Also it is often called on
  ;; non-macroexpanded code, so it may also miss some occurrences that would
  ;; only appear in the expanded code.
152
  (cond ((equal y x) 1)
153
	((and (consp x) (not (memq (car x) '(quote function cl-function))))
154
	 (let ((sum 0))
155
	   (while (consp x)
156 157
	     (setq sum (+ sum (or (cl--expr-contains (pop x) y) 0))))
	   (setq sum (+ sum (or (cl--expr-contains x y) 0)))
158 159 160
	   (and (> sum 0) sum)))
	(t nil)))

161 162
(defun cl--expr-contains-any (x y)
  (while (and y (not (cl--expr-contains x (car y)))) (pop y))
163 164
  y)

165 166 167 168
(defun cl--expr-depends-p (x y)
  "Check whether X may depend on any of the symbols in Y."
  (and (not (macroexp-const-p x))
       (or (not (cl--safe-expr-p x)) (cl--expr-contains-any x y))))
169

Richard M. Stallman's avatar
Richard M. Stallman committed
170 171
;;; Symbols.

172
(defvar cl--gensym-counter)
173
;;;###autoload
174
(defun cl-gensym (&optional prefix)
Richard M. Stallman's avatar
Richard M. Stallman committed
175 176
  "Generate a new uninterned symbol.
The name is made by appending a number to PREFIX, default \"G\"."
177 178
  (let ((pfix (if (stringp prefix) prefix "G"))
	(num (if (integerp prefix) prefix
179 180
	       (prog1 cl--gensym-counter
		 (setq cl--gensym-counter (1+ cl--gensym-counter))))))
181
    (make-symbol (format "%s%d" pfix num))))
Richard M. Stallman's avatar
Richard M. Stallman committed
182

183
;;;###autoload
184
(defun cl-gentemp (&optional prefix)
Richard M. Stallman's avatar
Richard M. Stallman committed
185 186
  "Generate a new interned symbol with a unique name.
The name is made by appending a number to PREFIX, default \"G\"."
187
  (let ((pfix (if (stringp prefix) prefix "G"))
Richard M. Stallman's avatar
Richard M. Stallman committed
188
	name)
189 190
    (while (intern-soft (setq name (format "%s%d" pfix cl--gensym-counter)))
      (setq cl--gensym-counter (1+ cl--gensym-counter)))
Richard M. Stallman's avatar
Richard M. Stallman committed
191 192 193 194 195
    (intern name)))


;;; Program structure.

196
(def-edebug-spec cl-declarations
197
  (&rest ("cl-declare" &rest sexp)))
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217

(def-edebug-spec cl-declarations-or-string
  (&or stringp cl-declarations))

(def-edebug-spec cl-lambda-list
  (([&rest arg]
    [&optional ["&optional" cl-&optional-arg &rest cl-&optional-arg]]
    [&optional ["&rest" arg]]
    [&optional ["&key" [cl-&key-arg &rest cl-&key-arg]
		&optional "&allow-other-keys"]]
    [&optional ["&aux" &rest
		&or (symbolp &optional def-form) symbolp]]
    )))

(def-edebug-spec cl-&optional-arg
  (&or (arg &optional def-form arg) arg))

(def-edebug-spec cl-&key-arg
  (&or ([&or (symbolp arg) arg] &optional def-form arg) arg))

218 219
(def-edebug-spec cl-type-spec sexp)

220 221 222 223
(defconst cl--lambda-list-keywords
  '(&optional &rest &key &allow-other-keys &aux &whole &body &environment))

(defvar cl--bind-block) (defvar cl--bind-defs) (defvar cl--bind-enquote)
224
(defvar cl--bind-lets) (defvar cl--bind-forms)
225 226

(defun cl--transform-lambda (form bind-block)
227 228 229 230 231
  "Transform a function form FORM of name BIND-BLOCK.
BIND-BLOCK is the name of the symbol to which the function will be bound,
and which will be used for the name of the `cl-block' surrounding the
function's body.
FORM is of the form (ARGS . BODY)."
232 233
  ;; FIXME: (lambda (a &aux b) 1) expands to (lambda (a &rest --cl-rest--) ...)
  ;; where the --cl-rest-- is clearly undesired.
234 235
  (let* ((args (car form)) (body (cdr form)) (orig-args args)
	 (cl--bind-block bind-block) (cl--bind-defs nil) (cl--bind-enquote nil)
236
         (cl--bind-lets nil) (cl--bind-forms nil)
237 238 239
         (parsed-body (macroexp-parse-body body))
	 (header (car parsed-body)) (simple-args nil))
    (setq body (cdr parsed-body))
240 241 242 243 244 245 246 247
    (setq args (if (listp args) (cl-copy-list args) (list '&rest args)))
    (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p)))))
    (if (setq cl--bind-defs (cadr (memq '&cl-defs args)))
	(setq args (delq '&cl-defs (delq cl--bind-defs args))
	      cl--bind-defs (cadr cl--bind-defs)))
    (if (setq cl--bind-enquote (memq '&cl-quote args))
	(setq args (delq '&cl-quote args)))
    (if (memq '&whole args) (error "&whole not currently implemented"))
248 249
    (let* ((p (memq '&environment args))
           (v (cadr p)))
250
      (if p (setq args (nconc (delq (car p) (delq v args))
251
                              `(&aux (,v macroexpand-all-environment))))))
252 253 254 255 256 257 258 259
    (while (and args (symbolp (car args))
		(not (memq (car args) '(nil &rest &body &key &aux)))
		(not (and (eq (car args) '&optional)
			  (or cl--bind-defs (consp (cadr args))))))
      (push (pop args) simple-args))
    (or (eq cl--bind-block 'cl-none)
	(setq body (list `(cl-block ,cl--bind-block ,@body))))
    (if (null args)
260
	(cl-list* nil (nreverse simple-args) (nconc header body))
261 262 263 264
      (if (memq '&optional simple-args) (push '&optional args))
      (cl--do-arglist args nil (- (length simple-args)
                                  (if (memq '&optional simple-args) 1 0)))
      (setq cl--bind-lets (nreverse cl--bind-lets))
265
      (cl-list* nil
266 267
	     (nconc (nreverse simple-args)
		    (list '&rest (car (pop cl--bind-lets))))
268 269 270 271 272 273 274 275 276 277 278 279
	     (nconc (save-match-data ;; Macro expansion can take place in the
                      ;; middle of apparently harmless computation, so it
                      ;; should not touch the match-data.
                      (require 'help-fns)
                      (cons (help-add-fundoc-usage
                             (if (stringp (car header)) (pop header))
                             ;; Be careful with make-symbol and (back)quote,
                             ;; see bug#12884.
                             (let ((print-gensym nil) (print-quoted t))
                               (format "%S" (cons 'fn (cl--make-usage-args
                                                       orig-args)))))
                            header))
280 281 282 283
		    (list `(let* ,cl--bind-lets
                             ,@(nreverse cl--bind-forms)
                             ,@body)))))))

284
;;;###autoload
285
(defmacro cl-defun (name args &rest body)
286
  "Define NAME as a function.
Richard M. Stallman's avatar
Richard M. Stallman committed
287
Like normal `defun', except ARGLIST allows full Common Lisp conventions,
288
and BODY is implicitly surrounded by (cl-block NAME ...).
289 290

\(fn NAME ARGLIST [DOCSTRING] BODY...)"
291 292
  (declare (debug
            ;; Same as defun but use cl-lambda-list.
293
            (&define [&or name ("setf" :name setf name)]
294 295 296
                     cl-lambda-list
                     cl-declarations-or-string
                     [&optional ("interactive" interactive)]
297
                     def-body))
298
           (doc-string 3)
299
           (indent 2))
300
  (let* ((res (cl--transform-lambda (cons args body) name))
301 302
	 (form `(defun ,name ,@(cdr res))))
    (if (car res) `(progn ,(car res) ,form) form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
303

Daniel Colascione's avatar
Daniel Colascione committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
;;;###autoload
(defmacro cl-iter-defun (name args &rest body)
  "Define NAME as a generator function.
Like normal `iter-defun', except ARGLIST allows full Common Lisp conventions,
and BODY is implicitly surrounded by (cl-block NAME ...).

\(fn NAME ARGLIST [DOCSTRING] BODY...)"
  (declare (debug
            ;; Same as iter-defun but use cl-lambda-list.
            (&define [&or name ("setf" :name setf name)]
                     cl-lambda-list
                     cl-declarations-or-string
                     [&optional ("interactive" interactive)]
                     def-body))
           (doc-string 3)
           (indent 2))
  (require 'generator)
  (let* ((res (cl--transform-lambda (cons args body) name))
         (form `(iter-defun ,name ,@(cdr res))))
    (if (car res) `(progn ,(car res) ,form) form)))

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
;; The lambda list for macros is different from that of normal lambdas.
;; Note that &environment is only allowed as first or last items in the
;; top level list.

(def-edebug-spec cl-macro-list
  (([&optional "&environment" arg]
    [&rest cl-macro-arg]
    [&optional ["&optional" &rest
		&or (cl-macro-arg &optional def-form cl-macro-arg) arg]]
    [&optional [[&or "&rest" "&body"] cl-macro-arg]]
    [&optional ["&key" [&rest
			[&or ([&or (symbolp cl-macro-arg) arg]
			      &optional def-form cl-macro-arg)
			     arg]]
		&optional "&allow-other-keys"]]
    [&optional ["&aux" &rest
		&or (symbolp &optional def-form) symbolp]]
    [&optional "&environment" arg]
    )))

(def-edebug-spec cl-macro-arg
  (&or arg cl-macro-list1))

(def-edebug-spec cl-macro-list1
  (([&optional "&whole" arg]  ;; only allowed at lower levels
    [&rest cl-macro-arg]
    [&optional ["&optional" &rest
		&or (cl-macro-arg &optional def-form cl-macro-arg) arg]]
    [&optional [[&or "&rest" "&body"] cl-macro-arg]]
    [&optional ["&key" [&rest
			[&or ([&or (symbolp cl-macro-arg) arg]
			      &optional def-form cl-macro-arg)
			     arg]]
		&optional "&allow-other-keys"]]
    [&optional ["&aux" &rest
		&or (symbolp &optional def-form) symbolp]]
    . [&or arg nil])))

363
;;;###autoload
364
(defmacro cl-defmacro (name args &rest body)
365
  "Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
366
Like normal `defmacro', except ARGLIST allows full Common Lisp conventions,
367
and BODY is implicitly surrounded by (cl-block NAME ...).
368 369

\(fn NAME ARGLIST [DOCSTRING] BODY...)"
370
  (declare (debug
371
            (&define name cl-macro-list cl-declarations-or-string def-body))
372
           (doc-string 3)
373
           (indent 2))
374
  (let* ((res (cl--transform-lambda (cons args body) name))
375 376
	 (form `(defmacro ,name ,@(cdr res))))
    (if (car res) `(progn ,(car res) ,form) form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
377

378 379 380 381 382 383
(def-edebug-spec cl-lambda-expr
  (&define ("lambda" cl-lambda-list
	    ;;cl-declarations-or-string
	    ;;[&optional ("interactive" interactive)]
	    def-body)))

384
;; Redefine function-form to also match cl-function
385 386 387 388
(def-edebug-spec function-form
  ;; form at the end could also handle "function",
  ;; but recognize it specially to avoid wrapping function forms.
  (&or ([&or "quote" "function"] &or symbolp lambda-expr)
389
       ("cl-function" cl-function)
390 391
       form))

392
;;;###autoload
393
(defmacro cl-function (func)
394
  "Introduce a function.
395 396
Like normal `function', except that if argument is a lambda form,
its argument list allows full Common Lisp conventions."
397
  (declare (debug (&or symbolp cl-lambda-expr)))
Richard M. Stallman's avatar
Richard M. Stallman committed
398
  (if (eq (car-safe func) 'lambda)
399
      (let* ((res (cl--transform-lambda (cdr func) 'cl-none))
400 401 402
	     (form `(function (lambda . ,(cdr res)))))
	(if (car res) `(progn ,(car res) ,form) form))
    `(function ,func)))
Richard M. Stallman's avatar
Richard M. Stallman committed
403

404 405 406 407 408 409 410 411
(defun cl--make-usage-var (x)
  "X can be a var or a (destructuring) lambda-list."
  (cond
   ((symbolp x) (make-symbol (upcase (symbol-name x))))
   ((consp x) (cl--make-usage-args x))
   (t x)))

(defun cl--make-usage-args (arglist)
412 413 414 415 416
  (let ((aux (ignore-errors (cl-position '&aux arglist))))
    (when aux
      ;; `&aux' args aren't arguments, so let's just drop them from the
      ;; usage info.
      (setq arglist (cl-subseq arglist 0 aux))))
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  (if (cdr-safe (last arglist))         ;Not a proper list.
      (let* ((last (last arglist))
             (tail (cdr last)))
        (unwind-protect
            (progn
              (setcdr last nil)
              (nconc (cl--make-usage-args arglist) (cl--make-usage-var tail)))
          (setcdr last tail)))
    ;; `orig-args' can contain &cl-defs (an internal
    ;; CL thingy I don't understand), so remove it.
    (let ((x (memq '&cl-defs arglist)))
      (when x (setq arglist (delq (car x) (remq (cadr x) arglist)))))
    (let ((state nil))
      (mapcar (lambda (x)
                (cond
                 ((symbolp x)
433 434 435 436 437 438 439 440
                  (let ((first (aref (symbol-name x) 0)))
                    (if (eq ?\& first)
                        (setq state x)
                      ;; Strip a leading underscore, since it only
                      ;; means that this argument is unused.
                      (make-symbol (upcase (if (eq ?_ first)
                                               (substring (symbol-name x) 1)
                                             (symbol-name x)))))))
441 442 443 444 445 446 447 448 449 450 451
                 ((not (consp x)) x)
                 ((memq state '(nil &rest)) (cl--make-usage-args x))
                 (t      ;(VAR INITFORM SVAR) or ((KEYWORD VAR) INITFORM SVAR).
                  (cl-list*
                   (if (and (consp (car x)) (eq state '&key))
                       (list (caar x) (cl--make-usage-var (nth 1 (car x))))
                     (cl--make-usage-var (car x)))
                   (nth 1 x)                        ;INITFORM.
                   (cl--make-usage-args (nthcdr 2 x)) ;SVAR.
                   ))))
              arglist))))
452

453
(defun cl--do-arglist (args expr &optional num)   ; uses cl--bind-*
Richard M. Stallman's avatar
Richard M. Stallman committed
454
  (if (nlistp args)
455
      (if (or (memq args cl--lambda-list-keywords) (not (symbolp args)))
Richard M. Stallman's avatar
Richard M. Stallman committed
456
	  (error "Invalid argument name: %s" args)
457
	(push (list args expr) cl--bind-lets))
458
    (setq args (cl-copy-list args))
Richard M. Stallman's avatar
Richard M. Stallman committed
459 460 461 462 463
    (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p)))))
    (let ((p (memq '&body args))) (if p (setcar p '&rest)))
    (if (memq '&environment args) (error "&environment used incorrectly"))
    (let ((save-args args)
	  (restarg (memq '&rest args))
464
	  (safety (if (cl--compiling-file) cl--optimize-safety 3))
Richard M. Stallman's avatar
Richard M. Stallman committed
465 466 467
	  (keys nil)
	  (laterarg nil) (exactarg nil) minarg)
      (or num (setq num 0))
468 469 470
      (setq restarg (if (listp (cadr restarg))
                        (make-symbol "--cl-rest--")
                      (cadr restarg)))
471
      (push (list restarg expr) cl--bind-lets)
Richard M. Stallman's avatar
Richard M. Stallman committed
472
      (if (eq (car args) '&whole)
473
	  (push (list (cl--pop2 args) restarg) cl--bind-lets))
Richard M. Stallman's avatar
Richard M. Stallman committed
474 475
      (let ((p args))
	(setq minarg restarg)
476
	(while (and p (not (memq (car p) cl--lambda-list-keywords)))
Richard M. Stallman's avatar
Richard M. Stallman committed
477 478 479
	  (or (eq p args) (setq minarg (list 'cdr minarg)))
	  (setq p (cdr p)))
	(if (memq (car p) '(nil &aux))
480
	    (setq minarg `(= (length ,restarg)
481
                             ,(length (cl-ldiff args p)))
Richard M. Stallman's avatar
Richard M. Stallman committed
482
		  exactarg (not (eq args p)))))
483
      (while (and args (not (memq (car args) cl--lambda-list-keywords)))
Richard M. Stallman's avatar
Richard M. Stallman committed
484 485
	(let ((poparg (list (if (or (cdr args) (not exactarg)) 'pop 'car)
			    restarg)))
486
	  (cl--do-arglist
487
	   (pop args)
Richard M. Stallman's avatar
Richard M. Stallman committed
488
	   (if (or laterarg (= safety 0)) poparg
489 490
	     `(if ,minarg ,poparg
                (signal 'wrong-number-of-arguments
491 492
                        (list ,(and (not (eq cl--bind-block 'cl-none))
                                    `',cl--bind-block)
493
                              (length ,restarg)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
494
	(setq num (1+ num) laterarg t))
495
      (while (and (eq (car args) '&optional) (pop args))
496
	(while (and args (not (memq (car args) cl--lambda-list-keywords)))
497
	  (let ((arg (pop args)))
Richard M. Stallman's avatar
Richard M. Stallman committed
498
	    (or (consp arg) (setq arg (list arg)))
499
	    (if (cddr arg) (cl--do-arglist (nth 2 arg) `(and ,restarg t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
500
	    (let ((def (if (cdr arg) (nth 1 arg)
501 502
			 (or (car cl--bind-defs)
			     (nth 1 (assq (car arg) cl--bind-defs)))))
503
		  (poparg `(pop ,restarg)))
504
	      (and def cl--bind-enquote (setq def `',def))
505
	      (cl--do-arglist (car arg)
506
			     (if def `(if ,restarg ,poparg ,def) poparg))
Richard M. Stallman's avatar
Richard M. Stallman committed
507 508
	      (setq num (1+ num))))))
      (if (eq (car args) '&rest)
509
	  (let ((arg (cl--pop2 args)))
510
	    (if (consp arg) (cl--do-arglist arg restarg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
511
	(or (eq (car args) '&key) (= safety 0) exactarg
512 513 514
	    (push `(if ,restarg
                       (signal 'wrong-number-of-arguments
                               (list
515 516
                                ,(and (not (eq cl--bind-block 'cl-none))
                                      `',cl--bind-block)
517
                                (+ ,num (length ,restarg)))))
518
                  cl--bind-forms)))
519
      (while (and (eq (car args) '&key) (pop args))
520
	(while (and args (not (memq (car args) cl--lambda-list-keywords)))
521
	  (let ((arg (pop args)))
522
	    (or (consp arg) (setq arg (list arg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
523
	    (let* ((karg (if (consp (car arg)) (caar arg)
524 525 526 527 528 529 530
                           (let ((name (symbol-name (car arg))))
                             ;; Strip a leading underscore, since it only
                             ;; means that this argument is unused, but
                             ;; shouldn't affect the key's name (bug#12367).
                             (if (eq ?_ (aref name 0))
                                 (setq name (substring name 1)))
                             (intern (format ":%s" name)))))
531
		   (varg (if (consp (car arg)) (cl-cadar arg) (car arg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
532
		   (def (if (cdr arg) (cadr arg)
533
			  (or (car cl--bind-defs) (cadr (assq varg cl--bind-defs)))))
534
                   (look `(plist-member ,restarg ',karg)))
535
	      (and def cl--bind-enquote (setq def `',def))
Richard M. Stallman's avatar
Richard M. Stallman committed
536
	      (if (cddr arg)
537
		  (let* ((temp (or (nth 2 arg) (make-symbol "--cl-var--")))
538
			 (val `(car (cdr ,temp))))
539 540
		    (cl--do-arglist temp look)
		    (cl--do-arglist varg
541 542 543
				   `(if ,temp
                                        (prog1 ,val (setq ,temp t))
                                      ,def)))
544
		(cl--do-arglist
Richard M. Stallman's avatar
Richard M. Stallman committed
545
		 varg
546
		 `(car (cdr ,(if (null def)
Richard M. Stallman's avatar
Richard M. Stallman committed
547
				 look
548
			       `(or ,look
549
                                    ,(if (eq (cl--const-expr-p def) t)
550
					 `'(nil ,(cl--const-expr-val def))
551
				       `(list nil ,def))))))))
552
	      (push karg keys)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
553
      (setq keys (nreverse keys))
554
      (or (and (eq (car args) '&allow-other-keys) (pop args))
Richard M. Stallman's avatar
Richard M. Stallman committed
555
	  (null keys) (= safety 0)
556
	  (let* ((var (make-symbol "--cl-keys--"))
Richard M. Stallman's avatar
Richard M. Stallman committed
557
		 (allow '(:allow-other-keys))
558 559 560 561 562 563 564 565 566 567 568
		 (check `(while ,var
                           (cond
                            ((memq (car ,var) ',(append keys allow))
                             (setq ,var (cdr (cdr ,var))))
                            ((car (cdr (memq (quote ,@allow) ,restarg)))
                             (setq ,var nil))
                            (t
                             (error
                              ,(format "Keyword argument %%s not one of %s"
                                       keys)
                              (car ,var)))))))
569
	    (push `(let ((,var ,restarg)) ,check) cl--bind-forms)))
570
      (while (and (eq (car args) '&aux) (pop args))
571
	(while (and args (not (memq (car args) cl--lambda-list-keywords)))
Richard M. Stallman's avatar
Richard M. Stallman committed
572
	  (if (consp (car args))
573
	      (if (and cl--bind-enquote (cl-cadar args))
574
		  (cl--do-arglist (caar args)
575
				 `',(cadr (pop args)))
576 577
		(cl--do-arglist (caar args) (cadr (pop args))))
	    (cl--do-arglist (pop args) nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
578 579
      (if args (error "Malformed argument list %s" save-args)))))

580
(defun cl--arglist-args (args)
Richard M. Stallman's avatar
Richard M. Stallman committed
581 582 583
  (if (nlistp args) (list args)
    (let ((res nil) (kind nil) arg)
      (while (consp args)
584
	(setq arg (pop args))
585
	(if (memq arg cl--lambda-list-keywords) (setq kind arg)
586
	  (if (eq arg '&cl-defs) (pop args)
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588
	    (and (consp arg) kind (setq arg (car arg)))
	    (and (consp arg) (cdr arg) (eq kind '&key) (setq arg (cadr arg)))
589
	    (setq res (nconc res (cl--arglist-args arg))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
590 591
      (nconc res (and args (list args))))))

592
;;;###autoload
593
(defmacro cl-destructuring-bind (args expr &rest body)
Glenn Morris's avatar
Glenn Morris committed
594
  "Bind the variables in ARGS to the result of EXPR and execute BODY."
595 596
  (declare (indent 2)
           (debug (&define cl-macro-list def-form cl-declarations def-body)))
597
  (let* ((cl--bind-lets nil) (cl--bind-forms nil)
598
	 (cl--bind-defs nil) (cl--bind-block 'cl-none) (cl--bind-enquote nil))
599
    (cl--do-arglist (or args '(&aux)) expr)
600 601
    (macroexp-let* (nreverse cl--bind-lets)
                   (macroexp-progn (append (nreverse cl--bind-forms) body)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
602 603


604
;;; The `cl-eval-when' form.
Richard M. Stallman's avatar
Richard M. Stallman committed
605

606
(defvar cl--not-toplevel nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
607

608
;;;###autoload
609
(defmacro cl-eval-when (when &rest body)
610
  "Control when BODY is evaluated.
Richard M. Stallman's avatar
Richard M. Stallman committed
611 612
If `compile' is in WHEN, BODY is evaluated when compiled at top-level.
If `load' is in WHEN, BODY is evaluated when loaded after top-level compile.
613 614 615
If `eval' is in WHEN, BODY is evaluated when interpreted or at non-top-level.

\(fn (WHEN...) BODY...)"
616
  (declare (indent 1) (debug (sexp body)))
617
  (if (and (fboundp 'cl--compiling-file) (cl--compiling-file)
618
	   (not cl--not-toplevel) (not (boundp 'for-effect))) ;Horrible kludge.
619
      (let ((comp (or (memq 'compile when) (memq :compile-toplevel when)))
620
	    (cl--not-toplevel t))
621
	(if (or (memq 'load when) (memq :load-toplevel when))
622
	    (if comp (cons 'progn (mapcar 'cl--compile-time-too body))
623
	      `(if nil nil ,@body))
Richard M. Stallman's avatar
Richard M. Stallman committed
624
	  (progn (if comp (eval (cons 'progn body))) nil)))
625
    (and (or (memq 'eval when) (memq :execute when))
Richard M. Stallman's avatar
Richard M. Stallman committed
626 627
	 (cons 'progn body))))

628
(defun cl--compile-time-too (form)
Richard M. Stallman's avatar
Richard M. Stallman committed
629 630
  (or (and (symbolp (car-safe form)) (get (car-safe form) 'byte-hunk-handler))
      (setq form (macroexpand
631
		  form (cons '(cl-eval-when) byte-compile-macro-environment))))
Richard M. Stallman's avatar
Richard M. Stallman committed
632
  (cond ((eq (car-safe form) 'progn)
633
	 (cons 'progn (mapcar 'cl--compile-time-too (cdr form))))
634
	((eq (car-safe form) 'cl-eval-when)
Richard M. Stallman's avatar
Richard M. Stallman committed
635
	 (let ((when (nth 1 form)))
636
	   (if (or (memq 'eval when) (memq :execute when))
637
	       `(cl-eval-when (compile ,@when) ,@(cddr form))
Richard M. Stallman's avatar
Richard M. Stallman committed
638 639 640
	     form)))
	(t (eval form) form)))

641
;;;###autoload
642
(defmacro cl-load-time-value (form &optional _read-only)
Richard M. Stallman's avatar
Richard M. Stallman committed
643 644
  "Like `progn', but evaluates the body at load time.
The result of the body appears to the compiler as a quoted constant."
645
  (declare (debug (form &optional sexp)))
646
  (if (cl--compiling-file)
647
      (let* ((temp (cl-gentemp "--cl-load-time--"))
648
	     (set `(setq ,temp ,form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
649 650
	(if (and (fboundp 'byte-compile-file-form-defmumble)
		 (boundp 'this-kind) (boundp 'that-one))
651 652 653 654 655 656 657 658 659 660 661 662 663 664
            ;; Else, we can't output right away, so we have to delay it to the
            ;; next time we're at the top-level.
            ;; FIXME: Use advice-add/remove.
            (fset 'byte-compile-file-form
                  (let ((old (symbol-function 'byte-compile-file-form)))
                    (lambda (form)
                      (fset 'byte-compile-file-form old)
                      (byte-compile-file-form set)
                      (byte-compile-file-form form))))
          ;; If we're not in the middle of compiling something, we can
          ;; output directly to byte-compile-outbuffer, to make sure
          ;; temp is set before we use it.
          (print set byte-compile--outbuffer))
	temp)
665
    `',(eval form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
666 667 668 669


;;; Conditional control structures.

670
;;;###autoload
671
(defmacro cl-case (expr &rest clauses)
672
  "Eval EXPR and choose among clauses on that value.
Richard M. Stallman's avatar
Richard M. Stallman committed
673 674
Each clause looks like (KEYLIST BODY...).  EXPR is evaluated and compared
against each key in each KEYLIST; the corresponding BODY is evaluated.
675
If no clause succeeds, cl-case returns nil.  A single atom may be used in
676
place of a KEYLIST of one atom.  A KEYLIST of t or `otherwise' is
Richard M. Stallman's avatar
Richard M. Stallman committed
677
allowed only in the final clause, and matches if no other keys match.
678 679
Key values are compared by `eql'.
\n(fn EXPR (KEYLIST BODY...)...)"
680
  (declare (indent 1) (debug (form &rest (sexp body))))
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
  (macroexp-let2 macroexp-copyable-p temp expr
    (let* ((head-list nil))
      `(cond
        ,@(mapcar
           (lambda (c)
             (cons (cond ((memq (car c) '(t otherwise)) t)
                         ((eq (car c) 'cl--ecase-error-flag)
                          `(error "cl-ecase failed: %s, %s"
                                  ,temp ',(reverse head-list)))
                         ((listp (car c))
                          (setq head-list (append (car c) head-list))
                          `(cl-member ,temp ',(car c)))
                         (t
                          (if (memq (car c) head-list)
                              (error "Duplicate key in case: %s"
                                     (car c)))
                          (push (car c) head-list)
                          `(eql ,temp ',(car c))))
                   (or (cdr c) '(nil))))
           clauses)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
701

702
;;;###autoload
703
(defmacro cl-ecase (expr &rest clauses)
704
  "Like `cl-case', but error if no case fits.
705 706
`otherwise'-clauses are not allowed.
\n(fn EXPR (KEYLIST BODY...)...)"
707 708
  (declare (indent 1) (debug cl-case))
  `(cl-case ,expr ,@clauses (cl--ecase-error-flag)))
Richard M. Stallman's avatar
Richard M. Stallman committed
709

710
;;;###autoload
711
(defmacro cl-typecase (expr &rest clauses)
712
  "Evals EXPR, chooses among clauses on that value.
Richard M. Stallman's avatar
Richard M. Stallman committed
713 714
Each clause looks like (TYPE BODY...).  EXPR is evaluated and, if it
satisfies TYPE, the corresponding BODY is evaluated.  If no clause succeeds,
715
cl-typecase returns nil.  A TYPE of t or `otherwise' is allowed only in the
716 717
final clause, and matches if no other keys match.
\n(fn EXPR (TYPE BODY...)...)"
718 719
  (declare (indent 1)
           (debug (form &rest ([&or cl-type-spec "otherwise"] body))))
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
  (macroexp-let2 macroexp-copyable-p temp expr
    (let* ((type-list nil))
      (cons
       'cond
       (mapcar
        (function
         (lambda (c)
           (cons (cond ((eq (car c) 'otherwise) t)
                       ((eq (car c) 'cl--ecase-error-flag)
                        `(error "cl-etypecase failed: %s, %s"
                                ,temp ',(reverse type-list)))
                       (t
                        (push (car c) type-list)
                        `(cl-typep ,temp ',(car c))))
                 (or (cdr c) '(nil)))))
        clauses)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
736

737
;;;###autoload
738 739
(defmacro cl-etypecase (expr &rest clauses)
  "Like `cl-typecase', but error if no case fits.
740 741
`otherwise'-clauses are not allowed.
\n(fn EXPR (TYPE BODY...)...)"
742 743
  (declare (indent 1) (debug cl-typecase))
  `(cl-typecase ,expr ,@clauses (cl--ecase-error-flag)))
Richard M. Stallman's avatar
Richard M. Stallman committed
744 745 746 747


;;; Blocks and exits.

748
;;;###autoload
749
(defmacro cl-block (name &rest body)
750
  "Define a lexically-scoped block named NAME.
751
NAME may be any symbol.  Code inside the BODY forms can call `cl-return-from'
Richard M. Stallman's avatar
Richard M. Stallman committed
752 753 754 755 756 757
to jump prematurely out of the block.  This differs from `catch' and `throw'
in two respects:  First, the NAME is an unevaluated symbol rather than a
quoted symbol or other form; and second, NAME is lexically rather than
dynamically scoped:  Only references to it within BODY will work.  These
references may appear inside macro expansions, but not inside functions
called from BODY."
758
  (declare (indent 1) (debug (symbolp body)))
759
  (if (cl--safe-expr-p `(progn ,@body)) `(progn ,@body)
760
    `(cl--block-wrapper
761 762
      (catch ',(intern (format "--cl-block-%s--" name))
        ,@body))))
Richard M. Stallman's avatar
Richard M. Stallman committed
763

764
;;;###autoload
765
(defmacro cl-return (&optional result)
766
  "Return from the block named nil.
767
This is equivalent to `(cl-return-from nil RESULT)'."
768
  (declare (debug (&optional form)))
769
  `(cl-return-from nil ,result))
Richard M. Stallman's avatar
Richard M. Stallman committed
770

771
;;;###autoload
772
(defmacro cl-return-from (name &optional result)
773
  "Return from the block named NAME.
774
This jumps out to the innermost enclosing `(cl-block NAME ...)' form,
Richard M. Stallman's avatar
Richard M. Stallman committed
775 776 777
returning RESULT from that form (or nil if RESULT is omitted).
This is compatible with Common Lisp, but note that `defun' and
`defmacro' do not create implicit blocks as they do in Common Lisp."
778
  (declare (indent 1) (debug (symbolp &optional form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
779
  (let ((name2 (intern (format "--cl-block-%s--" name))))
780
    `(cl--block-throw ',name2 ,result)))
Richard M. Stallman's avatar
Richard M. Stallman committed
781 782


783
;;; The "cl-loop" macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
784

785
(defvar cl--loop-args) (defvar cl--loop-accum-var) (defvar cl--loop-accum-vars)
Stefan Monnier's avatar
Stefan Monnier committed
786 787 788
(defvar cl--loop-bindings) (defvar cl--loop-body)
(defvar cl--loop-finally)
(defvar cl--loop-finish-flag)           ;Symbol set to nil to exit the loop?
789
(defvar cl--loop-first-flag)
Stefan Monnier's avatar
Stefan Monnier committed
790 791
(defvar cl--loop-initially) (defvar cl--loop-iterator-function)
(defvar cl--loop-name)
792
(defvar cl--loop-result) (defvar cl--loop-result-explicit)
793 794
(defvar cl--loop-result-var) (defvar cl--loop-steps)
(defvar cl--loop-symbol-macs)
Richard M. Stallman's avatar
Richard M. Stallman committed
795

Stefan Monnier's avatar
Stefan Monnier committed
796 797 798 799 800 801
(defun cl--loop-set-iterator-function (kind iterator)
  (if cl--loop-iterator-function
      ;; FIXME: Of course, we could make it work, but why bother.
      (error "Iteration on %S does not support this combination" kind)
    (setq cl--loop-iterator-function iterator)))

802
;;;###autoload
803
(defmacro cl-loop (&rest loop-args)
804
  "The Common Lisp `loop' macro.
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
Valid clauses include:
  For clauses:
    for VAR from/upfrom/downfrom EXPR1 to/upto/downto/above/below EXPR2 by EXPR3
    for VAR = EXPR1 then EXPR2
    for VAR in/on/in-ref LIST by FUNC
    for VAR across/across-ref ARRAY
    for VAR being:
      the elements of/of-ref SEQUENCE [using (index VAR2)]
      the symbols [of OBARRAY]
      the hash-keys/hash-values of HASH-TABLE [using (hash-values/hash-keys V2)]
      the key-codes/key-bindings/key-seqs of KEYMAP [using (key-bindings VAR2)]
      the overlays/intervals [of BUFFER] [from POS1] [to POS2]
      the frames/buffers
      the windows [of FRAME]
  Iteration clauses:
    repeat INTEGER
    while/until/always/never/thereis CONDITION
  Accumulation clauses:
    collect/append/nconc/concat/vconcat/count/sum/maximize/minimize FORM
      [into VAR]
  Miscellaneous clauses:
    with VAR = INIT
    if/when/unless COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...]
    named NAME
    initially/finally [do] EXPRS...
    do EXPRS...
    [finally] return EXPR

For more details, see Info node `(cl)Loop Facility'.
834 835

\(fn CLAUSE...)"
836 837 838 839 840 841 842 843 844 845 846 847
  (declare (debug (&rest &or
                         ;; These are usually followed by a symbol, but it can
                         ;; actually be any destructuring-bind pattern, which
                         ;; would erroneously match `form'.
                         [[&or "for" "as" "with" "and"] sexp]
                         ;; These are followed by expressions which could
                         ;; erroneously match `symbolp'.
                         [[&or "from" "upfrom" "downfrom" "to" "upto" "downto"
                               "above" "below" "by" "in" "on" "=" "across"
                               "repeat" "while" "until" "always" "never"
                               "thereis" "collect" "append" "nconc" "sum"
                               "count" "maximize" "minimize" "if" "unless"
848 849
                               "return"]
                          form]
850 851
                         ;; Simple default, which covers 99% of the cases.
                         symbolp form)))
852 853
  (if (not (memq t (mapcar #'symbolp
                           (delq nil (delq t (cl-copy-list loop-args))))))
854 855
      `(cl-block nil (while t ,@loop-args))
    (let ((cl--loop-args loop-args) (cl--loop-name nil) (cl--loop-bindings nil)
Stefan Monnier's avatar
Stefan Monnier committed
856 857 858
	  (cl--loop-body nil)		(cl--loop-steps nil)
	  (cl--loop-result nil)		(cl--loop-result-explicit nil)
	  (cl--loop-result-var nil)	(cl--loop-finish-flag nil)
859 860
	  (cl--loop-accum-var nil)	(cl--loop-accum-vars nil)
	  (cl--loop-initially nil)	(cl--loop-finally nil)
Stefan Monnier's avatar
Stefan Monnier committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
	  (cl--loop-iterator-function nil) (cl--loop-first-flag nil)
          (cl--loop-symbol-macs nil))
      ;; Here is more or less how those dynbind vars are used after looping
      ;; over cl--parse-loop-clause:
      ;;
      ;; (cl-block ,cl--loop-name
      ;;   (cl-symbol-macrolet ,cl--loop-symbol-macs
      ;;     (foldl #'cl--loop-let
      ;;            `((,cl--loop-result-var)
      ;;              ((,cl--loop-first-flag t))
      ;;              ((,cl--loop-finish-flag t))
      ;;              ,@cl--loop-bindings)
      ;;           ,@(nreverse cl--loop-initially)
      ;;           (while                   ;(well: cl--loop-iterator-function)
      ;;               ,(car (cl--loop-build-ands (nreverse cl--loop-body)))
      ;;             ,@(cadr (cl--loop-build-ands (nreverse cl--loop-body)))
      ;;             ,@(nreverse cl--loop-steps)
      ;;             (setq ,cl--loop-first-flag nil))
      ;;           (if (not ,cl--loop-finish-flag) ;FIXME: Why `if' vs `progn'?
      ;;               ,cl--loop-result-var
      ;;             ,@(nreverse cl--loop-finally)
      ;;             ,(or cl--loop-result-explicit
      ;;                  cl--loop-result)))))
      ;;
885
      (setq cl--loop-args (append cl--loop-args '(cl-end-loop)))
886 887
      (while (not (eq (car cl--loop-args) 'cl-end-loop))
        (cl--parse-loop-clause))
888 889 890 891 892 893
      (if cl--loop-finish-flag
	  (push `((,cl--loop-finish-flag t)) cl--loop-bindings))
      (if cl--loop-first-flag
	  (progn (push `((,cl--loop-first-flag t)) cl--loop-bindings)
		 (push `(setq ,cl--loop-first-flag nil) cl--loop-steps)))
      (let* ((epilogue (nconc (nreverse cl--loop-finally)
894 895
			      (list (or cl--loop-result-explicit
                                        cl--loop-result))))
896 897
	     (ands (cl--loop-build-ands (nreverse cl--loop-body)))
	     (while-body (nconc (cadr ands) (nreverse cl--loop-steps)))
Richard M. Stallman's avatar
Richard M. Stallman committed
898
	     (body (append
899
		    (nreverse cl--loop-initially)
Stefan Monnier's avatar
Stefan Monnier committed
900
		    (list (if cl--loop-iterator-function
901
			      `(cl-block --cl-finish--
Stefan Monnier's avatar
Stefan Monnier committed
902 903 904 905 906 907 908
                                 ,(funcall cl--loop-iterator-function
                                           (if (eq (car ands) t) while-body
                                             (cons `(or ,(car ands)
                                                        (cl-return-from
                                                            --cl-finish--
                                                          nil))
                                                   while-body))))
909
			    `(while ,(car ands) ,@while-body)))
910 911 912 913
		    (if cl--loop-finish-flag
			(if (equal epilogue '(nil)) (list cl--loop-result-var)
			  `((if ,cl--loop-finish-flag
				(progn ,@epilogue) ,cl--loop-result-var)))
Richard M. Stallman's avatar
Richard M. Stallman committed
914
		      epilogue))))
915 916
	(if cl--loop-result-var
            (push (list cl--loop-result-var) cl--loop-bindings))
917 918 919
	(while cl--loop-bindings
	  (if (cdar cl--loop-bindings)
	      (setq body (list (cl--loop-let (pop cl--loop-bindings) body t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
920
	    (let ((lets nil))
921 922 923 924 925
	      (while (and cl--loop-bindings
			  (not (cdar cl--loop-bindings)))
		(push (car (pop cl--loop-bindings)) lets))
	      (setq body (list (cl--loop-let lets body nil))))))
	(if cl--loop-symbol-macs
926 927
	    (setq body
                  (list `(cl-symbol-macrolet ,cl--loop-symbol-macs ,@body))))
928
	`(cl-block ,cl--loop-name ,@body)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
929

930
;; Below is a complete spec for cl-loop, in several parts that correspond
931 932
;; to the syntax given in CLtL2.  The specs do more than specify where
;; the forms are; it also specifies, as much as Edebug allows, all the
933
;; syntactically valid cl-loop clauses.  The disadvantage of this
934 935 936
;; completeness is rigidity, but the "for ... being" clause allows
;; arbitrary extensions of the form: [symbolp &rest &or symbolp form].

937
;; (def-edebug-spec cl-loop
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973