Move lexical binding renaming to JS:VARIABLE printer (part one)
[clinton/parenscript.git] / src / printer.lisp
CommitLineData
496ef8be 1(in-package "PARENSCRIPT")
9da682ca 2
cb8f8e58
VS
3(defvar *ps-print-pretty* t)
4(defvar *indent-num-spaces* 4)
5(defvar *js-string-delimiter* #\'
6 "Specifies which character should be used for delimiting strings.
7
8This variable is used when you want to embed the resulting JavaScript
9in an html attribute delimited by #\\\" as opposed to #\\', or
10vice-versa.")
11
12(defvar *indent-level*)
cb8f8e58 13
d434e1d5
VS
14(defvar *psw-stream*)
15
16(defun parenscript-print (form immediate?)
17 (declare (special immediate?))
cb8f8e58 18 (let ((*indent-level* 0)
d434e1d5
VS
19 (*psw-stream* (if immediate?
20 *psw-stream*
21 (make-string-output-stream)))
22 (%psw-accumulator ()))
23 (declare (special %psw-accumulator))
0ce67a33 24 (if (and (listp form) (eq 'js:block (car form))) ; ignore top-level block
fdfa77fc 25 (loop for (statement . remaining) on (cdr form) do
d434e1d5 26 (ps-print statement) (psw #\;) (when remaining (psw #\Newline)))
0ce67a33 27 (ps-print form))
d434e1d5
VS
28 (unless immediate?
29 (reverse (cons (get-output-stream-string *psw-stream*) %psw-accumulator)))))
cb8f8e58
VS
30
31(defun psw (obj)
d434e1d5
VS
32 (declare (special %psw-accumulator immediate?))
33 (typecase obj
34 (string (write-string obj *psw-stream*))
35 (character (write-char obj *psw-stream*))
36 (otherwise
37 (if immediate?
38 (write-string (eval obj) *psw-stream*)
39 (setf %psw-accumulator
40 (cons obj
41 (cons (get-output-stream-string *psw-stream*)
42 %psw-accumulator)))))))
4ff112cb 43
839600e9 44(defgeneric ps-print% (special-form-name special-form-args))
9da682ca 45
4a987e2b
VS
46(defmacro defprinter (special-form content-args &body body)
47 "Given a special-form name and a destructuring lambda-list for its
48arguments, defines a printer for that form using the given body."
49 (let ((sf (gensym))
50 (sf-args (gensym)))
839600e9 51 `(defmethod ps-print% ((,sf (eql ',special-form)) ,sf-args)
89aa7077 52 (declare (ignorable ,sf))
4a987e2b
VS
53 (destructuring-bind ,content-args
54 ,sf-args
55 ,@body))))
56
839600e9 57(defgeneric ps-print (compiled-form))
4a987e2b 58
cb8f8e58 59(defmethod ps-print ((form null))) ; don't print top-level nils (ex: result of defining macros, etc.)
53a1beac 60
f2bb932e 61(defmethod ps-print ((s symbol))
4e6c3ba1 62 (assert (keywordp s) nil "~S is not a symbol" s)
48ea6dd2 63 (ps-print (string-downcase s)))
f2bb932e 64
839600e9 65(defmethod ps-print ((compiled-form cons))
839600e9 66 (ps-print% (car compiled-form) (cdr compiled-form)))
4a987e2b 67
116f7450 68(defun newline-and-indent ()
cb8f8e58 69 (if *ps-print-pretty*
496ef8be
VS
70 (progn (psw #\Newline)
71 (loop repeat (* *indent-level* *indent-num-spaces*) do (psw #\Space)))
cb8f8e58 72 (psw #\Space)))
4a987e2b
VS
73
74(defparameter *js-lisp-escaped-chars*
75 '((#\' . #\')
76 (#\\ . #\\)
77 (#\b . #\Backspace)
78 (#\f . #.(code-char 12))
79 (#\n . #\Newline)
80 (#\r . #\Return)
81 (#\t . #\Tab)))
82
839600e9 83(defmethod ps-print ((string string))
4a987e2b
VS
84 (flet ((lisp-special-char-to-js (lisp-char)
85 (car (rassoc lisp-char *js-lisp-escaped-chars*))))
c639fe7f 86 (psw *js-string-delimiter*)
839600e9
VS
87 (loop for char across string
88 for code = (char-code char)
89 for special = (lisp-special-char-to-js char)
c639fe7f 90 do (cond (special (psw #\\) (psw special))
d434e1d5 91 ((or (<= code #x1f) (>= code #x80)) (format *psw-stream* "\\u~4,'0x" code))
c639fe7f
VS
92 (t (psw char))))
93 (psw *js-string-delimiter*)))
839600e9
VS
94
95(defmethod ps-print ((number number))
d434e1d5 96 (format *psw-stream* (if (integerp number) "~S" "~F") number))
4a987e2b
VS
97
98;;; expression and operator precedence rules
99
100(defun expression-precedence (expr)
101 (if (consp expr)
102 (case (car expr)
0ce67a33
VS
103 ((js:slot-value js:aref) (op-precedence (car expr)))
104 (js:= (op-precedence 'js:=))
e8fdcce7 105 (js:? (op-precedence 'js:?))
0ce67a33 106 (js:unary-operator (op-precedence (second expr)))
4a987e2b 107 (operator (op-precedence (second expr)))
a14fb2cb
VS
108 (otherwise -1))
109 -1))
9da682ca 110
0ce67a33 111(defprinter js:literal (str)
4ff112cb 112 (psw str))
46f794a4 113
4ff112cb
VS
114(defun print-comma-delimited-list (ps-forms)
115 (loop for (form . remaining) on ps-forms do
116 (ps-print form) (when remaining (psw ", "))))
cc4f1551 117
0ce67a33 118(defprinter js:array (&rest initial-contents)
4ff112cb 119 (psw #\[) (print-comma-delimited-list initial-contents) (psw #\]))
839600e9 120
0ce67a33 121(defprinter js:aref (array indices)
a14fb2cb 122 (if (>= (expression-precedence array) (op-precedence 'js:aref))
d43d746e
TC
123 (parenthesize-print array)
124 (ps-print array))
839600e9 125 (loop for idx in indices do
4ff112cb 126 (psw #\[) (ps-print idx) (psw #\])))
839600e9 127
0c69cff0
CE
128(defvar *lexical-bindings* nil)
129
130(defun rename-js-variable (name)
131 (or (cdr (assoc name *lexical-bindings*))
132 name))
133
134(defprinter js:let (variables expression)
135 (let ((*lexical-bindings*
136 (append (mapcar (lambda (var)
137 (cons var (if (assoc var *lexical-bindings*)
138 (ps-gensym var)
139 var)))
140 variables))))
141 (ps-print expression)))
142
0ce67a33 143(defprinter js:variable (var)
0c69cff0 144 (psw (symbol-to-js-string (rename-js-variable var))))
cc4f1551
RD
145
146;;; arithmetic operators
839600e9 147(defun parenthesize-print (ps-form)
4ff112cb 148 (psw #\() (ps-print ps-form) (psw #\)))
cc4f1551 149
0ce67a33 150(defprinter js:operator (op &rest args)
4ff112cb
VS
151 (loop for (arg . remaining) on args
152 with precedence = (op-precedence op) do
153 (if (>= (expression-precedence arg) precedence)
154 (parenthesize-print arg)
155 (ps-print arg))
d434e1d5 156 (when remaining (format *psw-stream* " ~(~A~) " op))))
4a987e2b 157
0ce67a33 158(defprinter js:unary-operator (op arg &key prefix space)
d434e1d5 159 (when prefix (format *psw-stream* "~(~a~)~:[~; ~]" op space))
6a46e1ef
TC
160 (if (> (expression-precedence arg)
161 (op-precedence (case op
162 (+ 'unary+)
163 (- 'unary-)
164 (t op))))
839600e9
VS
165 (parenthesize-print arg)
166 (ps-print arg))
d434e1d5 167 (unless prefix (format *psw-stream* "~(~a~)" op)))
4a987e2b 168
0ce67a33
VS
169(defprinter js:funcall (fun-designator &rest args)
170 (funcall (if (member (car fun-designator) '(js:variable js:aref js:slot-value js:funcall))
79630c82
VS
171 #'ps-print
172 #'parenthesize-print)
173 fun-designator)
4ff112cb 174 (psw #\() (print-comma-delimited-list args) (psw #\)))
cc4f1551 175
fdfa77fc
VS
176(defprinter js:|,| (&rest expressions)
177 (psw #\()
178 (loop for (exp . remaining) on expressions do
179 (ps-print exp) (when remaining (psw ", ")))
180 (psw #\)))
181
182(defprinter js:block (&rest statements)
183 (psw #\{)
184 (incf *indent-level*)
185 (dolist (statement statements)
186 (newline-and-indent) (ps-print statement) (psw #\;))
187 (decf *indent-level*)
188 (newline-and-indent)
189 (psw #\}))
4a987e2b 190
0ce67a33 191(defprinter js:lambda (args body)
839600e9 192 (print-fun-def nil args body))
4a987e2b 193
0ce67a33 194(defprinter js:defun (name args body)
839600e9
VS
195 (print-fun-def name args body))
196
116f7450 197(defun print-fun-def (name args body-block)
d434e1d5 198 (format *psw-stream* "function ~:[~;~A~](" name (symbol-to-js-string name))
4ff112cb 199 (loop for (arg . remaining) on args do
dd4442b8 200 (psw (symbol-to-js-string arg)) (when remaining (psw ", ")))
4ff112cb 201 (psw ") ")
116f7450 202 (ps-print body-block))
cc4f1551 203
0ce67a33 204(defprinter js:object (&rest slot-defs)
4ff112cb 205 (psw "{ ")
79630c82 206 (loop for ((slot-name . slot-value) . remaining) on slot-defs do
fc772f72
VS
207 (ps-print slot-name) (psw " : ") (ps-print slot-value)
208 (when remaining (psw ", ")))
4ff112cb 209 (psw " }"))
cc4f1551 210
0ce67a33 211(defprinter js:slot-value (obj slot)
a14fb2cb 212 (if (or (> (expression-precedence obj) (op-precedence 'js:slot-value))
79630c82 213 (numberp obj)
0ce67a33 214 (and (listp obj) (member (car obj) '(js:lambda js:object))))
839600e9
VS
215 (parenthesize-print obj)
216 (ps-print obj))
3b4f81fb 217 (if (and (symbolp slot) (not (keywordp slot)))
dd4442b8 218 (progn (psw #\.) (psw (symbol-to-js-string slot)))
4ff112cb 219 (progn (psw #\[) (ps-print slot) (psw #\]))))
cc4f1551 220
fdfa77fc 221(defprinter js:if (test consequent &rest clauses)
4ff112cb 222 (psw "if (") (ps-print test) (psw ") ")
fdfa77fc
VS
223 (ps-print consequent)
224 (loop while clauses do
225 (ecase (car clauses)
226 (:else-if (psw " else if (") (ps-print (cadr clauses)) (psw ") ")
227 (ps-print (caddr clauses))
228 (setf clauses (cdddr clauses)))
229 (:else (psw " else ")
230 (ps-print (cadr clauses))
231 (return)))))
4a987e2b 232
e8fdcce7 233(defprinter js:? (test then else)
20ba6d7a
VS
234 (if (>= (expression-precedence test) (op-precedence 'js:?))
235 (parenthesize-print test)
236 (ps-print test))
4ff112cb 237 (psw " ? ")
e8fdcce7 238 (if (>= (expression-precedence then) (op-precedence 'js:?))
839600e9
VS
239 (parenthesize-print then)
240 (ps-print then))
4ff112cb 241 (psw " : ")
e8fdcce7 242 (if (>= (expression-precedence else) (op-precedence 'js:?))
5705b542
VS
243 (parenthesize-print else)
244 (ps-print else)))
cc4f1551 245
0ce67a33 246(defprinter js:= (lhs rhs)
4ff112cb 247 (ps-print lhs) (psw " = ") (ps-print rhs))
cc4f1551 248
0ce67a33 249(defprinter js:var (var-name &rest var-value)
4ff112cb 250 (psw "var ")
0c69cff0 251 (ps-print var-name)
839600e9 252 (when var-value
4ff112cb 253 (psw " = ")
839600e9 254 (ps-print (car var-value))))
cc4f1551 255
0ce67a33 256(defprinter js:break (&optional label)
c452748e
TC
257 (psw "break")
258 (when label
259 (psw " ")
dd4442b8 260 (psw (symbol-to-js-string label))))
c452748e 261
0ce67a33 262(defprinter js:continue (&optional label)
c452748e
TC
263 (psw "continue")
264 (when label
265 (psw " ")
dd4442b8 266 (psw (symbol-to-js-string label))))
c452748e 267
cc4f1551 268;;; iteration
0ce67a33 269(defprinter js:for (label vars tests steps body-block)
dd4442b8 270 (when label (psw (symbol-to-js-string label)) (psw ": ") (newline-and-indent))
4ff112cb
VS
271 (psw "for (")
272 (loop for ((var-name . var-init) . remaining) on vars
273 for decl = "var " then "" do
dd4442b8 274 (psw decl) (psw (symbol-to-js-string var-name)) (psw " = ") (ps-print var-init) (when remaining (psw ", ")))
4ff112cb 275 (psw "; ")
6a2ce72d
TC
276 (loop for (test . remaining) on tests do
277 (ps-print test) (when remaining (psw ", ")))
4ff112cb 278 (psw "; ")
6a2ce72d
TC
279 (loop for (step . remaining) on steps do
280 (ps-print step) (when remaining (psw ", ")))
4ff112cb 281 (psw ") ")
116f7450 282 (ps-print body-block))
cc4f1551 283
0ce67a33 284(defprinter js:for-in (var object body-block)
5ffb1eba 285 (psw "for (var ") (ps-print var) (psw " in ")
6a46e1ef
TC
286 (if (> (expression-precedence object) (op-precedence 'in))
287 (parenthesize-print object)
288 (ps-print object))
289 (psw ") ")
116f7450 290 (ps-print body-block))
cc4f1551 291
0ce67a33 292(defprinter js:while (test body-block)
4ff112cb 293 (psw "while (") (ps-print test) (psw ") ")
116f7450 294 (ps-print body-block))
4a987e2b 295
0ce67a33 296(defprinter js:with (expression body-block)
4ff112cb 297 (psw "with (") (ps-print expression) (psw ") ")
116f7450 298 (ps-print body-block))
4a987e2b 299
0ce67a33 300(defprinter js:switch (test clauses)
116f7450
VS
301 (flet ((print-body-statements (body-statements)
302 (incf *indent-level*)
303 (loop for statement in body-statements do
304 (progn (newline-and-indent)
305 (ps-print statement)
4ff112cb 306 (psw #\;)))
116f7450 307 (decf *indent-level*)))
4ff112cb 308 (psw "switch (") (ps-print test) (psw ") {")
e0032a96 309 (loop for (val . statements) in clauses
116f7450 310 do (progn (newline-and-indent)
675edae3 311 (if (eq val 'default)
4ff112cb 312 (progn (psw "default: ")
e0032a96 313 (print-body-statements statements))
4ff112cb 314 (progn (psw "case ")
116f7450 315 (ps-print val)
4ff112cb 316 (psw #\:)
e0032a96
VS
317 (print-body-statements statements)))))
318 (newline-and-indent)
4ff112cb 319 (psw #\})))
116f7450 320
0ce67a33 321(defprinter js:try (body-block &key catch finally)
4ff112cb 322 (psw "try ")
116f7450 323 (ps-print body-block)
839600e9 324 (when catch
dd4442b8 325 (psw " catch (") (psw (symbol-to-js-string (first catch))) (psw ") ")
839600e9
VS
326 (ps-print (second catch)))
327 (when finally
4ff112cb 328 (psw " finally ")
116f7450 329 (ps-print finally)))
cc4f1551
RD
330
331;;; regex
0ce67a33 332(defprinter js:regex (regex)
d434e1d5
VS
333 (let ((slash (unless (and (> (length regex) 0) (char= (char regex 0) #\/)) "/")))
334 (psw (concatenate 'string slash regex slash))))
cc4f1551 335
cc4f1551 336;;; conditional compilation
0ce67a33 337(defprinter js:cc-if (test &rest body)
4ff112cb 338 (psw "/*@if ")
839600e9 339 (ps-print test)
116f7450 340 (incf *indent-level*)
0ce67a33 341 (dolist (form body)
4ff112cb 342 (newline-and-indent) (ps-print form) (psw #\;))
116f7450
VS
343 (decf *indent-level*)
344 (newline-and-indent)
4ff112cb 345 (psw "@end @*/"))
cc4f1551 346
0ce67a33 347(defprinter js:instanceof (value type)
6a46e1ef 348 (psw #\()
0ce67a33 349 (if (> (expression-precedence value) (op-precedence 'js:instanceof))
6a46e1ef
TC
350 (parenthesize-print value)
351 (ps-print value))
352 (psw " instanceof ")
0ce67a33 353 (if (> (expression-precedence type) (op-precedence 'js:instanceof))
6a46e1ef
TC
354 (parenthesize-print type)
355 (ps-print type))
356 (psw #\)))
357
0ce67a33 358(defprinter js:escape (literal-js)
ceb1f277 359 ;; literal-js should be a form that evaluates to a string containing valid JavaScript
0ce67a33 360 (psw literal-js))
cb8f8e58 361
6a46e1ef 362;;; named statements
0ce67a33
VS
363(defprinter js:throw (x)
364 (psw "throw ") (ps-print x))
365
366(defprinter js:return (x)
367 (psw "return ") (ps-print x))