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