source: trunk/j/src/org/armedbear/lisp/destructuring-bind.lisp @ 4911

Last change on this file since 4911 was 4911, checked in by piso, 18 years ago

DO-ARG-COUNT-ERROR

File size: 12.5 KB
Line 
1;;; destructuring-bind.lisp
2;;;
3;;; Copyright (C) 2003 Peter Graves
4;;; $Id: destructuring-bind.lisp,v 1.8 2003-11-29 04:21:33 piso Exp $
5;;;
6;;; This program is free software; you can redistribute it and/or
7;;; modify it under the terms of the GNU General Public License
8;;; as published by the Free Software Foundation; either version 2
9;;; of the License, or (at your option) any later version.
10;;;
11;;; This program is distributed in the hope that it will be useful,
12;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14;;; GNU General Public License for more details.
15;;;
16;;; You should have received a copy of the GNU General Public License
17;;; along with this program; if not, write to the Free Software
18;;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19
20;;;; From CMUCL, via GCL.
21
22(in-package "SYSTEM")
23
24(defvar *arg-tests* ())
25
26(defvar *system-lets* nil)
27
28(defvar *user-lets* ())
29
30(defvar *ignorable-vars*)
31
32(defun do-arg-count-error (error-kind name arg lambda-list minimum maximum)
33  (error 'program-error "wrong number of arguments for ~S" name))
34
35(defun parse-defmacro (lambda-list arg-list-name code name error-kind
36           &key (anonymousp nil)
37           (doc-string-allowed t)
38           ((:environment env-arg-name))
39           (error-fun 'error))
40  (multiple-value-bind (body declarations documentation)
41           (parse-body code nil doc-string-allowed)
42    (let* ((*arg-tests* ())
43     (*user-lets* ())
44     (*system-lets* ())
45     (*ignorable-vars* ()))
46      (multiple-value-bind
47    (env-arg-used minimum maximum)
48    (parse-defmacro-lambda-list lambda-list arg-list-name name
49              error-kind error-fun (not anonymousp)
50              nil env-arg-name)
51  (values
52   `(let* ,(nreverse *system-lets*)
53     ,@(when *ignorable-vars*
54         `((declare (ignorable ,@*ignorable-vars*))))
55      ,@*arg-tests*
56      (let* ,(nreverse *user-lets*)
57        ,@declarations
58        ,@body))
59   `(,@(when (and env-arg-name (not env-arg-used))
60         `((declare (ignore ,env-arg-name)))))
61   documentation
62   minimum
63   maximum)))))
64
65(defun make-keyword (symbol)
66  "Takes a non-keyword symbol, symbol, and returns the corresponding keyword."
67  (intern (symbol-name symbol) (find-package "KEYWORD")))
68
69(defun defmacro-error (problem name)
70  (error 'type-error "~S is not of type ~S~%" problem name))
71
72(defun verify-keywords (key-list valid-keys allow-other-keys)
73  (do ((already-processed nil)
74       (unknown-keyword nil)
75       (remaining key-list (cddr remaining)))
76      ((null remaining)
77       (if (and unknown-keyword
78    (not allow-other-keys)
79    (not (lookup-keyword :allow-other-keys key-list)))
80     (values :unknown-keyword (list unknown-keyword valid-keys))
81     (values nil nil)))
82    (cond ((not (and (consp remaining) (listp (cdr remaining))))
83     (return (values :dotted-list key-list)))
84    ((null (cdr remaining))
85     (return (values :odd-length key-list)))
86    #+nil ;; Not ANSI compliant to disallow duplicate keywords.
87    ((memql (car remaining) already-processed)
88     (return (values :duplicate (car remaining))))
89    ((or (eq (car remaining) :allow-other-keys)
90         (memql (car remaining) valid-keys))
91     (push (car remaining) already-processed))
92    (t
93     (setf unknown-keyword (car remaining))))))
94
95(defun lookup-keyword (keyword key-list)
96  (do ((remaining key-list (cddr remaining)))
97      ((endp remaining))
98    (when (eq keyword (car remaining))
99      (return (cadr remaining)))))
100
101(defun keyword-supplied-p (keyword key-list)
102  (do ((remaining key-list (cddr remaining)))
103      ((endp remaining))
104    (when (eq keyword (car remaining))
105      (return t))))
106
107
108(defun parse-defmacro-lambda-list
109       (lambda-list arg-list-name name error-kind error-fun
110        &optional top-level env-illegal env-arg-name)
111  (let ((path (if top-level `(cdr ,arg-list-name) arg-list-name))
112  (now-processing :required)
113  (maximum 0)
114  (minimum 0)
115  (keys ())
116  rest-name restp allow-other-keys-p env-arg-used)
117    ;; This really strange way to test for '&whole is neccessary because member
118    ;; does not have to work on dotted lists, and dotted lists are legal
119    ;; in lambda-lists.
120    (when (and (do ((list lambda-list (cdr list)))
121       ((atom list) nil)
122     (when (eq (car list) '&whole) (return t)))
123         (not (eq (car lambda-list) '&whole)))
124      (error "&Whole must appear first in ~S lambda-list." error-kind))
125    (do ((rest-of-args lambda-list (cdr rest-of-args)))
126  ((atom rest-of-args)
127   (cond ((null rest-of-args) nil)
128         ;; Varlist is dotted, treat as &rest arg and exit.
129         (t (push-let-binding rest-of-args path nil)
130      (setf restp t))))
131      (let ((var (car rest-of-args)))
132  (cond ((eq var '&whole)
133         (cond ((and (cdr rest-of-args) (symbolp (cadr rest-of-args)))
134          (setf rest-of-args (cdr rest-of-args))
135          (push-let-binding (car rest-of-args) arg-list-name nil))
136         (t
137          (defmacro-error "&WHOLE" name))))
138        ((eq var '&environment)
139         (cond (env-illegal
140          (error "&ENVIRONMENT not valid with ~S" error-kind))
141         ((not top-level)
142          (error "&ENVIRONMENT only valid at top level of lambda list")))
143         (cond ((and (cdr rest-of-args) (symbolp (cadr rest-of-args)))
144          (setf rest-of-args (cdr rest-of-args))
145          (push-let-binding (car rest-of-args) env-arg-name nil)
146          (setf env-arg-used t))
147         (t
148          (defmacro-error "&ENVIRONMENT" error-kind name))))
149        ((or (eq var '&rest) (eq var '&body))
150         (cond ((and (cdr rest-of-args) (symbolp (cadr rest-of-args)))
151          (setf rest-of-args (cdr rest-of-args))
152          (setf restp t)
153          (push-let-binding (car rest-of-args) path nil))
154         ;;
155         ;; This branch implements an incompatible extension to
156         ;; Common Lisp.  In place of a symbol following &body,
157         ;; there may be a list of up to three elements which will
158         ;; be bound to the body, declarations, and doc-string of
159         ;; the body.
160         ((and (cdr rest-of-args)
161         (consp (cadr rest-of-args))
162         (symbolp (caadr rest-of-args)))
163          (setf rest-of-args (cdr rest-of-args))
164          (setf restp t)
165          (let ((body-name (caar rest-of-args))
166          (declarations-name (cadar rest-of-args))
167          (doc-string-name (caddar rest-of-args))
168          (parse-body-values (gensym)))
169      (push-let-binding
170       parse-body-values
171       `(multiple-value-list
172         (parse-body ,path ,env-arg-name
173               ,(not (null doc-string-name))))
174       t)
175      (setf env-arg-used t)
176      (when body-name
177        (push-let-binding body-name
178              `(car ,parse-body-values) nil))
179      (when declarations-name
180        (push-let-binding declarations-name
181              `(cadr ,parse-body-values) nil))
182      (when doc-string-name
183        (push-let-binding doc-string-name
184              `(caddr ,parse-body-values) nil))))
185         (t
186          (defmacro-error (symbol-name var) error-kind name))))
187        ((eq var '&optional)
188         (setf now-processing :optionals))
189        ((eq var '&key)
190         (setf now-processing :keywords)
191         (setf rest-name (gensym "KEYWORDS-"))
192         (push rest-name *ignorable-vars*)
193         (setf restp t)
194         (push-let-binding rest-name path t))
195        ((eq var '&allow-other-keys)
196         (setf allow-other-keys-p t))
197        ((eq var '&aux)
198         (setf now-processing :auxs))
199        ((listp var)
200         (case now-processing
201     (:required
202      (let ((sub-list-name (gensym "SUBLIST-")))
203        (push-sub-list-binding sub-list-name `(car ,path) var
204             name error-kind error-fun)
205        (parse-defmacro-lambda-list var sub-list-name name
206            error-kind error-fun))
207      (setf path `(cdr ,path))
208      (incf minimum)
209      (incf maximum))
210     (:optionals
211      (when (> (length var) 3)
212        (cerror "Ignore extra noise."
213          "More than variable, initform, and suppliedp ~
214          in &optional binding - ~S"
215          var))
216      (push-optional-binding (car var) (cadr var) (caddr var)
217           `(not (null ,path)) `(car ,path)
218           name error-kind error-fun)
219      (setf path `(cdr ,path))
220      (incf maximum))
221     (:keywords
222      (let* ((keyword-given (consp (car var)))
223       (variable (if keyword-given
224               (cadar var)
225               (car var)))
226       (keyword (if keyword-given
227              (caar var)
228              (make-keyword variable)))
229       (supplied-p (caddr var)))
230        (push-optional-binding variable (cadr var) supplied-p
231             `(keyword-supplied-p ',keyword
232                ,rest-name)
233             `(lookup-keyword ',keyword
234                  ,rest-name)
235             name error-kind error-fun)
236        (push keyword keys)))
237     (:auxs (push-let-binding (car var) (cadr var) nil))))
238        ((symbolp var)
239         (case now-processing
240     (:required
241      (incf minimum)
242      (incf maximum)
243      (push-let-binding var `(car ,path) nil)
244      (setf path `(cdr ,path)))
245     (:optionals
246      (incf maximum)
247      (push-let-binding var `(car ,path) nil `(not (null ,path)))
248      (setf path `(cdr ,path)))
249     (:keywords
250      (let ((key (make-keyword var)))
251        (push-let-binding var `(lookup-keyword ,key ,rest-name)
252              nil)
253        (push key keys)))
254     (:auxs
255      (push-let-binding var nil nil))))
256        (t
257         (error "non-symbol in lambda-list: ~S" var)))))
258    ;; Generate code to check the number of arguments, unless dotted
259    ;; in which case length will not work.
260    (unless restp
261       (push `(unless (<= ,minimum
262        (length (the list ,(if top-level
263             `(cdr ,arg-list-name)
264                 arg-list-name)))
265        ,@(unless restp
266            (list maximum)))
267          ,(let ((arg (if top-level
268              `(cdr ,arg-list-name)
269            arg-list-name)))
270       (if (eq error-fun 'error)
271           `(do-arg-count-error ',error-kind ',name ,arg
272              ',lambda-list ,minimum
273              ,(unless restp maximum))
274                             `(,error-fun 'defmacro-ll-arg-count-error
275         :kind ',error-kind
276         ,@(when name `(:name ',name))
277         :argument ,arg
278         :lambda-list ',lambda-list
279         :minimum ,minimum
280         ,@(unless restp `(:maximum ,maximum))))))
281       *arg-tests*))
282    (if keys
283  (let ((problem (gensym "KEY-PROBLEM-"))
284        (info (gensym "INFO-")))
285    (push `(multiple-value-bind
286         (,problem ,info)
287         (verify-keywords ,rest-name ',keys ',allow-other-keys-p)
288       (when ,problem
289         (,error-fun
290          'defmacro-ll-broken-key-list-error
291          :kind ',error-kind
292          ,@(when name `(:name ',name))
293          :problem ,problem
294          :info ,info)))
295    *arg-tests*)))
296    (values env-arg-used minimum (if (null restp) maximum nil))))
297
298
299(defun push-sub-list-binding (variable path object name error-kind error-fun)
300  (let ((var (gensym "TEMP-")))
301    (push `(,variable
302      (let ((,var ,path))
303        (if (listp ,var)
304      ,var
305      (,error-fun 'defmacro-bogus-sublist-error
306            :kind ',error-kind
307            ,@(when name `(:name ',name))
308            :object ,var
309            :lambda-list ',object))))
310    *system-lets*)))
311
312(defun push-let-binding (variable path systemp &optional condition
313          (init-form nil))
314  (let ((let-form (if condition
315          `(,variable (if ,condition ,path ,init-form))
316          `(,variable ,path))))
317    (if systemp
318  (push let-form *system-lets*)
319  (push let-form *user-lets*))))
320
321(defun push-optional-binding (value-var init-form supplied-var condition path
322          name error-kind error-fun)
323  (unless supplied-var
324    (setf supplied-var (gensym "SUPPLIEDP-")))
325  (push-let-binding supplied-var condition t)
326  (cond ((consp value-var)
327   (let ((whole-thing (gensym "OPTIONAL-SUBLIST-")))
328     (push-sub-list-binding whole-thing
329          `(if ,supplied-var ,path ,init-form)
330          value-var name error-kind error-fun)
331     (parse-defmacro-lambda-list value-var whole-thing name
332               error-kind error-fun)))
333  ((symbolp value-var)
334   (push-let-binding value-var path nil supplied-var init-form))
335  (t
336   (error "Illegal optional variable name: ~S" value-var))))
337
338(defun parse-body (body environment &optional (doc-string-allowed t))
339  (let ((decls ())
340  (doc nil))
341    (do ((tail body (cdr tail)))
342  ((endp tail)
343   (values tail (nreverse decls) doc))
344      (let ((form (car tail)))
345  (cond ((and (stringp form) (cdr tail))
346         (if doc-string-allowed
347       (setq doc form
348       ;; Only one doc string is allowed.
349       doc-string-allowed nil)
350       (return (values tail (nreverse decls) doc))))
351        ((not (and (consp form) (symbolp (car form))))
352         (return (values tail (nreverse decls) doc)))
353        ((eq (car form) 'declare)
354         (push form decls))
355        (t
356         (return (values tail (nreverse decls) doc))))))))
357
358(defmacro destructuring-bind (lambda-list arg-list &rest body)
359  (let* ((arg-list-name (gensym "ARG-LIST-")))
360    (multiple-value-bind
361  (body local-decls)
362  (parse-defmacro lambda-list arg-list-name body nil 'destructuring-bind
363      :anonymousp t :doc-string-allowed nil)
364      `(let ((,arg-list-name ,arg-list))
365   ,@local-decls
366   ,body))))
Note: See TracBrowser for help on using the repository browser.