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