r9722: Document the FDML.
[clsql.git] / sql / loop-extension.lisp
1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:    loop-extension.lisp
6 ;;;; Purpose: Extensions to the Loop macro for CLSQL
7 ;;;;
8 ;;;; Copyright (c) 2001-2004 Kevin Rosenberg and (c) 1999-2001 Pierre R. Mai
9 ;;;;
10 ;;;; $Id$
11 ;;;; *************************************************************************
12
13 (in-package #:cl-user)
14
15 #+(or allegro sbcl)
16 (eval-when (:compile-toplevel :load-toplevel :execute)
17   (defpackage #:ansi-loop 
18     (:import-from #+sbcl #:sb-loop #+allegro #:excl
19                   #:*loop-epilogue*
20                   #:*loop-ansi-universe* 
21                   #:add-loop-path)))
22
23 #+(or allegro sbcl)
24 (defun ansi-loop::loop-gentemp (&optional (pref 'loopva-))
25   (gensym (string pref)))
26
27 #+(or cmu scl sbcl openmcl allegro)
28 (defun loop-record-iteration-path (variable data-type prep-phrases)
29   (let ((in-phrase nil)
30         (from-phrase nil))
31     (loop for (prep . rest) in prep-phrases
32           do
33           (case prep
34             ((:in :of)
35              (when in-phrase
36                (error 'clsql:sql-user-error
37                       :message
38                       (format nil
39                               "Duplicate OF or IN iteration path: ~S."
40                               (cons prep rest))))
41              (setq in-phrase rest))
42             ((:from)
43              (when from-phrase
44                (error 'clsql:sql-user-error
45                       :message
46                       (format nil
47                               "Duplicate FROM iteration path: ~S."
48                               (cons prep rest))))
49              (setq from-phrase rest))
50             (t
51              (error 'clsql:sql-user-error
52                     :message
53                     (format nil"Unknown preposition: ~S." prep)))))
54     (unless in-phrase
55       (error 'clsql:sql-user-error 
56              :message "Missing OF or IN iteration path."))
57     (unless from-phrase
58       (setq from-phrase '(clsql-sys:*default-database*)))
59
60     (unless (consp variable)
61       (setq variable (list variable)))
62
63     (cond
64      ;; object query
65      ((and (consp (first in-phrase))
66            (string-equal "sql-query" (symbol-name (caar in-phrase)))
67            (consp (second (first in-phrase)))
68            (eq 'quote (first (second (first in-phrase))))
69            (symbolp (second (second (first in-phrase)))))
70
71        (let ((result-var (ansi-loop::loop-gentemp
72                               'loop-record-result-))
73              (step-var (ansi-loop::loop-gentemp 'loop-record-step-)))
74          `(((,variable nil ,@(and data-type (list data-type)))
75             (,result-var (clsql-sys:query ,(first in-phrase)))
76             (,step-var nil))
77            ()
78            ()
79            ()
80            (if (null ,result-var)
81                t
82                (progn
83                  (setq ,step-var (first ,result-var))
84                  (setq ,result-var (rest ,result-var))
85                  nil))
86            (,variable ,step-var)
87            (null ,result-var)
88            ()
89            (if (null ,result-var)
90                t
91                (progn
92                  (setq ,step-var (first ,result-var))
93                  (setq ,result-var (rest ,result-var))
94                  nil))
95            (,variable ,step-var))))
96       
97       ((consp variable)
98        (let ((query-var (ansi-loop::loop-gentemp 'loop-record-))
99              (db-var (ansi-loop::loop-gentemp 'loop-record-database-))
100              (result-set-var (ansi-loop::loop-gentemp
101                               'loop-record-result-set-))
102              (step-var (ansi-loop::loop-gentemp 'loop-record-step-)))
103          (push `(when ,result-set-var
104                   (clsql-sys:database-dump-result-set ,result-set-var ,db-var))
105                ansi-loop::*loop-epilogue*)
106          `(((,variable nil ,@(and data-type (list data-type)))
107             (,query-var ,(first in-phrase))
108             (,db-var ,(first from-phrase))
109             (,result-set-var nil)
110             (,step-var nil))
111            ((multiple-value-bind (%rs %cols)
112                 (clsql-sys:database-query-result-set ,query-var ,db-var :result-types :auto)
113               (setq ,result-set-var %rs ,step-var (make-list %cols))))
114            ()
115            ()
116            (not (clsql-sys:database-store-next-row ,result-set-var ,db-var ,step-var))
117            (,variable ,step-var)
118            (not ,result-set-var)
119            ()
120            (not (clsql-sys:database-store-next-row ,result-set-var ,db-var ,step-var))
121            (,variable ,step-var)))))))
122
123 #+(or cmu scl sbcl openmcl allegro)
124 (ansi-loop::add-loop-path '(record records tuple tuples)
125                           'loop-record-iteration-path
126                           ansi-loop::*loop-ansi-universe*
127                           :preposition-groups '((:of :in) (:from))
128                           :inclusive-permitted nil)
129
130 #+lispworks 
131 (eval-when (:compile-toplevel :load-toplevel :execute)
132   (in-package loop))
133
134 #+lispworks
135 (cl-user::define-loop-method (record records tuple tuples) clsql-loop-method 
136   (in of from))
137
138 #+lispworks
139 (defun clsql-loop-method (method-name iter-var iter-var-data-type 
140                           prep-phrases inclusive? allowed-preps 
141                           method-specific-data)
142   (declare (ignore method-name inclusive? allowed-preps method-specific-data))
143   (let ((in-phrase nil)
144         (from-phrase nil))
145     (loop for (prep . rest) in prep-phrases
146           do
147           (cond
148             ((or (eq prep 'in) (eq prep 'of))
149              (when in-phrase
150                (error 'clsql:sql-user-error
151                       :message
152                       (format nil "Duplicate OF or IN iteration path: ~S."
153                               (cons prep rest))))
154              (setq in-phrase rest))
155             ((eq prep 'from)
156              (when from-phrase
157                (error 'clsql:sql-user-error
158                       :message
159                       (format nil "Duplicate FROM iteration path: ~S."
160                               (cons prep rest))))
161              (setq from-phrase rest))
162             (t
163              (error 'clsql:sql-user-error
164                     :message (format nil "Unknown preposition: ~S." prep)))))
165     (unless in-phrase
166       (error 'clsql:sql-user-error 
167              :message "Missing OF or IN iteration path."))
168     (unless from-phrase
169       (setq from-phrase '(clsql:*default-database*)))
170
171     (unless (consp iter-var)
172       (setq iter-var (list iter-var)))
173
174     (cond
175      ;; object query
176      ((and (consp in-phrase)
177            (string-equal "sql-query" (symbol-name (car in-phrase)))
178            (consp (second in-phrase))
179            (eq 'quote (first (second in-phrase)))
180            (symbolp (second (second in-phrase))))
181
182        (let ((result-var (gensym "LOOP-RECORD-RESULT-"))
183              (step-var (gensym "LOOP-RECORD-STEP-")))
184          (values
185           t
186           nil
187           `(,@(mapcar (lambda (v) `(,v nil)) iter-var)
188               (,result-var (clsql:query ,in-phrase))
189               (,step-var nil))
190           ()
191           ()
192           ()
193           `((if (null ,result-var)
194                 t
195                 (progn
196                   (setq ,step-var (first ,result-var))
197                   (setq ,result-var (rest ,result-var))
198                   nil)))
199           `(,iter-var ,step-var)
200           `((if (null ,result-var)
201                 t
202                 (progn
203                   (setq ,step-var (first ,result-var))
204                   (setq ,result-var (rest ,result-var))
205                   nil)))
206            `(,iter-var ,step-var)
207            ()
208            ()
209            )))
210       
211       ((consp iter-var)
212        (let ((query-var (gensym "LOOP-RECORD-"))
213              (db-var (gensym "LOOP-RECORD-DATABASE-"))
214              (result-set-var (gensym "LOOP-RECORD-RESULT-SET-"))
215              (step-var (gensym "LOOP-RECORD-STEP-")))
216          (values
217           t
218           nil
219           `(,@(mapcar (lambda (v) `(,v nil)) iter-var)
220             (,query-var ,in-phrase)
221             (,db-var ,(first from-phrase))
222             (,result-set-var nil)
223             (,step-var nil))
224           `((multiple-value-bind (%rs %cols)
225                 (clsql-sys:database-query-result-set ,query-var ,db-var :result-types :auto)
226               (setq ,result-set-var %rs ,step-var (make-list %cols))))
227           ()
228           ()
229           `((unless (clsql-sys:database-store-next-row ,result-set-var ,db-var ,step-var)
230               (when ,result-set-var
231                 (clsql-sys:database-dump-result-set ,result-set-var ,db-var))
232               t))
233           `(,iter-var ,step-var)
234           `((unless (clsql-sys:database-store-next-row ,result-set-var ,db-var ,step-var)
235               (when ,result-set-var
236                 (clsql-sys:database-dump-result-set ,result-set-var ,db-var))
237               t))
238           `(,iter-var ,step-var)
239           ()
240           ()))))))
241