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 ;;; Callers of `js2-valid-prop-name-token'
 116
 117 (js2-deftest-parse parse-property-access-when-not-keyword
 118   "A.foo = 3;")
 119
 120 (js2-deftest-parse parse-property-access-when-keyword
 121   "A.in = 3;"
 122   :bind ((js2-allow-keywords-as-property-names t)))
 123
 124 (js2-deftest-parse parse-property-access-when-keyword-no-xml
 125   "A.in = 3;"
 126   :bind ((js2-allow-keywords-as-property-names t)
 127          (js2-compiler-xml-available nil)))
 128
 129 (js2-deftest-parse parse-object-literal-when-not-keyword
 130   "a = {b: 1};")
 131
 132 (js2-deftest-parse parse-object-literal-when-keyword
 133   "a = {in: 1};"
 134   :bind ((js2-allow-keywords-as-property-names t)))
 135
 136 ;;; 'of' contextual keyword
 137
 138 (js2-deftest-parse parse-array-comp-loop-with-of
 139   "[a for (a of [])];")
 140
 141 (js2-deftest-parse parse-for-of
 142   "for (var a of []) {\n}")
 143
 144 (js2-deftest-parse of-can-be-var-name
 145   "var of = 3;")
 146
 147 (js2-deftest-parse of-can-be-function-name
 148   "function of() {\n}")
 149
 150 ;;; Destructuring binding
 151
 152 (js2-deftest-parse destruct-in-declaration
 153   "var {a, b} = {a: 1, b: 2};")
 154
 155 (js2-deftest-parse destruct-in-arguments
 156   "function f({a: aa, b: bb}) {\n}")
 157
 158 (js2-deftest-parse destruct-in-array-comp-loop
 159   "[a + b for ([a, b] in [[0, 1], [1, 2]])];")
 160
 161 (js2-deftest-parse destruct-in-catch-clause
 162   "try {\n} catch ({a, b}) {\n  a + b;\n}")
 163
 164 ;;; Function parameters
 165
 166 (js2-deftest-parse function-with-default-parameters
 167   "function foo(a = 1, b = a + 1) {\n}")
 168
 169 (js2-deftest-parse function-with-no-default-after-default
 170   "function foo(a = 1, b) {\n}"
 171   :syntax-error "b")
 172
 173 (js2-deftest-parse function-with-destruct-after-default
 174   "function foo(a = 1, {b, c}) {\n}"
 175   :syntax-error "{")
 176
 177 (js2-deftest-parse function-with-rest-parameter
 178   "function foo(a, b, ...rest) {\n}")
 179
 180 (js2-deftest-parse function-with-param-after-rest-parameter
 181   "function foo(a, ...b, rest) {\n}"
 182   :syntax-error "rest")
 183
 184 (js2-deftest-parse function-with-destruct-after-rest-parameter
 185   "function foo(a, ...b, {}) {\n}"
 186   :syntax-error "{}")
 187
 188 (js2-deftest-parse function-with-rest-after-default-parameter
 189   "function foo(a = 1, ...rest) {\n}")
 190
 191 ;;; Spread operator
 192
 193 (js2-deftest-parse spread-in-array-literal
 194   "[1, ...[2, 3], 4, ...[5, 6]];")
 195
 196 (js2-deftest-parse spread-in-function-call
 197   "f(3, ...[t(2), t(3)], 42, ...[t(4)]);")
 198
 199 ;;; Arrow functions
 200
 201 (js2-deftest-parse arrow-function-with-empty-args-and-no-curlies
 202   "() => false;" :reference "() => {false};")
 203
 204 (js2-deftest-parse arrow-function-with-args-and-curlies
 205   "(a, b = 1, ...c) => {  c;\n};")
 206
 207 (js2-deftest-parse parenless-arrow-function-prohibits-rest
 208   "...b => {b + 1;};" :syntax-error "=>" :errors-count 2)
 209
 210 (js2-deftest-parse parenless-arrow-function-prohibits-destructuring
 211   "[a, b] => {a + b;};" :syntax-error "=>" :errors-count 5)
 212
 213 ;;; Automatic semicolon insertion
 214
 215 (js2-deftest-parse no-auto-semi-insertion-after-if
 216   "if (true) {\n}")
 217
 218 (js2-deftest-parse auto-semi-insertion-after-function
 219   "a = function() {}" :reference "a = function() {};")
 220
 221 (js2-deftest-parse auto-semi-one-variable-per-line
 222   "x\ny" :reference "x;\ny;")
 223
 224 ;;; Labels
 225
 226 (js2-deftest-parse labeled-stmt-node
 227   "foo:\nbar:\nx = y + 1;")
 228
 229 (js2-deftest no-label-node-inside-expr "x = y:"
 230   (let (js2-parse-interruptable-p)
 231     (js2-mode))
 232   (let ((assignment (js2-expr-stmt-node-expr (car (js2-scope-kids js2-mode-ast)))))
 233     (should (js2-name-node-p (js2-assign-node-right assignment)))))
 234
 235 (js2-deftest-parse label-and-loops "for (; ; ) {
 236   loop:
 237   for (; ; ) {
 238     continue loop;
 239   }
 240 }")
 241
 242 ;;; Generators
 243
 244 (js2-deftest-parse legacy-generator "function foo() {\n  yield 1;\n}")
 245
 246 (js2-deftest-parse legacy-generator-cannot-return
 247   "function foo() {\n  yield 1;\n return 2;\n}" :syntax-error "return 2")
 248
 249 (js2-deftest-parse harmony-generator "function* bar() {\n  yield 2;\n  return 3;\n}")
 250
 251 ;;; Scopes
 252
 253 (js2-deftest ast-symbol-table-includes-fn-node "function foo() {}"
 254   (js2-mode)
 255   (let ((entry (js2-scope-get-symbol js2-mode-ast 'foo)))
 256     (should (= (js2-symbol-decl-type entry) js2-FUNCTION))
 257     (should (equal (js2-symbol-name entry) "foo"))
 258     (should (js2-function-node-p (js2-symbol-ast-node entry)))))
 259
 260 (js2-deftest fn-symbol-table-includes-nested-fn "function foo() {
 261   function bar() {}
 262   var x;
 263 }"
 264   (js2-mode)
 265   (let* ((scope (js2-node-at-point (point-min)))
 266          (fn-entry (js2-scope-get-symbol scope 'bar))
 267          (var-entry (js2-scope-get-symbol scope 'x)))
 268     (should (string= (js2-name-node-name (js2-function-node-name scope)) "foo"))
 269     (should (= (js2-symbol-decl-type fn-entry) js2-FUNCTION))
 270     (should (js2-function-node-p (js2-symbol-ast-node fn-entry)))
 271     (should (= (js2-symbol-decl-type var-entry) js2-VAR))
 272     (should (js2-name-node-p (js2-symbol-ast-node var-entry)))))
 273
 274 ;;; Tokenizer
 275
 276 (js2-deftest get-token "(1+1)"
 277   (js2-init-scanner)
 278   (should (eq js2-LP (js2-next-token)))
 279   (should (eq js2-NUMBER (js2-next-token)))
 280   (should (eq js2-ADD (js2-next-token)))
 281   (should (eq js2-NUMBER (js2-next-token)))
 282   (should (eq js2-RP (js2-next-token))))
 283
 284 (js2-deftest unget-token "()"
 285   (js2-init-scanner)
 286   (should (eq js2-LP (js2-next-token)))
 287   (js2-unget-token)
 288   (should (eq js2-LP (js2-next-token)))
 289   (should (eq js2-RP (js2-next-token))))
 290
 291 (js2-deftest get-token-or-eol "x\n++;"
 292   (js2-init-scanner)
 293   (should (eq js2-NAME (js2-next-token)))
 294   (should (eq js2-EOL (js2-peek-token-or-eol)))
 295   (should (eq js2-INC (js2-next-token)))
 296   (should (eq js2-SEMI (js2-peek-token-or-eol))))
 297
 298 (js2-deftest unget-token-over-eol-and-comment "x\n//abc\ny"
 299   (js2-init-scanner)
 300   (should (eq js2-NAME (js2-next-token)))
 301   (should (eq js2-NAME (js2-next-token)))
 302   (should (equal "y" (js2-current-token-string)))
 303   (js2-unget-token)
 304   (should (eq js2-NAME (js2-current-token-type)))
 305   (should (equal "x" (js2-current-token-string))))
 306
 307 (js2-deftest ts-seek "(1+2)"
 308   (js2-init-scanner)
 309   (should (eq js2-LP (js2-next-token)))
 310   (should (eq js2-NUMBER (js2-next-token)))
 311   (js2-unget-token)
 312   (let ((state (make-js2-ts-state)))
 313     (should (eq js2-NUMBER (js2-next-token)))
 314     (should (eq js2-ADD (js2-next-token)))
 315     (js2-ts-seek state)
 316     (should (eq 1 js2-ti-lookahead))
 317     (should (eq js2-NUMBER (js2-next-token)))
 318     (should (eq 1 (js2-token-number
 319                    (js2-current-token))))))
 320
 321 ;;; Error handling
 322
 323 (js2-deftest for-node-with-error-len "for "
 324   (js2-mode)
 325   (let ((node (js2-node-at-point (point-min))))
 326     (should (= (js2-node-len (js2-node-parent node)) 4))))
 327
 328 (js2-deftest function-without-parens-error "function b {}"
 329   ;; Should finish the parse.
 330   (js2-mode))