| blob | 0096e0aab3e9c440c414055ebb5a4d675e609cb0 |
1 ;;; cl-macs.el --- Common Lisp macros -*- lexical-binding: t -*-
3 ;; Copyright (C) 1993, 2001-2016 Free Software Foundation, Inc.
5 ;; Author: Dave Gillespie <daveg@synaptics.com>
6 ;; Old-Version: 2.02
7 ;; Keywords: extensions
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; These are extensions to Emacs Lisp that provide a degree of
28 ;; Common Lisp compatibility, beyond what is already built-in
29 ;; in Emacs Lisp.
30 ;;
31 ;; This package was written by Dave Gillespie; it is a complete
32 ;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
33 ;;
34 ;; Bug reports, comments, and suggestions are welcome!
36 ;; This file contains the portions of the Common Lisp extensions
37 ;; package which should be autoloaded, but need only be present
38 ;; if the compiler or interpreter is used---this file is not
39 ;; necessary for executing compiled code.
41 ;; See cl.el for Change Log.
44 ;;; Code:
48 ;; `gv' is required here because cl-macs can be loaded before loaddefs.el.
59 ;;; Initialization.
61 ;; Place compiler macros at the beginning, otherwise uses of the corresponding
62 ;; functions can lead to recursive-loads that prevent the calls from
63 ;; being optimized.
65 ;;;###autoload
71 form))
73 ;; Note: `cl--compiler-macro-cXXr' has been copied to
74 ;; `internal--compiler-macro-cXXr' in subr.el. If you amend either
75 ;; one, you may want to amend the other, too.
76 ;;;###autoload
80 ;;; Some predicates for analyzing Lisp forms.
81 ;; These are used by various
82 ;; macro expanders to optimize the results in certain common cases.
85 car-safe cdr-safe progn prog1 prog2))
90 "Check if no side effects, and executes quickly."
109 "Check if no side effects."
119 ;;; Check if constant (i.e., no side effects or dependencies).
130 "Return the value of X known at compile-time.
131 If X is not known at compile time, return nil. Before testing
132 whether X is known at compile time, macroexpand it completely in
133 `macroexpand-all-environment'."
139 "Count number of times X refers to Y. Return nil for 0 times."
140 ;; FIXME: This is naive, and it will cl-count Y as referred twice in
141 ;; (let ((Y 1)) Y) even though it should be 0. Also it is often called on
142 ;; non-macroexpanded code, so it may also miss some occurrences that would
143 ;; only appear in the expanded code.
155 y)
158 "Check whether X may depend on any of the symbols in Y."
162 ;;; Symbols.
165 ;;;###autoload
167 "Generate a new uninterned symbol.
175 ;;;###autoload
177 "Generate a new interned symbol with a unique name.
180 name)
186 ;;; Program structure.
202 )))
215 ;; Internal hacks used in formal arg lists:
216 ;; - &cl-quote: Added to formal-arglists to mean that any default value
217 ;; mentioned in the formal arglist should be considered as implicitly
218 ;; quoted rather than evaluated. This is used in `cl-defsubst' when
219 ;; performing compiler-macro-expansion, since at that time the
220 ;; arguments hold expressions rather than values.
221 ;; - &cl-defs (DEF . DEFS): Gives the default value to use for missing
222 ;; optional arguments which don't have an explicit default value.
223 ;; DEFS is an alist mapping vars to their default default value.
224 ;; and DEF is the default default to use for all other vars.
232 "Transform a function form FORM of name BIND-BLOCK.
233 BIND-BLOCK is the name of the symbol to which the function will be bound,
234 and which will be used for the name of the `cl-block' surrounding the
235 function's body.
236 FORM is of the form (ARGS . BODY)."
242 ;; "(. X) to (&rest X)" conversion already done in cl--do-arglist, but we
243 ;; do it here as well, so as to be able to see if we can avoid
244 ;; cl--do-arglist.
250 ;; Remove "&cl-defs DEFS" from args.
260 ;; Take away all the simple args whose parsing can be handled more
261 ;; efficiently by a plain old `lambda' than the manual parsing generated
262 ;; by `cl--do-arglist'.
267 ;; Optional args whose default is nil are simple.
274 ;; Don't keep a dummy trailing &optional without actual optional args.
285 nil)
287 ;; so we pass the rest to cl--do-arglist which will do
288 ;; "manual" parsing.
293 ;; Macro expansion can take place in the middle of
294 ;; apparently harmless computation, so it should not
295 ;; touch the match-data.
299 ;; Be careful with make-symbol and (back)quote,
300 ;; see bug#12884.
305 orig-args))))))
306 header)))
307 ;; FIXME: we'd want to choose an arg name for the &rest param
308 ;; and pass that as `expr' to cl--do-arglist, but that ends up
309 ;; generating code with a redundant let-binding, so we instead
310 ;; pass a dummy and then look in cl--bind-lets to find what var
311 ;; this was bound to.
314 ;; (cl-assert (eq :dummy (nth 1 (car cl--bind-lets))))
318 ,@header
324 ;;;###autoload
326 "Define NAME as a function.
327 Like normal `defun', except ARGLIST allows full Common Lisp conventions,
328 and BODY is implicitly surrounded by (cl-block NAME ...).
330 The full form of a Common Lisp function argument list is
332 (VAR...
333 [&optional (VAR [INITFORM [SVAR]])...]
334 [&rest|&body VAR]
335 [&key (([KEYWORD] VAR) [INITFORM [SVAR]])... [&allow-other-keys]]
336 [&aux (VAR [INITFORM])...])
338 VAR maybe be replaced recursively with an argument list for
339 destructing, `&whole' is supported within these sublists. If
340 SVAR, INITFORM, and KEYWORD are all omitted, then `(VAR)' may be
341 written simply `VAR'. See the Info node `(cl)Argument Lists' for
342 more details.
344 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
346 ;; Same as defun but use cl-lambda-list.
348 cl-lambda-list
349 cl-declarations-or-string
351 def-body))
358 ;;;###autoload
360 "Define NAME as a generator function.
361 Like normal `iter-defun', except ARGLIST allows full Common Lisp conventions,
362 and BODY is implicitly surrounded by (cl-block NAME ...).
364 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
366 ;; Same as iter-defun but use cl-lambda-list.
368 cl-lambda-list
369 cl-declarations-or-string
371 def-body))
379 ;; The lambda list for macros is different from that of normal lambdas.
380 ;; Note that &environment is only allowed as first or last items in the
381 ;; top level list.
392 arg]]
397 )))
411 arg]]
417 ;;;###autoload
419 "Define NAME as a macro.
420 Like normal `defmacro', except ARGLIST allows full Common Lisp conventions,
421 and BODY is implicitly surrounded by (cl-block NAME ...).
423 The full form of a Common Lisp macro argument list is
425 (VAR...
426 [&optional (VAR [INITFORM [SVAR]])...]
427 [&rest|&body VAR]
428 [&key (([KEYWORD] VAR) [INITFORM [SVAR]])... [&allow-other-keys]]
429 [&aux (VAR [INITFORM])...]
430 [&environment VAR])
432 VAR maybe be replaced recursively with an argument list for
433 destructing, `&whole' is supported within these sublists. If
434 SVAR, INITFORM, and KEYWORD are all omitted, then `(VAR)' may be
435 written simply `VAR'. See the Info node `(cl)Argument Lists' for
436 more details.
438 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
449 ;;cl-declarations-or-string
450 ;;[&optional ("interactive" interactive)]
451 def-body)))
453 ;; Redefine function-form to also match cl-function
455 ;; form at the end could also handle "function",
456 ;; but recognize it specially to avoid wrapping function forms.
459 form))
461 ;;;###autoload
463 "Introduce a function.
464 Like normal `function', except that if argument is a lambda form,
465 its argument list allows full Common Lisp conventions."
474 "X can be a var or a (destructuring) lambda-list."
483 ;; `&aux' args aren't arguments, so let's just drop them from the
484 ;; usage info.
494 ;; `orig-args' can contain &cl-defs.
504 ;; Strip a leading underscore, since it only
505 ;; means that this argument is unused.
518 ))))
519 arglist))))
563 restarg)))
596 cl--bind-forms)))
603 ;; Strip a leading underscore, since it only
604 ;; means that this argument is unused, but
605 ;; shouldn't affect the key's name (bug#12367).
611 ;; The ordering between those two or clauses is
612 ;; irrelevant, since in practice only one of the two
613 ;; is ever non-nil (the car is only used for
614 ;; cl-deftype which doesn't use the cdr).
628 varg
630 look
650 keys)
654 nil)))
668 ;;;###autoload
670 "Bind the variables in ARGS to the result of EXPR and execute BODY."
680 ;;; The `cl-eval-when' form.
684 ;;;###autoload
686 "Control when BODY is evaluated.
687 If `compile' is in WHEN, BODY is evaluated when compiled at top-level.
688 If `load' is in WHEN, BODY is evaluated when loaded after top-level compile.
689 If `eval' is in WHEN, BODY is evaluated when interpreted or at non-top-level.
691 \(fn (WHEN...) BODY...)"
714 form)))
717 ;;;###autoload
719 "Like `progn', but evaluates the body at load time.
720 The result of the body appears to the compiler as a quoted constant."
727 ;; Else, we can't output right away, so we have to delay it to the
728 ;; next time we're at the top-level.
729 ;; FIXME: Use advice-add/remove.
736 ;; If we're not in the middle of compiling something, we can
737 ;; output directly to byte-compile-outbuffer, to make sure
738 ;; temp is set before we use it.
740 temp)
744 ;;; Conditional control structures.
746 ;;;###autoload
748 "Eval EXPR and choose among clauses on that value.
749 Each clause looks like (KEYLIST BODY...). EXPR is evaluated and compared
750 against each key in each KEYLIST; the corresponding BODY is evaluated.
751 If no clause succeeds, cl-case returns nil. A single atom may be used in
752 place of a KEYLIST of one atom. A KEYLIST of t or `otherwise' is
753 allowed only in the final clause, and matches if no other keys match.
754 Key values are compared by `eql'.
776 clauses)))))
778 ;;;###autoload
780 "Like `cl-case', but error if no case fits.
781 `otherwise'-clauses are not allowed.
786 ;;;###autoload
788 "Evals EXPR, chooses among clauses on that value.
789 Each clause looks like (TYPE BODY...). EXPR is evaluated and, if it
790 satisfies TYPE, the corresponding BODY is evaluated. If no clause succeeds,
791 cl-typecase returns nil. A TYPE of t or `otherwise' is allowed only in the
792 final clause, and matches if no other keys match.
799 'cond
811 clauses)))))
813 ;;;###autoload
815 "Like `cl-typecase', but error if no case fits.
816 `otherwise'-clauses are not allowed.
822 ;;; Blocks and exits.
824 ;;;###autoload
826 "Define a lexically-scoped block named NAME.
827 NAME may be any symbol. Code inside the BODY forms can call `cl-return-from'
828 to jump prematurely out of the block. This differs from `catch' and `throw'
829 in two respects: First, the NAME is an unevaluated symbol rather than a
830 quoted symbol or other form; and second, NAME is lexically rather than
831 dynamically scoped: Only references to it within BODY will work. These
832 references may appear inside macro expansions, but not inside functions
833 called from BODY."
840 ;;;###autoload
842 "Return from the block named nil.
843 This is equivalent to `(cl-return-from nil RESULT)'."
847 ;;;###autoload
849 "Return from the block named NAME.
850 This jumps out to the innermost enclosing `(cl-block NAME ...)' form,
851 returning RESULT from that form (or nil if RESULT is omitted).
852 This is compatible with Common Lisp, but note that `defun' and
853 `defmacro' do not create implicit blocks as they do in Common Lisp."
859 ;;; The "cl-loop" macro.
874 ;; FIXME: Of course, we could make it work, but why bother.
878 ;;;###autoload
880 "The Common Lisp `loop' macro.
881 Valid clauses include:
882 For clauses:
883 for VAR from/upfrom/downfrom EXPR1 to/upto/downto/above/below EXPR2 [by EXPR3]
884 for VAR = EXPR1 then EXPR2
885 for VAR in/on/in-ref LIST [by FUNC]
886 for VAR across/across-ref ARRAY
887 for VAR being:
888 the elements of/of-ref SEQUENCE [using (index VAR2)]
889 the symbols [of OBARRAY]
890 the hash-keys/hash-values of HASH-TABLE [using (hash-values/hash-keys V2)]
891 the key-codes/key-bindings/key-seqs of KEYMAP [using (key-bindings VAR2)]
892 the overlays/intervals [of BUFFER] [from POS1] [to POS2]
893 the frames/buffers
894 the windows [of FRAME]
895 Iteration clauses:
896 repeat INTEGER
897 while/until/always/never/thereis CONDITION
898 Accumulation clauses:
899 collect/append/nconc/concat/vconcat/count/sum/maximize/minimize FORM
900 [into VAR]
901 Miscellaneous clauses:
902 with VAR = INIT
903 if/when/unless COND CLAUSE [and CLAUSE]... else CLAUSE [and CLAUSE...]
904 named NAME
905 initially/finally [do] EXPRS...
906 do EXPRS...
907 [finally] return EXPR
909 For more details, see Info node `(cl)Loop Facility'.
911 \(fn CLAUSE...)"
913 ;; These are usually followed by a symbol, but it can
914 ;; actually be any destructuring-bind pattern, which
915 ;; would erroneously match `form'.
917 ;; These are followed by expressions which could
918 ;; erroneously match `symbolp'.
925 form]
926 ;; Simple default, which covers 99% of the cases.
927 symbolp form)))
939 ;; Here is more or less how those dynbind vars are used after looping
940 ;; over cl--parse-loop-clause:
941 ;;
942 ;; (cl-block ,cl--loop-name
943 ;; (cl-symbol-macrolet ,cl--loop-symbol-macs
944 ;; (foldl #'cl--loop-let
945 ;; `((,cl--loop-result-var)
946 ;; ((,cl--loop-first-flag t))
947 ;; ((,cl--loop-finish-flag t))
948 ;; ,@cl--loop-bindings)
949 ;; ,@(nreverse cl--loop-initially)
950 ;; (while ;(well: cl--loop-iterator-function)
951 ;; ,(car (cl--loop-build-ands (nreverse cl--loop-body)))
952 ;; ,@(cadr (cl--loop-build-ands (nreverse cl--loop-body)))
953 ;; ,@(nreverse cl--loop-steps)
954 ;; (setq ,cl--loop-first-flag nil))
955 ;; (if (not ,cl--loop-finish-flag) ;FIXME: Why `if' vs `progn'?
956 ;; ,cl--loop-result-var
957 ;; ,@(nreverse cl--loop-finally)
958 ;; ,(or cl--loop-result-explicit
959 ;; cl--loop-result)))))
960 ;;
971 cl--loop-result))))
982 --cl-finish--
983 nil))
984 while-body))))
990 epilogue))))
1006 ;; Below is a complete spec for cl-loop, in several parts that correspond
1007 ;; to the syntax given in CLtL2. The specs do more than specify where
1008 ;; the forms are; it also specifies, as much as Edebug allows, all the
1009 ;; syntactically valid cl-loop clauses. The disadvantage of this
1010 ;; completeness is rigidity, but the "for ... being" clause allows
1011 ;; arbitrary extensions of the form: [symbolp &rest &or symbolp form].
1013 ;; (def-edebug-spec cl-loop
1014 ;; ([&optional ["named" symbolp]]
1015 ;; [&rest
1016 ;; &or
1017 ;; ["repeat" form]
1018 ;; loop-for-as
1019 ;; loop-with
1020 ;; loop-initial-final]
1021 ;; [&rest loop-clause]
1022 ;; ))
1024 ;; (def-edebug-spec loop-with
1025 ;; ("with" loop-var
1026 ;; loop-type-spec
1027 ;; [&optional ["=" form]]
1028 ;; &rest ["and" loop-var
1029 ;; loop-type-spec
1030 ;; [&optional ["=" form]]]))
1032 ;; (def-edebug-spec loop-for-as
1033 ;; ([&or "for" "as"] loop-for-as-subclause
1034 ;; &rest ["and" loop-for-as-subclause]))
1036 ;; (def-edebug-spec loop-for-as-subclause
1037 ;; (loop-var
1038 ;; loop-type-spec
1039 ;; &or
1040 ;; [[&or "in" "on" "in-ref" "across-ref"]
1041 ;; form &optional ["by" function-form]]
1043 ;; ["=" form &optional ["then" form]]
1044 ;; ["across" form]
1045 ;; ["being"
1046 ;; [&or "the" "each"]
1047 ;; &or
1048 ;; [[&or "element" "elements"]
1049 ;; [&or "of" "in" "of-ref"] form
1050 ;; &optional "using" ["index" symbolp]];; is this right?
1051 ;; [[&or "hash-key" "hash-keys"
1052 ;; "hash-value" "hash-values"]
1053 ;; [&or "of" "in"]
1054 ;; hash-table-p &optional ["using" ([&or "hash-value" "hash-values"
1055 ;; "hash-key" "hash-keys"] sexp)]]
1057 ;; [[&or "symbol" "present-symbol" "external-symbol"
1058 ;; "symbols" "present-symbols" "external-symbols"]
1059 ;; [&or "in" "of"] package-p]
1061 ;; ;; Extensions for Emacs Lisp, including Lucid Emacs.
1062 ;; [[&or "frame" "frames"
1063 ;; "screen" "screens"
1064 ;; "buffer" "buffers"]]
1066 ;; [[&or "window" "windows"]
1067 ;; [&or "of" "in"] form]
1069 ;; [[&or "overlay" "overlays"
1070 ;; "extent" "extents"]
1071 ;; [&or "of" "in"] form
1072 ;; &optional [[&or "from" "to"] form]]
1074 ;; [[&or "interval" "intervals"]
1075 ;; [&or "in" "of"] form
1076 ;; &optional [[&or "from" "to"] form]
1077 ;; ["property" form]]
1079 ;; [[&or "key-code" "key-codes"
1080 ;; "key-seq" "key-seqs"
1081 ;; "key-binding" "key-bindings"]
1082 ;; [&or "in" "of"] form
1083 ;; &optional ["using" ([&or "key-code" "key-codes"
1084 ;; "key-seq" "key-seqs"
1085 ;; "key-binding" "key-bindings"]
1086 ;; sexp)]]
1087 ;; ;; For arbitrary extensions, recognize anything else.
1088 ;; [symbolp &rest &or symbolp form]
1089 ;; ]
1091 ;; ;; arithmetic - must be last since all parts are optional.
1092 ;; [[&optional [[&or "from" "downfrom" "upfrom"] form]]
1093 ;; [&optional [[&or "to" "downto" "upto" "below" "above"] form]]
1094 ;; [&optional ["by" form]]
1095 ;; ]))
1097 ;; (def-edebug-spec loop-initial-final
1098 ;; (&or ["initially"
1099 ;; ;; [&optional &or "do" "doing"] ;; CLtL2 doesn't allow this.
1100 ;; &rest loop-non-atomic-expr]
1101 ;; ["finally" &or
1102 ;; [[&optional &or "do" "doing"] &rest loop-non-atomic-expr]
1103 ;; ["return" form]]))
1105 ;; (def-edebug-spec loop-and-clause
1106 ;; (loop-clause &rest ["and" loop-clause]))
1108 ;; (def-edebug-spec loop-clause
1109 ;; (&or
1110 ;; [[&or "while" "until" "always" "never" "thereis"] form]
1112 ;; [[&or "collect" "collecting"
1113 ;; "append" "appending"
1114 ;; "nconc" "nconcing"
1115 ;; "concat" "vconcat"] form
1116 ;; [&optional ["into" loop-var]]]
1118 ;; [[&or "count" "counting"
1119 ;; "sum" "summing"
1120 ;; "maximize" "maximizing"
1121 ;; "minimize" "minimizing"] form
1122 ;; [&optional ["into" loop-var]]
1123 ;; loop-type-spec]
1125 ;; [[&or "if" "when" "unless"]
1126 ;; form loop-and-clause
1127 ;; [&optional ["else" loop-and-clause]]
1128 ;; [&optional "end"]]
1130 ;; [[&or "do" "doing"] &rest loop-non-atomic-expr]
1132 ;; ["return" form]
1133 ;; loop-initial-final
1134 ;; ))
1136 ;; (def-edebug-spec loop-non-atomic-expr
1137 ;; ([¬ atom] form))
1139 ;; (def-edebug-spec loop-var
1140 ;; ;; The symbolp must be last alternative to recognize e.g. (a b . c)
1141 ;; ;; loop-var =>
1142 ;; ;; (loop-var . [&or nil loop-var])
1143 ;; ;; (symbolp . [&or nil loop-var])
1144 ;; ;; (symbolp . loop-var)
1145 ;; ;; (symbolp . (symbolp . [&or nil loop-var]))
1146 ;; ;; (symbolp . (symbolp . loop-var))
1147 ;; ;; (symbolp . (symbolp . symbolp)) == (symbolp symbolp . symbolp)
1148 ;; (&or (loop-var . [&or nil loop-var]) [gate symbolp]))
1150 ;; (def-edebug-spec loop-type-spec
1151 ;; (&optional ["of-type" loop-d-type-spec]))
1153 ;; (def-edebug-spec loop-d-type-spec
1154 ;; (&or (loop-d-type-spec . [&or nil loop-d-type-spec]) cl-type-spec))
1162 key-binding key-bindings)))
1195 ;; Use `cl-gensym' rather than `make-symbol'. It's important that
1196 ;; (not (eq (symbol-name var1) (symbol-name var2))) because
1197 ;; these vars get added to the macro-environment.
1208 above below by))
1235 loop-for-bindings))
1240 cl--loop-body))
1243 loop-for-steps)))
1257 loop-for-sets))))
1263 cl-function))
1268 loop-for-steps)))
1282 loop-for-sets)
1290 loop-for-sets))))
1299 cl--loop-body)
1302 cl--loop-symbol-macs)
1305 loop-for-sets))))
1325 loop-for-bindings)
1327 cl--loop-symbol-macs)
1333 cl--loop-body)
1337 loop-for-sets))
1339 loop-for-steps)))
1361 symbols present-symbols external-symbols))
1427 loop-for-bindings)
1431 cl--loop-body)
1433 loop-for-steps)))
1443 loop-for-bindings)
1444 ;; If we started in the minibuffer, we need to
1445 ;; ensure that next-window will bring us back there
1446 ;; at some point. (Bug#7492).
1447 ;; (Consider using walk-windows instead of cl-loop if
1448 ;; you care about such things.)
1450 loop-for-bindings)
1454 cl--loop-body)
1456 loop-for-steps)))
1459 ;; This is an advertised interface: (info "(cl)Other Clauses").
1471 cl--loop-bindings)))
1475 t)
1476 cl--loop-body))
1480 cl--loop-steps))))
1494 t)
1495 cl--loop-body))))
1511 t)
1512 cl--loop-body)))
1541 t)
1542 cl--loop-body))
1549 bindings)
1570 cl--loop-body)
1580 cl--loop-body))
1614 cl--loop-body))
1617 ;; This is an advertised interface: (info "(cl)Other Clauses").
1628 "Build an expression equivalent to (let SPECS BODY).
1629 SPECS can include bindings using `cl-loop's destructuring (not to be
1630 confused with the patterns of `cl-destructuring-bind').
1631 If PAR is nil, do the bindings step by step, like `let*'.
1632 If BODY is `setq', then use SPECS for assignments rather than for bindings."
1653 nil ;; Don't bother declaring/setting `temp' since it won't
1654 ;; be used when `expr' is nil, anyway.
1657 ;; Prefer a fresh uninterned symbol over "_to", to avoid
1658 ;; warnings that we set an unused variable.
1660 ;; Make sure this temp variable is locally declared.
1667 nspecs))
1683 var)
1688 def))
1689 cl--loop-bindings)
1691 cl--loop-accum-var))
1692 cl--loop-accum-var))))
1695 "Return various representations of (and . CLAUSES).
1696 CLAUSES is a list of Elisp expressions, where clauses of the form
1697 \(progn E1 E2 E3 .. t) are the focus of particular optimizations.
1698 The return value has shape (COND BODY COMBO)
1699 such that COMBO is equivalent to (and . CLAUSES)."
1702 ;; Look through `clauses', trying to optimize (progn ,@A t) (progn ,@B) ,@C
1703 ;; into (progn ,@A ,@B) ,@C.
1714 ;; A final (progn ,@A t) is moved outside of the `and'.
1719 body
1722 ands)))
1726 ;;; Other iteration control structures.
1728 ;;;###autoload
1730 "The Common Lisp `do' loop.
1732 \(fn ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
1737 cl-declarations body)))
1740 ;;;###autoload
1742 "The Common Lisp `do*' loop.
1744 \(fn ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)"
1752 steps)
1754 ,@body
1758 steps)))
1766 ;;;###autoload
1768 "Loop over a list.
1769 Evaluate BODY with VAR bound to each `car' from LIST, in turn.
1770 Then evaluate RESULT to get return value, default nil.
1771 An implicit nil block is established around the loop.
1773 \(fn (VAR LIST [RESULT]) BODY...)"
1780 ;;;###autoload
1782 "Loop a certain number of times.
1783 Evaluate BODY with VAR bound to successive integers from 0, inclusive,
1784 to COUNT, exclusive. Then evaluate RESULT to get return value, default
1785 nil.
1787 \(fn (VAR COUNT [RESULT]) BODY...)"
1795 ;;;###autoload
1797 "Execute statements while providing for control transfers to labels.
1798 Each element of LABELS-OR-STMTS can be either a label (integer or symbol)
1799 or a `cons' cell, in which case it's taken to be a statement.
1800 This distinction is made before performing macroexpansion.
1801 Statements are executed in sequence left to right, discarding any return value,
1802 stopping only when reaching the end of LABELS-OR-STMTS.
1803 Any statement can transfer control at any time to the statements that follow
1804 one of the labels with the special form (go LABEL).
1805 Labels have lexical scope and dynamic extent."
1812 ;; Add a "go to next block" to implement the fallthrough.
1849 ;;;###autoload
1851 "Run BODY like a `cl-tagbody' after setting up the BINDINGS.
1852 Shorthand for (cl-block nil (let BINDINGS (cl-tagbody BODY)))"
1855 ;;;###autoload
1857 "Run BODY like a `cl-tagbody' after setting up the BINDINGS.
1858 Shorthand for (cl-block nil (let* BINDINGS (cl-tagbody BODY)))"
1861 ;;;###autoload
1863 "Loop over all symbols.
1864 Evaluate BODY with VAR bound to each interned symbol, or to each symbol
1865 from OBARRAY.
1867 \(fn (VAR [OBARRAY [RESULT]]) BODY...)"
1870 ;; Apparently this doesn't have an implicit block.
1877 ;;;###autoload
1879 "Like `cl-do-symbols', but use the default obarray.
1881 \(fn (VAR [RESULT]) BODY...)"
1886 ;;; Assignments.
1888 ;;;###autoload
1890 "Set SYMs to the values VALs in parallel.
1891 This is like `setq', except that all VAL forms are evaluated (in order)
1892 before assigning any symbols SYM to the corresponding values.
1894 \(fn SYM VAL SYM VAL ...)"
1899 ;;; Binding control structures.
1901 ;;;###autoload
1903 "Bind SYMBOLS to VALUES dynamically in BODY.
1904 The forms SYMBOLS and VALUES are evaluated, and must evaluate to lists.
1905 Each symbol in the first list is bound to the corresponding value in the
1906 second list (or to nil if VALUES is shorter than SYMBOLS); then the
1907 BODY forms are executed and their result is returned. This is much like
1908 a `let' form, except that the list of symbols can be computed at run-time."
1928 "Special macro-expander to rename (function F) references in `cl-labels'."
1930 ;; ¡¡Big Ugly Hack!! We can't use a compiler-macro because those are checked
1931 ;; *after* handling `function', but we want to stop macroexpansion from
1932 ;; being applied infinitely, so we use a cache to return the exact `form'
1933 ;; being expanded even though we don't receive it.
1944 res))))))
1946 ;;;###autoload
1948 "Make local function definitions.
1949 Like `cl-labels' but the definitions are not recursive.
1950 Each binding can take the form (FUNC EXP) where
1951 FUNC is the function name, and EXP is an expression that returns the
1952 function value to which it should be bound, or it can take the more common
1953 form \(FUNC ARGLIST BODY...) which is a shorthand
1954 for (FUNC (lambda ARGLIST BODY)).
1956 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
1963 ;; Optimize (cl-flet ((fun var)) body).
1968 binds))
1974 newenv)))
1975 ;; FIXME: Eliminate those functions which aren't referenced.
1979 ;; Don't override lexical-let's macro-expander.
1983 ;;;###autoload
1985 "Make local function definitions.
1986 Like `cl-flet' but the definitions can refer to previous ones.
1988 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
1995 ;;;###autoload
1997 "Make temporary function bindings.
1998 The bindings can be recursive and the scoping is lexical, but capturing them
1999 in closures will only work if `lexical-binding' is in use.
2001 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
2012 newenv)))
2014 ;; Don't override lexical-let's macro-expander.
2018 ;; The following ought to have a better definition for use with newer
2019 ;; byte compilers.
2020 ;;;###autoload
2022 "Make temporary macro definitions.
2023 This is like `cl-flet', but for macros instead of functions.
2025 \(fn ((NAME ARGLIST BODY...) ...) FORM...)"
2029 def-body))
2030 cl-declarations body)))
2040 macroexpand-all-environment))))))
2046 cl--old-macroexpand
2050 "Special macro expander used inside `cl-symbol-macrolet'.
2051 This function replaces `macroexpand' during macro expansion
2052 of `cl-symbol-macrolet', and does the same thing as `macroexpand'
2053 except that it additionally expands symbol macros."
2060 ;; Perform symbol-macro expansion.
2064 ;; Convert setq to setf if required by symbol-macro expansion.
2071 ;; Don't loop further.
2072 nil)))
2074 ;; CL's symbol-macrolet treats re-bindings as candidates for
2075 ;; expansion (turning the let into a letf if needed), contrary to
2076 ;; Common-Lisp where such re-bindings hide the symbol-macro.
2082 binding
2087 nbs)))
2094 ;; FIXME: The behavior of CL made sense in a dynamically scoped
2095 ;; language, but for lexical scoping, Common-Lisp's behavior might
2096 ;; make more sense (and indeed, CL behaves like Common-Lisp w.r.t
2097 ;; lexical-let), so maybe we should adjust the behavior based on
2098 ;; the use of lexical-binding.
2099 ;; (`(,(or `let `let*) . ,(or `(,bindings . ,body) dontcare))
2100 ;; (let ((nbs ()) (found nil))
2101 ;; (dolist (binding bindings)
2102 ;; (let* ((var (if (symbolp binding) binding (car binding)))
2103 ;; (name (symbol-name var))
2104 ;; (val (and found (consp binding) (eq 'let* (car exp))
2105 ;; (list (macroexpand-all (cadr binding)
2106 ;; env)))))
2107 ;; (push (if (assq name env)
2108 ;; ;; This binding should hide its symbol-macro,
2109 ;; ;; but given the way macroexpand-all works, we
2110 ;; ;; can't prevent application of `env' to the
2111 ;; ;; sub-expressions, so we need to α-rename this
2112 ;; ;; variable instead.
2113 ;; (let ((nvar (make-symbol
2114 ;; (copy-sequence name))))
2115 ;; (setq found t)
2116 ;; (push (list name nvar) env)
2117 ;; (cons nvar (or val (cdr-safe binding))))
2118 ;; (if val (cons var val) binding))
2119 ;; nbs)))
2120 ;; (when found
2121 ;; (setq exp `(,(car exp)
2122 ;; ,(nreverse nbs)
2123 ;; ,@(macroexp-unprogn
2124 ;; (macroexpand-all (macroexp-progn body)
2125 ;; env)))))
2126 ;; nil))
2127 )))
2128 exp))
2130 ;;;###autoload
2132 "Make symbol macro definitions.
2133 Within the body FORMs, references to the variable NAME will be replaced
2134 by EXPANSION, and (setq NAME ...) will act like (setf EXPANSION ...).
2136 \(fn ((NAME EXPANSION) ...) FORM...)"
2149 ;; FIXME: For N bindings, this will traverse `body' N times!
2153 macroexpand-all-environment))))
2158 expansion)
2159 expansion)))
2162 ;;; Multiple values.
2164 ;;;###autoload
2166 "Collect multiple return values.
2167 FORM must return a list; the BODY is then executed with the first N elements
2168 of this list bound (`let'-style) to each of the symbols SYM in turn. This
2169 is analogous to the Common Lisp `multiple-value-bind' macro, using lists to
2170 simulate true multiple return values. For compatibility, (cl-values A B C) is
2171 a synonym for (list A B C).
2173 \(fn (SYM...) FORM BODY)"
2179 vars))
2182 ;;;###autoload
2184 "Collect multiple return values.
2185 FORM must return a list; the first N elements of this list are stored in
2186 each of the symbols SYM in turn. This is analogous to the Common Lisp
2187 `multiple-value-setq' macro, using lists to simulate true multiple return
2188 values. For compatibility, (cl-values A B C) is a synonym for (list A B C).
2190 \(fn (SYM...) FORM)"
2202 vars)))))))))
2205 ;;; Declarations.
2207 ;;;###autoload
2209 "Equivalent to `progn'."
2212 ;;;###autoload
2214 "Return FORM. If type-checking is enabled, assert that it is of TYPE."
2219 form
2266 nil)
2268 ;;; Process any proclamations made before cl-macs was loaded.
2274 ;;;###autoload
2276 "Declare SPECS about the current function while compiling.
2277 For instance
2279 (cl-declare (warn 0))
2281 will turn off byte-compile warnings in the function.
2282 See Info node `(cl)Declarations' for details."
2287 nil)
2289 ;;; The standard modify macros.
2291 ;; `setf' is now part of core Elisp, defined in gv.el.
2293 ;;;###autoload
2295 "Set PLACEs to the values VALs in parallel.
2296 This is like `setf', except that all VAL forms are evaluated (in order)
2297 before assigning any PLACEs to the corresponding values.
2299 \(fn PLACE VAL PLACE VAL ...)"
2318 ;;;###autoload
2320 "Remove TAG from property list PLACE.
2321 PLACE may be a symbol, or any generalized variable allowed by `setf'.
2322 The form returns true if TAG was found and removed, nil otherwise."
2328 t)
2331 ;;;###autoload
2333 "Shift left among PLACEs.
2334 Example: (cl-shiftf A B C) sets A to B, B to C, and returns the old A.
2335 Each PLACE may be a symbol, or any generalized variable allowed by `setf'.
2337 \(fn PLACE... VAL)"
2347 ;;;###autoload
2349 "Rotate left among PLACEs.
2350 Example: (cl-rotatef A B C) sets A to B, B to C, and C to A. It returns nil.
2351 Each PLACE may be a symbol, or any generalized variable allowed by `setf'.
2353 \(fn PLACE...)"
2373 ;; FIXME: `letf' is unsatisfactory because it does not really "restore" the
2374 ;; previous state. If the getter/setter loses information, that info is
2375 ;; not recovered.
2378 ;; It's not quite clear what the semantics of cl-letf should be.
2379 ;; E.g. in (cl-letf ((PLACE1 VAL1) (PLACE2 VAL2)) BODY), while it's clear
2380 ;; that the actual assignments ("bindings") should only happen after
2381 ;; evaluating VAL1 and VAL2, it's not clear when the sub-expressions of
2382 ;; PLACE1 and PLACE2 should be evaluated. Should we have
2383 ;; PLACE1; VAL1; PLACE2; VAL2; bind1; bind2
2384 ;; or
2385 ;; VAL1; VAL2; PLACE1; PLACE2; bind1; bind2
2386 ;; or
2387 ;; VAL1; VAL2; PLACE1; bind1; PLACE2; bind2
2388 ;; Common-Lisp's `psetf' does the first, so we'll do the same.
2394 binds)
2402 ;; If there's no vnew, do nothing.
2405 binds))
2406 body))
2410 binds))))
2415 ;; Special-case for simple variables.
2418 simplebinds)
2419 binds body)
2423 binds)
2424 body)))))))
2426 ;;;###autoload
2428 "Temporarily bind to PLACEs.
2429 This is the analogue of `let', but with generalized variables (in the
2430 sense of `setf') for the PLACEs. Each PLACE is set to the corresponding
2431 VALUE, then the BODY forms are executed. On exit, either normally or
2432 because of a `throw' or error, the PLACEs are set back to their original
2433 values. Note that this macro is *not* available in Common Lisp.
2434 As a special case, if `(PLACE)' is used instead of `(PLACE VALUE)',
2435 the PLACE is not modified before executing BODY.
2437 \(fn ((PLACE VALUE) ...) BODY...)"
2443 ;;;###autoload
2445 "Temporarily bind to PLACEs.
2446 Like `cl-letf' but where the bindings are performed one at a time,
2447 rather than all at the end (i.e. like `let*' rather than like `let')."
2453 ;;;###autoload
2455 "Set PLACE to (FUNC PLACE ARGS...).
2456 FUNC should be an unquoted function name. PLACE may be a symbol,
2457 or any generalized variable allowed by `setf'."
2465 ;;;###autoload
2467 "Set PLACE to (FUNC ARG1 PLACE ARGS...).
2468 Like `cl-callf', but PLACE is the second argument of FUNC, not the first.
2470 \(fn FUNC ARG1 PLACE ARGS...)"
2481 ;;;###autoload
2483 "Define NAME as a function.
2484 Like `defun', except the function is automatically declared `inline' and
2485 the arguments are immutable.
2486 ARGLIST allows full Common Lisp conventions, and BODY is implicitly
2487 surrounded by (cl-block NAME ...).
2488 The function's arguments should be treated as immutable.
2490 \(fn NAME ARGLIST [DOCSTRING] BODY...)"
2495 ;; (pbody (cons 'progn body))
2496 )
2506 ;; We used to pass `simple' as
2507 ;; (not (or unsafe (cl-expr-access-order pbody argns)))
2508 ;; But this is much too simplistic since it
2509 ;; does not pay attention to the argvs (and
2510 ;; cl-expr-access-order itself is also too naive).
2511 nil
2523 nil)
2525 argns argvs))))
2526 ;; FIXME: `sublis/subst' will happily substitute the symbol
2527 ;; `argn' in places where it's not used as a reference
2528 ;; to a variable.
2529 ;; FIXME: `sublis/subst' will happily copy `argv' to a different
2530 ;; scope, leading to name capture.
2538 "Perform substitutions indicated by ALIST in TREE (non-destructively)."
2546 ;;; Structures.
2551 ;; Rather than hard code cl-structure-object, we indirect through this variable
2552 ;; for bootstrapping reasons.
2555 ;;;###autoload
2557 "Define a struct type.
2558 This macro defines a new data type called NAME that stores data
2559 in SLOTs. It defines a `make-NAME' constructor, a `copy-NAME'
2560 copier, a `NAME-p' predicate, and slot accessors named `NAME-SLOT'.
2561 You can use the accessors to set the corresponding slots, via `setf'.
2563 NAME may instead take the form (NAME OPTIONS...), where each
2564 OPTION is either a single keyword or (KEYWORD VALUE) where
2565 KEYWORD can be one of :conc-name, :constructor, :copier, :predicate,
2566 :type, :named, :initial-offset, :print-function, or :include.
2568 Each SLOT may instead take the form (SNAME SDEFAULT SOPTIONS...), where
2569 SDEFAULT is the default value of that slot and SOPTIONS are keyword-value
2570 pairs for that slot.
2571 Currently, only one keyword is supported, `:read-only'. If this has a
2572 non-nil value, that slot cannot be set via `setf'.
2574 \(fn NAME SLOTS...)"
2578 [&or symbolp
2580 symbolp &rest
2581 [&or symbolp
2592 ;; All the above is for the following def-form.
2614 pred-form pred-check)
2617 descs)))
2628 ;; If this defines a constructor of the same name as
2629 ;; the default one, don't define the default.
2639 ;; FIXME: Actually, we can include more than once as long as
2640 ;; we include EIEIO classes rather than cl-structs!
2655 descs)))
2678 old-descs)
2681 type inc-type
2696 descs)))))
2718 defaults))
2724 ;; The arg "cl-x" is referenced by name in eg pred-form
2725 ;; and pred-check, so changing it is not straightforward.
2728 slot struct)
2737 forms)
2744 forms)
2745 ;; For normal slots, we don't need to define a setf-expander,
2746 ;; since gv-get can use the compiler macro to get the
2747 ;; same result.
2748 ;; (push `(gv-define-setter ,accessor (cl-val cl-x)
2749 ;; ;; If cl is loaded only for compilation,
2750 ;; ;; the call to cl--struct-setf-expander would
2751 ;; ;; cause a warning because it may not be
2752 ;; ;; defined at run time. Suppress that warning.
2753 ;; (progn
2754 ;; (declare-function
2755 ;; cl--struct-setf-expander "cl-macs"
2756 ;; (x name accessor pred-form pos))
2757 ;; (cl--struct-setf-expander
2758 ;; cl-val cl-x ',name ',accessor
2759 ;; ,(and pred-check `',pred-check)
2760 ;; ,pos)))
2761 ;; forms)
2762 )
2776 forms)
2783 constrs))
2787 slots defaults)))
2795 forms)))
2797 ;; Don't bother adding to cl-custom-print-functions since it's not used
2798 ;; by anything anyway!
2799 ;;(if print-func
2800 ;; (push `(if (boundp 'cl-custom-print-functions)
2801 ;; (push
2802 ;; ;; The auto-generated function does not pay attention to
2803 ;; ;; the depth argument cl-n.
2804 ;; (lambda (cl-x cl-s ,(if print-auto '_cl-n 'cl-n))
2805 ;; (and ,pred-form ,print-func))
2806 ;; cl-custom-print-functions))
2807 ;; forms))
2811 ;; Call cl-struct-define during compilation as well, so that
2812 ;; a subsequent cl-defstruct in the same file can correctly include this
2813 ;; struct as a parent.
2820 ;;; Add cl-struct support to pcase
2826 ;; BFS precedence.
2834 ;;;###autoload
2836 "Pcase patterns to match cl-structs.
2837 Elements of FIELDS can be of the form (NAME PAT) in which case the contents of
2838 field NAME is matched against PAT, or they can be of the form NAME which
2839 is a shorthand for (NAME NAME)."
2850 fields)))
2853 "Extra special cases for `cl-typep' predicates."
2876 pred2)))
2888 "Return the sequence used to build STRUCT-TYPE.
2889 STRUCT-TYPE is a symbol naming a struct type. Return `vector' or
2890 `list', or nil if STRUCT-TYPE is not a struct type. "
2895 "Return a list of slot names of struct STRUCT-TYPE.
2896 Each entry is a list (SLOT-NAME . OPTS), where SLOT-NAME is a
2897 slot name symbol and OPTS is a list of slot options given to
2898 `cl-defstruct'. Dummy slots that represent the struct name and
2899 slots skipped by :initial-offset may appear in the list."
2912 descs)))
2918 "Return the offset of slot SLOT-NAME in STRUCT-TYPE.
2919 The returned zero-based slot index is relative to the start of
2920 the structure data type and is adjusted for any structure name
2921 and :initial-offset slots. Signal error if struct STRUCT-TYPE
2922 does not contain SLOT-NAME."
2932 "Return non-nil if SYM will be bound when we run the code.
2933 Of course, we really can't know that for sure, so it's just a heuristic."
2947 ;;;###autoload
3004 ;;;###autoload
3006 "Verify that FORM is of type TYPE; signal an error if not.
3007 STRING is an optional description of the desired type."
3015 nil))))
3017 ;;;###autoload
3019 ;; FIXME: This is actually not compatible with Common-Lisp's `assert'.
3020 "Verify that FORM returns non-nil; signal an error if not.
3021 Second arg SHOW-ARGS means to include arguments of FORM in message.
3022 Other args STRING and ARGS... are arguments to be passed to `error'.
3023 They are not evaluated unless the assertion fails. If STRING is
3024 omitted, a default message listing FORM itself is used."
3031 x))
3038 nil))))
3040 ;;; Compiler macros.
3042 ;;;###autoload
3044 "Define a compiler-only macro.
3045 This is like `defmacro', but macro expansion occurs only if the call to
3046 FUNC is compiled (i.e., not interpreted). Compiler macros should be used
3047 for optimizing the way calls to FUNC are compiled; the form returned by
3048 BODY should do the same thing as a call to the normal function called
3049 FUNC, though possibly more efficiently. Note that, like regular macros,
3050 compiler macros are expanded repeatedly until no further expansions are
3052 original function call alone by declaring an initial `&whole foo' parameter
3053 and then returning foo."
3058 ;; FIXME: The code in bytecomp mishandles top-level expressions that define
3059 ;; uninterned functions. E.g. it would generate code like:
3060 ;; (defalias '#1=#:foo--cmacro #[514 ...])
3061 ;; (put 'foo 'compiler-macro '#:foo--cmacro)
3062 ;; So we circumvent this by using an interned name.
3065 ;; Name the compiler-macro function, so that `symbol-file' can find it.
3071 ;;;###autoload
3073 "Like `macroexpand', but for compiler macros.
3074 Expands FORM repeatedly until no further expansion is possible.
3075 Returns FORM unchanged if it has no compiler macro, or if it has a
3076 macro that returns its `&whole' argument."
3087 form)
3089 ;; Optimize away unused block-wrappers.
3098 macroexpand-all-environment)))
3099 ;; FIXME: To avoid re-applying macroexpand-all, we'd like to be able
3100 ;; to indicate that this return value is already fully expanded.
3103 cl-body)))
3110 ;; Compile-time optimizations for some functions defined in this package.
3130 ;;;###autoload
3142 cl-fifth cl-sixth cl-seventh
3143 cl-eighth cl-ninth cl-tenth
3144 cl-rest cl-endp cl-plusp cl-minusp
3145 cl-caaar cl-caadr cl-cadar
3146 cl-caddr cl-cdaar cl-cdadr
3147 cl-cddar cl-cdddr cl-caaaar
3148 cl-caaadr cl-caadar cl-caaddr
3149 cl-cadaar cl-cadadr cl-caddar
3150 cl-cadddr cl-cdaaar cl-cdaadr
3151 cl-cdadar cl-cdaddr cl-cddaar
3152 cl-cddadr cl-cdddar cl-cddddr))
3155 ;;; Things that are inline.
3157 cl-notevery cl-revappend cl-nreconc gethash))
3159 ;;; Things that are side-effect-free.
3162 cl-lcm cl-isqrt cl-floor cl-ceiling cl-truncate cl-round cl-mod cl-rem
3163 cl-subseq cl-list-length cl-get cl-getf))
3165 ;;; Things that are side-effect-and-error-free.
3168 cl-random-state-p copy-tree cl-sublis))
3170 ;;; Types and assertions.
3172 ;;;###autoload
3174 "Define NAME as a new data type.
3175 The type name can then be used in `cl-typecase', `cl-check-type', etc."
3183 ;;; Additional functions that we can now define because we've defined
3184 ;;; `cl-defsubst' and `cl-typep'.
3187 "Return the value of slot SLOT-NAME in INST of STRUCT-TYPE.
3188 STRUCT and SLOT-NAME are symbols. INST is a structure instance."
3195 ;; We could use `elt', but since the byte compiler will resolve the
3196 ;; branch below at compile time, it's more efficient to use the
3197 ;; type-specific accessor.
3204 ;; Local variables:
3205 ;; byte-compile-dynamic: t
3206 ;; generated-autoload-file: "cl-loaddefs.el"
3207 ;; End:
3211 ;;; cl-macs.el ends here