git.chise.org Git - chise/xemacs-chise.git.1/blob - lisp/cl-macs.el

   1 ;;; cl-macs.el --- Common Lisp extensions for GNU Emacs Lisp (part four)
   2
   3 ;; Copyright (C) 1993 Free Software Foundation, Inc.
   4
   5 ;; Author: Dave Gillespie <daveg@synaptics.com>
   6 ;; Version: 2.02
   7 ;; Keywords: extensions
   8
   9 ;; This file is part of XEmacs.
  10
  11 ;; XEmacs is free software; you can redistribute it and/or modify it
  12 ;; under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; XEmacs is distributed in the hope that it will be useful, but
  17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 ;; General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
  23 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  24 ;; 02111-1307, USA.
  25
  26 ;;; Synched up with: FSF 19.34.
  27
  28 ;;; Commentary:
  29
  30 ;; These are extensions to Emacs Lisp that provide a degree of
  31 ;; Common Lisp compatibility, beyond what is already built-in
  32 ;; in Emacs Lisp.
  33 ;;
  34 ;; This package was written by Dave Gillespie; it is a complete
  35 ;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
  36 ;;
  37 ;; This package works with Emacs 18, Emacs 19, and Lucid Emacs 19.
  38 ;;
  39 ;; Bug reports, comments, and suggestions are welcome!
  40
  41 ;; This file contains the portions of the Common Lisp extensions
  42 ;; package which should be autoloaded, but need only be present
  43 ;; if the compiler or interpreter is used---this file is not
  44 ;; necessary for executing compiled code.
  45
  46 ;; See cl.el for Change Log.
  47
  48
  49 ;;; Code:
  50
  51 (or (memq 'cl-19 features)
  52     (error "Tried to load `cl-macs' before `cl'!"))
  53
  54
  55 ;;; We define these here so that this file can compile without having
  56 ;;; loaded the cl.el file already.
  57
  58 (defmacro cl-push (x place) (list 'setq place (list 'cons x place)))
  59 (defmacro cl-pop (place)
  60   (list 'car (list 'prog1 place (list 'setq place (list 'cdr place)))))
  61 (defmacro cl-pop2 (place)
  62   (list 'prog1 (list 'car (list 'cdr place))
  63         (list 'setq place (list 'cdr (list 'cdr place)))))
  64 (put 'cl-push 'edebug-form-spec 'edebug-sexps)
  65 (put 'cl-pop 'edebug-form-spec 'edebug-sexps)
  66 (put 'cl-pop2 'edebug-form-spec 'edebug-sexps)
  67
  68 (defvar cl-emacs-type)
  69 (defvar cl-optimize-safety)
  70 (defvar cl-optimize-speed)
  71
  72
  73 ;;; This kludge allows macros which use cl-transform-function-property
  74 ;;; to be called at compile-time.
  75
  76 (require
  77  (progn
  78    (or (fboundp 'defalias) (fset 'defalias 'fset))
  79    (or (fboundp 'cl-transform-function-property)
  80        (defalias 'cl-transform-function-property
  81          #'(lambda (n p f)
  82              (list 'put (list 'quote n) (list 'quote p)
  83                    (list 'function (cons 'lambda f))))))
  84    'xemacs))
  85
  86
  87 ;;; Initialization.
  88
  89 (defvar cl-old-bc-file-form nil)
  90
  91 ;; Patch broken Emacs 18 compiler (re top-level macros).
  92 ;; Emacs 19 compiler doesn't need this patch.
  93 ;; Also, undo broken definition of `eql' that uses same bytecode as `eq'.
  94
  95 ;;;###autoload
  96 (defun cl-compile-time-init ()
  97   (setq cl-old-bc-file-form (symbol-function 'byte-compile-file-form))
  98   (or (fboundp 'byte-compile-flush-pending)   ; Emacs 19 compiler?
  99       (defalias 'byte-compile-file-form
 100         #'(lambda (form)
 101             (setq form (macroexpand form byte-compile-macro-environment))
 102             (if (eq (car-safe form) 'progn)
 103                 (cons 'progn (mapcar 'byte-compile-file-form (cdr form)))
 104               (funcall cl-old-bc-file-form form)))))
 105   (put 'eql 'byte-compile 'cl-byte-compile-compiler-macro)
 106   (run-hooks 'cl-hack-bytecomp-hook))
 107
 108
 109 ;;; Program structure.
 110
 111 ;;;###autoload
 112 (defmacro defun* (name args &rest body)
 113   "(defun* NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function.
 114 Like normal `defun', except ARGLIST allows full Common Lisp conventions,
 115 and BODY is implicitly surrounded by (block NAME ...)."
 116   (let* ((res (cl-transform-lambda (cons args body) name))
 117          (form (list* 'defun name (cdr res))))
 118     (if (car res) (list 'progn (car res) form) form)))
 119
 120 ;;;###autoload
 121 (defmacro defmacro* (name args &rest body)
 122   "(defmacro* NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro.
 123 Like normal `defmacro', except ARGLIST allows full Common Lisp conventions,
 124 and BODY is implicitly surrounded by (block NAME ...)."
 125   (let* ((res (cl-transform-lambda (cons args body) name))
 126          (form (list* 'defmacro name (cdr res))))
 127     (if (car res) (list 'progn (car res) form) form)))
 128
 129 ;;;###autoload
 130 (defmacro function* (func)
 131   "(function* SYMBOL-OR-LAMBDA): introduce a function.
 132 Like normal `function', except that if argument is a lambda form, its
 133 ARGLIST allows full Common Lisp conventions."
 134   (if (eq (car-safe func) 'lambda)
 135       (let* ((res (cl-transform-lambda (cdr func) 'cl-none))
 136              (form (list 'function (cons 'lambda (cdr res)))))
 137         (if (car res) (list 'progn (car res) form) form))
 138     (list 'function func)))
 139
 140 (defun cl-transform-function-property (func prop form)
 141   (let ((res (cl-transform-lambda form func)))
 142     (append '(progn) (cdr (cdr (car res)))
 143             (list (list 'put (list 'quote func) (list 'quote prop)
 144                         (list 'function (cons 'lambda (cdr res))))))))
 145
 146 (defconst lambda-list-keywords
 147   '(&optional &rest &key &allow-other-keys &aux &whole &body &environment))
 148
 149 (defvar cl-macro-environment nil)
 150 (defvar bind-block) (defvar bind-defs) (defvar bind-enquote)
 151 (defvar bind-inits) (defvar bind-lets) (defvar bind-forms)
 152
 153 (defun cl-transform-lambda (form bind-block)
 154   (let* ((args (car form)) (body (cdr form))
 155          (bind-defs nil) (bind-enquote nil)
 156          (bind-inits nil) (bind-lets nil) (bind-forms nil)
 157          (header nil) (simple-args nil))
 158     (while (or (stringp (car body)) (eq (car-safe (car body)) 'interactive))
 159       (cl-push (cl-pop body) header))
 160     (setq args (if (listp args) (copy-list args) (list '&rest args)))
 161     (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p)))))
 162     (if (setq bind-defs (cadr (memq '&cl-defs args)))
 163         (setq args (delq '&cl-defs (delq bind-defs args))
 164               bind-defs (cadr bind-defs)))
 165     (if (setq bind-enquote (memq '&cl-quote args))
 166         (setq args (delq '&cl-quote args)))
 167     (if (memq '&whole args) (error "&whole not currently implemented"))
 168     (let* ((p (memq '&environment args)) (v (cadr p)))
 169       (if p (setq args (nconc (delq (car p) (delq v args))
 170                               (list '&aux (list v 'cl-macro-environment))))))
 171     (while (and args (symbolp (car args))
 172                 (not (memq (car args) '(nil &rest &body &key &aux)))
 173                 (not (and (eq (car args) '&optional)
 174                           (or bind-defs (consp (cadr args))))))
 175       (cl-push (cl-pop args) simple-args))
 176     (or (eq bind-block 'cl-none)
 177         (setq body (list (list* 'block bind-block body))))
 178     (if (null args)
 179         (list* nil (nreverse simple-args) (nconc (nreverse header) body))
 180       (if (memq '&optional simple-args) (cl-push '&optional args))
 181       (cl-do-arglist args nil (- (length simple-args)
 182                                  (if (memq '&optional simple-args) 1 0)))
 183       (setq bind-lets (nreverse bind-lets))
 184       (list* (and bind-inits (list* 'eval-when '(compile load eval)
 185                                     (nreverse bind-inits)))
 186              (nconc (nreverse simple-args)
 187                     (list '&rest (car (cl-pop bind-lets))))
 188              (nconc (nreverse header)
 189                     (list (nconc (list 'let* bind-lets)
 190                                  (nreverse bind-forms) body)))))))
 191
 192 (defun cl-do-arglist (args expr &optional num)   ; uses bind-*
 193   (if (nlistp args)
 194       (if (or (memq args lambda-list-keywords) (not (symbolp args)))
 195           (error "Invalid argument name: %s" args)
 196         (cl-push (list args expr) bind-lets))
 197     (setq args (copy-list args))
 198     (let ((p (last args))) (if (cdr p) (setcdr p (list '&rest (cdr p)))))
 199     (let ((p (memq '&body args))) (if p (setcar p '&rest)))
 200     (if (memq '&environment args) (error "&environment used incorrectly"))
 201     (let ((save-args args)
 202           (restarg (memq '&rest args))
 203           (safety (if (cl-compiling-file) cl-optimize-safety 3))
 204           (keys nil)
 205           (laterarg nil) (exactarg nil) minarg)
 206       (or num (setq num 0))
 207       (if (listp (cadr restarg))
 208           (setq restarg (gensym "--rest--"))
 209         (setq restarg (cadr restarg)))
 210       (cl-push (list restarg expr) bind-lets)
 211       (if (eq (car args) '&whole)
 212           (cl-push (list (cl-pop2 args) restarg) bind-lets))
 213       (let ((p args))
 214         (setq minarg restarg)
 215         (while (and p (not (memq (car p) lambda-list-keywords)))
 216           (or (eq p args) (setq minarg (list 'cdr minarg)))
 217           (setq p (cdr p)))
 218         (if (memq (car p) '(nil &aux))
 219             (setq minarg (list '= (list 'length restarg)
 220                                (length (ldiff args p)))
 221                   exactarg (not (eq args p)))))
 222       (while (and args (not (memq (car args) lambda-list-keywords)))
 223         (let ((poparg (list (if (or (cdr args) (not exactarg)) 'pop 'car)
 224                             restarg)))
 225           (cl-do-arglist
 226            (cl-pop args)
 227            (if (or laterarg (= safety 0)) poparg
 228              (list 'if minarg poparg
 229                    (list 'signal '(quote wrong-number-of-arguments)
 230                          (list 'list (and (not (eq bind-block 'cl-none))
 231                                           (list 'quote bind-block))
 232                                (list 'length restarg)))))))
 233         (setq num (1+ num) laterarg t))
 234       (while (and (eq (car args) '&optional) (cl-pop args))
 235         (while (and args (not (memq (car args) lambda-list-keywords)))
 236           (let ((arg (cl-pop args)))
 237             (or (consp arg) (setq arg (list arg)))
 238             (if (cddr arg) (cl-do-arglist (nth 2 arg) (list 'and restarg t)))
 239             (let ((def (if (cdr arg) (nth 1 arg)
 240                          (or (car bind-defs)
 241                              (nth 1 (assq (car arg) bind-defs)))))
 242                   (poparg (list 'pop restarg)))
 243               (and def bind-enquote (setq def (list 'quote def)))
 244               (cl-do-arglist (car arg)
 245                              (if def (list 'if restarg poparg def) poparg))
 246               (setq num (1+ num))))))
 247       (if (eq (car args) '&rest)
 248           (let ((arg (cl-pop2 args)))
 249             (if (consp arg) (cl-do-arglist arg restarg)))
 250         (or (eq (car args) '&key) (= safety 0) exactarg
 251             (cl-push (list 'if restarg
 252                            (list 'signal '(quote wrong-number-of-arguments)
 253                                  (list 'list
 254                                        (and (not (eq bind-block 'cl-none))
 255                                             (list 'quote bind-block))
 256                                        (list '+ num (list 'length restarg)))))
 257                      bind-forms)))
 258       (while (and (eq (car args) '&key) (cl-pop args))
 259         (while (and args (not (memq (car args) lambda-list-keywords)))
 260           (let ((arg (cl-pop args)))
 261             (or (consp arg) (setq arg (list arg)))
 262             (let* ((karg (if (consp (car arg)) (caar arg)
 263                            (intern (format ":%s" (car arg)))))
 264                    (varg (if (consp (car arg)) (cadar arg) (car arg)))
 265                    (def (if (cdr arg) (cadr arg)
 266                           (or (car bind-defs) (cadr (assq varg bind-defs)))))
 267                    (look (list 'memq (list 'quote karg) restarg)))
 268               (and def bind-enquote (setq def (list 'quote def)))
 269               (if (cddr arg)
 270                   (let* ((temp (or (nth 2 arg) (gensym)))
 271                          (val (list 'car (list 'cdr temp))))
 272                     (cl-do-arglist temp look)
 273                     (cl-do-arglist varg
 274                                    (list 'if temp
 275                                          (list 'prog1 val (list 'setq temp t))
 276                                          def)))
 277                 (cl-do-arglist
 278                  varg
 279                  (list 'car
 280                        (list 'cdr
 281                              (if (null def)
 282                                  look
 283                                (list 'or look
 284                                      (if (eq (cl-const-expr-p def) t)
 285                                          (list
 286                                           'quote
 287                                           (list nil (cl-const-expr-val def)))
 288                                        (list 'list nil def))))))))
 289               (cl-push karg keys)
 290               (if (= (aref (symbol-name karg) 0) ?:)
 291                   (progn (set karg karg)
 292                          (cl-push (list 'setq karg (list 'quote karg))
 293                                   bind-inits)))))))
 294       (setq keys (nreverse keys))
 295       (or (and (eq (car args) '&allow-other-keys) (cl-pop args))
 296           (null keys) (= safety 0)
 297           (let* ((var (gensym "--keys--"))
 298                  (allow '(:allow-other-keys))
 299                  (check (list
 300                          'while var
 301                          (list
 302                           'cond
 303                           (list (list 'memq (list 'car var)
 304                                       (list 'quote (append keys allow)))
 305                                 (list 'setq var (list 'cdr (list 'cdr var))))
 306                           (list (list 'car
 307                                       (list 'cdr
 308                                             (list 'memq (cons 'quote allow)
 309                                                   restarg)))
 310                                 (list 'setq var nil))
 311                           (list t
 312                                 (list
 313                                  'error
 314                                  (format "Keyword argument %%s not one of %s"
 315                                          keys)
 316                                  (list 'car var)))))))
 317             (cl-push (list 'let (list (list var restarg)) check) bind-forms)))
 318       (while (and (eq (car args) '&aux) (cl-pop args))
 319         (while (and args (not (memq (car args) lambda-list-keywords)))
 320           (if (consp (car args))
 321               (if (and bind-enquote (cadar args))
 322                   (cl-do-arglist (caar args)
 323                                  (list 'quote (cadr (cl-pop args))))
 324                 (cl-do-arglist (caar args) (cadr (cl-pop args))))
 325             (cl-do-arglist (cl-pop args) nil))))
 326       (if args (error "Malformed argument list %s" save-args)))))
 327
 328 (defun cl-arglist-args (args)
 329   (if (nlistp args) (list args)
 330     (let ((res nil) (kind nil) arg)
 331       (while (consp args)
 332         (setq arg (cl-pop args))
 333         (if (memq arg lambda-list-keywords) (setq kind arg)
 334           (if (eq arg '&cl-defs) (cl-pop args)
 335             (and (consp arg) kind (setq arg (car arg)))
 336             (and (consp arg) (cdr arg) (eq kind '&key) (setq arg (cadr arg)))
 337             (setq res (nconc res (cl-arglist-args arg))))))
 338       (nconc res (and args (list args))))))
 339
 340 ;;;###autoload
 341 (defmacro destructuring-bind (args expr &rest body)
 342   (let* ((bind-lets nil) (bind-forms nil) (bind-inits nil)
 343          (bind-defs nil) (bind-block 'cl-none))
 344     (cl-do-arglist (or args '(&aux)) expr)
 345     (append '(progn) bind-inits
 346             (list (nconc (list 'let* (nreverse bind-lets))
 347                          (nreverse bind-forms) body)))))
 348
 349
 350 ;;; The `eval-when' form.
 351
 352 (defvar cl-not-toplevel nil)
 353
 354 ;;;###autoload
 355 (defmacro eval-when (when &rest body)
 356   "(eval-when (WHEN...) BODY...): control when BODY is evaluated.
 357 If `compile' is in WHEN, BODY is evaluated when compiled at top-level.
 358 If `load' is in WHEN, BODY is evaluated when loaded after top-level compile.
 359 If `eval' is in WHEN, BODY is evaluated when interpreted or at non-top-level."
 360   (if (and (fboundp 'cl-compiling-file) (cl-compiling-file)
 361            (not cl-not-toplevel) (not (boundp 'for-effect)))  ; horrible kludge
 362       (let ((comp (or (memq 'compile when) (memq ':compile-toplevel when)))
 363             (cl-not-toplevel t))
 364         (if (or (memq 'load when) (memq ':load-toplevel when))
 365             (if comp (cons 'progn (mapcar 'cl-compile-time-too body))
 366               (list* 'if nil nil body))
 367           (progn (if comp (eval (cons 'progn body))) nil)))
 368     (and (or (memq 'eval when) (memq ':execute when))
 369          (cons 'progn body))))
 370
 371 (defun cl-compile-time-too (form)
 372   (or (and (symbolp (car-safe form)) (get (car-safe form) 'byte-hunk-handler))
 373       (setq form (macroexpand
 374                   form (cons '(eval-when) byte-compile-macro-environment))))
 375   (cond ((eq (car-safe form) 'progn)
 376          (cons 'progn (mapcar 'cl-compile-time-too (cdr form))))
 377         ((eq (car-safe form) 'eval-when)
 378          (let ((when (nth 1 form)))
 379            (if (or (memq 'eval when) (memq ':execute when))
 380                (list* 'eval-when (cons 'compile when) (cddr form))
 381              form)))
 382         (t (eval form) form)))
 383
 384 (or (and (fboundp 'eval-when-compile)
 385          (not (eq (car-safe (symbol-function 'eval-when-compile)) 'autoload)))
 386     (eval '(defmacro eval-when-compile (&rest body)
 387              "Like `progn', but evaluates the body at compile time.
 388 The result of the body appears to the compiler as a quoted constant."
 389              (list 'quote (eval (cons 'progn body))))))
 390
 391 ;;;###autoload
 392 (defmacro load-time-value (form &optional read-only)
 393   "Like `progn', but evaluates the body at load time.
 394 The result of the body appears to the compiler as a quoted constant."
 395   (if (cl-compiling-file)
 396       (let* ((temp (gentemp "--cl-load-time--"))
 397              (set (list 'set (list 'quote temp) form)))
 398         (if (and (fboundp 'byte-compile-file-form-defmumble)
 399                  (boundp 'this-kind) (boundp 'that-one))
 400             (fset 'byte-compile-file-form
 401                   (list 'lambda '(form)
 402                         (list 'fset '(quote byte-compile-file-form)
 403                               (list 'quote
 404                                     (symbol-function 'byte-compile-file-form)))
 405                         (list 'byte-compile-file-form (list 'quote set))
 406                         '(byte-compile-file-form form)))
 407           ;; XEmacs change
 408           (print set (symbol-value ;;'outbuffer
 409                                    'byte-compile-output-buffer
 410                                    )))
 411         (list 'symbol-value (list 'quote temp)))
 412     (list 'quote (eval form))))
 413
 414
 415 ;;; Conditional control structures.
 416
 417 ;;;###autoload
 418 (defmacro case (expr &rest clauses)
 419   "(case EXPR CLAUSES...): evals EXPR, chooses from CLAUSES on that value.
 420 Each clause looks like (KEYLIST BODY...).  EXPR is evaluated and compared
 421 against each key in each KEYLIST; the corresponding BODY is evaluated.
 422 If no clause succeeds, case returns nil.  A single atom may be used in
 423 place of a KEYLIST of one atom.  A KEYLIST of `t' or `otherwise' is
 424 allowed only in the final clause, and matches if no other keys match.
 425 Key values are compared by `eql'."
 426   (let* ((temp (if (cl-simple-expr-p expr 3) expr (gensym)))
 427          (head-list nil)
 428          (last-clause (car (last clauses)))
 429          (body (cons
 430                 'cond
 431                 (mapcar
 432                  #'(lambda (c)
 433                      (cons (cond ((memq (car c) '(t otherwise))
 434                                   (or (eq c last-clause)
 435                                       (error
 436                                        "`%s' is allowed only as the last case clause"
 437                                        (car c)))
 438                                   t)
 439                                  ((eq (car c) 'ecase-error-flag)
 440                                   (list 'error "ecase failed: %s, %s"
 441                                         temp (list 'quote (reverse head-list))))
 442                                  ((listp (car c))
 443                                   (setq head-list (append (car c) head-list))
 444                                   (list 'member* temp (list 'quote (car c))))
 445                                  (t
 446                                   (if (memq (car c) head-list)
 447                                       (error "Duplicate key in case: %s"
 448                                              (car c)))
 449                                   (cl-push (car c) head-list)
 450                                   (list 'eql temp (list 'quote (car c)))))
 451                            (or (cdr c) '(nil))))
 452                  clauses))))
 453     (if (eq temp expr) body
 454       (list 'let (list (list temp expr)) body))))
 455
 456 ;; #### CL standard also requires `ccase', which signals a continuable
 457 ;; error (`cerror' in XEmacs).  However, I don't think it buys us
 458 ;; anything to introduce it, as there is probably much more CL stuff
 459 ;; missing, and the feature is not essential.  --hniksic
 460
 461 ;;;###autoload
 462 (defmacro ecase (expr &rest clauses)
 463   "(ecase EXPR CLAUSES...): like `case', but error if no case fits.
 464 `otherwise'-clauses are not allowed."
 465   (let ((disallowed (or (assq t clauses)
 466                         (assq 'otherwise clauses))))
 467     (if disallowed
 468         (error "`%s' is not allowed in ecase" (car disallowed))))
 469   (list* 'case expr (append clauses '((ecase-error-flag)))))
 470
 471 ;;;###autoload
 472 (defmacro typecase (expr &rest clauses)
 473   "(typecase EXPR CLAUSES...): evals EXPR, chooses from CLAUSES on that value.
 474 Each clause looks like (TYPE BODY...).  EXPR is evaluated and, if it
 475 satisfies TYPE, the corresponding BODY is evaluated.  If no clause succeeds,
 476 typecase returns nil.  A TYPE of `t' or `otherwise' is allowed only in the
 477 final clause, and matches if no other keys match."
 478   (let* ((temp (if (cl-simple-expr-p expr 3) expr (gensym)))
 479          (type-list nil)
 480          (body (cons
 481                 'cond
 482                 (mapcar
 483                  #'(lambda (c)
 484                      (cons (cond ((eq (car c) 'otherwise) t)
 485                                  ((eq (car c) 'ecase-error-flag)
 486                                   (list 'error "etypecase failed: %s, %s"
 487                                         temp (list 'quote (reverse type-list))))
 488                                  (t
 489                                   (cl-push (car c) type-list)
 490                                   (cl-make-type-test temp (car c))))
 491                            (or (cdr c) '(nil))))
 492                  clauses))))
 493     (if (eq temp expr) body
 494       (list 'let (list (list temp expr)) body))))
 495
 496 ;;;###autoload
 497 (defmacro etypecase (expr &rest clauses)
 498   "(etypecase EXPR CLAUSES...): like `typecase', but error if no case fits.
 499 `otherwise'-clauses are not allowed."
 500   (list* 'typecase expr (append clauses '((ecase-error-flag)))))
 501
 502
 503 ;;; Blocks and exits.
 504
 505 ;;;###autoload
 506 (defmacro block (name &rest body)
 507   "(block NAME BODY...): define a lexically-scoped block named NAME.
 508 NAME may be any symbol.  Code inside the BODY forms can call `return-from'
 509 to jump prematurely out of the block.  This differs from `catch' and `throw'
 510 in two respects:  First, the NAME is an unevaluated symbol rather than a
 511 quoted symbol or other form; and second, NAME is lexically rather than
 512 dynamically scoped:  Only references to it within BODY will work.  These
 513 references may appear inside macro expansions, but not inside functions
 514 called from BODY."
 515   (if (cl-safe-expr-p (cons 'progn body)) (cons 'progn body)
 516     (list 'cl-block-wrapper
 517           (list* 'catch (list 'quote (intern (format "--cl-block-%s--" name)))
 518                  body))))
 519
 520 (defvar cl-active-block-names nil)
 521
 522 (put 'cl-block-wrapper 'byte-compile 'cl-byte-compile-block)
 523 (defun cl-byte-compile-block (cl-form)
 524   (if (fboundp 'byte-compile-form-do-effect)  ; Check for optimizing compiler
 525       (progn
 526         (let* ((cl-entry (cons (nth 1 (nth 1 (nth 1 cl-form))) nil))
 527                (cl-active-block-names (cons cl-entry cl-active-block-names))
 528                (cl-body (byte-compile-top-level
 529                          (cons 'progn (cddr (nth 1 cl-form))))))
 530           (if (cdr cl-entry)
 531               (byte-compile-form (list 'catch (nth 1 (nth 1 cl-form)) cl-body))
 532             (byte-compile-form cl-body))))
 533     (byte-compile-form (nth 1 cl-form))))
 534
 535 (put 'cl-block-throw 'byte-compile 'cl-byte-compile-throw)
 536 (defun cl-byte-compile-throw (cl-form)
 537   (let ((cl-found (assq (nth 1 (nth 1 cl-form)) cl-active-block-names)))
 538     (if cl-found (setcdr cl-found t)))
 539   (byte-compile-normal-call (cons 'throw (cdr cl-form))))
 540
 541 ;;;###autoload
 542 (defmacro return (&optional res)
 543   "(return [RESULT]): return from the block named nil.
 544 This is equivalent to `(return-from nil RESULT)'."
 545   (list 'return-from nil res))
 546
 547 ;;;###autoload
 548 (defmacro return-from (name &optional res)
 549   "(return-from NAME [RESULT]): return from the block named NAME.
 550 This jumps out to the innermost enclosing `(block NAME ...)' form,
 551 returning RESULT from that form (or nil if RESULT is omitted).
 552 This is compatible with Common Lisp, but note that `defun' and
 553 `defmacro' do not create implicit blocks as they do in Common Lisp."
 554   (let ((name2 (intern (format "--cl-block-%s--" name))))
 555     (list 'cl-block-throw (list 'quote name2) res)))
 556
 557
 558 ;;; The "loop" macro.
 559
 560 (defvar args) (defvar loop-accum-var) (defvar loop-accum-vars)
 561 (defvar loop-bindings) (defvar loop-body) (defvar loop-destr-temps)
 562 (defvar loop-finally) (defvar loop-finish-flag) (defvar loop-first-flag)
 563 (defvar loop-initially) (defvar loop-map-form) (defvar loop-name)
 564 (defvar loop-result) (defvar loop-result-explicit)
 565 (defvar loop-result-var) (defvar loop-steps) (defvar loop-symbol-macs)
 566
 567 ;;;###autoload
 568 (defmacro loop (&rest args)
 569   "(loop CLAUSE...): The Common Lisp `loop' macro.
 570 Valid clauses are:
 571   for VAR from/upfrom/downfrom NUM to/upto/downto/above/below NUM by NUM,
 572   for VAR in LIST by FUNC, for VAR on LIST by FUNC, for VAR = INIT then EXPR,
 573   for VAR across ARRAY, repeat NUM, with VAR = INIT, while COND, until COND,
 574   always COND, never COND, thereis COND, collect EXPR into VAR,
 575   append EXPR into VAR, nconc EXPR into VAR, sum EXPR into VAR,
 576   count EXPR into VAR, maximize EXPR into VAR, minimize EXPR into VAR,
 577   if COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...],
 578   unless COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...],
 579   do EXPRS..., initially EXPRS..., finally EXPRS..., return EXPR,
 580   finally return EXPR, named NAME."
 581   (if (not (memq t (mapcar 'symbolp (delq nil (delq t (copy-list args))))))
 582       (list 'block nil (list* 'while t args))
 583     (let ((loop-name nil)       (loop-bindings nil)
 584           (loop-body nil)       (loop-steps nil)
 585           (loop-result nil)     (loop-result-explicit nil)
 586           (loop-result-var nil) (loop-finish-flag nil)
 587           (loop-accum-var nil)  (loop-accum-vars nil)
 588           (loop-initially nil)  (loop-finally nil)
 589           (loop-map-form nil)   (loop-first-flag nil)
 590           (loop-destr-temps nil) (loop-symbol-macs nil))
 591       (setq args (append args '(cl-end-loop)))
 592       (while (not (eq (car args) 'cl-end-loop)) (cl-parse-loop-clause))
 593       (if loop-finish-flag
 594           (cl-push (list (list loop-finish-flag t)) loop-bindings))
 595       (if loop-first-flag
 596           (progn (cl-push (list (list loop-first-flag t)) loop-bindings)
 597                  (cl-push (list 'setq loop-first-flag nil) loop-steps)))
 598       (let* ((epilogue (nconc (nreverse loop-finally)
 599                               (list (or loop-result-explicit loop-result))))
 600              (ands (cl-loop-build-ands (nreverse loop-body)))
 601              (while-body (nconc (cadr ands) (nreverse loop-steps)))
 602              (body (append
 603                     (nreverse loop-initially)
 604                     (list (if loop-map-form
 605                               (list 'block '--cl-finish--
 606                                     (subst
 607                                      (if (eq (car ands) t) while-body
 608                                        (cons (list 'or (car ands)
 609                                                    '(return-from --cl-finish--
 610                                                       nil))
 611                                              while-body))
 612                                      '--cl-map loop-map-form))
 613                             (list* 'while (car ands) while-body)))
 614                     (if loop-finish-flag
 615                         (if (equal epilogue '(nil)) (list loop-result-var)
 616                           (list (list 'if loop-finish-flag
 617                                       (cons 'progn epilogue) loop-result-var)))
 618                       epilogue))))
 619         (if loop-result-var (cl-push (list loop-result-var) loop-bindings))
 620         (while loop-bindings
 621           (if (cdar loop-bindings)
 622               (setq body (list (cl-loop-let (cl-pop loop-bindings) body t)))
 623             (let ((lets nil))
 624               (while (and loop-bindings
 625                           (not (cdar loop-bindings)))
 626                 (cl-push (car (cl-pop loop-bindings)) lets))
 627               (setq body (list (cl-loop-let lets body nil))))))
 628         (if loop-symbol-macs
 629             (setq body (list (list* 'symbol-macrolet loop-symbol-macs body))))
 630         (list* 'block loop-name body)))))
 631
 632 (defun cl-parse-loop-clause ()   ; uses args, loop-*
 633   (let ((word (cl-pop args))
 634         (hash-types '(hash-key hash-keys hash-value hash-values))
 635         (key-types '(key-code key-codes key-seq key-seqs
 636                      key-binding key-bindings)))
 637     (cond
 638
 639      ((null args)
 640       (error "Malformed `loop' macro"))
 641
 642      ((eq word 'named)
 643       (setq loop-name (cl-pop args)))
 644
 645      ((eq word 'initially)
 646       (if (memq (car args) '(do doing)) (cl-pop args))
 647       (or (consp (car args)) (error "Syntax error on `initially' clause"))
 648       (while (consp (car args))
 649         (cl-push (cl-pop args) loop-initially)))
 650
 651      ((eq word 'finally)
 652       (if (eq (car args) 'return)
 653           (setq loop-result-explicit (or (cl-pop2 args) '(quote nil)))
 654         (if (memq (car args) '(do doing)) (cl-pop args))
 655         (or (consp (car args)) (error "Syntax error on `finally' clause"))
 656         (if (and (eq (caar args) 'return) (null loop-name))
 657             (setq loop-result-explicit (or (nth 1 (cl-pop args)) '(quote nil)))
 658           (while (consp (car args))
 659             (cl-push (cl-pop args) loop-finally)))))
 660
 661      ((memq word '(for as))
 662       (let ((loop-for-bindings nil) (loop-for-sets nil) (loop-for-steps nil)
 663             (ands nil))
 664         (while
 665             (let ((var (or (cl-pop args) (gensym))))
 666               (setq word (cl-pop args))
 667               (if (eq word 'being) (setq word (cl-pop args)))
 668               (if (memq word '(the each)) (setq word (cl-pop args)))
 669               (if (memq word '(buffer buffers))
 670                   (setq word 'in args (cons '(buffer-list) args)))
 671               (cond
 672
 673                ((memq word '(from downfrom upfrom to downto upto
 674                              above below by))
 675                 (cl-push word args)
 676                 (if (memq (car args) '(downto above))
 677                     (error "Must specify `from' value for downward loop"))
 678                 (let* ((down (or (eq (car args) 'downfrom)
 679                                  (memq (caddr args) '(downto above))))
 680                        (excl (or (memq (car args) '(above below))
 681                                  (memq (caddr args) '(above below))))
 682                        (start (and (memq (car args) '(from upfrom downfrom))
 683                                    (cl-pop2 args)))
 684                        (end (and (memq (car args)
 685                                        '(to upto downto above below))
 686                                  (cl-pop2 args)))
 687                        (step (and (eq (car args) 'by) (cl-pop2 args)))
 688                        (end-var (and (not (cl-const-expr-p end)) (gensym)))
 689                        (step-var (and (not (cl-const-expr-p step))
 690                                       (gensym))))
 691                   (and step (numberp step) (<= step 0)
 692                        (error "Loop `by' value is not positive: %s" step))
 693                   (cl-push (list var (or start 0)) loop-for-bindings)
 694                   (if end-var (cl-push (list end-var end) loop-for-bindings))
 695                   (if step-var (cl-push (list step-var step)
 696                                         loop-for-bindings))
 697                   (if end
 698                       (cl-push (list
 699                                 (if down (if excl '> '>=) (if excl '< '<=))
 700                                 var (or end-var end)) loop-body))
 701                   (cl-push (list var (list (if down '- '+) var
 702                                            (or step-var step 1)))
 703                            loop-for-steps)))
 704
 705                ((memq word '(in in-ref on))
 706                 (let* ((on (eq word 'on))
 707                        (temp (if (and on (symbolp var)) var (gensym))))
 708                   (cl-push (list temp (cl-pop args)) loop-for-bindings)
 709                   (cl-push (list 'consp temp) loop-body)
 710                   (if (eq word 'in-ref)
 711                       (cl-push (list var (list 'car temp)) loop-symbol-macs)
 712                     (or (eq temp var)
 713                         (progn
 714                           (cl-push (list var nil) loop-for-bindings)
 715                           (cl-push (list var (if on temp (list 'car temp)))
 716                                    loop-for-sets))))
 717                   (cl-push (list temp
 718                                  (if (eq (car args) 'by)
 719                                      (let ((step (cl-pop2 args)))
 720                                        (if (and (memq (car-safe step)
 721                                                       '(quote function
 722                                                               function*))
 723                                                 (symbolp (nth 1 step)))
 724                                            (list (nth 1 step) temp)
 725                                          (list 'funcall step temp)))
 726                                    (list 'cdr temp)))
 727                            loop-for-steps)))
 728
 729                ((eq word '=)
 730                 (let* ((start (cl-pop args))
 731                        (then (if (eq (car args) 'then) (cl-pop2 args) start)))
 732                   (cl-push (list var nil) loop-for-bindings)
 733                   (if (or ands (eq (car args) 'and))
 734                       (progn
 735                         (cl-push (list var
 736                                        (list 'if
 737                                              (or loop-first-flag
 738                                                  (setq loop-first-flag
 739                                                        (gensym)))
 740                                              start var))
 741                                  loop-for-sets)
 742                         (cl-push (list var then) loop-for-steps))
 743                     (cl-push (list var
 744                                    (if (eq start then) start
 745                                      (list 'if
 746                                            (or loop-first-flag
 747                                                (setq loop-first-flag (gensym)))
 748                                            start then)))
 749                              loop-for-sets))))
 750
 751                ((memq word '(across across-ref))
 752                 (let ((temp-vec (gensym)) (temp-idx (gensym)))
 753                   (cl-push (list temp-vec (cl-pop args)) loop-for-bindings)
 754                   (cl-push (list temp-idx -1) loop-for-bindings)
 755                   (cl-push (list '< (list 'setq temp-idx (list '1+ temp-idx))
 756                                  (list 'length temp-vec)) loop-body)
 757                   (if (eq word 'across-ref)
 758                       (cl-push (list var (list 'aref temp-vec temp-idx))
 759                                loop-symbol-macs)
 760                     (cl-push (list var nil) loop-for-bindings)
 761                     (cl-push (list var (list 'aref temp-vec temp-idx))
 762                              loop-for-sets))))
 763
 764                ((memq word '(element elements))
 765                 (let ((ref (or (memq (car args) '(in-ref of-ref))
 766                                (and (not (memq (car args) '(in of)))
 767                                     (error "Expected `of'"))))
 768                       (seq (cl-pop2 args))
 769                       (temp-seq (gensym))
 770                       (temp-idx (if (eq (car args) 'using)
 771                                     (if (and (= (length (cadr args)) 2)
 772                                              (eq (caadr args) 'index))
 773                                         (cadr (cl-pop2 args))
 774                                       (error "Bad `using' clause"))
 775                                   (gensym))))
 776                   (cl-push (list temp-seq seq) loop-for-bindings)
 777                   (cl-push (list temp-idx 0) loop-for-bindings)
 778                   (if ref
 779                       (let ((temp-len (gensym)))
 780                         (cl-push (list temp-len (list 'length temp-seq))
 781                                  loop-for-bindings)
 782                         (cl-push (list var (list 'elt temp-seq temp-idx))
 783                                  loop-symbol-macs)
 784                         (cl-push (list '< temp-idx temp-len) loop-body))
 785                     (cl-push (list var nil) loop-for-bindings)
 786                     (cl-push (list 'and temp-seq
 787                                    (list 'or (list 'consp temp-seq)
 788                                          (list '< temp-idx
 789                                                (list 'length temp-seq))))
 790                              loop-body)
 791                     (cl-push (list var (list 'if (list 'consp temp-seq)
 792                                              (list 'pop temp-seq)
 793                                              (list 'aref temp-seq temp-idx)))
 794                              loop-for-sets))
 795                   (cl-push (list temp-idx (list '1+ temp-idx))
 796                            loop-for-steps)))
 797
 798                ((memq word hash-types)
 799                 (or (memq (car args) '(in of)) (error "Expected `of'"))
 800                 (let* ((table (cl-pop2 args))
 801                        (other (if (eq (car args) 'using)
 802                                   (if (and (= (length (cadr args)) 2)
 803                                            (memq (caadr args) hash-types)
 804                                            (not (eq (caadr args) word)))
 805                                       (cadr (cl-pop2 args))
 806                                     (error "Bad `using' clause"))
 807                                 (gensym))))
 808                   (if (memq word '(hash-value hash-values))
 809                       (setq var (prog1 other (setq other var))))
 810                   (setq loop-map-form
 811                         (list 'maphash (list 'function
 812                                              (list* 'lambda (list var other)
 813                                                     '--cl-map)) table))))
 814
 815                ((memq word '(symbol present-symbol external-symbol
 816                              symbols present-symbols external-symbols))
 817                 (let ((ob (and (memq (car args) '(in of)) (cl-pop2 args))))
 818                   (setq loop-map-form
 819                         (list 'mapatoms (list 'function
 820                                               (list* 'lambda (list var)
 821                                                      '--cl-map)) ob))))
 822
 823                ((memq word '(overlay overlays extent extents))
 824                 (let ((buf nil) (from nil) (to nil))
 825                   (while (memq (car args) '(in of from to))
 826                     (cond ((eq (car args) 'from) (setq from (cl-pop2 args)))
 827                           ((eq (car args) 'to) (setq to (cl-pop2 args)))
 828                           (t (setq buf (cl-pop2 args)))))
 829                   (setq loop-map-form
 830                         (list 'cl-map-extents
 831                               (list 'function (list 'lambda (list var (gensym))
 832                                                     '(progn . --cl-map) nil))
 833                               buf from to))))
 834
 835                ((memq word '(interval intervals))
 836                 (let ((buf nil) (prop nil) (from nil) (to nil)
 837                       (var1 (gensym)) (var2 (gensym)))
 838                   (while (memq (car args) '(in of property from to))
 839                     (cond ((eq (car args) 'from) (setq from (cl-pop2 args)))
 840                           ((eq (car args) 'to) (setq to (cl-pop2 args)))
 841                           ((eq (car args) 'property)
 842                            (setq prop (cl-pop2 args)))
 843                           (t (setq buf (cl-pop2 args)))))
 844                   (if (and (consp var) (symbolp (car var)) (symbolp (cdr var)))
 845                       (setq var1 (car var) var2 (cdr var))
 846                     (cl-push (list var (list 'cons var1 var2)) loop-for-sets))
 847                   (setq loop-map-form
 848                         (list 'cl-map-intervals
 849                               (list 'function (list 'lambda (list var1 var2)
 850                                                     '(progn . --cl-map)))
 851                               buf prop from to))))
 852
 853                ((memq word key-types)
 854                 (or (memq (car args) '(in of)) (error "Expected `of'"))
 855                 (let ((map (cl-pop2 args))
 856                       (other (if (eq (car args) 'using)
 857                                  (if (and (= (length (cadr args)) 2)
 858                                           (memq (caadr args) key-types)
 859                                           (not (eq (caadr args) word)))
 860                                      (cadr (cl-pop2 args))
 861                                    (error "Bad `using' clause"))
 862                                (gensym))))
 863                   (if (memq word '(key-binding key-bindings))
 864                       (setq var (prog1 other (setq other var))))
 865                   (setq loop-map-form
 866                         (list (if (memq word '(key-seq key-seqs))
 867                                   'cl-map-keymap-recursively 'cl-map-keymap)
 868                               (list 'function (list* 'lambda (list var other)
 869                                                      '--cl-map)) map))))
 870
 871                ((memq word '(frame frames screen screens))
 872                 (let ((temp (gensym)))
 873                   (cl-push (list var '(selected-frame))
 874                            loop-for-bindings)
 875                   (cl-push (list temp nil) loop-for-bindings)
 876                   (cl-push (list 'prog1 (list 'not (list 'eq var temp))
 877                                  (list 'or temp (list 'setq temp var)))
 878                            loop-body)
 879                   (cl-push (list var (list 'next-frame var))
 880                            loop-for-steps)))
 881
 882                ((memq word '(window windows))
 883                 (let ((scr (and (memq (car args) '(in of)) (cl-pop2 args)))
 884                       (temp (gensym)))
 885                   (cl-push (list var (if scr
 886                                          (list 'frame-selected-window scr)
 887                                        '(selected-window)))
 888                            loop-for-bindings)
 889                   (cl-push (list temp nil) loop-for-bindings)
 890                   (cl-push (list 'prog1 (list 'not (list 'eq var temp))
 891                                  (list 'or temp (list 'setq temp var)))
 892                            loop-body)
 893                   (cl-push (list var (list 'next-window var)) loop-for-steps)))
 894
 895                (t
 896                 (let ((handler (and (symbolp word)
 897                                     (get word 'cl-loop-for-handler))))
 898                   (if handler
 899                       (funcall handler var)
 900                     (error "Expected a `for' preposition, found %s" word)))))
 901               (eq (car args) 'and))
 902           (setq ands t)
 903           (cl-pop args))
 904         (if (and ands loop-for-bindings)
 905             (cl-push (nreverse loop-for-bindings) loop-bindings)
 906           (setq loop-bindings (nconc (mapcar 'list loop-for-bindings)
 907                                      loop-bindings)))
 908         (if loop-for-sets
 909             (cl-push (list 'progn
 910                            (cl-loop-let (nreverse loop-for-sets) 'setq ands)
 911                            t) loop-body))
 912         (if loop-for-steps
 913             (cl-push (cons (if ands 'psetq 'setq)
 914                            (apply 'append (nreverse loop-for-steps)))
 915                      loop-steps))))
 916
 917      ((eq word 'repeat)
 918       (let ((temp (gensym)))
 919         (cl-push (list (list temp (cl-pop args))) loop-bindings)
 920         (cl-push (list '>= (list 'setq temp (list '1- temp)) 0) loop-body)))
 921
 922      ((eq word 'collect)
 923       (let ((what (cl-pop args))
 924             (var (cl-loop-handle-accum nil 'nreverse)))
 925         (if (eq var loop-accum-var)
 926             (cl-push (list 'progn (list 'push what var) t) loop-body)
 927           (cl-push (list 'progn
 928                          (list 'setq var (list 'nconc var (list 'list what)))
 929                          t) loop-body))))
 930
 931      ((memq word '(nconc nconcing append appending))
 932       (let ((what (cl-pop args))
 933             (var (cl-loop-handle-accum nil 'nreverse)))
 934         (cl-push (list 'progn
 935                        (list 'setq var
 936                              (if (eq var loop-accum-var)
 937                                  (list 'nconc
 938                                        (list (if (memq word '(nconc nconcing))
 939                                                  'nreverse 'reverse)
 940                                              what)
 941                                        var)
 942                                (list (if (memq word '(nconc nconcing))
 943                                          'nconc 'append)
 944                                      var what))) t) loop-body)))
 945
 946      ((memq word '(concat concating))
 947       (let ((what (cl-pop args))
 948             (var (cl-loop-handle-accum "")))
 949         (cl-push (list 'progn (list 'callf 'concat var what) t) loop-body)))
 950
 951      ((memq word '(vconcat vconcating))
 952       (let ((what (cl-pop args))
 953             (var (cl-loop-handle-accum [])))
 954         (cl-push (list 'progn (list 'callf 'vconcat var what) t) loop-body)))
 955
 956      ((memq word '(sum summing))
 957       (let ((what (cl-pop args))
 958             (var (cl-loop-handle-accum 0)))
 959         (cl-push (list 'progn (list 'incf var what) t) loop-body)))
 960
 961      ((memq word '(count counting))
 962       (let ((what (cl-pop args))
 963             (var (cl-loop-handle-accum 0)))
 964         (cl-push (list 'progn (list 'if what (list 'incf var)) t) loop-body)))
 965
 966      ((memq word '(minimize minimizing maximize maximizing))
 967       (let* ((what (cl-pop args))
 968              (temp (if (cl-simple-expr-p what) what (gensym)))
 969              (var (cl-loop-handle-accum nil))
 970              (func (intern (substring (symbol-name word) 0 3)))
 971              (set (list 'setq var (list 'if var (list func var temp) temp))))
 972         (cl-push (list 'progn (if (eq temp what) set
 973                                 (list 'let (list (list temp what)) set))
 974                        t) loop-body)))
 975
 976      ((eq word 'with)
 977       (let ((bindings nil))
 978         (while (progn (cl-push (list (cl-pop args)
 979                                      (and (eq (car args) '=) (cl-pop2 args)))
 980                                bindings)
 981                       (eq (car args) 'and))
 982           (cl-pop args))
 983         (cl-push (nreverse bindings) loop-bindings)))
 984
 985      ((eq word 'while)
 986       (cl-push (cl-pop args) loop-body))
 987
 988      ((eq word 'until)
 989       (cl-push (list 'not (cl-pop args)) loop-body))
 990
 991      ((eq word 'always)
 992       (or loop-finish-flag (setq loop-finish-flag (gensym)))
 993       (cl-push (list 'setq loop-finish-flag (cl-pop args)) loop-body)
 994       (setq loop-result t))
 995
 996      ((eq word 'never)
 997       (or loop-finish-flag (setq loop-finish-flag (gensym)))
 998       (cl-push (list 'setq loop-finish-flag (list 'not (cl-pop args)))
 999                loop-body)
1000       (setq loop-result t))
1001
1002      ((eq word 'thereis)
1003       (or loop-finish-flag (setq loop-finish-flag (gensym)))
1004       (or loop-result-var (setq loop-result-var (gensym)))
1005       (cl-push (list 'setq loop-finish-flag
1006                      (list 'not (list 'setq loop-result-var (cl-pop args))))
1007                loop-body))
1008
1009      ((memq word '(if when unless))
1010       (let* ((cond (cl-pop args))
1011              (then (let ((loop-body nil))
1012                      (cl-parse-loop-clause)
1013                      (cl-loop-build-ands (nreverse loop-body))))
1014              (else (let ((loop-body nil))
1015                      (if (eq (car args) 'else)
1016                          (progn (cl-pop args) (cl-parse-loop-clause)))
1017                      (cl-loop-build-ands (nreverse loop-body))))
1018              (simple (and (eq (car then) t) (eq (car else) t))))
1019         (if (eq (car args) 'end) (cl-pop args))
1020         (if (eq word 'unless) (setq then (prog1 else (setq else then))))
1021         (let ((form (cons (if simple (cons 'progn (nth 1 then)) (nth 2 then))
1022                           (if simple (nth 1 else) (list (nth 2 else))))))
1023           (if (cl-expr-contains form 'it)
1024               (let ((temp (gensym)))
1025                 (cl-push (list temp) loop-bindings)
1026                 (setq form (list* 'if (list 'setq temp cond)
1027                                   (subst temp 'it form))))
1028             (setq form (list* 'if cond form)))
1029           (cl-push (if simple (list 'progn form t) form) loop-body))))
1030
1031      ((memq word '(do doing))
1032       (let ((body nil))
1033         (or (consp (car args)) (error "Syntax error on `do' clause"))
1034         (while (consp (car args)) (cl-push (cl-pop args) body))
1035         (cl-push (cons 'progn (nreverse (cons t body))) loop-body)))
1036
1037      ((eq word 'return)
1038       (or loop-finish-flag (setq loop-finish-flag (gensym)))
1039       (or loop-result-var (setq loop-result-var (gensym)))
1040       (cl-push (list 'setq loop-result-var (cl-pop args)
1041                      loop-finish-flag nil) loop-body))
1042
1043      (t
1044       (let ((handler (and (symbolp word) (get word 'cl-loop-handler))))
1045         (or handler (error "Expected a loop keyword, found %s" word))
1046         (funcall handler))))
1047     (if (eq (car args) 'and)
1048         (progn (cl-pop args) (cl-parse-loop-clause)))))
1049
1050 (defun cl-loop-let (specs body par)   ; uses loop-*
1051   (let ((p specs) (temps nil) (new nil))
1052     (while (and p (or (symbolp (car-safe (car p))) (null (cadar p))))
1053       (setq p (cdr p)))
1054     (and par p
1055          (progn
1056            (setq par nil p specs)
1057            (while p
1058              (or (cl-const-expr-p (cadar p))
1059                  (let ((temp (gensym)))
1060                    (cl-push (list temp (cadar p)) temps)
1061                    (setcar (cdar p) temp)))
1062              (setq p (cdr p)))))
1063     (while specs
1064       (if (and (consp (car specs)) (listp (caar specs)))
1065           (let* ((spec (caar specs)) (nspecs nil)
1066                  (expr (cadr (cl-pop specs)))
1067                  (temp (cdr (or (assq spec loop-destr-temps)
1068                                 (car (cl-push (cons spec (or (last spec 0)
1069                                                              (gensym)))
1070                                               loop-destr-temps))))))
1071             (cl-push (list temp expr) new)
1072             (while (consp spec)
1073               (cl-push (list (cl-pop spec)
1074                              (and expr (list (if spec 'pop 'car) temp)))
1075                        nspecs))
1076             (setq specs (nconc (nreverse nspecs) specs)))
1077         (cl-push (cl-pop specs) new)))
1078     (if (eq body 'setq)
1079         (let ((set (cons (if par 'psetq 'setq) (apply 'nconc (nreverse new)))))
1080           (if temps (list 'let* (nreverse temps) set) set))
1081       (list* (if par 'let 'let*)
1082              (nconc (nreverse temps) (nreverse new)) body))))
1083
1084 (defun cl-loop-handle-accum (def &optional func)   ; uses args, loop-*
1085   (if (eq (car args) 'into)
1086       (let ((var (cl-pop2 args)))
1087         (or (memq var loop-accum-vars)
1088             (progn (cl-push (list (list var def)) loop-bindings)
1089                    (cl-push var loop-accum-vars)))
1090         var)
1091     (or loop-accum-var
1092         (progn
1093           (cl-push (list (list (setq loop-accum-var (gensym)) def))
1094                    loop-bindings)
1095           (setq loop-result (if func (list func loop-accum-var)
1096                               loop-accum-var))
1097           loop-accum-var))))
1098
1099 (defun cl-loop-build-ands (clauses)
1100   (let ((ands nil)
1101         (body nil))
1102     (while clauses
1103       (if (and (eq (car-safe (car clauses)) 'progn)
1104                (eq (car (last (car clauses))) t))
1105           (if (cdr clauses)
1106               (setq clauses (cons (nconc (butlast (car clauses))
1107                                          (if (eq (car-safe (cadr clauses))
1108                                                  'progn)
1109                                              (cdadr clauses)
1110                                            (list (cadr clauses))))
1111                                   (cddr clauses)))
1112             (setq body (cdr (butlast (cl-pop clauses)))))
1113         (cl-push (cl-pop clauses) ands)))
1114     (setq ands (or (nreverse ands) (list t)))
1115     (list (if (cdr ands) (cons 'and ands) (car ands))
1116           body
1117           (let ((full (if body
1118                           (append ands (list (cons 'progn (append body '(t)))))
1119                         ands)))
1120             (if (cdr full) (cons 'and full) (car full))))))
1121
1122
1123 ;;; Other iteration control structures.
1124
1125 ;;;###autoload
1126 (defmacro do (steps endtest &rest body)
1127   "The Common Lisp `do' loop.
1128 Format is: (do ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
1129   (cl-expand-do-loop steps endtest body nil))
1130
1131 ;;;###autoload
1132 (defmacro do* (steps endtest &rest body)
1133   "The Common Lisp `do*' loop.
1134 Format is: (do* ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
1135   (cl-expand-do-loop steps endtest body t))
1136
1137 (defun cl-expand-do-loop (steps endtest body star)
1138   (list 'block nil
1139         (list* (if star 'let* 'let)
1140                (mapcar #'(lambda (c) (if (consp c) (list (car c) (nth 1 c)) c))
1141                        steps)
1142                (list* 'while (list 'not (car endtest))
1143                       (append body
1144                               (let ((sets (mapcar
1145                                            #'(lambda (c)
1146                                                (and (consp c) (cdr (cdr c))
1147                                                     (list (car c) (nth 2 c))))
1148                                            steps)))
1149                                 (setq sets (delq nil sets))
1150                                 (and sets
1151                                      (list (cons (if (or star (not (cdr sets)))
1152                                                      'setq 'psetq)
1153                                                  (apply 'append sets)))))))
1154                (or (cdr endtest) '(nil)))))
1155
1156 ;;;###autoload
1157 (defmacro dolist (spec &rest body)
1158   "(dolist (VAR LIST [RESULT]) BODY...): loop over a list.
1159 Evaluate BODY with VAR bound to each `car' from LIST, in turn.
1160 Then evaluate RESULT to get return value, default nil."
1161   (let ((temp (gensym "--dolist-temp--")))
1162     (list 'block nil
1163           (list* 'let (list (list temp (nth 1 spec)) (car spec))
1164                  (list* 'while temp (list 'setq (car spec) (list 'car temp))
1165                         (append body (list (list 'setq temp
1166                                                  (list 'cdr temp)))))
1167                  (if (cdr (cdr spec))
1168                      (cons (list 'setq (car spec) nil) (cdr (cdr spec)))
1169                    '(nil))))))
1170
1171 ;;;###autoload
1172 (defmacro dotimes (spec &rest body)
1173   "(dotimes (VAR COUNT [RESULT]) BODY...): loop a certain number of times.
1174 Evaluate BODY with VAR bound to successive integers from 0, inclusive,
1175 to COUNT, exclusive.  Then evaluate RESULT to get return value, default
1176 nil."
1177   (let ((temp (gensym "--dotimes-temp--")))
1178     (list 'block nil
1179           (list* 'let (list (list temp (nth 1 spec)) (list (car spec) 0))
1180                  (list* 'while (list '< (car spec) temp)
1181                         (append body (list (list 'incf (car spec)))))
1182                  (or (cdr (cdr spec)) '(nil))))))
1183
1184 ;;;###autoload
1185 (defmacro do-symbols (spec &rest body)
1186   "(dosymbols (VAR [OBARRAY [RESULT]]) BODY...): loop over all symbols.
1187 Evaluate BODY with VAR bound to each interned symbol, or to each symbol
1188 from OBARRAY."
1189   ;; Apparently this doesn't have an implicit block.
1190   (list 'block nil
1191         (list 'let (list (car spec))
1192               (list* 'mapatoms
1193                      (list 'function (list* 'lambda (list (car spec)) body))
1194                      (and (cadr spec) (list (cadr spec))))
1195               (caddr spec))))
1196
1197 ;;;###autoload
1198 (defmacro do-all-symbols (spec &rest body)
1199   (list* 'do-symbols (list (car spec) nil (cadr spec)) body))
1200
1201
1202 ;;; Assignments.
1203
1204 ;;;###autoload
1205 (defmacro psetq (&rest args)
1206   "(psetq SYM VAL SYM VAL ...): set SYMs to the values VALs in parallel.
1207 This is like `setq', except that all VAL forms are evaluated (in order)
1208 before assigning any symbols SYM to the corresponding values."
1209   (cons 'psetf args))
1210
1211
1212 ;;; Binding control structures.
1213
1214 ;;;###autoload
1215 (defmacro progv (symbols values &rest body)
1216   "(progv SYMBOLS VALUES BODY...): bind SYMBOLS to VALUES dynamically in BODY.
1217 The forms SYMBOLS and VALUES are evaluated, and must evaluate to lists.
1218 Each SYMBOL in the first list is bound to the corresponding VALUE in the
1219 second list (or made unbound if VALUES is shorter than SYMBOLS); then the
1220 BODY forms are executed and their result is returned.  This is much like
1221 a `let' form, except that the list of symbols can be computed at run-time."
1222   (list 'let '((cl-progv-save nil))
1223         (list 'unwind-protect
1224               (list* 'progn (list 'cl-progv-before symbols values) body)
1225               '(cl-progv-after))))
1226
1227 ;;; This should really have some way to shadow 'byte-compile properties, etc.
1228 ;;;###autoload
1229 (defmacro flet (bindings &rest body)
1230   "(flet ((FUNC ARGLIST BODY...) ...) FORM...): make temporary function defns.
1231 This is an analogue of `let' that operates on the function cell of FUNC
1232 rather than its value cell.  The FORMs are evaluated with the specified
1233 function definitions in place, then the definitions are undone (the FUNCs
1234 go back to their previous definitions, or lack thereof)."
1235   (list* 'letf*
1236          (mapcar
1237           #'(lambda (x)
1238               (if (or (and (fboundp (car x))
1239                            (eq (car-safe (symbol-function (car x))) 'macro))
1240                       (cdr (assq (car x) cl-macro-environment)))
1241                   (error "Use `labels', not `flet', to rebind macro names"))
1242               (let ((func (list 'function*
1243                                 (list 'lambda (cadr x)
1244                                       (list* 'block (car x) (cddr x))))))
1245                 (if (and (cl-compiling-file)
1246                          (boundp 'byte-compile-function-environment))
1247                     (cl-push (cons (car x) (eval func))
1248                              byte-compile-function-environment))
1249                 (list (list 'symbol-function (list 'quote (car x))) func)))
1250           bindings)
1251          body))
1252
1253 ;;;###autoload
1254 (defmacro labels (bindings &rest body)
1255   "(labels ((FUNC ARGLIST BODY...) ...) FORM...): make temporary func bindings.
1256 This is like `flet', except the bindings are lexical instead of dynamic.
1257 Unlike `flet', this macro is fully compliant with the Common Lisp standard."
1258   (let ((vars nil) (sets nil) (cl-macro-environment cl-macro-environment))
1259     (while bindings
1260       (let ((var (gensym)))
1261         (cl-push var vars)
1262         (cl-push (list 'function* (cons 'lambda (cdar bindings))) sets)
1263         (cl-push var sets)
1264         (cl-push (list (car (cl-pop bindings)) 'lambda '(&rest cl-labels-args)
1265                        (list 'list* '(quote funcall) (list 'quote var)
1266                              'cl-labels-args))
1267                  cl-macro-environment)))
1268     (cl-macroexpand-all (list* 'lexical-let vars (cons (cons 'setq sets) body))
1269                         cl-macro-environment)))
1270
1271 ;; The following ought to have a better definition for use with newer
1272 ;; byte compilers.
1273 ;;;###autoload
1274 (defmacro macrolet (bindings &rest body)
1275   "(macrolet ((NAME ARGLIST BODY...) ...) FORM...): make temporary macro defns.
1276 This is like `flet', but for macros instead of functions."
1277   (if (cdr bindings)
1278       (list 'macrolet
1279             (list (car bindings)) (list* 'macrolet (cdr bindings) body))
1280     (if (null bindings) (cons 'progn body)
1281       (let* ((name (caar bindings))
1282              (res (cl-transform-lambda (cdar bindings) name)))
1283         (eval (car res))
1284         (cl-macroexpand-all (cons 'progn body)
1285                             (cons (list* name 'lambda (cdr res))
1286                                   cl-macro-environment))))))
1287
1288 ;;;###autoload
1289 (defmacro symbol-macrolet (bindings &rest body)
1290   "(symbol-macrolet ((NAME EXPANSION) ...) FORM...): make symbol macro defns.
1291 Within the body FORMs, references to the variable NAME will be replaced
1292 by EXPANSION, and (setq NAME ...) will act like (setf EXPANSION ...)."
1293   (if (cdr bindings)
1294       (list 'symbol-macrolet
1295             (list (car bindings)) (list* 'symbol-macrolet (cdr bindings) body))
1296     (if (null bindings) (cons 'progn body)
1297       (cl-macroexpand-all (cons 'progn body)
1298                           (cons (list (symbol-name (caar bindings))
1299                                       (cadar bindings))
1300                                 cl-macro-environment)))))
1301
1302 (defvar cl-closure-vars nil)
1303 ;;;###autoload
1304 (defmacro lexical-let (bindings &rest body)
1305   "(lexical-let BINDINGS BODY...): like `let', but lexically scoped.
1306 The main visible difference is that lambdas inside BODY will create
1307 lexical closures as in Common Lisp."
1308   (let* ((cl-closure-vars cl-closure-vars)
1309          (vars (mapcar #'(lambda (x)
1310                            (or (consp x) (setq x (list x)))
1311                            (cl-push (gensym (format "--%s--" (car x)))
1312                                     cl-closure-vars)
1313                            (list (car x) (cadr x) (car cl-closure-vars)))
1314                        bindings))
1315          (ebody
1316           (cl-macroexpand-all
1317            (cons 'progn body)
1318            (nconc (mapcar #'(lambda (x)
1319                               (list (symbol-name (car x))
1320                                     (list 'symbol-value (caddr x))
1321                                     t))
1322                           vars)
1323                   (list '(defun . cl-defun-expander))
1324                   cl-macro-environment))))
1325     (if (not (get (car (last cl-closure-vars)) 'used))
1326         (list 'let (mapcar #'(lambda (x) (list (caddr x) (cadr x))) vars)
1327               (sublis (mapcar #'(lambda (x)
1328                                   (cons (caddr x) (list 'quote (caddr x))))
1329                               vars)
1330                       ebody))
1331       (list 'let (mapcar #'(lambda (x)
1332                              (list (caddr x)
1333                                    (list 'make-symbol
1334                                          (format "--%s--" (car x)))))
1335                          vars)
1336             (apply 'append '(setf)
1337                    (mapcar #'(lambda (x)
1338                                (list (list 'symbol-value (caddr x)) (cadr x)))
1339                            vars))
1340             ebody))))
1341
1342 ;;;###autoload
1343 (defmacro lexical-let* (bindings &rest body)
1344   "(lexical-let* BINDINGS BODY...): like `let*', but lexically scoped.
1345 The main visible difference is that lambdas inside BODY will create
1346 lexical closures as in Common Lisp."
1347   (if (null bindings) (cons 'progn body)
1348     (setq bindings (reverse bindings))
1349     (while bindings
1350       (setq body (list (list* 'lexical-let (list (cl-pop bindings)) body))))
1351     (car body)))
1352
1353 (defun cl-defun-expander (func &rest rest)
1354   (list 'progn
1355         (list 'defalias (list 'quote func)
1356               (list 'function (cons 'lambda rest)))
1357         (list 'quote func)))
1358
1359
1360 ;;; Multiple values.
1361
1362 ;;;###autoload
1363 (defmacro multiple-value-bind (vars form &rest body)
1364   "(multiple-value-bind (SYM SYM...) FORM BODY): collect multiple return values.
1365 FORM must return a list; the BODY is then executed with the first N elements
1366 of this list bound (`let'-style) to each of the symbols SYM in turn.  This
1367 is analogous to the Common Lisp `multiple-value-bind' macro, using lists to
1368 simulate true multiple return values.  For compatibility, (values A B C) is
1369 a synonym for (list A B C)."
1370   (let ((temp (gensym)) (n -1))
1371     (list* 'let* (cons (list temp form)
1372                        (mapcar #'(lambda (v)
1373                                    (list v (list 'nth (setq n (1+ n)) temp)))
1374                                vars))
1375            body)))
1376
1377 ;;;###autoload
1378 (defmacro multiple-value-setq (vars form)
1379   "(multiple-value-setq (SYM SYM...) FORM): collect multiple return values.
1380 FORM must return a list; the first N elements of this list are stored in
1381 each of the symbols SYM in turn.  This is analogous to the Common Lisp
1382 `multiple-value-setq' macro, using lists to simulate true multiple return
1383 values.  For compatibility, (values A B C) is a synonym for (list A B C)."
1384   (cond ((null vars) (list 'progn form nil))
1385         ((null (cdr vars)) (list 'setq (car vars) (list 'car form)))
1386         (t
1387          (let* ((temp (gensym)) (n 0))
1388            (list 'let (list (list temp form))
1389                  (list 'prog1 (list 'setq (cl-pop vars) (list 'car temp))
1390                        (cons 'setq
1391                              (apply 'nconc
1392                                     (mapcar
1393                                      #'(lambda (v)
1394                                          (list v (list
1395                                                   'nth
1396                                                   (setq n (1+ n))
1397                                                   temp)))
1398                                             vars)))))))))
1399
1400
1401 ;;; Declarations.
1402
1403 ;;;###autoload
1404 (defmacro locally (&rest body) (cons 'progn body))
1405 ;;;###autoload
1406 (defmacro the (type form) form)
1407
1408 (defvar cl-proclaim-history t)    ; for future compilers
1409 (defvar cl-declare-stack t)       ; for future compilers
1410
1411 (defun cl-do-proclaim (spec hist)
1412   (and hist (listp cl-proclaim-history) (cl-push spec cl-proclaim-history))
1413   (cond ((eq (car-safe spec) 'special)
1414          (if (boundp 'byte-compile-bound-variables)
1415              (setq byte-compile-bound-variables
1416                    (append
1417                     (mapcar #'(lambda (v) (cons v byte-compile-global-bit))
1418                             (cdr spec))
1419                     byte-compile-bound-variables))))
1420
1421         ((eq (car-safe spec) 'inline)
1422          (while (setq spec (cdr spec))
1423            (or (memq (get (car spec) 'byte-optimizer)
1424                      '(nil byte-compile-inline-expand))
1425                (error "%s already has a byte-optimizer, can't make it inline"
1426                       (car spec)))
1427            (put (car spec) 'byte-optimizer 'byte-compile-inline-expand)))
1428
1429         ((eq (car-safe spec) 'notinline)
1430          (while (setq spec (cdr spec))
1431            (if (eq (get (car spec) 'byte-optimizer)
1432                    'byte-compile-inline-expand)
1433                (put (car spec) 'byte-optimizer nil))))
1434
1435         ((eq (car-safe spec) 'optimize)
1436          (let ((speed (assq (nth 1 (assq 'speed (cdr spec)))
1437                             '((0 . nil) (1 . t) (2 . t) (3 . t))))
1438                (safety (assq (nth 1 (assq 'safety (cdr spec)))
1439                              '((0 . t) (1 . t) (2 . t) (3 . nil)))))
1440            (when speed
1441              (setq cl-optimize-speed (car speed)
1442                    byte-optimize (cdr speed)))
1443            (when safety
1444              (setq cl-optimize-safety (car safety)
1445                    byte-compile-delete-errors (cdr safety)))))
1446
1447         ((and (eq (car-safe spec) 'warn) (boundp 'byte-compile-warnings))
1448          (if (eq byte-compile-warnings t)
1449              ;; XEmacs change
1450              (setq byte-compile-warnings byte-compile-default-warnings))
1451          (while (setq spec (cdr spec))
1452            (if (consp (car spec))
1453                (if (eq (cadar spec) 0)
1454                    (setq byte-compile-warnings
1455                          (delq (caar spec) byte-compile-warnings))
1456                  (setq byte-compile-warnings
1457                        (adjoin (caar spec) byte-compile-warnings)))))))
1458   nil)
1459
1460 ;;; Process any proclamations made before cl-macs was loaded.
1461 (defvar cl-proclaims-deferred)
1462 (let ((p (reverse cl-proclaims-deferred)))
1463   (while p (cl-do-proclaim (cl-pop p) t))
1464   (setq cl-proclaims-deferred nil))
1465
1466 ;;;###autoload
1467 (defmacro declare (&rest specs)
1468   (if (cl-compiling-file)
1469       (while specs
1470         (if (listp cl-declare-stack) (cl-push (car specs) cl-declare-stack))
1471         (cl-do-proclaim (cl-pop specs) nil)))
1472   nil)
1473
1474
1475
1476 ;;; Generalized variables.
1477
1478 ;;;###autoload
1479 (defmacro define-setf-method (func args &rest body)
1480   "(define-setf-method NAME ARGLIST BODY...): define a `setf' method.
1481 This method shows how to handle `setf's to places of the form (NAME ARGS...).
1482 The argument forms ARGS are bound according to ARGLIST, as if NAME were
1483 going to be expanded as a macro, then the BODY forms are executed and must
1484 return a list of five elements: a temporary-variables list, a value-forms
1485 list, a store-variables list (of length one), a store-form, and an access-
1486 form.  See `defsetf' for a simpler way to define most setf-methods."
1487   (append '(eval-when (compile load eval))
1488           (if (stringp (car body))
1489               (list (list 'put (list 'quote func) '(quote setf-documentation)
1490                           (cl-pop body))))
1491           (list (cl-transform-function-property
1492                  func 'setf-method (cons args body)))))
1493
1494 ;;;###autoload
1495 (defmacro defsetf (func arg1 &rest args)
1496   "(defsetf NAME FUNC): define a `setf' method.
1497 This macro is an easy-to-use substitute for `define-setf-method' that works
1498 well for simple place forms.  In the simple `defsetf' form, `setf's of
1499 the form (setf (NAME ARGS...) VAL) are transformed to function or macro
1500 calls of the form (FUNC ARGS... VAL).  Example: (defsetf aref aset).
1501 Alternate form: (defsetf NAME ARGLIST (STORE) BODY...).
1502 Here, the above `setf' call is expanded by binding the argument forms ARGS
1503 according to ARGLIST, binding the value form VAL to STORE, then executing
1504 BODY, which must return a Lisp form that does the necessary `setf' operation.
1505 Actually, ARGLIST and STORE may be bound to temporary variables which are
1506 introduced automatically to preserve proper execution order of the arguments.
1507 Example: (defsetf nth (n x) (v) (list 'setcar (list 'nthcdr n x) v))."
1508   (if (listp arg1)
1509       (let* ((largs nil) (largsr nil)
1510              (temps nil) (tempsr nil)
1511              (restarg nil) (rest-temps nil)
1512              (store-var (car (prog1 (car args) (setq args (cdr args)))))
1513              (store-temp (intern (format "--%s--temp--" store-var)))
1514              (lets1 nil) (lets2 nil)
1515              (docstr nil) (p arg1))
1516         (if (stringp (car args))
1517             (setq docstr (prog1 (car args) (setq args (cdr args)))))
1518         (while (and p (not (eq (car p) '&aux)))
1519           (if (eq (car p) '&rest)
1520               (setq p (cdr p) restarg (car p))
1521             (or (memq (car p) '(&optional &key &allow-other-keys))
1522                 (setq largs (cons (if (consp (car p)) (car (car p)) (car p))
1523                                   largs)
1524                       temps (cons (intern (format "--%s--temp--" (car largs)))
1525                                   temps))))
1526           (setq p (cdr p)))
1527         (setq largs (nreverse largs) temps (nreverse temps))
1528         (if restarg
1529             (setq largsr (append largs (list restarg))
1530                   rest-temps (intern (format "--%s--temp--" restarg))
1531                   tempsr (append temps (list rest-temps)))
1532           (setq largsr largs tempsr temps))
1533         (let ((p1 largs) (p2 temps))
1534           (while p1
1535             (setq lets1 (cons (list (car p2)
1536                                     (list 'gensym (format "--%s--" (car p1))))
1537                               lets1)
1538                   lets2 (cons (list (car p1) (car p2)) lets2)
1539                   p1 (cdr p1) p2 (cdr p2))))
1540         (if restarg (setq lets2 (cons (list restarg rest-temps) lets2)))
1541         (append (list 'define-setf-method func arg1)
1542                 (and docstr (list docstr))
1543                 (list
1544                  (list 'let*
1545                        (nreverse
1546                         (cons (list store-temp
1547                                     (list 'gensym (format "--%s--" store-var)))
1548                               (if restarg
1549                                   (append
1550                                    (list
1551                                     (list rest-temps
1552                                           (list 'mapcar '(quote gensym)
1553                                                 restarg)))
1554                                    lets1)
1555                                 lets1)))
1556                        (list 'list  ; 'values
1557                              (cons (if restarg 'list* 'list) tempsr)
1558                              (cons (if restarg 'list* 'list) largsr)
1559                              (list 'list store-temp)
1560                              (cons 'let*
1561                                    (cons (nreverse
1562                                           (cons (list store-var store-temp)
1563                                                 lets2))
1564                                          args))
1565                              (cons (if restarg 'list* 'list)
1566                                    (cons (list 'quote func) tempsr)))))))
1567     (list 'defsetf func '(&rest args) '(store)
1568           (let ((call (list 'cons (list 'quote arg1)
1569                             '(append args (list store)))))
1570             (if (car args)
1571                 (list 'list '(quote progn) call 'store)
1572               call)))))
1573
1574 ;;; Some standard place types from Common Lisp.
1575 (eval-when-compile (defvar ignored-arg)) ; Warning suppression
1576 (defsetf aref aset)
1577 (defsetf car setcar)
1578 (defsetf cdr setcdr)
1579 (defsetf elt (seq n) (store)
1580   (list 'if (list 'listp seq) (list 'setcar (list 'nthcdr n seq) store)
1581         (list 'aset seq n store)))
1582 (defsetf get (x y &optional ignored-arg) (store) (list 'put x y store))
1583 (defsetf get* (x y &optional ignored-arg) (store) (list 'put x y store))
1584 (defsetf gethash (x h &optional ignored-arg) (store) (list 'cl-puthash x store h))
1585 (defsetf nth (n x) (store) (list 'setcar (list 'nthcdr n x) store))
1586 (defsetf subseq (seq start &optional end) (new)
1587   (list 'progn (list 'replace seq new ':start1 start ':end1 end) new))
1588 (defsetf symbol-function fset)
1589 (defsetf symbol-plist setplist)
1590 (defsetf symbol-value set)
1591
1592 ;;; Various car/cdr aliases.  Note that `cadr' is handled specially.
1593 (defsetf first setcar)
1594 (defsetf second (x) (store) (list 'setcar (list 'cdr x) store))
1595 (defsetf third (x) (store) (list 'setcar (list 'cddr x) store))
1596 (defsetf fourth (x) (store) (list 'setcar (list 'cdddr x) store))
1597 (defsetf fifth (x) (store) (list 'setcar (list 'nthcdr 4 x) store))
1598 (defsetf sixth (x) (store) (list 'setcar (list 'nthcdr 5 x) store))
1599 (defsetf seventh (x) (store) (list 'setcar (list 'nthcdr 6 x) store))
1600 (defsetf eighth (x) (store) (list 'setcar (list 'nthcdr 7 x) store))
1601 (defsetf ninth (x) (store) (list 'setcar (list 'nthcdr 8 x) store))
1602 (defsetf tenth (x) (store) (list 'setcar (list 'nthcdr 9 x) store))
1603 (defsetf rest setcdr)
1604
1605 ;;; Some more Emacs-related place types.
1606 (defsetf buffer-file-name set-visited-file-name t)
1607 (defsetf buffer-modified-p set-buffer-modified-p t)
1608 (defsetf buffer-name rename-buffer t)
1609 (defsetf buffer-string () (store)
1610   (list 'progn '(erase-buffer) (list 'insert store)))
1611 (defsetf buffer-substring cl-set-buffer-substring)
1612 (defsetf current-buffer set-buffer)
1613 (defsetf current-case-table set-case-table)
1614 (defsetf current-column move-to-column t)
1615 (defsetf current-global-map use-global-map t)
1616 (defsetf current-input-mode () (store)
1617   (list 'progn (list 'apply 'set-input-mode store) store))
1618 (defsetf current-local-map use-local-map t)
1619 (defsetf current-window-configuration set-window-configuration t)
1620 (defsetf default-file-modes set-default-file-modes t)
1621 (defsetf default-value set-default)
1622 (defsetf documentation-property put)
1623 (defsetf extent-face set-extent-face)
1624 (defsetf extent-priority set-extent-priority)
1625 (defsetf extent-property (x y &optional ignored-arg) (arg)
1626   (list 'set-extent-property x y arg))
1627 (defsetf extent-start-position (ext) (store)
1628   `(progn (set-extent-endpoints ,ext ,store (extent-end-position ,ext))
1629           ,store))
1630 (defsetf extent-end-position (ext) (store)
1631   `(progn (set-extent-endpoints ,ext (extent-start-position ,ext) ,store)
1632           ,store))
1633 (defsetf face-background (f &optional s) (x) (list 'set-face-background f x s))
1634 (defsetf face-background-pixmap (f &optional s) (x)
1635   (list 'set-face-background-pixmap f x s))
1636 (defsetf face-font (f &optional s) (x) (list 'set-face-font f x s))
1637 (defsetf face-foreground (f &optional s) (x) (list 'set-face-foreground f x s))
1638 (defsetf face-underline-p (f &optional s) (x)
1639   (list 'set-face-underline-p f x s))
1640 (defsetf file-modes set-file-modes t)
1641 (defsetf frame-parameters modify-frame-parameters t)
1642 (defsetf frame-visible-p cl-set-frame-visible-p)
1643 (defsetf frame-properties (&optional f) (p)
1644   `(progn (set-frame-properties ,f ,p) ,p))
1645 (defsetf frame-property (f p &optional ignored-arg) (v)
1646   `(progn (set-frame-property ,f ,v) ,p))
1647 (defsetf frame-width (&optional f) (v)
1648   `(progn (set-frame-width ,f ,v) ,v))
1649 (defsetf frame-height (&optional f) (v)
1650   `(progn (set-frame-height ,f ,v) ,v))
1651 (defsetf current-frame-configuration set-frame-configuration)
1652
1653 ;; XEmacs: new stuff
1654 ;; Consoles
1655 (defsetf selected-console select-console t)
1656 (defsetf selected-device select-device t)
1657 (defsetf device-baud-rate (&optional d) (v)
1658   `(set-device-baud-rate ,d ,v))
1659 ;; This setf method is a bad idea, because set-specifier *adds* a
1660 ;; specification, rather than just setting it.  The net effect is that
1661 ;; it makes specifier-instance return VAL, but other things don't work
1662 ;; as expected -- letf, to name one.
1663 ;(defsetf specifier-instance (spec &optional dom def nof) (val)
1664 ;  `(set-specifier ,spec ,val ,dom))
1665
1666 ;; Annotations
1667 (defsetf annotation-glyph set-annotation-glyph)
1668 (defsetf annotation-down-glyph set-annotation-down-glyph)
1669 (defsetf annotation-face set-annotation-face)
1670 (defsetf annotation-layout set-annotation-layout)
1671 (defsetf annotation-data set-annotation-data)
1672 (defsetf annotation-action set-annotation-action)
1673 (defsetf annotation-menu set-annotation-menu)
1674 ;; Widget
1675 (defsetf widget-get widget-put t)
1676 (defsetf widget-value widget-value-set t)
1677
1678 ;; Misc
1679 (defsetf recent-keys-ring-size set-recent-keys-ring-size)
1680 (defsetf symbol-value-in-buffer (s b &optional ignored-arg) (store)
1681   `(with-current-buffer ,b (set ,s ,store)))
1682 (defsetf symbol-value-in-console (s c &optional ignored-arg) (store)
1683   `(letf (((selected-console) ,c))
1684      (set ,s ,store)))
1685
1686 (defsetf buffer-dedicated-frame (&optional b) (v)
1687   `(set-buffer-dedicated-frame ,b ,v))
1688 (defsetf console-type-image-conversion-list
1689   set-console-type-image-conversion-list)
1690 (defsetf default-toolbar-position set-default-toolbar-position)
1691 (defsetf device-class (&optional d) (v)
1692   `(set-device-class ,d ,v))
1693 (defsetf extent-begin-glyph set-extent-begin-glyph)
1694 (defsetf extent-begin-glyph-layout set-extent-begin-glyph-layout)
1695 (defsetf extent-end-glyph set-extent-end-glyph)
1696 (defsetf extent-end-glyph-layout set-extent-end-glyph-layout)
1697 (defsetf extent-keymap set-extent-keymap)
1698 (defsetf extent-parent set-extent-parent)
1699 (defsetf extent-properties set-extent-properties)
1700 ;; Avoid adding various face and glyph functions.
1701 (defsetf frame-selected-window (&optional f) (v)
1702   `(set-frame-selected-window ,f ,v))
1703 (defsetf glyph-image (glyph &optional domain) (i)
1704   (list 'set-glyph-image glyph i domain))
1705 (defsetf itimer-function set-itimer-function)
1706 (defsetf itimer-function-arguments set-itimer-function-arguments)
1707 (defsetf itimer-is-idle set-itimer-is-idle)
1708 (defsetf itimer-recorded-run-time set-itimer-recorded-run-time)
1709 (defsetf itimer-restart set-itimer-restart)
1710 (defsetf itimer-uses-arguments set-itimer-uses-arguments)
1711 (defsetf itimer-value set-itimer-value)
1712 (defsetf keymap-parents set-keymap-parents)
1713 (defsetf marker-insertion-type set-marker-insertion-type)
1714 (defsetf mouse-pixel-position (&optional d) (v)
1715   `(progn
1716      (set-mouse-pixel-position ,d ,(car v) ,(car (cdr v)) ,(cdr (cdr v)))
1717      ,v))
1718 (defsetf trunc-stack-length set-trunc-stack-length)
1719 (defsetf trunc-stack-stack set-trunc-stack-stack)
1720 (defsetf undoable-stack-max set-undoable-stack-max)
1721 (defsetf weak-list-list set-weak-list-list)
1722
1723
1724 (defsetf getenv setenv t)
1725 (defsetf get-register set-register)
1726 (defsetf global-key-binding global-set-key)
1727 (defsetf keymap-parent set-keymap-parent)
1728 (defsetf keymap-name set-keymap-name)
1729 (defsetf keymap-prompt set-keymap-prompt)
1730 (defsetf keymap-default-binding set-keymap-default-binding)
1731 (defsetf local-key-binding local-set-key)
1732 (defsetf mark set-mark t)
1733 (defsetf mark-marker set-mark t)
1734 (defsetf marker-position set-marker t)
1735 (defsetf match-data store-match-data t)
1736 (defsetf mouse-position (scr) (store)
1737   (list 'set-mouse-position scr (list 'car store) (list 'cadr store)
1738         (list 'cddr store)))
1739 (defsetf overlay-get overlay-put)
1740 (defsetf overlay-start (ov) (store)
1741   (list 'progn (list 'move-overlay ov store (list 'overlay-end ov)) store))
1742 (defsetf overlay-end (ov) (store)
1743   (list 'progn (list 'move-overlay ov (list 'overlay-start ov) store) store))
1744 (defsetf point goto-char)
1745 (defsetf point-marker goto-char t)
1746 (defsetf point-max () (store)
1747   (list 'progn (list 'narrow-to-region '(point-min) store) store))
1748 (defsetf point-min () (store)
1749   (list 'progn (list 'narrow-to-region store '(point-max)) store))
1750 (defsetf process-buffer set-process-buffer)
1751 (defsetf process-filter set-process-filter)
1752 (defsetf process-sentinel set-process-sentinel)
1753 (defsetf read-mouse-position (scr) (store)
1754   (list 'set-mouse-position scr (list 'car store) (list 'cdr store)))
1755 (defsetf selected-window select-window)
1756 (defsetf selected-frame select-frame)
1757 (defsetf standard-case-table set-standard-case-table)
1758 (defsetf syntax-table set-syntax-table)
1759 (defsetf visited-file-modtime set-visited-file-modtime t)
1760 (defsetf window-buffer set-window-buffer t)
1761 (defsetf window-display-table set-window-display-table t)
1762 (defsetf window-dedicated-p set-window-dedicated-p t)
1763 (defsetf window-height (&optional window) (store)
1764   `(progn (enlarge-window (- ,store (window-height)) nil ,window) ,store))
1765 (defsetf window-hscroll set-window-hscroll)
1766 (defsetf window-point set-window-point)
1767 (defsetf window-start set-window-start)
1768 (defsetf window-width (&optional window) (store)
1769   `(progn (enlarge-window (- ,store (window-width)) t ,window) ,store))
1770 (defsetf x-get-cutbuffer x-store-cutbuffer t)
1771 (defsetf x-get-cut-buffer x-store-cut-buffer t)   ; groan.
1772 (defsetf x-get-secondary-selection x-own-secondary-selection t)
1773 (defsetf x-get-selection x-own-selection t)
1774 (defsetf get-selection own-selection t)
1775
1776 ;;; More complex setf-methods.
1777 ;;; These should take &environment arguments, but since full arglists aren't
1778 ;;; available while compiling cl-macs, we fake it by referring to the global
1779 ;;; variable cl-macro-environment directly.
1780
1781 (define-setf-method apply (func arg1 &rest rest)
1782   (or (and (memq (car-safe func) '(quote function function*))
1783            (symbolp (car-safe (cdr-safe func))))
1784       (error "First arg to apply in setf is not (function SYM): %s" func))
1785   (let* ((form (cons (nth 1 func) (cons arg1 rest)))
1786          (method (get-setf-method form cl-macro-environment)))
1787     (list (car method) (nth 1 method) (nth 2 method)
1788           (cl-setf-make-apply (nth 3 method) (cadr func) (car method))
1789           (cl-setf-make-apply (nth 4 method) (cadr func) (car method)))))
1790
1791 (defun cl-setf-make-apply (form func temps)
1792   (if (eq (car form) 'progn)
1793       (list* 'progn (cl-setf-make-apply (cadr form) func temps) (cddr form))
1794     (or (equal (last form) (last temps))
1795         (error "%s is not suitable for use with setf-of-apply" func))
1796     (list* 'apply (list 'quote (car form)) (cdr form))))
1797
1798 (define-setf-method nthcdr (n place)
1799   (let ((method (get-setf-method place cl-macro-environment))
1800         (n-temp (gensym "--nthcdr-n--"))
1801         (store-temp (gensym "--nthcdr-store--")))
1802     (list (cons n-temp (car method))
1803           (cons n (nth 1 method))
1804           (list store-temp)
1805           (list 'let (list (list (car (nth 2 method))
1806                                  (list 'cl-set-nthcdr n-temp (nth 4 method)
1807                                        store-temp)))
1808                 (nth 3 method) store-temp)
1809           (list 'nthcdr n-temp (nth 4 method)))))
1810
1811 (define-setf-method getf (place tag &optional def)
1812   (let ((method (get-setf-method place cl-macro-environment))
1813         (tag-temp (gensym "--getf-tag--"))
1814         (def-temp (gensym "--getf-def--"))
1815         (store-temp (gensym "--getf-store--")))
1816     (list (append (car method) (list tag-temp def-temp))
1817           (append (nth 1 method) (list tag def))
1818           (list store-temp)
1819           (list 'let (list (list (car (nth 2 method))
1820                                  (list 'cl-set-getf (nth 4 method)
1821                                        tag-temp store-temp)))
1822                 (nth 3 method) store-temp)
1823           (list 'getf (nth 4 method) tag-temp def-temp))))
1824
1825 (define-setf-method substring (place from &optional to)
1826   (let ((method (get-setf-method place cl-macro-environment))
1827         (from-temp (gensym "--substring-from--"))
1828         (to-temp (gensym "--substring-to--"))
1829         (store-temp (gensym "--substring-store--")))
1830     (list (append (car method) (list from-temp to-temp))
1831           (append (nth 1 method) (list from to))
1832           (list store-temp)
1833           (list 'let (list (list (car (nth 2 method))
1834                                  (list 'cl-set-substring (nth 4 method)
1835                                        from-temp to-temp store-temp)))
1836                 (nth 3 method) store-temp)
1837           (list 'substring (nth 4 method) from-temp to-temp))))
1838
1839 (define-setf-method values (&rest args)
1840   (let ((methods (mapcar #'(lambda (x)
1841                              (get-setf-method x cl-macro-environment))
1842                          args))
1843         (store-temp (gensym "--values-store--")))
1844     (list (apply 'append (mapcar 'first methods))
1845           (apply 'append (mapcar 'second methods))
1846           (list store-temp)
1847           (cons 'list
1848                 (mapcar #'(lambda (m)
1849                             (cl-setf-do-store (cons (car (third m)) (fourth m))
1850                                               (list 'pop store-temp)))
1851                         methods))
1852           (cons 'list (mapcar 'fifth methods)))))
1853
1854 ;;; Getting and optimizing setf-methods.
1855 ;;;###autoload
1856 (defun get-setf-method (place &optional env)
1857   "Return a list of five values describing the setf-method for PLACE.
1858 PLACE may be any Lisp form which can appear as the PLACE argument to
1859 a macro like `setf' or `incf'."
1860   (if (symbolp place)
1861       (let ((temp (gensym "--setf--")))
1862         (list nil nil (list temp) (list 'setq place temp) place))
1863     (or (and (symbolp (car place))
1864              (let* ((func (car place))
1865                     (name (symbol-name func))
1866                     (method (get func 'setf-method))
1867                     (case-fold-search nil))
1868                (or (and method
1869                         (let ((cl-macro-environment env))
1870                           (setq method (apply method (cdr place))))
1871                         (if (and (consp method) (= (length method) 5))
1872                             method
1873                           (error "Setf-method for %s returns malformed method"
1874                                  func)))
1875                    (and (save-match-data
1876                           (string-match "\\`c[ad][ad][ad]?[ad]?r\\'" name))
1877                         (get-setf-method (compiler-macroexpand place)))
1878                    (and (eq func 'edebug-after)
1879                         (get-setf-method (nth (1- (length place)) place)
1880                                          env)))))
1881         (if (eq place (setq place (macroexpand place env)))
1882             (if (and (symbolp (car place)) (fboundp (car place))
1883                      (symbolp (symbol-function (car place))))
1884                 (get-setf-method (cons (symbol-function (car place))
1885                                        (cdr place)) env)
1886               (error "No setf-method known for %s" (car place)))
1887           (get-setf-method place env)))))
1888
1889 (defun cl-setf-do-modify (place opt-expr)
1890   (let* ((method (get-setf-method place cl-macro-environment))
1891          (temps (car method)) (values (nth 1 method))
1892          (lets nil) (subs nil)
1893          (optimize (and (not (eq opt-expr 'no-opt))
1894                         (or (and (not (eq opt-expr 'unsafe))
1895                                  (cl-safe-expr-p opt-expr))
1896                             (cl-setf-simple-store-p (car (nth 2 method))
1897                                                     (nth 3 method)))))
1898          (simple (and optimize (consp place) (cl-simple-exprs-p (cdr place)))))
1899     (while values
1900       (if (or simple (cl-const-expr-p (car values)))
1901           (cl-push (cons (cl-pop temps) (cl-pop values)) subs)
1902         (cl-push (list (cl-pop temps) (cl-pop values)) lets)))
1903     (list (nreverse lets)
1904           (cons (car (nth 2 method)) (sublis subs (nth 3 method)))
1905           (sublis subs (nth 4 method)))))
1906
1907 (defun cl-setf-do-store (spec val)
1908   (let ((sym (car spec))
1909         (form (cdr spec)))
1910     (if (or (cl-const-expr-p val)
1911             (and (cl-simple-expr-p val) (eq (cl-expr-contains form sym) 1))
1912             (cl-setf-simple-store-p sym form))
1913         (subst val sym form)
1914       (list 'let (list (list sym val)) form))))
1915
1916 (defun cl-setf-simple-store-p (sym form)
1917   (and (consp form) (eq (cl-expr-contains form sym) 1)
1918        (eq (nth (1- (length form)) form) sym)
1919        (symbolp (car form)) (fboundp (car form))
1920        (not (eq (car-safe (symbol-function (car form))) 'macro))))
1921
1922 ;;; The standard modify macros.
1923 ;;;###autoload
1924 (defmacro setf (&rest args)
1925   "(setf PLACE VAL PLACE VAL ...): set each PLACE to the value of its VAL.
1926 This is a generalized version of `setq'; the PLACEs may be symbolic
1927 references such as (car x) or (aref x i), as well as plain symbols.
1928 For example, (setf (cadar x) y) is equivalent to (setcar (cdar x) y).
1929 The return value is the last VAL in the list."
1930   (if (cdr (cdr args))
1931       (let ((sets nil))
1932         (while args (cl-push (list 'setf (cl-pop args) (cl-pop args)) sets))
1933         (cons 'progn (nreverse sets)))
1934     (if (symbolp (car args))
1935         (and args (cons 'setq args))
1936       (let* ((method (cl-setf-do-modify (car args) (nth 1 args)))
1937              (store (cl-setf-do-store (nth 1 method) (nth 1 args))))
1938         (if (car method) (list 'let* (car method) store) store)))))
1939
1940 ;;;###autoload
1941 (defmacro psetf (&rest args)
1942   "(psetf PLACE VAL PLACE VAL ...): set PLACEs to the values VALs in parallel.
1943 This is like `setf', except that all VAL forms are evaluated (in order)
1944 before assigning any PLACEs to the corresponding values."
1945   (let ((p args) (simple t) (vars nil))
1946     (while p
1947       (if (or (not (symbolp (car p))) (cl-expr-depends-p (nth 1 p) vars))
1948           (setq simple nil))
1949       (if (memq (car p) vars)
1950           (error "Destination duplicated in psetf: %s" (car p)))
1951       (cl-push (cl-pop p) vars)
1952       (or p (error "Odd number of arguments to psetf"))
1953       (cl-pop p))
1954     (if simple
1955         (list 'progn (cons 'setf args) nil)
1956       (setq args (reverse args))
1957       (let ((expr (list 'setf (cadr args) (car args))))
1958         (while (setq args (cddr args))
1959           (setq expr (list 'setf (cadr args) (list 'prog1 (car args) expr))))
1960         (list 'progn expr nil)))))
1961
1962 ;;;###autoload
1963 (defun cl-do-pop (place)
1964   (if (cl-simple-expr-p place)
1965       (list 'prog1 (list 'car place) (list 'setf place (list 'cdr place)))
1966     (let* ((method (cl-setf-do-modify place t))
1967            (temp (gensym "--pop--")))
1968       (list 'let*
1969             (append (car method)
1970                     (list (list temp (nth 2 method))))
1971             (list 'prog1
1972                   (list 'car temp)
1973                   (cl-setf-do-store (nth 1 method) (list 'cdr temp)))))))
1974
1975 ;;;###autoload
1976 (defmacro remf (place tag)
1977   "(remf PLACE TAG): remove TAG from property list PLACE.
1978 PLACE may be a symbol, or any generalized variable allowed by `setf'.
1979 The form returns true if TAG was found and removed, nil otherwise."
1980   (let* ((method (cl-setf-do-modify place t))
1981          (tag-temp (and (not (cl-const-expr-p tag)) (gensym "--remf-tag--")))
1982          (val-temp (and (not (cl-simple-expr-p place))
1983                         (gensym "--remf-place--")))
1984          (ttag (or tag-temp tag))
1985          (tval (or val-temp (nth 2 method))))
1986     (list 'let*
1987           (append (car method)
1988                   (and val-temp (list (list val-temp (nth 2 method))))
1989                   (and tag-temp (list (list tag-temp tag))))
1990           (list 'if (list 'eq ttag (list 'car tval))
1991                 (list 'progn
1992                       (cl-setf-do-store (nth 1 method) (list 'cddr tval))
1993                       t)
1994                 (list 'cl-do-remf tval ttag)))))
1995
1996 ;;;###autoload
1997 (defmacro shiftf (place &rest args)
1998   "(shiftf PLACE PLACE... VAL): shift left among PLACEs.
1999 Example: (shiftf A B C) sets A to B, B to C, and returns the old A.
2000 Each PLACE may be a symbol, or any generalized variable allowed by `setf'."
2001   (if (not (memq nil (mapcar 'symbolp (butlast (cons place args)))))
2002       (list* 'prog1 place
2003              (let ((sets nil))
2004                (while args
2005                  (cl-push (list 'setq place (car args)) sets)
2006                  (setq place (cl-pop args)))
2007                (nreverse sets)))
2008     (let* ((places (reverse (cons place args)))
2009            (form (cl-pop places)))
2010       (while places
2011         (let ((method (cl-setf-do-modify (cl-pop places) 'unsafe)))
2012           (setq form (list 'let* (car method)
2013                            (list 'prog1 (nth 2 method)
2014                                  (cl-setf-do-store (nth 1 method) form))))))
2015       form)))
2016
2017 ;;;###autoload
2018 (defmacro rotatef (&rest args)
2019   "(rotatef PLACE...): rotate left among PLACEs.
2020 Example: (rotatef A B C) sets A to B, B to C, and C to A.  It returns nil.
2021 Each PLACE may be a symbol, or any generalized variable allowed by `setf'."
2022   (if (not (memq nil (mapcar 'symbolp args)))
2023       (and (cdr args)
2024            (let ((sets nil)
2025                  (first (car args)))
2026              (while (cdr args)
2027                (setq sets (nconc sets (list (cl-pop args) (car args)))))
2028              (nconc (list 'psetf) sets (list (car args) first))))
2029     (let* ((places (reverse args))
2030            (temp (gensym "--rotatef--"))
2031            (form temp))
2032       (while (cdr places)
2033         (let ((method (cl-setf-do-modify (cl-pop places) 'unsafe)))
2034           (setq form (list 'let* (car method)
2035                            (list 'prog1 (nth 2 method)
2036                                  (cl-setf-do-store (nth 1 method) form))))))
2037       (let ((method (cl-setf-do-modify (car places) 'unsafe)))
2038         (list 'let* (append (car method) (list (list temp (nth 2 method))))
2039               (cl-setf-do-store (nth 1 method) form) nil)))))
2040
2041 ;;;###autoload
2042 (defmacro letf (bindings &rest body)
2043   "(letf ((PLACE VALUE) ...) BODY...): temporarily bind to PLACEs.
2044 This is the analogue of `let', but with generalized variables (in the
2045 sense of `setf') for the PLACEs.  Each PLACE is set to the corresponding
2046 VALUE, then the BODY forms are executed.  On exit, either normally or
2047 because of a `throw' or error, the PLACEs are set back to their original
2048 values.  Note that this macro is *not* available in Common Lisp.
2049 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
2050 the PLACE is not modified before executing BODY."
2051   (if (and (not (cdr bindings)) (cdar bindings) (symbolp (caar bindings)))
2052       (list* 'let bindings body)
2053     (let ((lets nil)
2054           (rev (reverse bindings)))
2055       (while rev
2056         (let* ((place (if (symbolp (caar rev))
2057                           (list 'symbol-value (list 'quote (caar rev)))
2058                         (caar rev)))
2059                (value (cadar rev))
2060                (method (cl-setf-do-modify place 'no-opt))
2061                (save (gensym "--letf-save--"))
2062                (bound (and (memq (car place) '(symbol-value symbol-function))
2063                            (gensym "--letf-bound--")))
2064                (temp (and (not (cl-const-expr-p value)) (cdr bindings)
2065                           (gensym "--letf-val--"))))
2066           (setq lets (nconc (car method)
2067                             (if bound
2068                                 (list (list bound
2069                                             (list (if (eq (car place)
2070                                                           'symbol-value)
2071                                                       'boundp 'fboundp)
2072                                                   (nth 1 (nth 2 method))))
2073                                       (list save (list 'and bound
2074                                                        (nth 2 method))))
2075                               (list (list save (nth 2 method))))
2076                             (and temp (list (list temp value)))
2077                             lets)
2078                 body (list
2079                       (list 'unwind-protect
2080                             (cons 'progn
2081                                   (if (cdr (car rev))
2082                                       (cons (cl-setf-do-store (nth 1 method)
2083                                                               (or temp value))
2084                                             body)
2085                                     body))
2086                             (if bound
2087                                 (list 'if bound
2088                                       (cl-setf-do-store (nth 1 method) save)
2089                                       (list (if (eq (car place) 'symbol-value)
2090                                                 'makunbound 'fmakunbound)
2091                                             (nth 1 (nth 2 method))))
2092                               (cl-setf-do-store (nth 1 method) save))))
2093                 rev (cdr rev))))
2094       (list* 'let* lets body))))
2095
2096 ;;;###autoload
2097 (defmacro letf* (bindings &rest body)
2098   "(letf* ((PLACE VALUE) ...) BODY...): temporarily bind to PLACEs.
2099 This is the analogue of `let*', but with generalized variables (in the
2100 sense of `setf') for the PLACEs.  Each PLACE is set to the corresponding
2101 VALUE, then the BODY forms are executed.  On exit, either normally or
2102 because of a `throw' or error, the PLACEs are set back to their original
2103 values.  Note that this macro is *not* available in Common Lisp.
2104 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
2105 the PLACE is not modified before executing BODY."
2106   (if (null bindings)
2107       (cons 'progn body)
2108     (setq bindings (reverse bindings))
2109     (while bindings
2110       (setq body (list (list* 'letf (list (cl-pop bindings)) body))))
2111     (car body)))
2112
2113 ;;;###autoload
2114 (defmacro callf (func place &rest args)
2115   "(callf FUNC PLACE ARGS...): set PLACE to (FUNC PLACE ARGS...).
2116 FUNC should be an unquoted function name.  PLACE may be a symbol,
2117 or any generalized variable allowed by `setf'."
2118   (let* ((method (cl-setf-do-modify place (cons 'list args)))
2119          (rargs (cons (nth 2 method) args)))
2120     (list 'let* (car method)
2121           (cl-setf-do-store (nth 1 method)
2122                             (if (symbolp func) (cons func rargs)
2123                               (list* 'funcall (list 'function func)
2124                                      rargs))))))
2125
2126 ;;;###autoload
2127 (defmacro callf2 (func arg1 place &rest args)
2128   "(callf2 FUNC ARG1 PLACE ARGS...): set PLACE to (FUNC ARG1 PLACE ARGS...).
2129 Like `callf', but PLACE is the second argument of FUNC, not the first."
2130   (if (and (cl-safe-expr-p arg1) (cl-simple-expr-p place) (symbolp func))
2131       (list 'setf place (list* func arg1 place args))
2132     (let* ((method (cl-setf-do-modify place (cons 'list args)))
2133            (temp (and (not (cl-const-expr-p arg1)) (gensym "--arg1--")))
2134            (rargs (list* (or temp arg1) (nth 2 method) args)))
2135       (list 'let* (append (and temp (list (list temp arg1))) (car method))
2136             (cl-setf-do-store (nth 1 method)
2137                               (if (symbolp func) (cons func rargs)
2138                                 (list* 'funcall (list 'function func)
2139                                        rargs)))))))
2140
2141 ;;;###autoload
2142 (defmacro define-modify-macro (name arglist func &optional doc)
2143   "(define-modify-macro NAME ARGLIST FUNC): define a `setf'-like modify macro.
2144 If NAME is called, it combines its PLACE argument with the other arguments
2145 from ARGLIST using FUNC: (define-modify-macro incf (&optional (n 1)) +)"
2146   (if (memq '&key arglist) (error "&key not allowed in define-modify-macro"))
2147   (let ((place (gensym "--place--")))
2148     (list 'defmacro* name (cons place arglist) doc
2149           (list* (if (memq '&rest arglist) 'list* 'list)
2150                  '(quote callf) (list 'quote func) place
2151                  (cl-arglist-args arglist)))))
2152
2153
2154 ;;; Structures.
2155
2156 ;;;###autoload
2157 (defmacro defstruct (struct &rest descs)
2158   "(defstruct (NAME OPTIONS...) (SLOT SLOT-OPTS...)...): define a struct type.
2159 This macro defines a new Lisp data type called NAME, which contains data
2160 stored in SLOTs.  This defines a `make-NAME' constructor, a `copy-NAME'
2161 copier, a `NAME-p' predicate, and setf-able `NAME-SLOT' accessors."
2162   (let* ((name (if (consp struct) (car struct) struct))
2163          (opts (cdr-safe struct))
2164          (slots nil)
2165          (defaults nil)
2166          (conc-name (concat (symbol-name name) "-"))
2167          (constructor (intern (format "make-%s" name)))
2168          (constrs nil)
2169          (copier (intern (format "copy-%s" name)))
2170          (predicate (intern (format "%s-p" name)))
2171          (print-func nil) (print-auto nil)
2172          (safety (if (cl-compiling-file) cl-optimize-safety 3))
2173          (include nil)
2174          (tag (intern (format "cl-struct-%s" name)))
2175          (tag-symbol (intern (format "cl-struct-%s-tags" name)))
2176          (include-descs nil)
2177          (side-eff nil)
2178          (type nil)
2179          (named nil)
2180          (forms nil)
2181          pred-form pred-check)
2182     (if (stringp (car descs))
2183         (cl-push (list 'put (list 'quote name) '(quote structure-documentation)
2184                        (cl-pop descs)) forms))
2185     (setq descs (cons '(cl-tag-slot)
2186                       (mapcar #'(lambda (x) (if (consp x) x (list x)))
2187                               descs)))
2188     (while opts
2189       (let ((opt (if (consp (car opts)) (caar opts) (car opts)))
2190             (args (cdr-safe (cl-pop opts))))
2191         (cond ((eq opt ':conc-name)
2192                (if args
2193                    (setq conc-name (if (car args)
2194                                        (symbol-name (car args)) ""))))
2195               ((eq opt ':constructor)
2196                (if (cdr args)
2197                    (cl-push args constrs)
2198                  (if args (setq constructor (car args)))))
2199               ((eq opt ':copier)
2200                (if args (setq copier (car args))))
2201               ((eq opt ':predicate)
2202                (if args (setq predicate (car args))))
2203               ((eq opt ':include)
2204                (setq include (car args)
2205                      include-descs (mapcar #'(lambda (x)
2206                                                (if (consp x) x (list x)))
2207                                            (cdr args))))
2208               ((eq opt ':print-function)
2209                (setq print-func (car args)))
2210               ((eq opt ':type)
2211                (setq type (car args)))
2212               ((eq opt ':named)
2213                (setq named t))
2214               ((eq opt ':initial-offset)
2215                (setq descs (nconc (make-list (car args) '(cl-skip-slot))
2216                                   descs)))
2217               (t
2218                (error "Slot option %s unrecognized" opt)))))
2219     (if print-func
2220         (setq print-func (list 'progn
2221                                (list 'funcall (list 'function print-func)
2222                                      'cl-x 'cl-s 'cl-n) t))
2223       (or type (and include (not (get include 'cl-struct-print)))
2224           (setq print-auto t
2225                 print-func (and (or (not (or include type)) (null print-func))
2226                                 (list 'progn
2227                                       (list 'princ (format "#S(%s" name)
2228                                             'cl-s))))))
2229     (if include
2230         (let ((inc-type (get include 'cl-struct-type))
2231               (old-descs (get include 'cl-struct-slots)))
2232           (or inc-type (error "%s is not a struct name" include))
2233           (and type (not (eq (car inc-type) type))
2234                (error ":type disagrees with :include for %s" name))
2235           (while include-descs
2236             (setcar (memq (or (assq (caar include-descs) old-descs)
2237                               (error "No slot %s in included struct %s"
2238                                      (caar include-descs) include))
2239                           old-descs)
2240                     (cl-pop include-descs)))
2241           (setq descs (append old-descs (delq (assq 'cl-tag-slot descs) descs))
2242                 type (car inc-type)
2243                 named (assq 'cl-tag-slot descs))
2244           (if (cadr inc-type) (setq tag name named t))
2245           (let ((incl include))
2246             (while incl
2247               (cl-push (list 'pushnew (list 'quote tag)
2248                              (intern (format "cl-struct-%s-tags" incl)))
2249                        forms)
2250               (setq incl (get incl 'cl-struct-include)))))
2251       (if type
2252           (progn
2253             (or (memq type '(vector list))
2254                 (error "Illegal :type specifier: %s" type))
2255             (if named (setq tag name)))
2256         (setq type 'vector named 'true)))
2257     (or named (setq descs (delq (assq 'cl-tag-slot descs) descs)))
2258     (cl-push (list 'defvar tag-symbol) forms)
2259     (setq pred-form (and named
2260                          (let ((pos (- (length descs)
2261                                        (length (memq (assq 'cl-tag-slot descs)
2262                                                      descs)))))
2263                            (if (eq type 'vector)
2264                                (list 'and '(vectorp cl-x)
2265                                      (list '>= '(length cl-x) (length descs))
2266                                      (list 'memq (list 'aref 'cl-x pos)
2267                                            tag-symbol))
2268                              (if (= pos 0)
2269                                  (list 'memq '(car-safe cl-x) tag-symbol)
2270                                (list 'and '(consp cl-x)
2271                                      (list 'memq (list 'nth pos 'cl-x)
2272                                            tag-symbol))))))
2273           pred-check (and pred-form (> safety 0)
2274                           (if (and (eq (caadr pred-form) 'vectorp)
2275                                    (= safety 1))
2276                               (cons 'and (cdddr pred-form)) pred-form)))
2277     (let ((pos 0) (descp descs))
2278       (while descp
2279         (let* ((desc (cl-pop descp))
2280                (slot (car desc)))
2281           (if (memq slot '(cl-tag-slot cl-skip-slot))
2282               (progn
2283                 (cl-push nil slots)
2284                 (cl-push (and (eq slot 'cl-tag-slot) (list 'quote tag))
2285                          defaults))
2286             (if (assq slot descp)
2287                 (error "Duplicate slots named %s in %s" slot name))
2288             (let ((accessor (intern (format "%s%s" conc-name slot))))
2289               (cl-push slot slots)
2290               (cl-push (nth 1 desc) defaults)
2291               (cl-push (list*
2292                         'defsubst* accessor '(cl-x)
2293                         (append
2294                          (and pred-check
2295                               (list (list 'or pred-check
2296                                           (list 'error
2297                                                 (format "%s accessing a non-%s"
2298                                                         accessor name)
2299                                                 'cl-x))))
2300                          (list (if (eq type 'vector) (list 'aref 'cl-x pos)
2301                                  (if (= pos 0) '(car cl-x)
2302                                    (list 'nth pos 'cl-x)))))) forms)
2303               (cl-push (cons accessor t) side-eff)
2304               (cl-push (list 'define-setf-method accessor '(cl-x)
2305                              (if (cadr (memq ':read-only (cddr desc)))
2306                                  (list 'error (format "%s is a read-only slot"
2307                                                       accessor))
2308                                (list 'cl-struct-setf-expander 'cl-x
2309                                      (list 'quote name) (list 'quote accessor)
2310                                      (and pred-check (list 'quote pred-check))
2311                                      pos)))
2312                        forms)
2313               (if print-auto
2314                   (nconc print-func
2315                          (list (list 'princ (format " %s" slot) 'cl-s)
2316                                (list 'prin1 (list accessor 'cl-x) 'cl-s)))))))
2317         (setq pos (1+ pos))))
2318     (setq slots (nreverse slots)
2319           defaults (nreverse defaults))
2320     (and predicate pred-form
2321          (progn (cl-push (list 'defsubst* predicate '(cl-x)
2322                                (if (eq (car pred-form) 'and)
2323                                    (append pred-form '(t))
2324                                  (list 'and pred-form t))) forms)
2325                 (cl-push (cons predicate 'error-free) side-eff)))
2326     (and copier
2327          (progn (cl-push (list 'defun copier '(x) '(copy-sequence x)) forms)
2328                 (cl-push (cons copier t) side-eff)))
2329     (if constructor
2330         (cl-push (list constructor
2331                        (cons '&key (delq nil (copy-sequence slots))))
2332                  constrs))
2333     (while constrs
2334       (let* ((name (caar constrs))
2335              (args (cadr (cl-pop constrs)))
2336              (anames (cl-arglist-args args))
2337              (make (mapcar* #'(lambda (s d) (if (memq s anames) s d))
2338                             slots defaults)))
2339         (cl-push (list 'defsubst* name
2340                        (list* '&cl-defs (list 'quote (cons nil descs)) args)
2341                        (cons type make)) forms)
2342         (if (cl-safe-expr-p (cons 'progn (mapcar 'second descs)))
2343             (cl-push (cons name t) side-eff))))
2344     (if print-auto (nconc print-func (list '(princ ")" cl-s) t)))
2345     (if print-func
2346         (cl-push (list 'push
2347                        (list 'function
2348                              (list 'lambda '(cl-x cl-s cl-n)
2349                                    (list 'and pred-form print-func)))
2350                        'custom-print-functions) forms))
2351     (cl-push (list 'setq tag-symbol (list 'list (list 'quote tag))) forms)
2352     (cl-push (list* 'eval-when '(compile load eval)
2353                     (list 'put (list 'quote name) '(quote cl-struct-slots)
2354                           (list 'quote descs))
2355                     (list 'put (list 'quote name) '(quote cl-struct-type)
2356                           (list 'quote (list type (eq named t))))
2357                     (list 'put (list 'quote name) '(quote cl-struct-include)
2358                           (list 'quote include))
2359                     (list 'put (list 'quote name) '(quote cl-struct-print)
2360                           print-auto)
2361                     (mapcar #'(lambda (x)
2362                                 (list 'put (list 'quote (car x))
2363                                       '(quote side-effect-free)
2364                                       (list 'quote (cdr x))))
2365                             side-eff))
2366              forms)
2367     (cons 'progn (nreverse (cons (list 'quote name) forms)))))
2368
2369 ;;;###autoload
2370 (defun cl-struct-setf-expander (x name accessor pred-form pos)
2371   (let* ((temp (gensym "--x--")) (store (gensym "--store--")))
2372     (list (list temp) (list x) (list store)
2373           (append '(progn)
2374                   (and pred-form
2375                        (list (list 'or (subst temp 'cl-x pred-form)
2376                                    (list 'error
2377                                          (format
2378                                           "%s storing a non-%s" accessor name)
2379                                          temp))))
2380                   (list (if (eq (car (get name 'cl-struct-type)) 'vector)
2381                             (list 'aset temp pos store)
2382                           (list 'setcar
2383                                 (if (<= pos 5)
2384                                     (let ((xx temp))
2385                                       (while (>= (setq pos (1- pos)) 0)
2386                                         (setq xx (list 'cdr xx)))
2387                                       xx)
2388                                   (list 'nthcdr pos temp))
2389                                 store))))
2390           (list accessor temp))))
2391
2392
2393 ;;; Types and assertions.
2394
2395 ;;;###autoload
2396 (defmacro deftype (name args &rest body)
2397   "(deftype NAME ARGLIST BODY...): define NAME as a new data type.
2398 The type name can then be used in `typecase', `check-type', etc."
2399   (list 'eval-when '(compile load eval)
2400         (cl-transform-function-property
2401          name 'cl-deftype-handler (cons (list* '&cl-defs ''('*) args) body))))
2402
2403 (defun cl-make-type-test (val type)
2404   (if (symbolp type)
2405       (cond ((get type 'cl-deftype-handler)
2406              (cl-make-type-test val (funcall (get type 'cl-deftype-handler))))
2407             ((memq type '(nil t)) type)
2408             ((eq type 'string-char) (list 'characterp val))
2409             ((eq type 'null) (list 'null val))
2410             ((eq type 'float) (list 'floatp-safe val))
2411             ((eq type 'real) (list 'numberp val))
2412             ((eq type 'fixnum) (list 'integerp val))
2413             (t
2414              (let* ((name (symbol-name type))
2415                     (namep (intern (concat name "p"))))
2416                (if (fboundp namep) (list namep val)
2417                  (list (intern (concat name "-p")) val)))))
2418     (cond ((get (car type) 'cl-deftype-handler)
2419            (cl-make-type-test val (apply (get (car type) 'cl-deftype-handler)
2420                                          (cdr type))))
2421           ((memq (car-safe type) '(integer float real number))
2422            (delq t (list 'and (cl-make-type-test val (car type))
2423                          (if (memq (cadr type) '(* nil)) t
2424                            (if (consp (cadr type)) (list '> val (caadr type))
2425                              (list '>= val (cadr type))))
2426                          (if (memq (caddr type) '(* nil)) t
2427                            (if (consp (caddr type)) (list '< val (caaddr type))
2428                              (list '<= val (caddr type)))))))
2429           ((memq (car-safe type) '(and or not))
2430            (cons (car type)
2431                  (mapcar #'(lambda (x) (cl-make-type-test val x))
2432                          (cdr type))))
2433           ((memq (car-safe type) '(member member*))
2434            (list 'and (list 'member* val (list 'quote (cdr type))) t))
2435           ((eq (car-safe type) 'satisfies) (list (cadr type) val))
2436           (t (error "Bad type spec: %s" type)))))
2437
2438 ;;;###autoload
2439 (defun typep (object type)   ; See compiler macro below.
2440   "Check that OBJECT is of type TYPE.
2441 TYPE is a Common Lisp-style type specifier."
2442   (eval (cl-make-type-test 'object type)))
2443
2444 ;;;###autoload
2445 (defmacro check-type (place type &optional string)
2446   "Verify that PLACE is of type TYPE; signal a continuable error if not.
2447 STRING is an optional description of the desired type."
2448   (when (or (not (cl-compiling-file))
2449             (< cl-optimize-speed 3)
2450             (= cl-optimize-safety 3))
2451     (let* ((temp (if (cl-simple-expr-p place 3) place (gensym)))
2452            (test (cl-make-type-test temp type))
2453            (signal-error `(signal 'wrong-type-argument
2454                                   ,(list 'list (or string (list 'quote type))
2455                                          temp (list 'quote place))))
2456            (body
2457             (condition-case nil
2458                 `(while (not ,test)
2459                    ,(macroexpand `(setf ,place ,signal-error)))
2460               (error
2461                `(if ,test (progn ,signal-error nil))))))
2462       (if (eq temp place)
2463           body
2464         `(let ((,temp ,place)) ,body)))))
2465
2466 ;;;###autoload
2467 (defmacro assert (form &optional show-args string &rest args)
2468   "Verify that FORM returns non-nil; signal an error if not.
2469 Second arg SHOW-ARGS means to include arguments of FORM in message.
2470 Other args STRING and ARGS... are arguments to be passed to `error'.
2471 They are not evaluated unless the assertion fails.  If STRING is
2472 omitted, a default message listing FORM itself is used."
2473   (and (or (not (cl-compiling-file))
2474            (< cl-optimize-speed 3) (= cl-optimize-safety 3))
2475        (let ((sargs (and show-args (delq nil (mapcar
2476                                                #'(lambda (x)
2477                                                    (and (not (cl-const-expr-p x))
2478                                                         x))
2479                                                (cdr form))))))
2480          (list 'progn
2481                (list 'or form
2482                      (if string
2483                          (list* 'error string (append sargs args))
2484                        (list 'signal '(quote cl-assertion-failed)
2485                              (list* 'list (list 'quote form) sargs))))
2486                nil))))
2487
2488 ;;;###autoload
2489 (defmacro ignore-errors (&rest body)
2490   "Execute FORMS; if an error occurs, return nil.
2491 Otherwise, return result of last FORM."
2492   `(condition-case nil (progn ,@body) (error nil)))
2493
2494 ;;;###autoload
2495 (defmacro ignore-file-errors (&rest body)
2496   "Execute FORMS; if an error of type `file-error' occurs, return nil.
2497 Otherwise, return result of last FORM."
2498   `(condition-case nil (progn ,@body) (file-error nil)))
2499
2500 ;;; Some predicates for analyzing Lisp forms.  These are used by various
2501 ;;; macro expanders to optimize the results in certain common cases.
2502
2503 (defconst cl-simple-funcs '(car cdr nth aref elt if and or + - 1+ 1- min max
2504                             car-safe cdr-safe progn prog1 prog2))
2505 (defconst cl-safe-funcs '(* / % length memq list vector vectorp
2506                           < > <= >= = error))
2507
2508 ;;; Check if no side effects, and executes quickly.
2509 (defun cl-simple-expr-p (x &optional size)
2510   (or size (setq size 10))
2511   (if (and (consp x) (not (memq (car x) '(quote function function*))))
2512       (and (symbolp (car x))
2513            (or (memq (car x) cl-simple-funcs)
2514                (get (car x) 'side-effect-free))
2515            (progn
2516              (setq size (1- size))
2517              (while (and (setq x (cdr x))
2518                          (setq size (cl-simple-expr-p (car x) size))))
2519              (and (null x) (>= size 0) size)))
2520     (and (> size 0) (1- size))))
2521
2522 (defun cl-simple-exprs-p (xs)
2523   (while (and xs (cl-simple-expr-p (car xs)))
2524     (setq xs (cdr xs)))
2525   (not xs))
2526
2527 ;;; Check if no side effects.
2528 (defun cl-safe-expr-p (x)
2529   (or (not (and (consp x) (not (memq (car x) '(quote function function*)))))
2530       (and (symbolp (car x))
2531            (or (memq (car x) cl-simple-funcs)
2532                (memq (car x) cl-safe-funcs)
2533                (get (car x) 'side-effect-free))
2534            (progn
2535              (while (and (setq x (cdr x)) (cl-safe-expr-p (car x))))
2536              (null x)))))
2537
2538 ;;; Check if constant (i.e., no side effects or dependencies).
2539 (defun cl-const-expr-p (x)
2540   (cond ((consp x)
2541          (or (eq (car x) 'quote)
2542              (and (memq (car x) '(function function*))
2543                   (or (symbolp (nth 1 x))
2544                       (and (eq (car-safe (nth 1 x)) 'lambda) 'func)))))
2545         ((symbolp x) (and (memq x '(nil t)) t))
2546         (t t)))
2547
2548 (defun cl-const-exprs-p (xs)
2549   (while (and xs (cl-const-expr-p (car xs)))
2550     (setq xs (cdr xs)))
2551   (not xs))
2552
2553 (defun cl-const-expr-val (x)
2554   (and (eq (cl-const-expr-p x) t) (if (consp x) (nth 1 x) x)))
2555
2556 (defun cl-expr-access-order (x v)
2557   (if (cl-const-expr-p x) v
2558     (if (consp x)
2559         (progn
2560           (while (setq x (cdr x)) (setq v (cl-expr-access-order (car x) v)))
2561           v)
2562       (if (eq x (car v)) (cdr v) '(t)))))
2563
2564 ;;; Count number of times X refers to Y.  Return NIL for 0 times.
2565 (defun cl-expr-contains (x y)
2566   (cond ((equal y x) 1)
2567         ((and (consp x) (not (memq (car-safe x) '(quote function function*))))
2568          (let ((sum 0))
2569            (while x
2570              (setq sum (+ sum (or (cl-expr-contains (cl-pop x) y) 0))))
2571            (and (> sum 0) sum)))
2572         (t nil)))
2573
2574 (defun cl-expr-contains-any (x y)
2575   (while (and y (not (cl-expr-contains x (car y)))) (cl-pop y))
2576   y)
2577
2578 ;;; Check whether X may depend on any of the symbols in Y.
2579 (defun cl-expr-depends-p (x y)
2580   (and (not (cl-const-expr-p x))
2581        (or (not (cl-safe-expr-p x)) (cl-expr-contains-any x y))))
2582
2583
2584 ;;; Compiler macros.
2585
2586 ;;;###autoload
2587 (defmacro define-compiler-macro (func args &rest body)
2588   "(define-compiler-macro FUNC ARGLIST BODY...): Define a compiler-only macro.
2589 This is like `defmacro', but macro expansion occurs only if the call to
2590 FUNC is compiled (i.e., not interpreted).  Compiler macros should be used
2591 for optimizing the way calls to FUNC are compiled; the form returned by
2592 BODY should do the same thing as a call to the normal function called
2593 FUNC, though possibly more efficiently.  Note that, like regular macros,
2594 compiler macros are expanded repeatedly until no further expansions are
2595 possible.  Unlike regular macros, BODY can decide to \"punt\" and leave the
2596 original function call alone by declaring an initial `&whole foo' parameter
2597 and then returning foo."
2598   (let ((p (if (listp args) args (list '&rest args))) (res nil))
2599     (while (consp p) (cl-push (cl-pop p) res))
2600     (setq args (nreverse res)) (setcdr res (and p (list '&rest p))))
2601   (list 'eval-when '(compile load eval)
2602         (cl-transform-function-property
2603          func 'cl-compiler-macro
2604          (cons (if (memq '&whole args) (delq '&whole args)
2605                  (cons '--cl-whole-arg-- args)) body))
2606         (list 'or (list 'get (list 'quote func) '(quote byte-compile))
2607               (list 'put (list 'quote func) '(quote byte-compile)
2608                     '(quote cl-byte-compile-compiler-macro)))))
2609
2610 ;;;###autoload
2611 (defun compiler-macroexpand (form)
2612   (while
2613       (let ((func (car-safe form)) (handler nil))
2614         (while (and (symbolp func)
2615                     (not (setq handler (get func 'cl-compiler-macro)))
2616                     (fboundp func)
2617                     (or (not (eq (car-safe (symbol-function func)) 'autoload))
2618                         (load (nth 1 (symbol-function func)))))
2619           (setq func (symbol-function func)))
2620         (and handler
2621              (not (eq form (setq form (apply handler form (cdr form))))))))
2622   form)
2623
2624 (defun cl-byte-compile-compiler-macro (form)
2625   (if (eq form (setq form (compiler-macroexpand form)))
2626       (byte-compile-normal-call form)
2627     (byte-compile-form form)))
2628
2629 (defmacro defsubst* (name args &rest body)
2630   "(defsubst* NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function.
2631 Like `defun', except the function is automatically declared `inline',
2632 ARGLIST allows full Common Lisp conventions, and BODY is implicitly
2633 surrounded by (block NAME ...)."
2634   (let* ((argns (cl-arglist-args args)) (p argns)
2635          (pbody (cons 'progn body))
2636          (unsafe (not (cl-safe-expr-p pbody))))
2637     (while (and p (eq (cl-expr-contains args (car p)) 1)) (cl-pop p))
2638     (list 'progn
2639           (if p nil   ; give up if defaults refer to earlier args
2640             (list 'define-compiler-macro name
2641                   (list* '&whole 'cl-whole '&cl-quote args)
2642                   (list* 'cl-defsubst-expand (list 'quote argns)
2643                          (list 'quote (list* 'block name body))
2644                          (not (or unsafe (cl-expr-access-order pbody argns)))
2645                          (and (memq '&key args) 'cl-whole) unsafe argns)))
2646           (list* 'defun* name args body))))
2647
2648 (defun cl-defsubst-expand (argns body simple whole unsafe &rest argvs)
2649   (if (and whole (not (cl-safe-expr-p (cons 'progn argvs)))) whole
2650     (if (cl-simple-exprs-p argvs) (setq simple t))
2651     (let ((lets (delq nil
2652                       (mapcar* #'(lambda (argn argv)
2653                                    (if (or simple (cl-const-expr-p argv))
2654                                        (progn (setq body (subst argv argn body))
2655                                               (and unsafe (list argn argv)))
2656                                      (list argn argv)))
2657                                argns argvs))))
2658       (if lets (list 'let lets body) body))))
2659
2660
2661 ;;; Compile-time optimizations for some functions defined in this package.
2662 ;;; Note that cl.el arranges to force cl-macs to be loaded at compile-time,
2663 ;;; mainly to make sure these macros will be present.
2664
2665 (put 'eql 'byte-compile nil)
2666 (define-compiler-macro eql (&whole form a b)
2667   (cond ((eq (cl-const-expr-p a) t)
2668          (let ((val (cl-const-expr-val a)))
2669            (if (and (numberp val) (not (integerp val)))
2670                (list 'equal a b)
2671              (list 'eq a b))))
2672         ((eq (cl-const-expr-p b) t)
2673          (let ((val (cl-const-expr-val b)))
2674            (if (and (numberp val) (not (integerp val)))
2675                (list 'equal a b)
2676              (list 'eq a b))))
2677         ((cl-simple-expr-p a 5)
2678          (list 'if (list 'numberp a)
2679                (list 'equal a b)
2680                (list 'eq a b)))
2681         ((and (cl-safe-expr-p a)
2682               (cl-simple-expr-p b 5))
2683          (list 'if (list 'numberp b)
2684                (list 'equal a b)
2685                (list 'eq a b)))
2686         (t form)))
2687
2688 (define-compiler-macro member* (&whole form a list &rest keys)
2689   (let ((test (and (= (length keys) 2) (eq (car keys) ':test)
2690                    (cl-const-expr-val (nth 1 keys)))))
2691     (cond ((eq test 'eq) (list 'memq a list))
2692           ((eq test 'equal) (list 'member a list))
2693           ((or (null keys) (eq test 'eql))
2694            (if (eq (cl-const-expr-p a) t)
2695                (list (if (floatp-safe (cl-const-expr-val a)) 'member 'memq)
2696                      a list)
2697              (if (eq (cl-const-expr-p list) t)
2698                  (let ((p (cl-const-expr-val list)) (mb nil) (mq nil))
2699                    (if (not (cdr p))
2700                        (and p (list 'eql a (list 'quote (car p))))
2701                      (while p
2702                        (if (floatp-safe (car p)) (setq mb t)
2703                          (or (integerp (car p)) (symbolp (car p)) (setq mq t)))
2704                        (setq p (cdr p)))
2705                      (if (not mb) (list 'memq a list)
2706                        (if (not mq) (list 'member a list) form))))
2707                form)))
2708           (t form))))
2709
2710 (define-compiler-macro assoc* (&whole form a list &rest keys)
2711   (let ((test (and (= (length keys) 2) (eq (car keys) ':test)
2712                    (cl-const-expr-val (nth 1 keys)))))
2713     (cond ((eq test 'eq) (list 'assq a list))
2714           ((eq test 'equal) (list 'assoc a list))
2715           ((and (eq (cl-const-expr-p a) t) (or (null keys) (eq test 'eql)))
2716            (if (floatp-safe (cl-const-expr-val a))
2717                (list 'assoc a list) (list 'assq a list)))
2718           (t form))))
2719
2720 (define-compiler-macro adjoin (&whole form a list &rest keys)
2721   (if (and (cl-simple-expr-p a) (cl-simple-expr-p list)
2722            (not (memq ':key keys)))
2723       (list 'if (list* 'member* a list keys) list (list 'cons a list))
2724     form))
2725
2726 (define-compiler-macro list* (arg &rest others)
2727   (let* ((args (reverse (cons arg others)))
2728          (form (car args)))
2729     (while (setq args (cdr args))
2730       (setq form (list 'cons (car args) form)))
2731     form))
2732
2733 (define-compiler-macro get* (sym prop &optional default)
2734   (list 'get sym prop default))
2735
2736 (define-compiler-macro getf (sym prop &optional default)
2737   (list 'plist-get sym prop default))
2738
2739 (define-compiler-macro typep (&whole form val type)
2740   (if (cl-const-expr-p type)
2741       (let ((res (cl-make-type-test val (cl-const-expr-val type))))
2742         (if (or (memq (cl-expr-contains res val) '(nil 1))
2743                 (cl-simple-expr-p val)) res
2744           (let ((temp (gensym)))
2745             (list 'let (list (list temp val)) (subst temp val res)))))
2746     form))
2747
2748
2749 (mapc
2750  #'(lambda (y)
2751      (put (car y) 'side-effect-free t)
2752      (put (car y) 'byte-compile 'cl-byte-compile-compiler-macro)
2753      (put (car y) 'cl-compiler-macro
2754           (list 'lambda '(w x)
2755                 (if (symbolp (cadr y))
2756                     (list 'list (list 'quote (cadr y))
2757                           (list 'list (list 'quote (caddr y)) 'x))
2758                   (cons 'list (cdr y))))))
2759  '((first 'car x) (second 'cadr x) (third 'caddr x) (fourth 'cadddr x)
2760    (fifth 'nth 4 x) (sixth 'nth 5 x) (seventh 'nth 6 x)
2761    (eighth 'nth 7 x) (ninth 'nth 8 x) (tenth 'nth 9 x)
2762    (rest 'cdr x) (endp 'null x) (plusp '> x 0) (minusp '< x 0)
2763    (oddp  'eq (list 'logand x 1) 1)
2764    (evenp 'eq (list 'logand x 1) 0)
2765    (caar car car) (cadr car cdr) (cdar cdr car) (cddr cdr cdr)
2766    (caaar car caar) (caadr car cadr) (cadar car cdar)
2767    (caddr car cddr) (cdaar cdr caar) (cdadr cdr cadr)
2768    (cddar cdr cdar) (cdddr cdr cddr) (caaaar car caaar)
2769    (caaadr car caadr) (caadar car cadar) (caaddr car caddr)
2770    (cadaar car cdaar) (cadadr car cdadr) (caddar car cddar)
2771    (cadddr car cdddr) (cdaaar cdr caaar) (cdaadr cdr caadr)
2772    (cdadar cdr cadar) (cdaddr cdr caddr) (cddaar cdr cdaar)
2773    (cddadr cdr cdadr) (cdddar cdr cddar) (cddddr cdr cdddr)))
2774
2775 ;;; Things that are inline.
2776 (proclaim '(inline floatp-safe acons map concatenate notany notevery
2777 ;; XEmacs change
2778                    cl-set-elt revappend nreconc
2779                    ))
2780
2781 ;;; Things that are side-effect-free.  Moved to byte-optimize.el
2782 ;(dolist (fun '(oddp evenp plusp minusp
2783 ;                   abs expt signum last butlast ldiff
2784 ;                   pairlis gcd lcm
2785 ;                   isqrt floor* ceiling* truncate* round* mod* rem* subseq
2786 ;                   list-length getf))
2787 ;  (put fun 'side-effect-free t))
2788
2789 ;;; Things that are side-effect-and-error-free.  Moved to byte-optimize.el
2790 ;(dolist (fun '(eql floatp-safe list* subst acons equalp random-state-p
2791 ;                  copy-tree sublis))
2792 ;  (put fun 'side-effect-free 'error-free))
2793
2794
2795 (run-hooks 'cl-macs-load-hook)
2796
2797 ;;; cl-macs.el ends here