nyacc: still debugginug
[mes.git] / module / nyacc / lang / c99 / cppbody.scm
1 ;;; nyacc/lang/c99/cppbody.scm
2 ;;;
3 ;;; Copyright (C) 2016-2017 Matthew R. Wette
4 ;;;
5 ;;; This program is free software: you can redistribute it and/or modify
6 ;;; it under the terms of the GNU General Public License as published by
7 ;;; the Free Software Foundation, either version 3 of the License, or
8 ;;; (at your option) any later version.
9 ;;;
10 ;;; This program is distributed in the hope that it will be useful,
11 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 ;;; GNU General Public License for more details.
14 ;;;
15 ;;; You should have received a copy of the GNU General Public License
16 ;;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18 (define (cpp-err fmt . args)
19   (apply throw 'cpp-error fmt args))
20
21 ;;.@deffn skip-ws ch
22 (define (skip-ws ch)
23   (if (eof-object? ch) ch
24       (if (char-set-contains? c:ws ch)
25           (skip-ws (read-char))
26           ch)))
27
28 ;; Since we want to be able to get CPP statements with comment in tact
29 ;; (e.g., for passing to @code{pretty-print-c99}) we need to remove
30 ;; comments when parsing CPP expressions.  We convert a comm-reader
31 ;; into a comm-skipper here.  And from that generate a lexer generator.
32 (define cpp-comm-skipper
33   (let ((reader (make-comm-reader '(("/*" . "*/")))))
34     (lambda (ch)
35       (reader ch #f))))
36
37 ;; generate a lexical analyzer per string
38 (define gen-cpp-lexer
39   (make-lexer-generator mtab #:comm-skipper cpp-comm-skipper))
40
41 ;; @deffn parse-cpp-expr text => tree
42 ;; Given a string returns a cpp parse tree.  This is called by
43 ;; @code{eval-cpp-expr}.  The text will have had all CPP defined symbols
44 ;; expanded already so no identifiers should appear in the text.
45 ;; A @code{cpp-error} will be thrown if a parse error occurs.
46 (define (parse-cpp-expr text)
47   (with-throw-handler
48    'nyacc-error
49    (lambda ()
50      (with-input-from-string text
51        (lambda () (raw-parser (gen-cpp-lexer)))))
52    (lambda (key fmt . args)
53      (apply throw 'cpp-error fmt args))))
54
55 ;; @deffn eval-cpp-expr tree dict => datum
56 ;; Evaluate a tree produced from @code{parse-cpp-expr}.
57 ;; The tree passed to this routine is 
58 (define (eval-cpp-expr tree dict)
59   (letrec
60       ((tx (lambda (tr ix) (list-ref tr ix)))
61        (tx1 (lambda (tr) (tx tr 1)))
62        (ev (lambda (ex ix) (eval-expr (list-ref ex ix))))
63        (ev1 (lambda (ex) (ev ex 1)))    ; eval expr in arg 1
64        (ev2 (lambda (ex) (ev ex 2)))    ; eval expr in arg 2
65        (ev3 (lambda (ex) (ev ex 3)))    ; eval expr in arg 3
66        (eval-expr
67         (lambda (tree)
68           (case (car tree)
69             ((fixed) (string->number (tx1 tree)))
70             ((char) (char->integer (tx1 tree)))
71             ((defined) (if (assoc-ref dict (tx1 tree)) 1 0))
72             ((pre-inc post-inc) (1+ (ev1 tree)))
73             ((pre-dec post-dec) (1- (ev1 tree)))
74             ((pos) (ev1 tree))
75             ((neg) (- (ev1 tree)))
76             ((bw-not) (bitwise-not (ev1 tree)))
77             ((not) (if (zero? (ev1 tree)) 1 0))
78             ((mul) (* (ev1 tree) (ev2 tree)))
79             ((div) (/ (ev1 tree) (ev2 tree)))
80             ((mod) (modulo (ev1 tree) (ev2 tree)))
81             ((add) (+ (ev1 tree) (ev2 tree)))
82             ((sub) (- (ev1 tree) (ev2 tree)))
83             ((lshift) (bitwise-arithmetic-shift-left (ev1 tree) (ev2 tree)))
84             ((rshift) (bitwise-arithmetic-shift-right (ev1 tree) (ev2 tree)))
85             ((lt) (if (< (ev1 tree) (ev2 tree)) 1 0))
86             ((le) (if (<= (ev1 tree) (ev2 tree)) 1 0))
87             ((gt) (if (> (ev1 tree) (ev2 tree)) 1 0))
88             ((ge) (if (>= (ev1 tree) (ev2 tree)) 1 0))
89             ((equal) (if (= (ev1 tree) (ev2 tree)) 1 0))
90             ((noteq) (if (= (ev1 tree) (ev2 tree)) 0 1))
91             ((bw-or) (bitwise-ior (ev1 tree) (ev2 tree)))
92             ((bw-xor) (bitwise-xor (ev1 tree) (ev2 tree)))
93             ((bw-and) (bitwise-and (ev1 tree) (ev2 tree)))
94             ((or) (if (and (zero? (ev1 tree)) (zero? (ev2 tree))) 0 1))
95             ((and) (if (or (zero? (ev1 tree)) (zero? (ev2 tree))) 0 1))
96             ((cond-expr) (if (zero? (ev1 tree)) (ev3 tree) (ev2 tree)))
97             ((ident) (cpp-err "undefined identifier: ~S" (cadr tree)))
98             (else (error "incomplete implementation"))))))
99     (eval-expr tree)))
100
101 ;; Note: scan-cpp-input scans replacement text.  When identifiers are found
102 ;; they are tested for expansion as follows:
103 ;; @enumerate
104 ;; @item If already expanded, then ignore.
105 ;; @item If followed by @code{(}, then use @code{collect-args} to get the
106 ;; arguments and ...
107 ;; @item Otherwise insert the replacement text and continue scanning (at
108 ;; first character of new replacement text.
109 ;; @end enumerate
110
111 ;; @deffn scan-cpp-input ch argd used dict end-tok => string
112 ;; Process replacement text from the input port and generate a (reversed)
113 ;; token-list.  If end-tok, stop at, and push back, @code{,} or @code{)}.
114 ;; The argument @var{argd} is a dictionary (argument name, argument
115 ;; value) pairs which will be expanded as needed.  This routine is called
116 ;; by collect-args, expand-cpp-repl and cpp-expand-text.
117 (define (scan-cpp-input ch argd dict used end-tok)
118   (let ((res (x-scan-cpp-input ch argd dict used end-tok)))
119     (simple-format #t "scan=>~S\n" res)
120     res))
121 (define (x-scan-cpp-input ch argd dict used end-tok)
122   ;; Works like this: scan tokens (comments, parens, strings, char's, etc).
123   ;; Tokens (i.e., strings) are collected in a (reverse ordered) list (stl)
124   ;; and merged together on return.  Lone characters are collected in the
125   ;; list @code{chl}.  Once a token border is seen the character list is
126   ;; converted to a string and added to the string list first, followed by
127   ;; the new token.
128
129   ;; Turn reverse chl into a string and insert it into the string list stl.
130   (define (add-chl chl stl)
131     (if (null? chl) stl (cons (list->string (reverse chl)) stl)))
132
133   ;; used when we see `#foo'; converts foo to "foo"
134   (define (stringify str)
135     (string-append "\"" str "\""))
136
137   (define conjoin string-append)
138
139   ;; We just scanned "defined", now need to scan the arg to inhibit expansion.
140   ;; For example, we have scanned "defined"; we now scan "(FOO)" or "FOO", and
141   ;; return "defined(FOO)".  We use ec (end-char) as state indicator: nul at
142   ;; start, #\) on seeing #\( or #\space if other.
143   (define (scan-defined-arg)
144     (let* ((ch (skip-ws ch)) (ec (if (char=? ch #\() #\) #\space)))
145       (let iter ((chl '(#\()) (ec ec) (ch ch))
146         (cond
147          ((and (eof-object? ch) (char=? #\space ec))
148           (string-append "defined" (list->string (reverse (cons #\) chl)))))
149          ((eof-object? ch) (cpp-err "illegal argument to `defined'"))
150          ((and (char=? ch #\)) (char=? ec #\)))
151           (string-append "defined" (list->string (reverse (cons ch chl)))))
152          ((char-set-contains? c:ir ch)
153           (iter (cons ch chl) ec (read-char)))
154          (else (cpp-err "illegal identifier"))))))
155
156   (let iter ((stl '())          ; string list (i.e., tokens)
157              (chl '())          ; char-list (current list of input chars)
158              (nxt #f)           ; next string 
159              (lvl 0)            ; level
160              (ch ch))   ; next character
161     (simple-format #t "iter ch=~S stl=~S chl=~S nxt=~S lvl=~S ch=~S\n"
162                    ch stl chl nxt lvl ch)
163     (cond
164      ;; have item to add, but first add in char's
165      (nxt (iter (cons nxt (add-chl chl stl)) '() #f lvl ch))
166      ;; If end of string or see end-ch at level 0, then return.
167      ((eof-object? ch)  ;; CHECK (ab++)
168       (apply string-append (reverse (add-chl chl stl))))
169      
170      ((and (eqv? end-tok ch) (zero? lvl))
171       (unread-char ch)
172       (apply string-append (reverse (add-chl chl stl))))
173      ((and end-tok (char=? #\) ch) (zero? lvl))
174       (unread-char ch)
175       (apply string-append (reverse (add-chl chl stl))))
176      
177      ((read-c-comm ch #f) =>
178       (lambda (cp) (iter stl chl (string-append "/*" (cdr cp) "*/")
179                          lvl (read-char))))
180      ;; not sure about this:
181      ((char-set-contains? c:ws ch) (iter stl chl nxt lvl (read-char)))
182      ((char=? #\( ch) (iter stl (cons ch chl) nxt (1+ lvl) (read-char)))
183      ((char=? #\) ch) (iter stl (cons ch chl) nxt (1- lvl) (read-char)))
184      ((char=? #\# ch)
185       (let ((ch (read-char)))
186         (if (eqv? ch #\#)
187             (iter stl chl "##" lvl (read-char))
188             (iter stl chl "#" lvl ch))))
189      ((read-c-string ch) =>
190       (lambda (st) (iter stl chl st lvl (read-char))))
191      ((read-c-ident ch) =>
192       (lambda (iden)
193         ;;(simple-format #t "  read-c-ident => ~S\n" iden)
194         (if (equal? iden "defined")
195             ;; "defined" is a special case
196             (iter stl chl (scan-defined-arg) lvl (read-char))
197             ;; otherwise ...
198             (let* ((aval (assoc-ref argd iden))  ; lookup argument
199                    (rval (assoc-ref dict iden))) ; lookup macro def
200               ;;(simple-format #t "    aval=~S rval=~S\n" aval rval)
201               (cond
202                ((and (pair? stl) (string=? "#" (car stl)))
203                 ;;(simple-format #t "TEST iden=~S aval=~S\n" iden aval)
204                 (iter (cdr stl) chl (stringify aval) lvl (read-char)))
205                ((and (pair? stl) (string=? "##" (car stl)))
206                 ;;(simple-format #t "TEST iden=~S aval=~S\n" iden aval)
207                 (iter (cddr stl) chl (conjoin (cadr stl) aval) lvl (read-char)))
208                ((member iden used)      ; name used
209                 (iter stl chl iden lvl (read-char)))
210                (aval                    ; arg ref
211                 (iter stl chl aval lvl (read-char)))
212                ((string? rval)          ; cpp repl
213                 (iter stl chl rval lvl (read-char)))
214                ((pair? rval)            ; cpp macro
215                 (let* ((argl (car rval)) (text (cdr rval))
216                        (argd (collect-args (read-char) argl argd dict used))
217                        (newl (expand-cpp-repl text argd dict (cons iden used))))
218                   (iter stl chl newl lvl (read-char))))
219                (else                    ; normal identifier
220                 ;;(simple-format #t "normal id stl=~S\n" stl)
221                 (iter stl chl iden lvl (read-char))))))))
222      (else
223       (iter stl (cons ch chl) #f lvl (read-char))))))
224
225 ;; @deffn collect-args ch argl argd dict used => argd
226 ;; to be documented
227 ;; I think argd is a passthrough for scan-cpp-input
228 ;; argl: list of formal arguments in #define
229 ;; argd: used? (maybe just a pass-through for scan-cpp-input
230 ;; dict: dict of macro defs
231 ;; used: list of already expanded macros
232 ;; TODO clean this up
233 ;; should be looking at #\( and eat up to matching #\)
234 (define (collect-args ch argl argd dict used)
235   (simple-format #t "collect-args: argl=~S argd=~S dict=~S\n" argl argd dict)
236   (if (not (eqv? (skip-ws ch) #\()) (cpp-err "CPP expecting `('"))
237   (let iter ((argl argl) (argv '()) (ch (read-char)))
238     (simple-format #t "  ch=~S\n" ch)
239     (cond
240      ((eqv? ch #\)) (reverse argv))
241      ((null? argl)
242       (if (eqv? ch #\space) (iter argl argv ch) (cpp-err "arg count")))
243      ((and (null? (cdr argl)) (string=? (car argl) "..."))
244       (iter (cdr argl)
245             (acons "__VA_ARGS__" (scan-cpp-input ch argd dict used #\)) argv)
246             (read-char)))
247      (else
248       (iter (cdr argl)
249             (acons (car argl) (scan-cpp-input ch argd dict used #\,) argv)
250             (read-char))))))
251
252 ;; @deffn expand-cpp-repl
253 ;; to be documented
254 (define (expand-cpp-repl repl argd dict used)
255   (with-input-from-string repl
256     (lambda () (scan-cpp-input (read-char) argd dict used #f))))
257
258 ;; @deffn cpp-expand-text text dict => string
259 (define (cpp-expand-text text dict)
260   (with-input-from-string text
261     (lambda () (scan-cpp-input (read-char) '() dict '() #f))))
262
263 ;; @deffn expand-cpp-mref ident dict => repl|#f
264 ;; Given an identifier seen in C99 input, this checks for associated
265 ;; definition in @var{dict} (generated from CPP defines).  If found,
266 ;; the expansion is returned as a string.  If @var{ident} refers
267 ;; to a macro with arguments, then the arguments will be read from the
268 ;; current input.
269 (define (expand-cpp-mref ident dict . rest)
270   (let ((used (if (pair? rest) (car rest) '()))
271         (rval (assoc-ref dict ident)))
272     (cond
273      ((not rval) #f)
274      ((member ident used) ident)
275      ((string? rval)
276       (let ((expd (expand-cpp-repl rval '() dict (cons ident used))))
277         expd))
278      ((pair? rval)
279       (let ((ch (read-char)))
280         (simple-format #t "expand-cpp-mref: ch=~S\n" ch)
281         (unread-char ch))
282       (let* ((argl (car rval)) (repl (cdr rval))
283              (argd (collect-args (read-char) argl '() dict '()))
284              (expd (expand-cpp-repl repl argd dict (cons ident used))))
285         expd)))))
286
287 ;;; --- last line ---