code.delx.au - gnu-emacs-elpa/blob - tests/parser.el

   1 ;;; tests/parser.el --- Some tests for js2-mode.
   2
   3 ;; Copyright (C) 2009, 2011-2013  Free Software Foundation, Inc.
   4
   5 ;; This file is part of GNU Emacs.
   6
   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.
  11
  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.
  16
  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/>.
  19
  20 ;;; Code:
  21
  22 (require 'ert)
  23 (require 'ert-x)
  24 (require 'js2-mode)
  25
  26 (defmacro js2-deftest (name buffer-contents &rest body)
  27   `(ert-deftest ,(intern (format "js2-%s" name)) ()
  28      (with-temp-buffer
  29        (save-excursion
  30          (insert ,buffer-contents))
  31        (unwind-protect
  32            (progn
  33              ,@body)
  34          (fundamental-mode)))))
  35
  36 (put 'js2-deftest 'lisp-indent-function 'defun)
  37
  38 (defun js2-test-string-to-ast (s)
  39   (ert-with-test-buffer (:name 'origin)
  40     (insert s)
  41     (js2-mode)
  42     (should (null js2-mode-buffer-dirty-p))
  43     js2-mode-ast))
  44
  45 (defun* js2-test-parse-string (code-string &key syntax-error errors-count
  46                                                 reference)
  47   (let ((ast (js2-test-string-to-ast code-string)))
  48     (if syntax-error
  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)
  56         (js2-print-tree ast)
  57         (skip-chars-backward " \t\n")
  58         (should (string= (or reference code-string)
  59                          (buffer-substring-no-properties
  60                           (point-min) (point))))))))
  61
  62 (defmacro* js2-deftest-parse (name code-string &key bind syntax-error errors-count
  63                                                     reference)
  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
  69 the test."
  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))))
  76
  77 (put 'js2-deftest-parse 'lisp-indent-function 'defun)
  78
  79 ;;; Basics
  80
  81 (js2-deftest-parse variable-assignment
  82   "a = 1;")
  83
  84 (js2-deftest-parse empty-object-literal
  85   "b = {};")
  86
  87 (js2-deftest-parse empty-array-literal
  88   "c = [];")
  89
  90 (js2-deftest-parse array-with-missing-elements
  91   "var a = [1, 2, ,];")
  92
  93 (js2-deftest-parse comma-after-regexp
  94   "d = /eee/, 42;")
  95
  96 (js2-deftest-parse return-statement
  97   "function foo() {\n  return 2;\n}")
  98
  99 (js2-deftest-parse function-statement
 100   "function foo() {\n}")
 101
 102 (js2-deftest-parse function-statement-inside-block
 103   "if (true) {\n  function foo() {\n  }\n}")
 104
 105 (js2-deftest-parse function-expression-statements-are-verboten
 106   "function() {}" :syntax-error "(")
 107
 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)))
 111
 112 (js2-deftest-parse named-function-expression
 113   "a = function b() {};")
 114
 115 (js2-deftest-parse parenthesized-expression
 116   "(1 + 2);")
 117
 118 ;;; Callers of `js2-valid-prop-name-token'
 119
 120 (js2-deftest-parse parse-property-access-when-not-keyword
 121   "A.foo = 3;")
 122
 123 (js2-deftest-parse parse-property-access-when-keyword
 124   "A.in = 3;"
 125   :bind ((js2-allow-keywords-as-property-names t)))
 126
 127 (js2-deftest-parse parse-property-access-when-keyword-no-xml
 128   "A.in = 3;"
 129   :bind ((js2-allow-keywords-as-property-names t)
 130          (js2-compiler-xml-available nil)))
 131
 132 (js2-deftest-parse parse-object-literal-when-not-keyword
 133   "a = {b: 1};")
 134
 135 (js2-deftest-parse parse-object-literal-when-keyword
 136   "a = {in: 1};"
 137   :bind ((js2-allow-keywords-as-property-names t)))
 138
 139 ;;; 'of' contextual keyword
 140
 141 (js2-deftest-parse parse-legacy-array-comp-loop-with-of
 142   "[a for (a of [])];")
 143
 144 (js2-deftest-parse parse-array-comp-loop
 145   "[for (a of []) a];")
 146
 147 (js2-deftest-parse parse-for-of
 148   "for (var a of []) {\n}")
 149
 150 (js2-deftest-parse of-can-be-var-name
 151   "var of = 3;")
 152
 153 (js2-deftest-parse of-can-be-function-name
 154   "function of() {\n}")
 155
 156 ;;; Destructuring binding
 157
 158 (js2-deftest-parse destruct-in-declaration
 159   "var {a, b} = {a: 1, b: 2};")
 160
 161 (js2-deftest-parse destruct-in-arguments
 162   "function f({a: aa, b: bb}) {\n}")
 163
 164 (js2-deftest-parse destruct-in-array-comp-loop
 165   "[a + b for ([a, b] in [[0, 1], [1, 2]])];")
 166
 167 (js2-deftest-parse destruct-in-catch-clause
 168   "try {\n} catch ({a, b}) {\n  a + b;\n}")
 169
 170 ;;; Function parameters
 171
 172 (js2-deftest-parse function-with-default-parameters
 173   "function foo(a = 1, b = a + 1) {\n}")
 174
 175 (js2-deftest-parse function-with-no-default-after-default
 176   "function foo(a = 1, b) {\n}"
 177   :syntax-error "b")
 178
 179 (js2-deftest-parse function-with-destruct-after-default
 180   "function foo(a = 1, {b, c}) {\n}"
 181   :syntax-error "{")
 182
 183 (js2-deftest-parse function-with-rest-parameter
 184   "function foo(a, b, ...rest) {\n}")
 185
 186 (js2-deftest-parse function-with-param-after-rest-parameter
 187   "function foo(a, ...b, rest) {\n}"
 188   :syntax-error "rest")
 189
 190 (js2-deftest-parse function-with-destruct-after-rest-parameter
 191   "function foo(a, ...b, {}) {\n}"
 192   :syntax-error "{}")
 193
 194 (js2-deftest-parse function-with-rest-after-default-parameter
 195   "function foo(a = 1, ...rest) {\n}")
 196
 197 ;;; Spread operator
 198
 199 (js2-deftest-parse spread-in-array-literal
 200   "[1, ...[2, 3], 4, ...[5, 6]];")
 201
 202 (js2-deftest-parse spread-in-function-call
 203   "f(3, ...[t(2), t(3)], 42, ...[t(4)]);")
 204
 205 ;;; Arrow functions
 206
 207 (js2-deftest-parse arrow-function-with-empty-args-and-no-curlies
 208   "() => false;" :reference "() => {false};")
 209
 210 (js2-deftest-parse arrow-function-with-args-and-curlies
 211   "(a, b = 1, ...c) => {  c;\n};")
 212
 213 (js2-deftest-parse parenless-arrow-function-prohibits-rest
 214   "...b => {b + 1;};" :syntax-error "=>" :errors-count 2)
 215
 216 (js2-deftest-parse parenless-arrow-function-prohibits-destructuring
 217   "[a, b] => {a + b;};" :syntax-error "=>" :errors-count 5)
 218
 219 ;;; Automatic semicolon insertion
 220
 221 (js2-deftest-parse no-auto-semi-insertion-after-if
 222   "if (true) {\n}")
 223
 224 (js2-deftest-parse auto-semi-insertion-after-function
 225   "a = function() {}" :reference "a = function() {};")
 226
 227 (js2-deftest-parse auto-semi-one-variable-per-line
 228   "x\ny" :reference "x;\ny;")
 229
 230 ;;; Labels
 231
 232 (js2-deftest-parse labeled-stmt-node
 233   "foo:\nbar:\nx = y + 1;")
 234
 235 (js2-deftest no-label-node-inside-expr "x = y:"
 236   (let (js2-parse-interruptable-p)
 237     (js2-mode))
 238   (let ((assignment (js2-expr-stmt-node-expr (car (js2-scope-kids js2-mode-ast)))))
 239     (should (js2-name-node-p (js2-assign-node-right assignment)))))
 240
 241 (js2-deftest-parse label-and-loops "for (; ; ) {
 242   loop:
 243   for (; ; ) {
 244     continue loop;
 245   }
 246 }")
 247
 248 ;;; Generators
 249
 250 (js2-deftest-parse legacy-generator "function foo() {\n  yield 1;\n}")
 251
 252 (js2-deftest-parse legacy-generator-cannot-return
 253   "function foo() {\n  yield 1;\n return 2;\n}" :syntax-error "return 2")
 254
 255 (js2-deftest-parse harmony-generator "function* bar() {\n  yield 2;\n  return 3;\n}")
 256
 257 (js2-deftest-parse harmony-generator-yield-star "(function*(a) {  yield* a;\n});")
 258
 259 ;;; Comprehensions
 260
 261 (js2-deftest-parse parse-legacy-array-comp-loop-with-filter
 262   "[a for (a in b) if (a == 2)];")
 263
 264 (js2-deftest-parse parse-array-comp-loop-with-filters
 265   "[for (a in b) if (a == 2) if (b != 10) a];")
 266
 267 (js2-deftest-parse parse-generator-comp-loop-with-filters
 268   "(for (x of y) if (x != 4) x);")
 269
 270 (js2-deftest-parse parse-array-comp-with-yield-is-ok
 271   "(function() {  return [for (x of []) yield x];\n});")
 272
 273 (js2-deftest-parse parse-generator-comp-with-yield-is-not-ok
 274   "(function() {  return (for (x of []) yield x);\n});"
 275   :syntax-error "yield")
 276
 277 (js2-deftest-parse parse-generator-comp-with-yield-inside-function-is-ok
 278   "(for (x of []) function*() {  yield x;\n});")
 279
 280 ;;; Numbers
 281
 282 (js2-deftest-parse decimal-starting-with-zero "081;" :reference "81;")
 283
 284 (js2-deftest-parse huge-hex "0x0123456789abcdefABCDEF;" :reference "-1;")
 285
 286 (js2-deftest-parse octal-without-o "071;" :reference "57;")
 287
 288 (js2-deftest-parse hex-number-okay "0x123;" :reference "291;")
 289
 290 (js2-deftest-parse hex-number-broken "0xz23;"
 291   :syntax-error "0xz" :errors-count 2)
 292
 293 (js2-deftest-parse binary-number-okay "0b101;" :reference "5;")
 294
 295 (js2-deftest-parse binary-number-broken "0b210;"
 296   :syntax-error "0b2" :errors-count 2)
 297
 298 (js2-deftest-parse octal-number-okay "0o765;" :reference "501;")
 299
 300 (js2-deftest-parse octal-number-broken "0o812;"
 301   :syntax-error "0o8" :errors-count 2)
 302
 303 ;;; Scopes
 304
 305 (js2-deftest ast-symbol-table-includes-fn-node "function foo() {}"
 306   (js2-mode)
 307   (let ((entry (js2-scope-get-symbol js2-mode-ast 'foo)))
 308     (should (= (js2-symbol-decl-type entry) js2-FUNCTION))
 309     (should (equal (js2-symbol-name entry) "foo"))
 310     (should (js2-function-node-p (js2-symbol-ast-node entry)))))
 311
 312 (js2-deftest fn-symbol-table-includes-nested-fn "function foo() {
 313   function bar() {}
 314   var x;
 315 }"
 316   (js2-mode)
 317   (let* ((scope (js2-node-at-point (point-min)))
 318          (fn-entry (js2-scope-get-symbol scope 'bar))
 319          (var-entry (js2-scope-get-symbol scope 'x)))
 320     (should (string= (js2-name-node-name (js2-function-node-name scope)) "foo"))
 321     (should (= (js2-symbol-decl-type fn-entry) js2-FUNCTION))
 322     (should (js2-function-node-p (js2-symbol-ast-node fn-entry)))
 323     (should (= (js2-symbol-decl-type var-entry) js2-VAR))
 324     (should (js2-name-node-p (js2-symbol-ast-node var-entry)))))
 325
 326 ;;; Tokenizer
 327
 328 (js2-deftest get-token "(1+1)"
 329   (js2-init-scanner)
 330   (should (eq js2-LP (js2-next-token)))
 331   (should (eq js2-NUMBER (js2-next-token)))
 332   (should (eq js2-ADD (js2-next-token)))
 333   (should (eq js2-NUMBER (js2-next-token)))
 334   (should (eq js2-RP (js2-next-token))))
 335
 336 (js2-deftest unget-token "()"
 337   (js2-init-scanner)
 338   (should (eq js2-LP (js2-next-token)))
 339   (js2-unget-token)
 340   (should (eq js2-LP (js2-next-token)))
 341   (should (eq js2-RP (js2-next-token))))
 342
 343 (js2-deftest get-token-or-eol "x\n++;"
 344   (js2-init-scanner)
 345   (should (eq js2-NAME (js2-next-token)))
 346   (should (eq js2-EOL (js2-peek-token-or-eol)))
 347   (should (eq js2-INC (js2-next-token)))
 348   (should (eq js2-SEMI (js2-peek-token-or-eol))))
 349
 350 (js2-deftest unget-token-over-eol-and-comment "x\n//abc\ny"
 351   (js2-init-scanner)
 352   (should (eq js2-NAME (js2-next-token)))
 353   (should (eq js2-NAME (js2-next-token)))
 354   (should (equal "y" (js2-current-token-string)))
 355   (js2-unget-token)
 356   (should (eq js2-NAME (js2-current-token-type)))
 357   (should (equal "x" (js2-current-token-string))))
 358
 359 (js2-deftest ts-seek "(1+2)"
 360   (js2-init-scanner)
 361   (should (eq js2-LP (js2-next-token)))
 362   (should (eq js2-NUMBER (js2-next-token)))
 363   (js2-unget-token)
 364   (let ((state (make-js2-ts-state)))
 365     (should (eq js2-NUMBER (js2-next-token)))
 366     (should (eq js2-ADD (js2-next-token)))
 367     (js2-ts-seek state)
 368     (should (eq 1 js2-ti-lookahead))
 369     (should (eq js2-NUMBER (js2-next-token)))
 370     (should (eq 1 (js2-token-number
 371                    (js2-current-token))))))
 372
 373 ;;; Error handling
 374
 375 (js2-deftest for-node-with-error-len "for "
 376   (js2-mode)
 377   (let ((node (js2-node-at-point (point-min))))
 378     (should (= (js2-node-len (js2-node-parent node)) 4))))
 379
 380 (js2-deftest function-without-parens-error "function b {}"
 381   ;; Should finish the parse.
 382   (js2-mode))