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   (insert s)
  40   (js2-mode)
  41   (should (null js2-mode-buffer-dirty-p))
  42   js2-mode-ast)
  43
  44 (defun* js2-test-parse-string (code-string &key syntax-error errors-count
  45                                                 reference)
  46   (ert-with-test-buffer (:name 'origin)
  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 (js2-deftest-parse for-with-in-operator-in-parens
 119   "for (var y = (0 in []) in {}) {\n}")
 120
 121 (js2-deftest-parse for-with-in-operator-in-cond
 122   "for (var y = 1 ? 0 in [] : false in {}) {\n}")
 123
 124 (js2-deftest-parse let-expression
 125   "(let (x = 42) x);")
 126
 127 (js2-deftest-parse let-expression-statement
 128   "let (x = 42) x;")
 129
 130 ;;; Callers of `js2-valid-prop-name-token'
 131
 132 (js2-deftest-parse parse-property-access-when-not-keyword
 133   "A.foo = 3;")
 134
 135 (js2-deftest-parse parse-property-access-when-keyword
 136   "A.in = 3;"
 137   :bind ((js2-allow-keywords-as-property-names t)))
 138
 139 (js2-deftest-parse parse-property-access-when-keyword-no-xml
 140   "A.in = 3;"
 141   :bind ((js2-allow-keywords-as-property-names t)
 142          (js2-compiler-xml-available nil)))
 143
 144 (js2-deftest-parse parse-object-literal-when-not-keyword
 145   "a = {b: 1};")
 146
 147 (js2-deftest-parse parse-object-literal-when-keyword
 148   "a = {in: 1};"
 149   :bind ((js2-allow-keywords-as-property-names t)))
 150
 151 ;;; 'of' contextual keyword
 152
 153 (js2-deftest-parse parse-legacy-array-comp-loop-with-of
 154   "[a for (a of [])];")
 155
 156 (js2-deftest-parse parse-array-comp-loop
 157   "[for (a of []) a];")
 158
 159 (js2-deftest-parse parse-for-of
 160   "for (var a of []) {\n}")
 161
 162 (js2-deftest-parse of-can-be-var-name
 163   "var of = 3;")
 164
 165 (js2-deftest-parse of-can-be-function-name
 166   "function of() {\n}")
 167
 168 ;;; Destructuring binding
 169
 170 (js2-deftest-parse destruct-in-declaration
 171   "var {a, b} = {a: 1, b: 2};")
 172
 173 (js2-deftest-parse destruct-in-arguments
 174   "function f({a: aa, b: bb}) {\n}")
 175
 176 (js2-deftest-parse destruct-in-array-comp-loop
 177   "[a + b for ([a, b] in [[0, 1], [1, 2]])];")
 178
 179 (js2-deftest-parse destruct-in-catch-clause
 180   "try {\n} catch ({a, b}) {\n  a + b;\n}")
 181
 182 ;;; Object literals
 183
 184 (js2-deftest-parse object-literal-shorthand
 185   "var x = {a: 1, b, c: 1, d};")
 186
 187 (js2-deftest-parse object-literal-shorthard-with-number
 188   "var a = {1};" :syntax-error ";" :errors-count 2)
 189
 190 (js2-deftest-parse object-literal-method
 191   "var x = {f(y) {  return y;\n}};")
 192
 193 (js2-deftest-parse object-literal-getter-method
 194   "var x = {get f() {  return 42;\n}};")
 195
 196 (js2-deftest-parse object-literal-setter-method
 197   "var x = {set f(y) {  x = y;\n}};")
 198
 199 (js2-deftest-parse object-literal-computed-keys
 200   "var x = {[Symbol.iterator]: function() {}};")
 201
 202 ;;; Function parameters
 203
 204 (js2-deftest-parse function-with-default-parameters
 205   "function foo(a = 1, b = a + 1) {\n}")
 206
 207 (js2-deftest-parse function-with-no-default-after-default
 208   "function foo(a = 1, b) {\n}"
 209   :syntax-error "b")
 210
 211 (js2-deftest-parse function-with-destruct-after-default
 212   "function foo(a = 1, {b, c}) {\n}"
 213   :syntax-error "{")
 214
 215 (js2-deftest-parse function-with-rest-parameter
 216   "function foo(a, b, ...rest) {\n}")
 217
 218 (js2-deftest-parse function-with-param-after-rest-parameter
 219   "function foo(a, ...b, rest) {\n}"
 220   :syntax-error "rest")
 221
 222 (js2-deftest-parse function-with-destruct-after-rest-parameter
 223   "function foo(a, ...b, {}) {\n}"
 224   :syntax-error "{}")
 225
 226 (js2-deftest-parse function-with-rest-after-default-parameter
 227   "function foo(a = 1, ...rest) {\n}")
 228
 229 ;;; Spread operator
 230
 231 (js2-deftest-parse spread-in-array-literal
 232   "[1, ...[2, 3], 4, ...[5, 6]];")
 233
 234 (js2-deftest-parse spread-in-function-call
 235   "f(3, ...[t(2), t(3)], 42, ...[t(4)]);")
 236
 237 ;;; Arrow functions
 238
 239 (js2-deftest-parse arrow-function-with-empty-args-and-no-curlies
 240   "() => false;" :reference "() => {false};")
 241
 242 (js2-deftest-parse arrow-function-with-args-and-curlies
 243   "(a, b = 1, ...c) => {  c;\n};")
 244
 245 (js2-deftest-parse arrow-function-with-destructuring
 246   "([{a}, b]) => {  a + b;\n};")
 247
 248 (js2-deftest-parse parenless-arrow-function-prohibits-rest
 249   "...b => {b + 1;};" :syntax-error "=>" :errors-count 1)
 250
 251 (js2-deftest-parse parenless-arrow-function-prohibits-destructuring
 252   "[a, b] => {a + b;};" :syntax-error "=>" :errors-count 4)
 253
 254 ;;; Automatic semicolon insertion
 255
 256 (js2-deftest-parse no-auto-semi-insertion-after-if
 257   "if (true) {\n}")
 258
 259 (js2-deftest-parse auto-semi-insertion-after-function
 260   "a = function() {}" :reference "a = function() {};")
 261
 262 (js2-deftest-parse auto-semi-one-variable-per-line
 263   "x\ny" :reference "x;\ny;")
 264
 265 ;;; Labels
 266
 267 (js2-deftest-parse labeled-stmt-node
 268   "foo:\nbar:\nx = y + 1;")
 269
 270 (js2-deftest no-label-node-inside-expr "x = y:"
 271   (let (js2-parse-interruptable-p)
 272     (js2-mode))
 273   (let ((assignment (js2-expr-stmt-node-expr (car (js2-scope-kids js2-mode-ast)))))
 274     (should (js2-name-node-p (js2-assign-node-right assignment)))))
 275
 276 (js2-deftest-parse label-and-loops "for (; ; ) {
 277   loop:
 278   for (; ; ) {
 279     continue loop;
 280   }
 281 }")
 282
 283 ;;; Generators
 284
 285 (js2-deftest-parse legacy-generator "function foo() {\n  yield 1;\n}")
 286
 287 (js2-deftest-parse legacy-generator-cannot-return
 288   "function foo() {\n  yield 1;\n return 2;\n}" :syntax-error "return 2")
 289
 290 (js2-deftest-parse harmony-generator "function* bar() {\n  yield 2;\n  return 3;\n}")
 291
 292 (js2-deftest-parse harmony-generator-yield-star "(function*(a) {  yield* a;\n});")
 293
 294 ;;; Comprehensions
 295
 296 (js2-deftest-parse parse-legacy-array-comp-loop-with-filter
 297   "[a for (a in b) if (a == 2)];")
 298
 299 (js2-deftest-parse parse-array-comp-loop-with-filters
 300   "[for (a in b) if (a == 2) if (b != 10) a];")
 301
 302 (js2-deftest-parse parse-generator-comp-loop-with-filters
 303   "(for (x of y) if (x != 4) x);")
 304
 305 (js2-deftest-parse parse-array-comp-with-yield-is-ok
 306   "(function() {  return [for (x of []) yield x];\n});")
 307
 308 (js2-deftest-parse parse-generator-comp-with-yield-is-not-ok
 309   "(function() {  return (for (x of []) yield x);\n});"
 310   :syntax-error "yield")
 311
 312 (js2-deftest-parse parse-generator-comp-with-yield-inside-function-is-ok
 313   "(for (x of []) function*() {  yield x;\n});")
 314
 315 ;;; Numbers
 316
 317 (js2-deftest-parse decimal-starting-with-zero "081;" :reference "81;")
 318
 319 (js2-deftest-parse huge-hex "0x0123456789abcdefABCDEF;" :reference "-1;")
 320
 321 (js2-deftest-parse octal-without-o "071;" :reference "57;")
 322
 323 (js2-deftest-parse hex-number-okay "0x123;" :reference "291;")
 324
 325 (js2-deftest-parse hex-number-broken "0xz23;"
 326   :syntax-error "0xz" :errors-count 2)
 327
 328 (js2-deftest-parse binary-number-okay "0b101;" :reference "5;")
 329
 330 (js2-deftest-parse binary-number-broken "0b210;"
 331   :syntax-error "0b2" :errors-count 2)
 332
 333 (js2-deftest-parse octal-number-okay "0o765;" :reference "501;")
 334
 335 (js2-deftest-parse octal-number-broken "0o812;"
 336   :syntax-error "0o8" :errors-count 2)
 337
 338 ;;; Strings
 339
 340 (js2-deftest-parse string-literal
 341   "var x = 'y';")
 342
 343 (js2-deftest-parse object-get-string-literal
 344   "var x = {y: 5};\nvar z = x[\"y\"];")
 345
 346 (js2-deftest-parse template-no-substritutions
 347   "var x = `abc
 348             def`, y = `\\u0000`;")
 349
 350 (js2-deftest-parse template-with-substitutions
 351   "var y = `${a + b} ${d + e + f}`;")
 352
 353 ;;; Classes
 354
 355 (js2-deftest-parse parse-harmony-class-statement
 356   "class Foo {\n  get bar() {  return 42;\n}\n  set bar(x) {  y = x;\n}\n}")
 357
 358 (js2-deftest-parse parse-harmony-class-statement-without-name-is-not-ok
 359   "class {\n  get bar() {  return 42;\n}\n}"
 360   :syntax-error "{")
 361
 362 (js2-deftest-parse parse-harmony-class-expression
 363   "var Foo1 = class Foo {\n  bar() {  return 42;\n}\n};")
 364
 365 (js2-deftest-parse parse-harmony-anonymous-class-expression
 366   "var Foo = class {\n  set bar(x) {  bar = x;\n}\n};")
 367
 368 (js2-deftest-parse parse-harmony-class-with-extends
 369   "class Foo extends Bar {\n}")
 370
 371 (js2-deftest-parse parse-harmony-anonymous-class-with-extends
 372   "foo.Foo = class extends Bar {\n  set bar(x) {  bar = x;\n}\n};")
 373
 374 (js2-deftest-parse parse-harmony-class-with-complex-extends
 375   "class Foo extends foo[BAR][2].Baz {\n}")
 376
 377 (js2-deftest-parse parse-harmony-class-missing-extended-class-is-not-ok
 378   "class Foo extends {\n}"
 379   :syntax-error "extends")
 380
 381 (js2-deftest-parse parse-harmony-class-static-method
 382   "class Foo extends Bar {\n  static bar() {  return 42;\n}\n}")
 383
 384 (js2-deftest-parse parse-unterminated-class-is-not-okay
 385   "class Foo {\n  get bar() {  return 42;\n}"
 386   :syntax-error "}")
 387
 388 (js2-deftest-parse parse-super-keyword
 389   "class Foo {\n  constructor() {  super(42);\n}\n  foo() {  super.foo();\n}\n}")
 390
 391 ;;; Scopes
 392
 393 (js2-deftest ast-symbol-table-includes-fn-node "function foo() {}"
 394   (js2-mode)
 395   (let ((entry (js2-scope-get-symbol js2-mode-ast 'foo)))
 396     (should (= (js2-symbol-decl-type entry) js2-FUNCTION))
 397     (should (equal (js2-symbol-name entry) "foo"))
 398     (should (js2-function-node-p (js2-symbol-ast-node entry)))))
 399
 400 (js2-deftest fn-symbol-table-includes-nested-fn "function foo() {
 401   function bar() {}
 402   var x;
 403 }"
 404   (js2-mode)
 405   (let* ((scope (js2-node-at-point (point-min)))
 406          (fn-entry (js2-scope-get-symbol scope 'bar))
 407          (var-entry (js2-scope-get-symbol scope 'x)))
 408     (should (string= (js2-name-node-name (js2-function-node-name scope)) "foo"))
 409     (should (= (js2-symbol-decl-type fn-entry) js2-FUNCTION))
 410     (should (js2-function-node-p (js2-symbol-ast-node fn-entry)))
 411     (should (= (js2-symbol-decl-type var-entry) js2-VAR))
 412     (should (js2-name-node-p (js2-symbol-ast-node var-entry)))))
 413
 414 ;;; Tokenizer
 415
 416 (js2-deftest get-token "(1+1)"
 417   (js2-init-scanner)
 418   (should (eq js2-LP (js2-next-token)))
 419   (should (eq js2-NUMBER (js2-next-token)))
 420   (should (eq js2-ADD (js2-next-token)))
 421   (should (eq js2-NUMBER (js2-next-token)))
 422   (should (eq js2-RP (js2-next-token))))
 423
 424 (js2-deftest unget-token "()"
 425   (js2-init-scanner)
 426   (should (eq js2-LP (js2-next-token)))
 427   (js2-unget-token)
 428   (should (eq js2-LP (js2-next-token)))
 429   (should (eq js2-RP (js2-next-token))))
 430
 431 (js2-deftest get-token-or-eol "x\n++;"
 432   (js2-init-scanner)
 433   (should (eq js2-NAME (js2-next-token)))
 434   (should (eq js2-EOL (js2-peek-token-or-eol)))
 435   (should (eq js2-INC (js2-next-token)))
 436   (should (eq js2-SEMI (js2-peek-token-or-eol))))
 437
 438 (js2-deftest unget-token-over-eol-and-comment "x\n//abc\ny"
 439   (js2-init-scanner)
 440   (should (eq js2-NAME (js2-next-token)))
 441   (should (eq js2-NAME (js2-next-token)))
 442   (should (equal "y" (js2-current-token-string)))
 443   (js2-unget-token)
 444   (should (eq js2-NAME (js2-current-token-type)))
 445   (should (equal "x" (js2-current-token-string))))
 446
 447 (js2-deftest ts-seek "(1+2)"
 448   (js2-init-scanner)
 449   (should (eq js2-LP (js2-next-token)))
 450   (should (eq js2-NUMBER (js2-next-token)))
 451   (js2-unget-token)
 452   (let ((state (make-js2-ts-state)))
 453     (should (eq js2-NUMBER (js2-next-token)))
 454     (should (eq js2-ADD (js2-next-token)))
 455     (js2-ts-seek state)
 456     (should (eq 1 js2-ti-lookahead))
 457     (should (eq js2-NUMBER (js2-next-token)))
 458     (should (eq 1 (js2-token-number
 459                    (js2-current-token))))))
 460
 461 (js2-deftest get-token-template-literal "`abc ${i} z ${j} def`"
 462   (js2-init-scanner)
 463   (should (eq js2-TEMPLATE_HEAD (js2-next-token)))
 464   (should (equal "abc " (js2-current-token-string)))
 465   (should (eq js2-NAME (js2-next-token)))
 466   (should (eq js2-RC (js2-next-token)))
 467   (should (eq js2-TEMPLATE_HEAD (js2-next-token 'TEMPLATE_TAIL)))
 468   (should (equal " z " (js2-current-token-string)))
 469   (should (eq js2-NAME (js2-next-token)))
 470   (should (eq js2-RC (js2-next-token)))
 471   (should (eq js2-NO_SUBS_TEMPLATE (js2-next-token 'TEMPLATE_TAIL)))
 472   (should (equal " def" (js2-current-token-string))))
 473
 474 ;;; Error handling
 475
 476 (js2-deftest for-node-with-error-len "for "
 477   (js2-mode)
 478   (let ((node (js2-node-at-point (point-min))))
 479     (should (= (js2-node-len (js2-node-parent node)) 4))))
 480
 481 (js2-deftest function-without-parens-error "function b {}"
 482   ;; Should finish the parse.
 483   (js2-mode))