Commit | Line | Data |
---|---|---|
861345b4 | 1 | ;;; -*-lisp-*- |
2 | ;;; | |
3 | ;;; $Id$ | |
4 | ;;; | |
5 | ;;; Basic definitions | |
6 | ;;; | |
7 | ;;; (c) 2005 Mark Wooding | |
8 | ;;; | |
9 | ||
10 | ;;;----- Licensing notice --------------------------------------------------- | |
11 | ;;; | |
12 | ;;; This program is free software; you can redistribute it and/or modify | |
13 | ;;; it under the terms of the GNU General Public License as published by | |
14 | ;;; the Free Software Foundation; either version 2 of the License, or | |
15 | ;;; (at your option) any later version. | |
16 | ;;; | |
17 | ;;; This program is distributed in the hope that it will be useful, | |
18 | ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;;; GNU General Public License for more details. | |
21 | ;;; | |
22 | ;;; You should have received a copy of the GNU General Public License | |
23 | ;;; along with this program; if not, write to the Free Software Foundation, | |
24 | ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
25 | ||
02866e07 MW |
26 | ;;;-------------------------------------------------------------------------- |
27 | ;;; Package things. | |
28 | ||
861345b4 | 29 | (defpackage #:mdw.base |
30 | (:use #:common-lisp) | |
31 | (:export #:compile-time-defun | |
32 | #:show | |
9d3ccec7 | 33 | #:stringify #:listify #:fix-pair #:pairify #:parse-body |
861345b4 | 34 | #:whitespace-char-p |
35 | #:slot-uninitialized | |
560e1186 | 36 | #:nlet #:while #:case2 #:ecase2 |
861345b4 | 37 | #:with-gensyms #:let*/gensyms #:with-places |
e979e568 MW |
38 | #:locp #:locf #:ref #:with-locatives |
39 | #:update-place #:update-place-after | |
7dcf04ad MW |
40 | #:incf-after #:decf-after |
41 | #:fixnump) | |
42 | #+cmu (:import-from #:extensions #:fixnump)) | |
43 | ||
861345b4 | 44 | (in-package #:mdw.base) |
45 | ||
02866e07 MW |
46 | ;;;-------------------------------------------------------------------------- |
47 | ;;; Some simple macros to get things going. | |
48 | ||
861345b4 | 49 | (defmacro compile-time-defun (name args &body body) |
50 | "Define a function which can be used by macros during the compilation | |
0ff9df03 | 51 | process." |
861345b4 | 52 | `(eval-when (:compile-toplevel :load-toplevel) |
53 | (defun ,name ,args ,@body))) | |
54 | ||
55 | (defmacro show (x) | |
56 | "Debugging tool: print the expression X and its value." | |
57 | (let ((tmp (gensym))) | |
58 | `(let ((,tmp ,x)) | |
59 | (format t "~&~S: ~S~%" ',x ,tmp) | |
60 | ,tmp))) | |
61 | ||
62 | (defun stringify (str) | |
63 | "Return a string representation of STR. Strings are returned unchanged; | |
0ff9df03 MW |
64 | symbols are converted to their names (unqualified!). Other objects are |
65 | converted to their print representations." | |
861345b4 | 66 | (typecase str |
67 | (string str) | |
68 | (symbol (symbol-name str)) | |
69 | (t (with-output-to-string (s) | |
70 | (princ str s))))) | |
02866e07 | 71 | |
861345b4 | 72 | (compile-time-defun listify (x) |
73 | "If X is a (possibly empty) list, return X; otherwise return (list X)." | |
74 | (if (listp x) x (list x))) | |
02866e07 | 75 | |
861345b4 | 76 | (compile-time-defun do-fix-pair (x y defaultp) |
77 | "Helper function for fix-pair and pairify." | |
78 | (flet ((singleton (x) (values x (if defaultp y x)))) | |
79 | (cond ((atom x) (singleton x)) | |
80 | ((null (cdr x)) (singleton (car x))) | |
81 | ((atom (cdr x)) (values (car x) (cdr x))) | |
82 | ((cddr x) (error "Too many elements for a pair.")) | |
83 | (t (values (car x) (cadr x)))))) | |
02866e07 | 84 | |
861345b4 | 85 | (compile-time-defun fix-pair (x &optional (y nil defaultp)) |
86 | "Return two values extracted from X. It works as follows: | |
0ff9df03 MW |
87 | (A) -> A, Y |
88 | (A B) -> A, B | |
89 | (A B . C) -> error | |
90 | (A . B) -> A, B | |
91 | A -> A, Y | |
92 | where Y defaults to A if not specified." | |
861345b4 | 93 | (do-fix-pair x y defaultp)) |
02866e07 | 94 | |
861345b4 | 95 | (compile-time-defun pairify (x &optional (y nil defaultp)) |
96 | "As for fix-pair, but returns a list instead of two values." | |
97 | (multiple-value-call #'list (do-fix-pair x y defaultp))) | |
98 | ||
99 | (defun whitespace-char-p (ch) | |
100 | "Return whether CH is a whitespace character or not." | |
101 | (case ch | |
102 | ((#\space #\tab #\newline #\return #\vt #\formfeed) t) | |
103 | (t nil))) | |
104 | ||
105 | (declaim (ftype (function nil ()) slot-unitialized)) | |
106 | (defun slot-uninitialized () | |
107 | "A function which signals an error. Can be used as an initializer form in | |
0ff9df03 | 108 | structure definitions without doom ensuing." |
861345b4 | 109 | (error "No initializer for slot.")) |
110 | ||
e2a3c923 | 111 | (compile-time-defun parse-body (body &key (allow-docstring-p t)) |
9d3ccec7 | 112 | "Given a BODY (a list of forms), parses it into three sections: a |
0ff9df03 MW |
113 | docstring, a list of declarations (forms beginning with the symbol |
114 | `declare') and the body forms. The result is returned as three lists | |
115 | (even the docstring), suitable for interpolation into a backquoted list | |
e2a3c923 MW |
116 | using `@,'. If ALLOW-DOCSTRING-P is nil, docstrings aren't allowed at |
117 | all." | |
118 | (let ((doc nil) (decls nil)) | |
119 | (do ((forms body (cdr forms))) (nil) | |
120 | (let ((form (and forms (car forms)))) | |
121 | (cond ((and allow-docstring-p (not doc) (stringp form) (cdr forms)) | |
122 | (setf doc form)) | |
123 | ((and (consp form) | |
124 | (eq (car form) 'declare)) | |
125 | (setf decls (append decls (cdr form)))) | |
126 | (t (return (values (and doc (list doc)) | |
127 | (and decls (list (cons 'declare decls))) | |
128 | forms)))))))) | |
9d3ccec7 | 129 | |
7dcf04ad MW |
130 | #-cmu |
131 | (progn | |
132 | (declaim (inline fixnump)) | |
133 | (defun fixnump (object) | |
134 | "Answer non-nil if OBJECT is a fixnum, or nil if it isn't." | |
135 | (typep object 'fixnum))) | |
136 | ||
02866e07 MW |
137 | ;;;-------------------------------------------------------------------------- |
138 | ;;; Generating symbols. | |
139 | ||
861345b4 | 140 | (defmacro with-gensyms (syms &body body) |
141 | "Everyone's favourite macro helper." | |
142 | `(let (,@(mapcar (lambda (sym) `(,sym (gensym ,(symbol-name sym)))) | |
143 | (listify syms))) | |
144 | ,@body)) | |
145 | ||
146 | (defmacro let*/gensyms (binds &body body) | |
147 | "A macro helper. BINDS is a list of binding pairs (VAR VALUE), where VALUE | |
0ff9df03 MW |
148 | defaults to VAR. The result is that BODY is evaluated in a context where |
149 | each VAR is bound to a gensym, and in the final expansion, each of those | |
150 | gensyms will be bound to the corresponding VALUE." | |
861345b4 | 151 | (labels ((more (binds) |
152 | (let ((tmp (gensym "TMP")) (bind (car binds))) | |
153 | `((let ((,tmp ,(cadr bind)) | |
154 | (,(car bind) (gensym ,(symbol-name (car bind))))) | |
155 | `(let ((,,(car bind) ,,tmp)) | |
156 | ,,@(if (cdr binds) | |
157 | (more (cdr binds)) | |
158 | body))))))) | |
159 | (if (null binds) | |
160 | `(progn ,@body) | |
161 | (car (more (mapcar #'pairify (listify binds))))))) | |
162 | ||
02866e07 | 163 | ;;;-------------------------------------------------------------------------- |
f2d46aaa MW |
164 | ;;; Some simple yet useful control structures. |
165 | ||
166 | (defmacro nlet (name binds &body body) | |
167 | "Scheme's named let." | |
168 | (multiple-value-bind (vars vals) | |
169 | (loop for bind in binds | |
170 | for (var val) = (pairify bind nil) | |
171 | collect var into vars | |
172 | collect val into vals | |
173 | finally (return (values vars vals))) | |
174 | `(labels ((,name ,vars | |
175 | ,@body)) | |
176 | (,name ,@vals)))) | |
177 | ||
178 | (defmacro while (cond &body body) | |
179 | "If COND is false, evaluate to nil; otherwise evaluate BODY and try again." | |
180 | `(loop | |
93f04724 | 181 | (unless ,cond (return)) |
f2d46aaa MW |
182 | ,@body)) |
183 | ||
560e1186 MW |
184 | (compile-time-defun do-case2-like (kind vform clauses) |
185 | "Helper function for `case2' and `ecase2'." | |
186 | (with-gensyms (scrutinee argument) | |
187 | `(multiple-value-bind (,scrutinee ,argument) ,vform | |
188 | (declare (ignorable ,argument)) | |
189 | (,kind ,scrutinee | |
190 | ,@(mapcar (lambda (clause) | |
191 | (destructuring-bind | |
b3bc3745 | 192 | (cases (&optional varx vary) &rest forms) |
560e1186 MW |
193 | clause |
194 | `(,cases | |
b3bc3745 MW |
195 | ,@(if varx |
196 | (list `(let ((,(or vary varx) ,argument) | |
197 | ,@(and vary | |
198 | `((,varx ,scrutinee)))) | |
199 | ,@forms)) | |
560e1186 MW |
200 | forms)))) |
201 | clauses))))) | |
202 | ||
203 | (defmacro case2 (vform &body clauses) | |
204 | "VFORM is a form which evaluates to two values, SCRUTINEE and ARGUMENT. | |
b3bc3745 MW |
205 | The CLAUSES have the form (CASES ([[SCRUVAR] ARGVAR]) FORMS...), where a |
206 | standard `case' clause has the form (CASES FORMS...). The `case2' form | |
207 | evaluates the VFORM, and compares the SCRUTINEE to the various CASES, in | |
208 | order, just like `case'. If there is a match, then the corresponding | |
209 | FORMs are evaluated with ARGVAR bound to the ARGUMENT and SCRUVAR bound to | |
210 | the SCRUTINEE (where specified). Note the bizarre defaulting behaviour: | |
211 | ARGVAR is less optional than SCRUVAR." | |
560e1186 MW |
212 | (do-case2-like 'case vform clauses)) |
213 | ||
214 | (defmacro ecase2 (vform &body clauses) | |
215 | "Like `case2', but signals an error if no clause matches the SCRUTINEE." | |
216 | (do-case2-like 'ecase vform clauses)) | |
217 | ||
f2d46aaa | 218 | ;;;-------------------------------------------------------------------------- |
02866e07 MW |
219 | ;;; with-places |
220 | ||
861345b4 | 221 | (defmacro %place-ref (getform setform newtmp) |
222 | "Grim helper macro for with-places." | |
223 | (declare (ignore setform newtmp)) | |
224 | getform) | |
02866e07 | 225 | |
861345b4 | 226 | (define-setf-expander %place-ref (getform setform newtmp) |
227 | "Grim helper macro for with-places." | |
228 | (values nil nil newtmp setform getform)) | |
02866e07 | 229 | |
861345b4 | 230 | (defmacro with-places ((&key environment) places &body body) |
231 | "A hairy helper, for writing setf-like macros. PLACES is a list of binding | |
0ff9df03 MW |
232 | pairs (VAR PLACE), where PLACE defaults to VAR. The result is that BODY |
233 | is evaluated in a context where each VAR is bound to a gensym, and in the | |
234 | final expansion, each of those gensyms will be bound to a symbol-macro | |
235 | capable of reading or setting the value of the corresponding PLACE." | |
861345b4 | 236 | (if (null places) |
237 | `(progn ,@body) | |
238 | (let*/gensyms (environment) | |
239 | (labels | |
240 | ((more (places) | |
241 | (let ((place (car places))) | |
242 | (with-gensyms (tmp valtmps valforms | |
243 | newtmps setform getform) | |
244 | `((let ((,tmp ,(cadr place)) | |
245 | (,(car place) | |
246 | (gensym ,(symbol-name (car place))))) | |
247 | (multiple-value-bind | |
248 | (,valtmps ,valforms | |
249 | ,newtmps ,setform ,getform) | |
250 | (get-setf-expansion ,tmp | |
251 | ,environment) | |
252 | (list 'let* | |
253 | (mapcar #'list ,valtmps ,valforms) | |
254 | `(symbol-macrolet ((,,(car place) | |
255 | (%place-ref ,,getform | |
256 | ,,setform | |
257 | ,,newtmps))) | |
258 | ,,@(if (cdr places) | |
259 | (more (cdr places)) | |
260 | body)))))))))) | |
261 | (car (more (mapcar #'pairify (listify places)))))))) | |
262 | ||
02866e07 MW |
263 | ;;;-------------------------------------------------------------------------- |
264 | ;;; Update-in-place macros built using with-places. | |
265 | ||
e979e568 MW |
266 | (defmacro update-place (op place arg &environment env) |
267 | "Update PLACE with the value of OP PLACE ARG, returning the new value." | |
268 | (with-places (:environment env) (place) | |
269 | `(setf ,place (,op ,place ,arg)))) | |
02866e07 | 270 | |
e979e568 MW |
271 | (defmacro update-place-after (op place arg &environment env) |
272 | "Update PLACE with the value of OP PLACE ARG, returning the old value." | |
273 | (with-places (:environment env) (place) | |
274 | (with-gensyms (x) | |
275 | `(let ((,x ,place)) | |
02866e07 MW |
276 | (setf ,place (,op ,x ,arg)) |
277 | ,x)))) | |
278 | ||
e979e568 MW |
279 | (defmacro incf-after (place &optional (by 1)) |
280 | "Increment PLACE by BY, returning the old value." | |
281 | `(update-place-after + ,place ,by)) | |
02866e07 | 282 | |
e979e568 MW |
283 | (defmacro decf-after (place &optional (by 1)) |
284 | "Decrement PLACE by BY, returning the old value." | |
285 | `(update-place-after - ,place ,by)) | |
286 | ||
02866e07 MW |
287 | ;;;-------------------------------------------------------------------------- |
288 | ;;; Locatives. | |
e979e568 | 289 | |
861345b4 | 290 | (defstruct (loc (:predicate locp) (:constructor make-loc (reader writer))) |
291 | "Locative data type. See `locf' and `ref'." | |
292 | (reader (slot-uninitialized) :type function) | |
293 | (writer (slot-uninitialized) :type function)) | |
02866e07 | 294 | |
861345b4 | 295 | (defmacro locf (place &environment env) |
296 | "Slightly cheesy locatives. (locf PLACE) returns an object which, using | |
0ff9df03 MW |
297 | the `ref' function, can be used to read or set the value of PLACE. It's |
298 | cheesy because it uses closures rather than actually taking the address of | |
299 | something. Also, unlike Zetalisp, we don't overload `car' to do our dirty | |
300 | work." | |
861345b4 | 301 | (multiple-value-bind |
302 | (valtmps valforms newtmps setform getform) | |
303 | (get-setf-expansion place env) | |
304 | `(let* (,@(mapcar #'list valtmps valforms)) | |
305 | (make-loc (lambda () ,getform) | |
306 | (lambda (,@newtmps) ,setform))))) | |
02866e07 | 307 | |
861345b4 | 308 | (declaim (inline loc (setf loc))) |
02866e07 | 309 | |
861345b4 | 310 | (defun ref (loc) |
311 | "Fetch the value referred to by a locative." | |
312 | (funcall (loc-reader loc))) | |
02866e07 | 313 | |
861345b4 | 314 | (defun (setf ref) (new loc) |
315 | "Store a new value in the place referred to by a locative." | |
316 | (funcall (loc-writer loc) new)) | |
02866e07 | 317 | |
861345b4 | 318 | (defmacro with-locatives (locs &body body) |
319 | "LOCS is a list of items of the form (SYM [LOC-EXPR]), where SYM is a | |
0ff9df03 MW |
320 | symbol and LOC-EXPR evaluates to a locative. If LOC-EXPR is omitted, it |
321 | defaults to SYM. As an abbreviation for a common case, LOCS may be a | |
322 | symbol instead of a list. The BODY is evaluated in an environment where | |
323 | each SYM is a symbol macro which expands to (ref LOC-EXPR) -- or, in fact, | |
324 | something similar which doesn't break if LOC-EXPR has side-effects. Thus, | |
325 | references, including `setf' forms, fetch or modify the thing referred to | |
326 | by the LOC-EXPR. Useful for covering over where something uses a | |
327 | locative." | |
861345b4 | 328 | (setf locs (mapcar #'pairify (listify locs))) |
329 | (let ((tt (mapcar (lambda (l) (declare (ignore l)) (gensym)) locs)) | |
330 | (ll (mapcar #'cadr locs)) | |
331 | (ss (mapcar #'car locs))) | |
332 | `(let (,@(mapcar (lambda (tmp loc) `(,tmp ,loc)) tt ll)) | |
333 | (symbol-macrolet (,@(mapcar (lambda (sym tmp) | |
334 | `(,sym (ref ,tmp))) ss tt)) | |
335 | ,@body)))) | |
336 | ||
337 | ;;;----- That's all, folks -------------------------------------------------- |