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