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