1 ;;; tests/parser.el --- Some tests for js2-mode.
3 ;; Copyright (C) 2009, 2011-2013 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software: you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 (defmacro js2-deftest (name buffer-contents &rest body)
27 `(ert-deftest ,(intern (format "js2-%s" name)) ()
30 (insert ,buffer-contents))
34 (fundamental-mode)))))
36 (put 'js2-deftest 'lisp-indent-function 'defun)
38 (defun js2-test-string-to-ast (s)
39 (ert-with-test-buffer (:name 'origin)
42 (should (null js2-mode-buffer-dirty-p))
45 (defun* js2-test-parse-string (code-string &key syntax-error errors-count
47 (let ((ast (js2-test-string-to-ast code-string)))
49 (let ((errors (js2-ast-root-errors ast)))
50 (should (= (or errors-count 1) (length errors)))
51 (destructuring-bind (_ pos len) (first errors)
52 (should (string= syntax-error (substring code-string
53 (1- pos) (+ pos len -1))))))
54 (should (= 0 (length (js2-ast-root-errors ast))))
55 (ert-with-test-buffer (:name 'copy)
57 (skip-chars-backward " \t\n")
58 (should (string= (or reference code-string)
59 (buffer-substring-no-properties
60 (point-min) (point))))))))
62 (defmacro* js2-deftest-parse (name code-string &key bind syntax-error errors-count
64 "Parse CODE-STRING. If SYNTAX-ERROR is nil, print syntax tree
65 with `js2-print-tree' and assert the result to be equal to
66 REFERENCE, if present, or the original string. If SYNTAX-ERROR
67 is passed, expect syntax error highlighting substring equal to
68 SYNTAX-ERROR value. BIND defines bindings to apply them around
70 `(ert-deftest ,(intern (format "js2-%s" name)) ()
71 (let ,(append bind '((js2-basic-offset 2)))
72 (js2-test-parse-string ,code-string
73 :syntax-error ,syntax-error
74 :errors-count ,errors-count
75 :reference ,reference))))
77 (put 'js2-deftest-parse 'lisp-indent-function 'defun)
81 (js2-deftest-parse variable-assignment
84 (js2-deftest-parse empty-object-literal
87 (js2-deftest-parse empty-array-literal
90 (js2-deftest-parse array-with-missing-elements
93 (js2-deftest-parse comma-after-regexp
96 (js2-deftest-parse return-statement
97 "function foo() {\n return 2;\n}")
99 (js2-deftest-parse function-statement
100 "function foo() {\n}")
102 (js2-deftest-parse function-statement-inside-block
103 "if (true) {\n function foo() {\n }\n}")
105 (js2-deftest-parse function-expression-statements-are-verboten
106 "function() {}" :syntax-error "(")
108 (js2-deftest-parse member-expr-as-function-name
109 "function a.b.c[2](x, y) {\n}"
110 :bind ((js2-allow-member-expr-as-function-name t)))
112 (js2-deftest-parse named-function-expression
113 "a = function b() {};")
115 (js2-deftest-parse parenthesized-expression
118 (js2-deftest-parse for-with-in-operator-in-parens
119 "for (var y = (0 in []) in {}) {\n}")
121 (js2-deftest-parse for-with-in-operator-in-cond
122 "for (var y = 1 ? 0 in [] : false in {}) {\n}")
124 ;;; Callers of `js2-valid-prop-name-token'
126 (js2-deftest-parse parse-property-access-when-not-keyword
129 (js2-deftest-parse parse-property-access-when-keyword
131 :bind ((js2-allow-keywords-as-property-names t)))
133 (js2-deftest-parse parse-property-access-when-keyword-no-xml
135 :bind ((js2-allow-keywords-as-property-names t)
136 (js2-compiler-xml-available nil)))
138 (js2-deftest-parse parse-object-literal-when-not-keyword
141 (js2-deftest-parse parse-object-literal-when-keyword
143 :bind ((js2-allow-keywords-as-property-names t)))
145 ;;; 'of' contextual keyword
147 (js2-deftest-parse parse-legacy-array-comp-loop-with-of
148 "[a for (a of [])];")
150 (js2-deftest-parse parse-array-comp-loop
151 "[for (a of []) a];")
153 (js2-deftest-parse parse-for-of
154 "for (var a of []) {\n}")
156 (js2-deftest-parse of-can-be-var-name
159 (js2-deftest-parse of-can-be-function-name
160 "function of() {\n}")
162 ;;; Destructuring binding
164 (js2-deftest-parse destruct-in-declaration
165 "var {a, b} = {a: 1, b: 2};")
167 (js2-deftest-parse destruct-in-arguments
168 "function f({a: aa, b: bb}) {\n}")
170 (js2-deftest-parse destruct-in-array-comp-loop
171 "[a + b for ([a, b] in [[0, 1], [1, 2]])];")
173 (js2-deftest-parse destruct-in-catch-clause
174 "try {\n} catch ({a, b}) {\n a + b;\n}")
176 ;;; Function parameters
178 (js2-deftest-parse function-with-default-parameters
179 "function foo(a = 1, b = a + 1) {\n}")
181 (js2-deftest-parse function-with-no-default-after-default
182 "function foo(a = 1, b) {\n}"
185 (js2-deftest-parse function-with-destruct-after-default
186 "function foo(a = 1, {b, c}) {\n}"
189 (js2-deftest-parse function-with-rest-parameter
190 "function foo(a, b, ...rest) {\n}")
192 (js2-deftest-parse function-with-param-after-rest-parameter
193 "function foo(a, ...b, rest) {\n}"
194 :syntax-error "rest")
196 (js2-deftest-parse function-with-destruct-after-rest-parameter
197 "function foo(a, ...b, {}) {\n}"
200 (js2-deftest-parse function-with-rest-after-default-parameter
201 "function foo(a = 1, ...rest) {\n}")
205 (js2-deftest-parse spread-in-array-literal
206 "[1, ...[2, 3], 4, ...[5, 6]];")
208 (js2-deftest-parse spread-in-function-call
209 "f(3, ...[t(2), t(3)], 42, ...[t(4)]);")
213 (js2-deftest-parse arrow-function-with-empty-args-and-no-curlies
214 "() => false;" :reference "() => {false};")
216 (js2-deftest-parse arrow-function-with-args-and-curlies
217 "(a, b = 1, ...c) => { c;\n};")
219 (js2-deftest-parse parenless-arrow-function-prohibits-rest
220 "...b => {b + 1;};" :syntax-error "=>" :errors-count 2)
222 (js2-deftest-parse parenless-arrow-function-prohibits-destructuring
223 "[a, b] => {a + b;};" :syntax-error "=>" :errors-count 5)
225 ;;; Automatic semicolon insertion
227 (js2-deftest-parse no-auto-semi-insertion-after-if
230 (js2-deftest-parse auto-semi-insertion-after-function
231 "a = function() {}" :reference "a = function() {};")
233 (js2-deftest-parse auto-semi-one-variable-per-line
234 "x\ny" :reference "x;\ny;")
238 (js2-deftest-parse labeled-stmt-node
239 "foo:\nbar:\nx = y + 1;")
241 (js2-deftest no-label-node-inside-expr "x = y:"
242 (let (js2-parse-interruptable-p)
244 (let ((assignment (js2-expr-stmt-node-expr (car (js2-scope-kids js2-mode-ast)))))
245 (should (js2-name-node-p (js2-assign-node-right assignment)))))
247 (js2-deftest-parse label-and-loops "for (; ; ) {
256 (js2-deftest-parse legacy-generator "function foo() {\n yield 1;\n}")
258 (js2-deftest-parse legacy-generator-cannot-return
259 "function foo() {\n yield 1;\n return 2;\n}" :syntax-error "return 2")
261 (js2-deftest-parse harmony-generator "function* bar() {\n yield 2;\n return 3;\n}")
263 (js2-deftest-parse harmony-generator-yield-star "(function*(a) { yield* a;\n});")
267 (js2-deftest-parse parse-legacy-array-comp-loop-with-filter
268 "[a for (a in b) if (a == 2)];")
270 (js2-deftest-parse parse-array-comp-loop-with-filters
271 "[for (a in b) if (a == 2) if (b != 10) a];")
273 (js2-deftest-parse parse-generator-comp-loop-with-filters
274 "(for (x of y) if (x != 4) x);")
276 (js2-deftest-parse parse-array-comp-with-yield-is-ok
277 "(function() { return [for (x of []) yield x];\n});")
279 (js2-deftest-parse parse-generator-comp-with-yield-is-not-ok
280 "(function() { return (for (x of []) yield x);\n});"
281 :syntax-error "yield")
283 (js2-deftest-parse parse-generator-comp-with-yield-inside-function-is-ok
284 "(for (x of []) function*() { yield x;\n});")
288 (js2-deftest-parse decimal-starting-with-zero "081;" :reference "81;")
290 (js2-deftest-parse huge-hex "0x0123456789abcdefABCDEF;" :reference "-1;")
292 (js2-deftest-parse octal-without-o "071;" :reference "57;")
294 (js2-deftest-parse hex-number-okay "0x123;" :reference "291;")
296 (js2-deftest-parse hex-number-broken "0xz23;"
297 :syntax-error "0xz" :errors-count 2)
299 (js2-deftest-parse binary-number-okay "0b101;" :reference "5;")
301 (js2-deftest-parse binary-number-broken "0b210;"
302 :syntax-error "0b2" :errors-count 2)
304 (js2-deftest-parse octal-number-okay "0o765;" :reference "501;")
306 (js2-deftest-parse octal-number-broken "0o812;"
307 :syntax-error "0o8" :errors-count 2)
311 (js2-deftest ast-symbol-table-includes-fn-node "function foo() {}"
313 (let ((entry (js2-scope-get-symbol js2-mode-ast 'foo)))
314 (should (= (js2-symbol-decl-type entry) js2-FUNCTION))
315 (should (equal (js2-symbol-name entry) "foo"))
316 (should (js2-function-node-p (js2-symbol-ast-node entry)))))
318 (js2-deftest fn-symbol-table-includes-nested-fn "function foo() {
323 (let* ((scope (js2-node-at-point (point-min)))
324 (fn-entry (js2-scope-get-symbol scope 'bar))
325 (var-entry (js2-scope-get-symbol scope 'x)))
326 (should (string= (js2-name-node-name (js2-function-node-name scope)) "foo"))
327 (should (= (js2-symbol-decl-type fn-entry) js2-FUNCTION))
328 (should (js2-function-node-p (js2-symbol-ast-node fn-entry)))
329 (should (= (js2-symbol-decl-type var-entry) js2-VAR))
330 (should (js2-name-node-p (js2-symbol-ast-node var-entry)))))
334 (js2-deftest get-token "(1+1)"
336 (should (eq js2-LP (js2-next-token)))
337 (should (eq js2-NUMBER (js2-next-token)))
338 (should (eq js2-ADD (js2-next-token)))
339 (should (eq js2-NUMBER (js2-next-token)))
340 (should (eq js2-RP (js2-next-token))))
342 (js2-deftest unget-token "()"
344 (should (eq js2-LP (js2-next-token)))
346 (should (eq js2-LP (js2-next-token)))
347 (should (eq js2-RP (js2-next-token))))
349 (js2-deftest get-token-or-eol "x\n++;"
351 (should (eq js2-NAME (js2-next-token)))
352 (should (eq js2-EOL (js2-peek-token-or-eol)))
353 (should (eq js2-INC (js2-next-token)))
354 (should (eq js2-SEMI (js2-peek-token-or-eol))))
356 (js2-deftest unget-token-over-eol-and-comment "x\n//abc\ny"
358 (should (eq js2-NAME (js2-next-token)))
359 (should (eq js2-NAME (js2-next-token)))
360 (should (equal "y" (js2-current-token-string)))
362 (should (eq js2-NAME (js2-current-token-type)))
363 (should (equal "x" (js2-current-token-string))))
365 (js2-deftest ts-seek "(1+2)"
367 (should (eq js2-LP (js2-next-token)))
368 (should (eq js2-NUMBER (js2-next-token)))
370 (let ((state (make-js2-ts-state)))
371 (should (eq js2-NUMBER (js2-next-token)))
372 (should (eq js2-ADD (js2-next-token)))
374 (should (eq 1 js2-ti-lookahead))
375 (should (eq js2-NUMBER (js2-next-token)))
376 (should (eq 1 (js2-token-number
377 (js2-current-token))))))
381 (js2-deftest for-node-with-error-len "for "
383 (let ((node (js2-node-at-point (point-min))))
384 (should (= (js2-node-len (js2-node-parent node)) 4))))
386 (js2-deftest function-without-parens-error "function b {}"
387 ;; Should finish the parse.