1 ;;; js2-mode.el --- Improved JavaScript editing mode
3 ;; Copyright (C) 2009, 2011-2015 Free Software Foundation, Inc.
5 ;; Author: Steve Yegge <steve.yegge@gmail.com>
6 ;; mooz <stillpedant@gmail.com>
7 ;; Dmitry Gutov <dgutov@yandex.ru>
8 ;; URL: https://github.com/mooz/js2-mode/
9 ;; http://code.google.com/p/js2-mode/
11 ;; Keywords: languages, javascript
12 ;; Package-Requires: ((emacs "24.1") (cl-lib "0.5"))
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software: you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation, either version 3 of the License, or
19 ;; (at your option) any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;; This JavaScript editing mode supports:
33 ;; - strict recognition of the Ecma-262 language standard
34 ;; - support for most Rhino and SpiderMonkey extensions from 1.5 and up
35 ;; - parsing support for ECMAScript for XML (E4X, ECMA-357)
36 ;; - accurate syntax highlighting using a recursive-descent parser
37 ;; - on-the-fly reporting of syntax errors and strict-mode warnings
38 ;; - undeclared-variable warnings using a configurable externs framework
39 ;; - "bouncing" line indentation to choose among alternate indentation points
40 ;; - smart line-wrapping within comments and strings
42 ;; - show some or all function bodies as {...}
43 ;; - show some or all block comments as /*...*/
44 ;; - context-sensitive menu bar and popup menus
45 ;; - code browsing using the `imenu' package
46 ;; - many customization options
50 ;; To install it as your major mode for JavaScript editing:
52 ;; (add-to-list 'auto-mode-alist '("\\.js\\'" . js2-mode))
54 ;; Alternatively, to install it as a minor mode just for JavaScript linting,
55 ;; you must add it to the appropriate major-mode hook. Normally this would be:
57 ;; (add-hook 'js-mode-hook 'js2-minor-mode)
59 ;; You may also want to hook it in for shell scripts running via node.js:
61 ;; (add-to-list 'interpreter-mode-alist '("node" . js2-mode))
63 ;; To customize how it works:
64 ;; M-x customize-group RET js2-mode RET
68 ;; This mode includes a port of Mozilla Rhino's scanner, parser and
69 ;; symbol table. Ideally it should stay in sync with Rhino, keeping
70 ;; `js2-mode' current as the EcmaScript language standard evolves.
72 ;; Unlike cc-engine based language modes, js2-mode's line-indentation is not
73 ;; customizable. It is a surprising amount of work to support customizable
74 ;; indentation. The current compromise is that the tab key lets you cycle among
75 ;; various likely indentation points, similar to the behavior of python-mode.
77 ;; This mode does not yet work with "multi-mode" modes such as `mmm-mode'
78 ;; and `mumamo', although it could be made to do so with some effort.
79 ;; This means that `js2-mode' is currently only useful for editing JavaScript
80 ;; files, and not for editing JavaScript within <script> tags or templates.
82 ;; The project page on GitHub is used for development and issue tracking.
83 ;; The original homepage at Google Code has outdated information and is mostly
94 (if (version< emacs-version "25.0")
95 (require 'js2-old-indent)
96 (defvaralias 'js2-basic-offset 'js-indent-level nil)
97 (defalias 'js2-proper-indentation 'js--proper-indentation)
98 (defalias 'js2-indent-line 'js-indent-line)
99 (defalias 'js2-re-search-forward 'js--re-search-forward)))
101 ;;; Externs (variables presumed to be defined by the host system)
103 (defvar js2-ecma-262-externs
105 '(Array Boolean Date Error EvalError Function Infinity JSON
106 Math NaN Number Object RangeError ReferenceError RegExp
107 String SyntaxError TypeError URIError
108 decodeURI decodeURIComponent encodeURI
109 encodeURIComponent escape eval isFinite isNaN
110 parseFloat parseInt undefined unescape))
111 "Ecma-262 externs. Included in `js2-externs' by default.")
113 (defvar js2-browser-externs
116 Attr CDATASection CharacterData Comment DOMException
117 DOMImplementation Document DocumentFragment
118 DocumentType Element Entity EntityReference
119 ExceptionCode NamedNodeMap Node NodeList Notation
120 ProcessingInstruction Text
123 HTMLAnchorElement HTMLAppletElement HTMLAreaElement
124 HTMLBRElement HTMLBaseElement HTMLBaseFontElement
125 HTMLBodyElement HTMLButtonElement HTMLCollection
126 HTMLDListElement HTMLDirectoryElement HTMLDivElement
127 HTMLDocument HTMLElement HTMLFieldSetElement
128 HTMLFontElement HTMLFormElement HTMLFrameElement
129 HTMLFrameSetElement HTMLHRElement HTMLHeadElement
130 HTMLHeadingElement HTMLHtmlElement HTMLIFrameElement
131 HTMLImageElement HTMLInputElement HTMLIsIndexElement
132 HTMLLIElement HTMLLabelElement HTMLLegendElement
133 HTMLLinkElement HTMLMapElement HTMLMenuElement
134 HTMLMetaElement HTMLModElement HTMLOListElement
135 HTMLObjectElement HTMLOptGroupElement
136 HTMLOptionElement HTMLOptionsCollection
137 HTMLParagraphElement HTMLParamElement HTMLPreElement
138 HTMLQuoteElement HTMLScriptElement HTMLSelectElement
139 HTMLStyleElement HTMLTableCaptionElement
140 HTMLTableCellElement HTMLTableColElement
141 HTMLTableElement HTMLTableRowElement
142 HTMLTableSectionElement HTMLTextAreaElement
143 HTMLTitleElement HTMLUListElement
146 DOMConfiguration DOMError DOMException
147 DOMImplementationList DOMImplementationSource
148 DOMLocator DOMStringList NameList TypeInfo
152 window alert confirm document java navigator prompt screen
153 self top requestAnimationFrame cancelAnimationFrame
156 CSSCharsetRule CSSFontFace CSSFontFaceRule
157 CSSImportRule CSSMediaRule CSSPageRule
158 CSSPrimitiveValue CSSProperties CSSRule CSSRuleList
159 CSSStyleDeclaration CSSStyleRule CSSStyleSheet
160 CSSValue CSSValueList Counter DOMImplementationCSS
161 DocumentCSS DocumentStyle ElementCSSInlineStyle
162 LinkStyle MediaList RGBColor Rect StyleSheet
163 StyleSheetList ViewCSS
166 EventListener EventTarget Event DocumentEvent UIEvent
167 MouseEvent MutationEvent KeyboardEvent
170 DocumentRange Range RangeException
173 XPathResult XMLHttpRequest
175 ;; console object. Provided by at least Chrome and Firefox.
178 You can cause these to be included or excluded with the custom
179 variable `js2-include-browser-externs'.")
181 (defvar js2-rhino-externs
183 '(Packages importClass importPackage com org java
184 ;; Global object (shell) externs.
185 defineClass deserialize doctest gc help load
186 loadClass print quit readFile readUrl runCommand seal
187 serialize spawn sync toint32 version))
188 "Mozilla Rhino externs.
189 Set `js2-include-rhino-externs' to t to include them.")
191 (defvar js2-node-externs
193 '(__dirname __filename Buffer clearInterval clearTimeout require
194 console exports global module process setInterval setTimeout
197 Set `js2-include-node-externs' to t to include them.")
199 (defvar js2-typed-array-externs
201 '(ArrayBuffer Uint8ClampedArray DataView
202 Int8Array Uint8Array Int16Array Uint16Array Int32Array Uint32Array
203 Float32Array Float64Array))
204 "Khronos typed array externs. Available in most modern browsers and
205 in node.js >= 0.6. If `js2-include-node-externs' or `js2-include-browser-externs'
206 are enabled, these will also be included.")
208 (defvar js2-harmony-externs
210 '(Map Promise Proxy Reflect Set Symbol WeakMap WeakSet))
211 "ES6 externs. If `js2-include-browser-externs' is enabled and
212 `js2-language-version' is sufficiently high, these will be included.")
216 (defun js2-mark-safe-local (name pred)
217 "Make the variable NAME buffer-local and mark it as safe file-local
218 variable with predicate PRED."
219 (make-variable-buffer-local name)
220 (put name 'safe-local-variable pred))
222 (defcustom js2-highlight-level 2
223 "Amount of syntax highlighting to perform.
224 0 or a negative value means none.
225 1 adds basic syntax highlighting.
226 2 adds highlighting of some Ecma built-in properties.
227 3 adds highlighting of many Ecma built-in functions."
229 :type '(choice (const :tag "None" 0)
230 (const :tag "Basic" 1)
231 (const :tag "Include Properties" 2)
232 (const :tag "Include Functions" 3)))
234 (defvar js2-mode-dev-mode-p nil
235 "Non-nil if running in development mode. Normally nil.")
237 (defgroup js2-mode nil
238 "An improved JavaScript mode."
241 (defcustom js2-idle-timer-delay 0.2
242 "Delay in secs before re-parsing after user makes changes.
243 Multiplied by `js2-dynamic-idle-timer-adjust', which see."
246 (make-variable-buffer-local 'js2-idle-timer-delay)
248 (defcustom js2-dynamic-idle-timer-adjust 0
249 "Positive to adjust `js2-idle-timer-delay' based on file size.
250 The idea is that for short files, parsing is faster so we can be
251 more responsive to user edits without interfering with editing.
252 The buffer length in characters (typically bytes) is divided by
253 this value and used to multiply `js2-idle-timer-delay' for the
254 buffer. For example, a 21k file and 10k adjust yields 21k/10k
255 == 2, so js2-idle-timer-delay is multiplied by 2.
256 If `js2-dynamic-idle-timer-adjust' is 0 or negative,
257 `js2-idle-timer-delay' is not dependent on the file size."
261 (defcustom js2-concat-multiline-strings t
262 "When non-nil, `js2-line-break' in mid-string will make it a
263 string concatenation. When `eol', the '+' will be inserted at the
264 end of the line, otherwise, at the beginning of the next line."
265 :type '(choice (const t) (const eol) (const nil))
268 (defcustom js2-mode-show-parse-errors t
269 "True to highlight parse errors."
273 (defcustom js2-mode-show-strict-warnings t
274 "Non-nil to emit Ecma strict-mode warnings.
275 Some of the warnings can be individually disabled by other flags,
276 even if this flag is non-nil."
280 (defcustom js2-strict-trailing-comma-warning t
281 "Non-nil to warn about trailing commas in array literals.
282 Ecma-262-5.1 allows them, but older versions of IE raise an error."
286 (defcustom js2-strict-missing-semi-warning t
287 "Non-nil to warn about semicolon auto-insertion after statement.
288 Technically this is legal per Ecma-262, but some style guides disallow
293 (defcustom js2-missing-semi-one-line-override nil
294 "Non-nil to permit missing semicolons in one-line functions.
295 In one-liner functions such as `function identity(x) {return x}'
296 people often omit the semicolon for a cleaner look. If you are
297 such a person, you can suppress the missing-semicolon warning
298 by setting this variable to t."
302 (defcustom js2-strict-inconsistent-return-warning t
303 "Non-nil to warn about mixing returns with value-returns.
304 It's perfectly legal to have a `return' and a `return foo' in the
305 same function, but it's often an indicator of a bug, and it also
306 interferes with type inference (in systems that support it.)"
310 (defcustom js2-strict-cond-assign-warning t
311 "Non-nil to warn about expressions like if (a = b).
312 This often should have been '==' instead of '='. If the warning
313 is enabled, you can suppress it on a per-expression basis by
314 parenthesizing the expression, e.g. if ((a = b)) ..."
318 (defcustom js2-strict-var-redeclaration-warning t
319 "Non-nil to warn about redeclaring variables in a script or function."
323 (defcustom js2-strict-var-hides-function-arg-warning t
324 "Non-nil to warn about a var decl hiding a function argument."
328 (defcustom js2-skip-preprocessor-directives nil
329 "Non-nil to treat lines beginning with # as comments.
330 Useful for viewing Mozilla JavaScript source code."
334 (defcustom js2-language-version 200
335 "Configures what JavaScript language version to recognize.
336 Currently versions 150, 160, 170, 180 and 200 are supported,
337 corresponding to JavaScript 1.5, 1.6, 1.7, 1.8 and 2.0 (Harmony),
338 respectively. In a nutshell, 1.6 adds E4X support, 1.7 adds let,
339 yield, and Array comprehensions, and 1.8 adds function closures."
343 (defcustom js2-instanceof-has-side-effects nil
344 "If non-nil, treats the instanceof operator as having side effects.
345 This is useful for xulrunner apps."
349 (defcustom js2-move-point-on-right-click t
350 "Non-nil to move insertion point when you right-click.
351 This makes right-click context menu behavior a bit more intuitive,
352 since menu operations generally apply to the point. The exception
353 is if there is a region selection, in which case the point does -not-
354 move, so cut/copy/paste can work properly.
356 Note that IntelliJ moves the point, and Eclipse leaves it alone,
357 so this behavior is customizable."
361 (defcustom js2-allow-rhino-new-expr-initializer t
362 "Non-nil to support a Rhino's experimental syntactic construct.
364 Rhino supports the ability to follow a `new' expression with an object
365 literal, which is used to set additional properties on the new object
366 after calling its constructor. Syntax:
368 new <expr> [ ( arglist ) ] [initializer]
370 Hence, this expression:
372 new Object {a: 1, b: 2}
374 results in an Object with properties a=1 and b=2. This syntax is
375 apparently not configurable in Rhino - it's currently always enabled,
376 as of Rhino version 1.7R2."
380 (defcustom js2-allow-member-expr-as-function-name nil
381 "Non-nil to support experimental Rhino syntax for function names.
383 Rhino supports an experimental syntax configured via the Rhino Context
384 setting `allowMemberExprAsFunctionName'. The experimental syntax is:
386 function <member-expr> ( [ arg-list ] ) { <body> }
388 Where member-expr is a non-parenthesized 'member expression', which
389 is anything at the grammar level of a new-expression or lower, meaning
390 any expression that does not involve infix or unary operators.
392 When <member-expr> is not a simple identifier, then it is syntactic
393 sugar for assigning the anonymous function to the <member-expr>. Hence,
396 function a.b().c[2] (x, y) { ... }
400 a.b().c[2] = function(x, y) {...}
402 which doesn't seem particularly useful, but Rhino permits it."
408 (defmacro js2-deflocal (name value &optional comment)
409 "Define a buffer-local variable NAME with VALUE and COMMENT."
410 (declare (debug defvar) (doc-string 3))
412 (defvar ,name ,value ,comment)
413 (make-variable-buffer-local ',name)))
415 (defvar js2-EOF_CHAR -1
416 "Represents end of stream. Distinct from js2-EOF token type.")
418 ;; I originally used symbols to represent tokens, but Rhino uses
419 ;; ints and then sets various flag bits in them, so ints it is.
420 ;; The upshot is that we need a `js2-' prefix in front of each name.
421 (defvar js2-ERROR -1)
424 (defvar js2-ENTERWITH 2) ; begin interpreter bytecodes
425 (defvar js2-LEAVEWITH 3)
426 (defvar js2-RETURN 4)
430 (defvar js2-SETNAME 8)
432 (defvar js2-BITXOR 10)
433 (defvar js2-BITAND 11)
443 (defvar js2-ADD 21) ; infix plus
444 (defvar js2-SUB 22) ; infix minus
449 (defvar js2-BITNOT 27)
450 (defvar js2-POS 28) ; unary plus
451 (defvar js2-NEG 29) ; unary minus
453 (defvar js2-DELPROP 31)
454 (defvar js2-TYPEOF 32)
455 (defvar js2-GETPROP 33)
456 (defvar js2-GETPROPNOWARN 34)
457 (defvar js2-SETPROP 35)
458 (defvar js2-GETELEM 36)
459 (defvar js2-SETELEM 37)
461 (defvar js2-NAME 39) ; an identifier
462 (defvar js2-NUMBER 40)
463 (defvar js2-STRING 41)
466 (defvar js2-FALSE 44)
468 (defvar js2-SHEQ 46) ; shallow equality (===)
469 (defvar js2-SHNE 47) ; shallow inequality (!==)
470 (defvar js2-REGEXP 48)
471 (defvar js2-BINDNAME 49)
472 (defvar js2-THROW 50)
473 (defvar js2-RETHROW 51) ; rethrow caught exception: catch (e if ) uses it
475 (defvar js2-INSTANCEOF 53)
476 (defvar js2-LOCAL_LOAD 54)
477 (defvar js2-GETVAR 55)
478 (defvar js2-SETVAR 56)
479 (defvar js2-CATCH_SCOPE 57)
480 (defvar js2-ENUM_INIT_KEYS 58) ; FIXME: what are these?
481 (defvar js2-ENUM_INIT_VALUES 59)
482 (defvar js2-ENUM_INIT_ARRAY 60)
483 (defvar js2-ENUM_NEXT 61)
484 (defvar js2-ENUM_ID 62)
485 (defvar js2-THISFN 63)
486 (defvar js2-RETURN_RESULT 64) ; to return previously stored return result
487 (defvar js2-ARRAYLIT 65) ; array literal
488 (defvar js2-OBJECTLIT 66) ; object literal
489 (defvar js2-GET_REF 67) ; *reference
490 (defvar js2-SET_REF 68) ; *reference = something
491 (defvar js2-DEL_REF 69) ; delete reference
492 (defvar js2-REF_CALL 70) ; f(args) = something or f(args)++
493 (defvar js2-REF_SPECIAL 71) ; reference for special properties like __proto
494 (defvar js2-YIELD 72) ; JS 1.7 yield pseudo keyword
497 (defvar js2-DEFAULTNAMESPACE 73)
498 (defvar js2-ESCXMLATTR 74)
499 (defvar js2-ESCXMLTEXT 75)
500 (defvar js2-REF_MEMBER 76) ; Reference for x.@y, x..y etc.
501 (defvar js2-REF_NS_MEMBER 77) ; Reference for x.ns::y, x..ns::y etc.
502 (defvar js2-REF_NAME 78) ; Reference for @y, @[y] etc.
503 (defvar js2-REF_NS_NAME 79) ; Reference for ns::y, @ns::y@[y] etc.
505 (defvar js2-first-bytecode js2-ENTERWITH)
506 (defvar js2-last-bytecode js2-REF_NS_NAME)
509 (defvar js2-SEMI 81) ; semicolon
510 (defvar js2-LB 82) ; left and right brackets
512 (defvar js2-LC 84) ; left and right curly-braces
514 (defvar js2-LP 86) ; left and right parens
516 (defvar js2-COMMA 88) ; comma operator
518 (defvar js2-ASSIGN 89) ; simple assignment (=)
519 (defvar js2-ASSIGN_BITOR 90) ; |=
520 (defvar js2-ASSIGN_BITXOR 91) ; ^=
521 (defvar js2-ASSIGN_BITAND 92) ; &=
522 (defvar js2-ASSIGN_LSH 93) ; <<=
523 (defvar js2-ASSIGN_RSH 94) ; >>=
524 (defvar js2-ASSIGN_URSH 95) ; >>>=
525 (defvar js2-ASSIGN_ADD 96) ; +=
526 (defvar js2-ASSIGN_SUB 97) ; -=
527 (defvar js2-ASSIGN_MUL 98) ; *=
528 (defvar js2-ASSIGN_DIV 99) ; /=
529 (defvar js2-ASSIGN_MOD 100) ; %=
531 (defvar js2-first-assign js2-ASSIGN)
532 (defvar js2-last-assign js2-ASSIGN_MOD)
534 (defvar js2-HOOK 101) ; conditional (?:)
535 (defvar js2-COLON 102)
536 (defvar js2-OR 103) ; logical or (||)
537 (defvar js2-AND 104) ; logical and (&&)
538 (defvar js2-INC 105) ; increment/decrement (++ --)
540 (defvar js2-DOT 107) ; member operator (.)
541 (defvar js2-FUNCTION 108) ; function keyword
542 (defvar js2-EXPORT 109) ; export keyword
543 (defvar js2-IMPORT 110) ; import keyword
544 (defvar js2-IF 111) ; if keyword
545 (defvar js2-ELSE 112) ; else keyword
546 (defvar js2-SWITCH 113) ; switch keyword
547 (defvar js2-CASE 114) ; case keyword
548 (defvar js2-DEFAULT 115) ; default keyword
549 (defvar js2-WHILE 116) ; while keyword
550 (defvar js2-DO 117) ; do keyword
551 (defvar js2-FOR 118) ; for keyword
552 (defvar js2-BREAK 119) ; break keyword
553 (defvar js2-CONTINUE 120) ; continue keyword
554 (defvar js2-VAR 121) ; var keyword
555 (defvar js2-WITH 122) ; with keyword
556 (defvar js2-CATCH 123) ; catch keyword
557 (defvar js2-FINALLY 124) ; finally keyword
558 (defvar js2-VOID 125) ; void keyword
559 (defvar js2-RESERVED 126) ; reserved keywords
561 (defvar js2-EMPTY 127)
563 ;; Types used for the parse tree - never returned by scanner.
565 (defvar js2-BLOCK 128) ; statement block
566 (defvar js2-LABEL 129) ; label
567 (defvar js2-TARGET 130)
568 (defvar js2-LOOP 131)
569 (defvar js2-EXPR_VOID 132) ; expression statement in functions
570 (defvar js2-EXPR_RESULT 133) ; expression statement in scripts
572 (defvar js2-SCRIPT 135) ; top-level node for entire script
573 (defvar js2-TYPEOFNAME 136) ; for typeof(simple-name)
574 (defvar js2-USE_STACK 137)
575 (defvar js2-SETPROP_OP 138) ; x.y op= something
576 (defvar js2-SETELEM_OP 139) ; x[y] op= something
577 (defvar js2-LOCAL_BLOCK 140)
578 (defvar js2-SET_REF_OP 141) ; *reference op= something
581 (defvar js2-DOTDOT 142) ; member operator (..)
582 (defvar js2-COLONCOLON 143) ; namespace::name
583 (defvar js2-XML 144) ; XML type
584 (defvar js2-DOTQUERY 145) ; .() -- e.g., x.emps.emp.(name == "terry")
585 (defvar js2-XMLATTR 146) ; @
586 (defvar js2-XMLEND 147)
588 ;; Optimizer-only tokens
589 (defvar js2-TO_OBJECT 148)
590 (defvar js2-TO_DOUBLE 149)
592 (defvar js2-GET 150) ; JS 1.5 get pseudo keyword
593 (defvar js2-SET 151) ; JS 1.5 set pseudo keyword
594 (defvar js2-LET 152) ; JS 1.7 let pseudo keyword
595 (defvar js2-CONST 153)
596 (defvar js2-SETCONST 154)
597 (defvar js2-SETCONSTVAR 155)
598 (defvar js2-ARRAYCOMP 156)
599 (defvar js2-LETEXPR 157)
600 (defvar js2-WITHEXPR 158)
601 (defvar js2-DEBUGGER 159)
603 (defvar js2-COMMENT 160)
604 (defvar js2-TRIPLEDOT 161) ; for rest parameter
605 (defvar js2-ARROW 162) ; function arrow (=>)
606 (defvar js2-CLASS 163)
607 (defvar js2-EXTENDS 164)
608 (defvar js2-SUPER 165)
609 (defvar js2-TEMPLATE_HEAD 166) ; part of template literal before substitution
610 (defvar js2-NO_SUBS_TEMPLATE 167) ; template literal without substitutions
611 (defvar js2-TAGGED_TEMPLATE 168) ; tagged template literal
613 (defconst js2-num-tokens (1+ js2-TAGGED_TEMPLATE))
615 (defconst js2-debug-print-trees nil)
617 ;; Rhino accepts any string or stream as input. Emacs character
618 ;; processing works best in buffers, so we'll assume the input is a
619 ;; buffer. JavaScript strings can be copied into temp buffers before
622 ;; Buffer-local variables yield much cleaner code than using `defstruct'.
623 ;; They're the Emacs equivalent of instance variables, more or less.
625 (js2-deflocal js2-ts-dirty-line nil
626 "Token stream buffer-local variable.
627 Indicates stuff other than whitespace since start of line.")
629 (js2-deflocal js2-ts-hit-eof nil
630 "Token stream buffer-local variable.")
633 (js2-deflocal js2-ts-line-start 0
634 "Token stream buffer-local variable.")
636 (js2-deflocal js2-ts-lineno 1
637 "Token stream buffer-local variable.")
640 (js2-deflocal js2-ts-line-end-char -1
641 "Token stream buffer-local variable.")
643 (js2-deflocal js2-ts-cursor 1 ; emacs buffers are 1-indexed
644 "Token stream buffer-local variable.
645 Current scan position.")
648 (js2-deflocal js2-ts-is-xml-attribute nil
649 "Token stream buffer-local variable.")
651 (js2-deflocal js2-ts-xml-is-tag-content nil
652 "Token stream buffer-local variable.")
654 (js2-deflocal js2-ts-xml-open-tags-count 0
655 "Token stream buffer-local variable.")
657 (js2-deflocal js2-ts-string-buffer nil
658 "Token stream buffer-local variable.
659 List of chars built up while scanning various tokens.")
661 (cl-defstruct (js2-token
663 (:constructor make-js2-token (beg)))
664 "Value returned from the token stream."
675 ;; Have to call `js2-init-scanner' to initialize the values.
676 (js2-deflocal js2-ti-tokens nil)
677 (js2-deflocal js2-ti-tokens-cursor nil)
678 (js2-deflocal js2-ti-lookahead nil)
680 (cl-defstruct (js2-ts-state
681 (:constructor make-js2-ts-state (&key (lineno js2-ts-lineno)
682 (cursor js2-ts-cursor)
683 (tokens (copy-sequence js2-ti-tokens))
684 (tokens-cursor js2-ti-tokens-cursor)
685 (lookahead js2-ti-lookahead))))
694 (js2-deflocal js2-parsed-errors nil
695 "List of errors produced during scanning/parsing.")
697 (js2-deflocal js2-parsed-warnings nil
698 "List of warnings produced during scanning/parsing.")
700 (js2-deflocal js2-recover-from-parse-errors t
701 "Non-nil to continue parsing after a syntax error.
703 In recovery mode, the AST will be built in full, and any error
704 nodes will be flagged with appropriate error information. If
705 this flag is nil, a syntax error will result in an error being
708 The variable is automatically buffer-local, because different
709 modes that use the parser will need different settings.")
711 (js2-deflocal js2-parse-hook nil
712 "List of callbacks for receiving parsing progress.")
714 (defvar js2-parse-finished-hook nil
715 "List of callbacks to notify when parsing finishes.
716 Not called if parsing was interrupted.")
718 (js2-deflocal js2-is-eval-code nil
719 "True if we're evaluating code in a string.
720 If non-nil, the tokenizer will record the token text, and the AST nodes
721 will record their source text. Off by default for IDE modes, since the
722 text is available in the buffer.")
724 (defvar js2-parse-ide-mode t
725 "Non-nil if the parser is being used for `js2-mode'.
726 If non-nil, the parser will set text properties for fontification
727 and the syntax table. The value should be nil when using the
728 parser as a frontend to an interpreter or byte compiler.")
730 ;;; Parser instance variables (buffer-local vars for js2-parse)
732 (defconst js2-ti-after-eol (lsh 1 16)
733 "Flag: first token of the source line.")
735 ;; Inline Rhino's CompilerEnvirons vars as buffer-locals.
737 (js2-deflocal js2-compiler-generate-debug-info t)
738 (js2-deflocal js2-compiler-use-dynamic-scope nil)
739 (js2-deflocal js2-compiler-reserved-keywords-as-identifier nil)
740 (js2-deflocal js2-compiler-xml-available t)
741 (js2-deflocal js2-compiler-optimization-level 0)
742 (js2-deflocal js2-compiler-generating-source t)
743 (js2-deflocal js2-compiler-strict-mode nil)
744 (js2-deflocal js2-compiler-report-warning-as-error nil)
745 (js2-deflocal js2-compiler-generate-observer-count nil)
746 (js2-deflocal js2-compiler-activation-names nil)
750 ;; There's a compileFunction method in Context.java - may need it.
751 (js2-deflocal js2-called-by-compile-function nil
752 "True if `js2-parse' was called by `js2-compile-function'.
753 Will only be used when we finish implementing the interpreter.")
755 ;; SKIP: ts (we just call `js2-init-scanner' and use its vars)
757 ;; SKIP: node factory - we're going to just call functions directly,
758 ;; and eventually go to a unified AST format.
760 (js2-deflocal js2-nesting-of-function 0)
762 (js2-deflocal js2-recorded-identifiers nil
763 "Tracks identifiers found during parsing.")
765 (js2-deflocal js2-is-in-destructuring nil
766 "True while parsing destructuring expression.")
768 (js2-deflocal js2-in-use-strict-directive nil
769 "True while inside a script or function under strict mode.")
771 (defcustom js2-global-externs nil
772 "A list of any extern names you'd like to consider always declared.
773 This list is global and is used by all `js2-mode' files.
774 You can create buffer-local externs list using `js2-additional-externs'.
776 There is also a buffer-local variable `js2-default-externs',
777 which is initialized by default to include the Ecma-262 externs
778 and the standard browser externs. The three lists are all
779 checked during highlighting."
783 (js2-deflocal js2-default-externs nil
784 "Default external declarations.
786 These are currently only used for highlighting undeclared variables,
787 which only worries about top-level (unqualified) references.
788 As js2-mode's processing improves, we will flesh out this list.
790 The initial value is set to `js2-ecma-262-externs', unless some
791 of the `js2-include-?-externs' variables are set to t, in which
792 case the browser, Rhino and/or Node.js externs are also included.
794 See `js2-additional-externs' for more information.")
796 (defcustom js2-include-browser-externs t
797 "Non-nil to include browser externs in the master externs list.
798 If you work on JavaScript files that are not intended for browsers,
799 such as Mozilla Rhino server-side JavaScript, set this to nil.
800 See `js2-additional-externs' for more information about externs."
804 (defcustom js2-include-rhino-externs nil
805 "Non-nil to include Mozilla Rhino externs in the master externs list.
806 See `js2-additional-externs' for more information about externs."
810 (defcustom js2-include-node-externs nil
811 "Non-nil to include Node.js externs in the master externs list.
812 See `js2-additional-externs' for more information about externs."
816 (js2-deflocal js2-additional-externs nil
817 "A buffer-local list of additional external declarations.
818 It is used to decide whether variables are considered undeclared
819 for purposes of highlighting.
821 Each entry is a Lisp string. The string should be the fully qualified
822 name of an external entity. All externs should be added to this list,
823 so that as js2-mode's processing improves it can take advantage of them.
825 You may want to declare your externs in three ways.
826 First, you can add externs that are valid for all your JavaScript files.
827 You should probably do this by adding them to `js2-global-externs', which
828 is a global list used for all js2-mode files.
830 Next, you can add a function to `js2-init-hook' that adds additional
831 externs appropriate for the specific file, perhaps based on its path.
832 These should go in `js2-additional-externs', which is buffer-local.
834 Third, you can use JSLint's global declaration, as long as
835 `js2-include-jslint-globals' is non-nil, which see.
837 Finally, you can add a function to `js2-post-parse-callbacks',
838 which is called after parsing completes, and `js2-mode-ast' is bound to
839 the root of the parse tree. At this stage you can set up an AST
840 node visitor using `js2-visit-ast' and examine the parse tree
841 for specific import patterns that may imply the existence of
842 other externs, possibly tied to your build system. These should also
843 be added to `js2-additional-externs'.
845 Your post-parse callback may of course also use the simpler and
846 faster (but perhaps less robust) approach of simply scanning the
847 buffer text for your imports, using regular expressions.")
850 ;; SKIP: encoded-source
852 ;;; The following variables are per-function and should be saved/restored
853 ;;; during function parsing...
855 (js2-deflocal js2-current-script-or-fn nil)
856 (js2-deflocal js2-current-scope nil)
857 (js2-deflocal js2-nesting-of-with 0)
858 (js2-deflocal js2-label-set nil
859 "An alist mapping label names to nodes.")
861 (js2-deflocal js2-loop-set nil)
862 (js2-deflocal js2-loop-and-switch-set nil)
863 (js2-deflocal js2-has-return-value nil)
864 (js2-deflocal js2-end-flags 0)
866 ;;; ...end of per function variables
868 ;; These flags enumerate the possible ways a statement/function can
869 ;; terminate. These flags are used by endCheck() and by the Parser to
870 ;; detect inconsistent return usage.
872 ;; END_UNREACHED is reserved for code paths that are assumed to always be
873 ;; able to execute (example: throw, continue)
875 ;; END_DROPS_OFF indicates if the statement can transfer control to the
876 ;; next one. Statement such as return dont. A compound statement may have
877 ;; some branch that drops off control to the next statement.
879 ;; END_RETURNS indicates that the statement can return (without arguments)
880 ;; END_RETURNS_VALUE indicates that the statement can return a value.
882 ;; A compound statement such as
886 ;; Will be detected as (END_DROPS_OFF | END_RETURN_VALUE) by endCheck()
888 (defconst js2-end-unreached #x0)
889 (defconst js2-end-drops-off #x1)
890 (defconst js2-end-returns #x2)
891 (defconst js2-end-returns-value #x4)
893 ;; Rhino awkwardly passes a statementLabel parameter to the
894 ;; statementHelper() function, the main statement parser, which
895 ;; is then used by quite a few of the sub-parsers. We just make
896 ;; it a buffer-local variable and make sure it's cleaned up properly.
897 (js2-deflocal js2-labeled-stmt nil) ; type `js2-labeled-stmt-node'
899 ;; Similarly, Rhino passes an inForInit boolean through about half
900 ;; the expression parsers. We use a dynamically-scoped variable,
901 ;; which makes it easier to funcall the parsers individually without
902 ;; worrying about whether they take the parameter or not.
903 (js2-deflocal js2-in-for-init nil)
904 (js2-deflocal js2-temp-name-counter 0)
905 (js2-deflocal js2-parse-stmt-count 0)
907 (defsubst js2-get-next-temp-name ()
908 (format "$%d" (cl-incf js2-temp-name-counter)))
910 (defvar js2-parse-interruptable-p t
911 "Set this to nil to force parse to continue until finished.
912 This will mostly be useful for interpreters.")
914 (defvar js2-statements-per-pause 50
915 "Pause after this many statements to check for user input.
916 If user input is pending, stop the parse and discard the tree.
917 This makes for a smoother user experience for large files.
918 You may have to wait a second or two before the highlighting
919 and error-reporting appear, but you can always type ahead if
920 you wish. This appears to be more or less how Eclipse, IntelliJ
921 and other editors work.")
923 (js2-deflocal js2-record-comments t
924 "Instructs the scanner to record comments in `js2-scanned-comments'.")
926 (js2-deflocal js2-scanned-comments nil
927 "List of all comments from the current parse.")
929 (defcustom js2-mode-indent-inhibit-undo nil
930 "Non-nil to disable collection of Undo information when indenting lines.
931 Some users have requested this behavior. It's nil by default because
932 other Emacs modes don't work this way."
936 (defcustom js2-mode-indent-ignore-first-tab nil
937 "If non-nil, ignore first TAB keypress if we look indented properly.
938 It's fairly common for users to navigate to an already-indented line
939 and press TAB for reassurance that it's been indented. For this class
940 of users, we want the first TAB press on a line to be ignored if the
941 line is already indented to one of the precomputed alternatives.
943 This behavior is only partly implemented. If you TAB-indent a line,
944 navigate to another line, and then navigate back, it fails to clear
945 the last-indented variable, so it thinks you've already hit TAB once,
946 and performs the indent. A full solution would involve getting on the
947 point-motion hooks for the entire buffer. If we come across another
948 use cases that requires watching point motion, I'll consider doing it.
950 If you set this variable to nil, then the TAB key will always change
951 the indentation of the current line, if more than one alternative
952 indentation spot exists."
956 (defvar js2-indent-hook nil
957 "A hook for user-defined indentation rules.
959 Functions on this hook should expect two arguments: (LIST INDEX)
960 The LIST argument is the list of computed indentation points for
961 the current line. INDEX is the list index of the indentation point
962 that `js2-bounce-indent' plans to use. If INDEX is nil, then the
963 indent function is not going to change the current line indentation.
965 If a hook function on this list returns a non-nil value, then
966 `js2-bounce-indent' assumes the hook function has performed its own
967 indentation, and will do nothing. If all hook functions on the list
968 return nil, then `js2-bounce-indent' will use its computed indentation
969 and reindent the line.
971 When hook functions on this hook list are called, the variable
972 `js2-mode-ast' may or may not be set, depending on whether the
973 parse tree is available. If the variable is nil, you can pass a
974 callback to `js2-mode-wait-for-parse', and your callback will be
975 called after the new parse tree is built. This can take some time
979 `((((class color) (background light))
980 (:underline "orange"))
981 (((class color) (background dark))
982 (:underline "orange"))
984 "Face for JavaScript warnings."
988 `((((class color) (background light))
990 (((class color) (background dark))
992 (t (:foreground "red")))
993 "Face for JavaScript errors."
996 (defface js2-jsdoc-tag
997 '((t :foreground "SlateGray"))
998 "Face used to highlight @whatever tags in jsdoc comments."
1001 (defface js2-jsdoc-type
1002 '((t :foreground "SteelBlue"))
1003 "Face used to highlight {FooBar} types in jsdoc comments."
1006 (defface js2-jsdoc-value
1007 '((t :foreground "PeachPuff3"))
1008 "Face used to highlight tag values in jsdoc comments."
1011 (defface js2-function-param
1012 '((t :foreground "SeaGreen"))
1013 "Face used to highlight function parameters in javascript."
1016 (defface js2-function-call
1017 '((t :inherit default))
1018 "Face used to highlight function name in calls."
1021 (defface js2-object-property
1022 '((t :inherit default))
1023 "Face used to highlight named property in object literal."
1026 (defface js2-instance-member
1027 '((t :foreground "DarkOrchid"))
1028 "Face used to highlight instance variables in javascript.
1029 Not currently used."
1032 (defface js2-private-member
1033 '((t :foreground "PeachPuff3"))
1034 "Face used to highlight calls to private methods in javascript.
1035 Not currently used."
1038 (defface js2-private-function-call
1039 '((t :foreground "goldenrod"))
1040 "Face used to highlight calls to private functions in javascript.
1041 Not currently used."
1044 (defface js2-jsdoc-html-tag-name
1045 '((((class color) (min-colors 88) (background light))
1046 (:foreground "rosybrown"))
1047 (((class color) (min-colors 8) (background dark))
1048 (:foreground "yellow"))
1049 (((class color) (min-colors 8) (background light))
1050 (:foreground "magenta")))
1051 "Face used to highlight jsdoc html tag names"
1054 (defface js2-jsdoc-html-tag-delimiter
1055 '((((class color) (min-colors 88) (background light))
1056 (:foreground "dark khaki"))
1057 (((class color) (min-colors 8) (background dark))
1058 (:foreground "green"))
1059 (((class color) (min-colors 8) (background light))
1060 (:foreground "green")))
1061 "Face used to highlight brackets in jsdoc html tags."
1064 (defface js2-external-variable
1065 '((t :foreground "orange"))
1066 "Face used to highlight undeclared variable identifiers.")
1068 (defcustom js2-init-hook nil
1069 "List of functions to be called after `js2-mode' or
1070 `js2-minor-mode' has initialized all variables, before parsing
1071 the buffer for the first time."
1074 :version "20130608")
1076 (defcustom js2-post-parse-callbacks nil
1077 "List of callback functions invoked after parsing finishes.
1078 Currently, the main use for this function is to add synthetic
1079 declarations to `js2-recorded-identifiers', which see."
1083 (defcustom js2-build-imenu-callbacks nil
1084 "List of functions called during Imenu index generation.
1085 It's a good place to add additional entries to it, using
1086 `js2-record-imenu-entry'."
1090 (defcustom js2-highlight-external-variables t
1091 "Non-nil to highlight undeclared variable identifiers.
1092 An undeclared variable is any variable not declared with var or let
1093 in the current scope or any lexically enclosing scope. If you use
1094 such a variable, then you are either expecting it to originate from
1095 another file, or you've got a potential bug."
1099 (defcustom js2-warn-about-unused-function-arguments nil
1100 "Non-nil to treat function arguments like declared-but-unused variables."
1104 (defcustom js2-include-jslint-globals t
1105 "Non-nil to include the identifiers from JSLint global
1106 declaration (see http://www.jslint.com/lint.html#global) in the
1107 buffer-local externs list. See `js2-additional-externs' for more
1112 (defvar js2-mode-map
1113 (let ((map (make-sparse-keymap)))
1114 (define-key map [mouse-1] #'js2-mode-show-node)
1115 (define-key map (kbd "M-j") #'js2-line-break)
1116 (define-key map (kbd "C-c C-e") #'js2-mode-hide-element)
1117 (define-key map (kbd "C-c C-s") #'js2-mode-show-element)
1118 (define-key map (kbd "C-c C-a") #'js2-mode-show-all)
1119 (define-key map (kbd "C-c C-f") #'js2-mode-toggle-hide-functions)
1120 (define-key map (kbd "C-c C-t") #'js2-mode-toggle-hide-comments)
1121 (define-key map (kbd "C-c C-o") #'js2-mode-toggle-element)
1122 (define-key map (kbd "C-c C-w") #'js2-mode-toggle-warnings-and-errors)
1123 (define-key map [down-mouse-3] #'js2-down-mouse-3)
1124 (define-key map [remap js-find-symbol] #'js2-jump-to-definition)
1126 (define-key map [menu-bar javascript]
1127 (cons "JavaScript" (make-sparse-keymap "JavaScript")))
1129 (define-key map [menu-bar javascript customize-js2-mode]
1130 '(menu-item "Customize js2-mode" js2-mode-customize
1131 :help "Customize the behavior of this mode"))
1133 (define-key map [menu-bar javascript js2-force-refresh]
1134 '(menu-item "Force buffer refresh" js2-mode-reset
1135 :help "Re-parse the buffer from scratch"))
1137 (define-key map [menu-bar javascript separator-2]
1140 (define-key map [menu-bar javascript next-error]
1141 '(menu-item "Next warning or error" next-error
1142 :enabled (and js2-mode-ast
1143 (or (js2-ast-root-errors js2-mode-ast)
1144 (js2-ast-root-warnings js2-mode-ast)))
1145 :help "Move to next warning or error"))
1147 (define-key map [menu-bar javascript display-errors]
1148 '(menu-item "Show errors and warnings" js2-mode-display-warnings-and-errors
1149 :visible (not js2-mode-show-parse-errors)
1150 :help "Turn on display of warnings and errors"))
1152 (define-key map [menu-bar javascript hide-errors]
1153 '(menu-item "Hide errors and warnings" js2-mode-hide-warnings-and-errors
1154 :visible js2-mode-show-parse-errors
1155 :help "Turn off display of warnings and errors"))
1157 (define-key map [menu-bar javascript separator-1]
1160 (define-key map [menu-bar javascript js2-toggle-function]
1161 '(menu-item "Show/collapse element" js2-mode-toggle-element
1162 :help "Hide or show function body or comment"))
1164 (define-key map [menu-bar javascript show-comments]
1165 '(menu-item "Show block comments" js2-mode-toggle-hide-comments
1166 :visible js2-mode-comments-hidden
1167 :help "Expand all hidden block comments"))
1169 (define-key map [menu-bar javascript hide-comments]
1170 '(menu-item "Hide block comments" js2-mode-toggle-hide-comments
1171 :visible (not js2-mode-comments-hidden)
1172 :help "Show block comments as /*...*/"))
1174 (define-key map [menu-bar javascript show-all-functions]
1175 '(menu-item "Show function bodies" js2-mode-toggle-hide-functions
1176 :visible js2-mode-functions-hidden
1177 :help "Expand all hidden function bodies"))
1179 (define-key map [menu-bar javascript hide-all-functions]
1180 '(menu-item "Hide function bodies" js2-mode-toggle-hide-functions
1181 :visible (not js2-mode-functions-hidden)
1182 :help "Show {...} for all top-level function bodies"))
1185 "Keymap used in `js2-mode' buffers.")
1187 (defcustom js2-bounce-indent-p nil
1188 "Non-nil to bind `js2-indent-bounce' and `js2-indent-bounce-backward'.
1189 They will augment the default indent-line behavior with cycling
1190 among several computed alternatives. See the function
1191 `js2-bounce-indent' for details. The above commands will be
1192 bound to TAB and backtab."
1195 :set (lambda (sym value)
1196 (set-default sym value)
1197 (let ((map js2-mode-map))
1200 (define-key map "\t" nil)
1201 (define-key map (kbd "<backtab>") nil))
1202 (define-key map "\t" #'js2-indent-bounce)
1203 (define-key map (kbd "<backtab>") #'js2-indent-bounce-backward)))))
1205 (defconst js2-mode-identifier-re "[[:alpha:]_$][[:alnum:]_$]*")
1207 (defvar js2-mode-//-comment-re "^\\(\\s-*\\)//.+"
1208 "Matches a //-comment line. Must be first non-whitespace on line.
1209 First match-group is the leading whitespace.")
1211 (defvar js2-mode-hook nil)
1213 (js2-deflocal js2-mode-ast nil "Private variable.")
1214 (js2-deflocal js2-mode-parse-timer nil "Private variable.")
1215 (js2-deflocal js2-mode-buffer-dirty-p nil "Private variable.")
1216 (js2-deflocal js2-mode-parsing nil "Private variable.")
1217 (js2-deflocal js2-mode-node-overlay nil)
1219 (defvar js2-mode-show-overlay js2-mode-dev-mode-p
1220 "Debug: Non-nil to highlight AST nodes on mouse-down.")
1222 (js2-deflocal js2-mode-fontifications nil "Private variable")
1223 (js2-deflocal js2-mode-deferred-properties nil "Private variable")
1224 (js2-deflocal js2-imenu-recorder nil "Private variable")
1225 (js2-deflocal js2-imenu-function-map nil "Private variable")
1227 (defvar js2-mode-verbose-parse-p js2-mode-dev-mode-p
1228 "Non-nil to emit status messages during parsing.")
1230 (defvar js2-mode-functions-hidden nil "Private variable.")
1231 (defvar js2-mode-comments-hidden nil "Private variable.")
1233 (defvar js2-mode-syntax-table
1234 (let ((table (make-syntax-table)))
1235 (c-populate-syntax-table table)
1236 (modify-syntax-entry ?` "\"" table)
1238 "Syntax table used in `js2-mode' buffers.")
1240 (defvar js2-mode-abbrev-table nil
1241 "Abbrev table in use in `js2-mode' buffers.")
1242 (define-abbrev-table 'js2-mode-abbrev-table ())
1244 (defvar js2-mode-pending-parse-callbacks nil
1245 "List of functions waiting to be notified that parse is finished.")
1247 (defvar js2-mode-last-indented-line -1)
1249 ;;; Localizable error and warning messages
1251 ;; Messages are copied from Rhino's Messages.properties.
1252 ;; Many of the Java-specific messages have been elided.
1253 ;; Add any js2-specific ones at the end, so we can keep
1254 ;; this file synced with changes to Rhino's.
1256 (defvar js2-message-table
1257 (make-hash-table :test 'equal :size 250)
1258 "Contains localized messages for `js2-mode'.")
1260 ;; TODO(stevey): construct this table at compile-time.
1261 (defmacro js2-msg (key &rest strings)
1262 `(puthash ,key (concat ,@strings)
1265 (defun js2-get-msg (msg-key)
1266 "Look up a localized message.
1267 MSG-KEY is a list of (MSG ARGS). If the message takes parameters,
1268 the correct number of ARGS must be provided."
1269 (let* ((key (if (listp msg-key) (car msg-key) msg-key))
1270 (args (if (listp msg-key) (cdr msg-key)))
1271 (msg (gethash key js2-message-table)))
1273 (apply #'format msg args)
1274 key))) ; default to showing the key
1276 (js2-msg "msg.dup.parms"
1277 "Duplicate parameter name '%s'.")
1279 (js2-msg "msg.too.big.jump"
1280 "Program too complex: jump offset too big.")
1282 (js2-msg "msg.too.big.index"
1283 "Program too complex: internal index exceeds 64K limit.")
1285 (js2-msg "msg.while.compiling.fn"
1286 "Encountered code generation error while compiling function '%s': %s")
1288 (js2-msg "msg.while.compiling.script"
1289 "Encountered code generation error while compiling script: %s")
1292 (js2-msg "msg.ctor.not.found"
1293 "Constructor for '%s' not found.")
1295 (js2-msg "msg.not.ctor"
1296 "'%s' is not a constructor.")
1299 (js2-msg "msg.varargs.ctor"
1300 "Method or constructor '%s' must be static "
1301 "with the signature (Context cx, Object[] args, "
1302 "Function ctorObj, boolean inNewExpr) "
1303 "to define a variable arguments constructor.")
1305 (js2-msg "msg.varargs.fun"
1306 "Method '%s' must be static with the signature "
1307 "(Context cx, Scriptable thisObj, Object[] args, Function funObj) "
1308 "to define a variable arguments function.")
1310 (js2-msg "msg.incompat.call"
1311 "Method '%s' called on incompatible object.")
1313 (js2-msg "msg.bad.parms"
1314 "Unsupported parameter type '%s' in method '%s'.")
1316 (js2-msg "msg.bad.method.return"
1317 "Unsupported return type '%s' in method '%s'.")
1319 (js2-msg "msg.bad.ctor.return"
1320 "Construction of objects of type '%s' is not supported.")
1322 (js2-msg "msg.no.overload"
1323 "Method '%s' occurs multiple times in class '%s'.")
1325 (js2-msg "msg.method.not.found"
1326 "Method '%s' not found in '%s'.")
1330 (js2-msg "msg.bad.for.in.lhs"
1331 "Invalid left-hand side of for..in loop.")
1333 (js2-msg "msg.mult.index"
1334 "Only one variable allowed in for..in loop.")
1336 (js2-msg "msg.bad.for.in.destruct"
1337 "Left hand side of for..in loop must be an array of "
1338 "length 2 to accept key/value pair.")
1340 (js2-msg "msg.cant.convert"
1341 "Can't convert to type '%s'.")
1343 (js2-msg "msg.bad.assign.left"
1344 "Invalid assignment left-hand side.")
1346 (js2-msg "msg.bad.decr"
1347 "Invalid decrement operand.")
1349 (js2-msg "msg.bad.incr"
1350 "Invalid increment operand.")
1352 (js2-msg "msg.bad.yield"
1353 "yield must be in a function.")
1355 (js2-msg "msg.yield.parenthesized"
1356 "yield expression must be parenthesized.")
1359 (js2-msg "msg.cant.call.indirect"
1360 "Function '%s' must be called directly, and not by way of a "
1361 "function of another name.")
1363 (js2-msg "msg.eval.nonstring"
1364 "Calling eval() with anything other than a primitive "
1365 "string value will simply return the value. "
1366 "Is this what you intended?")
1368 (js2-msg "msg.eval.nonstring.strict"
1369 "Calling eval() with anything other than a primitive "
1370 "string value is not allowed in strict mode.")
1372 (js2-msg "msg.bad.destruct.op"
1373 "Invalid destructuring assignment operator")
1376 (js2-msg "msg.only.from.new"
1377 "'%s' may only be invoked from a `new' expression.")
1379 (js2-msg "msg.deprec.ctor"
1380 "The '%s' constructor is deprecated.")
1383 (js2-msg "msg.no.function.ref.found"
1384 "no source found to decompile function reference %s")
1386 (js2-msg "msg.arg.isnt.array"
1387 "second argument to Function.prototype.apply must be an array")
1390 (js2-msg "msg.bad.esc.mask"
1391 "invalid string escape mask")
1394 (js2-msg "msg.bad.quant"
1395 "Invalid quantifier %s")
1397 (js2-msg "msg.overlarge.backref"
1398 "Overly large back reference %s")
1400 (js2-msg "msg.overlarge.min"
1401 "Overly large minimum %s")
1403 (js2-msg "msg.overlarge.max"
1404 "Overly large maximum %s")
1406 (js2-msg "msg.zero.quant"
1407 "Zero quantifier %s")
1409 (js2-msg "msg.max.lt.min"
1410 "Maximum %s less than minimum")
1412 (js2-msg "msg.unterm.quant"
1413 "Unterminated quantifier %s")
1415 (js2-msg "msg.unterm.paren"
1416 "Unterminated parenthetical %s")
1418 (js2-msg "msg.unterm.class"
1419 "Unterminated character class %s")
1421 (js2-msg "msg.bad.range"
1422 "Invalid range in character class.")
1424 (js2-msg "msg.trail.backslash"
1425 "Trailing \\ in regular expression.")
1427 (js2-msg "msg.re.unmatched.right.paren"
1428 "unmatched ) in regular expression.")
1430 (js2-msg "msg.no.regexp"
1431 "Regular expressions are not available.")
1433 (js2-msg "msg.bad.backref"
1434 "back-reference exceeds number of capturing parentheses.")
1436 (js2-msg "msg.bad.regexp.compile"
1437 "Only one argument may be specified if the first "
1438 "argument to RegExp.prototype.compile is a RegExp object.")
1441 (js2-msg "msg.got.syntax.errors"
1442 "Compilation produced %s syntax errors.")
1444 (js2-msg "msg.var.redecl"
1445 "TypeError: redeclaration of var %s.")
1447 (js2-msg "msg.const.redecl"
1448 "TypeError: redeclaration of const %s.")
1450 (js2-msg "msg.let.redecl"
1451 "TypeError: redeclaration of variable %s.")
1453 (js2-msg "msg.parm.redecl"
1454 "TypeError: redeclaration of formal parameter %s.")
1456 (js2-msg "msg.fn.redecl"
1457 "TypeError: redeclaration of function %s.")
1459 (js2-msg "msg.let.decl.not.in.block"
1460 "SyntaxError: let declaration not directly within block")
1462 (js2-msg "msg.mod.import.decl.at.top.level"
1463 "SyntaxError: import declarations may only appear at the top level")
1465 (js2-msg "msg.mod.as.after.reserved.word"
1466 "SyntaxError: missing keyword 'as' after reserved word %s")
1468 (js2-msg "msg.mod.rc.after.import.spec.list"
1469 "SyntaxError: missing '}' after module specifier list")
1471 (js2-msg "msg.mod.from.after.import.spec.set"
1472 "SyntaxError: missing keyword 'from' after import specifier set")
1474 (js2-msg "msg.mod.declaration.after.import"
1475 "SyntaxError: missing declaration after 'import' keyword")
1477 (js2-msg "msg.mod.spec.after.from"
1478 "SyntaxError: missing module specifier after 'from' keyword")
1480 (js2-msg "msg.mod.export.decl.at.top.level"
1481 "SyntaxError: export declarations may only appear at top level")
1483 (js2-msg "msg.mod.rc.after.export.spec.list"
1484 "SyntaxError: missing '}' after export specifier list")
1487 (js2-msg "msg.dup.label"
1490 (js2-msg "msg.undef.label"
1493 (js2-msg "msg.bad.break"
1494 "unlabelled break must be inside loop or switch")
1496 (js2-msg "msg.continue.outside"
1497 "continue must be inside loop")
1499 (js2-msg "msg.continue.nonloop"
1500 "continue can only use labels of iteration statements")
1502 (js2-msg "msg.bad.throw.eol"
1503 "Line terminator is not allowed between the throw "
1504 "keyword and throw expression.")
1506 (js2-msg "msg.unnamed.function.stmt" ; added by js2-mode
1507 "function statement requires a name")
1509 (js2-msg "msg.no.paren.parms"
1510 "missing ( before function parameters.")
1512 (js2-msg "msg.no.parm"
1513 "missing formal parameter")
1515 (js2-msg "msg.no.paren.after.parms"
1516 "missing ) after formal parameters")
1518 (js2-msg "msg.no.default.after.default.param" ; added by js2-mode
1519 "parameter without default follows parameter with default")
1521 (js2-msg "msg.param.after.rest" ; added by js2-mode
1522 "parameter after rest parameter")
1524 (js2-msg "msg.bad.arrow.args" ; added by js2-mode
1525 "invalid arrow-function arguments (parentheses around the arrow-function may help)")
1527 (js2-msg "msg.no.brace.body"
1528 "missing '{' before function body")
1530 (js2-msg "msg.no.brace.after.body"
1531 "missing } after function body")
1533 (js2-msg "msg.no.paren.cond"
1534 "missing ( before condition")
1536 (js2-msg "msg.no.paren.after.cond"
1537 "missing ) after condition")
1539 (js2-msg "msg.no.semi.stmt"
1540 "missing ; before statement")
1542 (js2-msg "msg.missing.semi"
1543 "missing ; after statement")
1545 (js2-msg "msg.no.name.after.dot"
1546 "missing name after . operator")
1548 (js2-msg "msg.no.name.after.coloncolon"
1549 "missing name after :: operator")
1551 (js2-msg "msg.no.name.after.dotdot"
1552 "missing name after .. operator")
1554 (js2-msg "msg.no.name.after.xmlAttr"
1555 "missing name after .@")
1557 (js2-msg "msg.no.bracket.index"
1558 "missing ] in index expression")
1560 (js2-msg "msg.no.paren.switch"
1561 "missing ( before switch expression")
1563 (js2-msg "msg.no.paren.after.switch"
1564 "missing ) after switch expression")
1566 (js2-msg "msg.no.brace.switch"
1567 "missing '{' before switch body")
1569 (js2-msg "msg.bad.switch"
1570 "invalid switch statement")
1572 (js2-msg "msg.no.colon.case"
1573 "missing : after case expression")
1575 (js2-msg "msg.double.switch.default"
1576 "double default label in the switch statement")
1578 (js2-msg "msg.no.while.do"
1579 "missing while after do-loop body")
1581 (js2-msg "msg.no.paren.for"
1582 "missing ( after for")
1584 (js2-msg "msg.no.semi.for"
1585 "missing ; after for-loop initializer")
1587 (js2-msg "msg.no.semi.for.cond"
1588 "missing ; after for-loop condition")
1590 (js2-msg "msg.in.after.for.name"
1591 "missing in or of after for")
1593 (js2-msg "msg.no.paren.for.ctrl"
1594 "missing ) after for-loop control")
1596 (js2-msg "msg.no.paren.with"
1597 "missing ( before with-statement object")
1599 (js2-msg "msg.no.paren.after.with"
1600 "missing ) after with-statement object")
1602 (js2-msg "msg.no.with.strict"
1603 "with statements not allowed in strict mode")
1605 (js2-msg "msg.no.paren.after.let"
1606 "missing ( after let")
1608 (js2-msg "msg.no.paren.let"
1609 "missing ) after variable list")
1611 (js2-msg "msg.no.curly.let"
1612 "missing } after let statement")
1614 (js2-msg "msg.bad.return"
1617 (js2-msg "msg.no.brace.block"
1618 "missing } in compound statement")
1620 (js2-msg "msg.bad.label"
1623 (js2-msg "msg.bad.var"
1624 "missing variable name")
1626 (js2-msg "msg.bad.var.init"
1627 "invalid variable initialization")
1629 (js2-msg "msg.no.colon.cond"
1630 "missing : in conditional expression")
1632 (js2-msg "msg.no.paren.arg"
1633 "missing ) after argument list")
1635 (js2-msg "msg.no.bracket.arg"
1636 "missing ] after element list")
1638 (js2-msg "msg.bad.prop"
1639 "invalid property id")
1641 (js2-msg "msg.no.colon.prop"
1642 "missing : after property id")
1644 (js2-msg "msg.no.brace.prop"
1645 "missing } after property list")
1647 (js2-msg "msg.no.paren"
1648 "missing ) in parenthetical")
1650 (js2-msg "msg.reserved.id"
1651 "'%s' is a reserved identifier")
1653 (js2-msg "msg.no.paren.catch"
1654 "missing ( before catch-block condition")
1656 (js2-msg "msg.bad.catchcond"
1657 "invalid catch block condition")
1659 (js2-msg "msg.catch.unreachable"
1660 "any catch clauses following an unqualified catch are unreachable")
1662 (js2-msg "msg.no.brace.try"
1663 "missing '{' before try block")
1665 (js2-msg "msg.no.brace.catchblock"
1666 "missing '{' before catch-block body")
1668 (js2-msg "msg.try.no.catchfinally"
1669 "'try' without 'catch' or 'finally'")
1671 (js2-msg "msg.no.return.value"
1672 "function %s does not always return a value")
1674 (js2-msg "msg.anon.no.return.value"
1675 "anonymous function does not always return a value")
1677 (js2-msg "msg.return.inconsistent"
1678 "return statement is inconsistent with previous usage")
1680 (js2-msg "msg.generator.returns"
1681 "TypeError: legacy generator function '%s' returns a value")
1683 (js2-msg "msg.anon.generator.returns"
1684 "TypeError: anonymous legacy generator function returns a value")
1686 (js2-msg "msg.syntax"
1689 (js2-msg "msg.unexpected.eof"
1690 "Unexpected end of file")
1692 (js2-msg "msg.XML.bad.form"
1693 "illegally formed XML syntax")
1695 (js2-msg "msg.XML.not.available"
1696 "XML runtime not available")
1698 (js2-msg "msg.too.deep.parser.recursion"
1699 "Too deep recursion while parsing")
1701 (js2-msg "msg.no.side.effects"
1702 "Code has no side effects")
1704 (js2-msg "msg.extra.trailing.comma"
1705 "Trailing comma is not supported in some browsers")
1707 (js2-msg "msg.array.trailing.comma"
1708 "Trailing comma yields different behavior across browsers")
1710 (js2-msg "msg.equal.as.assign"
1711 (concat "Test for equality (==) mistyped as assignment (=)?"
1712 " (parenthesize to suppress warning)"))
1714 (js2-msg "msg.var.hides.arg"
1715 "Variable %s hides argument")
1717 (js2-msg "msg.destruct.assign.no.init"
1718 "Missing = in destructuring declaration")
1720 (js2-msg "msg.no.octal.strict"
1721 "Octal numbers prohibited in strict mode.")
1723 (js2-msg "msg.dup.obj.lit.prop.strict"
1724 "Property '%s' already defined in this object literal.")
1726 (js2-msg "msg.dup.param.strict"
1727 "Parameter '%s' already declared in this function.")
1729 (js2-msg "msg.bad.id.strict"
1730 "'%s' is not a valid identifier for this use in strict mode.")
1733 (js2-msg "msg.no.properties"
1734 "%s has no properties.")
1736 (js2-msg "msg.invalid.iterator"
1737 "Invalid iterator value")
1739 (js2-msg "msg.iterator.primitive"
1740 "__iterator__ returned a primitive value")
1742 (js2-msg "msg.assn.create.strict"
1743 "Assignment to undeclared variable %s")
1745 (js2-msg "msg.undeclared.variable" ; added by js2-mode
1746 "Undeclared variable or function '%s'")
1748 (js2-msg "msg.unused.variable" ; added by js2-mode
1749 "Unused variable or function '%s'")
1751 (js2-msg "msg.uninitialized.variable" ; added by js2-mode
1752 "Variable '%s' referenced but never initialized")
1754 (js2-msg "msg.ref.undefined.prop"
1755 "Reference to undefined property '%s'")
1757 (js2-msg "msg.prop.not.found"
1758 "Property %s not found.")
1760 (js2-msg "msg.invalid.type"
1761 "Invalid JavaScript value of type %s")
1763 (js2-msg "msg.primitive.expected"
1764 "Primitive type expected (had %s instead)")
1766 (js2-msg "msg.namespace.expected"
1767 "Namespace object expected to left of :: (found %s instead)")
1769 (js2-msg "msg.null.to.object"
1770 "Cannot convert null to an object.")
1772 (js2-msg "msg.undef.to.object"
1773 "Cannot convert undefined to an object.")
1775 (js2-msg "msg.cyclic.value"
1776 "Cyclic %s value not allowed.")
1778 (js2-msg "msg.is.not.defined"
1779 "'%s' is not defined.")
1781 (js2-msg "msg.undef.prop.read"
1782 "Cannot read property '%s' from %s")
1784 (js2-msg "msg.undef.prop.write"
1785 "Cannot set property '%s' of %s to '%s'")
1787 (js2-msg "msg.undef.prop.delete"
1788 "Cannot delete property '%s' of %s")
1790 (js2-msg "msg.undef.method.call"
1791 "Cannot call method '%s' of %s")
1793 (js2-msg "msg.undef.with"
1794 "Cannot apply 'with' to %s")
1796 (js2-msg "msg.isnt.function"
1797 "%s is not a function, it is %s.")
1799 (js2-msg "msg.isnt.function.in"
1800 "Cannot call property %s in object %s. "
1801 "It is not a function, it is '%s'.")
1803 (js2-msg "msg.function.not.found"
1804 "Cannot find function %s.")
1806 (js2-msg "msg.function.not.found.in"
1807 "Cannot find function %s in object %s.")
1809 (js2-msg "msg.isnt.xml.object"
1810 "%s is not an xml object.")
1812 (js2-msg "msg.no.ref.to.get"
1813 "%s is not a reference to read reference value.")
1815 (js2-msg "msg.no.ref.to.set"
1816 "%s is not a reference to set reference value to %s.")
1818 (js2-msg "msg.no.ref.from.function"
1819 "Function %s can not be used as the left-hand "
1820 "side of assignment or as an operand of ++ or -- operator.")
1822 (js2-msg "msg.bad.default.value"
1823 "Object's getDefaultValue() method returned an object.")
1825 (js2-msg "msg.instanceof.not.object"
1826 "Can't use instanceof on a non-object.")
1828 (js2-msg "msg.instanceof.bad.prototype"
1829 "'prototype' property of %s is not an object.")
1831 (js2-msg "msg.bad.radix"
1832 "illegal radix %s.")
1835 (js2-msg "msg.default.value"
1836 "Cannot find default value for object.")
1838 (js2-msg "msg.zero.arg.ctor"
1839 "Cannot load class '%s' which has no zero-parameter constructor.")
1841 (js2-msg "msg.ctor.multiple.parms"
1842 "Can't define constructor or class %s since more than "
1843 "one constructor has multiple parameters.")
1845 (js2-msg "msg.extend.scriptable"
1846 "%s must extend ScriptableObject in order to define property %s.")
1848 (js2-msg "msg.bad.getter.parms"
1849 "In order to define a property, getter %s must have zero "
1850 "parameters or a single ScriptableObject parameter.")
1852 (js2-msg "msg.obj.getter.parms"
1853 "Expected static or delegated getter %s to take "
1854 "a ScriptableObject parameter.")
1856 (js2-msg "msg.getter.static"
1857 "Getter and setter must both be static or neither be static.")
1859 (js2-msg "msg.setter.return"
1860 "Setter must have void return type: %s")
1862 (js2-msg "msg.setter2.parms"
1863 "Two-parameter setter must take a ScriptableObject as "
1864 "its first parameter.")
1866 (js2-msg "msg.setter1.parms"
1867 "Expected single parameter setter for %s")
1869 (js2-msg "msg.setter2.expected"
1870 "Expected static or delegated setter %s to take two parameters.")
1872 (js2-msg "msg.setter.parms"
1873 "Expected either one or two parameters for setter.")
1875 (js2-msg "msg.setter.bad.type"
1876 "Unsupported parameter type '%s' in setter '%s'.")
1878 (js2-msg "msg.add.sealed"
1879 "Cannot add a property to a sealed object: %s.")
1881 (js2-msg "msg.remove.sealed"
1882 "Cannot remove a property from a sealed object: %s.")
1884 (js2-msg "msg.modify.sealed"
1885 "Cannot modify a property of a sealed object: %s.")
1887 (js2-msg "msg.modify.readonly"
1888 "Cannot modify readonly property: %s.")
1891 (js2-msg "msg.missing.exponent"
1894 (js2-msg "msg.caught.nfe"
1895 "number format error")
1897 (js2-msg "msg.unterminated.string.lit"
1898 "unterminated string literal")
1900 (js2-msg "msg.unterminated.comment"
1901 "unterminated comment")
1903 (js2-msg "msg.unterminated.re.lit"
1904 "unterminated regular expression literal")
1906 (js2-msg "msg.invalid.re.flag"
1907 "invalid flag after regular expression")
1909 (js2-msg "msg.no.re.input.for"
1912 (js2-msg "msg.illegal.character"
1913 "illegal character")
1915 (js2-msg "msg.invalid.escape"
1916 "invalid Unicode escape sequence")
1918 (js2-msg "msg.bad.namespace"
1919 "not a valid default namespace statement. "
1920 "Syntax is: default xml namespace = EXPRESSION;")
1922 ;; TokensStream warnings
1923 (js2-msg "msg.bad.octal.literal"
1924 "illegal octal literal digit %s; "
1925 "interpreting it as a decimal digit")
1927 (js2-msg "msg.missing.hex.digits"
1928 "missing hexadecimal digits after '0x'")
1930 (js2-msg "msg.missing.binary.digits"
1931 "missing binary digits after '0b'")
1933 (js2-msg "msg.missing.octal.digits"
1934 "missing octal digits after '0o'")
1936 (js2-msg "msg.script.is.not.constructor"
1937 "Script objects are not constructors.")
1940 (js2-msg "msg.arraylength.bad"
1941 "Inappropriate array length.")
1944 (js2-msg "msg.arraylength.too.big"
1945 "Array length %s exceeds supported capacity limit.")
1948 (js2-msg "msg.bad.uri"
1949 "Malformed URI sequence.")
1952 (js2-msg "msg.bad.precision"
1953 "Precision %s out of range.")
1956 (js2-msg "msg.send.newborn"
1957 "Attempt to send value to newborn generator")
1959 (js2-msg "msg.already.exec.gen"
1960 "Already executing generator")
1962 (js2-msg "msg.StopIteration.invalid"
1963 "StopIteration may not be changed to an arbitrary object.")
1966 (js2-msg "msg.yield.closing"
1967 "Yield from closing generator")
1970 (js2-msg "msg.unnamed.class.stmt" ; added by js2-mode
1971 "class statement requires a name")
1973 (js2-msg "msg.class.unexpected.comma" ; added by js2-mode
1974 "unexpected ',' between class properties")
1976 (js2-msg "msg.unexpected.static" ; added by js2-mode
1977 "unexpected 'static'")
1979 (js2-msg "msg.missing.extends" ; added by js2-mode
1980 "name is required after extends")
1982 (js2-msg "msg.no.brace.class" ; added by js2-mode
1983 "missing '{' before class body")
1985 (js2-msg "msg.missing.computed.rb" ; added by js2-mode
1986 "missing ']' after computed property expression")
1990 (defconst js2-ti-max-lookahead 2)
1991 (defconst js2-ti-ntokens (1+ js2-ti-max-lookahead))
1993 (defun js2-new-token (offset)
1994 (let ((token (make-js2-token (+ offset js2-ts-cursor))))
1995 (setq js2-ti-tokens-cursor (mod (1+ js2-ti-tokens-cursor) js2-ti-ntokens))
1996 (aset js2-ti-tokens js2-ti-tokens-cursor token)
1999 (defsubst js2-current-token ()
2000 (aref js2-ti-tokens js2-ti-tokens-cursor))
2002 (defsubst js2-current-token-string ()
2003 (js2-token-string (js2-current-token)))
2005 (defsubst js2-current-token-type ()
2006 (js2-token-type (js2-current-token)))
2008 (defsubst js2-current-token-beg ()
2009 (js2-token-beg (js2-current-token)))
2011 (defsubst js2-current-token-end ()
2012 (js2-token-end (js2-current-token)))
2014 (defun js2-current-token-len ()
2015 (let ((token (js2-current-token)))
2016 (- (js2-token-end token)
2017 (js2-token-beg token))))
2019 (defun js2-ts-seek (state)
2020 (setq js2-ts-lineno (js2-ts-state-lineno state)
2021 js2-ts-cursor (js2-ts-state-cursor state)
2022 js2-ti-tokens (js2-ts-state-tokens state)
2023 js2-ti-tokens-cursor (js2-ts-state-tokens-cursor state)
2024 js2-ti-lookahead (js2-ts-state-lookahead state)))
2028 (defun js2-delete-if (predicate list)
2029 "Remove all items satisfying PREDICATE in LIST."
2030 (cl-loop for item in list
2031 if (not (funcall predicate item))
2034 (defun js2-position (element list)
2035 "Find 0-indexed position of ELEMENT in LIST comparing with `eq'.
2036 Returns nil if element is not found in the list."
2039 (while (and list (not found))
2040 (if (eq element (car list))
2042 (setq count (1+ count)
2046 (defun js2-find-if (predicate list)
2047 "Find first item satisfying PREDICATE in LIST."
2049 (while (and list (not result))
2050 (if (funcall predicate (car list))
2051 (setq result (car list)))
2052 (setq list (cdr list)))
2055 (defmacro js2-time (form)
2056 "Evaluate FORM, discard result, and return elapsed time in sec."
2058 (let ((beg (make-symbol "--js2-time-beg--")))
2059 `(let ((,beg (current-time)))
2061 (/ (truncate (* (- (float-time (current-time))
2066 (defsubst js2-same-line (pos)
2067 "Return t if POS is on the same line as current point."
2068 (and (>= pos (point-at-bol))
2069 (<= pos (point-at-eol))))
2071 (defun js2-code-bug ()
2072 "Signal an error when we encounter an unexpected code path."
2073 (error "failed assertion"))
2075 (defsubst js2-record-text-property (beg end prop value)
2076 "Record a text property to set when parsing finishes."
2077 (push (list beg end prop value) js2-mode-deferred-properties))
2079 ;; I'd like to associate errors with nodes, but for now the
2080 ;; easiest thing to do is get the context info from the last token.
2081 (defun js2-record-parse-error (msg &optional arg pos len)
2082 (push (list (list msg arg)
2083 (or pos (js2-current-token-beg))
2084 (or len (js2-current-token-len)))
2087 (defun js2-report-error (msg &optional msg-arg pos len)
2088 "Signal a syntax error or record a parse error."
2089 (if js2-recover-from-parse-errors
2090 (js2-record-parse-error msg msg-arg pos len)
2091 (signal 'js2-syntax-error
2095 (goto-char js2-ts-cursor)
2099 (defun js2-report-warning (msg &optional msg-arg pos len face)
2100 (if js2-compiler-report-warning-as-error
2101 (js2-report-error msg msg-arg pos len)
2102 (push (list (list msg msg-arg)
2103 (or pos (js2-current-token-beg))
2104 (or len (js2-current-token-len))
2106 js2-parsed-warnings)))
2108 (defun js2-add-strict-warning (msg-id &optional msg-arg beg end)
2109 (if js2-compiler-strict-mode
2110 (js2-report-warning msg-id msg-arg beg
2111 (and beg end (- end beg)))))
2113 (put 'js2-syntax-error 'error-conditions
2114 '(error syntax-error js2-syntax-error))
2115 (put 'js2-syntax-error 'error-message "Syntax error")
2117 (put 'js2-parse-error 'error-conditions
2118 '(error parse-error js2-parse-error))
2119 (put 'js2-parse-error 'error-message "Parse error")
2121 (defmacro js2-clear-flag (flags flag)
2122 `(setq ,flags (logand ,flags (lognot ,flag))))
2124 (defmacro js2-set-flag (flags flag)
2125 "Logical-or FLAG into FLAGS."
2126 `(setq ,flags (logior ,flags ,flag)))
2128 (defsubst js2-flag-set-p (flags flag)
2129 (/= 0 (logand flags flag)))
2131 (defsubst js2-flag-not-set-p (flags flag)
2132 (zerop (logand flags flag)))
2134 ;;; AST struct and function definitions
2136 ;; flags for ast node property 'member-type (used for e4x operators)
2137 (defvar js2-property-flag #x1 "Property access: element is valid name.")
2138 (defvar js2-attribute-flag #x2 "x.@y or x..@y.")
2139 (defvar js2-descendants-flag #x4 "x..y or x..@i.")
2141 (defsubst js2-relpos (pos anchor)
2142 "Convert POS to be relative to ANCHOR.
2143 If POS is nil, returns nil."
2144 (and pos (- pos anchor)))
2146 (defun js2-make-pad (indent)
2149 (make-string (* indent js2-basic-offset) ? )))
2151 (defun js2-visit-ast (node callback)
2152 "Visit every node in ast NODE with visitor CALLBACK.
2154 CALLBACK is a function that takes two arguments: (NODE END-P). It is
2155 called twice: once to visit the node, and again after all the node's
2156 children have been processed. The END-P argument is nil on the first
2157 call and non-nil on the second call. The return value of the callback
2158 affects the traversal: if non-nil, the children of NODE are processed.
2159 If the callback returns nil, or if the node has no children, then the
2160 callback is called immediately with a non-nil END-P argument.
2162 The node traversal is approximately lexical-order, although there
2163 are currently no guarantees around this."
2165 (let ((vfunc (get (aref node 0) 'js2-visitor)))
2167 (when (funcall callback node nil)
2170 ((eq vfunc 'js2-visit-none)
2171 nil) ; don't even bother calling it
2172 ;; Each AST node type has to define a `js2-visitor' function
2173 ;; that takes a node and a callback, and calls `js2-visit-ast'
2174 ;; on each child of the node.
2176 (funcall vfunc node callback))
2178 (error "%s does not define a visitor-traversal function"
2180 ;; call the end-visit
2181 (funcall callback node t))))
2183 (cl-defstruct (js2-node
2184 (:constructor nil)) ; abstract
2185 "Base AST node type."
2186 (type -1) ; token type
2187 (pos -1) ; start position of this AST node in parsed input
2188 (len 1) ; num characters spanned by the node
2189 props ; optional node property list (an alist)
2190 parent) ; link to parent node; null for root
2192 (defsubst js2-node-get-prop (node prop &optional default)
2193 (or (cadr (assoc prop (js2-node-props node))) default))
2195 (defsubst js2-node-set-prop (node prop value)
2196 (setf (js2-node-props node)
2197 (cons (list prop value) (js2-node-props node))))
2199 (defun js2-fixup-starts (n nodes)
2200 "Adjust the start positions of NODES to be relative to N.
2201 Any node in the list may be nil, for convenience."
2202 (dolist (node nodes)
2204 (setf (js2-node-pos node) (- (js2-node-pos node)
2205 (js2-node-pos n))))))
2207 (defun js2-node-add-children (parent &rest nodes)
2208 "Set parent node of NODES to PARENT, and return PARENT.
2209 Does nothing if we're not recording parent links.
2210 If any given node in NODES is nil, doesn't record that link."
2211 (js2-fixup-starts parent nodes)
2212 (dolist (node nodes)
2214 (setf (js2-node-parent node) parent))))
2216 ;; Non-recursive since it's called a frightening number of times.
2217 (defun js2-node-abs-pos (n)
2218 (let ((pos (js2-node-pos n)))
2219 (while (setq n (js2-node-parent n))
2220 (setq pos (+ pos (js2-node-pos n))))
2223 (defsubst js2-node-abs-end (n)
2224 "Return absolute buffer position of end of N."
2225 (+ (js2-node-abs-pos n) (js2-node-len n)))
2227 ;; It's important to make sure block nodes have a Lisp list for the
2228 ;; child nodes, to limit printing recursion depth in an AST that
2229 ;; otherwise consists of defstruct vectors. Emacs will crash printing
2230 ;; a sufficiently large vector tree.
2232 (cl-defstruct (js2-block-node
2235 (:constructor make-js2-block-node (&key (type js2-BLOCK)
2236 (pos (js2-current-token-beg))
2240 "A block of statements."
2241 kids) ; a Lisp list of the child statement nodes
2243 (put 'cl-struct-js2-block-node 'js2-visitor 'js2-visit-block)
2244 (put 'cl-struct-js2-block-node 'js2-printer 'js2-print-block)
2246 (defun js2-visit-block (ast callback)
2247 "Visit the `js2-block-node' children of AST."
2248 (dolist (kid (js2-block-node-kids ast))
2249 (js2-visit-ast kid callback)))
2251 (defun js2-print-block (n i)
2252 (let ((pad (js2-make-pad i)))
2254 (dolist (kid (js2-block-node-kids n))
2255 (js2-print-ast kid (1+ i)))
2258 (cl-defstruct (js2-scope
2259 (:include js2-block-node)
2261 (:constructor make-js2-scope (&key (type js2-BLOCK)
2262 (pos (js2-current-token-beg))
2265 ;; The symbol-table is a LinkedHashMap<String,Symbol> in Rhino.
2266 ;; I don't have one of those handy, so I'll use an alist for now.
2267 ;; It's as fast as an emacs hashtable for up to about 50 elements,
2268 ;; and is much lighter-weight to construct (both CPU and mem).
2269 ;; The keys are interned strings (symbols) for faster lookup.
2270 ;; Should switch to hybrid alist/hashtable eventually.
2271 symbol-table ; an alist of (symbol . js2-symbol)
2272 parent-scope ; a `js2-scope'
2273 top) ; top-level `js2-scope' (script/function)
2275 (put 'cl-struct-js2-scope 'js2-visitor 'js2-visit-block)
2276 (put 'cl-struct-js2-scope 'js2-printer 'js2-print-none)
2278 (defun js2-node-get-enclosing-scope (node)
2279 "Return the innermost `js2-scope' node surrounding NODE.
2280 Returns nil if there is no enclosing scope node."
2281 (while (and (setq node (js2-node-parent node))
2282 (not (js2-scope-p node))))
2285 (defun js2-get-defining-scope (scope name &optional point)
2286 "Search up scope chain from SCOPE looking for NAME, a string or symbol.
2287 Returns `js2-scope' in which NAME is defined, or nil if not found.
2289 If POINT is non-nil, and if the found declaration type is
2290 `js2-LET', also check that the declaration node is before POINT."
2291 (let ((sym (if (symbolp name)
2296 (while (and scope continue)
2298 (let ((entry (cdr (assq sym (js2-scope-symbol-table scope)))))
2301 (not (eq js2-LET (js2-symbol-decl-type entry)))
2303 (js2-node-abs-pos (js2-symbol-ast-node entry))))))
2304 (and (eq sym 'arguments)
2305 (js2-function-node-p scope)))
2308 (setq scope (js2-scope-parent-scope scope))))
2311 (defun js2-scope-get-symbol (scope name)
2312 "Return symbol table entry for NAME in SCOPE.
2313 NAME can be a string or symbol. Returns a `js2-symbol' or nil if not found."
2314 (and (js2-scope-symbol-table scope)
2315 (cdr (assq (if (symbolp name)
2318 (js2-scope-symbol-table scope)))))
2320 (defun js2-scope-put-symbol (scope name symbol)
2321 "Enter SYMBOL into symbol-table for SCOPE under NAME.
2322 NAME can be a Lisp symbol or string. SYMBOL is a `js2-symbol'."
2323 (let* ((table (js2-scope-symbol-table scope))
2324 (sym (if (symbolp name) name (intern name)))
2325 (entry (assq sym table)))
2327 (setcdr entry symbol)
2328 (push (cons sym symbol)
2329 (js2-scope-symbol-table scope)))))
2331 (cl-defstruct (js2-symbol
2333 (:constructor make-js2-symbol (decl-type name &optional ast-node)))
2334 "A symbol table entry."
2335 ;; One of js2-FUNCTION, js2-LP (for parameters), js2-VAR,
2336 ;; js2-LET, or js2-CONST
2339 ast-node) ; a `js2-node'
2341 (cl-defstruct (js2-error-node
2343 (:constructor nil) ; silence emacs21 byte-compiler
2344 (:constructor make-js2-error-node (&key (type js2-ERROR)
2345 (pos (js2-current-token-beg))
2347 "AST node representing a parse error.")
2349 (put 'cl-struct-js2-error-node 'js2-visitor 'js2-visit-none)
2350 (put 'cl-struct-js2-error-node 'js2-printer 'js2-print-none)
2352 (cl-defstruct (js2-script-node
2353 (:include js2-scope)
2355 (:constructor make-js2-script-node (&key (type js2-SCRIPT)
2356 (pos (js2-current-token-beg))
2358 ;; FIXME: What are those?
2361 functions ; Lisp list of nested functions
2362 regexps ; Lisp list of (string . flags)
2363 symbols ; alist (every symbol gets unique index)
2365 var-names ; vector of string names
2366 consts ; bool-vector matching var-decls
2367 (temp-number 0)) ; for generating temp variables
2369 (put 'cl-struct-js2-script-node 'js2-visitor 'js2-visit-block)
2370 (put 'cl-struct-js2-script-node 'js2-printer 'js2-print-script)
2372 (defun js2-print-script (node indent)
2373 (dolist (kid (js2-block-node-kids node))
2374 (js2-print-ast kid indent)))
2376 (cl-defstruct (js2-ast-root
2377 (:include js2-script-node)
2379 (:constructor make-js2-ast-root (&key (type js2-SCRIPT)
2380 (pos (js2-current-token-beg))
2383 "The root node of a js2 AST."
2384 buffer ; the source buffer from which the code was parsed
2385 comments ; a Lisp list of comments, ordered by start position
2386 errors ; a Lisp list of errors found during parsing
2387 warnings ; a Lisp list of warnings found during parsing
2388 node-count) ; number of nodes in the tree, including the root
2390 (put 'cl-struct-js2-ast-root 'js2-visitor 'js2-visit-ast-root)
2391 (put 'cl-struct-js2-ast-root 'js2-printer 'js2-print-script)
2393 (defun js2-visit-ast-root (ast callback)
2394 (dolist (kid (js2-ast-root-kids ast))
2395 (js2-visit-ast kid callback))
2396 (dolist (comment (js2-ast-root-comments ast))
2397 (js2-visit-ast comment callback)))
2399 (cl-defstruct (js2-comment-node
2402 (:constructor make-js2-comment-node (&key (type js2-COMMENT)
2403 (pos (js2-current-token-beg))
2406 format) ; 'line, 'block, 'jsdoc or 'html
2408 (put 'cl-struct-js2-comment-node 'js2-visitor 'js2-visit-none)
2409 (put 'cl-struct-js2-comment-node 'js2-printer 'js2-print-comment)
2411 (defun js2-print-comment (n i)
2412 ;; We really ought to link end-of-line comments to their nodes.
2413 ;; Or maybe we could add a new comment type, 'endline.
2414 (insert (js2-make-pad i)
2415 (js2-node-string n)))
2417 (cl-defstruct (js2-expr-stmt-node
2420 (:constructor make-js2-expr-stmt-node (&key (type js2-EXPR_VOID)
2424 "An expression statement."
2427 (defsubst js2-expr-stmt-node-set-has-result (node)
2428 "Change NODE type to `js2-EXPR_RESULT'. Used for code generation."
2429 (setf (js2-node-type node) js2-EXPR_RESULT))
2431 (put 'cl-struct-js2-expr-stmt-node 'js2-visitor 'js2-visit-expr-stmt-node)
2432 (put 'cl-struct-js2-expr-stmt-node 'js2-printer 'js2-print-expr-stmt-node)
2434 (defun js2-visit-expr-stmt-node (n v)
2435 (js2-visit-ast (js2-expr-stmt-node-expr n) v))
2437 (defun js2-print-expr-stmt-node (n indent)
2438 (js2-print-ast (js2-expr-stmt-node-expr n) indent)
2441 (cl-defstruct (js2-loop-node
2442 (:include js2-scope)
2444 "Abstract supertype of loop nodes."
2445 body ; a `js2-block-node'
2446 lp ; position of left-paren, nil if omitted
2447 rp) ; position of right-paren, nil if omitted
2449 (cl-defstruct (js2-do-node
2450 (:include js2-loop-node)
2452 (:constructor make-js2-do-node (&key (type js2-DO)
2453 (pos (js2-current-token-beg))
2460 "AST node for do-loop."
2461 condition ; while (expression)
2462 while-pos) ; buffer position of 'while' keyword
2464 (put 'cl-struct-js2-do-node 'js2-visitor 'js2-visit-do-node)
2465 (put 'cl-struct-js2-do-node 'js2-printer 'js2-print-do-node)
2467 (defun js2-visit-do-node (n v)
2468 (js2-visit-ast (js2-do-node-body n) v)
2469 (js2-visit-ast (js2-do-node-condition n) v))
2471 (defun js2-print-do-node (n i)
2472 (let ((pad (js2-make-pad i)))
2473 (insert pad "do {\n")
2474 (dolist (kid (js2-block-node-kids (js2-do-node-body n)))
2475 (js2-print-ast kid (1+ i)))
2476 (insert pad "} while (")
2477 (js2-print-ast (js2-do-node-condition n) 0)
2480 (cl-defstruct (js2-export-node
2483 (:constructor make-js2-export-node (&key (type js2-EXPORT)
2484 (pos (js2-current-token-beg))
2490 "AST node for an export statement. There are many things that can be exported,
2491 so many of its properties will be nil.
2493 exports-list ; lisp list of js2-export-binding-node to export
2494 from-clause ; js2-from-clause-node for re-exporting symbols from another module
2495 declaration ; js2-var-decl-node (var, let, const) or js2-class-node
2496 default) ; js2-function-node or js2-assign-node
2498 (put 'cl-struct-js2-export-node 'js2-visitor 'js2-visit-export-node)
2499 (put 'cl-struct-js2-export-node 'js2-printer 'js2-print-export-node)
2501 (defun js2-visit-export-node (n v)
2502 (let ((exports-list (js2-export-node-exports-list n))
2503 (from (js2-export-node-from-clause n))
2504 (declaration (js2-export-node-declaration n))
2505 (default (js2-export-node-default n)))
2507 (dolist (export exports-list)
2508 (js2-visit-ast export v)))
2510 (js2-visit-ast from v))
2512 (js2-visit-ast declaration v))
2514 (js2-visit-ast default v))))
2516 (defun js2-print-export-node (n i)
2517 (let ((pad (js2-make-pad i))
2518 (exports-list (js2-export-node-exports-list n))
2519 (from (js2-export-node-from-clause n))
2520 (declaration (js2-export-node-declaration n))
2521 (default (js2-export-node-default n)))
2522 (insert pad "export ")
2526 (js2-print-ast default i))
2528 (js2-print-ast declaration i))
2529 ((and exports-list from)
2530 (js2-print-named-imports exports-list)
2532 (js2-print-from-clause from))
2535 (js2-print-from-clause from))
2537 (js2-print-named-imports exports-list)))
2540 (cl-defstruct (js2-while-node
2541 (:include js2-loop-node)
2543 (:constructor make-js2-while-node (&key (type js2-WHILE)
2544 (pos (js2-current-token-beg))
2548 "AST node for while-loop."
2549 condition) ; while-condition
2551 (put 'cl-struct-js2-while-node 'js2-visitor 'js2-visit-while-node)
2552 (put 'cl-struct-js2-while-node 'js2-printer 'js2-print-while-node)
2554 (defun js2-visit-while-node (n v)
2555 (js2-visit-ast (js2-while-node-condition n) v)
2556 (js2-visit-ast (js2-while-node-body n) v))
2558 (defun js2-print-while-node (n i)
2559 (let ((pad (js2-make-pad i)))
2560 (insert pad "while (")
2561 (js2-print-ast (js2-while-node-condition n) 0)
2563 (js2-print-body (js2-while-node-body n) (1+ i))
2564 (insert pad "}\n")))
2566 (cl-defstruct (js2-for-node
2567 (:include js2-loop-node)
2569 (:constructor make-js2-for-node (&key (type js2-FOR)
2574 "AST node for a C-style for-loop."
2575 init ; initialization expression
2576 condition ; loop condition
2577 update) ; update clause
2579 (put 'cl-struct-js2-for-node 'js2-visitor 'js2-visit-for-node)
2580 (put 'cl-struct-js2-for-node 'js2-printer 'js2-print-for-node)
2582 (defun js2-visit-for-node (n v)
2583 (js2-visit-ast (js2-for-node-init n) v)
2584 (js2-visit-ast (js2-for-node-condition n) v)
2585 (js2-visit-ast (js2-for-node-update n) v)
2586 (js2-visit-ast (js2-for-node-body n) v))
2588 (defun js2-print-for-node (n i)
2589 (let ((pad (js2-make-pad i)))
2590 (insert pad "for (")
2591 (js2-print-ast (js2-for-node-init n) 0)
2593 (js2-print-ast (js2-for-node-condition n) 0)
2595 (js2-print-ast (js2-for-node-update n) 0)
2597 (js2-print-body (js2-for-node-body n) (1+ i))
2598 (insert pad "}\n")))
2600 (cl-defstruct (js2-for-in-node
2601 (:include js2-loop-node)
2603 (:constructor make-js2-for-in-node (&key (type js2-FOR)
2612 "AST node for a for..in loop."
2613 iterator ; [var] foo in ...
2614 object ; object over which we're iterating
2615 in-pos ; buffer position of 'in' keyword
2616 each-pos ; buffer position of 'each' keyword, if foreach-p
2617 foreach-p ; t if it's a for-each loop
2618 forof-p) ; t if it's a for-of loop
2620 (put 'cl-struct-js2-for-in-node 'js2-visitor 'js2-visit-for-in-node)
2621 (put 'cl-struct-js2-for-in-node 'js2-printer 'js2-print-for-in-node)
2623 (defun js2-visit-for-in-node (n v)
2624 (js2-visit-ast (js2-for-in-node-iterator n) v)
2625 (js2-visit-ast (js2-for-in-node-object n) v)
2626 (js2-visit-ast (js2-for-in-node-body n) v))
2628 (defun js2-print-for-in-node (n i)
2629 (let ((pad (js2-make-pad i))
2630 (foreach (js2-for-in-node-foreach-p n))
2631 (forof (js2-for-in-node-forof-p n)))
2636 (js2-print-ast (js2-for-in-node-iterator n) 0)
2637 (insert (if forof " of " " in "))
2638 (js2-print-ast (js2-for-in-node-object n) 0)
2640 (js2-print-body (js2-for-in-node-body n) (1+ i))
2641 (insert pad "}\n")))
2643 (cl-defstruct (js2-return-node
2646 (:constructor make-js2-return-node (&key (type js2-RETURN)
2650 "AST node for a return statement."
2651 retval) ; expression to return, or 'undefined
2653 (put 'cl-struct-js2-return-node 'js2-visitor 'js2-visit-return-node)
2654 (put 'cl-struct-js2-return-node 'js2-printer 'js2-print-return-node)
2656 (defun js2-visit-return-node (n v)
2657 (js2-visit-ast (js2-return-node-retval n) v))
2659 (defun js2-print-return-node (n i)
2660 (insert (js2-make-pad i) "return")
2661 (when (js2-return-node-retval n)
2663 (js2-print-ast (js2-return-node-retval n) 0))
2666 (cl-defstruct (js2-if-node
2669 (:constructor make-js2-if-node (&key (type js2-IF)
2676 "AST node for an if-statement."
2677 condition ; expression
2678 then-part ; statement or block
2679 else-pos ; optional buffer position of 'else' keyword
2680 else-part ; optional statement or block
2681 lp ; position of left-paren, nil if omitted
2682 rp) ; position of right-paren, nil if omitted
2684 (put 'cl-struct-js2-if-node 'js2-visitor 'js2-visit-if-node)
2685 (put 'cl-struct-js2-if-node 'js2-printer 'js2-print-if-node)
2687 (defun js2-visit-if-node (n v)
2688 (js2-visit-ast (js2-if-node-condition n) v)
2689 (js2-visit-ast (js2-if-node-then-part n) v)
2690 (js2-visit-ast (js2-if-node-else-part n) v))
2692 (defun js2-print-if-node (n i)
2693 (let ((pad (js2-make-pad i))
2694 (then-part (js2-if-node-then-part n))
2695 (else-part (js2-if-node-else-part n)))
2697 (js2-print-ast (js2-if-node-condition n) 0)
2699 (js2-print-body then-part (1+ i))
2704 ((js2-if-node-p else-part)
2706 (js2-print-body else-part i))
2708 (insert " else {\n")
2709 (js2-print-body else-part (1+ i))
2710 (insert pad "}\n")))))
2712 (cl-defstruct (js2-export-binding-node
2715 (:constructor make-js2-export-binding-node (&key (type -1)
2720 "AST node for an external symbol binding.
2721 It contains a local-name node which is the name of the value in the
2722 current scope, and extern-name which is the name of the value in the
2723 imported or exported scope. By default these are the same, but if the
2724 name is aliased as in {foo as bar}, it would have an extern-name node
2725 containing 'foo' and a local-name node containing 'bar'."
2726 local-name ; js2-name-node with the variable name in this scope
2727 extern-name) ; js2-name-node with the value name in the exporting module
2729 (put 'cl-struct-js2-export-binding-node 'js2-printer 'js2-print-extern-binding)
2730 (put 'cl-struct-js2-export-binding-node 'js2-visitor 'js2-visit-extern-binding)
2732 (defun js2-visit-extern-binding (n v)
2733 "Visit an extern binding node. First visit the local-name, and, if
2734 different, visit the extern-name."
2735 (let ((local-name (js2-export-binding-node-local-name n))
2736 (extern-name (js2-export-binding-node-extern-name n)))
2738 (js2-visit-ast local-name v))
2739 (when (not (equal local-name extern-name))
2740 (js2-visit-ast extern-name v))))
2742 (defun js2-print-extern-binding (n _i)
2743 "Print a representation of a single extern binding. E.g. 'foo' or
2745 (let ((local-name (js2-export-binding-node-local-name n))
2746 (extern-name (js2-export-binding-node-extern-name n)))
2747 (insert (js2-name-node-name extern-name))
2748 (when (not (equal local-name extern-name))
2750 (insert (js2-name-node-name local-name)))))
2753 (cl-defstruct (js2-import-node
2756 (:constructor make-js2-import-node (&key (type js2-IMPORT)
2757 (pos (js2-current-token-beg))
2762 "AST node for an import statement. It follows the form
2764 import ModuleSpecifier;
2765 import ImportClause FromClause;"
2766 import ; js2-import-clause-node specifying which names are to imported.
2767 from ; js2-from-clause-node indicating the module from which to import.
2768 module-id) ; module-id of the import. E.g. 'src/mylib'.
2770 (put 'cl-struct-js2-import-node 'js2-printer 'js2-print-import)
2771 (put 'cl-struct-js2-import-node 'js2-visitor 'js2-visit-import)
2773 (defun js2-visit-import (n v)
2774 (let ((import-clause (js2-import-node-import n))
2775 (from-clause (js2-import-node-from n)))
2777 (js2-visit-ast import-clause v))
2779 (js2-visit-ast from-clause v))))
2781 (defun js2-print-import (n i)
2782 "Prints a representation of the import node"
2783 (let ((pad (js2-make-pad i))
2784 (import-clause (js2-import-node-import n))
2785 (from-clause (js2-import-node-from n))
2786 (module-id (js2-import-node-module-id n)))
2787 (insert pad "import ")
2790 (js2-print-import-clause import-clause)
2792 (js2-print-from-clause from-clause))
2798 (cl-defstruct (js2-import-clause-node
2801 (:constructor make-js2-import-clause-node (&key (type -1)
2807 "AST node corresponding to the import clause of an import statement. This is
2808 the portion of the import that bindings names from the external context to the
2810 namespace-import ; js2-namespace-import-node. E.g. '* as lib'
2811 named-imports ; lisp list of js2-export-binding-node for all named imports.
2812 default-binding) ; js2-export-binding-node for the default import binding
2814 (put 'cl-struct-js2-import-clause-node 'js2-visitor 'js2-visit-import-clause)
2815 (put 'cl-struct-js2-import-clause-node 'js2-printer 'js2-print-import-clause)
2817 (defun js2-visit-import-clause (n v)
2818 (let ((ns-import (js2-import-clause-node-namespace-import n))
2819 (named-imports (js2-import-clause-node-named-imports n))
2820 (default (js2-import-clause-node-default-binding n)))
2822 (js2-visit-ast ns-import v))
2824 (dolist (import named-imports)
2825 (js2-visit-ast import v)))
2827 (js2-visit-ast default v))))
2829 (defun js2-print-import-clause (n)
2830 (let ((ns-import (js2-import-clause-node-namespace-import n))
2831 (named-imports (js2-import-clause-node-named-imports n))
2832 (default (js2-import-clause-node-default-binding n)))
2834 ((and default ns-import)
2835 (js2-print-ast default)
2837 (js2-print-namespace-import ns-import))
2838 ((and default named-imports)
2839 (js2-print-ast default)
2841 (js2-print-named-imports named-imports))
2843 (js2-print-ast default))
2845 (js2-print-namespace-import ns-import))
2847 (js2-print-named-imports named-imports)))))
2849 (defun js2-print-namespace-import (node)
2851 (insert (js2-name-node-name (js2-namespace-import-node-name node))))
2853 (defun js2-print-named-imports (imports)
2855 (let ((len (length imports))
2858 (js2-print-extern-binding (nth n imports) 0)
2859 (unless (= n (- len 1))
2864 (cl-defstruct (js2-namespace-import-node
2867 (:constructor make-js2-namespace-import-node (&key (type -1)
2871 "AST node for a complete namespace import.
2872 E.g. the '* as lib' expression in:
2874 import * as lib from 'src/lib'
2876 It contains a single name node referring to the bound name."
2877 name) ; js2-name-node of the bound name.
2879 (defun js2-visit-namespace-import (n v)
2880 (js2-visit-ast (js2-namespace-import-node-name n) v))
2882 (put 'cl-struct-js2-namespace-import-node 'js2-visitor 'js2-visit-namespace-import)
2883 (put 'cl-struct-js2-namespace-import-node 'js2-printer 'js2-print-namespace-import)
2885 (cl-defstruct (js2-from-clause-node
2888 (:constructor make-js2-from-clause-node (&key (type js2-NAME)
2893 "AST node for the from clause in an import or export statement.
2894 E.g. from 'my/module'. It can refere to either an external module, or to the
2895 modules metadata itself."
2896 module-id ; string containing the module specifier.
2897 metadata-p) ; true if this clause refers to the module's metadata
2899 (put 'cl-struct-js2-from-clause-node 'js2-visitor 'js2-visit-none)
2900 (put 'cl-struct-js2-from-clause-node 'js2-printer 'js2-print-from-clause)
2902 (defun js2-print-from-clause (n)
2904 (if (js2-from-clause-node-metadata-p n)
2905 (insert "this module")
2907 (insert (js2-from-clause-node-module-id n))
2910 (cl-defstruct (js2-try-node
2913 (:constructor make-js2-try-node (&key (type js2-TRY)
2919 "AST node for a try-statement."
2921 catch-clauses ; a Lisp list of `js2-catch-node'
2922 finally-block) ; a `js2-finally-node'
2924 (put 'cl-struct-js2-try-node 'js2-visitor 'js2-visit-try-node)
2925 (put 'cl-struct-js2-try-node 'js2-printer 'js2-print-try-node)
2927 (defun js2-visit-try-node (n v)
2928 (js2-visit-ast (js2-try-node-try-block n) v)
2929 (dolist (clause (js2-try-node-catch-clauses n))
2930 (js2-visit-ast clause v))
2931 (js2-visit-ast (js2-try-node-finally-block n) v))
2933 (defun js2-print-try-node (n i)
2934 (let ((pad (js2-make-pad i))
2935 (catches (js2-try-node-catch-clauses n))
2936 (finally (js2-try-node-finally-block n)))
2937 (insert pad "try {\n")
2938 (js2-print-body (js2-try-node-try-block n) (1+ i))
2941 (dolist (catch catches)
2942 (js2-print-ast catch i)))
2944 (js2-print-ast finally i)
2947 (cl-defstruct (js2-catch-node
2948 (:include js2-scope)
2950 (:constructor make-js2-catch-node (&key (type js2-CATCH)
2957 "AST node for a catch clause."
2958 param ; destructuring form or simple name node
2959 guard-kwd ; relative buffer position of "if" in "catch (x if ...)"
2960 guard-expr ; catch condition, a `js2-node'
2961 lp ; buffer position of left-paren, nil if omitted
2962 rp) ; buffer position of right-paren, nil if omitted
2964 (put 'cl-struct-js2-catch-node 'js2-visitor 'js2-visit-catch-node)
2965 (put 'cl-struct-js2-catch-node 'js2-printer 'js2-print-catch-node)
2967 (defun js2-visit-catch-node (n v)
2968 (js2-visit-ast (js2-catch-node-param n) v)
2969 (when (js2-catch-node-guard-kwd n)
2970 (js2-visit-ast (js2-catch-node-guard-expr n) v))
2971 (js2-visit-block n v))
2973 (defun js2-print-catch-node (n i)
2974 (let ((pad (js2-make-pad i))
2975 (guard-kwd (js2-catch-node-guard-kwd n))
2976 (guard-expr (js2-catch-node-guard-expr n)))
2978 (js2-print-ast (js2-catch-node-param n) 0)
2981 (js2-print-ast guard-expr 0))
2983 (js2-print-body n (1+ i))
2986 (cl-defstruct (js2-finally-node
2989 (:constructor make-js2-finally-node (&key (type js2-FINALLY)
2992 "AST node for a finally clause."
2993 body) ; a `js2-node', often but not always a block node
2995 (put 'cl-struct-js2-finally-node 'js2-visitor 'js2-visit-finally-node)
2996 (put 'cl-struct-js2-finally-node 'js2-printer 'js2-print-finally-node)
2998 (defun js2-visit-finally-node (n v)
2999 (js2-visit-ast (js2-finally-node-body n) v))
3001 (defun js2-print-finally-node (n i)
3002 (let ((pad (js2-make-pad i)))
3003 (insert " finally {\n")
3004 (js2-print-body (js2-finally-node-body n) (1+ i))
3005 (insert pad "}\n")))
3007 (cl-defstruct (js2-switch-node
3010 (:constructor make-js2-switch-node (&key (type js2-SWITCH)
3016 "AST node for a switch statement."
3017 discriminant ; a `js2-node' (switch expression)
3018 cases ; a Lisp list of `js2-case-node'
3019 lp ; position of open-paren for discriminant, nil if omitted
3020 rp) ; position of close-paren for discriminant, nil if omitted
3022 (put 'cl-struct-js2-switch-node 'js2-visitor 'js2-visit-switch-node)
3023 (put 'cl-struct-js2-switch-node 'js2-printer 'js2-print-switch-node)
3025 (defun js2-visit-switch-node (n v)
3026 (js2-visit-ast (js2-switch-node-discriminant n) v)
3027 (dolist (c (js2-switch-node-cases n))
3028 (js2-visit-ast c v)))
3030 (defun js2-print-switch-node (n i)
3031 (let ((pad (js2-make-pad i))
3032 (cases (js2-switch-node-cases n)))
3033 (insert pad "switch (")
3034 (js2-print-ast (js2-switch-node-discriminant n) 0)
3036 (dolist (case cases)
3037 (js2-print-ast case i))
3038 (insert pad "}\n")))
3040 (cl-defstruct (js2-case-node
3041 (:include js2-block-node)
3043 (:constructor make-js2-case-node (&key (type js2-CASE)
3046 "AST node for a case clause of a switch statement."
3047 expr) ; the case expression (nil for default)
3049 (put 'cl-struct-js2-case-node 'js2-visitor 'js2-visit-case-node)
3050 (put 'cl-struct-js2-case-node 'js2-printer 'js2-print-case-node)
3052 (defun js2-visit-case-node (n v)
3053 (js2-visit-ast (js2-case-node-expr n) v)
3054 (js2-visit-block n v))
3056 (defun js2-print-case-node (n i)
3057 (let ((pad (js2-make-pad i))
3058 (expr (js2-case-node-expr n)))
3061 (insert "default:\n")
3063 (js2-print-ast expr 0)
3065 (dolist (kid (js2-case-node-kids n))
3066 (js2-print-ast kid (1+ i)))))
3068 (cl-defstruct (js2-throw-node
3071 (:constructor make-js2-throw-node (&key (type js2-THROW)
3074 "AST node for a throw statement."
3075 expr) ; the expression to throw
3077 (put 'cl-struct-js2-throw-node 'js2-visitor 'js2-visit-throw-node)
3078 (put 'cl-struct-js2-throw-node 'js2-printer 'js2-print-throw-node)
3080 (defun js2-visit-throw-node (n v)
3081 (js2-visit-ast (js2-throw-node-expr n) v))
3083 (defun js2-print-throw-node (n i)
3084 (insert (js2-make-pad i) "throw ")
3085 (js2-print-ast (js2-throw-node-expr n) 0)
3088 (cl-defstruct (js2-with-node
3091 (:constructor make-js2-with-node (&key (type js2-WITH)
3095 "AST node for a with-statement."
3098 lp ; buffer position of left-paren around object, nil if omitted
3099 rp) ; buffer position of right-paren around object, nil if omitted
3101 (put 'cl-struct-js2-with-node 'js2-visitor 'js2-visit-with-node)
3102 (put 'cl-struct-js2-with-node 'js2-printer 'js2-print-with-node)
3104 (defun js2-visit-with-node (n v)
3105 (js2-visit-ast (js2-with-node-object n) v)
3106 (js2-visit-ast (js2-with-node-body n) v))
3108 (defun js2-print-with-node (n i)
3109 (let ((pad (js2-make-pad i)))
3110 (insert pad "with (")
3111 (js2-print-ast (js2-with-node-object n) 0)
3113 (js2-print-body (js2-with-node-body n) (1+ i))
3114 (insert pad "}\n")))
3116 (cl-defstruct (js2-label-node
3119 (:constructor make-js2-label-node (&key (type js2-LABEL)
3122 "AST node for a statement label or case label."
3124 loop) ; for validating and code-generating continue-to-label
3126 (put 'cl-struct-js2-label-node 'js2-visitor 'js2-visit-none)
3127 (put 'cl-struct-js2-label-node 'js2-printer 'js2-print-label)
3129 (defun js2-print-label (n i)
3130 (insert (js2-make-pad i)
3131 (js2-label-node-name n)
3134 (cl-defstruct (js2-labeled-stmt-node
3137 ;; type needs to be in `js2-side-effecting-tokens' to avoid spurious
3138 ;; no-side-effects warnings, hence js2-EXPR_RESULT.
3139 (:constructor make-js2-labeled-stmt-node (&key (type js2-EXPR_RESULT)
3142 "AST node for a statement with one or more labels.
3143 Multiple labels for a statement are collapsed into the labels field."
3144 labels ; Lisp list of `js2-label-node'
3145 stmt) ; the statement these labels are for
3147 (put 'cl-struct-js2-labeled-stmt-node 'js2-visitor 'js2-visit-labeled-stmt)
3148 (put 'cl-struct-js2-labeled-stmt-node 'js2-printer 'js2-print-labeled-stmt)
3150 (defun js2-get-label-by-name (lbl-stmt name)
3151 "Return a `js2-label-node' by NAME from LBL-STMT's labels list.
3152 Returns nil if no such label is in the list."
3153 (let ((label-list (js2-labeled-stmt-node-labels lbl-stmt))
3155 (while (and label-list (not result))
3156 (if (string= (js2-label-node-name (car label-list)) name)
3157 (setq result (car label-list))
3158 (setq label-list (cdr label-list))))
3161 (defun js2-visit-labeled-stmt (n v)
3162 (dolist (label (js2-labeled-stmt-node-labels n))
3163 (js2-visit-ast label v))
3164 (js2-visit-ast (js2-labeled-stmt-node-stmt n) v))
3166 (defun js2-print-labeled-stmt (n i)
3167 (dolist (label (js2-labeled-stmt-node-labels n))
3168 (js2-print-ast label i))
3169 (js2-print-ast (js2-labeled-stmt-node-stmt n) i))
3171 (defun js2-labeled-stmt-node-contains (node label)
3172 "Return t if NODE contains LABEL in its label set.
3173 NODE is a `js2-labels-node'. LABEL is an identifier."
3174 (cl-loop for nl in (js2-labeled-stmt-node-labels node)
3175 if (string= label (js2-label-node-name nl))
3177 finally return nil))
3179 (defsubst js2-labeled-stmt-node-add-label (node label)
3180 "Add a `js2-label-node' to the label set for this statement."
3181 (setf (js2-labeled-stmt-node-labels node)
3182 (nconc (js2-labeled-stmt-node-labels node) (list label))))
3184 (cl-defstruct (js2-jump-node
3187 "Abstract supertype of break and continue nodes."
3188 label ; `js2-name-node' for location of label identifier, if present
3189 target) ; target js2-labels-node or loop/switch statement
3191 (defun js2-visit-jump-node (n v)
3192 ;; We don't visit the target, since it's a back-link.
3193 (js2-visit-ast (js2-jump-node-label n) v))
3195 (cl-defstruct (js2-break-node
3196 (:include js2-jump-node)
3198 (:constructor make-js2-break-node (&key (type js2-BREAK)
3201 "AST node for a break statement.
3202 The label field is a `js2-name-node', possibly nil, for the named label
3203 if provided. E.g. in 'break foo', it represents 'foo'. The target field
3204 is the target of the break - a label node or enclosing loop/switch statement.")
3206 (put 'cl-struct-js2-break-node 'js2-visitor 'js2-visit-jump-node)
3207 (put 'cl-struct-js2-break-node 'js2-printer 'js2-print-break-node)
3209 (defun js2-print-break-node (n i)
3210 (insert (js2-make-pad i) "break")
3211 (when (js2-break-node-label n)
3213 (js2-print-ast (js2-break-node-label n) 0))
3216 (cl-defstruct (js2-continue-node
3217 (:include js2-jump-node)
3219 (:constructor make-js2-continue-node (&key (type js2-CONTINUE)
3222 "AST node for a continue statement.
3223 The label field is the user-supplied enclosing label name, a `js2-name-node'.
3224 It is nil if continue specifies no label. The target field is the jump target:
3225 a `js2-label-node' or the innermost enclosing loop.")
3227 (put 'cl-struct-js2-continue-node 'js2-visitor 'js2-visit-jump-node)
3228 (put 'cl-struct-js2-continue-node 'js2-printer 'js2-print-continue-node)
3230 (defun js2-print-continue-node (n i)
3231 (insert (js2-make-pad i) "continue")
3232 (when (js2-continue-node-label n)
3234 (js2-print-ast (js2-continue-node-label n) 0))
3237 (cl-defstruct (js2-function-node
3238 (:include js2-script-node)
3240 (:constructor make-js2-function-node (&key (type js2-FUNCTION)
3244 (form 'FUNCTION_STATEMENT)
3250 "AST node for a function declaration.
3251 The `params' field is a Lisp list of nodes. Each node is either a simple
3252 `js2-name-node', or if it's a destructuring-assignment parameter, a
3253 `js2-array-node' or `js2-object-node'."
3254 ftype ; FUNCTION, GETTER or SETTER
3255 form ; FUNCTION_{STATEMENT|EXPRESSION|ARROW}
3256 name ; function name (a `js2-name-node', or nil if anonymous)
3257 params ; a Lisp list of destructuring forms or simple name nodes
3258 rest-p ; if t, the last parameter is rest parameter
3259 body ; a `js2-block-node' or expression node (1.8 only)
3260 lp ; position of arg-list open-paren, or nil if omitted
3261 rp ; position of arg-list close-paren, or nil if omitted
3262 ignore-dynamic ; ignore value of the dynamic-scope flag (interpreter only)
3263 needs-activation ; t if we need an activation object for this frame
3264 generator-type ; STAR, LEGACY, COMPREHENSION or nil
3265 member-expr) ; nonstandard Ecma extension from Rhino
3267 (put 'cl-struct-js2-function-node 'js2-visitor 'js2-visit-function-node)
3268 (put 'cl-struct-js2-function-node 'js2-printer 'js2-print-function-node)
3270 (defun js2-visit-function-node (n v)
3271 (js2-visit-ast (js2-function-node-name n) v)
3272 (dolist (p (js2-function-node-params n))
3273 (js2-visit-ast p v))
3274 (js2-visit-ast (js2-function-node-body n) v))
3276 (defun js2-print-function-node (n i)
3277 (let* ((pad (js2-make-pad i))
3278 (getter (js2-node-get-prop n 'GETTER_SETTER))
3279 (name (or (js2-function-node-name n)
3280 (js2-function-node-member-expr n)))
3281 (params (js2-function-node-params n))
3282 (arrow (eq (js2-function-node-form n) 'FUNCTION_ARROW))
3283 (rest-p (js2-function-node-rest-p n))
3284 (body (js2-function-node-body n))
3285 (expr (not (eq (js2-function-node-form n) 'FUNCTION_STATEMENT))))
3286 (unless (or getter arrow)
3287 (insert pad "function")
3288 (when (eq (js2-function-node-generator-type n) 'STAR)
3292 (js2-print-ast name 0))
3294 (cl-loop with len = (length params)
3298 (when (and rest-p (= count len))
3300 (js2-print-ast param 0)
3307 ;; TODO: fix this to be smarter about indenting, etc.
3310 (if (js2-block-node-p body)
3311 (js2-print-body body (1+ i))
3312 (js2-print-ast body 0))
3317 (defun js2-function-name (node)
3318 "Return function name for NODE, a `js2-function-node', or nil if anonymous."
3319 (and (js2-function-node-name node)
3320 (js2-name-node-name (js2-function-node-name node))))
3322 ;; Having this be an expression node makes it more flexible.
3323 ;; There are IDE contexts, such as indentation in a for-loop initializer,
3324 ;; that work better if you assume it's an expression. Whenever we have
3325 ;; a standalone var/const declaration, we just wrap with an expr stmt.
3326 ;; Eclipse apparently screwed this up and now has two versions, expr and stmt.
3327 (cl-defstruct (js2-var-decl-node
3330 (:constructor make-js2-var-decl-node (&key (type js2-VAR)
3331 (pos (js2-current-token-beg))
3334 "AST node for a variable declaration list (VAR, CONST or LET).
3335 The node bounds differ depending on the declaration type. For VAR or
3336 CONST declarations, the bounds include the var/const keyword. For LET
3337 declarations, the node begins at the position of the first child."
3338 kids ; a Lisp list of `js2-var-init-node' structs.
3339 decl-type) ; js2-VAR, js2-CONST or js2-LET
3341 (put 'cl-struct-js2-var-decl-node 'js2-visitor 'js2-visit-var-decl)
3342 (put 'cl-struct-js2-var-decl-node 'js2-printer 'js2-print-var-decl)
3344 (defun js2-visit-var-decl (n v)
3345 (dolist (kid (js2-var-decl-node-kids n))
3346 (js2-visit-ast kid v)))
3348 (defun js2-print-var-decl (n i)
3349 (let ((pad (js2-make-pad i))
3350 (tt (js2-var-decl-node-decl-type n)))
3353 ((= tt js2-VAR) "var ")
3354 ((= tt js2-LET) "let ")
3355 ((= tt js2-CONST) "const ")
3357 (error "malformed var-decl node"))))
3358 (cl-loop with kids = (js2-var-decl-node-kids n)
3359 with len = (length kids)
3363 (js2-print-ast kid 0)
3367 (cl-defstruct (js2-var-init-node
3370 (:constructor make-js2-var-init-node (&key (type js2-VAR)
3374 "AST node for a variable declaration.
3375 The type field will be js2-CONST for a const decl."
3376 target ; `js2-name-node', `js2-object-node', or `js2-array-node'
3377 initializer) ; initializer expression, a `js2-node'
3379 (put 'cl-struct-js2-var-init-node 'js2-visitor 'js2-visit-var-init-node)
3380 (put 'cl-struct-js2-var-init-node 'js2-printer 'js2-print-var-init-node)
3382 (defun js2-visit-var-init-node (n v)
3383 (js2-visit-ast (js2-var-init-node-target n) v)
3384 (js2-visit-ast (js2-var-init-node-initializer n) v))
3386 (defun js2-print-var-init-node (n i)
3387 (let ((pad (js2-make-pad i))
3388 (name (js2-var-init-node-target n))
3389 (init (js2-var-init-node-initializer n)))
3391 (js2-print-ast name 0)
3394 (js2-print-ast init 0))))
3396 (cl-defstruct (js2-cond-node
3399 (:constructor make-js2-cond-node (&key (type js2-HOOK)
3406 "AST node for the ternary operator"
3410 q-pos ; buffer position of ?
3411 c-pos) ; buffer position of :
3413 (put 'cl-struct-js2-cond-node 'js2-visitor 'js2-visit-cond-node)
3414 (put 'cl-struct-js2-cond-node 'js2-printer 'js2-print-cond-node)
3416 (defun js2-visit-cond-node (n v)
3417 (js2-visit-ast (js2-cond-node-test-expr n) v)
3418 (js2-visit-ast (js2-cond-node-true-expr n) v)
3419 (js2-visit-ast (js2-cond-node-false-expr n) v))
3421 (defun js2-print-cond-node (n i)
3422 (let ((pad (js2-make-pad i)))
3424 (js2-print-ast (js2-cond-node-test-expr n) 0)
3426 (js2-print-ast (js2-cond-node-true-expr n) 0)
3428 (js2-print-ast (js2-cond-node-false-expr n) 0)))
3430 (cl-defstruct (js2-infix-node
3433 (:constructor make-js2-infix-node (&key type
3437 "Represents infix expressions.
3438 Includes assignment ops like `|=', and the comma operator.
3439 The type field inherited from `js2-node' holds the operator."
3440 op-pos ; buffer position where operator begins
3441 left ; any `js2-node'
3442 right) ; any `js2-node'
3444 (put 'cl-struct-js2-infix-node 'js2-visitor 'js2-visit-infix-node)
3445 (put 'cl-struct-js2-infix-node 'js2-printer 'js2-print-infix-node)
3447 (defun js2-visit-infix-node (n v)
3448 (js2-visit-ast (js2-infix-node-left n) v)
3449 (js2-visit-ast (js2-infix-node-right n) v))
3451 (defconst js2-operator-tokens
3452 (let ((table (make-hash-table :test 'eq))
3454 (list (cons js2-IN "in")
3455 (cons js2-TYPEOF "typeof")
3456 (cons js2-INSTANCEOF "instanceof")
3457 (cons js2-DELPROP "delete")
3458 (cons js2-COMMA ",")
3459 (cons js2-COLON ":")
3464 (cons js2-BITOR "|")
3465 (cons js2-BITXOR "^")
3466 (cons js2-BITAND "&")
3475 (cons js2-URSH ">>>")
3476 (cons js2-ADD "+") ; infix plus
3477 (cons js2-SUB "-") ; infix minus
3482 (cons js2-BITNOT "~")
3483 (cons js2-POS "+") ; unary plus
3484 (cons js2-NEG "-") ; unary minus
3485 (cons js2-TRIPLEDOT "...")
3486 (cons js2-SHEQ "===") ; shallow equality
3487 (cons js2-SHNE "!==") ; shallow inequality
3488 (cons js2-ASSIGN "=")
3489 (cons js2-ASSIGN_BITOR "|=")
3490 (cons js2-ASSIGN_BITXOR "^=")
3491 (cons js2-ASSIGN_BITAND "&=")
3492 (cons js2-ASSIGN_LSH "<<=")
3493 (cons js2-ASSIGN_RSH ">>=")
3494 (cons js2-ASSIGN_URSH ">>>=")
3495 (cons js2-ASSIGN_ADD "+=")
3496 (cons js2-ASSIGN_SUB "-=")
3497 (cons js2-ASSIGN_MUL "*=")
3498 (cons js2-ASSIGN_DIV "/=")
3499 (cons js2-ASSIGN_MOD "%="))))
3500 (cl-loop for (k . v) in tokens do
3501 (puthash k v table))
3504 (defun js2-print-infix-node (n i)
3505 (let* ((tt (js2-node-type n))
3506 (op (gethash tt js2-operator-tokens)))
3508 (error "unrecognized infix operator %s" (js2-node-type n)))
3509 (insert (js2-make-pad i))
3510 (js2-print-ast (js2-infix-node-left n) 0)
3511 (unless (= tt js2-COMMA)
3515 (js2-print-ast (js2-infix-node-right n) 0)))
3517 (cl-defstruct (js2-assign-node
3518 (:include js2-infix-node)
3520 (:constructor make-js2-assign-node (&key type
3524 "Represents any assignment.
3525 The type field holds the actual assignment operator.")
3527 (put 'cl-struct-js2-assign-node 'js2-visitor 'js2-visit-infix-node)
3528 (put 'cl-struct-js2-assign-node 'js2-printer 'js2-print-infix-node)
3530 (cl-defstruct (js2-unary-node
3533 (:constructor make-js2-unary-node (&key type ; required
3536 "AST node type for unary operator nodes.
3537 The type field can be NOT, BITNOT, POS, NEG, INC, DEC,
3538 TYPEOF, DELPROP or TRIPLEDOT. For INC or DEC, a 'postfix node
3539 property is added if the operator follows the operand."
3540 operand) ; a `js2-node' expression
3542 (put 'cl-struct-js2-unary-node 'js2-visitor 'js2-visit-unary-node)
3543 (put 'cl-struct-js2-unary-node 'js2-printer 'js2-print-unary-node)
3545 (defun js2-visit-unary-node (n v)
3546 (js2-visit-ast (js2-unary-node-operand n) v))
3548 (defun js2-print-unary-node (n i)
3549 (let* ((tt (js2-node-type n))
3550 (op (gethash tt js2-operator-tokens))
3551 (postfix (js2-node-get-prop n 'postfix)))
3553 (error "unrecognized unary operator %s" tt))
3554 (insert (js2-make-pad i))
3557 (if (or (= tt js2-TYPEOF)
3560 (js2-print-ast (js2-unary-node-operand n) 0)
3564 (cl-defstruct (js2-let-node
3565 (:include js2-scope)
3567 (:constructor make-js2-let-node (&key (type js2-LETEXPR)
3568 (pos (js2-current-token-beg))
3571 "AST node for a let expression or a let statement.
3572 Note that a let declaration such as let x=6, y=7 is a `js2-var-decl-node'."
3573 vars ; a `js2-var-decl-node'
3574 body ; a `js2-node' representing the expression or body block
3578 (put 'cl-struct-js2-let-node 'js2-visitor 'js2-visit-let-node)
3579 (put 'cl-struct-js2-let-node 'js2-printer 'js2-print-let-node)
3581 (defun js2-visit-let-node (n v)
3582 (js2-visit-ast (js2-let-node-vars n) v)
3583 (js2-visit-ast (js2-let-node-body n) v))
3585 (defun js2-print-let-node (n i)
3586 (insert (js2-make-pad i) "let (")
3588 (js2-print-ast (js2-let-node-vars n) 0)
3589 (delete-region p (+ p 4)))
3591 (js2-print-ast (js2-let-node-body n) i))
3593 (cl-defstruct (js2-keyword-node
3596 (:constructor make-js2-keyword-node (&key type
3597 (pos (js2-current-token-beg))
3598 (len (- js2-ts-cursor pos)))))
3599 "AST node representing a literal keyword such as `null'.
3600 Used for `null', `this', `true', `false' and `debugger'.
3601 The node type is set to js2-NULL, js2-THIS, etc.")
3603 (put 'cl-struct-js2-keyword-node 'js2-visitor 'js2-visit-none)
3604 (put 'cl-struct-js2-keyword-node 'js2-printer 'js2-print-keyword-node)
3606 (defun js2-print-keyword-node (n i)
3607 (insert (js2-make-pad i)
3608 (let ((tt (js2-node-type n)))
3610 ((= tt js2-THIS) "this")
3611 ((= tt js2-SUPER) "super")
3612 ((= tt js2-NULL) "null")
3613 ((= tt js2-TRUE) "true")
3614 ((= tt js2-FALSE) "false")
3615 ((= tt js2-DEBUGGER) "debugger")
3616 (t (error "Invalid keyword literal type: %d" tt))))))
3618 (defsubst js2-this-or-super-node-p (node)
3619 "Return t if NODE is a `js2-literal-node' of type js2-THIS or js2-SUPER."
3620 (let ((type (js2-node-type node)))
3621 (or (eq type js2-THIS) (eq type js2-SUPER))))
3623 (cl-defstruct (js2-new-node
3626 (:constructor make-js2-new-node (&key (type js2-NEW)
3627 (pos (js2-current-token-beg))
3631 "AST node for new-expression such as new Foo()."
3632 target ; an identifier or reference
3633 args ; a Lisp list of argument nodes
3634 lp ; position of left-paren, nil if omitted
3635 rp ; position of right-paren, nil if omitted
3636 initializer) ; experimental Rhino syntax: optional `js2-object-node'
3638 (put 'cl-struct-js2-new-node 'js2-visitor 'js2-visit-new-node)
3639 (put 'cl-struct-js2-new-node 'js2-printer 'js2-print-new-node)
3641 (defun js2-visit-new-node (n v)
3642 (js2-visit-ast (js2-new-node-target n) v)
3643 (dolist (arg (js2-new-node-args n))
3644 (js2-visit-ast arg v))
3645 (js2-visit-ast (js2-new-node-initializer n) v))
3647 (defun js2-print-new-node (n i)
3648 (insert (js2-make-pad i) "new ")
3649 (js2-print-ast (js2-new-node-target n))
3651 (js2-print-list (js2-new-node-args n))
3653 (when (js2-new-node-initializer n)
3655 (js2-print-ast (js2-new-node-initializer n))))
3657 (cl-defstruct (js2-name-node
3660 (:constructor make-js2-name-node (&key (type js2-NAME)
3661 (pos (js2-current-token-beg))
3662 (len (- js2-ts-cursor
3663 (js2-current-token-beg)))
3664 (name (js2-current-token-string)))))
3665 "AST node for a JavaScript identifier"
3667 scope) ; a `js2-scope' (optional, used for codegen)
3669 (put 'cl-struct-js2-name-node 'js2-visitor 'js2-visit-none)
3670 (put 'cl-struct-js2-name-node 'js2-printer 'js2-print-name-node)
3672 (defun js2-print-name-node (n i)
3673 (insert (js2-make-pad i)
3674 (js2-name-node-name n)))
3676 (defsubst js2-name-node-length (node)
3677 "Return identifier length of NODE, a `js2-name-node'.
3678 Returns 0 if NODE is nil or its identifier field is nil."
3680 (length (js2-name-node-name node))
3683 (cl-defstruct (js2-number-node
3686 (:constructor make-js2-number-node (&key (type js2-NUMBER)
3687 (pos (js2-current-token-beg))
3688 (len (- js2-ts-cursor
3689 (js2-current-token-beg)))
3690 (value (js2-current-token-string))
3691 (num-value (js2-token-number
3692 (js2-current-token)))
3693 (num-base (js2-token-number-base
3694 (js2-current-token))))))
3695 "AST node for a number literal."
3696 value ; the original string, e.g. "6.02e23"
3697 num-value ; the parsed number value
3698 num-base) ; the number's base
3700 (put 'cl-struct-js2-number-node 'js2-visitor 'js2-visit-none)
3701 (put 'cl-struct-js2-number-node 'js2-printer 'js2-print-number-node)
3703 (defun js2-print-number-node (n i)
3704 (insert (js2-make-pad i)
3705 (number-to-string (js2-number-node-num-value n))))
3707 (cl-defstruct (js2-regexp-node
3710 (:constructor make-js2-regexp-node (&key (type js2-REGEXP)
3711 (pos (js2-current-token-beg))
3712 (len (- js2-ts-cursor
3713 (js2-current-token-beg)))
3715 "AST node for a regular expression literal."
3716 value ; the regexp string, without // delimiters
3717 flags) ; a string of flags, e.g. `mi'.
3719 (put 'cl-struct-js2-regexp-node 'js2-visitor 'js2-visit-none)
3720 (put 'cl-struct-js2-regexp-node 'js2-printer 'js2-print-regexp)
3722 (defun js2-print-regexp (n i)
3723 (insert (js2-make-pad i)
3725 (js2-regexp-node-value n)
3727 (if (js2-regexp-node-flags n)
3728 (insert (js2-regexp-node-flags n))))
3730 (cl-defstruct (js2-string-node
3733 (:constructor make-js2-string-node (&key (type js2-STRING)
3734 (pos (js2-current-token-beg))
3735 (len (- js2-ts-cursor
3736 (js2-current-token-beg)))
3737 (value (js2-current-token-string)))))
3739 Escape characters are not evaluated; e.g. \n is 2 chars in value field.
3740 You can tell the quote type by looking at the first character."
3741 value) ; the characters of the string, including the quotes
3743 (put 'cl-struct-js2-string-node 'js2-visitor 'js2-visit-none)
3744 (put 'cl-struct-js2-string-node 'js2-printer 'js2-print-string-node)
3746 (defun js2-print-string-node (n i)
3747 (insert (js2-make-pad i)
3748 (js2-node-string n)))
3750 (cl-defstruct (js2-template-node
3753 (:constructor make-js2-template-node (&key (type js2-TEMPLATE_HEAD)
3756 kids) ; `js2-string-node' is used for string segments, other nodes
3757 ; for substitutions inside.
3759 (put 'cl-struct-js2-template-node 'js2-visitor 'js2-visit-template)
3760 (put 'cl-struct-js2-template-node 'js2-printer 'js2-print-template)
3762 (defun js2-visit-template (n callback)
3763 (dolist (kid (js2-template-node-kids n))
3764 (js2-visit-ast kid callback)))
3766 (defun js2-print-template (n i)
3767 (insert (js2-make-pad i))
3768 (dolist (kid (js2-template-node-kids n))
3769 (if (js2-string-node-p kid)
3770 (insert (js2-node-string kid))
3771 (js2-print-ast kid))))
3773 (cl-defstruct (js2-tagged-template-node
3776 (:constructor make-js2-tagged-template-node (&key (type js2-TAGGED_TEMPLATE)
3777 beg len tag template)))
3778 "Tagged template literal."
3779 tag ; `js2-node' with the tag expression.
3780 template) ; `js2-template-node' with the template.
3782 (put 'cl-struct-js2-tagged-template-node 'js2-visitor 'js2-visit-tagged-template)
3783 (put 'cl-struct-js2-tagged-template-node 'js2-printer 'js2-print-tagged-template)
3785 (defun js2-visit-tagged-template (n callback)
3786 (js2-visit-ast (js2-tagged-template-node-tag n) callback)
3787 (js2-visit-ast (js2-tagged-template-node-template n) callback))
3789 (defun js2-print-tagged-template (n i)
3790 (insert (js2-make-pad i))
3791 (js2-print-ast (js2-tagged-template-node-tag n))
3792 (js2-print-ast (js2-tagged-template-node-template n)))
3794 (cl-defstruct (js2-array-node
3797 (:constructor make-js2-array-node (&key (type js2-ARRAYLIT)
3800 "AST node for an array literal."
3801 elems) ; list of expressions. [foo,,bar] yields a nil middle element.
3803 (put 'cl-struct-js2-array-node 'js2-visitor 'js2-visit-array-node)
3804 (put 'cl-struct-js2-array-node 'js2-printer 'js2-print-array-node)
3806 (defun js2-visit-array-node (n v)
3807 (dolist (e (js2-array-node-elems n))
3808 (js2-visit-ast e v))) ; Can be nil; e.g. [a, ,b].
3810 (defun js2-print-array-node (n i)
3811 (insert (js2-make-pad i) "[")
3812 (let ((elems (js2-array-node-elems n)))
3813 (js2-print-list elems)
3814 (when (and elems (null (car (last elems))))
3818 (cl-defstruct (js2-class-node
3821 (:constructor make-js2-class-node (&key (type js2-CLASS)
3823 (form 'CLASS_STATEMENT)
3825 extends len elems)))
3826 "AST node for an class expression.
3827 `elems' is a list of `js2-object-prop-node', and `extends' is an
3828 optional `js2-expr-node'"
3829 form ; CLASS_{STATEMENT|EXPRESSION}
3830 name ; class name (a `js2-node-name', or nil if anonymous)
3831 extends ; class heritage (a `js2-expr-node', or nil if none)
3834 (put 'cl-struct-js2-class-node 'js2-visitor 'js2-visit-class-node)
3835 (put 'cl-struct-js2-class-node 'js2-printer 'js2-print-class-node)
3837 (defun js2-visit-class-node (n v)
3838 (js2-visit-ast (js2-class-node-name n) v)
3839 (js2-visit-ast (js2-class-node-extends n) v)
3840 (dolist (e (js2-class-node-elems n))
3841 (js2-visit-ast e v)))
3843 (defun js2-print-class-node (n i)
3844 (let* ((pad (js2-make-pad i))
3845 (name (js2-class-node-name n))
3846 (extends (js2-class-node-extends n))
3847 (elems (js2-class-node-elems n)))
3848 (insert pad "class")
3851 (js2-print-ast name 0))
3853 (insert " extends ")
3854 (js2-print-ast extends))
3856 (dolist (elem elems)
3858 (if (js2-node-get-prop elem 'STATIC)
3859 (progn (insert (js2-make-pad (1+ i)) "static ")
3860 (js2-print-ast elem 0)) ;; TODO(sdh): indentation isn't quite right
3861 (js2-print-ast elem (1+ i))))
3862 (insert "\n" pad "}")))
3864 (cl-defstruct (js2-object-node
3867 (:constructor make-js2-object-node (&key (type js2-OBJECTLIT)
3871 "AST node for an object literal expression.
3872 `elems' is a list of `js2-object-prop-node'."
3875 (put 'cl-struct-js2-object-node 'js2-visitor 'js2-visit-object-node)
3876 (put 'cl-struct-js2-object-node 'js2-printer 'js2-print-object-node)
3878 (defun js2-visit-object-node (n v)
3879 (dolist (e (js2-object-node-elems n))
3880 (js2-visit-ast e v)))
3882 (defun js2-print-object-node (n i)
3883 (insert (js2-make-pad i) "{")
3884 (js2-print-list (js2-object-node-elems n))
3887 (cl-defstruct (js2-object-prop-node
3888 (:include js2-infix-node)
3890 (:constructor make-js2-object-prop-node (&key (type js2-COLON)
3894 "AST node for an object literal prop:value entry.
3895 The `left' field is the property: a name node, string node,
3896 number node or expression node. The `right' field is a
3897 `js2-node' representing the initializer value. If the property
3898 is abbreviated, the node's `SHORTHAND' property is non-nil and
3899 both fields have the same value.")
3901 (put 'cl-struct-js2-object-prop-node 'js2-visitor 'js2-visit-infix-node)
3902 (put 'cl-struct-js2-object-prop-node 'js2-printer 'js2-print-object-prop-node)
3904 (defun js2-print-object-prop-node (n i)
3905 (let* ((left (js2-object-prop-node-left n))
3906 (right (js2-object-prop-node-right n))
3907 (computed (not (or (js2-string-node-p left)
3908 (js2-number-node-p left)
3909 (js2-name-node-p left)))))
3910 (insert (js2-make-pad i))
3913 (js2-print-ast left 0)
3916 (if (not (js2-node-get-prop n 'SHORTHAND))
3919 (js2-print-ast right 0)))))
3921 (cl-defstruct (js2-getter-setter-node
3922 (:include js2-infix-node)
3924 (:constructor make-js2-getter-setter-node (&key type ; GET, SET, or FUNCTION
3927 "AST node for a getter/setter property in an object literal.
3928 The `left' field is the `js2-name-node' naming the getter/setter prop.
3929 The `right' field is always an anonymous `js2-function-node' with a node
3930 property `GETTER_SETTER' set to js2-GET, js2-SET, or js2-FUNCTION. ")
3932 (put 'cl-struct-js2-getter-setter-node 'js2-visitor 'js2-visit-infix-node)
3933 (put 'cl-struct-js2-getter-setter-node 'js2-printer 'js2-print-getter-setter)
3935 (defun js2-print-getter-setter (n i)
3936 (let* ((pad (js2-make-pad i))
3937 (left (js2-getter-setter-node-left n))
3938 (right (js2-getter-setter-node-right n))
3939 (computed (not (or (js2-string-node-p left)
3940 (js2-number-node-p left)
3941 (js2-name-node-p left)))))
3943 (if (/= (js2-node-type n) js2-FUNCTION)
3944 (insert (if (= (js2-node-type n) js2-GET) "get " "set ")))
3945 (when (and (js2-function-node-p right)
3946 (eq 'STAR (js2-function-node-generator-type right)))
3950 (js2-print-ast left 0)
3953 (js2-print-ast right 0)))
3955 (cl-defstruct (js2-prop-get-node
3956 (:include js2-infix-node)
3958 (:constructor make-js2-prop-get-node (&key (type js2-GETPROP)
3961 "AST node for a dotted property reference, e.g. foo.bar or foo().bar")
3963 (put 'cl-struct-js2-prop-get-node 'js2-visitor 'js2-visit-prop-get-node)
3964 (put 'cl-struct-js2-prop-get-node 'js2-printer 'js2-print-prop-get-node)
3966 (defun js2-visit-prop-get-node (n v)
3967 (js2-visit-ast (js2-prop-get-node-left n) v)
3968 (js2-visit-ast (js2-prop-get-node-right n) v))
3970 (defun js2-print-prop-get-node (n i)
3971 (insert (js2-make-pad i))
3972 (js2-print-ast (js2-prop-get-node-left n) 0)
3974 (js2-print-ast (js2-prop-get-node-right n) 0))
3976 (cl-defstruct (js2-elem-get-node
3979 (:constructor make-js2-elem-get-node (&key (type js2-GETELEM)
3983 "AST node for an array index expression such as foo[bar]."
3984 target ; a `js2-node' - the expression preceding the "."
3985 element ; a `js2-node' - the expression in brackets
3986 lb ; position of left-bracket, nil if omitted
3987 rb) ; position of right-bracket, nil if omitted
3989 (put 'cl-struct-js2-elem-get-node 'js2-visitor 'js2-visit-elem-get-node)
3990 (put 'cl-struct-js2-elem-get-node 'js2-printer 'js2-print-elem-get-node)
3992 (defun js2-visit-elem-get-node (n v)
3993 (js2-visit-ast (js2-elem-get-node-target n) v)
3994 (js2-visit-ast (js2-elem-get-node-element n) v))
3996 (defun js2-print-elem-get-node (n i)
3997 (insert (js2-make-pad i))
3998 (js2-print-ast (js2-elem-get-node-target n) 0)
4000 (js2-print-ast (js2-elem-get-node-element n) 0)
4003 (cl-defstruct (js2-call-node
4006 (:constructor make-js2-call-node (&key (type js2-CALL)
4010 "AST node for a JavaScript function call."
4011 target ; a `js2-node' evaluating to the function to call
4012 args ; a Lisp list of `js2-node' arguments
4013 lp ; position of open-paren, or nil if missing
4014 rp) ; position of close-paren, or nil if missing
4016 (put 'cl-struct-js2-call-node 'js2-visitor 'js2-visit-call-node)
4017 (put 'cl-struct-js2-call-node 'js2-printer 'js2-print-call-node)
4019 (defun js2-visit-call-node (n v)
4020 (js2-visit-ast (js2-call-node-target n) v)
4021 (dolist (arg (js2-call-node-args n))
4022 (js2-visit-ast arg v)))
4024 (defun js2-print-call-node (n i)
4025 (insert (js2-make-pad i))
4026 (js2-print-ast (js2-call-node-target n) 0)
4028 (js2-print-list (js2-call-node-args n))
4031 (cl-defstruct (js2-yield-node
4034 (:constructor make-js2-yield-node (&key (type js2-YIELD)
4037 "AST node for yield statement or expression."
4038 star-p ; whether it's yield*
4039 value) ; optional: value to be yielded
4041 (put 'cl-struct-js2-yield-node 'js2-visitor 'js2-visit-yield-node)
4042 (put 'cl-struct-js2-yield-node 'js2-printer 'js2-print-yield-node)
4044 (defun js2-visit-yield-node (n v)
4045 (js2-visit-ast (js2-yield-node-value n) v))
4047 (defun js2-print-yield-node (n i)
4048 (insert (js2-make-pad i))
4050 (when (js2-yield-node-star-p n)
4052 (when (js2-yield-node-value n)
4054 (js2-print-ast (js2-yield-node-value n) 0)))
4056 (cl-defstruct (js2-paren-node
4059 (:constructor make-js2-paren-node (&key (type js2-LP)
4062 "AST node for a parenthesized expression.
4063 In particular, used when the parens are syntactically optional,
4064 as opposed to required parens such as those enclosing an if-conditional."
4067 (put 'cl-struct-js2-paren-node 'js2-visitor 'js2-visit-paren-node)
4068 (put 'cl-struct-js2-paren-node 'js2-printer 'js2-print-paren-node)
4070 (defun js2-visit-paren-node (n v)
4071 (js2-visit-ast (js2-paren-node-expr n) v))
4073 (defun js2-print-paren-node (n i)
4074 (insert (js2-make-pad i))
4076 (js2-print-ast (js2-paren-node-expr n) 0)
4079 (cl-defstruct (js2-comp-node
4080 (:include js2-scope)
4082 (:constructor make-js2-comp-node (&key (type js2-ARRAYCOMP)
4087 "AST node for an Array comprehension such as [[x,y] for (x in foo) for (y in bar)]."
4088 result ; result expression (just after left-bracket)
4089 loops ; a Lisp list of `js2-comp-loop-node'
4090 filters ; a Lisp list of guard/filter expressions
4091 form ; ARRAY, LEGACY_ARRAY or STAR_GENERATOR
4092 ; SpiderMonkey also supports "legacy generator expressions", but we dont.
4095 (put 'cl-struct-js2-comp-node 'js2-visitor 'js2-visit-comp-node)
4096 (put 'cl-struct-js2-comp-node 'js2-printer 'js2-print-comp-node)
4098 (defun js2-visit-comp-node (n v)
4099 (js2-visit-ast (js2-comp-node-result n) v)
4100 (dolist (l (js2-comp-node-loops n))
4101 (js2-visit-ast l v))
4102 (dolist (f (js2-comp-node-filters n))
4103 (js2-visit-ast f v)))
4105 (defun js2-print-comp-node (n i)
4106 (let ((pad (js2-make-pad i))
4107 (result (js2-comp-node-result n))
4108 (loops (js2-comp-node-loops n))
4109 (filters (js2-comp-node-filters n))
4110 (legacy-p (eq (js2-comp-node-form n) 'LEGACY_ARRAY))
4111 (gen-p (eq (js2-comp-node-form n) 'STAR_GENERATOR)))
4112 (insert pad (if gen-p "(" "["))
4114 (js2-print-ast result 0))
4130 (js2-print-ast result 0))
4131 (insert (if gen-p ")" "]"))))
4133 (cl-defstruct (js2-comp-loop-node
4134 (:include js2-for-in-node)
4136 (:constructor make-js2-comp-loop-node (&key (type js2-FOR)
4144 "AST subtree for each 'for (foo in bar)' loop in an array comprehension.")
4146 (put 'cl-struct-js2-comp-loop-node 'js2-visitor 'js2-visit-comp-loop)
4147 (put 'cl-struct-js2-comp-loop-node 'js2-printer 'js2-print-comp-loop)
4149 (defun js2-visit-comp-loop (n v)
4150 (js2-visit-ast (js2-comp-loop-node-iterator n) v)
4151 (js2-visit-ast (js2-comp-loop-node-object n) v))
4153 (defun js2-print-comp-loop (n _i)
4155 (when (js2-comp-loop-node-foreach-p n) (insert "each "))
4157 (js2-print-ast (js2-comp-loop-node-iterator n) 0)
4158 (insert (if (js2-comp-loop-node-forof-p n)
4160 (js2-print-ast (js2-comp-loop-node-object n) 0)
4163 (cl-defstruct (js2-empty-expr-node
4166 (:constructor make-js2-empty-expr-node (&key (type js2-EMPTY)
4167 (pos (js2-current-token-beg))
4169 "AST node for an empty expression.")
4171 (put 'cl-struct-js2-empty-expr-node 'js2-visitor 'js2-visit-none)
4172 (put 'cl-struct-js2-empty-expr-node 'js2-printer 'js2-print-none)
4174 (cl-defstruct (js2-xml-node
4175 (:include js2-block-node)
4177 (:constructor make-js2-xml-node (&key (type js2-XML)
4178 (pos (js2-current-token-beg))
4180 "AST node for initial parse of E4X literals.
4181 The kids field is a list of XML fragments, each a `js2-string-node' or
4182 a `js2-xml-js-expr-node'. Equivalent to Rhino's XmlLiteral node.")
4184 (put 'cl-struct-js2-xml-node 'js2-visitor 'js2-visit-block)
4185 (put 'cl-struct-js2-xml-node 'js2-printer 'js2-print-xml-node)
4187 (defun js2-print-xml-node (n i)
4188 (dolist (kid (js2-xml-node-kids n))
4189 (js2-print-ast kid i)))
4191 (cl-defstruct (js2-xml-js-expr-node
4192 (:include js2-xml-node)
4194 (:constructor make-js2-xml-js-expr-node (&key (type js2-XML)
4197 "AST node for an embedded JavaScript {expression} in an E4X literal.
4198 The start and end fields correspond to the curly-braces."
4199 expr) ; a `js2-expr-node' of some sort
4201 (put 'cl-struct-js2-xml-js-expr-node 'js2-visitor 'js2-visit-xml-js-expr)
4202 (put 'cl-struct-js2-xml-js-expr-node 'js2-printer 'js2-print-xml-js-expr)
4204 (defun js2-visit-xml-js-expr (n v)
4205 (js2-visit-ast (js2-xml-js-expr-node-expr n) v))
4207 (defun js2-print-xml-js-expr (n i)
4208 (insert (js2-make-pad i))
4210 (js2-print-ast (js2-xml-js-expr-node-expr n) 0)
4213 (cl-defstruct (js2-xml-dot-query-node
4214 (:include js2-infix-node)
4216 (:constructor make-js2-xml-dot-query-node (&key (type js2-DOTQUERY)
4220 "AST node for an E4X foo.(bar) filter expression.
4221 Note that the left-paren is automatically the character immediately
4222 following the dot (.) in the operator. No whitespace is permitted
4223 between the dot and the lp by the scanner."
4226 (put 'cl-struct-js2-xml-dot-query-node 'js2-visitor 'js2-visit-infix-node)
4227 (put 'cl-struct-js2-xml-dot-query-node 'js2-printer 'js2-print-xml-dot-query)
4229 (defun js2-print-xml-dot-query (n i)
4230 (insert (js2-make-pad i))
4231 (js2-print-ast (js2-xml-dot-query-node-left n) 0)
4233 (js2-print-ast (js2-xml-dot-query-node-right n) 0)
4236 (cl-defstruct (js2-xml-ref-node
4238 (:constructor nil)) ; abstract
4239 "Base type for E4X XML attribute-access or property-get expressions.
4240 Such expressions can take a variety of forms. The general syntax has
4243 - (optional) an @ (specifying an attribute access)
4244 - (optional) a namespace (a `js2-name-node') and double-colon
4245 - (required) either a `js2-name-node' or a bracketed [expression]
4247 The property-name expressions (examples: ns::name, @name) are
4248 represented as `js2-xml-prop-ref' nodes. The bracketed-expression
4249 versions (examples: ns::[name], @[name]) become `js2-xml-elem-ref' nodes.
4251 This node type (or more specifically, its subclasses) will sometimes
4252 be the right-hand child of a `js2-prop-get-node' or a
4253 `js2-infix-node' of type `js2-DOTDOT', the .. xml-descendants operator.
4254 The `js2-xml-ref-node' may also be a standalone primary expression with
4255 no explicit target, which is valid in certain expression contexts such as
4257 company..employee.(@id < 100)
4259 in this case, the @id is a `js2-xml-ref' that is part of an infix '<'
4260 expression whose parent is a `js2-xml-dot-query-node'."
4265 (defsubst js2-xml-ref-node-attr-access-p (node)
4266 "Return non-nil if this expression began with an @-token."
4267 (and (numberp (js2-xml-ref-node-at-pos node))
4268 (cl-plusp (js2-xml-ref-node-at-pos node))))
4270 (cl-defstruct (js2-xml-prop-ref-node
4271 (:include js2-xml-ref-node)
4273 (:constructor make-js2-xml-prop-ref-node (&key (type js2-REF_NAME)
4274 (pos (js2-current-token-beg))
4278 "AST node for an E4X XML [expr] property-ref expression.
4279 The JavaScript syntax is an optional @, an optional ns::, and a name.
4281 [ '@' ] [ name '::' ] name
4283 Examples include name, ns::name, ns::*, *::name, *::*, @attr, @ns::attr,
4284 @ns::*, @*::attr, @*::*, and @*.
4286 The node starts at the @ token, if present. Otherwise it starts at the
4287 namespace name. The node bounds extend through the closing right-bracket,
4288 or if it is missing due to a syntax error, through the end of the index
4292 (put 'cl-struct-js2-xml-prop-ref-node 'js2-visitor 'js2-visit-xml-prop-ref-node)
4293 (put 'cl-struct-js2-xml-prop-ref-node 'js2-printer 'js2-print-xml-prop-ref-node)
4295 (defun js2-visit-xml-prop-ref-node (n v)
4296 (js2-visit-ast (js2-xml-prop-ref-node-namespace n) v)
4297 (js2-visit-ast (js2-xml-prop-ref-node-propname n) v))
4299 (defun js2-print-xml-prop-ref-node (n i)
4300 (insert (js2-make-pad i))
4301 (if (js2-xml-ref-node-attr-access-p n)
4303 (when (js2-xml-prop-ref-node-namespace n)
4304 (js2-print-ast (js2-xml-prop-ref-node-namespace n) 0)
4306 (if (js2-xml-prop-ref-node-propname n)
4307 (js2-print-ast (js2-xml-prop-ref-node-propname n) 0)))
4309 (cl-defstruct (js2-xml-elem-ref-node
4310 (:include js2-xml-ref-node)
4312 (:constructor make-js2-xml-elem-ref-node (&key (type js2-REF_MEMBER)
4313 (pos (js2-current-token-beg))
4317 "AST node for an E4X XML [expr] member-ref expression.
4320 [ '@' ] [ name '::' ] '[' expr ']'
4322 Examples include ns::[expr], @ns::[expr], @[expr], *::[expr] and @*::[expr].
4324 Note that the form [expr] (i.e. no namespace or attribute-qualifier)
4325 is not a legal E4X XML element-ref expression, since it's already used
4326 for standard JavaScript element-get array indexing. Hence, a
4327 `js2-xml-elem-ref-node' always has either the attribute-qualifier, a
4328 non-nil namespace node, or both.
4330 The node starts at the @ token, if present. Otherwise it starts
4331 at the namespace name. The node bounds extend through the closing
4332 right-bracket, or if it is missing due to a syntax error, through the
4333 end of the index expression."
4334 expr ; the bracketed index expression
4338 (put 'cl-struct-js2-xml-elem-ref-node 'js2-visitor 'js2-visit-xml-elem-ref-node)
4339 (put 'cl-struct-js2-xml-elem-ref-node 'js2-printer 'js2-print-xml-elem-ref-node)
4341 (defun js2-visit-xml-elem-ref-node (n v)
4342 (js2-visit-ast (js2-xml-elem-ref-node-namespace n) v)
4343 (js2-visit-ast (js2-xml-elem-ref-node-expr n) v))
4345 (defun js2-print-xml-elem-ref-node (n i)
4346 (insert (js2-make-pad i))
4347 (if (js2-xml-ref-node-attr-access-p n)
4349 (when (js2-xml-elem-ref-node-namespace n)
4350 (js2-print-ast (js2-xml-elem-ref-node-namespace n) 0)
4353 (if (js2-xml-elem-ref-node-expr n)
4354 (js2-print-ast (js2-xml-elem-ref-node-expr n) 0))
4357 ;;; Placeholder nodes for when we try parsing the XML literals structurally.
4359 (cl-defstruct (js2-xml-start-tag-node
4360 (:include js2-xml-node)
4362 (:constructor make-js2-xml-start-tag-node (&key (type js2-XML)
4366 "AST node for an XML start-tag. Not currently used.
4367 The `kids' field is a Lisp list of child content nodes."
4368 name ; a `js2-xml-name-node'
4369 attrs ; a Lisp list of `js2-xml-attr-node'
4370 empty-p) ; t if this is an empty element such as <foo bar="baz"/>
4372 (put 'cl-struct-js2-xml-start-tag-node 'js2-visitor 'js2-visit-xml-start-tag)
4373 (put 'cl-struct-js2-xml-start-tag-node 'js2-printer 'js2-print-xml-start-tag)
4375 (defun js2-visit-xml-start-tag (n v)
4376 (js2-visit-ast (js2-xml-start-tag-node-name n) v)
4377 (dolist (attr (js2-xml-start-tag-node-attrs n))
4378 (js2-visit-ast attr v))
4379 (js2-visit-block n v))
4381 (defun js2-print-xml-start-tag (n i)
4382 (insert (js2-make-pad i) "<")
4383 (js2-print-ast (js2-xml-start-tag-node-name n) 0)
4384 (when (js2-xml-start-tag-node-attrs n)
4386 (js2-print-list (js2-xml-start-tag-node-attrs n) " "))
4389 ;; I -think- I'm going to make the parent node the corresponding start-tag,
4390 ;; and add the end-tag to the kids list of the parent as well.
4391 (cl-defstruct (js2-xml-end-tag-node
4392 (:include js2-xml-node)
4394 (:constructor make-js2-xml-end-tag-node (&key (type js2-XML)
4397 "AST node for an XML end-tag. Not currently used."
4398 name) ; a `js2-xml-name-node'
4400 (put 'cl-struct-js2-xml-end-tag-node 'js2-visitor 'js2-visit-xml-end-tag)
4401 (put 'cl-struct-js2-xml-end-tag-node 'js2-printer 'js2-print-xml-end-tag)
4403 (defun js2-visit-xml-end-tag (n v)
4404 (js2-visit-ast (js2-xml-end-tag-node-name n) v))
4406 (defun js2-print-xml-end-tag (n i)
4407 (insert (js2-make-pad i))
4409 (js2-print-ast (js2-xml-end-tag-node-name n) 0)
4412 (cl-defstruct (js2-xml-name-node
4413 (:include js2-xml-node)
4415 (:constructor make-js2-xml-name-node (&key (type js2-XML)
4417 len namespace kids)))
4418 "AST node for an E4X XML name. Not currently used.
4419 Any XML name can be qualified with a namespace, hence the namespace field.
4420 Further, any E4X name can be comprised of arbitrary JavaScript {} expressions.
4421 The kids field is a list of `js2-name-node' and `js2-xml-js-expr-node'.
4422 For a simple name, the kids list has exactly one node, a `js2-name-node'."
4423 namespace) ; a `js2-string-node'
4425 (put 'cl-struct-js2-xml-name-node 'js2-visitor 'js2-visit-xml-name-node)
4426 (put 'cl-struct-js2-xml-name-node 'js2-printer 'js2-print-xml-name-node)
4428 (defun js2-visit-xml-name-node (n v)
4429 (js2-visit-ast (js2-xml-name-node-namespace n) v))
4431 (defun js2-print-xml-name-node (n i)
4432 (insert (js2-make-pad i))
4433 (when (js2-xml-name-node-namespace n)
4434 (js2-print-ast (js2-xml-name-node-namespace n) 0)
4436 (dolist (kid (js2-xml-name-node-kids n))
4437 (js2-print-ast kid 0)))
4439 (cl-defstruct (js2-xml-pi-node
4440 (:include js2-xml-node)
4442 (:constructor make-js2-xml-pi-node (&key (type js2-XML)
4445 "AST node for an E4X XML processing instruction. Not currently used."
4446 name ; a `js2-xml-name-node'
4447 attrs) ; a list of `js2-xml-attr-node'
4449 (put 'cl-struct-js2-xml-pi-node 'js2-visitor 'js2-visit-xml-pi-node)
4450 (put 'cl-struct-js2-xml-pi-node 'js2-printer 'js2-print-xml-pi-node)
4452 (defun js2-visit-xml-pi-node (n v)
4453 (js2-visit-ast (js2-xml-pi-node-name n) v)
4454 (dolist (attr (js2-xml-pi-node-attrs n))
4455 (js2-visit-ast attr v)))
4457 (defun js2-print-xml-pi-node (n i)
4458 (insert (js2-make-pad i) "<?")
4459 (js2-print-ast (js2-xml-pi-node-name n))
4460 (when (js2-xml-pi-node-attrs n)
4462 (js2-print-list (js2-xml-pi-node-attrs n)))
4465 (cl-defstruct (js2-xml-cdata-node
4466 (:include js2-xml-node)
4468 (:constructor make-js2-xml-cdata-node (&key (type js2-XML)
4471 "AST node for a CDATA escape section. Not currently used."
4472 content) ; a `js2-string-node' with node-property 'quote-type 'cdata
4474 (put 'cl-struct-js2-xml-cdata-node 'js2-visitor 'js2-visit-xml-cdata-node)
4475 (put 'cl-struct-js2-xml-cdata-node 'js2-printer 'js2-print-xml-cdata-node)
4477 (defun js2-visit-xml-cdata-node (n v)
4478 (js2-visit-ast (js2-xml-cdata-node-content n) v))
4480 (defun js2-print-xml-cdata-node (n i)
4481 (insert (js2-make-pad i))
4482 (js2-print-ast (js2-xml-cdata-node-content n)))
4484 (cl-defstruct (js2-xml-attr-node
4485 (:include js2-xml-node)
4487 (:constructor make-js2-attr-node (&key (type js2-XML)
4490 eq-pos quote-type)))
4491 "AST node representing a foo='bar' XML attribute value. Not yet used."
4492 name ; a `js2-xml-name-node'
4493 value ; a `js2-xml-name-node'
4494 eq-pos ; buffer position of "=" sign
4495 quote-type) ; 'single or 'double
4497 (put 'cl-struct-js2-xml-attr-node 'js2-visitor 'js2-visit-xml-attr-node)
4498 (put 'cl-struct-js2-xml-attr-node 'js2-printer 'js2-print-xml-attr-node)
4500 (defun js2-visit-xml-attr-node (n v)
4501 (js2-visit-ast (js2-xml-attr-node-name n) v)
4502 (js2-visit-ast (js2-xml-attr-node-value n) v))
4504 (defun js2-print-xml-attr-node (n i)
4505 (let ((quote (if (eq (js2-xml-attr-node-quote-type n) 'single)
4508 (insert (js2-make-pad i))
4509 (js2-print-ast (js2-xml-attr-node-name n) 0)
4511 (js2-print-ast (js2-xml-attr-node-value n) 0)
4514 (cl-defstruct (js2-xml-text-node
4515 (:include js2-xml-node)
4517 (:constructor make-js2-text-node (&key (type js2-XML)
4520 "AST node for an E4X XML text node. Not currently used."
4521 content) ; a Lisp list of `js2-string-node' and `js2-xml-js-expr-node'
4523 (put 'cl-struct-js2-xml-text-node 'js2-visitor 'js2-visit-xml-text-node)
4524 (put 'cl-struct-js2-xml-text-node 'js2-printer 'js2-print-xml-text-node)
4526 (defun js2-visit-xml-text-node (n v)
4527 (js2-visit-ast (js2-xml-text-node-content n) v))
4529 (defun js2-print-xml-text-node (n i)
4530 (insert (js2-make-pad i))
4531 (dolist (kid (js2-xml-text-node-content n))
4532 (js2-print-ast kid)))
4534 (cl-defstruct (js2-xml-comment-node
4535 (:include js2-xml-node)
4537 (:constructor make-js2-xml-comment-node (&key (type js2-XML)
4540 "AST node for E4X XML comment. Not currently used.")
4542 (put 'cl-struct-js2-xml-comment-node 'js2-visitor 'js2-visit-none)
4543 (put 'cl-struct-js2-xml-comment-node 'js2-printer 'js2-print-xml-comment)
4545 (defun js2-print-xml-comment (n i)
4546 (insert (js2-make-pad i)
4547 (js2-node-string n)))
4551 (defsubst js2-node-line (n)
4552 "Fetch the source line number at the start of node N.
4553 This is O(n) in the length of the source buffer; use prudently."
4554 (1+ (count-lines (point-min) (js2-node-abs-pos n))))
4556 (defsubst js2-block-node-kid (n i)
4557 "Return child I of node N, or nil if there aren't that many."
4558 (nth i (js2-block-node-kids n)))
4560 (defsubst js2-block-node-first (n)
4561 "Return first child of block node N, or nil if there is none."
4562 (cl-first (js2-block-node-kids n)))
4564 (defun js2-node-root (n)
4565 "Return the root of the AST containing N.
4566 If N has no parent pointer, returns N."
4567 (let ((parent (js2-node-parent n)))
4569 (js2-node-root parent)
4572 (defsubst js2-node-short-name (n)
4573 "Return the short name of node N as a string, e.g. `js2-if-node'."
4574 (substring (symbol-name (aref n 0))
4575 (length "cl-struct-")))
4577 (defun js2-node-child-list (node)
4578 "Return the child list for NODE, a Lisp list of nodes.
4579 Works for block nodes, array nodes, obj literals, funarg lists,
4580 var decls and try nodes (for catch clauses). Note that you should call
4581 `js2-block-node-kids' on the function body for the body statements.
4582 Returns nil for zero-length child lists or unsupported nodes."
4584 ((js2-function-node-p node)
4585 (js2-function-node-params node))
4586 ((js2-block-node-p node)
4587 (js2-block-node-kids node))
4588 ((js2-try-node-p node)
4589 (js2-try-node-catch-clauses node))
4590 ((js2-array-node-p node)
4591 (js2-array-node-elems node))
4592 ((js2-object-node-p node)
4593 (js2-object-node-elems node))
4594 ((js2-call-node-p node)
4595 (js2-call-node-args node))
4596 ((js2-new-node-p node)
4597 (js2-new-node-args node))
4598 ((js2-var-decl-node-p node)
4599 (js2-var-decl-node-kids node))
4603 (defun js2-node-set-child-list (node kids)
4604 "Set the child list for NODE to KIDS."
4606 ((js2-function-node-p node)
4607 (setf (js2-function-node-params node) kids))
4608 ((js2-block-node-p node)
4609 (setf (js2-block-node-kids node) kids))
4610 ((js2-try-node-p node)
4611 (setf (js2-try-node-catch-clauses node) kids))
4612 ((js2-array-node-p node)
4613 (setf (js2-array-node-elems node) kids))
4614 ((js2-object-node-p node)
4615 (setf (js2-object-node-elems node) kids))
4616 ((js2-call-node-p node)
4617 (setf (js2-call-node-args node) kids))
4618 ((js2-new-node-p node)
4619 (setf (js2-new-node-args node) kids))
4620 ((js2-var-decl-node-p node)
4621 (setf (js2-var-decl-node-kids node) kids))
4623 (error "Unsupported node type: %s" (js2-node-short-name node))))
4626 ;; All because Common Lisp doesn't support multiple inheritance for defstructs.
4627 (defconst js2-paren-expr-nodes
4628 '(cl-struct-js2-comp-loop-node
4629 cl-struct-js2-comp-node
4630 cl-struct-js2-call-node
4631 cl-struct-js2-catch-node
4632 cl-struct-js2-do-node
4633 cl-struct-js2-elem-get-node
4634 cl-struct-js2-for-in-node
4635 cl-struct-js2-for-node
4636 cl-struct-js2-function-node
4637 cl-struct-js2-if-node
4638 cl-struct-js2-let-node
4639 cl-struct-js2-new-node
4640 cl-struct-js2-paren-node
4641 cl-struct-js2-switch-node
4642 cl-struct-js2-while-node
4643 cl-struct-js2-with-node
4644 cl-struct-js2-xml-dot-query-node)
4645 "Node types that can have a parenthesized child expression.
4646 In particular, nodes that respond to `js2-node-lp' and `js2-node-rp'.")
4648 (defsubst js2-paren-expr-node-p (node)
4649 "Return t for nodes that typically have a parenthesized child expression.
4650 Useful for computing the indentation anchors for arg-lists and conditions.
4651 Note that it may return a false positive, for instance when NODE is
4652 a `js2-new-node' and there are no arguments or parentheses."
4653 (memq (aref node 0) js2-paren-expr-nodes))
4655 ;; Fake polymorphism... yech.
4656 (defun js2-node-lp (node)
4657 "Return relative left-paren position for NODE, if applicable.
4658 For `js2-elem-get-node' structs, returns left-bracket position.
4659 Note that the position may be nil in the case of a parse error."
4661 ((js2-elem-get-node-p node)
4662 (js2-elem-get-node-lb node))
4663 ((js2-loop-node-p node)
4664 (js2-loop-node-lp node))
4665 ((js2-function-node-p node)
4666 (js2-function-node-lp node))
4667 ((js2-if-node-p node)
4668 (js2-if-node-lp node))
4669 ((js2-new-node-p node)
4670 (js2-new-node-lp node))
4671 ((js2-call-node-p node)
4672 (js2-call-node-lp node))
4673 ((js2-paren-node-p node)
4675 ((js2-switch-node-p node)
4676 (js2-switch-node-lp node))
4677 ((js2-catch-node-p node)
4678 (js2-catch-node-lp node))
4679 ((js2-let-node-p node)
4680 (js2-let-node-lp node))
4681 ((js2-comp-node-p node)
4683 ((js2-with-node-p node)
4684 (js2-with-node-lp node))
4685 ((js2-xml-dot-query-node-p node)
4686 (1+ (js2-infix-node-op-pos node)))
4688 (error "Unsupported node type: %s" (js2-node-short-name node)))))
4690 ;; Fake polymorphism... blech.
4691 (defun js2-node-rp (node)
4692 "Return relative right-paren position for NODE, if applicable.
4693 For `js2-elem-get-node' structs, returns right-bracket position.
4694 Note that the position may be nil in the case of a parse error."
4696 ((js2-elem-get-node-p node)
4697 (js2-elem-get-node-rb node))
4698 ((js2-loop-node-p node)
4699 (js2-loop-node-rp node))
4700 ((js2-function-node-p node)
4701 (js2-function-node-rp node))
4702 ((js2-if-node-p node)
4703 (js2-if-node-rp node))
4704 ((js2-new-node-p node)
4705 (js2-new-node-rp node))
4706 ((js2-call-node-p node)
4707 (js2-call-node-rp node))
4708 ((js2-paren-node-p node)
4709 (1- (js2-node-len node)))
4710 ((js2-switch-node-p node)
4711 (js2-switch-node-rp node))
4712 ((js2-catch-node-p node)
4713 (js2-catch-node-rp node))
4714 ((js2-let-node-p node)
4715 (js2-let-node-rp node))
4716 ((js2-comp-node-p node)
4717 (1- (js2-node-len node)))
4718 ((js2-with-node-p node)
4719 (js2-with-node-rp node))
4720 ((js2-xml-dot-query-node-p node)
4721 (1+ (js2-xml-dot-query-node-rp node)))
4723 (error "Unsupported node type: %s" (js2-node-short-name node)))))
4725 (defsubst js2-node-first-child (node)
4726 "Return the first element of `js2-node-child-list' for NODE."
4727 (car (js2-node-child-list node)))
4729 (defsubst js2-node-last-child (node)
4730 "Return the last element of `js2-node-last-child' for NODE."
4731 (car (last (js2-node-child-list node))))
4733 (defun js2-node-prev-sibling (node)
4734 "Return the previous statement in parent.
4735 Works for parents supported by `js2-node-child-list'.
4736 Returns nil if NODE is not in the parent, or PARENT is
4737 not a supported node, or if NODE is the first child."
4738 (let* ((p (js2-node-parent node))
4739 (kids (js2-node-child-list p))
4742 (not (eq node (cadr kids))))
4743 (setq kids (cdr kids)
4747 (defun js2-node-next-sibling (node)
4748 "Return the next statement in parent block.
4749 Returns nil if NODE is not in the block, or PARENT is not
4750 a block node, or if NODE is the last statement."
4751 (let* ((p (js2-node-parent node))
4752 (kids (js2-node-child-list p)))
4754 (not (eq node (car kids))))
4755 (setq kids (cdr kids)))
4758 (defun js2-node-find-child-before (pos parent &optional after)
4759 "Find the last child that starts before POS in parent.
4760 If AFTER is non-nil, returns first child starting after POS.
4761 POS is an absolute buffer position. PARENT is any node
4762 supported by `js2-node-child-list'.
4763 Returns nil if no applicable child is found."
4764 (let ((kids (if (js2-function-node-p parent)
4765 (js2-block-node-kids (js2-function-node-body parent))
4766 (js2-node-child-list parent)))
4767 (beg (js2-node-abs-pos (if (js2-function-node-p parent)
4768 (js2-function-node-body parent)
4772 (setq fn (if after '>= '<))
4773 (while (and kids continue)
4774 (setq kid (car kids))
4775 (if (funcall fn (+ beg (js2-node-pos kid)) pos)
4777 continue (not after))
4778 (setq continue after))
4779 (setq kids (cdr kids)))
4782 (defun js2-node-find-child-after (pos parent)
4783 "Find first child that starts after POS in parent.
4784 POS is an absolute buffer position. PARENT is any node
4785 supported by `js2-node-child-list'.
4786 Returns nil if no applicable child is found."
4787 (js2-node-find-child-before pos parent 'after))
4789 (defun js2-node-replace-child (pos parent new-node)
4790 "Replace node at index POS in PARENT with NEW-NODE.
4791 Only works for parents supported by `js2-node-child-list'."
4792 (let ((kids (js2-node-child-list parent))
4795 (setq kids (cdr kids)
4797 (setcar kids new-node)
4798 (js2-node-add-children parent new-node)))
4800 (defun js2-node-buffer (n)
4801 "Return the buffer associated with AST N.
4802 Returns nil if the buffer is not set as a property on the root
4803 node, or if parent links were not recorded during parsing."
4804 (let ((root (js2-node-root n)))
4806 (js2-ast-root-p root)
4807 (js2-ast-root-buffer root))))
4809 (defun js2-block-node-push (n kid)
4810 "Push js2-node KID onto the end of js2-block-node N's child list.
4811 KID is always added to the -end- of the kids list.
4812 Function also calls `js2-node-add-children' to add the parent link."
4813 (let ((kids (js2-node-child-list n)))
4815 (setcdr kids (nconc (cdr kids) (list kid)))
4816 (js2-node-set-child-list n (list kid)))
4817 (js2-node-add-children n kid)))
4819 (defun js2-node-string (node)
4820 (with-current-buffer (or (js2-node-buffer node)
4821 (error "No buffer available for node %s" node))
4822 (let ((pos (js2-node-abs-pos node)))
4823 (buffer-substring-no-properties pos (+ pos (js2-node-len node))))))
4825 ;; Container for storing the node we're looking for in a traversal.
4826 (js2-deflocal js2-discovered-node nil)
4828 ;; Keep track of absolute node position during traversals.
4829 (js2-deflocal js2-visitor-offset nil)
4831 (js2-deflocal js2-node-search-point nil)
4833 (when js2-mode-dev-mode-p
4834 (defun js2-find-node-at-point ()
4836 (let ((node (js2-node-at-point)))
4837 (message "%s" (or node "No node found at point"))))
4838 (defun js2-node-name-at-point ()
4840 (let ((node (js2-node-at-point)))
4841 (message "%s" (if node
4842 (js2-node-short-name node)
4843 "No node found at point.")))))
4845 (defun js2-node-at-point (&optional pos skip-comments)
4846 "Return AST node at POS, a buffer position, defaulting to current point.
4847 The `js2-mode-ast' variable must be set to the current parse tree.
4848 Signals an error if the AST (`js2-mode-ast') is nil.
4849 Always returns a node - if it can't find one, it returns the root.
4850 If SKIP-COMMENTS is non-nil, comment nodes are ignored."
4851 (let ((ast js2-mode-ast)
4854 (error "No JavaScript AST available"))
4855 ;; Look through comments first, since they may be inside nodes that
4856 ;; would otherwise report a match.
4857 (setq pos (or pos (point))
4858 result (if (> pos (js2-node-abs-end ast))
4860 (if (not skip-comments)
4861 (js2-comment-at-point pos))))
4863 (setq js2-discovered-node nil
4864 js2-visitor-offset 0
4865 js2-node-search-point pos)
4867 (catch 'js2-visit-done
4868 (js2-visit-ast ast #'js2-node-at-point-visitor))
4869 (setq js2-visitor-offset nil
4870 js2-node-search-point nil))
4871 (setq result js2-discovered-node))
4872 ;; may have found a comment beyond end of last child node,
4873 ;; since visiting the ast-root looks at the comment-list last.
4874 (if (and skip-comments
4875 (js2-comment-node-p result))
4877 (or result js2-mode-ast)))
4879 (defun js2-node-at-point-visitor (node end-p)
4880 (let ((rel-pos (js2-node-pos node))
4883 (point js2-node-search-point))
4886 ;; this evaluates to a non-nil return value, even if it's zero
4887 (cl-decf js2-visitor-offset rel-pos))
4888 ;; we already looked for comments before visiting, and don't want them now
4889 ((js2-comment-node-p node)
4892 (setq abs-pos (cl-incf js2-visitor-offset rel-pos)
4893 ;; we only want to use the node if the point is before
4894 ;; the last character position in the node, so we decrement
4895 ;; the absolute end by 1.
4896 abs-end (+ abs-pos (js2-node-len node) -1))
4898 ;; If this node starts after search-point, stop the search.
4900 (throw 'js2-visit-done nil))
4901 ;; If this node ends before the search-point, don't check kids.
4905 ;; Otherwise point is within this node, possibly in a child.
4906 (setq js2-discovered-node node)
4907 t)))))) ; keep processing kids to look for more specific match
4909 (defsubst js2-block-comment-p (node)
4910 "Return non-nil if NODE is a comment node of format `jsdoc' or `block'."
4911 (and (js2-comment-node-p node)
4912 (memq (js2-comment-node-format node) '(jsdoc block))))
4914 ;; TODO: put the comments in a vector and binary-search them instead
4915 (defun js2-comment-at-point (&optional pos)
4916 "Look through scanned comment nodes for one containing POS.
4917 POS is a buffer position that defaults to current point.
4918 Function returns nil if POS was not in any comment node."
4919 (let ((ast js2-mode-ast)
4920 (x (or pos (point)))
4923 (error "No JavaScript AST available"))
4925 ;; Comments are stored in lexical order.
4926 (dolist (comment (js2-ast-root-comments ast) nil)
4927 (setq beg (js2-node-abs-pos comment)
4928 end (+ beg (js2-node-len comment)))
4931 (throw 'done comment))))))
4933 (defun js2-mode-find-parent-fn (node)
4934 "Find function enclosing NODE.
4935 Returns nil if NODE is not inside a function."
4936 (setq node (js2-node-parent node))
4937 (while (and node (not (js2-function-node-p node)))
4938 (setq node (js2-node-parent node)))
4939 (and (js2-function-node-p node) node))
4941 (defun js2-mode-find-enclosing-fn (node)
4942 "Find function or root enclosing NODE."
4943 (if (js2-ast-root-p node)
4945 (setq node (js2-node-parent node))
4946 (while (not (or (js2-ast-root-p node)
4947 (js2-function-node-p node)))
4948 (setq node (js2-node-parent node)))
4951 (defun js2-mode-find-enclosing-node (beg end)
4952 "Find node fully enclosing BEG and END."
4953 (let ((node (js2-node-at-point beg))
4957 (if (or (js2-ast-root-p node)
4959 (<= (setq pos (js2-node-abs-pos node)) beg)
4960 (>= (+ pos (js2-node-len node)) end)))
4962 (setq node (js2-node-parent node))))
4965 (defun js2-node-parent-script-or-fn (node)
4966 "Find script or function immediately enclosing NODE.
4967 If NODE is the ast-root, returns nil."
4968 (if (js2-ast-root-p node)
4970 (setq node (js2-node-parent node))
4971 (while (and node (not (or (js2-function-node-p node)
4972 (js2-script-node-p node))))
4973 (setq node (js2-node-parent node)))
4976 (defun js2-node-is-descendant (node ancestor)
4977 "Return t if NODE is a descendant of ANCESTOR."
4979 (not (eq node ancestor)))
4980 (setq node (js2-node-parent node)))
4983 ;;; visitor infrastructure
4985 (defun js2-visit-none (_node _callback)
4986 "Visitor for AST node that have no node children."
4989 (defun js2-print-none (_node _indent)
4990 "Visitor for AST node with no printed representation.")
4992 (defun js2-print-body (node indent)
4993 "Print a statement, or a block without braces."
4994 (if (js2-block-node-p node)
4995 (dolist (kid (js2-block-node-kids node))
4996 (js2-print-ast kid indent))
4997 (js2-print-ast node indent)))
4999 (defun js2-print-list (args &optional delimiter)
5000 (cl-loop with len = (length args)
5004 (when arg (js2-print-ast arg 0))
5006 (insert (or delimiter ", ")))))
5008 (defun js2-print-tree (ast)
5009 "Prints an AST to the current buffer.
5010 Makes `js2-ast-parent-nodes' available to the printer functions."
5011 (let ((max-lisp-eval-depth (max max-lisp-eval-depth 1500)))
5012 (js2-print-ast ast)))
5014 (defun js2-print-ast (node &optional indent)
5015 "Helper function for printing AST nodes.
5016 Requires `js2-ast-parent-nodes' to be non-nil.
5017 You should use `js2-print-tree' instead of this function."
5018 (let ((printer (get (aref node 0) 'js2-printer))
5020 ;; TODO: wedge comments in here somewhere
5022 (funcall printer node i))))
5024 (defconst js2-side-effecting-tokens
5025 (let ((tokens (make-bool-vector js2-num-tokens nil)))
5026 (dolist (tt (list js2-ASSIGN
5096 (if js2-instanceof-has-side-effects
5097 (aset tokens js2-INSTANCEOF t))
5100 (defun js2-node-has-side-effects (node)
5101 "Return t if NODE has side effects."
5102 (when node ; makes it easier to handle malformed expressions
5103 (let ((tt (js2-node-type node)))
5105 ;; This doubtless needs some work, since EXPR_VOID is used
5106 ;; in several ways in Rhino and I may not have caught them all.
5107 ;; I'll wait for people to notice incorrect warnings.
5108 ((and (= tt js2-EXPR_VOID)
5109 (js2-expr-stmt-node-p node)) ; but not if EXPR_RESULT
5110 (let ((expr (js2-expr-stmt-node-expr node)))
5111 (or (js2-node-has-side-effects expr)
5112 (when (js2-string-node-p expr)
5113 (member (js2-string-node-value expr) '("use strict" "use asm"))))))
5115 (js2-node-has-side-effects (js2-infix-node-right node)))
5118 (or (js2-node-has-side-effects (js2-infix-node-right node))
5119 (js2-node-has-side-effects (js2-infix-node-left node))))
5121 (and (js2-node-has-side-effects (js2-cond-node-true-expr node))
5122 (js2-node-has-side-effects (js2-cond-node-false-expr node))))
5123 ((js2-paren-node-p node)
5124 (js2-node-has-side-effects (js2-paren-node-expr node)))
5125 ((= tt js2-ERROR) ; avoid cascaded error messages
5128 (aref js2-side-effecting-tokens tt))))))
5130 (defconst js2-stmt-node-types
5134 js2-DEFAULT ; e4x "default xml namespace" statement
5148 "Node types that only appear in statement contexts.
5149 The list does not include nodes that always appear as the child
5150 of another specific statement type, such as switch-cases,
5151 catch and finally blocks, and else-clauses. The list also excludes
5152 nodes like yield, let and var, which may appear in either expression
5153 or statement context, and in the latter context always have a
5154 `js2-expr-stmt-node' parent. Finally, the list does not include
5155 functions or scripts, which are treated separately from statements
5156 by the JavaScript parser and runtime.")
5158 (defun js2-stmt-node-p (node)
5159 "Heuristic for figuring out if NODE is a statement.
5160 Some node types can appear in either an expression context or a
5161 statement context, e.g. let-nodes, yield-nodes, and var-decl nodes.
5162 For these node types in a statement context, the parent will be a
5163 `js2-expr-stmt-node'.
5164 Functions aren't included in the check."
5165 (memq (js2-node-type node) js2-stmt-node-types))
5167 (defun js2-mode-find-first-stmt (node)
5168 "Search upward starting from NODE looking for a statement.
5169 For purposes of this function, a `js2-function-node' counts."
5170 (while (not (or (js2-stmt-node-p node)
5171 (js2-function-node-p node)))
5172 (setq node (js2-node-parent node)))
5175 (defun js2-node-parent-stmt (node)
5176 "Return the node's first ancestor that is a statement.
5177 Returns nil if NODE is a `js2-ast-root'. Note that any expression
5178 appearing in a statement context will have a parent that is a
5179 `js2-expr-stmt-node' that will be returned by this function."
5180 (let ((parent (js2-node-parent node)))
5181 (if (or (null parent)
5182 (js2-stmt-node-p parent)
5183 (and (js2-function-node-p parent)
5184 (not (eq (js2-function-node-form parent)
5185 'FUNCTION_EXPRESSION))))
5187 (js2-node-parent-stmt parent))))
5189 ;; In the Mozilla Rhino sources, Roshan James writes:
5190 ;; Does consistent-return analysis on the function body when strict mode is
5193 ;; function (x) { return (x+1) }
5197 ;; function (x) { if (x < 0) return (x+1); }
5199 ;; is not because the function can potentially return a value when the
5200 ;; condition is satisfied and if not, the function does not explicitly
5203 ;; This extends to checking mismatches such as "return" and "return <value>"
5204 ;; used in the same function. Warnings are not emitted if inconsistent
5205 ;; returns exist in code that can be statically shown to be unreachable.
5207 ;; function (x) { while (true) { ... if (..) { return value } ... } }
5209 ;; emits no warning. However if the loop had a break statement, then a
5210 ;; warning would be emitted.
5212 ;; The consistency analysis looks at control structures such as loops, ifs,
5213 ;; switch, try-catch-finally blocks, examines the reachable code paths and
5214 ;; warns the user about an inconsistent set of termination possibilities.
5216 ;; These flags enumerate the possible ways a statement/function can
5217 ;; terminate. These flags are used by endCheck() and by the Parser to
5218 ;; detect inconsistent return usage.
5220 ;; END_UNREACHED is reserved for code paths that are assumed to always be
5221 ;; able to execute (example: throw, continue)
5223 ;; END_DROPS_OFF indicates if the statement can transfer control to the
5224 ;; next one. Statement such as return dont. A compound statement may have
5225 ;; some branch that drops off control to the next statement.
5227 ;; END_RETURNS indicates that the statement can return with no value.
5228 ;; END_RETURNS_VALUE indicates that the statement can return a value.
5230 ;; A compound statement such as
5234 ;; Will be detected as (END_DROPS_OFF | END_RETURN_VALUE) by endCheck()
5236 (defconst js2-END_UNREACHED 0)
5237 (defconst js2-END_DROPS_OFF 1)
5238 (defconst js2-END_RETURNS 2)
5239 (defconst js2-END_RETURNS_VALUE 4)
5240 (defconst js2-END_YIELDS 8)
5242 (defun js2-has-consistent-return-usage (node)
5243 "Check that every return usage in a function body is consistent.
5244 Returns t if the function satisfies strict mode requirement."
5245 (let ((n (js2-end-check node)))
5246 ;; either it doesn't return a value in any branch...
5247 (or (js2-flag-not-set-p n js2-END_RETURNS_VALUE)
5248 ;; or it returns a value (or is unreached) at every branch
5249 (js2-flag-not-set-p n (logior js2-END_DROPS_OFF
5253 (defun js2-end-check-if (node)
5254 "Ensure that return usage in then/else blocks is consistent.
5255 If there is no else block, then the return statement can fall through.
5256 Returns logical OR of END_* flags"
5257 (let ((th (js2-if-node-then-part node))
5258 (el (js2-if-node-else-part node)))
5261 (logior (js2-end-check th) (if el
5263 js2-END_DROPS_OFF)))))
5265 (defun js2-end-check-switch (node)
5266 "Consistency of return statements is checked between the case statements.
5267 If there is no default, then the switch can fall through. If there is a
5268 default, we check to see if all code paths in the default return or if
5269 there is a code path that can fall through.
5270 Returns logical OR of END_* flags."
5271 (let ((rv js2-END_UNREACHED)
5273 ;; examine the cases
5275 (dolist (c (js2-switch-node-cases node))
5276 (if (js2-case-node-expr c)
5277 (js2-set-flag rv (js2-end-check-block c))
5278 (setq default-case c)
5279 (throw 'break nil))))
5280 ;; we don't care how the cases drop into each other
5281 (js2-clear-flag rv js2-END_DROPS_OFF)
5282 ;; examine the default
5283 (js2-set-flag rv (if default-case
5284 (js2-end-check default-case)
5288 (defun js2-end-check-try (node)
5289 "If the block has a finally, return consistency is checked in the
5290 finally block. If all code paths in the finally return, then the
5291 returns in the try-catch blocks don't matter. If there is a code path
5292 that does not return or if there is no finally block, the returns
5293 of the try and catch blocks are checked for mismatch.
5294 Returns logical OR of END_* flags."
5295 (let ((finally (js2-try-node-finally-block node))
5297 ;; check the finally if it exists
5298 (setq rv (if finally
5299 (js2-end-check (js2-finally-node-body finally))
5301 ;; If the finally block always returns, then none of the returns
5302 ;; in the try or catch blocks matter.
5303 (when (js2-flag-set-p rv js2-END_DROPS_OFF)
5304 (js2-clear-flag rv js2-END_DROPS_OFF)
5305 ;; examine the try block
5306 (js2-set-flag rv (js2-end-check (js2-try-node-try-block node)))
5307 ;; check each catch block
5308 (dolist (cb (js2-try-node-catch-clauses node))
5309 (js2-set-flag rv (js2-end-check cb))))
5312 (defun js2-end-check-loop (node)
5313 "Return statement in the loop body must be consistent.
5314 The default assumption for any kind of a loop is that it will eventually
5315 terminate. The only exception is a loop with a constant true condition.
5316 Code that follows such a loop is examined only if one can determine
5317 statically that there is a break out of the loop.
5319 for(... ; ... ; ...) {}
5324 Returns logical OR of END_* flags."
5325 (let ((rv (js2-end-check (js2-loop-node-body node)))
5327 ((js2-while-node-p node)
5328 (js2-while-node-condition node))
5329 ((js2-do-node-p node)
5330 (js2-do-node-condition node))
5331 ((js2-for-node-p node)
5332 (js2-for-node-condition node)))))
5334 ;; check to see if the loop condition is always true
5336 (eq (js2-always-defined-boolean-p condition) 'ALWAYS_TRUE))
5337 (js2-clear-flag rv js2-END_DROPS_OFF))
5339 ;; look for effect of breaks
5340 (js2-set-flag rv (js2-node-get-prop node
5345 (defun js2-end-check-block (node)
5346 "A general block of code is examined statement by statement.
5347 If any statement (even a compound one) returns in all branches, then
5348 subsequent statements are not examined.
5349 Returns logical OR of END_* flags."
5350 (let* ((rv js2-END_DROPS_OFF)
5351 (kids (js2-block-node-kids node))
5353 ;; Check each statement. If the statement can continue onto the next
5354 ;; one (i.e. END_DROPS_OFF is set), then check the next statement.
5355 (while (and n (js2-flag-set-p rv js2-END_DROPS_OFF))
5356 (js2-clear-flag rv js2-END_DROPS_OFF)
5357 (js2-set-flag rv (js2-end-check n))
5358 (setq kids (cdr kids)
5362 (defun js2-end-check-label (node)
5363 "A labeled statement implies that there may be a break to the label.
5364 The function processes the labeled statement and then checks the
5365 CONTROL_BLOCK_PROP property to see if there is ever a break to the
5367 Returns logical OR of END_* flags."
5368 (let ((rv (js2-end-check (js2-labeled-stmt-node-stmt node))))
5369 (logior rv (js2-node-get-prop node
5371 js2-END_UNREACHED))))
5373 (defun js2-end-check-break (node)
5374 "When a break is encountered annotate the statement being broken
5375 out of by setting its CONTROL_BLOCK_PROP property.
5376 Returns logical OR of END_* flags."
5377 (and (js2-break-node-target node)
5378 (js2-node-set-prop (js2-break-node-target node)
5383 (defun js2-end-check (node)
5384 "Examine the body of a function, doing a basic reachability analysis.
5385 Returns a combination of flags END_* flags that indicate
5386 how the function execution can terminate. These constitute only the
5387 pessimistic set of termination conditions. It is possible that at
5388 runtime certain code paths will never be actually taken. Hence this
5389 analysis will flag errors in cases where there may not be errors.
5390 Returns logical OR of END_* flags"
5393 ((js2-break-node-p node)
5394 (js2-end-check-break node))
5395 ((js2-expr-stmt-node-p node)
5396 (if (setq kid (js2-expr-stmt-node-expr node))
5399 ((or (js2-continue-node-p node)
5400 (js2-throw-node-p node))
5402 ((js2-return-node-p node)
5403 (if (setq kid (js2-return-node-retval node))
5404 js2-END_RETURNS_VALUE
5406 ((js2-loop-node-p node)
5407 (js2-end-check-loop node))
5408 ((js2-switch-node-p node)
5409 (js2-end-check-switch node))
5410 ((js2-labeled-stmt-node-p node)
5411 (js2-end-check-label node))
5412 ((js2-if-node-p node)
5413 (js2-end-check-if node))
5414 ((js2-try-node-p node)
5415 (js2-end-check-try node))
5416 ((js2-block-node-p node)
5417 (if (null (js2-block-node-kids node))
5419 (js2-end-check-block node)))
5420 ((js2-yield-node-p node)
5423 js2-END_DROPS_OFF))))
5425 (defun js2-always-defined-boolean-p (node)
5426 "Check if NODE always evaluates to true or false in boolean context.
5427 Returns 'ALWAYS_TRUE, 'ALWAYS_FALSE, or nil if it's neither always true
5429 (let ((tt (js2-node-type node))
5432 ((or (= tt js2-FALSE) (= tt js2-NULL))
5437 (setq num (js2-number-node-num-value node))
5438 (if (and (not (eq num 0.0e+NaN))
5445 ;;; Scanner -- a port of Mozilla Rhino's lexer.
5446 ;; Corresponds to Rhino files Token.java and TokenStream.java.
5448 (defvar js2-tokens nil
5449 "List of all defined token names.") ; initialized in `js2-token-names'
5451 (defconst js2-token-names
5452 (let* ((names (make-vector js2-num-tokens -1))
5453 (case-fold-search nil) ; only match js2-UPPER_CASE
5454 (syms (apropos-internal "^js2-\\(?:[[:upper:]_]+\\)")))
5455 (cl-loop for sym in syms
5458 (unless (or (memq sym '(js2-EOF_CHAR js2-ERROR))
5460 (aset names (symbol-value sym) ; code, e.g. 152
5462 (substring (symbol-name sym) 4))) ; name, e.g. "let"
5463 (push sym js2-tokens)))
5465 "Vector mapping int values to token string names, sans `js2-' prefix.")
5467 (defun js2-tt-name (tok)
5468 "Return a string name for TOK, a token symbol or code.
5469 Signals an error if it's not a recognized token."
5472 (setq code (symbol-value tok)))
5475 (if (and (numberp code)
5476 (not (cl-minusp code))
5477 (< code js2-num-tokens))
5478 (aref js2-token-names code)
5479 (error "Invalid token: %s" code)))))
5481 (defsubst js2-tt-sym (tok)
5482 "Return symbol for TOK given its code, e.g. 'js2-LP for code 86."
5483 (intern (js2-tt-name tok)))
5485 (defconst js2-token-codes
5486 (let ((table (make-hash-table :test 'eq :size 256)))
5487 (cl-loop for name across js2-token-names
5488 for sym = (intern (concat "js2-" (upcase name)))
5490 (puthash sym (symbol-value sym) table))
5491 ;; clean up a few that are "wrong" in Rhino's token codes
5492 (puthash 'js2-DELETE js2-DELPROP table)
5494 "Hashtable mapping token type symbols to their bytecodes.")
5496 (defsubst js2-tt-code (sym)
5497 "Return code for token symbol SYM, e.g. 86 for 'js2-LP."
5498 (or (gethash sym js2-token-codes)
5499 (error "Invalid token symbol: %s " sym))) ; signal code bug
5501 (defun js2-report-scan-error (msg &optional no-throw beg len)
5502 (setf (js2-token-end (js2-current-token)) js2-ts-cursor)
5503 (js2-report-error msg nil
5504 (or beg (js2-current-token-beg))
5505 (or len (js2-current-token-len)))
5507 (throw 'return js2-ERROR)))
5509 (defun js2-set-string-from-buffer (token)
5510 "Set `string' and `end' slots for TOKEN, return the string."
5511 (setf (js2-token-end token) js2-ts-cursor
5512 (js2-token-string token) (js2-collect-string js2-ts-string-buffer)))
5514 ;; TODO: could potentially avoid a lot of consing by allocating a
5515 ;; char buffer the way Rhino does.
5516 (defsubst js2-add-to-string (c)
5517 (push c js2-ts-string-buffer))
5519 ;; Note that when we "read" the end-of-file, we advance js2-ts-cursor
5520 ;; to (1+ (point-max)), which lets the scanner treat end-of-file like
5521 ;; any other character: when it's not part of the current token, we
5522 ;; unget it, allowing it to be read again by the following call.
5523 (defsubst js2-unget-char ()
5524 (cl-decf js2-ts-cursor))
5526 ;; Rhino distinguishes \r and \n line endings. We don't need to
5527 ;; because we only scan from Emacs buffers, which always use \n.
5528 (defun js2-get-char ()
5529 "Read and return the next character from the input buffer.
5530 Increments `js2-ts-lineno' if the return value is a newline char.
5531 Updates `js2-ts-cursor' to the point after the returned char.
5532 Returns `js2-EOF_CHAR' if we hit the end of the buffer.
5533 Also updates `js2-ts-hit-eof' and `js2-ts-line-start' as needed."
5535 ;; check for end of buffer
5536 (if (>= js2-ts-cursor (point-max))
5537 (setq js2-ts-hit-eof t
5538 js2-ts-cursor (1+ js2-ts-cursor)
5539 c js2-EOF_CHAR) ; return value
5540 ;; otherwise read next char
5541 (setq c (char-before (cl-incf js2-ts-cursor)))
5542 ;; if we read a newline, update counters
5544 (setq js2-ts-line-start js2-ts-cursor
5545 js2-ts-lineno (1+ js2-ts-lineno)))
5546 ;; TODO: skip over format characters
5549 (defun js2-read-unicode-escape ()
5550 "Read a \\uNNNN sequence from the input.
5551 Assumes the ?\ and ?u have already been read.
5552 Returns the unicode character, or nil if it wasn't a valid character.
5553 Doesn't change the values of any scanner variables."
5554 ;; I really wish I knew a better way to do this, but I can't
5555 ;; find the Emacs function that takes a 16-bit int and converts
5556 ;; it to a Unicode/utf-8 character. So I basically eval it with (read).
5557 ;; Have to first check that it's 4 hex characters or it may stop
5560 (let ((s (buffer-substring-no-properties js2-ts-cursor
5561 (+ 4 js2-ts-cursor))))
5562 (if (string-match "[0-9a-fA-F]\\{4\\}" s)
5563 (read (concat "?\\u" s))))))
5565 (defun js2-match-char (test)
5566 "Consume and return next character if it matches TEST, a character.
5567 Returns nil and consumes nothing if TEST is not the next character."
5568 (let ((c (js2-get-char)))
5574 (defun js2-peek-char ()
5579 (defun js2-identifier-start-p (c)
5580 "Is C a valid start to an ES5 Identifier?
5581 See http://es5.github.io/#x7.6"
5584 (memq (get-char-code-property c 'general-category)
5586 '(Lu Ll Lt Lm Lo Nl))))
5588 (defun js2-identifier-part-p (c)
5589 "Is C a valid part of an ES5 Identifier?
5590 See http://es5.github.io/#x7.6"
5592 (memq c '(?$ ?_ ?\u200c ?\u200d))
5593 (memq (get-char-code-property c 'general-category)
5600 ;; Connector Punctuation
5603 (defun js2-alpha-p (c)
5604 (cond ((and (<= ?A c) (<= c ?Z)) t)
5605 ((and (<= ?a c) (<= c ?z)) t)
5608 (defsubst js2-digit-p (c)
5609 (and (<= ?0 c) (<= c ?9)))
5611 (defun js2-js-space-p (c)
5613 (memq c '(#x20 #x9 #xB #xC #xD))
5616 ;; TODO: change this nil to check for Unicode space character
5619 (defconst js2-eol-chars (list js2-EOF_CHAR ?\n ?\r))
5621 (defun js2-skip-line ()
5622 "Skip to end of line."
5623 (while (not (memq (js2-get-char) js2-eol-chars)))
5625 (setf (js2-token-end (js2-current-token)) js2-ts-cursor))
5627 (defun js2-init-scanner (&optional buf line)
5628 "Create token stream for BUF starting on LINE.
5629 BUF defaults to `current-buffer' and LINE defaults to 1.
5631 A buffer can only have one scanner active at a time, which yields
5632 dramatically simpler code than using a defstruct. If you need to
5633 have simultaneous scanners in a buffer, copy the regions to scan
5635 (with-current-buffer (or buf (current-buffer))
5636 (setq js2-ts-dirty-line nil
5639 js2-ts-lineno (or line 1)
5640 js2-ts-line-end-char -1
5641 js2-ts-cursor (point-min)
5642 js2-ti-tokens (make-vector js2-ti-ntokens nil)
5643 js2-ti-tokens-cursor 0
5645 js2-ts-is-xml-attribute nil
5646 js2-ts-xml-is-tag-content nil
5647 js2-ts-xml-open-tags-count 0
5648 js2-ts-string-buffer nil)))
5650 ;; This function uses the cached op, string and number fields in
5651 ;; TokenStream; if getToken has been called since the passed token
5652 ;; was scanned, the op or string printed may be incorrect.
5653 (defun js2-token-to-string (token)
5654 ;; Not sure where this function is used in Rhino. Not tested.
5655 (if (not js2-debug-print-trees)
5657 (let ((name (js2-tt-name token)))
5659 ((memq token '(js2-STRING js2-REGEXP js2-NAME
5660 js2-TEMPLATE_HEAD js2-NO_SUBS_TEMPLATE))
5661 (concat name " `" (js2-current-token-string) "'"))
5662 ((eq token js2-NUMBER)
5663 (format "NUMBER %g" (js2-token-number (js2-current-token))))
5667 (defconst js2-keywords
5669 case catch class const continue
5670 debugger default delete do
5672 false finally for function
5673 if in instanceof import
5678 this throw true try typeof
5683 ;; Token names aren't exactly the same as the keywords, unfortunately.
5684 ;; E.g. delete is js2-DELPROP.
5685 (defconst js2-kwd-tokens
5686 (let ((table (make-vector js2-num-tokens nil))
5689 js2-CASE js2-CATCH js2-CLASS js2-CONST js2-CONTINUE
5690 js2-DEBUGGER js2-DEFAULT js2-DELPROP js2-DO
5692 js2-ELSE js2-EXTENDS js2-EXPORT
5693 js2-FALSE js2-FINALLY js2-FOR js2-FUNCTION
5694 js2-IF js2-IN js2-INSTANCEOF js2-IMPORT
5698 js2-SUPER js2-SWITCH
5699 js2-THIS js2-THROW js2-TRUE js2-TRY js2-TYPEOF
5704 (aset table i 'font-lock-keyword-face))
5705 (aset table js2-STRING 'font-lock-string-face)
5706 (aset table js2-REGEXP 'font-lock-string-face)
5707 (aset table js2-NO_SUBS_TEMPLATE 'font-lock-string-face)
5708 (aset table js2-TEMPLATE_HEAD 'font-lock-string-face)
5709 (aset table js2-COMMENT 'font-lock-comment-face)
5710 (aset table js2-THIS 'font-lock-builtin-face)
5711 (aset table js2-SUPER 'font-lock-builtin-face)
5712 (aset table js2-VOID 'font-lock-constant-face)
5713 (aset table js2-NULL 'font-lock-constant-face)
5714 (aset table js2-TRUE 'font-lock-constant-face)
5715 (aset table js2-FALSE 'font-lock-constant-face)
5716 (aset table js2-NOT 'font-lock-negation-char-face)
5718 "Vector whose values are non-nil for tokens that are keywords.
5719 The values are default faces to use for highlighting the keywords.")
5721 ;; FIXME: Support strict mode-only future reserved words, after we know
5722 ;; which parts scopes are in strict mode, and which are not.
5723 (defconst js2-reserved-words '(class enum export extends import static super)
5724 "Future reserved keywords in ECMAScript 5.1.")
5726 (defconst js2-keyword-names
5727 (let ((table (make-hash-table :test 'equal)))
5728 (cl-loop for k in js2-keywords
5730 (symbol-name k) ; instanceof
5731 (intern (concat "js2-"
5732 (upcase (symbol-name k)))) ; js2-INSTANCEOF
5735 "JavaScript keywords by name, mapped to their symbols.")
5737 (defconst js2-reserved-word-names
5738 (let ((table (make-hash-table :test 'equal)))
5739 (cl-loop for k in js2-reserved-words
5741 (puthash (symbol-name k) 'js2-RESERVED table))
5743 "JavaScript reserved words by name, mapped to 'js2-RESERVED.")
5745 (defun js2-collect-string (buf)
5746 "Convert BUF, a list of chars, to a string.
5747 Reverses BUF before converting."
5749 (apply #'string (nreverse buf))
5752 (defun js2-string-to-keyword (s)
5753 "Return token for S, a string, if S is a keyword or reserved word.
5754 Returns a symbol such as 'js2-BREAK, or nil if not keyword/reserved."
5755 (or (gethash s js2-keyword-names)
5756 (gethash s js2-reserved-word-names)))
5758 (defsubst js2-ts-set-char-token-bounds (token)
5759 "Used when next token is one character."
5760 (setf (js2-token-beg token) (1- js2-ts-cursor)
5761 (js2-token-end token) js2-ts-cursor))
5763 (defsubst js2-ts-return (token type)
5764 "Update the `end' and `type' slots of TOKEN,
5765 then throw `return' with value TYPE."
5766 (setf (js2-token-end token) js2-ts-cursor
5767 (js2-token-type token) type)
5768 (throw 'return type))
5770 (defun js2-x-digit-to-int (c accumulator)
5771 "Build up a hex number.
5772 If C is a hexadecimal digit, return ACCUMULATOR * 16 plus
5773 corresponding number. Otherwise return -1."
5776 ;; Use 0..9 < A..Z < a..z
5781 (throw 'check nil)))
5784 (cl-decf c (- ?A 10))
5785 (throw 'check nil)))
5788 (cl-decf c (- ?a 10))
5789 (throw 'check nil))))
5791 (logior c (lsh accumulator 4))))
5793 (defun js2-get-token (&optional modifier)
5794 "If `js2-ti-lookahead' is zero, call scanner to get new token.
5795 Otherwise, move `js2-ti-tokens-cursor' and return the type of
5798 This function will not return a newline (js2-EOL) - instead, it
5799 gobbles newlines until it finds a non-newline token. Call
5800 `js2-peek-token-or-eol' when you care about newlines.
5802 This function will also not return a js2-COMMENT. Instead, it
5803 records comments found in `js2-scanned-comments'. If the token
5804 returned by this function immediately follows a jsdoc comment,
5805 the token is flagged as such."
5806 (if (zerop js2-ti-lookahead)
5807 (js2-get-token-internal modifier)
5808 (cl-decf js2-ti-lookahead)
5809 (setq js2-ti-tokens-cursor (mod (1+ js2-ti-tokens-cursor) js2-ti-ntokens))
5810 (let ((tt (js2-current-token-type)))
5811 (cl-assert (not (= tt js2-EOL)))
5814 (defun js2-unget-token ()
5815 (cl-assert (< js2-ti-lookahead js2-ti-max-lookahead))
5816 (cl-incf js2-ti-lookahead)
5817 (setq js2-ti-tokens-cursor (mod (1- js2-ti-tokens-cursor) js2-ti-ntokens)))
5819 (defun js2-get-token-internal (modifier)
5820 (let* ((token (js2-get-token-internal-1 modifier)) ; call scanner
5821 (tt (js2-token-type token))
5825 (while (or (= tt js2-EOL) (= tt js2-COMMENT))
5829 (when js2-record-comments
5830 (js2-record-comment token)))
5831 (setq js2-ti-tokens-cursor (mod (1- js2-ti-tokens-cursor) js2-ti-ntokens))
5832 (setq token (js2-get-token-internal-1 modifier) ; call scanner again
5833 tt (js2-token-type token)))
5836 (setf (js2-token-follows-eol-p token) t))
5838 ;; perform lexical fontification as soon as token is scanned
5839 (when js2-parse-ide-mode
5842 (js2-record-face 'js2-error token))
5843 ((setq face (aref js2-kwd-tokens tt))
5844 (js2-record-face face token))
5845 ((and (= tt js2-NAME)
5846 (equal (js2-token-string token) "undefined"))
5847 (js2-record-face 'font-lock-constant-face token))))
5850 (defsubst js2-string-to-number (str base)
5851 ;; TODO: Maybe port ScriptRuntime.stringToNumber.
5853 (string-to-number str base)
5854 (overflow-error -1)))
5856 (defun js2-get-token-internal-1 (modifier)
5857 "Return next JavaScript token type, an int such as js2-RETURN.
5858 During operation, creates an instance of `js2-token' struct, sets
5859 its relevant fields and puts it into `js2-ti-tokens'."
5860 (let (identifier-start
5861 is-unicode-escape-start c
5862 contains-escape escape-val str result base
5863 look-for-slash continue tt
5864 (token (js2-new-token 0)))
5868 (when (eq modifier 'TEMPLATE_TAIL)
5869 (setf (js2-token-beg token) (1- js2-ts-cursor))
5870 (throw 'return (js2-get-string-or-template-token ?` token)))
5872 ;; Eat whitespace, possibly sensitive to newlines.
5875 (setq c (js2-get-char))
5877 ((eq c js2-EOF_CHAR)
5879 (js2-ts-set-char-token-bounds token)
5880 (throw 'return js2-EOF))
5882 (js2-ts-set-char-token-bounds token)
5883 (setq js2-ts-dirty-line nil)
5884 (throw 'return js2-EOL))
5885 ((not (js2-js-space-p c))
5886 (if (/= c ?-) ; in case end of HTML comment
5887 (setq js2-ts-dirty-line t))
5888 (setq continue nil))))
5889 ;; Assume the token will be 1 char - fixed up below.
5890 (js2-ts-set-char-token-bounds token)
5892 (throw 'return js2-XMLATTR))
5893 ;; identifier/keyword/instanceof?
5894 ;; watch out for starting with a <backslash>
5897 (setq c (js2-get-char))
5899 (setq identifier-start t
5900 is-unicode-escape-start t
5901 js2-ts-string-buffer nil)
5902 (setq identifier-start nil)
5906 (when (setq identifier-start (js2-identifier-start-p c))
5907 (setq js2-ts-string-buffer nil)
5908 (js2-add-to-string c))))
5909 (when identifier-start
5910 (setq contains-escape is-unicode-escape-start)
5913 (if is-unicode-escape-start
5914 ;; strictly speaking we should probably push-back
5915 ;; all the bad characters if the <backslash>uXXXX
5916 ;; sequence is malformed. But since there isn't a
5917 ;; correct context(is there?) for a bad Unicode
5918 ;; escape sequence in an identifier, we can report
5923 (setq c (js2-get-char)
5924 escape-val (js2-x-digit-to-int c escape-val))
5925 ;; Next check takes care of c < 0 and bad escape
5926 (if (cl-minusp escape-val)
5927 (throw 'break nil)))
5928 (if (cl-minusp escape-val)
5929 (js2-report-scan-error "msg.invalid.escape" t))
5930 (js2-add-to-string escape-val)
5931 (setq is-unicode-escape-start nil))
5932 (setq c (js2-get-char))
5935 (setq c (js2-get-char))
5937 (setq is-unicode-escape-start t
5939 (js2-report-scan-error "msg.illegal.character" t)))
5941 (if (or (eq c js2-EOF_CHAR)
5942 (not (js2-identifier-part-p c)))
5944 (js2-add-to-string c))))))
5946 (setf str (js2-collect-string js2-ts-string-buffer)
5947 (js2-token-end token) js2-ts-cursor)
5948 ;; FIXME: Invalid in ES5 and ES6, see
5949 ;; https://bugzilla.mozilla.org/show_bug.cgi?id=694360
5950 ;; Probably should just drop this conditional.
5951 (unless contains-escape
5952 ;; OPT we shouldn't have to make a string (object!) to
5953 ;; check if it's a keyword.
5954 ;; Return the corresponding token if it's a keyword
5955 (when (and (not (eq modifier 'KEYWORD_IS_NAME))
5956 (setq result (js2-string-to-keyword str)))
5957 (if (and (< js2-language-version 170)
5958 (memq result '(js2-LET js2-YIELD)))
5959 ;; LET and YIELD are tokens only in 1.7 and later
5960 (setq result 'js2-NAME))
5961 (when (eq result 'js2-RESERVED)
5962 (setf (js2-token-string token) str))
5963 (throw 'return (js2-tt-code result))))
5964 ;; If we want to intern these as Rhino does, just use (intern str)
5965 (setf (js2-token-string token) str)
5966 (throw 'return js2-NAME)) ; end identifier/kwd check
5968 (when (or (js2-digit-p c)
5969 (and (eq c ?.) (js2-digit-p (js2-peek-char))))
5970 (setq js2-ts-string-buffer nil
5973 (setq c (js2-get-char))
5975 ((or (eq c ?x) (eq c ?X))
5977 (setq c (js2-get-char)))
5978 ((and (or (eq c ?b) (eq c ?B))
5979 (>= js2-language-version 200))
5981 (setq c (js2-get-char)))
5982 ((and (or (eq c ?o) (eq c ?O))
5983 (>= js2-language-version 200))
5985 (setq c (js2-get-char)))
5987 (setq base 'maybe-8))
5989 (js2-add-to-string ?0))))
5992 (if (> 0 (js2-x-digit-to-int c 0))
5993 (js2-report-scan-error "msg.missing.hex.digits")
5994 (while (<= 0 (js2-x-digit-to-int c 0))
5995 (js2-add-to-string c)
5996 (setq c (js2-get-char)))))
5998 (if (not (memq c '(?0 ?1)))
5999 (js2-report-scan-error "msg.missing.binary.digits")
6000 (while (memq c '(?0 ?1))
6001 (js2-add-to-string c)
6002 (setq c (js2-get-char)))))
6004 (if (or (> ?0 c) (< ?7 c))
6005 (js2-report-scan-error "msg.missing.octal.digits")
6006 (while (and (<= ?0 c) (>= ?7 c))
6007 (js2-add-to-string c)
6008 (setq c (js2-get-char)))))
6010 (while (and (<= ?0 c) (<= c ?9))
6011 ;; We permit 08 and 09 as decimal numbers, which
6012 ;; makes our behavior a superset of the ECMA
6013 ;; numeric grammar. We might not always be so
6014 ;; permissive, so we warn about it.
6015 (when (and (eq base 'maybe-8) (>= c ?8))
6016 (js2-report-warning "msg.bad.octal.literal"
6017 (if (eq c ?8) "8" "9"))
6019 (js2-add-to-string c)
6020 (setq c (js2-get-char)))
6021 (when (eq base 'maybe-8)
6023 (when (and (eq base 10) (memq c '(?. ?e ?E)))
6026 (js2-add-to-string c)
6027 (setq c (js2-get-char))
6028 while (js2-digit-p c)))
6029 (when (memq c '(?e ?E))
6030 (js2-add-to-string c)
6031 (setq c (js2-get-char))
6032 (when (memq c '(?+ ?-))
6033 (js2-add-to-string c)
6034 (setq c (js2-get-char)))
6035 (unless (js2-digit-p c)
6036 (js2-report-scan-error "msg.missing.exponent" t))
6038 (js2-add-to-string c)
6039 (setq c (js2-get-char))
6040 while (js2-digit-p c))))
6042 (let ((str (js2-set-string-from-buffer token)))
6043 (setf (js2-token-number token) (js2-string-to-number str base)
6044 (js2-token-number-base token) base))
6045 (throw 'return js2-NUMBER))
6047 (when (or (memq c '(?\" ?\'))
6048 (and (>= js2-language-version 200)
6051 (js2-get-string-or-template-token c token)))
6052 (js2-ts-return token
6055 (throw 'return js2-SEMI))
6057 (throw 'return js2-LB))
6059 (throw 'return js2-RB))
6061 (throw 'return js2-LC))
6063 (throw 'return js2-RC))
6065 (throw 'return js2-LP))
6067 (throw 'return js2-RP))
6069 (throw 'return js2-COMMA))
6071 (throw 'return js2-HOOK))
6073 (if (js2-match-char ?:)
6075 (throw 'return js2-COLON)))
6077 (if (js2-match-char ?.)
6078 (if (js2-match-char ?.)
6079 js2-TRIPLEDOT js2-DOTDOT)
6080 (if (js2-match-char ?\()
6082 (throw 'return js2-DOT))))
6084 (if (js2-match-char ?|)
6085 (throw 'return js2-OR)
6086 (if (js2-match-char ?=)
6088 (throw 'return js2-BITOR))))
6090 (if (js2-match-char ?=)
6092 (throw 'return js2-BITXOR)))
6094 (if (js2-match-char ?&)
6095 (throw 'return js2-AND)
6096 (if (js2-match-char ?=)
6098 (throw 'return js2-BITAND))))
6100 (if (js2-match-char ?=)
6101 (if (js2-match-char ?=)
6103 (throw 'return js2-EQ))
6104 (if (js2-match-char ?>)
6105 (js2-ts-return token js2-ARROW)
6106 (throw 'return js2-ASSIGN))))
6108 (if (js2-match-char ?=)
6109 (if (js2-match-char ?=)
6112 (throw 'return js2-NOT)))
6114 ;; NB:treat HTML begin-comment as comment-till-eol
6115 (when (js2-match-char ?!)
6116 (when (js2-match-char ?-)
6117 (when (js2-match-char ?-)
6119 (setf (js2-token-comment-type (js2-current-token)) 'html)
6120 (throw 'return js2-COMMENT)))
6122 (if (js2-match-char ?<)
6123 (if (js2-match-char ?=)
6126 (if (js2-match-char ?=)
6128 (throw 'return js2-LT))))
6130 (if (js2-match-char ?>)
6131 (if (js2-match-char ?>)
6132 (if (js2-match-char ?=)
6135 (if (js2-match-char ?=)
6138 (if (js2-match-char ?=)
6140 (throw 'return js2-GT))))
6142 (if (js2-match-char ?=)
6144 (throw 'return js2-MUL)))
6146 ;; is it a // comment?
6147 (when (js2-match-char ?/)
6148 (setf (js2-token-beg token) (- js2-ts-cursor 2))
6150 (setf (js2-token-comment-type token) 'line)
6151 ;; include newline so highlighting goes to end of
6152 ;; window, if there actually is a newline; if we
6153 ;; hit eof, then implicitly there isn't
6154 (unless js2-ts-hit-eof
6155 (cl-incf (js2-token-end token)))
6156 (throw 'return js2-COMMENT))
6157 ;; is it a /* comment?
6158 (when (js2-match-char ?*)
6159 (setf look-for-slash nil
6160 (js2-token-beg token) (- js2-ts-cursor 2)
6161 (js2-token-comment-type token)
6162 (if (js2-match-char ?*)
6164 (setq look-for-slash t)
6168 (setq c (js2-get-char))
6170 ((eq c js2-EOF_CHAR)
6171 (setf (js2-token-end token) (1- js2-ts-cursor))
6172 (js2-report-error "msg.unterminated.comment")
6173 (throw 'return js2-COMMENT))
6175 (setq look-for-slash t))
6178 (js2-ts-return token js2-COMMENT)))
6180 (setf look-for-slash nil
6181 (js2-token-end token) js2-ts-cursor)))))
6182 (if (js2-match-char ?=)
6184 (throw 'return js2-DIV)))
6186 (when js2-skip-preprocessor-directives
6188 (setf (js2-token-comment-type token) 'preprocessor
6189 (js2-token-end token) js2-ts-cursor)
6190 (throw 'return js2-COMMENT))
6191 (throw 'return js2-ERROR))
6193 (if (js2-match-char ?=)
6195 (throw 'return js2-MOD)))
6197 (throw 'return js2-BITNOT))
6199 (if (js2-match-char ?=)
6201 (if (js2-match-char ?+)
6203 (throw 'return js2-ADD))))
6206 ((js2-match-char ?=)
6207 (setq c js2-ASSIGN_SUB))
6208 ((js2-match-char ?-)
6209 (unless js2-ts-dirty-line
6210 ;; treat HTML end-comment after possible whitespace
6211 ;; after line start as comment-until-eol
6212 (when (js2-match-char ?>)
6214 (setf (js2-token-comment-type (js2-current-token)) 'html)
6215 (throw 'return js2-COMMENT)))
6219 (setq js2-ts-dirty-line t)
6222 (js2-report-scan-error "msg.illegal.character")))))))
6223 (setf (js2-token-type token) tt)
6226 (defun js2-get-string-or-template-token (quote-char token)
6227 ;; We attempt to accumulate a string the fast way, by
6228 ;; building it directly out of the reader. But if there
6229 ;; are any escaped characters in the string, we revert to
6230 ;; building it out of a string buffer.
6231 (let ((c (js2-get-char))
6232 js2-ts-string-buffer
6233 nc c1 val escape-val)
6235 (while (/= c quote-char)
6237 (when (eq c js2-EOF_CHAR)
6239 (js2-report-error "msg.unterminated.string.lit")
6241 (when (and (eq c ?\n) (not (eq quote-char ?`)))
6243 (js2-report-error "msg.unterminated.string.lit")
6246 ;; We've hit an escaped character
6247 (setq c (js2-get-char))
6256 (setq c1 (js2-read-unicode-escape))
6257 (if js2-parse-ide-mode
6260 ;; just copy the string in IDE-mode
6261 (js2-add-to-string ?\\)
6262 (js2-add-to-string ?u)
6264 (js2-add-to-string (js2-get-char)))
6265 (setq c (js2-get-char))) ; added at end of loop
6266 ;; flag it as an invalid escape
6267 (js2-report-warning "msg.invalid.escape"
6268 nil (- js2-ts-cursor 2) 6))
6269 ;; Get 4 hex digits; if the u escape is not
6270 ;; followed by 4 hex digits, use 'u' + the
6271 ;; literal character sequence that follows.
6272 (js2-add-to-string ?u)
6275 (setq c (js2-get-char)
6276 escape-val (js2-x-digit-to-int c escape-val))
6277 (if (cl-minusp escape-val)
6278 (throw 'continue nil))
6279 (js2-add-to-string c))
6280 ;; prepare for replace of stored 'u' sequence by escape value
6281 (setq js2-ts-string-buffer (nthcdr 5 js2-ts-string-buffer)
6284 ;; Get 2 hex digits, defaulting to 'x'+literal
6285 ;; sequence, as above.
6286 (setq c (js2-get-char)
6287 escape-val (js2-x-digit-to-int c 0))
6288 (if (cl-minusp escape-val)
6290 (js2-add-to-string ?x)
6291 (throw 'continue nil))
6294 escape-val (js2-x-digit-to-int c escape-val))
6295 (if (cl-minusp escape-val)
6297 (js2-add-to-string ?x)
6298 (js2-add-to-string c1)
6299 (throw 'continue nil))
6301 (setq c escape-val))))
6303 ;; Remove line terminator after escape to follow
6304 ;; SpiderMonkey and C/C++
6305 (setq c (js2-get-char))
6306 (throw 'continue nil))
6308 (when (and (<= ?0 c) (< c ?8))
6311 (when (and (<= ?0 c) (< c ?8))
6312 (setq val (- (+ (* 8 val) c) ?0)
6314 (when (and (<= ?0 c)
6317 ;; c is 3rd char of octal sequence only
6318 ;; if the resulting val <= 0377
6319 (setq val (- (+ (* 8 val) c) ?0)
6323 (when (and (eq quote-char ?`) (eq c ?$))
6324 (when (eq (setq nc (js2-get-char)) ?\{)
6327 (js2-add-to-string c)
6328 (setq c (js2-get-char)))))
6329 (js2-set-string-from-buffer token)
6330 (if (not (eq quote-char ?`))
6332 (if (and (eq c ?$) (eq nc ?\{))
6334 js2-NO_SUBS_TEMPLATE))))
6336 (defun js2-read-regexp (start-tt)
6337 "Called by parser when it gets / or /= in literal context."
6339 in-class ; inside a '[' .. ']' character-class
6342 (token (js2-new-token 0)))
6343 (setq js2-ts-string-buffer nil)
6344 (if (eq start-tt js2-ASSIGN_DIV)
6346 (js2-add-to-string ?=)
6347 (if (not (eq start-tt js2-DIV))
6348 (error "failed assertion")))
6349 (while (and (not err)
6350 (or (/= (setq c (js2-get-char)) ?/)
6355 (setf (js2-token-end token) (1- js2-ts-cursor)
6357 (js2-token-string token) (js2-collect-string js2-ts-string-buffer))
6358 (js2-report-error "msg.unterminated.re.lit"))
6361 (js2-add-to-string c)
6362 (setq c (js2-get-char)))
6366 (setq in-class nil)))
6367 (js2-add-to-string c))))
6371 ((js2-match-char ?g)
6373 ((js2-match-char ?i)
6375 ((js2-match-char ?m)
6377 ((and (js2-match-char ?u)
6378 (>= js2-language-version 200))
6380 ((and (js2-match-char ?y)
6381 (>= js2-language-version 200))
6384 (setq continue nil))))
6385 (if (js2-alpha-p (js2-peek-char))
6386 (js2-report-scan-error "msg.invalid.re.flag" t
6388 (js2-set-string-from-buffer token))
6389 (js2-collect-string flags)))
6391 (defun js2-get-first-xml-token ()
6392 (setq js2-ts-xml-open-tags-count 0
6393 js2-ts-is-xml-attribute nil
6394 js2-ts-xml-is-tag-content nil)
6396 (js2-get-next-xml-token))
6398 (defun js2-xml-discard-string (token)
6399 "Throw away the string in progress and flag an XML parse error."
6400 (setf js2-ts-string-buffer nil
6401 (js2-token-string token) nil)
6402 (js2-report-scan-error "msg.XML.bad.form" t))
6404 (defun js2-get-next-xml-token ()
6405 (setq js2-ts-string-buffer nil) ; for recording the XML
6406 (let ((token (js2-new-token 0))
6411 (setq c (js2-get-char))
6414 (throw 'return js2-ERROR))
6415 (js2-ts-xml-is-tag-content
6418 (js2-add-to-string c)
6419 (setq js2-ts-xml-is-tag-content nil
6420 js2-ts-is-xml-attribute nil))
6422 (js2-add-to-string c)
6423 (when (eq ?> (js2-peek-char))
6424 (setq c (js2-get-char))
6425 (js2-add-to-string c)
6426 (setq js2-ts-xml-is-tag-content nil)
6427 (cl-decf js2-ts-xml-open-tags-count)))
6430 (js2-set-string-from-buffer token)
6431 (throw 'return js2-XML))
6433 (js2-add-to-string c)
6434 (unless (js2-read-quoted-string c token)
6435 (throw 'return js2-ERROR)))
6437 (js2-add-to-string c)
6438 (setq js2-ts-is-xml-attribute t))
6440 (js2-add-to-string c))
6442 (js2-add-to-string c)
6443 (setq js2-ts-is-xml-attribute nil)))
6444 (when (and (not js2-ts-xml-is-tag-content)
6445 (zerop js2-ts-xml-open-tags-count))
6446 (js2-set-string-from-buffer token)
6447 (throw 'return js2-XMLEND)))
6449 ;; else not tag content
6452 (js2-add-to-string c)
6453 (setq c (js2-peek-char))
6456 (setq c (js2-get-char)) ;; skip !
6457 (js2-add-to-string c)
6458 (setq c (js2-peek-char))
6461 (setq c (js2-get-char)) ;; skip -
6462 (js2-add-to-string c)
6465 (js2-add-to-string c)
6466 (unless (js2-read-xml-comment token)
6467 (throw 'return js2-ERROR)))
6468 (js2-xml-discard-string token)
6469 (throw 'return js2-ERROR)))
6471 (setq c (js2-get-char)) ;; skip [
6472 (js2-add-to-string c)
6473 (if (and (= (js2-get-char) ?C)
6474 (= (js2-get-char) ?D)
6475 (= (js2-get-char) ?A)
6476 (= (js2-get-char) ?T)
6477 (= (js2-get-char) ?A)
6478 (= (js2-get-char) ?\[))
6480 (js2-add-to-string ?C)
6481 (js2-add-to-string ?D)
6482 (js2-add-to-string ?A)
6483 (js2-add-to-string ?T)
6484 (js2-add-to-string ?A)
6485 (js2-add-to-string ?\[)
6486 (unless (js2-read-cdata token)
6487 (throw 'return js2-ERROR)))
6488 (js2-xml-discard-string token)
6489 (throw 'return js2-ERROR)))
6491 (unless (js2-read-entity token)
6492 (throw 'return js2-ERROR))))
6493 ;; Allow bare CDATA section, e.g.:
6494 ;; let xml = <![CDATA[ foo bar baz ]]>;
6495 (when (zerop js2-ts-xml-open-tags-count)
6496 (throw 'return js2-XMLEND)))
6498 (setq c (js2-get-char)) ;; skip ?
6499 (js2-add-to-string c)
6500 (unless (js2-read-PI token)
6501 (throw 'return js2-ERROR)))
6504 (setq c (js2-get-char)) ;; skip /
6505 (js2-add-to-string c)
6506 (when (zerop js2-ts-xml-open-tags-count)
6507 (js2-xml-discard-string token)
6508 (throw 'return js2-ERROR))
6509 (setq js2-ts-xml-is-tag-content t)
6510 (cl-decf js2-ts-xml-open-tags-count))
6513 (setq js2-ts-xml-is-tag-content t)
6514 (cl-incf js2-ts-xml-open-tags-count))))
6517 (js2-set-string-from-buffer token)
6518 (throw 'return js2-XML))
6520 (js2-add-to-string c))))))))
6521 (setf (js2-token-end token) js2-ts-cursor)
6522 (setf (js2-token-type token) result)
6525 (defun js2-read-quoted-string (quote token)
6528 (while (/= (setq c (js2-get-char)) js2-EOF_CHAR)
6529 (js2-add-to-string c)
6532 (js2-xml-discard-string token) ;; throw away string in progress
6535 (defun js2-read-xml-comment (token)
6536 (let ((c (js2-get-char)))
6538 (while (/= c js2-EOF_CHAR)
6540 (js2-add-to-string c)
6541 (when (and (eq c ?-) (eq ?- (js2-peek-char)))
6542 (setq c (js2-get-char))
6543 (js2-add-to-string c)
6544 (if (eq (js2-peek-char) ?>)
6546 (setq c (js2-get-char)) ;; skip >
6547 (js2-add-to-string c)
6549 (throw 'continue nil)))
6550 (setq c (js2-get-char))))
6551 (js2-xml-discard-string token)
6554 (defun js2-read-cdata (token)
6555 (let ((c (js2-get-char)))
6557 (while (/= c js2-EOF_CHAR)
6559 (js2-add-to-string c)
6560 (when (and (eq c ?\]) (eq (js2-peek-char) ?\]))
6561 (setq c (js2-get-char))
6562 (js2-add-to-string c)
6563 (if (eq (js2-peek-char) ?>)
6565 (setq c (js2-get-char)) ;; Skip >
6566 (js2-add-to-string c)
6568 (throw 'continue nil)))
6569 (setq c (js2-get-char))))
6570 (js2-xml-discard-string token)
6573 (defun js2-read-entity (token)
6577 (while (/= js2-EOF_CHAR (setq c (js2-get-char)))
6578 (js2-add-to-string c)
6581 (cl-incf decl-tags))
6584 (if (zerop decl-tags)
6585 (throw 'return t)))))
6586 (js2-xml-discard-string token)
6589 (defun js2-read-PI (token)
6590 "Scan an XML processing instruction."
6593 (while (/= js2-EOF_CHAR (setq c (js2-get-char)))
6594 (js2-add-to-string c)
6595 (when (and (eq c ??) (eq (js2-peek-char) ?>))
6596 (setq c (js2-get-char)) ;; Skip >
6597 (js2-add-to-string c)
6599 (js2-xml-discard-string token)
6604 (defun js2-set-face (beg end face &optional record)
6605 "Fontify a region. If RECORD is non-nil, record for later."
6606 (when (cl-plusp js2-highlight-level)
6607 (setq beg (min (point-max) beg)
6608 beg (max (point-min) beg)
6609 end (min (point-max) end)
6610 end (max (point-min) end))
6612 (push (list beg end face) js2-mode-fontifications)
6613 (put-text-property beg end 'font-lock-face face))))
6615 (defsubst js2-clear-face (beg end)
6616 (remove-text-properties beg end '(font-lock-face nil
6619 cursor-sensor-functions nil
6622 (defconst js2-ecma-global-props
6625 '("Infinity" "NaN" "undefined" "arguments") t)
6627 "Value properties of the Ecma-262 Global Object.
6628 Shown at or above `js2-highlight-level' 2.")
6630 ;; might want to add the name "arguments" to this list?
6631 (defconst js2-ecma-object-props
6634 '("prototype" "__proto__" "__parent__") t)
6636 "Value properties of the Ecma-262 Object constructor.
6637 Shown at or above `js2-highlight-level' 2.")
6639 (defconst js2-ecma-global-funcs
6643 '("decodeURI" "decodeURIComponent" "encodeURI" "encodeURIComponent"
6644 "eval" "isFinite" "isNaN" "parseFloat" "parseInt") t)
6646 "Function properties of the Ecma-262 Global object.
6647 Shown at or above `js2-highlight-level' 2.")
6649 (defconst js2-ecma-number-props
6651 (regexp-opt '("MAX_VALUE" "MIN_VALUE" "NaN"
6653 "POSITIVE_INFINITY") t)
6655 "Properties of the Ecma-262 Number constructor.
6656 Shown at or above `js2-highlight-level' 2.")
6658 (defconst js2-ecma-date-props "^\\(parse\\|UTC\\)$"
6659 "Properties of the Ecma-262 Date constructor.
6660 Shown at or above `js2-highlight-level' 2.")
6662 (defconst js2-ecma-math-props
6665 '("E" "LN10" "LN2" "LOG2E" "LOG10E" "PI" "SQRT1_2" "SQRT2")
6668 "Properties of the Ecma-262 Math object.
6669 Shown at or above `js2-highlight-level' 2.")
6671 (defconst js2-ecma-math-funcs
6674 '("abs" "acos" "asin" "atan" "atan2" "ceil" "cos" "exp" "floor"
6675 "log" "max" "min" "pow" "random" "round" "sin" "sqrt" "tan") t)
6677 "Function properties of the Ecma-262 Math object.
6678 Shown at or above `js2-highlight-level' 2.")
6680 (defconst js2-ecma-function-props
6684 '(;; properties of the Object prototype object
6685 "hasOwnProperty" "isPrototypeOf" "propertyIsEnumerable"
6686 "toLocaleString" "toString" "valueOf"
6687 ;; properties of the Function prototype object
6689 ;; properties of the Array prototype object
6690 "concat" "join" "pop" "push" "reverse" "shift" "slice" "sort"
6692 ;; properties of the String prototype object
6693 "charAt" "charCodeAt" "fromCharCode" "indexOf" "lastIndexOf"
6694 "localeCompare" "match" "replace" "search" "split" "substring"
6695 "toLocaleLowerCase" "toLocaleUpperCase" "toLowerCase"
6697 ;; properties of the Number prototype object
6698 "toExponential" "toFixed" "toPrecision"
6699 ;; properties of the Date prototype object
6700 "getDate" "getDay" "getFullYear" "getHours" "getMilliseconds"
6701 "getMinutes" "getMonth" "getSeconds" "getTime"
6702 "getTimezoneOffset" "getUTCDate" "getUTCDay" "getUTCFullYear"
6703 "getUTCHours" "getUTCMilliseconds" "getUTCMinutes" "getUTCMonth"
6704 "getUTCSeconds" "setDate" "setFullYear" "setHours"
6705 "setMilliseconds" "setMinutes" "setMonth" "setSeconds" "setTime"
6706 "setUTCDate" "setUTCFullYear" "setUTCHours" "setUTCMilliseconds"
6707 "setUTCMinutes" "setUTCMonth" "setUTCSeconds" "toDateString"
6708 "toLocaleDateString" "toLocaleString" "toLocaleTimeString"
6709 "toTimeString" "toUTCString"
6710 ;; properties of the RegExp prototype object
6712 ;; properties of the JSON prototype object
6714 ;; SpiderMonkey/Rhino extensions, versions 1.5+
6715 "toSource" "__defineGetter__" "__defineSetter__"
6716 "__lookupGetter__" "__lookupSetter__" "__noSuchMethod__"
6717 "every" "filter" "forEach" "lastIndexOf" "map" "some")
6720 "Built-in functions defined by Ecma-262 and SpiderMonkey extensions.
6721 Shown at or above `js2-highlight-level' 3.")
6723 (defun js2-parse-highlight-prop-get (parent target prop call-p)
6724 (let ((target-name (and target
6725 (js2-name-node-p target)
6726 (js2-name-node-name target)))
6727 (prop-name (if prop (js2-name-node-name prop)))
6728 (level2 (>= js2-highlight-level 2))
6729 (level3 (>= js2-highlight-level 3)))
6736 ((and level3 (string-match js2-ecma-function-props prop-name))
6737 'font-lock-builtin-face)
6738 ((and target-name prop)
6740 ((string= target-name "Date")
6741 (if (string-match js2-ecma-date-props prop-name)
6742 'font-lock-builtin-face))
6743 ((string= target-name "Math")
6744 (if (string-match js2-ecma-math-funcs prop-name)
6745 'font-lock-builtin-face))))))
6747 (if (string-match js2-ecma-global-funcs prop-name)
6748 'font-lock-builtin-face)))
6752 ((string= target-name "Number")
6753 (if (string-match js2-ecma-number-props prop-name)
6754 'font-lock-constant-face))
6755 ((string= target-name "Math")
6756 (if (string-match js2-ecma-math-props prop-name)
6757 'font-lock-constant-face))))
6759 (if (string-match js2-ecma-object-props prop-name)
6760 'font-lock-constant-face))))))
6761 (when (and (not face) prop-name)
6762 (setq face 'js2-object-property))
6764 (let ((pos (+ (js2-node-pos parent) ; absolute
6765 (js2-node-pos prop)))) ; relative
6767 (+ pos (js2-node-len prop))
6770 (defun js2-parse-highlight-member-expr-node (node)
6771 "Perform syntax highlighting of EcmaScript built-in properties.
6772 The variable `js2-highlight-level' governs this highlighting."
6773 (let (face target prop name pos end parent call-p callee)
6775 ;; case 1: simple name, e.g. foo
6776 ((js2-name-node-p node)
6777 (setq name (js2-name-node-name node))
6778 ;; possible for name to be nil in rare cases - saw it when
6779 ;; running js2-mode on an elisp buffer. Might as well try to
6780 ;; make it so js2-mode never barfs.
6782 (setq face (if (string-match js2-ecma-global-props name)
6783 'font-lock-constant-face))
6785 (setq pos (js2-node-pos node)
6786 end (+ pos (js2-node-len node)))
6787 (js2-set-face pos end face 'record))))
6788 ;; case 2: property access or function call
6789 ((or (js2-prop-get-node-p node)
6790 ;; highlight function call if expr is a prop-get node
6791 ;; or a plain name (i.e. unqualified function call)
6792 (and (setq call-p (js2-call-node-p node))
6793 (setq callee (js2-call-node-target node)) ; separate setq!
6794 (or (js2-prop-get-node-p callee)
6795 (js2-name-node-p callee))))
6797 node (if call-p callee node))
6798 (if (and call-p (js2-name-node-p callee))
6800 (setq target (js2-prop-get-node-left node)
6801 prop (js2-prop-get-node-right node)))
6803 ((js2-name-node-p prop)
6804 ;; case 2(a&c): simple or complex target, simple name, e.g. x[y].bar
6805 (js2-parse-highlight-prop-get parent target prop call-p))
6806 ((js2-name-node-p target)
6807 ;; case 2b: simple target, complex name, e.g. foo.x[y]
6808 (js2-parse-highlight-prop-get parent target nil call-p)))))))
6810 (defun js2-parse-highlight-member-expr-fn-name (expr)
6811 "Highlight the `baz' in function foo.bar.baz(args) {...}.
6812 This is experimental Rhino syntax. EXPR is the foo.bar.baz member expr.
6813 We currently only handle the case where the last component is a prop-get
6814 of a simple name. Called before EXPR has a parent node."
6816 (name (and (js2-prop-get-node-p expr)
6817 (js2-prop-get-node-right expr))))
6818 (when (js2-name-node-p name)
6819 (js2-set-face (setq pos (+ (js2-node-pos expr) ; parent is absolute
6820 (js2-node-pos name)))
6821 (+ pos (js2-node-len name))
6822 'font-lock-function-name-face
6825 ;; source: http://jsdoc.sourceforge.net/
6826 ;; Note - this syntax is for Google's enhanced jsdoc parser that
6827 ;; allows type specifications, and needs work before entering the wild.
6829 (defconst js2-jsdoc-param-tag-regexp
6830 (concat "^\\s-*\\*+\\s-*\\(@"
6831 "\\(?:param\\|arg\\(?:ument\\)?\\|prop\\(?:erty\\)?\\)"
6833 "\\s-*\\({[^}]+}\\)?" ; optional type
6834 "\\s-*\\[?\\([[:alnum:]_$\.]+\\)?\\]?" ; name
6836 "Matches jsdoc tags with optional type and optional param name.")
6838 (defconst js2-jsdoc-typed-tag-regexp
6839 (concat "^\\s-*\\*+\\s-*\\(@\\(?:"
6853 "\\)\\)\\s-*\\({[^}]+}\\)?")
6854 "Matches jsdoc tags with optional type.")
6856 (defconst js2-jsdoc-arg-tag-regexp
6857 (concat "^\\s-*\\*+\\s-*\\(@\\(?:"
6879 "\\)\\)\\s-+\\([^ \t]+\\)")
6880 "Matches jsdoc tags with a single argument.")
6882 (defconst js2-jsdoc-empty-tag-regexp
6883 (concat "^\\s-*\\*+\\s-*\\(@\\(?:"
6923 "Matches empty jsdoc tags.")
6925 (defconst js2-jsdoc-link-tag-regexp
6926 "{\\(@\\(?:link\\|code\\)\\)\\s-+\\([^#}\n]+\\)\\(#.+\\)?}"
6927 "Matches a jsdoc link or code tag.")
6929 (defconst js2-jsdoc-see-tag-regexp
6930 "^\\s-*\\*+\\s-*\\(@see\\)\\s-+\\([^#}\n]+\\)\\(#.+\\)?"
6931 "Matches a jsdoc @see tag.")
6933 (defconst js2-jsdoc-html-tag-regexp
6934 "\\(</?\\)\\([[:alpha:]]+\\)\\s-*\\(/?>\\)"
6935 "Matches a simple (no attributes) html start- or end-tag.")
6937 (defun js2-jsdoc-highlight-helper ()
6938 (js2-set-face (match-beginning 1)
6941 (if (match-beginning 2)
6943 (goto-char (match-beginning 2))
6944 (= (char-after) ?{))
6945 (js2-set-face (1+ (match-beginning 2))
6948 (js2-set-face (match-beginning 2)
6951 (if (match-beginning 3)
6952 (js2-set-face (match-beginning 3)
6956 (defun js2-highlight-jsdoc (ast)
6957 "Highlight doc comment tags."
6958 (let ((comments (js2-ast-root-comments ast))
6961 (dolist (node comments)
6962 (when (eq (js2-comment-node-format node) 'jsdoc)
6963 (setq beg (js2-node-abs-pos node)
6964 end (+ beg (js2-node-len node)))
6966 (narrow-to-region beg end)
6967 (dolist (re (list js2-jsdoc-param-tag-regexp
6968 js2-jsdoc-typed-tag-regexp
6969 js2-jsdoc-arg-tag-regexp
6970 js2-jsdoc-link-tag-regexp
6971 js2-jsdoc-see-tag-regexp
6972 js2-jsdoc-empty-tag-regexp))
6974 (while (re-search-forward re nil t)
6975 (js2-jsdoc-highlight-helper)))
6976 ;; simple highlighting for html tags
6978 (while (re-search-forward js2-jsdoc-html-tag-regexp nil t)
6979 (js2-set-face (match-beginning 1)
6981 'js2-jsdoc-html-tag-delimiter)
6982 (js2-set-face (match-beginning 2)
6984 'js2-jsdoc-html-tag-name)
6985 (js2-set-face (match-beginning 3)
6987 'js2-jsdoc-html-tag-delimiter))))))))
6989 (defun js2-highlight-assign-targets (_node left right)
6990 "Highlight function properties and external variables."
6992 ;; highlight vars and props assigned function values
6993 (when (or (js2-function-node-p right)
6994 (js2-class-node-p right))
6996 ;; var foo = function() {...}
6997 ((js2-name-node-p left)
6999 ;; foo.bar.baz = function() {...}
7000 ((and (js2-prop-get-node-p left)
7001 (js2-name-node-p (js2-prop-get-node-right left)))
7002 (setq name (js2-prop-get-node-right left))))
7004 (js2-set-face (setq leftpos (js2-node-abs-pos name))
7005 (+ leftpos (js2-node-len name))
7006 'font-lock-function-name-face
7009 (defun js2-record-name-node (node)
7010 "Saves NODE to `js2-recorded-identifiers' to check for undeclared variables
7011 later. NODE must be a name node."
7012 (let ((leftpos (js2-node-abs-pos node)))
7013 (push (list node js2-current-scope
7015 (+ leftpos (js2-node-len node)))
7016 js2-recorded-identifiers)))
7018 (defun js2-highlight-undeclared-vars ()
7019 "After entire parse is finished, look for undeclared variable references.
7020 We have to wait until entire buffer is parsed, since JavaScript permits var
7021 decls to occur after they're used.
7023 If any undeclared var name is in `js2-externs' or `js2-additional-externs',
7024 it is considered declared."
7026 (dolist (entry js2-recorded-identifiers)
7027 (cl-destructuring-bind (name-node scope pos end) entry
7028 (setq name (js2-name-node-name name-node))
7029 (unless (or (member name js2-global-externs)
7030 (member name js2-default-externs)
7031 (member name js2-additional-externs)
7032 (js2-get-defining-scope scope name pos))
7033 (js2-report-warning "msg.undeclared.variable" name pos (- end pos)
7034 'js2-external-variable))))))
7036 (defun js2--add-or-update-symbol (symbol inition used vars)
7037 "Add or update SYMBOL entry in VARS, an hash table.
7038 SYMBOL is a js2-name-node, INITION either nil, t, or ?P,
7039 respectively meaning that SYMBOL is a mere declaration, an
7040 assignment or a function parameter; when USED is t, the symbol
7041 node is assumed to be an usage and thus added to the list stored
7042 in the cdr of the entry.
7044 (let* ((nm (js2-name-node-name symbol))
7045 (es (js2-node-get-enclosing-scope symbol))
7046 (ds (js2-get-defining-scope es nm)))
7047 (when (and ds (not (equal nm "arguments")))
7048 (let* ((sym (js2-scope-get-symbol ds nm))
7049 (var (gethash sym vars))
7050 (err-var-p (js2-catch-node-p ds)))
7052 (setq inition err-var-p))
7055 (when (and inition (not (equal (car var) ?P)))
7056 (setcar var inition))
7058 (push symbol (cdr var))))
7059 ;; do not consider the declaration of catch parameter as an usage
7060 (when (and err-var-p used)
7062 (puthash sym (cons inition (if used (list symbol))) vars))))))
7064 (defun js2--classify-variables ()
7065 "Collect and classify variables declared or used within js2-mode-ast.
7066 Traverse the whole ast tree returning a summary of the variables
7067 usage as an hash-table, keyed by their corresponding symbol table
7069 Each variable is described by a tuple where the car is a flag
7070 indicating whether the variable has been initialized and the cdr
7071 is a possibly empty list of name nodes where it is used. External
7072 symbols, i.e. those not present in the whole scopes hierarchy,
7074 (let ((vars (make-hash-table :test #'eq :size 100)))
7077 (lambda (node end-p)
7080 ((js2-var-init-node-p node)
7081 ;; take note about possibly initialized declarations
7082 (let ((target (js2-var-init-node-target node))
7083 (initializer (js2-var-init-node-initializer node)))
7085 (let* ((parent (js2-node-parent node))
7086 (grandparent (if parent (js2-node-parent parent)))
7087 (inited (not (null initializer))))
7091 (js2-for-in-node-p grandparent)
7093 (mapcar #'js2-var-init-node-target
7094 (js2-var-decl-node-kids
7095 (js2-for-in-node-iterator grandparent)))))))
7096 (js2--add-or-update-symbol target inited nil vars)))))
7098 ((js2-assign-node-p node)
7099 ;; take note about assignments
7100 (let ((left (js2-assign-node-left node)))
7101 (when (js2-name-node-p left)
7102 (js2--add-or-update-symbol left t nil vars))))
7104 ((js2-prop-get-node-p node)
7105 ;; handle x.y.z nodes, considering only x
7106 (let ((left (js2-prop-get-node-left node)))
7107 (when (js2-name-node-p left)
7108 (js2--add-or-update-symbol left nil t vars))))
7110 ((js2-name-node-p node)
7111 ;; take note about used variables
7112 (let ((parent (js2-node-parent node)))
7114 (unless (or (and (js2-var-init-node-p parent) ; handled above
7115 (eq node (js2-var-init-node-target parent)))
7116 (and (js2-assign-node-p parent)
7117 (eq node (js2-assign-node-left parent)))
7118 (js2-prop-get-node-p parent))
7119 (let ((used t) inited)
7121 ((and (js2-function-node-p parent)
7122 (js2-wrapper-function-p parent))
7123 (setq inited (if (memq node (js2-function-node-params parent)) ?P t)))
7125 ((js2-for-in-node-p parent)
7126 (if (eq node (js2-for-in-node-iterator parent))
7127 (setq inited t used nil)))
7129 ((js2-function-node-p parent)
7130 (setq inited (if (memq node (js2-function-node-params parent)) ?P t)
7134 (let ((grandparent (js2-node-parent parent)))
7136 (setq used (js2-return-node-p grandparent)))))
7138 (js2--add-or-update-symbol node inited used vars))))))))
7142 (defun js2--get-name-node (node)
7144 ((js2-name-node-p node) node)
7145 ((js2-function-node-p node)
7146 (js2-function-node-name node))
7147 ((js2-class-node-p node)
7148 (js2-class-node-name node))
7149 ((js2-comp-loop-node-p node)
7150 (js2-comp-loop-node-iterator node))
7153 (defun js2--highlight-unused-variable (symbol info)
7154 (let ((name (js2-symbol-name symbol))
7158 (unless (and inited refs)
7161 (setq pos (js2-node-abs-pos ref))
7162 (setq len (js2-name-node-len ref))
7163 (js2-report-warning "msg.uninitialized.variable" name pos len
7165 (when (or js2-warn-about-unused-function-arguments
7166 (not (eq inited ?P)))
7167 (let* ((symn (js2-symbol-ast-node symbol))
7168 (namen (js2--get-name-node symn)))
7169 (unless (js2-node-top-level-decl-p namen)
7170 (setq pos (js2-node-abs-pos namen))
7171 (setq len (js2-name-node-len namen))
7172 (js2-report-warning "msg.unused.variable" name pos len
7173 'js2-warning))))))))
7175 (defun js2-highlight-unused-variables ()
7176 "Highlight unused variables."
7177 (let ((vars (js2--classify-variables)))
7178 (maphash #'js2--highlight-unused-variable vars)))
7181 (define-minor-mode js2-highlight-unused-variables-mode
7182 "Toggle highlight of unused variables."
7184 (if js2-highlight-unused-variables-mode
7185 (add-hook 'js2-post-parse-callbacks
7186 #'js2-highlight-unused-variables nil t)
7187 (remove-hook 'js2-post-parse-callbacks
7188 #'js2-highlight-unused-variables t)))
7190 (defun js2-set-default-externs ()
7191 "Set the value of `js2-default-externs' based on the various
7192 `js2-include-?-externs' variables."
7193 (setq js2-default-externs
7194 (append js2-ecma-262-externs
7195 (if js2-include-browser-externs js2-browser-externs)
7196 (if (and js2-include-browser-externs
7197 (>= js2-language-version 200)) js2-harmony-externs)
7198 (if js2-include-rhino-externs js2-rhino-externs)
7199 (if js2-include-node-externs js2-node-externs)
7200 (if (or js2-include-browser-externs js2-include-node-externs)
7201 js2-typed-array-externs))))
7203 (defun js2-apply-jslint-globals ()
7204 (setq js2-additional-externs
7205 (nconc (js2-get-jslint-globals)
7206 js2-additional-externs)))
7208 (defun js2-get-jslint-globals ()
7209 (cl-loop for node in (js2-ast-root-comments js2-mode-ast)
7210 when (and (eq 'block (js2-comment-node-format node))
7212 (goto-char (js2-node-abs-pos node))
7213 (looking-at "/\\*global ")))
7214 append (js2-get-jslint-globals-in
7216 (js2-node-abs-end node))))
7218 (defun js2-get-jslint-globals-in (beg end)
7222 (while (re-search-forward js2-mode-identifier-re end t)
7223 (let ((match (match-string 0)))
7224 (unless (member match '("true" "false"))
7225 (push match res)))))
7230 ;; We currently only support imenu, but eventually should support speedbar and
7231 ;; possibly other browsing mechanisms.
7233 ;; The basic strategy is to identify function assignment targets of the form
7234 ;; `foo.bar.baz', convert them to (list fn foo bar baz <position>), and push the
7235 ;; list into `js2-imenu-recorder'. The lists are merged into a trie-like tree
7236 ;; for imenu after parsing is finished.
7238 ;; A `foo.bar.baz' assignment target may be expressed in many ways in
7239 ;; JavaScript, and the general problem is undecidable. However, several forms
7240 ;; are readily recognizable at parse-time; the forms we attempt to recognize
7243 ;; function foo() -- function declaration
7244 ;; foo = function() -- function expression assigned to variable
7245 ;; foo.bar.baz = function() -- function expr assigned to nested property-get
7246 ;; foo = {bar: function()} -- fun prop in object literal assigned to var
7247 ;; foo = {bar: {baz: function()}} -- inside nested object literal
7248 ;; foo.bar = {baz: function()}} -- obj lit assigned to nested prop get
7249 ;; a.b = {c: {d: function()}} -- nested obj lit assigned to nested prop get
7250 ;; foo = {get bar() {...}} -- getter/setter in obj literal
7251 ;; function foo() {function bar() {...}} -- nested function
7252 ;; foo['a'] = function() -- fun expr assigned to deterministic element-get
7254 ;; This list boils down to a few forms that can be combined recursively.
7255 ;; Top-level named function declarations include both the left-hand (name)
7256 ;; and the right-hand (function value) expressions needed to produce an imenu
7257 ;; entry. The other "right-hand" forms we need to look for are:
7258 ;; - functions declared as props/getters/setters in object literals
7259 ;; - nested named function declarations
7260 ;; The "left-hand" expressions that functions can be assigned to include:
7261 ;; - local/global variables
7262 ;; - nested property-get expressions like a.b.c.d
7263 ;; - element gets like foo[10] or foo['bar'] where the index
7264 ;; expression can be trivially converted to a property name. They
7265 ;; effectively then become property gets.
7267 ;; All the different definition types are canonicalized into the form
7268 ;; foo.bar.baz = position-of-function-keyword
7270 ;; We need to build a trie-like structure for imenu. As an example,
7271 ;; consider the following JavaScript code:
7273 ;; a = function() {...} // function at position 5
7274 ;; b = function() {...} // function at position 25
7275 ;; foo = function() {...} // function at position 100
7276 ;; foo.bar = function() {...} // function at position 200
7277 ;; foo.bar.baz = function() {...} // function at position 300
7278 ;; foo.bar.zab = function() {...} // function at position 400
7280 ;; During parsing we accumulate an entry for each definition in
7281 ;; the variable `js2-imenu-recorder', like so:
7287 ;; (fn foo bar baz 300)
7288 ;; (fn foo bar zab 400))
7290 ;; Where 'fn' is the respective function node.
7291 ;; After parsing these entries are merged into this alist-trie:
7295 ;; (foo (<definition> . 3)
7296 ;; (bar (<definition> . 6)
7300 ;; Note the wacky need for a <definition> name. The token can be anything
7301 ;; that isn't a valid JavaScript identifier, because you might make foo
7302 ;; a function and then start setting properties on it that are also functions.
7304 (defun js2-prop-node-name (node)
7305 "Return the name of a node that may be a property-get/property-name.
7306 If NODE is not a valid name-node, string-node or integral number-node,
7307 returns nil. Otherwise returns the string name/value of the node."
7309 ((js2-name-node-p node)
7310 (js2-name-node-name node))
7311 ((js2-string-node-p node)
7312 (js2-string-node-value node))
7313 ((and (js2-number-node-p node)
7314 (string-match "^[0-9]+$" (js2-number-node-value node)))
7315 (js2-number-node-value node))
7316 ((eq (js2-node-type node) js2-THIS)
7318 ((eq (js2-node-type node) js2-SUPER)
7321 (defun js2-node-qname-component (node)
7322 "Return the name of this node, if it contributes to a qname.
7323 Returns nil if the node doesn't contribute."
7325 (or (js2-prop-node-name node)
7326 (if (and (js2-function-node-p node)
7327 (js2-function-node-name node))
7328 (js2-name-node-name (js2-function-node-name node))))))
7330 (defun js2-record-imenu-entry (fn-node qname pos)
7331 "Add an entry to `js2-imenu-recorder'.
7332 FN-NODE should be the current item's function node.
7334 Associate FN-NODE with its QNAME for later lookup.
7335 This is used in postprocessing the chain list. For each chain, we find
7336 the parent function, look up its qname, then prepend a copy of it to the chain."
7337 (push (cons fn-node (append qname (list pos))) js2-imenu-recorder)
7338 (unless js2-imenu-function-map
7339 (setq js2-imenu-function-map (make-hash-table :test 'eq)))
7340 (puthash fn-node qname js2-imenu-function-map))
7342 (defun js2-record-imenu-functions (node &optional var)
7343 "Record function definitions for imenu.
7344 NODE is a function node or an object literal.
7345 VAR, if non-nil, is the expression that NODE is being assigned to.
7346 When passed arguments of wrong type, does nothing."
7347 (when js2-parse-ide-mode
7348 (let ((fun-p (js2-function-node-p node))
7351 ;; non-anonymous function declaration?
7354 (setq fname-node (js2-function-node-name node)))
7355 (js2-record-imenu-entry node (list fname-node) (js2-node-pos node)))
7356 ;; for remaining forms, compute left-side tree branch first
7357 ((and var (setq qname (js2-compute-nested-prop-get var)))
7359 ;; foo.bar.baz = function
7361 (js2-record-imenu-entry node qname (js2-node-pos node)))
7362 ;; foo.bar.baz = object-literal
7363 ;; look for nested functions: {a: {b: function() {...} }}
7364 ((js2-object-node-p node)
7365 ;; Node position here is still absolute, since the parser
7366 ;; passes the assignment target and value expressions
7367 ;; to us before they are added as children of the assignment node.
7368 (js2-record-object-literal node qname (js2-node-pos node)))))))))
7370 (defun js2-compute-nested-prop-get (node)
7371 "If NODE is of form foo.bar, foo['bar'], or any nested combination, return
7372 component nodes as a list. Otherwise return nil. Element-gets are treated
7373 as property-gets if the index expression is a string, or a positive integer."
7374 (let (left right head)
7376 ((or (js2-name-node-p node)
7377 (js2-this-or-super-node-p node))
7379 ;; foo.bar.baz is parenthesized as (foo.bar).baz => right operand is a leaf
7380 ((js2-prop-get-node-p node) ; foo.bar
7381 (setq left (js2-prop-get-node-left node)
7382 right (js2-prop-get-node-right node))
7383 (if (setq head (js2-compute-nested-prop-get left))
7384 (nconc head (list right))))
7385 ((js2-elem-get-node-p node) ; foo['bar'] or foo[101]
7386 (setq left (js2-elem-get-node-target node)
7387 right (js2-elem-get-node-element node))
7388 (if (or (js2-string-node-p right) ; ['bar']
7389 (and (js2-number-node-p right) ; [10]
7390 (string-match "^[0-9]+$"
7391 (js2-number-node-value right))))
7392 (if (setq head (js2-compute-nested-prop-get left))
7393 (nconc head (list right))))))))
7395 (defun js2-record-object-literal (node qname pos)
7396 "Recursively process an object literal looking for functions.
7397 NODE is an object literal that is the right-hand child of an assignment
7398 expression. QNAME is a list of nodes representing the assignment target,
7399 e.g. for foo.bar.baz = {...}, QNAME is (foo-node bar-node baz-node).
7400 POS is the absolute position of the node.
7401 We do a depth-first traversal of NODE. For any functions we find,
7402 we append the property name to QNAME, then call `js2-record-imenu-entry'."
7404 (dolist (e (js2-object-node-elems node)) ; e is a `js2-object-prop-node'
7405 (let ((left (js2-infix-node-left e))
7406 ;; Element positions are relative to the parent position.
7407 (pos (+ pos (js2-node-pos e))))
7409 ;; foo: function() {...}
7410 ((js2-function-node-p (setq right (js2-infix-node-right e)))
7411 (when (js2-prop-node-name left)
7412 ;; As a policy decision, we record the position of the property,
7413 ;; not the position of the `function' keyword, since the property
7414 ;; is effectively the name of the function.
7415 (js2-record-imenu-entry right (append qname (list left)) pos)))
7416 ;; foo: {object-literal} -- add foo to qname, offset position, and recurse
7417 ((js2-object-node-p right)
7418 (js2-record-object-literal right
7419 (append qname (list (js2-infix-node-left e)))
7420 (+ pos (js2-node-pos right)))))))))
7422 (defun js2-node-top-level-decl-p (node)
7423 "Return t if NODE's name is defined in the top-level scope.
7424 Also returns t if NODE's name is not defined in any scope, since it implies
7425 that it's an external variable, which must also be in the top-level scope."
7426 (let* ((name (js2-prop-node-name node))
7427 (this-scope (js2-node-get-enclosing-scope node))
7430 ((js2-this-or-super-node-p node)
7434 ((setq defining-scope (js2-get-defining-scope this-scope name))
7435 (js2-ast-root-p defining-scope))
7438 (defun js2-wrapper-function-p (node)
7439 "Return t if NODE is a function expression that's immediately invoked.
7440 NODE must be `js2-function-node'."
7441 (let ((parent (js2-node-parent node)))
7443 ;; function(){...}();
7444 (and (js2-call-node-p parent)
7445 (eq node (js2-call-node-target parent)))
7446 (and (js2-paren-node-p parent)
7447 ;; (function(){...})();
7448 (or (js2-call-node-p (setq parent (js2-node-parent parent)))
7449 ;; (function(){...}).call(this);
7450 (and (js2-prop-get-node-p parent)
7451 (member (js2-name-node-name (js2-prop-get-node-right parent))
7453 (js2-call-node-p (js2-node-parent parent))))))))
7455 (defun js2-browse-postprocess-chains ()
7456 "Modify function-declaration name chains after parsing finishes.
7457 Some of the information is only available after the parse tree is complete.
7458 For instance, processing a nested scope requires a parent function node."
7459 (let (result fn parent-qname p elem)
7460 (dolist (entry js2-imenu-recorder)
7461 ;; function node goes first
7462 (cl-destructuring-bind (current-fn &rest (&whole chain head &rest)) entry
7463 ;; Examine head's defining scope:
7464 ;; Pre-processed chain, or top-level/external, keep as-is.
7465 (if (or (stringp head) (js2-node-top-level-decl-p head))
7467 (when (js2-this-or-super-node-p head)
7468 (setq chain (cdr chain))) ; discard this-node
7469 (when (setq fn (js2-node-parent-script-or-fn current-fn))
7470 (setq parent-qname (gethash fn js2-imenu-function-map 'not-found))
7471 (when (eq parent-qname 'not-found)
7472 ;; anonymous function expressions are not recorded
7473 ;; during the parse, so we need to handle this case here
7475 (if (js2-wrapper-function-p fn)
7476 (let ((grandparent (js2-node-parent-script-or-fn fn)))
7477 (if (js2-ast-root-p grandparent)
7479 (gethash grandparent js2-imenu-function-map 'skip)))
7481 (puthash fn parent-qname js2-imenu-function-map))
7482 (if (eq parent-qname 'skip)
7483 ;; We don't show it, let's record that fact.
7484 (remhash current-fn js2-imenu-function-map)
7485 ;; Prepend parent fn qname to this chain.
7486 (let ((qname (append parent-qname chain)))
7487 (puthash current-fn (butlast qname) js2-imenu-function-map)
7488 (push qname result)))))))
7489 ;; Collect chains obtained by third-party code.
7490 (let (js2-imenu-recorder)
7491 (run-hooks 'js2-build-imenu-callbacks)
7492 (dolist (entry js2-imenu-recorder)
7493 (push (cdr entry) result)))
7494 ;; Finally replace each node in each chain with its name.
7495 (dolist (chain result)
7498 (if (js2-node-p (setq elem (car p)))
7499 (setcar p (js2-node-qname-component elem)))
7503 ;; Merge name chains into a trie-like tree structure of nested lists.
7504 ;; To simplify construction of the trie, we first build it out using the rule
7505 ;; that the trie consists of lists of pairs. Each pair is a 2-element array:
7506 ;; [key, num-or-list]. The second element can be a number; if so, this key
7507 ;; is a leaf-node with only one value. (I.e. there is only one declaration
7508 ;; associated with the key at this level.) Otherwise the second element is
7509 ;; a list of pairs, with the rule applied recursively. This symmetry permits
7510 ;; a simple recursive formulation.
7512 ;; js2-mode is building the data structure for imenu. The imenu documentation
7513 ;; claims that it's the structure above, but in practice it wants the children
7514 ;; at the same list level as the key for that level, which is how I've drawn
7515 ;; the "Expected final result" above. We'll postprocess the trie to remove the
7516 ;; list wrapper around the children at each level.
7518 ;; A completed nested imenu-alist entry looks like this:
7520 ;; ("<definition>" . 7)
7525 ;; In particular, the documentation for `imenu--index-alist' says that
7526 ;; a nested sub-alist element looks like (INDEX-NAME SUB-ALIST).
7527 ;; The sub-alist entries immediately follow INDEX-NAME, the head of the list.
7529 (defun js2-treeify (lst)
7530 "Convert (a b c d) to (a ((b ((c d)))))."
7531 (if (null (cddr lst)) ; list length <= 2
7533 (list (car lst) (list (js2-treeify (cdr lst))))))
7535 (defun js2-build-alist-trie (chains trie)
7536 "Merge declaration name chains into a trie-like alist structure for imenu.
7537 CHAINS is the qname chain list produced during parsing. TRIE is a
7538 list of elements built up so far."
7539 (let (head tail pos branch kids)
7540 (dolist (chain chains)
7541 (setq head (car chain)
7543 pos (if (numberp (car tail)) (car tail))
7544 branch (js2-find-if (lambda (n)
7545 (string= (car n) head))
7547 kids (cl-second branch))
7549 ;; case 1: this key isn't in the trie yet
7552 (setcdr (last trie) (list (js2-treeify chain)))
7553 (setq trie (list (js2-treeify chain)))))
7554 ;; case 2: key is present with a single number entry: replace w/ list
7555 ;; ("a1" 10) + ("a1" 20) => ("a1" (("<definition>" 10)
7556 ;; ("<definition>" 20)))
7558 (setcar (cdr branch)
7559 (list (list "<definition-1>" kids)
7561 (list "<definition-2>" pos)
7562 (js2-treeify tail)))))
7563 ;; case 3: key is there (with kids), and we're a number entry
7567 (list (format "<definition-%d>"
7568 (1+ (cl-loop for kid in kids
7569 count (eq ?< (aref (car kid) 0)))))
7571 ;; case 4: key is there with kids, need to merge in our chain
7573 (js2-build-alist-trie (list tail) kids))))
7576 (defun js2-flatten-trie (trie)
7577 "Convert TRIE to imenu-format.
7578 Recurses through nodes, and for each one whose second element is a list,
7579 appends the list's flattened elements to the current element. Also
7580 changes the tails into conses. For instance, this pre-flattened trie
7592 Note that the root of the trie has no key, just a list of chains.
7593 This is also true for the value of any key with multiple children,
7594 e.g. key 'c' in the example above."
7597 (mapcar #'js2-flatten-trie trie))
7599 (if (numberp (cl-second trie))
7600 (cons (car trie) (cl-second trie))
7601 ;; else pop list and append its kids
7602 (apply #'append (list (car trie)) (js2-flatten-trie (cdr trie)))))))
7604 (defun js2-build-imenu-index ()
7605 "Turn `js2-imenu-recorder' into an imenu data structure."
7606 (when (eq js2-imenu-recorder 'empty)
7607 (setq js2-imenu-recorder nil))
7608 (let* ((chains (js2-browse-postprocess-chains))
7609 (result (js2-build-alist-trie chains nil)))
7610 (js2-flatten-trie result)))
7612 (defun js2-test-print-chains (chains)
7613 "Print a list of qname chains.
7614 Each element of CHAINS is a list of the form (NODE [NODE *] pos);
7615 i.e. one or more nodes, and an integer position as the list tail."
7616 (mapconcat (lambda (chain)
7618 (mapconcat (lambda (elem)
7619 (if (js2-node-p elem)
7620 (or (js2-node-qname-component elem)
7622 (number-to-string elem)))
7631 (defconst js2-version "1.8.5"
7632 "Version of JavaScript supported.")
7634 (defun js2-record-face (face &optional token)
7635 "Record a style run of FACE for TOKEN or the current token."
7636 (unless token (setq token (js2-current-token)))
7637 (js2-set-face (js2-token-beg token) (js2-token-end token) face 'record))
7639 (defsubst js2-node-end (n)
7640 "Computes the absolute end of node N.
7641 Use with caution! Assumes `js2-node-pos' is -absolute-, which
7642 is only true until the node is added to its parent; i.e., while parsing."
7646 (defun js2-record-comment (token)
7647 "Record a comment in `js2-scanned-comments'."
7648 (let ((ct (js2-token-comment-type token))
7649 (beg (js2-token-beg token))
7650 (end (js2-token-end token)))
7651 (push (make-js2-comment-node :len (- end beg)
7653 js2-scanned-comments)
7654 (when js2-parse-ide-mode
7655 (js2-record-face (if (eq ct 'jsdoc)
7657 'font-lock-comment-face)
7659 (when (memq ct '(html preprocessor))
7660 ;; Tell cc-engine the bounds of the comment.
7661 (js2-record-text-property beg (1- end) 'c-in-sws t)))))
7663 (defun js2-peek-token ()
7664 "Return the next token type without consuming it.
7665 If `js2-ti-lookahead' is positive, return the type of next token
7666 from `js2-ti-tokens'. Otherwise, call `js2-get-token'."
7667 (if (not (zerop js2-ti-lookahead))
7669 (aref js2-ti-tokens (mod (1+ js2-ti-tokens-cursor) js2-ti-ntokens)))
7670 (let ((tt (js2-get-token-internal nil)))
7674 (defalias 'js2-next-token 'js2-get-token)
7676 (defun js2-match-token (match &optional dont-unget)
7677 "Get next token and return t if it matches MATCH, a bytecode.
7678 Returns nil and consumes nothing if MATCH is not the next token."
7679 (if (/= (js2-get-token) match)
7680 (ignore (unless dont-unget (js2-unget-token)))
7683 (defun js2-match-contextual-kwd (name)
7684 "Consume and return t if next token is `js2-NAME', and its
7685 string is NAME. Returns nil and keeps current token otherwise."
7686 (if (or (/= (js2-get-token) js2-NAME)
7687 (not (string= (js2-current-token-string) name)))
7691 (js2-record-face 'font-lock-keyword-face)
7694 (defun js2-get-prop-name-token ()
7695 (js2-get-token (and (>= js2-language-version 170) 'KEYWORD_IS_NAME)))
7697 (defun js2-match-prop-name ()
7698 "Consume token and return t if next token is a valid property name.
7699 If `js2-language-version' is >= 180, a keyword or reserved word
7700 is considered valid name as well."
7701 (if (eq js2-NAME (js2-get-prop-name-token))
7706 (defun js2-must-match-prop-name (msg-id &optional pos len)
7707 (if (js2-match-prop-name)
7709 (js2-report-error msg-id nil pos len)
7712 (defun js2-peek-token-or-eol ()
7713 "Return js2-EOL if the next token immediately follows a newline.
7714 Else returns the next token. Used in situations where we don't
7715 consider certain token types valid if they are preceded by a newline.
7716 One example is the postfix ++ or -- operator, which has to be on the
7717 same line as its operand."
7718 (let ((tt (js2-get-token))
7719 (follows-eol (js2-token-follows-eol-p (js2-current-token))))
7725 (defun js2-must-match (token msg-id &optional pos len)
7726 "Match next token to token code TOKEN, or record a syntax error.
7727 MSG-ID is the error message to report if the match fails.
7728 Returns t on match, nil if no match."
7729 (if (js2-match-token token t)
7731 (js2-report-error msg-id nil pos len)
7735 (defun js2-must-match-name (msg-id)
7736 (if (js2-match-token js2-NAME t)
7738 (if (eq (js2-current-token-type) js2-RESERVED)
7739 (js2-report-error "msg.reserved.id" (js2-current-token-string))
7740 (js2-report-error msg-id)
7744 (defsubst js2-inside-function ()
7745 (cl-plusp js2-nesting-of-function))
7747 (defun js2-set-requires-activation ()
7748 (if (js2-function-node-p js2-current-script-or-fn)
7749 (setf (js2-function-node-needs-activation js2-current-script-or-fn) t)))
7751 (defun js2-check-activation-name (name _token)
7752 (when (js2-inside-function)
7753 ;; skip language-version 1.2 check from Rhino
7754 (if (or (string= "arguments" name)
7755 (and js2-compiler-activation-names ; only used in codegen
7756 (gethash name js2-compiler-activation-names)))
7757 (js2-set-requires-activation))))
7759 (defun js2-set-is-generator ()
7760 (let ((fn-node js2-current-script-or-fn))
7761 (when (and (js2-function-node-p fn-node)
7762 (not (js2-function-node-generator-type fn-node)))
7763 (setf (js2-function-node-generator-type js2-current-script-or-fn) 'LEGACY))))
7765 (defun js2-must-have-xml ()
7766 (unless js2-compiler-xml-available
7767 (js2-report-error "msg.XML.not.available")))
7769 (defun js2-push-scope (scope)
7770 "Push SCOPE, a `js2-scope', onto the lexical scope chain."
7771 (cl-assert (js2-scope-p scope))
7772 (cl-assert (null (js2-scope-parent-scope scope)))
7773 (cl-assert (not (eq js2-current-scope scope)))
7774 (setf (js2-scope-parent-scope scope) js2-current-scope
7775 js2-current-scope scope))
7777 (defsubst js2-pop-scope ()
7778 (setq js2-current-scope
7779 (js2-scope-parent-scope js2-current-scope)))
7781 (defun js2-enter-loop (loop-node)
7782 (push loop-node js2-loop-set)
7783 (push loop-node js2-loop-and-switch-set)
7784 (js2-push-scope loop-node)
7785 ;; Tell the current labeled statement (if any) its statement,
7786 ;; and set the jump target of the first label to the loop.
7787 ;; These are used in `js2-parse-continue' to verify that the
7788 ;; continue target is an actual labeled loop. (And for codegen.)
7789 (when js2-labeled-stmt
7790 (setf (js2-labeled-stmt-node-stmt js2-labeled-stmt) loop-node
7791 (js2-label-node-loop (car (js2-labeled-stmt-node-labels
7792 js2-labeled-stmt))) loop-node)))
7794 (defun js2-exit-loop ()
7796 (pop js2-loop-and-switch-set)
7799 (defsubst js2-enter-switch (switch-node)
7800 (push switch-node js2-loop-and-switch-set))
7802 (defsubst js2-exit-switch ()
7803 (pop js2-loop-and-switch-set))
7805 (defsubst js2-get-directive (node)
7806 "Return NODE's value if it is a directive, nil otherwise.
7808 A directive is an otherwise-meaningless expression statement
7809 consisting of a string literal, such as \"use strict\"."
7810 (and (js2-expr-stmt-node-p node)
7811 (js2-string-node-p (setq node (js2-expr-stmt-node-expr node)))
7812 (js2-string-node-value node)))
7814 (defun js2-parse (&optional buf cb)
7815 "Tell the js2 parser to parse a region of JavaScript.
7817 BUF is a buffer or buffer name containing the code to parse.
7818 Call `narrow-to-region' first to parse only part of the buffer.
7820 The returned AST root node is given some additional properties:
7821 `node-count' - total number of nodes in the AST
7822 `buffer' - BUF. The buffer it refers to may change or be killed,
7823 so the value is not necessarily reliable.
7825 An optional callback CB can be specified to report parsing
7826 progress. If `(functionp CB)' returns t, it will be called with
7827 the current line number once before parsing begins, then again
7828 each time the lexer reaches a new line number.
7830 CB can also be a list of the form `(symbol cb ...)' to specify
7831 multiple callbacks with different criteria. Each symbol is a
7832 criterion keyword, and the following element is the callback to
7835 :line - called whenever the line number changes
7836 :token - called for each new token consumed
7838 The list of criteria could be extended to include entering or
7839 leaving a statement, an expression, or a function definition."
7840 (if (and cb (not (functionp cb)))
7841 (error "criteria callbacks not yet implemented"))
7842 (let ((inhibit-point-motion-hooks t)
7843 (js2-compiler-xml-available (>= js2-language-version 160))
7844 ;; This is a recursive-descent parser, so give it a big stack.
7845 (max-lisp-eval-depth (max max-lisp-eval-depth 3000))
7846 (max-specpdl-size (max max-specpdl-size 3000))
7847 (case-fold-search nil)
7849 (with-current-buffer (or buf (current-buffer))
7850 (setq js2-scanned-comments nil
7851 js2-parsed-errors nil
7852 js2-parsed-warnings nil
7853 js2-imenu-recorder nil
7854 js2-imenu-function-map nil
7857 (setq ast (js2-do-parse))
7858 (unless js2-ts-hit-eof
7859 (js2-report-error "msg.got.syntax.errors" (length js2-parsed-errors)))
7860 (setf (js2-ast-root-errors ast) js2-parsed-errors
7861 (js2-ast-root-warnings ast) js2-parsed-warnings)
7862 ;; if we didn't find any declarations, put a dummy in this list so we
7863 ;; don't end up re-parsing the buffer in `js2-mode-create-imenu-index'
7864 (unless js2-imenu-recorder
7865 (setq js2-imenu-recorder 'empty))
7866 (run-hooks 'js2-parse-finished-hook)
7869 ;; Corresponds to Rhino's Parser.parse() method.
7870 (defun js2-do-parse ()
7871 "Parse current buffer starting from current point.
7872 Scanner should be initialized."
7873 (let ((pos js2-ts-cursor)
7874 (end js2-ts-cursor) ; in case file is empty
7876 (in-directive-prologue t)
7877 (js2-in-use-strict-directive js2-in-use-strict-directive)
7879 ;; initialize buffer-local parsing vars
7880 (setf root (make-js2-ast-root :buffer (buffer-name) :pos pos)
7881 js2-current-script-or-fn root
7882 js2-current-scope root
7883 js2-nesting-of-function 0
7884 js2-labeled-stmt nil
7885 js2-recorded-identifiers nil ; for js2-highlight
7886 js2-in-use-strict-directive nil)
7887 (while (/= (setq tt (js2-get-token)) js2-EOF)
7888 (if (= tt js2-FUNCTION)
7890 (setq n (if js2-called-by-compile-function
7891 (js2-parse-function-expr)
7892 (js2-parse-function-stmt))))
7893 ;; not a function - parse a statement
7895 (setq n (js2-parse-statement))
7896 (when in-directive-prologue
7897 (setq directive (js2-get-directive n))
7900 (setq in-directive-prologue nil))
7901 ((string= directive "use strict")
7902 (setq js2-in-use-strict-directive t)))))
7903 ;; add function or statement to script
7904 (setq end (js2-node-end n))
7905 (js2-block-node-push root n))
7906 ;; add comments to root in lexical order
7907 (when js2-scanned-comments
7908 ;; if we find a comment beyond end of normal kids, use its end
7909 (setq end (max end (js2-node-end (cl-first js2-scanned-comments))))
7910 (dolist (comment js2-scanned-comments)
7911 (push comment (js2-ast-root-comments root))
7912 (js2-node-add-children root comment)))
7913 (setf (js2-node-len root) (- end pos))
7914 (setq js2-mode-ast root) ; Make sure this is available for callbacks.
7915 ;; Give extensions a chance to muck with things before highlighting starts.
7916 (let ((js2-additional-externs js2-additional-externs))
7918 (run-hooks 'js2-post-parse-callbacks))
7919 (js2-highlight-undeclared-vars))
7922 (defun js2-parse-function-closure-body (fn-node)
7923 "Parse a JavaScript 1.8 function closure body."
7924 (let ((js2-nesting-of-function (1+ js2-nesting-of-function)))
7926 (js2-report-error "msg.no.brace.body" nil
7927 (js2-node-pos fn-node)
7928 (- js2-ts-cursor (js2-node-pos fn-node)))
7929 (js2-node-add-children fn-node
7930 (setf (js2-function-node-body fn-node)
7931 (js2-parse-expr t))))))
7933 (defun js2-parse-function-body (fn-node)
7934 (js2-must-match js2-LC "msg.no.brace.body"
7935 (js2-node-pos fn-node)
7936 (- js2-ts-cursor (js2-node-pos fn-node)))
7937 (let ((pos (js2-current-token-beg)) ; LC position
7938 (pn (make-js2-block-node)) ; starts at LC position
7941 not-in-directive-prologue
7944 (cl-incf js2-nesting-of-function)
7946 (while (not (or (= (setq tt (js2-peek-token)) js2-ERROR)
7949 (js2-block-node-push
7951 (if (/= tt js2-FUNCTION)
7952 (if not-in-directive-prologue
7953 (js2-parse-statement)
7954 (setq node (js2-parse-statement)
7955 directive (js2-get-directive node))
7958 (setq not-in-directive-prologue t))
7959 ((string= directive "use strict")
7960 ;; Back up and reparse the function, because new rules apply
7961 ;; to the function name and parameters.
7962 (when (not js2-in-use-strict-directive)
7963 (setq js2-in-use-strict-directive t)
7964 (throw 'reparse t))))
7967 (js2-parse-function-stmt))))
7968 (cl-decf js2-nesting-of-function))
7969 (setq end (js2-current-token-end)) ; assume no curly and leave at current token
7970 (if (js2-must-match js2-RC "msg.no.brace.after.body" pos)
7971 (setq end (js2-current-token-end)))
7972 (setf (js2-node-pos pn) pos
7973 (js2-node-len pn) (- end pos))
7974 (setf (js2-function-node-body fn-node) pn)
7975 (js2-node-add-children fn-node pn)
7978 (defun js2-define-destruct-symbols (node decl-type face &optional ignore-not-in-block)
7979 "Declare and fontify destructuring parameters inside NODE.
7980 NODE is either `js2-array-node', `js2-object-node', or `js2-name-node'.
7982 Return a list of `js2-name-node' nodes representing the symbols
7983 declared; probably to check them for errors."
7986 ((js2-name-node-p node)
7988 (js2-define-symbol decl-type (js2-name-node-name node)
7989 node ignore-not-in-block)
7991 (js2-set-face (setq leftpos (js2-node-abs-pos node))
7992 (+ leftpos (js2-node-len node))
7995 ((js2-object-node-p node)
7996 (dolist (elem (js2-object-node-elems node))
7997 (when (js2-object-prop-node-p elem)
7998 (push (js2-define-destruct-symbols
7999 ;; In abbreviated destructuring {a, b}, right == left.
8000 (js2-object-prop-node-right elem)
8001 decl-type face ignore-not-in-block)
8003 (apply #'append (nreverse name-nodes)))
8004 ((js2-array-node-p node)
8005 (dolist (elem (js2-array-node-elems node))
8007 (push (js2-define-destruct-symbols
8008 elem decl-type face ignore-not-in-block)
8010 (apply #'append (nreverse name-nodes)))
8011 (t (js2-report-error "msg.no.parm" nil (js2-node-abs-pos node)
8012 (js2-node-len node))
8015 (defvar js2-illegal-strict-identifiers
8016 '("eval" "arguments")
8017 "Identifiers not allowed as variables in strict mode.")
8019 (defun js2-check-strict-identifier (name-node)
8020 "Check that NAME-NODE makes a legal strict mode identifier."
8021 (when js2-in-use-strict-directive
8022 (let ((param-name (js2-name-node-name name-node)))
8023 (when (member param-name js2-illegal-strict-identifiers)
8024 (js2-report-error "msg.bad.id.strict" param-name
8025 (js2-node-abs-pos name-node) (js2-node-len name-node))))))
8027 (defun js2-check-strict-function-params (preceding-params params)
8028 "Given PRECEDING-PARAMS in a function's parameter list, check
8029 for strict mode errors caused by PARAMS."
8030 (when js2-in-use-strict-directive
8031 (dolist (param params)
8032 (let ((param-name (js2-name-node-name param)))
8033 (js2-check-strict-identifier param)
8034 (when (cl-some (lambda (param)
8035 (string= (js2-name-node-name param) param-name))
8037 (js2-report-error "msg.dup.param.strict" param-name
8038 (js2-node-abs-pos param) (js2-node-len param)))))))
8040 (defun js2-parse-function-params (function-type fn-node pos)
8041 "Parse the parameters of a function of FUNCTION-TYPE
8042 represented by FN-NODE at POS."
8043 (if (js2-match-token js2-RP)
8044 (setf (js2-function-node-rp fn-node) (- (js2-current-token-beg) pos))
8045 (let ((paren-free-arrow (and (eq function-type 'FUNCTION_ARROW)
8046 (eq (js2-current-token-type) js2-NAME)))
8048 param-name-nodes new-param-name-nodes
8050 (when paren-free-arrow
8052 (cl-loop for tt = (js2-peek-token)
8055 ;; destructuring param
8056 ((and (not paren-free-arrow)
8057 (or (= tt js2-LB) (= tt js2-LC)))
8059 (setq param (js2-parse-destruct-primary-expr)
8060 new-param-name-nodes (js2-define-destruct-symbols
8061 param js2-LP 'js2-function-param))
8062 (js2-check-strict-function-params param-name-nodes new-param-name-nodes)
8063 (setq param-name-nodes (append param-name-nodes new-param-name-nodes))
8064 (push param params))
8067 (when (and (>= js2-language-version 200)
8068 (not paren-free-arrow)
8069 (js2-match-token js2-TRIPLEDOT)
8070 (not rest-param-at))
8071 ;; to report errors if there are more parameters
8072 (setq rest-param-at (length params)))
8073 (js2-must-match-name "msg.no.parm")
8074 (js2-record-face 'js2-function-param)
8075 (setq param (js2-create-name-node))
8076 (js2-define-symbol js2-LP (js2-current-token-string) param)
8077 (js2-check-strict-function-params param-name-nodes (list param))
8078 (setq param-name-nodes (append param-name-nodes (list param)))
8079 ;; default parameter value
8080 (when (and (>= js2-language-version 200)
8081 (js2-match-token js2-ASSIGN))
8082 (cl-assert (not paren-free-arrow))
8083 (let* ((pos (js2-node-pos param))
8084 (tt (js2-current-token-type))
8085 (op-pos (- (js2-current-token-beg) pos))
8087 (right (js2-parse-assign-expr))
8088 (len (- (js2-node-end right) pos)))
8089 (setq param (make-js2-assign-node
8090 :type tt :pos pos :len len :op-pos op-pos
8091 :left left :right right))
8092 (js2-node-add-children param left right)))
8093 (push param params)))
8094 (when (and rest-param-at (> (length params) (1+ rest-param-at)))
8095 (js2-report-error "msg.param.after.rest" nil
8096 (js2-node-pos param) (js2-node-len param)))
8098 (js2-match-token js2-COMMA))
8099 (when (and (not paren-free-arrow)
8100 (js2-must-match js2-RP "msg.no.paren.after.parms"))
8101 (setf (js2-function-node-rp fn-node) (- (js2-current-token-beg) pos)))
8103 (setf (js2-function-node-rest-p fn-node) t))
8105 (js2-node-add-children fn-node p)
8106 (push p (js2-function-node-params fn-node))))))
8108 (defun js2-check-inconsistent-return-warning (fn-node name)
8109 "Possibly show inconsistent-return warning.
8110 Last token scanned is the close-curly for the function body."
8111 (when (and js2-mode-show-strict-warnings
8112 js2-strict-inconsistent-return-warning
8113 (not (js2-has-consistent-return-usage
8114 (js2-function-node-body fn-node))))
8115 ;; Have it extend from close-curly to bol or beginning of block.
8116 (let ((pos (save-excursion
8117 (goto-char (js2-current-token-end))
8118 (max (js2-node-abs-pos (js2-function-node-body fn-node))
8120 (end (js2-current-token-end)))
8121 (if (cl-plusp (js2-name-node-length name))
8122 (js2-add-strict-warning "msg.no.return.value"
8123 (js2-name-node-name name) pos end)
8124 (js2-add-strict-warning "msg.anon.no.return.value" nil pos end)))))
8126 (defun js2-parse-function-stmt ()
8127 (let ((pos (js2-current-token-beg))
8128 (star-p (js2-match-token js2-MUL)))
8129 (js2-must-match-name "msg.unnamed.function.stmt")
8130 (let ((name (js2-create-name-node t))
8133 ((js2-match-token js2-LP)
8134 (js2-parse-function 'FUNCTION_STATEMENT pos star-p name))
8135 (js2-allow-member-expr-as-function-name
8136 (setq member-expr (js2-parse-member-expr-tail nil name))
8137 (js2-parse-highlight-member-expr-fn-name member-expr)
8138 (js2-must-match js2-LP "msg.no.paren.parms")
8139 (setf pn (js2-parse-function 'FUNCTION_STATEMENT pos star-p)
8140 (js2-function-node-member-expr pn) member-expr)
8143 (js2-report-error "msg.no.paren.parms")
8144 (make-js2-error-node))))))
8146 (defun js2-parse-function-expr ()
8147 (let ((pos (js2-current-token-beg))
8148 (star-p (js2-match-token js2-MUL))
8150 (when (js2-match-token js2-NAME)
8151 (setq name (js2-create-name-node t)))
8152 (js2-must-match js2-LP "msg.no.paren.parms")
8153 (js2-parse-function 'FUNCTION_EXPRESSION pos star-p name)))
8155 (defun js2-parse-function-internal (function-type pos star-p &optional name)
8157 (if (= (js2-current-token-type) js2-LP) ; eventually matched LP?
8158 (setq lp (js2-current-token-beg)))
8159 (setf fn-node (make-js2-function-node :pos pos
8162 :lp (if lp (- lp pos))
8163 :generator-type (and star-p 'STAR)))
8165 (js2-set-face (js2-node-pos name) (js2-node-end name)
8166 'font-lock-function-name-face 'record)
8167 (when (and (eq function-type 'FUNCTION_STATEMENT)
8168 (cl-plusp (js2-name-node-length name)))
8169 ;; Function statements define a symbol in the enclosing scope
8170 (js2-define-symbol js2-FUNCTION (js2-name-node-name name) fn-node))
8171 (when js2-in-use-strict-directive
8172 (js2-check-strict-identifier name)))
8173 (if (or (js2-inside-function) (cl-plusp js2-nesting-of-with))
8174 ;; 1. Nested functions are not affected by the dynamic scope flag
8175 ;; as dynamic scope is already a parent of their scope.
8176 ;; 2. Functions defined under the with statement also immune to
8177 ;; this setup, in which case dynamic scope is ignored in favor
8178 ;; of the with object.
8179 (setf (js2-function-node-ignore-dynamic fn-node) t))
8180 ;; dynamically bind all the per-function variables
8181 (let ((js2-current-script-or-fn fn-node)
8182 (js2-current-scope fn-node)
8183 (js2-nesting-of-with 0)
8187 js2-loop-and-switch-set)
8188 (js2-parse-function-params function-type fn-node pos)
8189 (when (eq function-type 'FUNCTION_ARROW)
8190 (js2-must-match js2-ARROW "msg.bad.arrow.args"))
8191 (if (and (>= js2-language-version 180)
8192 (/= (js2-peek-token) js2-LC))
8193 (js2-parse-function-closure-body fn-node)
8194 (js2-parse-function-body fn-node))
8195 (js2-check-inconsistent-return-warning fn-node name)
8198 (js2-node-add-children fn-node name)
8199 ;; Function expressions define a name only in the body of the
8200 ;; function, and only if not hidden by a parameter name
8201 (when (and (eq function-type 'FUNCTION_EXPRESSION)
8202 (null (js2-scope-get-symbol js2-current-scope
8203 (js2-name-node-name name))))
8204 (js2-define-symbol js2-FUNCTION
8205 (js2-name-node-name name)
8207 (when (eq function-type 'FUNCTION_STATEMENT)
8208 (js2-record-imenu-functions fn-node))))
8210 (setf (js2-node-len fn-node) (- js2-ts-cursor pos))
8211 ;; Rhino doesn't do this, but we need it for finding undeclared vars.
8212 ;; We wait until after parsing the function to set its parent scope,
8213 ;; since `js2-define-symbol' needs the defining-scope check to stop
8214 ;; at the function boundary when checking for redeclarations.
8215 (setf (js2-scope-parent-scope fn-node) js2-current-scope)
8218 (defun js2-parse-function (function-type pos star-p &optional name)
8219 "Function parser. FUNCTION-TYPE is a symbol, POS is the
8220 beginning of the first token (function keyword, unless it's an
8221 arrow function), NAME is js2-name-node."
8225 ;; Preserve strict state outside this function.
8226 (js2-in-use-strict-directive js2-in-use-strict-directive))
8227 ;; Parse multiple times if a new strict mode directive is discovered in the
8228 ;; function body, as new rules will be retroactively applied to the legality
8229 ;; of function names and parameters.
8231 (setq ts-state (make-js2-ts-state))
8232 (setq continue (catch 'reparse
8233 (setq fn-node (js2-parse-function-internal
8234 function-type pos star-p name))
8238 (js2-ts-seek ts-state)))
8241 (defun js2-parse-statements (&optional parent)
8242 "Parse a statement list. Last token consumed must be js2-LC.
8244 PARENT can be a `js2-block-node', in which case the statements are
8245 appended to PARENT. Otherwise a new `js2-block-node' is created
8248 This function does not match the closing js2-RC: the caller
8249 matches the RC so it can provide a suitable error message if not
8250 matched. This means it's up to the caller to set the length of
8251 the node to include the closing RC. The node start pos is set to
8252 the absolute buffer start position, and the caller should fix it
8253 up to be relative to the parent node. All children of this block
8254 node are given relative start positions and correct lengths."
8255 (let ((pn (or parent (make-js2-block-node)))
8257 (while (and (> (setq tt (js2-peek-token)) js2-EOF)
8259 (js2-block-node-push pn (js2-parse-statement)))
8262 (defun js2-parse-statement ()
8264 ;; coarse-grained user-interrupt check - needs work
8265 (and js2-parse-interruptable-p
8266 (zerop (% (cl-incf js2-parse-stmt-count)
8267 js2-statements-per-pause))
8269 (throw 'interrupted t))
8270 (setq pn (js2-statement-helper))
8271 ;; no-side-effects warning check
8272 (unless (js2-node-has-side-effects pn)
8273 (setq end (js2-node-end pn))
8276 (setq beg (max (js2-node-pos pn) (point-at-bol))))
8277 (js2-add-strict-warning "msg.no.side.effects" nil beg end))
8280 ;; These correspond to the switch cases in Parser.statementHelper
8281 (defconst js2-parsers
8282 (let ((parsers (make-vector js2-num-tokens
8283 #'js2-parse-expr-stmt)))
8284 (aset parsers js2-BREAK #'js2-parse-break)
8285 (aset parsers js2-CLASS #'js2-parse-class-stmt)
8286 (aset parsers js2-CONST #'js2-parse-const-var)
8287 (aset parsers js2-CONTINUE #'js2-parse-continue)
8288 (aset parsers js2-DEBUGGER #'js2-parse-debugger)
8289 (aset parsers js2-DEFAULT #'js2-parse-default-xml-namespace)
8290 (aset parsers js2-DO #'js2-parse-do)
8291 (aset parsers js2-EXPORT #'js2-parse-export)
8292 (aset parsers js2-FOR #'js2-parse-for)
8293 (aset parsers js2-FUNCTION #'js2-parse-function-stmt)
8294 (aset parsers js2-IF #'js2-parse-if)
8295 (aset parsers js2-IMPORT #'js2-parse-import)
8296 (aset parsers js2-LC #'js2-parse-block)
8297 (aset parsers js2-LET #'js2-parse-let-stmt)
8298 (aset parsers js2-NAME #'js2-parse-name-or-label)
8299 (aset parsers js2-RETURN #'js2-parse-ret-yield)
8300 (aset parsers js2-SEMI #'js2-parse-semi)
8301 (aset parsers js2-SWITCH #'js2-parse-switch)
8302 (aset parsers js2-THROW #'js2-parse-throw)
8303 (aset parsers js2-TRY #'js2-parse-try)
8304 (aset parsers js2-VAR #'js2-parse-const-var)
8305 (aset parsers js2-WHILE #'js2-parse-while)
8306 (aset parsers js2-WITH #'js2-parse-with)
8307 (aset parsers js2-YIELD #'js2-parse-ret-yield)
8309 "A vector mapping token types to parser functions.")
8311 (defun js2-parse-warn-missing-semi (beg end)
8312 (and js2-mode-show-strict-warnings
8313 js2-strict-missing-semi-warning
8314 (js2-add-strict-warning
8315 "msg.missing.semi" nil
8316 ;; back up to beginning of statement or line
8317 (max beg (save-excursion
8322 (defconst js2-no-semi-insertion
8336 "List of tokens that don't do automatic semicolon insertion.")
8338 (defconst js2-autoinsert-semi-and-warn
8339 (list js2-ERROR js2-EOF js2-RC))
8341 (defun js2-statement-helper ()
8342 (let* ((tt (js2-get-token))
8344 (parser (if (= tt js2-ERROR)
8346 (aref js2-parsers tt)))
8348 ;; If the statement is set, then it's been told its label by now.
8349 (and js2-labeled-stmt
8350 (js2-labeled-stmt-node-stmt js2-labeled-stmt)
8351 (setq js2-labeled-stmt nil))
8352 (setq pn (funcall parser))
8353 ;; Don't do auto semi insertion for certain statement types.
8354 (unless (or (memq first-tt js2-no-semi-insertion)
8355 (js2-labeled-stmt-node-p pn))
8356 (js2-auto-insert-semicolon pn))
8359 (defun js2-auto-insert-semicolon (pn)
8360 (let* ((tt (js2-get-token))
8361 (pos (js2-node-pos pn)))
8364 ;; extend the node bounds to include the semicolon.
8365 (setf (js2-node-len pn) (- (js2-current-token-end) pos)))
8366 ((memq tt js2-autoinsert-semi-and-warn)
8367 (js2-unget-token) ; Not ';', do not consume.
8369 (js2-parse-warn-missing-semi pos (js2-node-end pn)))
8371 (if (not (js2-token-follows-eol-p (js2-current-token)))
8372 ;; Report error if no EOL or autoinsert ';' otherwise
8373 (js2-report-error "msg.no.semi.stmt")
8374 (js2-parse-warn-missing-semi pos (js2-node-end pn)))
8375 (js2-unget-token) ; Not ';', do not consume.
8378 (defun js2-parse-condition ()
8379 "Parse a parenthesized boolean expression, e.g. in an if- or while-stmt.
8380 The parens are discarded and the expression node is returned.
8381 The `pos' field of the return value is set to an absolute position
8382 that must be fixed up by the caller.
8383 Return value is a list (EXPR LP RP), with absolute paren positions."
8385 (if (js2-must-match js2-LP "msg.no.paren.cond")
8386 (setq lp (js2-current-token-beg)))
8387 (setq pn (js2-parse-expr))
8388 (if (js2-must-match js2-RP "msg.no.paren.after.cond")
8389 (setq rp (js2-current-token-beg)))
8390 ;; Report strict warning on code like "if (a = 7) ..."
8391 (if (and js2-strict-cond-assign-warning
8392 (js2-assign-node-p pn))
8393 (js2-add-strict-warning "msg.equal.as.assign" nil
8395 (+ (js2-node-pos pn)
8396 (js2-node-len pn))))
8399 (defun js2-parse-if ()
8400 "Parser for if-statement. Last matched token must be js2-IF."
8401 (let ((pos (js2-current-token-beg))
8402 cond if-true if-false else-pos end pn)
8403 (setq cond (js2-parse-condition)
8404 if-true (js2-parse-statement)
8405 if-false (if (js2-match-token js2-ELSE)
8407 (setq else-pos (- (js2-current-token-beg) pos))
8408 (js2-parse-statement)))
8409 end (js2-node-end (or if-false if-true))
8410 pn (make-js2-if-node :pos pos
8412 :condition (car cond)
8416 :lp (js2-relpos (cl-second cond) pos)
8417 :rp (js2-relpos (cl-third cond) pos)))
8418 (js2-node-add-children pn (car cond) if-true if-false)
8421 (defun js2-parse-import ()
8422 "Parse import statement. The current token must be js2-IMPORT."
8423 (unless (js2-ast-root-p js2-current-scope)
8424 (js2-report-error "msg.mod.import.decl.at.top.level"))
8425 (let ((beg (js2-current-token-beg)))
8426 (cond ((js2-match-token js2-STRING)
8427 (make-js2-import-node
8429 :len (- (js2-current-token-end) beg)
8430 :module-id (js2-current-token-string)))
8432 (let* ((import-clause (js2-parse-import-clause))
8433 (from-clause (and import-clause (js2-parse-from-clause)))
8434 (module-id (when from-clause (js2-from-clause-node-module-id from-clause)))
8435 (node (make-js2-import-node
8437 :len (- (js2-current-token-end) beg)
8438 :import import-clause
8440 :module-id module-id)))
8442 (js2-node-add-children node import-clause))
8444 (js2-node-add-children node from-clause))
8447 (defun js2-parse-import-clause ()
8448 "Parse the bindings in an import statement.
8449 This can take many forms:
8451 ImportedDefaultBinding -> 'foo'
8452 NameSpaceImport -> '* as lib'
8453 NamedImports -> '{foo as bar, bang}'
8454 ImportedDefaultBinding , NameSpaceImport -> 'foo, * as lib'
8455 ImportedDefaultBinding , NamedImports -> 'foo, {bar, baz as bif}'
8457 Try to match namespace imports and named imports first because nothing can
8458 come after them. If it is an imported default binding, then it could have named
8459 imports or a namespace import that follows it.
8461 (let* ((beg (js2-current-token-beg))
8462 (clause (make-js2-import-clause-node
8466 ((js2-match-token js2-MUL)
8467 (let ((ns-import (js2-parse-namespace-import)))
8469 (let ((name-node (js2-namespace-import-node-name ns-import)))
8471 js2-LET (js2-name-node-name name-node) name-node t)))
8472 (setf (js2-import-clause-node-namespace-import clause) ns-import)
8473 (push ns-import children)))
8474 ((js2-match-token js2-LC)
8475 (let ((imports (js2-parse-export-bindings t)))
8476 (setf (js2-import-clause-node-named-imports clause) imports)
8477 (dolist (import imports)
8478 (push import children)
8479 (let ((name-node (js2-export-binding-node-local-name import)))
8482 js2-LET (js2-name-node-name name-node) name-node t))))))
8483 ((= (js2-peek-token) js2-NAME)
8484 (let ((binding (js2-maybe-parse-export-binding)))
8485 (let ((node-name (js2-export-binding-node-local-name binding)))
8486 (js2-define-symbol js2-LET (js2-name-node-name node-name) node-name t))
8487 (setf (js2-import-clause-node-default-binding clause) binding)
8488 (push binding children))
8489 (when (js2-match-token js2-COMMA)
8491 ((js2-match-token js2-MUL)
8492 (let ((ns-import (js2-parse-namespace-import)))
8493 (let ((name-node (js2-namespace-import-node-name ns-import)))
8495 js2-LET (js2-name-node-name name-node) name-node t))
8496 (setf (js2-import-clause-node-namespace-import clause) ns-import)
8497 (push ns-import children)))
8498 ((js2-match-token js2-LC)
8499 (let ((imports (js2-parse-export-bindings t)))
8500 (setf (js2-import-clause-node-named-imports clause) imports)
8501 (dolist (import imports)
8502 (push import children)
8503 (let ((name-node (js2-export-binding-node-local-name import)))
8506 js2-LET (js2-name-node-name name-node) name-node t))))))
8507 (t (js2-report-error "msg.syntax")))))
8508 (t (js2-report-error "msg.mod.declaration.after.import")))
8509 (setf (js2-node-len clause) (- (js2-current-token-end) beg))
8510 (apply #'js2-node-add-children clause children)
8513 (defun js2-parse-namespace-import ()
8514 "Parse a namespace import expression such as '* as bar'.
8515 The current token must be js2-MUL."
8516 (let ((beg (js2-current-token-beg)))
8517 (when (js2-must-match js2-NAME "msg.syntax")
8518 (if (equal "as" (js2-current-token-string))
8519 (when (js2-must-match-prop-name "msg.syntax")
8520 (let ((node (make-js2-namespace-import-node
8522 :len (- (js2-current-token-end) beg)
8523 :name (make-js2-name-node
8524 :pos (js2-current-token-beg)
8525 :len (js2-current-token-end)
8526 :name (js2-current-token-string)))))
8527 (js2-node-add-children node (js2-namespace-import-node-name node))
8530 (js2-report-error "msg.syntax")))))
8533 (defun js2-parse-from-clause ()
8534 "Parse the from clause in an import or export statement. E.g. from 'src/lib'"
8535 (when (js2-must-match-name "msg.mod.from.after.import.spec.set")
8536 (let ((beg (js2-current-token-beg)))
8537 (if (equal "from" (js2-current-token-string))
8539 ((js2-match-token js2-STRING)
8540 (make-js2-from-clause-node
8542 :len (- (js2-current-token-end) beg)
8543 :module-id (js2-current-token-string)
8545 ((js2-match-token js2-THIS)
8546 (when (js2-must-match-name "msg.mod.spec.after.from")
8547 (if (equal "module" (js2-current-token-string))
8548 (make-js2-from-clause-node
8550 :len (- (js2-current-token-end) beg)
8555 (js2-report-error "msg.mod.spec.after.from")
8557 (t (js2-report-error "msg.mod.spec.after.from") nil))
8559 (js2-report-error "msg.mod.from.after.import.spec.set")
8562 (defun js2-parse-export-bindings (&optional import-p)
8563 "Parse a list of export binding expressions such as {}, {foo, bar}, and
8564 {foo as bar, baz as bang}. The current token must be
8565 js2-LC. Return a lisp list of js2-export-binding-node"
8566 (let ((bindings (list)))
8568 (let ((binding (js2-maybe-parse-export-binding)))
8570 (push binding bindings))
8571 (js2-match-token js2-COMMA)))
8572 (when (js2-must-match js2-RC (if import-p
8573 "msg.mod.rc.after.import.spec.list"
8574 "msg.mod.rc.after.export.spec.list"))
8575 (reverse bindings))))
8577 (defun js2-maybe-parse-export-binding ()
8578 "Attempt to parse a binding expression found inside an import/export statement.
8579 This can take the form of either as single js2-NAME token as in 'foo' or as in a
8580 rebinding expression 'bar as foo'. If it matches, it will return an instance of
8581 js2-export-binding-node and consume all the tokens. If it does not match, it
8582 consumes no tokens."
8583 (let ((extern-name (when (js2-match-prop-name) (js2-current-token-string)))
8584 (beg (js2-current-token-beg))
8585 (extern-name-len (js2-current-token-len))
8586 (is-reserved-name (or (= (js2-current-token-type) js2-RESERVED)
8587 (aref js2-kwd-tokens (js2-current-token-type)))))
8589 (let ((as (and (js2-match-token js2-NAME) (js2-current-token-string))))
8590 (if (and as (equal "as" (js2-current-token-string)))
8593 (and (js2-match-token js2-DEFAULT) "default")
8594 (and (js2-match-token js2-NAME) (js2-current-token-string)))))
8596 (let ((node (make-js2-export-binding-node
8598 :len (- (js2-current-token-end) beg)
8599 :local-name (make-js2-name-node
8601 :pos (js2-current-token-beg)
8602 :len (js2-current-token-len))
8603 :extern-name (make-js2-name-node
8606 :len extern-name-len))))
8607 (js2-node-add-children
8609 (js2-export-binding-node-local-name node)
8610 (js2-export-binding-node-extern-name node))
8614 (when as (js2-unget-token))
8615 (let* ((name-node (make-js2-name-node
8616 :name (js2-current-token-string)
8617 :pos (js2-current-token-beg)
8618 :len (js2-current-token-len)))
8619 (node (make-js2-export-binding-node
8620 :pos (js2-current-token-beg)
8621 :len (js2-current-token-len)
8622 :local-name name-node
8623 :extern-name name-node)))
8624 (when is-reserved-name
8625 (js2-report-error "msg.mod.as.after.reserved.word" extern-name))
8626 (js2-node-add-children node name-node)
8630 (defun js2-parse-switch ()
8631 "Parser for switch-statement. Last matched token must be js2-SWITCH."
8632 (let ((pos (js2-current-token-beg))
8633 tt pn discriminant has-default case-expr case-node
8634 case-pos cases stmt lp)
8635 (if (js2-must-match js2-LP "msg.no.paren.switch")
8636 (setq lp (js2-current-token-beg)))
8637 (setq discriminant (js2-parse-expr)
8638 pn (make-js2-switch-node :discriminant discriminant
8640 :lp (js2-relpos lp pos)))
8641 (js2-node-add-children pn discriminant)
8642 (js2-enter-switch pn)
8645 (if (js2-must-match js2-RP "msg.no.paren.after.switch")
8646 (setf (js2-switch-node-rp pn) (- (js2-current-token-beg) pos)))
8647 (js2-must-match js2-LC "msg.no.brace.switch")
8650 (setq tt (js2-next-token)
8651 case-pos (js2-current-token-beg))
8654 (setf (js2-node-len pn) (- (js2-current-token-end) pos))
8655 (throw 'break nil)) ; done
8657 (setq case-expr (js2-parse-expr))
8658 (js2-must-match js2-COLON "msg.no.colon.case"))
8661 (js2-report-error "msg.double.switch.default"))
8664 (js2-must-match js2-COLON "msg.no.colon.case"))
8666 (js2-report-error "msg.bad.switch")
8667 (throw 'break nil)))
8668 (setq case-node (make-js2-case-node :pos case-pos
8669 :len (- (js2-current-token-end) case-pos)
8671 (js2-node-add-children case-node case-expr)
8672 (while (and (/= (setq tt (js2-peek-token)) js2-RC)
8676 (setf stmt (js2-parse-statement)
8677 (js2-node-len case-node) (- (js2-node-end stmt) case-pos))
8678 (js2-block-node-push case-node stmt))
8679 (push case-node cases)))
8680 ;; add cases last, as pushing reverses the order to be correct
8682 (js2-node-add-children pn kid)
8683 (push kid (js2-switch-node-cases pn)))
8685 (js2-exit-switch))))
8687 (defun js2-parse-while ()
8688 "Parser for while-statement. Last matched token must be js2-WHILE."
8689 (let ((pos (js2-current-token-beg))
8690 (pn (make-js2-while-node))
8695 (setf cond (js2-parse-condition)
8696 (js2-while-node-condition pn) (car cond)
8697 body (js2-parse-statement)
8698 (js2-while-node-body pn) body
8699 (js2-node-len pn) (- (js2-node-end body) pos)
8700 (js2-while-node-lp pn) (js2-relpos (cl-second cond) pos)
8701 (js2-while-node-rp pn) (js2-relpos (cl-third cond) pos))
8702 (js2-node-add-children pn body (car cond)))
8706 (defun js2-parse-do ()
8707 "Parser for do-statement. Last matched token must be js2-DO."
8708 (let ((pos (js2-current-token-beg))
8709 (pn (make-js2-do-node))
8714 (setq body (js2-parse-statement))
8715 (js2-must-match js2-WHILE "msg.no.while.do")
8716 (setf (js2-do-node-while-pos pn) (- (js2-current-token-beg) pos)
8717 cond (js2-parse-condition)
8718 (js2-do-node-condition pn) (car cond)
8719 (js2-do-node-body pn) body
8721 (js2-do-node-lp pn) (js2-relpos (cl-second cond) pos)
8722 (js2-do-node-rp pn) (js2-relpos (cl-third cond) pos))
8723 (js2-node-add-children pn (car cond) body))
8725 ;; Always auto-insert semicolon to follow SpiderMonkey:
8726 ;; It is required by ECMAScript but is ignored by the rest of
8727 ;; world; see bug 238945
8728 (if (js2-match-token js2-SEMI)
8729 (setq end js2-ts-cursor))
8730 (setf (js2-node-len pn) (- end pos))
8733 (defun js2-parse-export ()
8734 "Parse an export statement.
8735 The Last matched token must be js2-EXPORT. Currently, the 'default' and 'expr'
8736 expressions should only be either hoistable expressions (function or generator)
8737 or assignment expressions, but there is no checking to enforce that and so it
8738 will parse without error a small subset of
8739 invalid export statements."
8740 (unless (js2-ast-root-p js2-current-scope)
8741 (js2-report-error "msg.mod.export.decl.at.top.level"))
8742 (let ((beg (js2-current-token-beg))
8744 exports-list from-clause declaration default)
8746 ((js2-match-token js2-MUL)
8747 (setq from-clause (js2-parse-from-clause))
8749 (push from-clause children)))
8750 ((js2-match-token js2-LC)
8751 (setq exports-list (js2-parse-export-bindings))
8753 (dolist (export exports-list)
8754 (push export children)))
8755 (when (js2-match-token js2-NAME)
8756 (if (equal "from" (js2-current-token-string))
8759 (setq from-clause (js2-parse-from-clause)))
8760 (js2-unget-token))))
8761 ((js2-match-token js2-DEFAULT)
8762 (setq default (js2-parse-expr)))
8763 ((or (js2-match-token js2-VAR) (js2-match-token js2-CONST) (js2-match-token js2-LET))
8764 (setq declaration (js2-parse-variables (js2-current-token-type) (js2-current-token-beg))))
8766 (setq declaration (js2-parse-expr))))
8768 (push from-clause children))
8770 (push declaration children)
8771 (when (not (js2-function-node-p declaration))
8772 (js2-auto-insert-semicolon declaration)))
8774 (push default children)
8775 (when (not (js2-function-node-p default))
8776 (js2-auto-insert-semicolon default)))
8777 (let ((node (make-js2-export-node
8779 :len (- (js2-current-token-end) beg)
8780 :exports-list exports-list
8781 :from-clause from-clause
8782 :declaration declaration
8784 (apply #'js2-node-add-children node children)
8787 (defun js2-parse-for ()
8788 "Parse a for, for-in or for each-in statement.
8789 Last matched token must be js2-FOR."
8790 (let ((for-pos (js2-current-token-beg))
8791 (tmp-scope (make-js2-scope))
8792 pn is-for-each is-for-in-or-of is-for-of
8793 in-pos each-pos tmp-pos
8794 init ; Node init is also foo in 'foo in object'.
8795 cond ; Node cond is also object in 'foo in object'.
8796 incr ; 3rd section of for-loop initializer.
8798 ;; See if this is a for each () instead of just a for ()
8799 (when (js2-match-token js2-NAME)
8800 (if (string= "each" (js2-current-token-string))
8803 each-pos (- (js2-current-token-beg) for-pos)) ; relative
8804 (js2-record-face 'font-lock-keyword-face))
8805 (js2-report-error "msg.no.paren.for")))
8806 (if (js2-must-match js2-LP "msg.no.paren.for")
8807 (setq lp (- (js2-current-token-beg) for-pos)))
8808 (setq tt (js2-get-token))
8809 ;; Capture identifiers inside parens. We can't create the node
8810 ;; (and use it as the current scope) until we know its type.
8811 (js2-push-scope tmp-scope)
8814 ;; parse init clause
8815 (let ((js2-in-for-init t)) ; set as dynamic variable
8819 (setq init (make-js2-empty-expr-node)))
8820 ((or (= tt js2-VAR) (= tt js2-LET))
8821 (setq init (js2-parse-variables tt (js2-current-token-beg))))
8824 (setq init (js2-parse-expr)))))
8825 (if (or (js2-match-token js2-IN)
8826 (and (>= js2-language-version 200)
8827 (js2-match-contextual-kwd "of")
8828 (setq is-for-of t)))
8829 (setq is-for-in-or-of t
8830 in-pos (- (js2-current-token-beg) for-pos)
8831 ;; scope of iteration target object is not the scope we've created above.
8832 ;; stash current scope temporary.
8833 cond (let ((js2-current-scope (js2-scope-parent-scope js2-current-scope)))
8834 (js2-parse-expr))) ; object over which we're iterating
8835 ;; else ordinary for loop - parse cond and incr
8836 (js2-must-match js2-SEMI "msg.no.semi.for")
8837 (setq cond (if (= (js2-peek-token) js2-SEMI)
8838 (make-js2-empty-expr-node) ; no loop condition
8840 (js2-must-match js2-SEMI "msg.no.semi.for.cond")
8841 (setq tmp-pos (js2-current-token-end)
8842 incr (if (= (js2-peek-token) js2-RP)
8843 (make-js2-empty-expr-node :pos tmp-pos)
8844 (js2-parse-expr)))))
8846 (if (js2-must-match js2-RP "msg.no.paren.for.ctrl")
8847 (setq rp (- (js2-current-token-beg) for-pos)))
8848 (if (not is-for-in-or-of)
8849 (setq pn (make-js2-for-node :init init
8854 ;; cond could be null if 'in obj' got eaten by the init node.
8855 (if (js2-infix-node-p init)
8856 ;; it was (foo in bar) instead of (var foo in bar)
8857 (setq cond (js2-infix-node-right init)
8858 init (js2-infix-node-left init))
8859 (if (and (js2-var-decl-node-p init)
8860 (> (length (js2-var-decl-node-kids init)) 1))
8861 (js2-report-error "msg.mult.index")))
8862 (setq pn (make-js2-for-in-node :iterator init
8865 :foreach-p is-for-each
8870 ;; Transplant the declarations.
8871 (setf (js2-scope-symbol-table pn)
8872 (js2-scope-symbol-table tmp-scope))
8876 ;; We have to parse the body -after- creating the loop node,
8877 ;; so that the loop node appears in the js2-loop-set, allowing
8878 ;; break/continue statements to find the enclosing loop.
8879 (setf body (js2-parse-statement)
8880 (js2-loop-node-body pn) body
8881 (js2-node-pos pn) for-pos
8882 (js2-node-len pn) (- (js2-node-end body) for-pos))
8883 (js2-node-add-children pn init cond incr body))
8888 (defun js2-parse-try ()
8889 "Parse a try statement. Last matched token must be js2-TRY."
8890 (let ((try-pos (js2-current-token-beg))
8897 (if (/= (js2-peek-token) js2-LC)
8898 (js2-report-error "msg.no.brace.try"))
8899 (setq try-block (js2-parse-statement)
8900 try-end (js2-node-end try-block)
8901 peek (js2-peek-token))
8904 (while (js2-match-token js2-CATCH)
8905 (let* ((catch-pos (js2-current-token-beg))
8906 (catch-node (make-js2-catch-node :pos catch-pos))
8911 (if saw-default-catch
8912 (js2-report-error "msg.catch.unreachable"))
8913 (if (js2-must-match js2-LP "msg.no.paren.catch")
8914 (setq lp (- (js2-current-token-beg) catch-pos)))
8915 (js2-push-scope catch-node)
8916 (let ((tt (js2-peek-token)))
8918 ;; Destructuring pattern:
8919 ;; catch ({ message, file }) { ... }
8920 ((or (= tt js2-LB) (= tt js2-LC))
8922 (setq param (js2-parse-destruct-primary-expr))
8923 (js2-define-destruct-symbols param js2-LET nil))
8926 (js2-must-match-name "msg.bad.catchcond")
8927 (setq param (js2-create-name-node))
8928 (js2-define-symbol js2-LET (js2-current-token-string) param)
8929 (js2-check-strict-identifier param))))
8931 (if (js2-match-token js2-IF)
8932 (setq guard-kwd (- (js2-current-token-beg) catch-pos)
8933 catch-cond (js2-parse-expr))
8934 (setq saw-default-catch t))
8935 (if (js2-must-match js2-RP "msg.bad.catchcond")
8936 (setq rp (- (js2-current-token-beg) catch-pos)))
8937 (js2-must-match js2-LC "msg.no.brace.catchblock")
8938 (js2-parse-statements catch-node)
8939 (if (js2-must-match js2-RC "msg.no.brace.after.body")
8940 (setq try-end (js2-current-token-end)))
8942 (setf (js2-node-len catch-node) (- try-end catch-pos)
8943 (js2-catch-node-param catch-node) param
8944 (js2-catch-node-guard-expr catch-node) catch-cond
8945 (js2-catch-node-guard-kwd catch-node) guard-kwd
8946 (js2-catch-node-lp catch-node) lp
8947 (js2-catch-node-rp catch-node) rp)
8948 (js2-node-add-children catch-node param catch-cond)
8949 (push catch-node catch-blocks))))
8950 ((/= peek js2-FINALLY)
8951 (js2-must-match js2-FINALLY "msg.try.no.catchfinally"
8952 (js2-node-pos try-block)
8953 (- (setq try-end (js2-node-end try-block))
8954 (js2-node-pos try-block)))))
8955 (when (js2-match-token js2-FINALLY)
8956 (let ((finally-pos (js2-current-token-beg))
8957 (block (js2-parse-statement)))
8958 (setq try-end (js2-node-end block)
8959 finally-block (make-js2-finally-node :pos finally-pos
8960 :len (- try-end finally-pos)
8962 (js2-node-add-children finally-block block)))
8963 (let ((pn (make-js2-try-node :pos try-pos
8964 :len (- try-end try-pos)
8965 :try-block try-block
8966 :finally-block finally-block)))
8967 (js2-node-add-children pn try-block finally-block)
8968 ;; Push them onto the try-node, which reverses and corrects their order.
8969 (dolist (cb catch-blocks)
8970 (js2-node-add-children pn cb)
8971 (push cb (js2-try-node-catch-clauses pn)))
8974 (defun js2-parse-throw ()
8975 "Parser for throw-statement. Last matched token must be js2-THROW."
8976 (let ((pos (js2-current-token-beg))
8978 (if (= (js2-peek-token-or-eol) js2-EOL)
8979 ;; ECMAScript does not allow new lines before throw expression,
8981 (js2-report-error "msg.bad.throw.eol"))
8982 (setq expr (js2-parse-expr)
8983 pn (make-js2-throw-node :pos pos
8984 :len (- (js2-node-end expr) pos)
8986 (js2-node-add-children pn expr)
8989 (defun js2-match-jump-label-name (label-name)
8990 "If break/continue specified a label, return that label's labeled stmt.
8991 Returns the corresponding `js2-labeled-stmt-node', or if LABEL-NAME
8992 does not match an existing label, reports an error and returns nil."
8993 (let ((bundle (cdr (assoc label-name js2-label-set))))
8995 (js2-report-error "msg.undef.label"))
8998 (defun js2-parse-break ()
8999 "Parser for break-statement. Last matched token must be js2-BREAK."
9000 (let ((pos (js2-current-token-beg))
9001 (end (js2-current-token-end))
9002 break-target ; statement to break from
9003 break-label ; in "break foo", name-node representing the foo
9004 labels ; matching labeled statement to break to
9006 (when (eq (js2-peek-token-or-eol) js2-NAME)
9008 (setq break-label (js2-create-name-node)
9009 end (js2-node-end break-label)
9010 ;; matchJumpLabelName only matches if there is one
9011 labels (js2-match-jump-label-name (js2-current-token-string))
9012 break-target (if labels (car (js2-labeled-stmt-node-labels labels)))))
9013 (unless (or break-target break-label)
9014 ;; no break target specified - try for innermost enclosing loop/switch
9015 (if (null js2-loop-and-switch-set)
9017 (js2-report-error "msg.bad.break" nil pos (length "break")))
9018 (setq break-target (car js2-loop-and-switch-set))))
9019 (setq pn (make-js2-break-node :pos pos
9022 :target break-target))
9023 (js2-node-add-children pn break-label) ; but not break-target
9026 (defun js2-parse-continue ()
9027 "Parser for continue-statement. Last matched token must be js2-CONTINUE."
9028 (let ((pos (js2-current-token-beg))
9029 (end (js2-current-token-end))
9030 label ; optional user-specified label, a `js2-name-node'
9031 labels ; current matching labeled stmt, if any
9032 target ; the `js2-loop-node' target of this continue stmt
9034 (when (= (js2-peek-token-or-eol) js2-NAME)
9036 (setq label (js2-create-name-node)
9037 end (js2-node-end label)
9038 ;; matchJumpLabelName only matches if there is one
9039 labels (js2-match-jump-label-name (js2-current-token-string))))
9041 ((null labels) ; no current label to go to
9042 (if (null js2-loop-set) ; no loop to continue to
9043 (js2-report-error "msg.continue.outside" nil pos
9044 (length "continue"))
9045 (setq target (car js2-loop-set)))) ; innermost enclosing loop
9047 (if (js2-loop-node-p (js2-labeled-stmt-node-stmt labels))
9048 (setq target (js2-labeled-stmt-node-stmt labels))
9049 (js2-report-error "msg.continue.nonloop" nil pos (- end pos)))))
9050 (setq pn (make-js2-continue-node :pos pos
9054 (js2-node-add-children pn label) ; but not target - it's not our child
9057 (defun js2-parse-with ()
9058 "Parser for with-statement. Last matched token must be js2-WITH."
9059 (when js2-in-use-strict-directive
9060 (js2-report-error "msg.no.with.strict"))
9061 (let ((pos (js2-current-token-beg))
9063 (if (js2-must-match js2-LP "msg.no.paren.with")
9064 (setq lp (js2-current-token-beg)))
9065 (setq obj (js2-parse-expr))
9066 (if (js2-must-match js2-RP "msg.no.paren.after.with")
9067 (setq rp (js2-current-token-beg)))
9068 (let ((js2-nesting-of-with (1+ js2-nesting-of-with)))
9069 (setq body (js2-parse-statement)))
9070 (setq pn (make-js2-with-node :pos pos
9071 :len (- (js2-node-end body) pos)
9074 :lp (js2-relpos lp pos)
9075 :rp (js2-relpos rp pos)))
9076 (js2-node-add-children pn obj body)
9079 (defun js2-parse-const-var ()
9080 "Parser for var- or const-statement.
9081 Last matched token must be js2-CONST or js2-VAR."
9082 (let ((tt (js2-current-token-type))
9083 (pos (js2-current-token-beg))
9085 (setq expr (js2-parse-variables tt (js2-current-token-beg))
9086 pn (make-js2-expr-stmt-node :pos pos
9087 :len (- (js2-node-end expr) pos)
9089 (js2-node-add-children pn expr)
9092 (defun js2-wrap-with-expr-stmt (pos expr &optional add-child)
9093 (let ((pn (make-js2-expr-stmt-node :pos pos
9094 :len (js2-node-len expr)
9095 :type (if (js2-inside-function)
9100 (js2-node-add-children pn expr))
9103 (defun js2-parse-let-stmt ()
9104 "Parser for let-statement. Last matched token must be js2-LET."
9105 (let ((pos (js2-current-token-beg))
9107 (if (= (js2-peek-token) js2-LP)
9108 ;; let expression in statement context
9109 (setq expr (js2-parse-let pos 'statement)
9110 pn (js2-wrap-with-expr-stmt pos expr t))
9111 ;; else we're looking at a statement like let x=6, y=7;
9112 (setf expr (js2-parse-variables js2-LET pos)
9113 pn (js2-wrap-with-expr-stmt pos expr t)
9114 (js2-node-type pn) js2-EXPR_RESULT))
9117 (defun js2-parse-ret-yield ()
9118 (js2-parse-return-or-yield (js2-current-token-type) nil))
9120 (defconst js2-parse-return-stmt-enders
9121 (list js2-SEMI js2-RC js2-EOF js2-EOL js2-ERROR js2-RB js2-RP js2-YIELD))
9123 (defsubst js2-now-all-set (before after mask)
9124 "Return whether or not the bits in the mask have changed to all set.
9125 BEFORE is bits before change, AFTER is bits after change, and MASK is
9126 the mask for bits. Returns t if all the bits in the mask are set in AFTER
9128 (and (/= (logand before mask) mask)
9129 (= (logand after mask) mask)))
9131 (defun js2-parse-return-or-yield (tt expr-context)
9132 (let* ((pos (js2-current-token-beg))
9133 (end (js2-current-token-end))
9134 (before js2-end-flags)
9135 (inside-function (js2-inside-function))
9136 (gen-type (and inside-function (js2-function-node-generator-type
9137 js2-current-script-or-fn)))
9138 e ret name yield-star-p)
9139 (unless inside-function
9140 (js2-report-error (if (eq tt js2-RETURN)
9143 (when (and inside-function
9145 (js2-match-token js2-MUL))
9146 (setq yield-star-p t))
9147 ;; This is ugly, but we don't want to require a semicolon.
9148 (unless (memq (js2-peek-token-or-eol) js2-parse-return-stmt-enders)
9149 (setq e (js2-parse-expr)
9150 end (js2-node-end e)))
9153 (js2-set-flag js2-end-flags (if (null e)
9155 js2-end-returns-value))
9156 (setq ret (make-js2-return-node :pos pos
9159 (js2-node-add-children ret e)
9160 ;; See if we need a strict mode warning.
9161 ;; TODO: The analysis done by `js2-has-consistent-return-usage' is
9162 ;; more thorough and accurate than this before/after flag check.
9163 ;; E.g. if there's a finally-block that always returns, we shouldn't
9164 ;; show a warning generated by inconsistent returns in the catch blocks.
9165 ;; Basically `js2-has-consistent-return-usage' needs to keep more state,
9166 ;; so we know which returns/yields to highlight, and we should get rid of
9167 ;; all the checking in `js2-parse-return-or-yield'.
9168 (if (and js2-strict-inconsistent-return-warning
9169 (js2-now-all-set before js2-end-flags
9170 (logior js2-end-returns js2-end-returns-value)))
9171 (js2-add-strict-warning "msg.return.inconsistent" nil pos end)))
9172 ((eq gen-type 'COMPREHENSION)
9173 ;; FIXME: We should probably switch to saving and using lastYieldOffset,
9174 ;; like SpiderMonkey does.
9175 (js2-report-error "msg.syntax" nil pos 5))
9177 (setq ret (make-js2-yield-node :pos pos
9180 :star-p yield-star-p))
9181 (js2-node-add-children ret e)
9182 (unless expr-context
9184 ret (js2-wrap-with-expr-stmt pos e t))
9185 (js2-set-requires-activation)
9186 (js2-set-is-generator))))
9187 ;; see if we are mixing yields and value returns.
9188 (when (and inside-function
9189 (js2-flag-set-p js2-end-flags js2-end-returns-value)
9190 (eq (js2-function-node-generator-type js2-current-script-or-fn)
9192 (setq name (js2-function-name js2-current-script-or-fn))
9193 (if (zerop (length name))
9194 (js2-report-error "msg.anon.generator.returns" nil pos (- end pos))
9195 (js2-report-error "msg.generator.returns" name pos (- end pos))))
9198 (defun js2-parse-debugger ()
9199 (make-js2-keyword-node :type js2-DEBUGGER))
9201 (defun js2-parse-block ()
9202 "Parser for a curly-delimited statement block.
9203 Last token matched must be `js2-LC'."
9204 (let ((pos (js2-current-token-beg))
9205 (pn (make-js2-scope)))
9209 (js2-parse-statements pn)
9210 (js2-must-match js2-RC "msg.no.brace.block")
9211 (setf (js2-node-len pn) (- (js2-current-token-end) pos)))
9215 ;; For `js2-ERROR' too, to have a node for error recovery to work on.
9216 (defun js2-parse-semi ()
9217 "Parse a statement or handle an error.
9218 Current token type is `js2-SEMI' or `js2-ERROR'."
9219 (let ((tt (js2-current-token-type)) pos len)
9220 (if (eq tt js2-SEMI)
9221 (make-js2-empty-expr-node :len 1)
9222 (setq pos (js2-current-token-beg)
9223 len (- (js2-current-token-end) pos))
9224 (js2-report-error "msg.syntax" nil pos len)
9225 (make-js2-error-node :pos pos :len len))))
9227 (defun js2-parse-default-xml-namespace ()
9228 "Parse a `default xml namespace = <expr>' e4x statement."
9229 (let ((pos (js2-current-token-beg))
9232 (js2-set-requires-activation)
9233 (setq len (- js2-ts-cursor pos))
9234 (unless (and (js2-match-token js2-NAME)
9235 (string= (js2-current-token-string) "xml"))
9236 (js2-report-error "msg.bad.namespace" nil pos len))
9237 (unless (and (js2-match-token js2-NAME)
9238 (string= (js2-current-token-string) "namespace"))
9239 (js2-report-error "msg.bad.namespace" nil pos len))
9240 (unless (js2-match-token js2-ASSIGN)
9241 (js2-report-error "msg.bad.namespace" nil pos len))
9242 (setq expr (js2-parse-expr)
9243 end (js2-node-end expr)
9244 unary (make-js2-unary-node :type js2-DEFAULTNAMESPACE
9248 (js2-node-add-children unary expr)
9249 (make-js2-expr-stmt-node :pos pos
9253 (defun js2-record-label (label bundle)
9254 ;; current token should be colon that `js2-parse-primary-expr' left untouched
9256 (let ((name (js2-label-node-name label))
9259 (when (setq labeled-stmt (cdr (assoc name js2-label-set)))
9260 ;; flag both labels if possible when used in editing mode
9261 (if (and js2-parse-ide-mode
9262 (setq dup (js2-get-label-by-name labeled-stmt name)))
9263 (js2-report-error "msg.dup.label" nil
9264 (js2-node-abs-pos dup) (js2-node-len dup)))
9265 (js2-report-error "msg.dup.label" nil
9266 (js2-node-pos label) (js2-node-len label)))
9267 (js2-labeled-stmt-node-add-label bundle label)
9268 (js2-node-add-children bundle label)
9269 ;; Add one reference to the bundle per label in `js2-label-set'
9270 (push (cons name bundle) js2-label-set)))
9272 (defun js2-parse-name-or-label ()
9273 "Parser for identifier or label. Last token matched must be js2-NAME.
9274 Called when we found a name in a statement context. If it's a label, we gather
9275 up any following labels and the next non-label statement into a
9276 `js2-labeled-stmt-node' bundle and return that. Otherwise we parse an
9277 expression and return it wrapped in a `js2-expr-stmt-node'."
9278 (let ((pos (js2-current-token-beg))
9281 ;; set check for label and call down to `js2-parse-primary-expr'
9282 (setq expr (js2-maybe-parse-label))
9284 ;; Parse the non-label expression and wrap with expression stmt.
9285 (js2-wrap-with-expr-stmt pos (js2-parse-expr) t)
9286 ;; else parsed a label
9287 (setq bundle (make-js2-labeled-stmt-node :pos pos))
9288 (js2-record-label expr bundle)
9289 ;; look for more labels
9290 (while (and continue (= (js2-get-token) js2-NAME))
9291 (if (setq expr (js2-maybe-parse-label))
9292 (js2-record-label expr bundle)
9293 (setq expr (js2-parse-expr)
9294 stmt (js2-wrap-with-expr-stmt (js2-node-pos expr) expr t)
9296 (js2-auto-insert-semicolon stmt)))
9297 ;; no more labels; now parse the labeled statement
9300 (let ((js2-labeled-stmt bundle)) ; bind dynamically
9302 (setq stmt (js2-statement-helper))))
9303 ;; remove the labels for this statement from the global set
9304 (dolist (label (js2-labeled-stmt-node-labels bundle))
9305 (setq js2-label-set (remove label js2-label-set))))
9306 (setf (js2-labeled-stmt-node-stmt bundle) stmt
9307 (js2-node-len bundle) (- (js2-node-end stmt) pos))
9308 (js2-node-add-children bundle stmt)
9311 (defun js2-maybe-parse-label ()
9312 (cl-assert (= (js2-current-token-type) js2-NAME))
9314 (next-tt (js2-get-token))
9315 (label-end (js2-current-token-end)))
9316 ;; Do not consume colon, it is used as unwind indicator
9317 ;; to return to statementHelper.
9319 (if (= next-tt js2-COLON)
9321 (setq label-pos (js2-current-token-beg))
9322 (make-js2-label-node :pos label-pos
9323 :len (- label-end label-pos)
9324 :name (js2-current-token-string))
9325 (js2-set-face label-pos
9327 'font-lock-variable-name-face 'record))
9328 ;; Backtrack from the name token, too.
9332 (defun js2-parse-expr-stmt ()
9333 "Default parser in statement context, if no recognized statement found."
9334 (js2-wrap-with-expr-stmt (js2-current-token-beg)
9337 (js2-parse-expr)) t))
9339 (defun js2-parse-variables (decl-type pos)
9340 "Parse a comma-separated list of variable declarations.
9341 Could be a 'var', 'const' or 'let' expression, possibly in a for-loop initializer.
9343 DECL-TYPE is a token value: either VAR, CONST, or LET depending on context.
9344 For 'var' or 'const', the keyword should be the token last scanned.
9346 POS is the position where the node should start. It's sometimes the
9347 var/const/let keyword, and other times the beginning of the first token
9348 in the first variable declaration.
9350 Returns the parsed `js2-var-decl-node' expression node."
9351 (let* ((result (make-js2-var-decl-node :decl-type decl-type
9353 destructuring kid-pos tt init name end nbeg nend vi
9356 ;; var foo = {a: 1, b: 2}, bar = [3, 4];
9357 ;; var {b: s2, a: s1} = foo, x = 6, y, [s3, s4] = bar;
9358 ;; var {a, b} = baz;
9360 (setq destructuring nil
9363 kid-pos (js2-current-token-beg)
9364 end (js2-current-token-end)
9366 (if (or (= tt js2-LB) (= tt js2-LC))
9367 ;; Destructuring assignment, e.g., var [a, b] = ...
9368 (setq destructuring (js2-parse-destruct-primary-expr)
9369 end (js2-node-end destructuring))
9370 ;; Simple variable name
9372 (when (js2-must-match-name "msg.bad.var")
9373 (setq name (js2-create-name-node)
9374 nbeg (js2-current-token-beg)
9375 nend (js2-current-token-end)
9377 (js2-define-symbol decl-type (js2-current-token-string) name js2-in-for-init)
9378 (js2-check-strict-identifier name)))
9379 (when (js2-match-token js2-ASSIGN)
9380 (setq init (js2-parse-assign-expr)
9381 end (js2-node-end init))
9382 (js2-record-imenu-functions init name))
9384 (js2-set-face nbeg nend (if (js2-function-node-p init)
9385 'font-lock-function-name-face
9386 'font-lock-variable-name-face)
9388 (setq vi (make-js2-var-init-node :pos kid-pos
9389 :len (- end kid-pos)
9393 (if (and (null init) (not js2-in-for-init))
9394 (js2-report-error "msg.destruct.assign.no.init"))
9395 (js2-define-destruct-symbols destructuring
9397 'font-lock-variable-name-face)
9398 (setf (js2-var-init-node-target vi) destructuring))
9399 (setf (js2-var-init-node-target vi) name))
9400 (setf (js2-var-init-node-initializer vi) init)
9401 (js2-node-add-children vi name destructuring init)
9402 (js2-block-node-push result vi)
9403 (unless (js2-match-token js2-COMMA)
9404 (setq continue nil)))
9405 (setf (js2-node-len result) (- end pos))
9408 (defun js2-parse-let (pos &optional stmt-p)
9409 "Parse a let expression or statement.
9410 A let-expression is of the form `let (vars) expr'.
9411 A let-statement is of the form `let (vars) {statements}'.
9412 The third form of let is a variable declaration list, handled
9413 by `js2-parse-variables'."
9414 (let ((pn (make-js2-let-node :pos pos))
9416 (if (js2-must-match js2-LP "msg.no.paren.after.let")
9417 (setf (js2-let-node-lp pn) (- (js2-current-token-beg) pos)))
9421 (setq vars (js2-parse-variables js2-LET (js2-current-token-beg)))
9422 (if (js2-must-match js2-RP "msg.no.paren.let")
9423 (setf (js2-let-node-rp pn) (- (js2-current-token-beg) pos)))
9424 (if (and stmt-p (js2-match-token js2-LC))
9427 (setf beg (js2-current-token-beg) ; position stmt at LC
9428 body (js2-parse-statements))
9429 (js2-must-match js2-RC "msg.no.curly.let")
9430 (setf (js2-node-len body) (- (js2-current-token-end) beg)
9431 (js2-node-len pn) (- (js2-current-token-end) pos)
9432 (js2-let-node-body pn) body
9433 (js2-node-type pn) js2-LET))
9435 (setf body (js2-parse-expr)
9436 (js2-node-len pn) (- (js2-node-end body) pos)
9437 (js2-let-node-body pn) body))
9438 (setf (js2-let-node-vars pn) vars)
9439 (js2-node-add-children pn vars body))
9443 (defun js2-define-new-symbol (decl-type name node &optional scope)
9444 (js2-scope-put-symbol (or scope js2-current-scope)
9446 (make-js2-symbol decl-type name node)))
9448 (defun js2-define-symbol (decl-type name &optional node ignore-not-in-block)
9449 "Define a symbol in the current scope.
9450 If NODE is non-nil, it is the AST node associated with the symbol."
9451 (let* ((defining-scope (js2-get-defining-scope js2-current-scope name))
9452 (symbol (if defining-scope
9453 (js2-scope-get-symbol defining-scope name)))
9454 (sdt (if symbol (js2-symbol-decl-type symbol) -1))
9455 (pos (if node (js2-node-abs-pos node)))
9456 (len (if node (js2-node-len node))))
9458 ((and symbol ; already defined
9459 (or (if js2-in-use-strict-directive
9460 ;; two const-bound vars in this block have same name
9461 (and (= sdt js2-CONST)
9462 (eq defining-scope js2-current-scope))
9463 (or (= sdt js2-CONST) ; old version is const
9464 (= decl-type js2-CONST))) ; new version is const
9465 ;; two let-bound vars in this block have same name
9466 (and (= sdt js2-LET)
9467 (eq defining-scope js2-current-scope))))
9470 ((= sdt js2-CONST) "msg.const.redecl")
9471 ((= sdt js2-LET) "msg.let.redecl")
9472 ((= sdt js2-VAR) "msg.var.redecl")
9473 ((= sdt js2-FUNCTION) "msg.function.redecl")
9474 (t "msg.parm.redecl"))
9476 ((or (= decl-type js2-LET)
9477 ;; strict mode const is scoped to the current LexicalEnvironment
9478 (and js2-in-use-strict-directive
9479 (= decl-type js2-CONST)))
9480 (if (and (= decl-type js2-LET)
9481 (not ignore-not-in-block)
9482 (or (= (js2-node-type js2-current-scope) js2-IF)
9483 (js2-loop-node-p js2-current-scope)))
9484 (js2-report-error "msg.let.decl.not.in.block")
9485 (js2-define-new-symbol decl-type name node)))
9486 ((or (= decl-type js2-VAR)
9487 (= decl-type js2-FUNCTION)
9488 ;; sloppy mode const is scoped to the current VariableEnvironment
9489 (and (not js2-in-use-strict-directive)
9490 (= decl-type js2-CONST)))
9492 (if (and js2-strict-var-redeclaration-warning (= sdt js2-VAR))
9493 (js2-add-strict-warning "msg.var.redecl" name)
9494 (if (and js2-strict-var-hides-function-arg-warning (= sdt js2-LP))
9495 (js2-add-strict-warning "msg.var.hides.arg" name)))
9496 (js2-define-new-symbol decl-type name node
9497 js2-current-script-or-fn)))
9498 ((= decl-type js2-LP)
9500 ;; must be duplicate parameter. Second parameter hides the
9501 ;; first, so go ahead and add the second pararameter
9502 (js2-report-warning "msg.dup.parms" name))
9503 (js2-define-new-symbol decl-type name node))
9504 (t (js2-code-bug)))))
9506 (defun js2-parse-paren-expr-or-generator-comp ()
9507 (let ((px-pos (js2-current-token-beg)))
9509 ((and (>= js2-language-version 200)
9510 (js2-match-token js2-FOR))
9511 (js2-parse-generator-comp px-pos))
9512 ((and (>= js2-language-version 200)
9513 (js2-match-token js2-RP))
9514 ;; Not valid expression syntax, but this is valid in an arrow
9515 ;; function with no params: () => body.
9516 (if (eq (js2-peek-token) js2-ARROW)
9517 ;; Return whatever, it will hopefully be rewinded and
9518 ;; reparsed when we reach the =>.
9519 (make-js2-keyword-node :type js2-NULL)
9520 (js2-report-error "msg.syntax")
9521 (make-js2-error-node)))
9523 (let* ((js2-in-for-init nil)
9524 (expr (js2-parse-expr))
9525 (pn (make-js2-paren-node :pos px-pos
9527 (js2-node-add-children pn (js2-paren-node-expr pn))
9528 (js2-must-match js2-RP "msg.no.paren")
9529 (setf (js2-node-len pn) (- (js2-current-token-end) px-pos))
9532 (defun js2-parse-expr (&optional oneshot)
9533 (let* ((pn (js2-parse-assign-expr))
9534 (pos (js2-node-pos pn))
9538 (while (and (not oneshot)
9539 (js2-match-token js2-COMMA))
9540 (setq op-pos (- (js2-current-token-beg) pos)) ; relative
9541 (if (= (js2-peek-token) js2-YIELD)
9542 (js2-report-error "msg.yield.parenthesized"))
9543 (setq right (js2-parse-assign-expr)
9545 pn (make-js2-infix-node :type js2-COMMA
9547 :len (- js2-ts-cursor pos)
9551 (js2-node-add-children pn left right))
9554 (defun js2-parse-assign-expr ()
9555 (let ((tt (js2-get-token))
9556 (pos (js2-current-token-beg))
9557 pn left right op-pos
9558 ts-state recorded-identifiers parsed-errors)
9559 (if (= tt js2-YIELD)
9560 (js2-parse-return-or-yield tt t)
9561 ;; Save the tokenizer state in case we find an arrow function
9562 ;; and have to rewind.
9563 (setq ts-state (make-js2-ts-state)
9564 recorded-identifiers js2-recorded-identifiers
9565 parsed-errors js2-parsed-errors)
9566 ;; not yield - parse assignment expression
9567 (setq pn (js2-parse-cond-expr)
9570 ((and (<= js2-first-assign tt)
9571 (<= tt js2-last-assign))
9572 ;; tt express assignment (=, |=, ^=, ..., %=)
9573 (setq op-pos (- (js2-current-token-beg) pos) ; relative
9575 ;; The assigned node could be a js2-prop-get-node (foo.bar = 0), we only
9576 ;; care about assignment to strict variable names.
9577 (when (js2-name-node-p left)
9578 (js2-check-strict-identifier left))
9579 (setq right (js2-parse-assign-expr)
9580 pn (make-js2-assign-node :type tt
9582 :len (- (js2-node-end right) pos)
9586 (when js2-parse-ide-mode
9587 (js2-highlight-assign-targets pn left right)
9588 (js2-record-imenu-functions right left))
9589 ;; do this last so ide checks above can use absolute positions
9590 (js2-node-add-children pn left right))
9591 ((and (= tt js2-ARROW)
9592 (>= js2-language-version 200))
9593 (js2-ts-seek ts-state)
9594 (setq js2-recorded-identifiers recorded-identifiers
9595 js2-parsed-errors parsed-errors)
9596 (setq pn (js2-parse-function 'FUNCTION_ARROW (js2-current-token-beg) nil)))
9601 (defun js2-parse-cond-expr ()
9602 (let ((pos (js2-current-token-beg))
9603 (pn (js2-parse-or-expr))
9609 (when (js2-match-token js2-HOOK)
9610 (setq q-pos (- (js2-current-token-beg) pos)
9611 if-true (let (js2-in-for-init) (js2-parse-assign-expr)))
9612 (js2-must-match js2-COLON "msg.no.colon.cond")
9613 (setq c-pos (- (js2-current-token-beg) pos)
9614 if-false (js2-parse-assign-expr)
9616 pn (make-js2-cond-node :pos pos
9617 :len (- (js2-node-end if-false) pos)
9618 :test-expr test-expr
9620 :false-expr if-false
9623 (js2-node-add-children pn test-expr if-true if-false))
9626 (defun js2-make-binary (type left parser)
9627 "Helper for constructing a binary-operator AST node.
9628 LEFT is the left-side-expression, already parsed, and the
9629 binary operator should have just been matched.
9630 PARSER is a function to call to parse the right operand,
9631 or a `js2-node' struct if it has already been parsed.
9632 FIXME: The latter option is unused?"
9633 (let* ((pos (js2-node-pos left))
9634 (op-pos (- (js2-current-token-beg) pos))
9635 (right (if (js2-node-p parser)
9639 (pn (make-js2-infix-node :type type
9641 :len (- (js2-node-end right) pos)
9645 (js2-node-add-children pn left right)
9648 (defun js2-parse-or-expr ()
9649 (let ((pn (js2-parse-and-expr)))
9650 (when (js2-match-token js2-OR)
9651 (setq pn (js2-make-binary js2-OR
9653 'js2-parse-or-expr)))
9656 (defun js2-parse-and-expr ()
9657 (let ((pn (js2-parse-bit-or-expr)))
9658 (when (js2-match-token js2-AND)
9659 (setq pn (js2-make-binary js2-AND
9661 'js2-parse-and-expr)))
9664 (defun js2-parse-bit-or-expr ()
9665 (let ((pn (js2-parse-bit-xor-expr)))
9666 (while (js2-match-token js2-BITOR)
9667 (setq pn (js2-make-binary js2-BITOR
9669 'js2-parse-bit-xor-expr)))
9672 (defun js2-parse-bit-xor-expr ()
9673 (let ((pn (js2-parse-bit-and-expr)))
9674 (while (js2-match-token js2-BITXOR)
9675 (setq pn (js2-make-binary js2-BITXOR
9677 'js2-parse-bit-and-expr)))
9680 (defun js2-parse-bit-and-expr ()
9681 (let ((pn (js2-parse-eq-expr)))
9682 (while (js2-match-token js2-BITAND)
9683 (setq pn (js2-make-binary js2-BITAND
9685 'js2-parse-eq-expr)))
9688 (defconst js2-parse-eq-ops
9689 (list js2-EQ js2-NE js2-SHEQ js2-SHNE))
9691 (defun js2-parse-eq-expr ()
9692 (let ((pn (js2-parse-rel-expr))
9694 (while (memq (setq tt (js2-get-token)) js2-parse-eq-ops)
9695 (setq pn (js2-make-binary tt
9697 'js2-parse-rel-expr)))
9701 (defconst js2-parse-rel-ops
9702 (list js2-IN js2-INSTANCEOF js2-LE js2-LT js2-GE js2-GT))
9704 (defun js2-parse-rel-expr ()
9705 (let ((pn (js2-parse-shift-expr))
9709 (setq tt (js2-get-token))
9711 ((and js2-in-for-init (= tt js2-IN))
9713 (setq continue nil))
9714 ((memq tt js2-parse-rel-ops)
9715 (setq pn (js2-make-binary tt pn 'js2-parse-shift-expr)))
9718 (setq continue nil))))
9721 (defconst js2-parse-shift-ops
9722 (list js2-LSH js2-URSH js2-RSH))
9724 (defun js2-parse-shift-expr ()
9725 (let ((pn (js2-parse-add-expr))
9729 (setq tt (js2-get-token))
9730 (if (memq tt js2-parse-shift-ops)
9731 (setq pn (js2-make-binary tt pn 'js2-parse-add-expr))
9733 (setq continue nil)))
9736 (defun js2-parse-add-expr ()
9737 (let ((pn (js2-parse-mul-expr))
9741 (setq tt (js2-get-token))
9742 (if (or (= tt js2-ADD) (= tt js2-SUB))
9743 (setq pn (js2-make-binary tt pn 'js2-parse-mul-expr))
9745 (setq continue nil)))
9748 (defconst js2-parse-mul-ops
9749 (list js2-MUL js2-DIV js2-MOD))
9751 (defun js2-parse-mul-expr ()
9752 (let ((pn (js2-parse-unary-expr))
9756 (setq tt (js2-get-token))
9757 (if (memq tt js2-parse-mul-ops)
9758 (setq pn (js2-make-binary tt pn 'js2-parse-unary-expr))
9760 (setq continue nil)))
9763 (defun js2-make-unary (type parser &rest args)
9764 "Make a unary node of type TYPE.
9765 PARSER is either a node (for postfix operators) or a function to call
9766 to parse the operand (for prefix operators)."
9767 (let* ((pos (js2-current-token-beg))
9768 (postfix (js2-node-p parser))
9771 (apply parser args)))
9774 (if postfix ; e.g. i++
9775 (setq pos (js2-node-pos expr)
9776 end (js2-current-token-end))
9777 (setq end (js2-node-end expr)))
9778 (setq pn (make-js2-unary-node :type type
9782 (js2-node-add-children pn expr)
9785 (defconst js2-incrementable-node-types
9786 (list js2-NAME js2-GETPROP js2-GETELEM js2-GET_REF js2-CALL)
9787 "Node types that can be the operand of a ++ or -- operator.")
9789 (defun js2-check-bad-inc-dec (tt beg end unary)
9790 (unless (memq (js2-node-type (js2-unary-node-operand unary))
9791 js2-incrementable-node-types)
9792 (js2-report-error (if (= tt js2-INC)
9795 nil beg (- end beg))))
9797 (defun js2-parse-unary-expr ()
9798 (let ((tt (js2-current-token-type))
9801 ((or (= tt js2-VOID)
9806 (js2-make-unary tt 'js2-parse-unary-expr))
9809 ;; Convert to special POS token in decompiler and parse tree
9810 (js2-make-unary js2-POS 'js2-parse-unary-expr))
9813 ;; Convert to special NEG token in decompiler and parse tree
9814 (js2-make-unary js2-NEG 'js2-parse-unary-expr))
9819 (setq beg (js2-current-token-beg)
9820 end (js2-current-token-end)
9821 expr (js2-make-unary tt 'js2-parse-member-expr t))
9822 (js2-check-bad-inc-dec tt beg end expr)))
9825 (js2-make-unary js2-DELPROP 'js2-parse-unary-expr))
9828 (make-js2-error-node)) ; try to continue
9830 js2-compiler-xml-available)
9831 ;; XML stream encountered in expression.
9832 (js2-parse-member-expr-tail t (js2-parse-xml-initializer)))
9834 (setq pn (js2-parse-member-expr t)
9835 ;; Don't look across a newline boundary for a postfix incop.
9836 tt (js2-peek-token-or-eol))
9837 (when (or (= tt js2-INC) (= tt js2-DEC))
9840 pn (js2-make-unary tt expr))
9841 (js2-node-set-prop pn 'postfix t)
9842 (js2-check-bad-inc-dec tt (js2-current-token-beg) (js2-current-token-end) pn))
9845 (defun js2-parse-xml-initializer ()
9846 "Parse an E4X XML initializer.
9847 I'm parsing it the way Rhino parses it, but without the tree-rewriting.
9848 Then I'll postprocess the result, depending on whether we're in IDE
9849 mode or codegen mode, and generate the appropriate rewritten AST.
9850 IDE mode uses a rich AST that models the XML structure. Codegen mode
9851 just concatenates everything and makes a new XML or XMLList out of it."
9852 (let ((tt (js2-get-first-xml-token))
9853 pn-xml pn expr kids expr-pos
9856 (when (not (or (= tt js2-XML) (= tt js2-XMLEND)))
9857 (js2-report-error "msg.syntax"))
9858 (setq pn-xml (make-js2-xml-node))
9861 (setq first-token nil)
9862 (setq tt (js2-get-next-xml-token)))
9864 ;; js2-XML means we found a {expr} in the XML stream.
9865 ;; The token string is the XML up to the left-curly.
9867 (push (make-js2-string-node :pos (js2-current-token-beg)
9868 :len (- js2-ts-cursor (js2-current-token-beg)))
9870 (js2-must-match js2-LC "msg.syntax")
9871 (setq expr-pos js2-ts-cursor
9872 expr (if (eq (js2-peek-token) js2-RC)
9873 (make-js2-empty-expr-node :pos expr-pos)
9875 (js2-must-match js2-RC "msg.syntax")
9876 (setq pn (make-js2-xml-js-expr-node :pos (js2-node-pos expr)
9877 :len (js2-node-len expr)
9879 (js2-node-add-children pn expr)
9881 ;; a js2-XMLEND token means we hit the final close-tag.
9883 (push (make-js2-string-node :pos (js2-current-token-beg)
9884 :len (- js2-ts-cursor (js2-current-token-beg)))
9886 (dolist (kid (nreverse kids))
9887 (js2-block-node-push pn-xml kid))
9888 (setf (js2-node-len pn-xml) (- js2-ts-cursor
9889 (js2-node-pos pn-xml))
9892 (js2-report-error "msg.syntax")
9893 (setq continue nil))))
9897 (defun js2-parse-argument-list ()
9898 "Parse an argument list and return it as a Lisp list of nodes.
9899 Returns the list in reverse order. Consumes the right-paren token."
9901 (unless (js2-match-token js2-RP)
9903 (let ((tt (js2-get-token)))
9904 (if (= tt js2-YIELD)
9905 (js2-report-error "msg.yield.parenthesized"))
9906 (if (and (= tt js2-TRIPLEDOT)
9907 (>= js2-language-version 200))
9908 (push (js2-make-unary tt 'js2-parse-assign-expr) result)
9910 (push (js2-parse-assign-expr) result)))
9912 (js2-match-token js2-COMMA))
9913 (js2-must-match js2-RP "msg.no.paren.arg")
9916 (defun js2-parse-member-expr (&optional allow-call-syntax)
9917 (let ((tt (js2-current-token-type))
9918 pn pos target args beg end init)
9920 (setq pn (js2-parse-primary-expr))
9921 ;; parse a 'new' expression
9923 (setq pos (js2-current-token-beg)
9925 target (js2-parse-member-expr)
9926 end (js2-node-end target)
9927 pn (make-js2-new-node :pos pos
9930 (js2-highlight-function-call (js2-current-token))
9931 (js2-node-add-children pn target)
9932 (when (js2-match-token js2-LP)
9933 ;; Add the arguments to pn, if any are supplied.
9934 (setf beg pos ; start of "new" keyword
9935 pos (js2-current-token-beg)
9936 args (nreverse (js2-parse-argument-list))
9937 (js2-new-node-args pn) args
9938 end (js2-current-token-end)
9939 (js2-new-node-lp pn) (- pos beg)
9940 (js2-new-node-rp pn) (- end 1 beg))
9941 (apply #'js2-node-add-children pn args))
9942 (when (and js2-allow-rhino-new-expr-initializer
9943 (js2-match-token js2-LC))
9944 (setf init (js2-parse-object-literal)
9945 end (js2-node-end init)
9946 (js2-new-node-initializer pn) init)
9947 (js2-node-add-children pn init))
9948 (setf (js2-node-len pn) (- end beg))) ; end outer if
9949 (js2-parse-member-expr-tail allow-call-syntax pn)))
9951 (defun js2-parse-member-expr-tail (allow-call-syntax pn)
9952 "Parse a chain of property/array accesses or function calls.
9953 Includes parsing for E4X operators like `..' and `.@'.
9954 If ALLOW-CALL-SYNTAX is nil, stops when we encounter a left-paren.
9955 Returns an expression tree that includes PN, the parent node."
9959 (setq tt (js2-get-token))
9961 ((or (= tt js2-DOT) (= tt js2-DOTDOT))
9962 (setq pn (js2-parse-property-access tt pn)))
9963 ((= tt js2-DOTQUERY)
9964 (setq pn (js2-parse-dot-query pn)))
9966 (setq pn (js2-parse-element-get pn)))
9969 (if allow-call-syntax
9970 (setq pn (js2-parse-function-call pn))
9971 (setq continue nil)))
9972 ((= tt js2-TEMPLATE_HEAD)
9973 (setq pn (js2-parse-tagged-template pn (js2-parse-template-literal))))
9974 ((= tt js2-NO_SUBS_TEMPLATE)
9975 (setq pn (js2-parse-tagged-template pn (make-js2-string-node :type tt))))
9978 (setq continue nil)))
9979 (if (>= js2-highlight-level 2)
9980 (js2-parse-highlight-member-expr-node pn)))
9983 (defun js2-parse-tagged-template (tag-node tpl-node)
9984 "Parse tagged template expression."
9985 (let* ((beg (js2-node-pos tag-node))
9986 (pn (make-js2-tagged-template-node :beg beg
9987 :len (- (js2-current-token-end) beg)
9989 :template tpl-node)))
9990 (js2-node-add-children pn tag-node tpl-node)
9993 (defun js2-parse-dot-query (pn)
9994 "Parse a dot-query expression, e.g. foo.bar.(@name == 2)
9995 Last token parsed must be `js2-DOTQUERY'."
9996 (let ((pos (js2-node-pos pn))
9999 (js2-set-requires-activation)
10000 (setq op-pos (js2-current-token-beg)
10001 expr (js2-parse-expr)
10002 end (js2-node-end expr)
10003 pn (make-js2-xml-dot-query-node :left pn
10007 (js2-node-add-children pn
10008 (js2-xml-dot-query-node-left pn)
10009 (js2-xml-dot-query-node-right pn))
10010 (if (js2-must-match js2-RP "msg.no.paren")
10011 (setf (js2-xml-dot-query-node-rp pn) (js2-current-token-beg)
10012 end (js2-current-token-end)))
10013 (setf (js2-node-len pn) (- end pos))
10016 (defun js2-parse-element-get (pn)
10017 "Parse an element-get expression, e.g. foo[bar].
10018 Last token parsed must be `js2-RB'."
10019 (let ((lb (js2-current-token-beg))
10020 (pos (js2-node-pos pn))
10022 (setq expr (js2-parse-expr))
10023 (if (js2-must-match js2-RB "msg.no.bracket.index")
10024 (setq rb (js2-current-token-beg)))
10025 (setq pn (make-js2-elem-get-node :target pn
10028 :lb (js2-relpos lb pos)
10029 :rb (js2-relpos rb pos)
10030 :len (- (js2-current-token-end) pos)))
10031 (js2-node-add-children pn
10032 (js2-elem-get-node-target pn)
10033 (js2-elem-get-node-element pn))
10036 (defun js2-highlight-function-call (token)
10037 (when (eq (js2-token-type token) js2-NAME)
10038 (js2-record-face 'js2-function-call token)))
10040 (defun js2-parse-function-call (pn)
10041 (js2-highlight-function-call (js2-current-token))
10044 (pos (js2-node-pos pn)))
10045 (setq pn (make-js2-call-node :pos pos
10047 :lp (- (js2-current-token-beg) pos)))
10048 (js2-node-add-children pn (js2-call-node-target pn))
10049 ;; Add the arguments to pn, if any are supplied.
10050 (setf args (nreverse (js2-parse-argument-list))
10051 (js2-call-node-rp pn) (- (js2-current-token-beg) pos)
10052 (js2-call-node-args pn) args)
10053 (apply #'js2-node-add-children pn args)
10054 (setf (js2-node-len pn) (- js2-ts-cursor pos))
10057 (defun js2-parse-property-access (tt pn)
10058 "Parse a property access, XML descendants access, or XML attr access."
10059 (let ((member-type-flags 0)
10060 (dot-pos (js2-current-token-beg))
10061 (dot-len (if (= tt js2-DOTDOT) 2 1))
10063 ref ; right side of . or .. operator
10065 (when (= tt js2-DOTDOT)
10066 (js2-must-have-xml)
10067 (setq member-type-flags js2-descendants-flag))
10068 (if (not js2-compiler-xml-available)
10070 (js2-must-match-prop-name "msg.no.name.after.dot")
10071 (setq name (js2-create-name-node t js2-GETPROP)
10072 result (make-js2-prop-get-node :left pn
10073 :pos (js2-current-token-beg)
10075 :len (js2-current-token-len)))
10076 (js2-node-add-children result pn name)
10078 ;; otherwise look for XML operators
10079 (setf result (if (= tt js2-DOT)
10080 (make-js2-prop-get-node)
10081 (make-js2-infix-node :type js2-DOTDOT))
10082 (js2-node-pos result) (js2-node-pos pn)
10083 (js2-infix-node-op-pos result) dot-pos
10084 (js2-infix-node-left result) pn ; do this after setting position
10085 tt (js2-get-prop-name-token))
10087 ;; handles: name, ns::name, ns::*, ns::[expr]
10089 (setq ref (js2-parse-property-name -1 nil member-type-flags)))
10090 ;; handles: *, *::name, *::*, *::[expr]
10092 (setq ref (js2-parse-property-name nil "*" member-type-flags)))
10093 ;; handles: '@attr', '@ns::attr', '@ns::*', '@ns::[expr]', etc.
10094 ((= tt js2-XMLATTR)
10095 (setq result (js2-parse-attribute-access)))
10097 (js2-report-error "msg.no.name.after.dot" nil dot-pos dot-len)))
10099 (setf (js2-node-len result) (- (js2-node-end ref)
10100 (js2-node-pos result))
10101 (js2-infix-node-right result) ref))
10102 (if (js2-infix-node-p result)
10103 (js2-node-add-children result
10104 (js2-infix-node-left result)
10105 (js2-infix-node-right result)))
10108 (defun js2-parse-attribute-access ()
10109 "Parse an E4X XML attribute expression.
10110 This includes expressions of the forms:
10112 @attr @ns::attr @ns::*
10114 @[expr] @*::[expr] @ns::[expr]
10116 Called if we peeked an '@' token."
10117 (let ((tt (js2-get-prop-name-token))
10118 (at-pos (js2-current-token-beg)))
10120 ;; handles: @name, @ns::name, @ns::*, @ns::[expr]
10122 (js2-parse-property-name at-pos nil 0))
10123 ;; handles: @*, @*::name, @*::*, @*::[expr]
10125 (js2-parse-property-name (js2-current-token-beg) "*" 0))
10128 (js2-parse-xml-elem-ref at-pos))
10130 (js2-report-error "msg.no.name.after.xmlAttr")
10131 ;; Avoid cascaded errors that happen if we make an error node here.
10132 (js2-parse-property-name (js2-current-token-beg) "" 0)))))
10134 (defun js2-parse-property-name (at-pos s member-type-flags)
10135 "Check if :: follows name in which case it becomes qualified name.
10137 AT-POS is a natural number if we just read an '@' token, else nil.
10138 S is the name or string that was matched: an identifier, 'throw' or '*'.
10139 MEMBER-TYPE-FLAGS is a bit set tracking whether we're a '.' or '..' child.
10141 Returns a `js2-xml-ref-node' if it's an attribute access, a child of a '..'
10142 operator, or the name is followed by ::. For a plain name, returns a
10143 `js2-name-node'. Returns a `js2-error-node' for malformed XML expressions."
10144 (let ((pos (or at-pos (js2-current-token-beg)))
10146 (name (js2-create-name-node t (js2-current-token-type) s))
10149 (when (js2-match-token js2-COLONCOLON)
10151 colon-pos (js2-current-token-beg)
10152 tt (js2-get-prop-name-token))
10154 ;; handles name::name
10156 (setq name (js2-create-name-node)))
10159 (setq name (js2-create-name-node nil nil "*")))
10160 ;; handles name::[expr]
10162 (throw 'return (js2-parse-xml-elem-ref at-pos ns colon-pos)))
10164 (js2-report-error "msg.no.name.after.coloncolon"))))
10165 (if (and (null ns) (zerop member-type-flags))
10169 (make-js2-xml-prop-ref-node :pos pos
10170 :len (- (js2-node-end name) pos)
10172 :colon-pos colon-pos
10174 (js2-node-add-children pn name))))))
10176 (defun js2-parse-xml-elem-ref (at-pos &optional namespace colon-pos)
10177 "Parse the [expr] portion of an xml element reference.
10178 For instance, @[expr], @*::[expr], or ns::[expr]."
10179 (let* ((lb (js2-current-token-beg))
10180 (pos (or at-pos lb))
10182 (expr (js2-parse-expr))
10183 (end (js2-node-end expr))
10185 (if (js2-must-match js2-RB "msg.no.bracket.index")
10186 (setq rb (js2-current-token-beg)
10187 end (js2-current-token-end)))
10190 (make-js2-xml-elem-ref-node :pos pos
10192 :namespace namespace
10193 :colon-pos colon-pos
10196 :lb (js2-relpos lb pos)
10197 :rb (js2-relpos rb pos)))
10198 (js2-node-add-children pn namespace expr))))
10200 (defun js2-parse-destruct-primary-expr ()
10201 (let ((js2-is-in-destructuring t))
10202 (js2-parse-primary-expr)))
10204 (defun js2-parse-primary-expr ()
10205 "Parse a literal (leaf) expression of some sort.
10206 Includes complex literals such as functions, object-literals,
10207 array-literals, array comprehensions and regular expressions."
10209 (setq tt (js2-current-token-type))
10212 (js2-parse-class-expr))
10213 ((= tt js2-FUNCTION)
10214 (js2-parse-function-expr))
10216 (js2-parse-array-comp-or-literal))
10218 (js2-parse-object-literal))
10220 (js2-parse-let (js2-current-token-beg)))
10222 (js2-parse-paren-expr-or-generator-comp))
10223 ((= tt js2-XMLATTR)
10224 (js2-must-have-xml)
10225 (js2-parse-attribute-access))
10227 (js2-parse-name tt))
10229 (setq node (make-js2-number-node))
10230 (when (and js2-in-use-strict-directive
10231 (= (js2-number-node-num-base node) 8))
10232 (js2-report-error "msg.no.octal.strict"))
10234 ((or (= tt js2-STRING) (= tt js2-NO_SUBS_TEMPLATE))
10235 (make-js2-string-node :type tt))
10236 ((= tt js2-TEMPLATE_HEAD)
10237 (js2-parse-template-literal))
10238 ((or (= tt js2-DIV) (= tt js2-ASSIGN_DIV))
10239 ;; Got / or /= which in this context means a regexp literal
10240 (let ((px-pos (js2-current-token-beg))
10241 (flags (js2-read-regexp tt))
10242 (end (js2-current-token-end)))
10244 (make-js2-regexp-node :pos px-pos
10245 :len (- end px-pos)
10246 :value (js2-current-token-string)
10248 (js2-set-face px-pos end 'font-lock-string-face 'record)
10249 (js2-record-text-property px-pos end 'syntax-table '(2)))))
10250 ((or (= tt js2-NULL)
10255 (make-js2-keyword-node :type tt))
10256 ((= tt js2-TRIPLEDOT)
10257 ;; Likewise, only valid in an arrow function with a rest param.
10258 (if (and (js2-match-token js2-NAME)
10259 (js2-match-token js2-RP)
10260 (eq (js2-peek-token) js2-ARROW))
10262 (js2-unget-token) ; Put back the right paren.
10263 ;; See the previous case.
10264 (make-js2-keyword-node :type js2-NULL))
10265 (js2-report-error "msg.syntax")
10266 (make-js2-error-node)))
10267 ((= tt js2-RESERVED)
10268 (js2-report-error "msg.reserved.id")
10269 (make-js2-name-node))
10271 ;; the scanner or one of its subroutines reported the error.
10272 (make-js2-error-node))
10274 (let* ((px-pos (point-at-bol))
10275 (len (- js2-ts-cursor px-pos)))
10276 (js2-report-error "msg.unexpected.eof" nil px-pos len))
10277 (make-js2-error-node :pos (1- js2-ts-cursor)))
10279 (js2-report-error "msg.syntax")
10280 (make-js2-error-node)))))
10282 (defun js2-parse-template-literal ()
10283 (let ((beg (js2-current-token-beg))
10284 (kids (list (make-js2-string-node :type js2-TEMPLATE_HEAD)))
10285 (tt js2-TEMPLATE_HEAD))
10286 (while (eq tt js2-TEMPLATE_HEAD)
10287 (push (js2-parse-expr) kids)
10288 (js2-must-match js2-RC "msg.syntax")
10289 (setq tt (js2-get-token 'TEMPLATE_TAIL))
10290 (push (make-js2-string-node :type tt) kids))
10291 (setq kids (nreverse kids))
10292 (let ((tpl (make-js2-template-node :beg beg
10293 :len (- (js2-current-token-end) beg)
10295 (apply #'js2-node-add-children tpl kids)
10298 (defun js2-parse-name (_tt)
10299 (let ((name (js2-current-token-string))
10301 (setq node (if js2-compiler-xml-available
10302 (js2-parse-property-name nil name 0)
10303 (js2-create-name-node 'check-activation nil name)))
10304 (if js2-highlight-external-variables
10305 (js2-record-name-node node))
10308 (defun js2-parse-warn-trailing-comma (msg pos elems comma-pos)
10309 (js2-add-strict-warning
10311 ;; back up from comma to beginning of line or array/objlit
10313 (js2-node-pos (car elems))
10316 (goto-char comma-pos)
10317 (back-to-indentation)
10321 (defun js2-parse-array-comp-or-literal ()
10322 (let ((pos (js2-current-token-beg)))
10323 (if (and (>= js2-language-version 200)
10324 (js2-match-token js2-FOR))
10325 (js2-parse-array-comp pos)
10326 (js2-parse-array-literal pos))))
10328 (defun js2-parse-array-literal (pos)
10329 (let ((after-lb-or-comma t)
10330 after-comma tt elems pn
10332 (unless js2-is-in-destructuring
10333 (js2-push-scope (make-js2-scope))) ; for the legacy array comp
10335 (setq tt (js2-get-token))
10339 (setq after-comma (js2-current-token-end))
10340 (if (not after-lb-or-comma)
10341 (setq after-lb-or-comma t)
10345 (= tt js2-EOF)) ; prevent infinite loop
10347 (js2-report-error "msg.no.bracket.arg" nil pos))
10348 (when (and after-comma (< js2-language-version 170))
10349 (js2-parse-warn-trailing-comma "msg.array.trailing.comma"
10350 pos (remove nil elems) after-comma))
10352 pn (make-js2-array-node :pos pos
10353 :len (- js2-ts-cursor pos)
10354 :elems (nreverse elems)))
10355 (apply #'js2-node-add-children pn (js2-array-node-elems pn)))
10356 ;; destructuring binding
10357 (js2-is-in-destructuring
10358 (push (if (or (= tt js2-LC)
10361 ;; [a, b, c] | {a, b, c} | {a:x, b:y, c:z} | a
10362 (js2-parse-destruct-primary-expr)
10364 (js2-report-error "msg.bad.var")
10365 (make-js2-error-node))
10367 (setq after-lb-or-comma nil
10370 ((and (>= js2-language-version 170)
10371 (= tt js2-FOR) ; check for array comprehension
10372 (not after-lb-or-comma) ; "for" can't follow a comma
10373 elems ; must have at least 1 element
10374 (not (cdr elems))) ; but no 2nd element
10377 pn (js2-parse-legacy-array-comp (car elems) pos)))
10380 (unless after-lb-or-comma
10381 (js2-report-error "msg.no.bracket.arg"))
10382 (if (and (= tt js2-TRIPLEDOT)
10383 (>= js2-language-version 200))
10385 (push (js2-make-unary tt 'js2-parse-assign-expr)
10388 (push (js2-parse-assign-expr) elems))
10389 (setq after-lb-or-comma nil
10390 after-comma nil))))
10391 (unless js2-is-in-destructuring
10395 (defun js2-parse-legacy-array-comp (expr pos)
10396 "Parse a legacy array comprehension (JavaScript 1.7).
10397 EXPR is the first expression after the opening left-bracket.
10398 POS is the beginning of the LB token preceding EXPR.
10399 We should have just parsed the 'for' keyword before calling this function."
10400 (let ((current-scope js2-current-scope)
10401 loops first filter result)
10404 (while (js2-match-token js2-FOR)
10405 (let ((loop (make-js2-comp-loop-node)))
10406 (js2-push-scope loop)
10408 (js2-parse-comp-loop loop)))
10409 ;; First loop takes expr scope's parent.
10410 (setf (js2-scope-parent-scope (setq first (car (last loops))))
10411 (js2-scope-parent-scope current-scope))
10412 ;; Set expr scope's parent to the last loop.
10413 (setf (js2-scope-parent-scope current-scope) (car loops))
10414 (if (/= (js2-get-token) js2-IF)
10416 (setq filter (js2-parse-condition))))
10417 (dotimes (_ (1- (length loops)))
10419 (js2-must-match js2-RB "msg.no.bracket.arg" pos)
10420 (setq result (make-js2-comp-node :pos pos
10421 :len (- js2-ts-cursor pos)
10423 :loops (nreverse loops)
10424 :filters (and filter (list (car filter)))
10425 :form 'LEGACY_ARRAY))
10426 ;; Set comp loop's parent to the last loop.
10427 ;; TODO: Get rid of the bogus expr scope.
10428 (setf (js2-scope-parent-scope result) first)
10429 (apply #'js2-node-add-children result expr (car filter)
10430 (js2-comp-node-loops result))
10433 (defun js2-parse-array-comp (pos)
10434 "Parse an ES6 array comprehension.
10435 POS is the beginning of the LB token.
10436 We should have just parsed the 'for' keyword before calling this function."
10437 (let ((pn (js2-parse-comprehension pos 'ARRAY)))
10438 (js2-must-match js2-RB "msg.no.bracket.arg" pos)
10441 (defun js2-parse-generator-comp (pos)
10442 (let* ((js2-nesting-of-function (1+ js2-nesting-of-function))
10443 (js2-current-script-or-fn
10444 (make-js2-function-node :generator-type 'COMPREHENSION))
10445 (pn (js2-parse-comprehension pos 'STAR_GENERATOR)))
10446 (js2-must-match js2-RP "msg.no.paren" pos)
10449 (defun js2-parse-comprehension (pos form)
10450 (let (loops filters expr result last)
10454 (while (js2-match-token js2-FOR)
10455 (let ((loop (make-js2-comp-loop-node)))
10456 (js2-push-scope loop)
10458 (js2-parse-comp-loop loop)))
10459 (while (js2-match-token js2-IF)
10460 (push (car (js2-parse-condition)) filters))
10461 (setq expr (js2-parse-assign-expr))
10462 (setq last (car loops)))
10465 (setq result (make-js2-comp-node :pos pos
10466 :len (- js2-ts-cursor pos)
10468 :loops (nreverse loops)
10469 :filters (nreverse filters)
10471 (apply #'js2-node-add-children result (js2-comp-node-loops result))
10472 (apply #'js2-node-add-children result expr (js2-comp-node-filters result))
10473 (setf (js2-scope-parent-scope result) last)
10476 (defun js2-parse-comp-loop (pn &optional only-of-p)
10477 "Parse a 'for [each] (foo [in|of] bar)' expression in an Array comprehension.
10478 The current token should be the initial FOR.
10479 If ONLY-OF-P is non-nil, only the 'for (foo of bar)' form is allowed."
10480 (let ((pos (js2-comp-loop-node-pos pn))
10481 tt iter obj foreach-p forof-p in-pos each-pos lp rp)
10482 (when (and (not only-of-p) (js2-match-token js2-NAME))
10483 (if (string= (js2-current-token-string) "each")
10486 each-pos (- (js2-current-token-beg) pos)) ; relative
10487 (js2-record-face 'font-lock-keyword-face))
10488 (js2-report-error "msg.no.paren.for")))
10489 (if (js2-must-match js2-LP "msg.no.paren.for")
10490 (setq lp (- (js2-current-token-beg) pos)))
10491 (setq tt (js2-peek-token))
10496 (setq iter (js2-parse-destruct-primary-expr))
10497 (js2-define-destruct-symbols iter js2-LET
10498 'font-lock-variable-name-face t))
10499 ((js2-match-token js2-NAME)
10500 (setq iter (js2-create-name-node)))
10502 (js2-report-error "msg.bad.var")))
10503 ;; Define as a let since we want the scope of the variable to
10504 ;; be restricted to the array comprehension
10505 (if (js2-name-node-p iter)
10506 (js2-define-symbol js2-LET (js2-name-node-name iter) pn t))
10507 (if (or (and (not only-of-p) (js2-match-token js2-IN))
10508 (and (>= js2-language-version 200)
10509 (js2-match-contextual-kwd "of")
10511 (setq in-pos (- (js2-current-token-beg) pos))
10512 (js2-report-error "msg.in.after.for.name"))
10513 (setq obj (js2-parse-expr))
10514 (if (js2-must-match js2-RP "msg.no.paren.for.ctrl")
10515 (setq rp (- (js2-current-token-beg) pos)))
10516 (setf (js2-node-pos pn) pos
10517 (js2-node-len pn) (- js2-ts-cursor pos)
10518 (js2-comp-loop-node-iterator pn) iter
10519 (js2-comp-loop-node-object pn) obj
10520 (js2-comp-loop-node-in-pos pn) in-pos
10521 (js2-comp-loop-node-each-pos pn) each-pos
10522 (js2-comp-loop-node-foreach-p pn) foreach-p
10523 (js2-comp-loop-node-forof-p pn) forof-p
10524 (js2-comp-loop-node-lp pn) lp
10525 (js2-comp-loop-node-rp pn) rp)
10526 (js2-node-add-children pn iter obj)
10529 (defun js2-parse-class-stmt ()
10530 (let ((pos (js2-current-token-beg))
10531 (_ (js2-must-match-name "msg.unnamed.class.stmt"))
10532 (name (js2-create-name-node t)))
10533 (js2-set-face (js2-node-pos name) (js2-node-end name)
10534 'font-lock-function-name-face 'record)
10535 (let ((node (js2-parse-class pos 'CLASS_STATEMENT name)))
10536 (js2-define-symbol js2-FUNCTION
10537 (js2-name-node-name name)
10541 (defun js2-parse-class-expr ()
10542 (let ((pos (js2-current-token-beg))
10544 (when (js2-match-token js2-NAME)
10545 (setq name (js2-create-name-node t)))
10546 (js2-parse-class pos 'CLASS_EXPRESSION name)))
10548 (defun js2-parse-class (pos form name)
10549 ;; class X [extends ...] {
10550 (let (pn elems extends)
10551 (if (js2-match-token js2-EXTENDS)
10552 (if (= (js2-peek-token) js2-LC)
10553 (js2-report-error "msg.missing.extends")
10554 ;; TODO(sdh): this should be left-hand-side-expr, not assign-expr
10555 (setq extends (js2-parse-assign-expr))
10557 (js2-report-error "msg.bad.extends"))))
10558 (js2-must-match js2-LC "msg.no.brace.class")
10559 (setq elems (js2-parse-object-literal-elems t)
10560 pn (make-js2-class-node :pos pos
10561 :len (- js2-ts-cursor pos)
10566 (apply #'js2-node-add-children pn (js2-class-node-elems pn))
10569 (defun js2-parse-object-literal ()
10570 (let* ((pos (js2-current-token-beg))
10571 (elems (js2-parse-object-literal-elems))
10572 (result (make-js2-object-node :pos pos
10573 :len (- js2-ts-cursor pos)
10575 (apply #'js2-node-add-children result (js2-object-node-elems result))
10578 (defun js2-property-key-string (property-node)
10579 "Return the key of PROPERTY-NODE (a `js2-object-prop-node' or
10580 `js2-getter-setter-node') as a string, or nil if it can't be
10581 represented as a string (e.g., the key is computed by an
10583 (let ((key (js2-infix-node-left property-node)))
10585 ((js2-name-node-p key)
10586 (js2-name-node-name key))
10587 ((js2-string-node-p key)
10588 (js2-string-node-value key))
10589 ((js2-number-node-p key)
10590 (js2-number-node-value key)))))
10592 (defun js2-parse-object-literal-elems (&optional class-p)
10593 (let ((pos (js2-current-token-beg))
10597 elem-key-string previous-elem-key-string
10598 after-comma previous-token)
10600 (setq tt (js2-get-prop-name-token)
10603 previous-token nil)
10604 ;; Handle 'static' keyword only if we're in a class
10605 (when (and class-p (= js2-NAME tt)
10606 (string= "static" (js2-current-token-string)))
10607 (js2-record-face 'font-lock-keyword-face)
10609 tt (js2-get-prop-name-token)))
10610 ;; Handle generator * before the property name for in-line functions
10611 (when (and (>= js2-language-version 200)
10613 (setq previous-token (js2-current-token)
10614 tt (js2-get-prop-name-token)))
10615 ;; Handle 'get' or 'set' keywords
10616 (let ((prop (js2-current-token-string)))
10617 (when (and (>= js2-language-version 200)
10619 (or (string= prop "get")
10620 (string= prop "set"))
10621 (member (js2-peek-token)
10622 (list js2-NAME js2-STRING js2-NUMBER js2-LB)))
10623 (setq previous-token (js2-current-token)
10624 tt (js2-get-prop-name-token))))
10626 ;; Found a property (of any sort)
10627 ((member tt (list js2-NAME js2-STRING js2-NUMBER js2-LB))
10628 (setq after-comma nil
10629 elem (js2-parse-named-prop tt pos previous-token))
10630 (if (and (null elem)
10631 (not js2-recover-from-parse-errors))
10632 (setq continue nil)))
10633 ;; Break out of loop, and handle trailing commas.
10637 (setq continue nil)
10639 (js2-parse-warn-trailing-comma "msg.extra.trailing.comma"
10640 pos elems after-comma)))
10642 (js2-report-error "msg.bad.prop")
10643 (unless js2-recover-from-parse-errors
10644 (setq continue nil)))) ; end switch
10645 ;; Handle static for classes' codegen.
10647 (if elem (js2-node-set-prop elem 'STATIC t)
10648 (js2-report-error "msg.unexpected.static")))
10649 ;; Handle commas, depending on class-p.
10650 (let ((tok (js2-get-prop-name-token)))
10651 (if (eq tok js2-COMMA)
10653 (js2-report-error "msg.class.unexpected.comma")
10654 (setq after-comma (js2-current-token-end)))
10656 (unless class-p (setq continue nil))))
10658 (when (and js2-in-use-strict-directive
10659 (setq elem-key-string (js2-property-key-string elem))
10661 (lambda (previous-elem)
10662 (and (setq previous-elem-key-string
10663 (js2-property-key-string previous-elem))
10664 ;; Check if the property is a duplicate.
10665 (string= previous-elem-key-string elem-key-string)
10666 ;; But make an exception for getter / setter pairs.
10667 (not (and (js2-getter-setter-node-p elem)
10668 (js2-getter-setter-node-p previous-elem)
10669 (/= (js2-getter-setter-node-type elem)
10670 (js2-getter-setter-node-type previous-elem))))))
10672 (js2-report-error "msg.dup.obj.lit.prop.strict"
10674 (js2-node-abs-pos (js2-infix-node-left elem))
10675 (js2-node-len (js2-infix-node-left elem))))
10676 ;; Append any parsed element.
10677 (push elem elems))) ; end loop
10678 (js2-must-match js2-RC "msg.no.brace.prop")
10681 (defun js2-parse-named-prop (tt pos previous-token)
10682 "Parse a name, string, or getter/setter object property.
10683 When `js2-is-in-destructuring' is t, forms like {a, b, c} will be permitted."
10685 ;; Literal string keys: {'foo': 'bar'}
10687 (make-js2-string-node))
10688 ;; Handle computed keys: {[Symbol.iterator]: ...}, *[1+2]() {...}},
10689 ;; {[foo + bar]() { ... }}, {[get ['x' + 1]() {...}}
10690 ((and (= tt js2-LB)
10691 (>= js2-language-version 200))
10692 (prog1 (js2-parse-expr)
10693 (js2-must-match js2-RB "msg.missing.computed.rb")))
10694 ;; Numeric keys: {12: 'foo'}, {10.7: 'bar'}
10696 (make-js2-number-node))
10697 ;; Unquoted names: {foo: 12}
10699 (js2-create-name-node))
10700 ;; Anything else is an error
10701 (t (js2-report-error "msg.bad.prop"))))
10702 (prop (and previous-token (js2-token-string previous-token)))
10703 (property-type (when previous-token
10704 (if (= (js2-token-type previous-token) js2-MUL)
10706 (js2-token-string previous-token)))))
10707 (when (or (string= prop "get")
10708 (string= prop "set"))
10709 (js2-set-face (js2-token-beg previous-token)
10710 (js2-token-end previous-token)
10711 'font-lock-keyword-face 'record)) ; get/set
10713 ;; method definition: {f() {...}}
10714 ((and (= (js2-peek-token) js2-LP)
10715 (>= js2-language-version 200))
10716 (when (js2-name-node-p key) ; highlight function name properties
10717 (js2-record-face 'font-lock-function-name-face))
10718 (js2-parse-getter-setter-prop pos key property-type))
10721 (let ((beg (js2-current-token-beg))
10722 (end (js2-current-token-end))
10723 (expr (js2-parse-plain-property key)))
10724 (when (and (= tt js2-NAME)
10725 (not js2-is-in-destructuring)
10726 js2-highlight-external-variables
10727 (js2-node-get-prop expr 'SHORTHAND))
10728 (js2-record-name-node key))
10729 (js2-set-face beg end
10730 (if (js2-function-node-p
10731 (js2-object-prop-node-right expr))
10732 'font-lock-function-name-face
10733 'js2-object-property)
10737 (defun js2-parse-plain-property (prop)
10738 "Parse a non-getter/setter property in an object literal.
10739 PROP is the node representing the property: a number, name,
10740 string or expression."
10741 (let* ((tt (js2-get-token))
10742 (pos (js2-node-pos prop))
10745 ;; Abbreviated property, as in {foo, bar}
10746 ((and (>= js2-language-version 200)
10747 (or (= tt js2-COMMA)
10749 (not (js2-number-node-p prop)))
10751 (setq result (make-js2-object-prop-node
10755 :op-pos (js2-current-token-len)))
10756 (js2-node-add-children result prop)
10757 (js2-node-set-prop result 'SHORTHAND t)
10761 (if (= tt js2-COLON)
10762 (setq colon (- (js2-current-token-beg) pos)
10763 expr (js2-parse-assign-expr))
10764 (js2-report-error "msg.no.colon.prop")
10765 (setq expr (make-js2-error-node)))
10766 (setq result (make-js2-object-prop-node
10768 ;; don't include last consumed token in length
10769 :len (- (+ (js2-node-pos expr)
10770 (js2-node-len expr))
10775 (js2-node-add-children result prop expr)
10778 (defun js2-parse-getter-setter-prop (pos prop type-string)
10779 "Parse getter or setter property in an object literal.
10780 JavaScript syntax is:
10782 { get foo() {...}, set foo(x) {...} }
10784 and expression closure style is also supported
10786 { get foo() x, set foo(x) _x = x }
10788 POS is the start position of the `get' or `set' keyword.
10789 PROP is the `js2-name-node' representing the property name.
10790 TYPE-STRING is a string `get', `set', `*', or nil, indicating a found keyword."
10792 ((string= "get" type-string) js2-GET)
10793 ((string= "set" type-string) js2-SET)
10796 (fn (js2-parse-function-expr)))
10797 ;; it has to be an anonymous function, as we already parsed the name
10798 (if (/= (js2-node-type fn) js2-FUNCTION)
10799 (js2-report-error "msg.bad.prop")
10800 (if (cl-plusp (length (js2-function-name fn)))
10801 (js2-report-error "msg.bad.prop")))
10802 (js2-node-set-prop fn 'GETTER_SETTER type) ; for codegen
10803 (when (string= type-string "*")
10804 (setf (js2-function-node-generator-type fn) 'STAR))
10805 (setq end (js2-node-end fn)
10806 result (make-js2-getter-setter-node :type type
10811 (js2-node-add-children result prop fn)
10814 (defun js2-create-name-node (&optional check-activation-p token string)
10815 "Create a name node using the current token and, optionally, STRING.
10816 And, if CHECK-ACTIVATION-P is non-nil, use the value of TOKEN."
10817 (let* ((beg (js2-current-token-beg))
10818 (tt (js2-current-token-type))
10820 (if (= js2-NAME tt)
10821 (js2-current-token-string)
10822 (js2-tt-name tt))))
10824 (setq name (make-js2-name-node :pos beg
10827 (if check-activation-p
10828 (js2-check-activation-name s (or token js2-NAME)))
10831 ;;; Indentation support (bouncing)
10833 ;; In recent-enough Emacs, we reuse the indentation code from
10834 ;; `js-mode'. To continue support for the older versions, some code
10835 ;; that was here previously was moved to `js2-old-indent.el'.
10837 ;; Whichever indenter is used, it's often "wrong", however, and needs
10838 ;; to be overridden. The right long-term solution is probably to
10839 ;; emulate (or integrate with) cc-engine, but it's a nontrivial amount
10840 ;; of coding. Even when a parse tree from `js2-parse' is present,
10841 ;; which is not true at the moment the user is typing, computing
10842 ;; indentation is still thousands of lines of code to handle every
10843 ;; possible syntactic edge case.
10845 ;; In the meantime, the compromise solution is that we offer a "bounce
10846 ;; indenter", configured with `js2-bounce-indent-p', which cycles the
10847 ;; current line indent among various likely guess points. This approach
10848 ;; is far from perfect, but should at least make it slightly easier to
10849 ;; move the line towards its desired indentation when manually
10850 ;; overriding Karl's heuristic nesting guesser.
10852 (defun js2-backward-sws ()
10853 "Move backward through whitespace and comments."
10855 (while (forward-comment -1)))
10857 (defun js2-forward-sws ()
10858 "Move forward through whitespace and comments."
10860 (while (forward-comment 1)))
10862 (defun js2-arglist-close ()
10863 "Return non-nil if we're on a line beginning with a close-paren/brace."
10865 (goto-char (point-at-bol))
10867 (looking-at "[])}]")))
10869 (defun js2-indent-looks-like-label-p ()
10870 (goto-char (point-at-bol))
10872 (looking-at (concat js2-mode-identifier-re ":")))
10874 (defun js2-indent-in-objlit-p (parse-status)
10875 "Return non-nil if this looks like an object-literal entry."
10876 (let ((start (nth 1 parse-status)))
10880 (and (zerop (forward-line -1))
10881 (not (< (point) start)) ; crossed a {} boundary
10882 (js2-indent-looks-like-label-p)))
10884 (js2-indent-looks-like-label-p)))))
10886 ;; If prev line looks like foobar({ then we're passing an object
10887 ;; literal to a function call, and people pretty much always want to
10888 ;; de-dent back to the previous line, so move the 'basic-offset'
10889 ;; position to the front.
10890 (defun js2-indent-objlit-arg-p (parse-status)
10892 (back-to-indentation)
10894 (and (eq (1- (point)) (nth 1 parse-status))
10895 (eq (char-before) ?{)
10898 (skip-chars-backward " \t")
10899 (eq (char-before) ?\()))))
10901 (defun js2-indent-case-block-p ()
10903 (back-to-indentation)
10905 (goto-char (point-at-bol))
10906 (skip-chars-forward " \t")
10907 (looking-at "case\\s-.+:")))
10909 (defun js2-bounce-indent (normal-col parse-status &optional backward)
10910 "Cycle among alternate computed indentation positions.
10911 PARSE-STATUS is the result of `parse-partial-sexp' from the beginning
10912 of the buffer to the current point. NORMAL-COL is the indentation
10913 column computed by the heuristic guesser based on current paren,
10914 bracket, brace and statement nesting. If BACKWARDS, cycle positions
10916 (let ((cur-indent (current-indentation))
10917 (old-buffer-undo-list buffer-undo-list)
10918 ;; Emacs 21 only has `count-lines', not `line-number-at-pos'
10919 (current-line (save-excursion
10920 (forward-line 0) ; move to bol
10921 (1+ (count-lines (point-min) (point)))))
10922 positions pos main-pos anchor arglist-cont same-indent
10923 basic-offset computed-pos)
10924 ;; temporarily don't record undo info, if user requested this
10925 (when js2-mode-indent-inhibit-undo
10926 (setq buffer-undo-list t))
10929 ;; First likely point: indent from beginning of previous code line
10930 (push (setq basic-offset
10932 (back-to-indentation)
10934 (back-to-indentation)
10939 ;; (First + epsilon) likely point: indent 2x from beginning of
10940 ;; previous code line. Google does it this way.
10941 (push (setq basic-offset
10943 (back-to-indentation)
10945 (back-to-indentation)
10947 (* 2 js2-basic-offset)))
10950 ;; Second likely point: indent from assign-expr RHS. This
10951 ;; is just a crude guess based on finding " = " on the previous
10952 ;; line containing actual code.
10953 (setq pos (save-excursion
10955 (goto-char (point-at-bol))
10956 (when (re-search-forward "\\s-+\\(=\\)\\s-+"
10958 (goto-char (match-end 1))
10959 (skip-chars-forward " \t\r\n")
10960 (current-column))))
10962 (cl-incf pos js2-basic-offset)
10963 (push pos positions))
10965 ;; Third likely point: same indent as previous line of code.
10966 ;; Make it the first likely point if we're not on an
10967 ;; arglist-close line and previous line ends in a comma, or
10968 ;; both this line and prev line look like object-literal
10970 (setq pos (save-excursion
10971 (goto-char (point-at-bol))
10973 (back-to-indentation)
10976 ;; while we're here, look for trailing comma
10977 (if (save-excursion
10978 (goto-char (point-at-eol))
10980 (eq (char-before) ?,))
10981 (setq arglist-cont (1- (point)))))))
10983 (if (and (or arglist-cont
10984 (js2-indent-in-objlit-p parse-status))
10985 (not (js2-arglist-close)))
10986 (setq same-indent pos))
10987 (push pos positions))
10989 ;; Fourth likely point: first preceding code with less indentation.
10990 ;; than the immediately preceding code line.
10991 (setq pos (save-excursion
10992 (back-to-indentation)
10994 (back-to-indentation)
10995 (setq anchor (current-column))
10996 (while (and (zerop (forward-line -1))
10998 (back-to-indentation)
11001 (setq pos (current-column))))
11002 (push pos positions)
11004 ;; nesting-heuristic position, main by default
11005 (push (setq main-pos normal-col) positions)
11007 ;; delete duplicates and sort positions list
11008 (setq positions (sort (delete-dups positions) '<))
11010 ;; comma-list continuation lines: prev line indent takes precedence
11012 (setq main-pos same-indent))
11014 ;; common special cases where we want to indent in from previous line
11015 (if (or (js2-indent-case-block-p)
11016 (js2-indent-objlit-arg-p parse-status))
11017 (setq main-pos basic-offset))
11019 ;; if bouncing backward, reverse positions list
11021 (setq positions (reverse positions)))
11023 ;; record whether we're already sitting on one of the alternatives
11024 (setq pos (member cur-indent positions))
11027 ;; case 0: we're one one of the alternatives and this is the
11028 ;; first time they've pressed TAB on this line (best-guess).
11029 ((and js2-mode-indent-ignore-first-tab
11031 ;; first time pressing TAB on this line?
11032 (not (eq js2-mode-last-indented-line current-line)))
11034 (setq computed-pos nil))
11035 ;; case 1: only one computed position => use it
11036 ((null (cdr positions))
11037 (setq computed-pos 0))
11038 ;; case 2: not on any of the computed spots => use main spot
11040 (setq computed-pos (js2-position main-pos positions)))
11041 ;; case 3: on last position: cycle to first position
11043 (setq computed-pos 0))
11044 ;; case 4: on intermediate position: cycle to next position
11046 (setq computed-pos (js2-position (cl-second pos) positions))))
11048 ;; see if any hooks want to indent; otherwise we do it
11049 (cl-loop with result = nil
11050 for hook in js2-indent-hook
11051 while (null result)
11053 (setq result (funcall hook positions computed-pos))
11055 (unless (or result (null computed-pos))
11056 (indent-line-to (nth computed-pos positions)))))
11059 (if js2-mode-indent-inhibit-undo
11060 (setq buffer-undo-list old-buffer-undo-list))
11061 ;; see commentary for `js2-mode-last-indented-line'
11062 (setq js2-mode-last-indented-line current-line))))
11064 (defun js2-1-line-comment-continuation-p ()
11065 "Return t if we're in a 1-line comment continuation.
11066 If so, we don't ever want to use bounce-indent."
11070 (looking-at "\\s-*//"))
11074 (when (looking-at "\\s-*$")
11077 (looking-at "\\s-*//")))))
11079 (defun js2-indent-bounce (&optional backward)
11080 "Indent the current line, bouncing between several positions."
11082 (let (parse-status offset indent-col
11083 ;; Don't whine about errors/warnings when we're indenting.
11084 ;; This has to be set before calling parse-partial-sexp below.
11085 (inhibit-point-motion-hooks t))
11086 (setq parse-status (save-excursion
11087 (syntax-ppss (point-at-bol)))
11088 offset (- (point) (save-excursion
11089 (back-to-indentation)
11091 ;; Don't touch multiline strings.
11092 (unless (nth 3 parse-status)
11093 (setq indent-col (js2-proper-indentation parse-status))
11095 ;; It doesn't work well on first line of buffer.
11096 ((and (not (nth 4 parse-status))
11097 (not (js2-same-line (point-min)))
11098 (not (js2-1-line-comment-continuation-p)))
11099 (js2-bounce-indent indent-col parse-status backward))
11100 ;; just indent to the guesser's likely spot
11101 (t (indent-line-to indent-col)))
11102 (when (cl-plusp offset)
11103 (forward-char offset)))))
11105 (defun js2-indent-bounce-backward ()
11106 "Indent the current line, bouncing between positions in reverse."
11108 (js2-indent-bounce t))
11110 (defun js2-indent-region (start end)
11111 "Indent the region, but don't use bounce indenting."
11112 (let ((js2-bounce-indent-p nil)
11113 (indent-region-function nil)
11114 (after-change-functions (remq 'js2-mode-edit
11115 after-change-functions)))
11116 (indent-region start end nil) ; nil for byte-compiler
11117 (js2-mode-edit start end (- end start))))
11119 (defvar js2-minor-mode-map
11120 (let ((map (make-sparse-keymap)))
11121 (define-key map (kbd "C-c C-`") #'js2-next-error)
11122 (define-key map [mouse-1] #'js2-mode-show-node)
11124 "Keymap used when `js2-minor-mode' is active.")
11127 (define-minor-mode js2-minor-mode
11128 "Minor mode for running js2 as a background linter.
11129 This allows you to use a different major mode for JavaScript editing,
11130 such as `js-mode', while retaining the asynchronous error/warning
11131 highlighting features of `js2-mode'."
11133 :lighter " js-lint"
11134 (if (derived-mode-p 'js2-mode)
11135 (setq js2-minor-mode nil)
11137 (js2-minor-mode-enter)
11138 (js2-minor-mode-exit))))
11140 (defun js2-minor-mode-enter ()
11141 "Initialization for `js2-minor-mode'."
11142 (set (make-local-variable 'max-lisp-eval-depth)
11143 (max max-lisp-eval-depth 3000))
11144 (setq next-error-function #'js2-next-error)
11145 (js2-set-default-externs)
11146 ;; Experiment: make reparse-delay longer for longer files.
11147 (if (cl-plusp js2-dynamic-idle-timer-adjust)
11148 (setq js2-idle-timer-delay
11149 (* js2-idle-timer-delay
11150 (/ (point-max) js2-dynamic-idle-timer-adjust))))
11151 (setq js2-mode-buffer-dirty-p t
11152 js2-mode-parsing nil)
11153 (set (make-local-variable 'js2-highlight-level) 0) ; no syntax highlighting
11154 (add-hook 'after-change-functions #'js2-minor-mode-edit nil t)
11155 (add-hook 'change-major-mode-hook #'js2-minor-mode-exit nil t)
11156 (when js2-include-jslint-globals
11157 (add-hook 'js2-post-parse-callbacks 'js2-apply-jslint-globals nil t))
11158 (run-hooks 'js2-init-hook)
11161 (defun js2-minor-mode-exit ()
11162 "Turn off `js2-minor-mode'."
11163 (setq next-error-function nil)
11164 (remove-hook 'after-change-functions #'js2-mode-edit t)
11165 (remove-hook 'change-major-mode-hook #'js2-minor-mode-exit t)
11166 (when js2-mode-node-overlay
11167 (delete-overlay js2-mode-node-overlay)
11168 (setq js2-mode-node-overlay nil))
11169 (js2-remove-overlays)
11170 (remove-hook 'js2-post-parse-callbacks 'js2-apply-jslint-globals t)
11171 (setq js2-mode-ast nil))
11173 (defvar js2-source-buffer nil "Linked source buffer for diagnostics view")
11174 (make-variable-buffer-local 'js2-source-buffer)
11176 (cl-defun js2-display-error-list ()
11177 "Display a navigable buffer listing parse errors/warnings."
11179 (unless (js2-have-errors-p)
11180 (message "No errors")
11181 (cl-return-from js2-display-error-list))
11182 (cl-labels ((annotate-list
11184 "Add diagnostic TYPE and line number to errs list"
11185 (mapcar (lambda (err)
11186 (list err type (line-number-at-pos (nth 1 err))))
11188 (let* ((srcbuf (current-buffer))
11189 (errbuf (get-buffer-create "*js-lint*"))
11190 (errors (annotate-list
11191 (when js2-mode-ast (js2-ast-root-errors js2-mode-ast))
11192 'js2-error)) ; must be a valid face name
11193 (warnings (annotate-list
11194 (when js2-mode-ast (js2-ast-root-warnings js2-mode-ast))
11195 'js2-warning)) ; must be a valid face name
11196 (all-errs (sort (append errors warnings)
11197 (lambda (e1 e2) (< (cl-cadar e1) (cl-cadar e2))))))
11198 (with-current-buffer errbuf
11199 (let ((inhibit-read-only t))
11201 (dolist (err all-errs)
11202 (cl-destructuring-bind ((msg-key beg _end &rest) type line) err
11203 (insert-text-button
11204 (format "line %d: %s" line (js2-get-msg msg-key))
11206 'follow-link "\C-m"
11207 'action 'js2-error-buffer-jump
11208 'js2-msg (js2-get-msg msg-key)
11211 (js2-error-buffer-mode)
11212 (setq js2-source-buffer srcbuf)
11213 (pop-to-buffer errbuf)
11214 (goto-char (point-min))
11216 (js2-error-buffer-view))))))
11218 (defvar js2-error-buffer-mode-map
11219 (let ((map (make-sparse-keymap)))
11220 (define-key map "n" #'js2-error-buffer-next)
11221 (define-key map "p" #'js2-error-buffer-prev)
11222 (define-key map (kbd "RET") #'js2-error-buffer-jump)
11223 (define-key map "o" #'js2-error-buffer-view)
11224 (define-key map "q" #'js2-error-buffer-quit)
11226 "Keymap used for js2 diagnostics buffers.")
11228 (defun js2-error-buffer-mode ()
11229 "Major mode for js2 diagnostics buffers.
11230 Selecting an error will jump it to the corresponding source-buffer error.
11231 \\{js2-error-buffer-mode-map}"
11233 (setq major-mode 'js2-error-buffer-mode
11234 mode-name "JS Lint Diagnostics")
11235 (use-local-map js2-error-buffer-mode-map)
11236 (setq truncate-lines t)
11237 (set-buffer-modified-p nil)
11238 (setq buffer-read-only t)
11239 (run-hooks 'js2-error-buffer-mode-hook))
11241 (defun js2-error-buffer-next ()
11242 "Move to next error and view it."
11244 (when (zerop (forward-line 1))
11245 (js2-error-buffer-view)))
11247 (defun js2-error-buffer-prev ()
11248 "Move to previous error and view it."
11250 (when (zerop (forward-line -1))
11251 (js2-error-buffer-view)))
11253 (defun js2-error-buffer-quit ()
11254 "Kill the current buffer."
11258 (defun js2-error-buffer-jump (&rest ignored)
11259 "Jump cursor to current error in source buffer."
11261 (when (js2-error-buffer-view)
11262 (pop-to-buffer js2-source-buffer)))
11264 (defun js2-error-buffer-view ()
11265 "Scroll source buffer to show error at current line."
11268 ((not (eq major-mode 'js2-error-buffer-mode))
11269 (message "Not in a js2 errors buffer"))
11270 ((not (buffer-live-p js2-source-buffer))
11271 (message "Source buffer has been killed"))
11272 ((not (wholenump (get-text-property (point) 'js2-pos)))
11273 (message "There does not seem to be an error here"))
11275 (let ((pos (get-text-property (point) 'js2-pos))
11276 (msg (get-text-property (point) 'js2-msg)))
11277 (save-selected-window
11278 (pop-to-buffer js2-source-buffer)
11283 (define-derived-mode js2-mode js-mode "Javascript-IDE"
11284 "Major mode for editing JavaScript code."
11285 (set (make-local-variable 'max-lisp-eval-depth)
11286 (max max-lisp-eval-depth 3000))
11287 (set (make-local-variable 'indent-line-function) #'js2-indent-line)
11288 (set (make-local-variable 'indent-region-function) #'js2-indent-region)
11289 (set (make-local-variable 'syntax-propertize-function) nil)
11290 (set (make-local-variable 'comment-line-break-function) #'js2-line-break)
11291 (set (make-local-variable 'beginning-of-defun-function) #'js2-beginning-of-defun)
11292 (set (make-local-variable 'end-of-defun-function) #'js2-end-of-defun)
11293 ;; We un-confuse `parse-partial-sexp' by setting syntax-table properties
11294 ;; for characters inside regexp literals.
11295 (set (make-local-variable 'parse-sexp-lookup-properties) t)
11296 ;; this is necessary to make `show-paren-function' work properly
11297 (set (make-local-variable 'parse-sexp-ignore-comments) t)
11298 ;; needed for M-x rgrep, among other things
11299 (put 'js2-mode 'find-tag-default-function #'js2-mode-find-tag)
11301 (setq font-lock-defaults '(nil t))
11303 ;; Experiment: make reparse-delay longer for longer files.
11304 (when (cl-plusp js2-dynamic-idle-timer-adjust)
11305 (setq js2-idle-timer-delay
11306 (* js2-idle-timer-delay
11307 (/ (point-max) js2-dynamic-idle-timer-adjust))))
11309 (add-hook 'change-major-mode-hook #'js2-mode-exit nil t)
11310 (add-hook 'after-change-functions #'js2-mode-edit nil t)
11311 (setq imenu-create-index-function #'js2-mode-create-imenu-index)
11312 (setq next-error-function #'js2-next-error)
11313 (imenu-add-to-menubar (concat "IM-" mode-name))
11314 (add-to-invisibility-spec '(js2-outline . t))
11315 (set (make-local-variable 'line-move-ignore-invisible) t)
11316 (set (make-local-variable 'forward-sexp-function) #'js2-mode-forward-sexp)
11317 (when (fboundp 'cursor-sensor-mode) (cursor-sensor-mode 1))
11319 (setq js2-mode-functions-hidden nil
11320 js2-mode-comments-hidden nil
11321 js2-mode-buffer-dirty-p t
11322 js2-mode-parsing nil)
11324 (js2-set-default-externs)
11326 (when js2-include-jslint-globals
11327 (add-hook 'js2-post-parse-callbacks 'js2-apply-jslint-globals nil t))
11329 (run-hooks 'js2-init-hook)
11333 (defun js2-mode-exit ()
11334 "Exit `js2-mode' and clean up."
11336 (when js2-mode-node-overlay
11337 (delete-overlay js2-mode-node-overlay)
11338 (setq js2-mode-node-overlay nil))
11339 (js2-remove-overlays)
11340 (setq js2-mode-ast nil)
11341 (remove-hook 'change-major-mode-hook #'js2-mode-exit t)
11342 (remove-from-invisibility-spec '(js2-outline . t))
11343 (js2-mode-show-all)
11344 (with-silent-modifications
11345 (js2-clear-face (point-min) (point-max))))
11347 (defun js2-mode-reset-timer ()
11348 "Cancel any existing parse timer and schedule a new one."
11349 (if js2-mode-parse-timer
11350 (cancel-timer js2-mode-parse-timer))
11351 (setq js2-mode-parsing nil)
11352 (let ((timer (timer-create)))
11353 (setq js2-mode-parse-timer timer)
11354 (timer-set-function timer 'js2-mode-idle-reparse (list (current-buffer)))
11355 (timer-set-idle-time timer js2-idle-timer-delay)
11356 ;; http://debbugs.gnu.org/cgi/bugreport.cgi?bug=12326
11357 (timer-activate-when-idle timer nil)))
11359 (defun js2-mode-idle-reparse (buffer)
11360 "Run `js2-reparse' if BUFFER is the current buffer, or schedule
11361 it to be reparsed when the buffer is selected."
11362 (cond ((eq buffer (current-buffer))
11364 ((buffer-live-p buffer)
11365 ;; reparse when the buffer is selected again
11366 (with-current-buffer buffer
11367 (add-hook 'window-configuration-change-hook
11368 #'js2-mode-idle-reparse-inner
11371 (defun js2-mode-idle-reparse-inner ()
11372 (remove-hook 'window-configuration-change-hook
11373 #'js2-mode-idle-reparse-inner
11377 (defun js2-mode-edit (_beg _end _len)
11378 "Schedule a new parse after buffer is edited.
11379 Buffer edit spans from BEG to END and is of length LEN."
11380 (setq js2-mode-buffer-dirty-p t)
11381 (js2-mode-hide-overlay)
11382 (js2-mode-reset-timer))
11384 (defun js2-minor-mode-edit (_beg _end _len)
11385 "Callback for buffer edits in `js2-mode'.
11386 Schedules a new parse after buffer is edited.
11387 Buffer edit spans from BEG to END and is of length LEN."
11388 (setq js2-mode-buffer-dirty-p t)
11389 (js2-mode-hide-overlay)
11390 (js2-mode-reset-timer))
11392 (defun js2-reparse (&optional force)
11393 "Re-parse current buffer after user finishes some data entry.
11394 If we get any user input while parsing, including cursor motion,
11395 we discard the parse and reschedule it. If FORCE is nil, then the
11396 buffer will only rebuild its `js2-mode-ast' if the buffer is dirty."
11399 (js2-compiler-strict-mode js2-mode-show-strict-warnings))
11400 (unless js2-mode-parsing
11401 (setq js2-mode-parsing t)
11403 (when (or js2-mode-buffer-dirty-p force)
11404 (js2-remove-overlays)
11405 (setq js2-mode-buffer-dirty-p nil
11406 js2-mode-fontifications nil
11407 js2-mode-deferred-properties nil)
11408 (if js2-mode-verbose-parse-p
11409 (message "parsing..."))
11412 (setq interrupted-p
11413 (catch 'interrupted
11415 (with-silent-modifications
11416 ;; if parsing is interrupted, comments and regex
11417 ;; literals stay ignored by `parse-partial-sexp'
11418 (remove-text-properties (point-min) (point-max)
11420 (js2-mode-apply-deferred-properties)
11421 (js2-mode-remove-suppressed-warnings)
11422 (js2-mode-show-warnings)
11423 (js2-mode-show-errors)
11424 (if (>= js2-highlight-level 1)
11425 (js2-highlight-jsdoc js2-mode-ast)))
11429 ;; unfinished parse => try again
11430 (setq js2-mode-buffer-dirty-p t)
11431 (js2-mode-reset-timer))
11432 (if js2-mode-verbose-parse-p
11433 (message "Parse time: %s" time))))
11434 (setq js2-mode-parsing nil)
11435 (unless interrupted-p
11436 (setq js2-mode-parse-timer nil))))))
11438 (defun js2-mode-show-node (event)
11439 "Debugging aid: highlight selected AST node on mouse click."
11441 (mouse-set-point event)
11442 (setq deactivate-mark t)
11443 (when js2-mode-show-overlay
11444 (let ((node (js2-node-at-point))
11447 (message "No node found at location %s" (point))
11448 (setq beg (js2-node-abs-pos node)
11449 end (+ beg (js2-node-len node)))
11450 (if js2-mode-node-overlay
11451 (move-overlay js2-mode-node-overlay beg end)
11452 (setq js2-mode-node-overlay (make-overlay beg end))
11453 (overlay-put js2-mode-node-overlay 'font-lock-face 'highlight))
11454 (with-silent-modifications
11455 (if (fboundp 'cursor-sensor-mode)
11456 (put-text-property beg end 'cursor-sensor-functions
11457 '(js2-mode-hide-overlay))
11458 (put-text-property beg end 'point-left #'js2-mode-hide-overlay)))
11459 (message "%s, parent: %s"
11460 (js2-node-short-name node)
11461 (if (js2-node-parent node)
11462 (js2-node-short-name (js2-node-parent node))
11465 (defun js2-mode-hide-overlay (&optional arg1 arg2 _arg3)
11466 "Remove the debugging overlay when point moves.
11467 ARG1, ARG2 and ARG3 have different values depending on whether this function
11468 was found on `point-left' or in `cursor-sensor-functions'."
11469 (when js2-mode-node-overlay
11470 (let ((beg (overlay-start js2-mode-node-overlay))
11471 (end (overlay-end js2-mode-node-overlay))
11472 (p2 (if (windowp arg1)
11473 ;; Called from cursor-sensor-functions.
11474 (window-point arg1)
11475 ;; Called from point-left.
11477 ;; Sometimes we're called spuriously.
11481 (with-silent-modifications
11482 (remove-text-properties beg end
11483 '(point-left nil cursor-sensor-functions)))
11484 (delete-overlay js2-mode-node-overlay)
11485 (setq js2-mode-node-overlay nil)))))
11487 (defun js2-mode-reset ()
11488 "Debugging helper: reset everything."
11493 (defun js2-mode-show-warn-or-err (e face)
11494 "Highlight a warning or error E with FACE.
11495 E is a list of ((MSG-KEY MSG-ARG) BEG LEN OVERRIDE-FACE).
11496 The last element is optional. When present, use instead of FACE."
11497 (let* ((key (cl-first e))
11498 (beg (cl-second e))
11499 (end (+ beg (cl-third e)))
11500 ;; Don't inadvertently go out of bounds.
11501 (beg (max (point-min) (min beg (point-max))))
11502 (end (max (point-min) (min end (point-max))))
11503 (ovl (make-overlay beg end)))
11504 ;; FIXME: Why a mix of overlays and text-properties?
11505 (overlay-put ovl 'font-lock-face (or (cl-fourth e) face))
11506 (overlay-put ovl 'js2-error t)
11507 (put-text-property beg end 'help-echo (js2-get-msg key))
11508 (if (fboundp 'cursor-sensor-mode)
11509 (put-text-property beg end 'cursor-sensor-functions '(js2-echo-error))
11510 (put-text-property beg end 'point-entered #'js2-echo-error))))
11512 (defun js2-remove-overlays ()
11513 "Remove overlays from buffer that have a `js2-error' property."
11514 (let ((beg (point-min))
11517 (dolist (o (overlays-in beg end))
11518 (when (overlay-get o 'js2-error)
11519 (delete-overlay o))))))
11521 (defun js2-mode-apply-deferred-properties ()
11522 "Apply fontifications and other text properties recorded during parsing."
11523 (when (cl-plusp js2-highlight-level)
11524 ;; We defer clearing faces as long as possible to eliminate flashing.
11525 (js2-clear-face (point-min) (point-max))
11526 ;; Have to reverse the recorded fontifications list so that errors
11527 ;; and warnings overwrite the normal fontifications.
11528 (dolist (f (nreverse js2-mode-fontifications))
11529 (put-text-property (cl-first f) (cl-second f) 'font-lock-face (cl-third f)))
11530 (setq js2-mode-fontifications nil))
11531 (dolist (p js2-mode-deferred-properties)
11532 (apply #'put-text-property p))
11533 (setq js2-mode-deferred-properties nil))
11535 (defun js2-mode-show-errors ()
11536 "Highlight syntax errors."
11537 (when js2-mode-show-parse-errors
11538 (dolist (e (js2-ast-root-errors js2-mode-ast))
11539 (js2-mode-show-warn-or-err e 'js2-error))))
11541 (defun js2-mode-remove-suppressed-warnings ()
11542 "Take suppressed warnings out of the AST warnings list.
11543 This ensures that the counts and `next-error' are correct."
11544 (setf (js2-ast-root-warnings js2-mode-ast)
11547 (let ((key (caar e)))
11549 (and (not js2-strict-trailing-comma-warning)
11550 (string-match "trailing\\.comma" key))
11551 (and (not js2-strict-cond-assign-warning)
11552 (string= key "msg.equal.as.assign"))
11553 (and js2-missing-semi-one-line-override
11554 (string= key "msg.missing.semi")
11555 (let* ((beg (cl-second e))
11556 (node (js2-node-at-point beg))
11557 (fn (js2-mode-find-parent-fn node))
11558 (body (and fn (js2-function-node-body fn)))
11559 (lc (and body (js2-node-abs-pos body)))
11560 (rc (and lc (+ lc (js2-node-len body)))))
11565 (and (js2-same-line lc)
11566 (js2-same-line rc))))))))))
11567 (js2-ast-root-warnings js2-mode-ast))))
11569 (defun js2-mode-show-warnings ()
11570 "Highlight strict-mode warnings."
11571 (when js2-mode-show-strict-warnings
11572 (dolist (e (js2-ast-root-warnings js2-mode-ast))
11573 (js2-mode-show-warn-or-err e 'js2-warning))))
11575 (defun js2-echo-error (arg1 arg2 &optional _arg3)
11576 "Called by point-motion hooks.
11577 ARG1, ARG2 and ARG3 have different values depending on whether this function
11578 was found on `point-entered' or in `cursor-sensor-functions'."
11579 (let* ((new-point (if (windowp arg1)
11580 ;; Called from cursor-sensor-functions.
11581 (window-point arg1)
11582 ;; Called from point-left.
11584 (msg (get-text-property new-point 'help-echo)))
11585 (when (and (stringp msg)
11586 (not (active-minibuffer-window))
11587 (not (current-message)))
11590 (defun js2-line-break (&optional _soft)
11591 "Break line at point and indent, continuing comment if within one.
11592 If inside a string, and `js2-concat-multiline-strings' is not
11593 nil, turn it into concatenation."
11595 (let ((parse-status (syntax-ppss)))
11597 ;; Check if we're inside a string.
11598 ((nth 3 parse-status)
11599 (if js2-concat-multiline-strings
11600 (js2-mode-split-string parse-status)
11602 ;; Check if inside a block comment.
11603 ((nth 4 parse-status)
11604 (js2-mode-extend-comment (nth 8 parse-status)))
11606 (newline-and-indent)))))
11608 (defun js2-mode-split-string (parse-status)
11609 "Turn a newline in mid-string into a string concatenation.
11610 PARSE-STATUS is as documented in `parse-partial-sexp'."
11611 (let* ((quote-char (nth 3 parse-status))
11612 (at-eol (eq js2-concat-multiline-strings 'eol)))
11613 (insert quote-char)
11614 (insert (if at-eol " +\n" "\n"))
11618 (insert quote-char)
11620 (insert quote-char)
11621 (backward-char 1))))
11623 (defun js2-mode-extend-comment (start-pos)
11624 "Indent the line and, when inside a comment block, add comment prefix."
11625 (let (star single col first-line needs-close)
11627 (back-to-indentation)
11628 (when (< (point) start-pos)
11629 (goto-char start-pos))
11631 ((looking-at "\\*[^/]")
11633 col (current-column)))
11634 ((looking-at "/\\*")
11637 col (1+ (current-column))))
11640 col (current-column)))))
11641 ;; Heuristic for whether we need to close the comment:
11642 ;; if we've got a parse error here, assume it's an unterminated
11646 (get-char-property (1- (point)) 'js2-error)
11647 ;; The heuristic above doesn't work well when we're
11648 ;; creating a comment and there's another one downstream,
11649 ;; as our parser thinks this one ends at the end of the
11650 ;; next one. (You can have a /* inside a js block comment.)
11651 ;; So just close it if the next non-ws char isn't a *.
11655 (skip-chars-forward " \t\r\n")
11656 (not (eq (char-after) ?*))))))
11657 (delete-horizontal-space)
11663 (if (and first-line needs-close)
11670 (and (zerop (forward-line 1))
11671 (looking-at "\\s-*//"))))
11674 ;; Don't need to extend the comment after all.
11675 (js2-indent-line)))
11677 (defun js2-beginning-of-line ()
11678 "Toggle point between bol and first non-whitespace char in line.
11679 Also moves past comment delimiters when inside comments."
11684 (back-to-indentation))
11686 (skip-chars-forward "/ \t"))
11687 ((and (eq (char-after) ?*)
11688 (setq node (js2-comment-at-point))
11689 (memq (js2-comment-node-format node) '(jsdoc block))
11691 (skip-chars-backward " \t")
11693 (skip-chars-forward "\* \t"))
11695 (goto-char (point-at-bol))))))
11697 (defun js2-end-of-line ()
11698 "Toggle point between eol and last non-whitespace char in line."
11701 (skip-chars-backward " \t")
11702 (goto-char (point-at-eol))))
11704 (defun js2-mode-wait-for-parse (callback)
11705 "Invoke CALLBACK when parsing is finished.
11706 If parsing is already finished, calls CALLBACK immediately."
11707 (if (not js2-mode-buffer-dirty-p)
11709 (push callback js2-mode-pending-parse-callbacks)
11710 (add-hook 'js2-parse-finished-hook #'js2-mode-parse-finished)))
11712 (defun js2-mode-parse-finished ()
11713 "Invoke callbacks in `js2-mode-pending-parse-callbacks'."
11714 ;; We can't let errors propagate up, since it prevents the
11715 ;; `js2-parse' method from completing normally and returning
11716 ;; the ast, which makes things mysteriously not work right.
11718 (dolist (cb js2-mode-pending-parse-callbacks)
11719 (condition-case err
11721 (error (message "%s" err))))
11722 (setq js2-mode-pending-parse-callbacks nil)))
11724 (defun js2-mode-flag-region (from to flag)
11725 "Hide or show text from FROM to TO, according to FLAG.
11726 If FLAG is nil then text is shown, while if FLAG is t the text is hidden.
11727 Returns the created overlay if FLAG is non-nil."
11728 (remove-overlays from to 'invisible 'js2-outline)
11730 (let ((o (make-overlay from to)))
11731 (overlay-put o 'invisible 'js2-outline)
11732 (overlay-put o 'isearch-open-invisible
11733 'js2-isearch-open-invisible)
11736 ;; Function to be set as an outline-isearch-open-invisible' property
11737 ;; to the overlay that makes the outline invisible (see
11738 ;; `js2-mode-flag-region').
11739 (defun js2-isearch-open-invisible (_overlay)
11740 ;; We rely on the fact that isearch places point on the matched text.
11741 (js2-mode-show-element))
11743 (defun js2-mode-invisible-overlay-bounds (&optional pos)
11744 "Return cons cell of bounds of folding overlay at POS.
11745 Returns nil if not found."
11746 (let ((overlays (overlays-at (or pos (point))))
11748 (while (and overlays
11750 (if (overlay-get (car overlays) 'invisible)
11751 (setq o (car overlays))
11752 (setq overlays (cdr overlays))))
11754 (cons (overlay-start o) (overlay-end o)))))
11756 (defun js2-mode-function-at-point (&optional pos)
11757 "Return the innermost function node enclosing current point.
11758 Returns nil if point is not in a function."
11759 (let ((node (js2-node-at-point pos)))
11760 (while (and node (not (js2-function-node-p node)))
11761 (setq node (js2-node-parent node)))
11762 (if (js2-function-node-p node)
11765 (defun js2-mode-toggle-element ()
11766 "Hide or show the foldable element at the point."
11768 (let (comment fn pos)
11771 ;; /* ... */ comment?
11772 ((js2-block-comment-p (setq comment (js2-comment-at-point)))
11773 (if (js2-mode-invisible-overlay-bounds
11774 (setq pos (+ 3 (js2-node-abs-pos comment))))
11777 (js2-mode-show-element))
11778 (js2-mode-hide-element)))
11781 (back-to-indentation)
11782 (looking-at js2-mode-//-comment-re))
11783 (js2-mode-toggle-//-comment))
11785 ((setq fn (js2-mode-function-at-point))
11786 (setq pos (and (js2-function-node-body fn)
11787 (js2-node-abs-pos (js2-function-node-body fn))))
11788 (goto-char (1+ pos))
11789 (if (js2-mode-invisible-overlay-bounds)
11790 (js2-mode-show-element)
11791 (js2-mode-hide-element)))
11793 (message "Nothing at point to hide or show"))))))
11795 (defun js2-mode-hide-element ()
11796 "Fold/hide contents of a block, showing ellipses.
11797 Show the hidden text with \\[js2-mode-show-element]."
11799 (if js2-mode-buffer-dirty-p
11800 (js2-mode-wait-for-parse #'js2-mode-hide-element))
11801 (let (node body beg end)
11803 ((js2-mode-invisible-overlay-bounds)
11804 (message "already hidden"))
11806 (setq node (js2-node-at-point))
11808 ((js2-block-comment-p node)
11809 (js2-mode-hide-comment node))
11811 (while (and node (not (js2-function-node-p node)))
11812 (setq node (js2-node-parent node)))
11814 (setq body (js2-function-node-body node)))
11816 (setq beg (js2-node-abs-pos body)
11817 end (+ beg (js2-node-len body)))
11818 (js2-mode-flag-region (1+ beg) (1- end) 'hide))
11819 (message "No collapsable element found at point"))))))))
11821 (defun js2-mode-show-element ()
11822 "Show the hidden element at current point."
11824 (let ((bounds (js2-mode-invisible-overlay-bounds)))
11826 (js2-mode-flag-region (car bounds) (cdr bounds) nil)
11827 (message "Nothing to un-hide"))))
11829 (defun js2-mode-show-all ()
11830 "Show all of the text in the buffer."
11832 (js2-mode-flag-region (point-min) (point-max) nil))
11834 (defun js2-mode-toggle-hide-functions ()
11836 (if js2-mode-functions-hidden
11837 (js2-mode-show-functions)
11838 (js2-mode-hide-functions)))
11840 (defun js2-mode-hide-functions ()
11841 "Hides all non-nested function bodies in the buffer.
11842 Use \\[js2-mode-show-all] to reveal them, or \\[js2-mode-show-element]
11843 to open an individual entry."
11845 (if js2-mode-buffer-dirty-p
11846 (js2-mode-wait-for-parse #'js2-mode-hide-functions))
11847 (if (null js2-mode-ast)
11848 (message "Oops - parsing failed")
11849 (setq js2-mode-functions-hidden t)
11850 (js2-visit-ast js2-mode-ast #'js2-mode-function-hider)))
11852 (defun js2-mode-function-hider (n endp)
11854 (let ((tt (js2-node-type n))
11857 ((and (= tt js2-FUNCTION)
11858 (setq body (js2-function-node-body n)))
11859 (setq beg (js2-node-abs-pos body)
11860 end (+ beg (js2-node-len body)))
11861 (js2-mode-flag-region (1+ beg) (1- end) 'hide)
11862 nil) ; don't process children of function
11864 t))))) ; keep processing other AST nodes
11866 (defun js2-mode-show-functions ()
11867 "Un-hide any folded function bodies in the buffer."
11869 (setq js2-mode-functions-hidden nil)
11871 (goto-char (point-min))
11872 (while (/= (goto-char (next-overlay-change (point)))
11874 (dolist (o (overlays-at (point)))
11875 (when (and (overlay-get o 'invisible)
11876 (not (overlay-get o 'comment)))
11877 (js2-mode-flag-region (overlay-start o) (overlay-end o) nil))))))
11879 (defun js2-mode-hide-comment (n)
11880 (let* ((head (if (eq (js2-comment-node-format n) 'jsdoc)
11883 (beg (+ (js2-node-abs-pos n) head))
11884 (end (- (+ beg (js2-node-len n)) head 2))
11885 (o (js2-mode-flag-region beg end 'hide)))
11886 (overlay-put o 'comment t)))
11888 (defun js2-mode-toggle-hide-comments ()
11889 "Folds all block comments in the buffer.
11890 Use \\[js2-mode-show-all] to reveal them, or \\[js2-mode-show-element]
11891 to open an individual entry."
11893 (if js2-mode-comments-hidden
11894 (js2-mode-show-comments)
11895 (js2-mode-hide-comments)))
11897 (defun js2-mode-hide-comments ()
11899 (if js2-mode-buffer-dirty-p
11900 (js2-mode-wait-for-parse #'js2-mode-hide-comments))
11901 (if (null js2-mode-ast)
11902 (message "Oops - parsing failed")
11903 (setq js2-mode-comments-hidden t)
11904 (dolist (n (js2-ast-root-comments js2-mode-ast))
11905 (when (js2-block-comment-p n)
11906 (js2-mode-hide-comment n)))
11907 (js2-mode-hide-//-comments)))
11909 (defun js2-mode-extend-//-comment (direction)
11910 "Find start or end of a block of similar //-comment lines.
11911 DIRECTION is -1 to look back, 1 to look forward.
11912 INDENT is the indentation level to match.
11913 Returns the end-of-line position of the furthest adjacent
11914 //-comment line with the same indentation as the current line.
11915 If there is no such matching line, returns current end of line."
11916 (let ((pos (point-at-eol))
11917 (indent (current-indentation)))
11919 (while (and (zerop (forward-line direction))
11920 (looking-at js2-mode-//-comment-re)
11921 (eq indent (length (match-string 1))))
11922 (setq pos (point-at-eol)))
11925 (defun js2-mode-hide-//-comments ()
11926 "Fold adjacent 1-line comments, showing only snippet of first one."
11929 (goto-char (point-min))
11930 (while (re-search-forward js2-mode-//-comment-re nil t)
11932 end (js2-mode-extend-//-comment 1))
11933 (unless (eq beg end)
11934 (overlay-put (js2-mode-flag-region beg end 'hide)
11937 (forward-char 1)))))
11939 (defun js2-mode-toggle-//-comment ()
11940 "Fold or un-fold any multi-line //-comment at point.
11941 Caller should have determined that this line starts with a //-comment."
11942 (let* ((beg (point-at-eol))
11946 (if (js2-mode-invisible-overlay-bounds)
11947 (js2-mode-show-element)
11948 ;; else hide the comment
11949 (setq beg (js2-mode-extend-//-comment -1)
11950 end (js2-mode-extend-//-comment 1))
11951 (unless (eq beg end)
11952 (overlay-put (js2-mode-flag-region beg end 'hide)
11955 (defun js2-mode-show-comments ()
11956 "Un-hide any hidden comments, leaving other hidden elements alone."
11958 (setq js2-mode-comments-hidden nil)
11960 (goto-char (point-min))
11961 (while (/= (goto-char (next-overlay-change (point)))
11963 (dolist (o (overlays-at (point)))
11964 (when (overlay-get o 'comment)
11965 (js2-mode-flag-region (overlay-start o) (overlay-end o) nil))))))
11967 (defun js2-mode-display-warnings-and-errors ()
11968 "Turn on display of warnings and errors."
11970 (setq js2-mode-show-parse-errors t
11971 js2-mode-show-strict-warnings t)
11972 (js2-reparse 'force))
11974 (defun js2-mode-hide-warnings-and-errors ()
11975 "Turn off display of warnings and errors."
11977 (setq js2-mode-show-parse-errors nil
11978 js2-mode-show-strict-warnings nil)
11979 (js2-reparse 'force))
11981 (defun js2-mode-toggle-warnings-and-errors ()
11982 "Toggle the display of warnings and errors.
11983 Some users don't like having warnings/errors reported while they type."
11985 (setq js2-mode-show-parse-errors (not js2-mode-show-parse-errors)
11986 js2-mode-show-strict-warnings (not js2-mode-show-strict-warnings))
11987 (if (called-interactively-p 'any)
11988 (message "warnings and errors %s"
11989 (if js2-mode-show-parse-errors
11992 (js2-reparse 'force))
11994 (defun js2-mode-customize ()
11996 (customize-group 'js2-mode))
11998 (defun js2-mode-forward-sexp (&optional arg)
11999 "Move forward across one statement or balanced expression.
12000 With ARG, do it that many times. Negative arg -N means
12001 move backward across N balanced expressions."
12003 (setq arg (or arg 1))
12005 (widen) ;; `blink-matching-open' calls `narrow-to-region'
12007 (let (forward-sexp-function
12008 node (start (point)) pos lp rp child)
12011 ;; could probably make this better for some cases:
12012 ;; - if in statement block (e.g. function body), go to parent
12013 ;; - infix exprs like (foo in bar) - maybe go to beginning
12014 ;; of infix expr if in the right-side expression?
12015 ((and arg (cl-minusp arg))
12016 (dotimes (_ (- arg))
12018 (forward-char -1) ; Enter the node we backed up to.
12019 (when (setq node (js2-node-at-point (point) t))
12020 (setq pos (js2-node-abs-pos node))
12021 (let ((parens (js2-mode-forward-sexp-parens node pos)))
12022 (setq lp (car parens)
12024 (when (and lp (> start lp))
12025 (if (and rp (<= start rp))
12026 ;; Between parens, check if there's a child node we can jump.
12027 (when (setq child (js2-node-closest-child node (point) lp t))
12028 (setq pos (js2-node-abs-pos child)))
12029 ;; Before both parens.
12031 (let ((state (parse-partial-sexp start pos)))
12032 (goto-char (if (not (zerop (car state)))
12033 ;; Stumble at the unbalanced paren if < 0, or
12034 ;; jump a bit further if > 0.
12035 (scan-sexps start -1)
12037 (unless pos (goto-char (point-min)))))
12042 (when (setq node (js2-node-at-point (point) t))
12043 (setq pos (js2-node-abs-pos node))
12044 (let ((parens (js2-mode-forward-sexp-parens node pos)))
12045 (setq lp (car parens)
12048 (when (and rp (<= start rp))
12050 (when (setq child (js2-node-closest-child node (point) rp))
12051 (setq pos (js2-node-abs-end child)))
12052 (setq pos (1+ rp))))
12053 ;; No parens or child nodes, looks for the end of the current node.
12054 (cl-incf pos (js2-node-len
12055 (if (js2-expr-stmt-node-p (js2-node-parent node))
12056 ;; Stop after the semicolon.
12057 (js2-node-parent node)
12059 (let ((state (save-excursion (parse-partial-sexp start pos))))
12060 (goto-char (if (not (zerop (car state)))
12061 (scan-sexps start 1)
12063 (unless pos (goto-char (point-max)))))))))
12065 (defun js2-mode-forward-sexp-parens (node abs-pos)
12066 "Return a cons cell with positions of main parens in NODE."
12068 ((or (js2-array-node-p node)
12069 (js2-object-node-p node)
12070 (js2-comp-node-p node)
12071 (memq (aref node 0) '(cl-struct-js2-block-node cl-struct-js2-scope)))
12072 (cons abs-pos (+ abs-pos (js2-node-len node) -1)))
12073 ((js2-paren-expr-node-p node)
12074 (let ((lp (js2-node-lp node))
12075 (rp (js2-node-rp node)))
12076 (cons (when lp (+ abs-pos lp))
12077 (when rp (+ abs-pos rp)))))))
12079 (defun js2-node-closest-child (parent point limit &optional before)
12080 (let* ((parent-pos (js2-node-abs-pos parent))
12081 (rpoint (- point parent-pos))
12082 (rlimit (- limit parent-pos))
12083 (min (min rpoint rlimit))
12084 (max (max rpoint rlimit))
12089 (lambda (node _end-p)
12090 (if (eq node parent)
12092 (let ((pos (js2-node-pos node)) ;; Both relative values.
12093 (end (+ (js2-node-pos node) (js2-node-len node))))
12094 (when (and (>= pos min) (<= end max)
12095 (if before (< pos rpoint) (> end rpoint)))
12097 (when (> end rpoint)
12098 (throw 'done nil)))
12102 (defun js2-errors ()
12103 "Return a list of errors found."
12105 (js2-ast-root-errors js2-mode-ast)))
12107 (defun js2-warnings ()
12108 "Return a list of warnings found."
12110 (js2-ast-root-warnings js2-mode-ast)))
12112 (defun js2-have-errors-p ()
12113 "Return non-nil if any parse errors or warnings were found."
12114 (or (js2-errors) (js2-warnings)))
12116 (defun js2-errors-and-warnings ()
12117 "Return a copy of the concatenated errors and warnings lists.
12118 They are appended: first the errors, then the warnings.
12119 Entries are of the form (MSG BEG END)."
12121 (append (js2-ast-root-errors js2-mode-ast)
12122 (copy-sequence (js2-ast-root-warnings js2-mode-ast)))))
12124 (defun js2-next-error (&optional arg reset)
12125 "Move to next parse error.
12126 Typically invoked via \\[next-error].
12127 ARG is the number of errors, forward or backward, to move.
12128 RESET means start over from the beginning."
12130 (if (not (or (js2-errors) (js2-warnings)))
12131 (message "No errors")
12133 (goto-char (point-min)))
12134 (let* ((errs (js2-errors-and-warnings))
12138 (backward (cl-minusp count))
12139 (sorter (if backward '> '<))
12140 (stopper (if backward '< '>))
12141 (count (abs count))
12143 ;; Sort by start position.
12144 (setq errs (sort errs (lambda (e1 e2)
12145 (funcall sorter (cl-second e1) (cl-second e2))))
12147 ;; Find nth error with pos > start.
12148 (while (and errs continue)
12149 (when (funcall stopper (cl-cadar errs) start)
12150 (setq err (car errs))
12151 (if (zerop (cl-decf count))
12152 (setq continue nil)))
12153 (setq errs (cdr errs)))
12154 ;; Clear for `js2-echo-error'.
12157 (goto-char (cl-second err))
12158 ;; Wrap around to first error.
12159 (goto-char (cl-second (car all-errs)))
12160 ;; If we were already on it, echo msg again.
12161 (if (= (point) start)
12162 (js2-echo-error (point) (point)))))))
12164 (defun js2-down-mouse-3 ()
12165 "Make right-click move the point to the click location.
12166 This makes right-click context menu operations a bit more intuitive.
12167 The point will not move if the region is active, however, to avoid
12168 destroying the region selection."
12170 (when (and js2-move-point-on-right-click
12172 (let ((e last-input-event))
12174 (goto-char (cl-cadadr e))))))
12176 (defun js2-mode-create-imenu-index ()
12177 "Return an alist for `imenu--index-alist'."
12178 ;; This is built up in `js2-parse-record-imenu' during parsing.
12180 ;; if we have an ast but no recorder, they're requesting a rescan
12181 (unless js2-imenu-recorder
12182 (js2-reparse 'force))
12184 (js2-build-imenu-index)
12185 (setq js2-imenu-recorder nil
12186 js2-imenu-function-map nil))))
12188 (defun js2-mode-find-tag ()
12189 "Replacement for `find-tag-default'.
12190 `find-tag-default' returns a ridiculous answer inside comments."
12193 (if (looking-at "\\_>")
12194 (setq beg (progn (forward-symbol -1) (point))
12195 end (progn (forward-symbol 1) (point)))
12196 (setq beg (progn (forward-symbol 1) (point))
12197 end (progn (forward-symbol -1) (point))))
12198 (replace-regexp-in-string
12200 (buffer-substring-no-properties beg end)))))
12202 (defun js2-mode-forward-sibling ()
12203 "Move to the end of the sibling following point in parent.
12204 Returns non-nil if successful, or nil if there was no following sibling."
12205 (let* ((node (js2-node-at-point))
12206 (parent (js2-mode-find-enclosing-fn node))
12208 (when (setq sib (js2-node-find-child-after (point) parent))
12209 (goto-char (+ (js2-node-abs-pos sib)
12210 (js2-node-len sib))))))
12212 (defun js2-mode-backward-sibling ()
12213 "Move to the beginning of the sibling node preceding point in parent.
12214 Parent is defined as the enclosing script or function."
12215 (let* ((node (js2-node-at-point))
12216 (parent (js2-mode-find-enclosing-fn node))
12218 (when (setq sib (js2-node-find-child-before (point) parent))
12219 (goto-char (js2-node-abs-pos sib)))))
12221 (defun js2-beginning-of-defun (&optional arg)
12222 "Go to line on which current function starts, and return t on success.
12223 If we're not in a function or already at the beginning of one, go
12224 to beginning of previous script-level element.
12225 With ARG N, do that N times. If N is negative, move forward."
12226 (setq arg (or arg 1))
12228 (let ((parent (js2-node-parent-script-or-fn (js2-node-at-point))))
12230 ((js2-function-node-p parent)
12231 (goto-char (js2-node-abs-pos parent)))
12233 (js2-mode-backward-sibling)))
12235 (js2-beginning-of-defun (1- arg))
12237 (when (js2-end-of-defun)
12238 (js2-beginning-of-defun (if (>= arg -1) 1 (1+ arg))))))
12240 (defun js2-end-of-defun ()
12241 "Go to the char after the last position of the current function
12242 or script-level element."
12243 (let* ((node (js2-node-at-point))
12244 (parent (or (and (js2-function-node-p node) node)
12245 (js2-node-parent-script-or-fn node)))
12247 (unless (js2-function-node-p parent)
12248 ;; Use current script-level node, or, if none, the next one.
12249 (setq script (or parent node)
12250 parent (js2-node-find-child-before (point) script))
12251 (when (or (null parent)
12252 (>= (point) (+ (js2-node-abs-pos parent)
12253 (js2-node-len parent))))
12254 (setq parent (js2-node-find-child-after (point) script))))
12256 (goto-char (+ (js2-node-abs-pos parent)
12257 (js2-node-len parent))))))
12259 (defun js2-mark-defun (&optional allow-extend)
12260 "Put mark at end of this function, point at beginning.
12261 The function marked is the one that contains point.
12263 Interactively, if this command is repeated,
12264 or (in Transient Mark mode) if the mark is active,
12265 it marks the next defun after the ones already marked."
12268 (when (and allow-extend
12269 (or (and (eq last-command this-command) (mark t))
12270 (and transient-mark-mode mark-active)))
12271 (let ((sib (save-excursion
12273 (if (js2-mode-forward-sibling)
12279 ;; no more siblings - try extending to enclosing node
12280 (goto-char (mark t)))))
12281 (when (not extended)
12282 (let ((node (js2-node-at-point (point) t)) ; skip comments
12283 ast fn stmt parent beg end)
12284 (when (js2-ast-root-p node)
12286 node (or (js2-node-find-child-after (point) node)
12287 (js2-node-find-child-before (point) node))))
12288 ;; only mark whole buffer if we can't find any children
12291 (if (js2-function-node-p node)
12293 (setq fn (js2-mode-find-enclosing-fn node)
12294 stmt (if (or (null fn)
12295 (js2-ast-root-p fn))
12296 (js2-mode-find-first-stmt node))
12297 parent (or stmt fn)))
12298 (setq beg (js2-node-abs-pos parent)
12299 end (+ beg (js2-node-len parent)))
12302 (exchange-point-and-mark)))))
12304 (defun js2-narrow-to-defun ()
12305 "Narrow to the function enclosing point."
12307 (let* ((node (js2-node-at-point (point) t)) ; skip comments
12308 (fn (if (js2-script-node-p node)
12310 (js2-mode-find-enclosing-fn node)))
12311 (beg (js2-node-abs-pos fn)))
12312 (unless (js2-ast-root-p fn)
12313 (narrow-to-region beg (+ beg (js2-node-len fn))))))
12315 (defun js2-jump-to-definition (&optional arg)
12316 "Jump to the definition of an object's property, variable or function."
12318 (ring-insert find-tag-marker-ring (point-marker))
12319 (let* ((node (js2-node-at-point))
12320 (parent (js2-node-parent node))
12321 (names (if (js2-prop-get-node-p parent)
12322 (reverse (let ((temp (js2-compute-nested-prop-get parent)))
12323 (cl-loop for n in temp
12326 until (equal node n)
12327 finally return result)))))
12329 (unless (and (js2-name-node-p node)
12330 (not (js2-var-init-node-p parent))
12331 (not (js2-function-node-p parent)))
12332 (error "Node is not a supported jump node"))
12333 (push (or (and names (pop names))
12334 (unless (and (js2-object-prop-node-p parent)
12335 (eq node (js2-object-prop-node-left parent)))
12337 (setq node-init (js2-search-scope node names))
12339 ;; todo: display list of results in buffer
12340 ;; todo: group found references by buffer
12346 (with-current-buffer b
12347 (when (derived-mode-p 'js2-mode)
12348 (setq node-init (js2-search-scope js2-mode-ast names))
12350 (throw 'found b)))))
12353 (setq node-init (if (listp node-init) (car node-init) node-init))
12356 (error "No jump location found"))
12357 (goto-char (js2-node-abs-pos node-init))))
12359 (defun js2-search-object (node name-node)
12360 "Check if object NODE contains element with NAME-NODE."
12361 (cl-assert (js2-object-node-p node))
12362 ;; Only support name-node and nodes for the time being
12363 (cl-loop for elem in (js2-object-node-elems node)
12364 for left = (js2-object-prop-node-left elem)
12365 if (or (and (js2-name-node-p left)
12366 (equal (js2-name-node-name name-node)
12367 (js2-name-node-name left)))
12368 (and (js2-string-node-p left)
12369 (string= (js2-name-node-name name-node)
12370 (js2-string-node-value left))))
12373 (defun js2-search-object-for-prop (object prop-names)
12374 "Return node in OBJECT that matches PROP-NAMES or nil.
12375 PROP-NAMES is a list of values representing a path to a value in OBJECT.
12376 i.e. ('name' 'value') = {name : { value: 3}}"
12378 (temp-object object)
12379 (temp t) ;temporay node
12380 (names prop-names))
12381 (while (and temp names (js2-object-node-p temp-object))
12382 (setq temp (js2-search-object temp-object (pop names)))
12383 (and (setq node temp)
12384 (setq temp-object (js2-object-prop-node-right temp))))
12385 (unless names node)))
12387 (defun js2-search-scope (node names)
12388 "Searches NODE scope for jump location matching NAMES.
12389 NAMES is a list of property values to search for. For functions
12390 and variables NAMES will contain one element."
12392 (val (js2-name-node-name (car names))))
12393 (setq node-init (js2-get-symbol-declaration node val))
12395 (when (> (length names) 1)
12397 ;; Check var declarations
12398 (when (and node-init (string= val (js2-name-node-name node-init)))
12399 (let ((parent (js2-node-parent node-init))
12400 (temp-names names))
12401 (pop temp-names) ;; First element is var name
12402 (setq node-init (when (js2-var-init-node-p parent)
12403 (js2-search-object-for-prop
12404 (js2-var-init-node-initializer parent)
12407 ;; Check all assign nodes
12410 (lambda (node endp)
12412 (if (js2-assign-node-p node)
12413 (let ((left (js2-assign-node-left node))
12414 (right (js2-assign-node-right node))
12415 (temp-names names))
12416 (when (js2-prop-get-node-p left)
12417 (let* ((prop-list (js2-compute-nested-prop-get left))
12418 (found (cl-loop for prop in prop-list
12419 until (not (string= (js2-name-node-name
12421 (js2-name-node-name prop)))
12422 if (not temp-names) return prop))
12423 (found-node (or found
12424 (when (js2-object-node-p right)
12425 (js2-search-object-for-prop right
12427 (if found-node (push found-node node-init))))))
12431 (defun js2-get-symbol-declaration (node name)
12432 "Find scope for NAME from NODE."
12433 (let ((scope (js2-get-defining-scope
12434 (or (js2-node-get-enclosing-scope node)
12436 (if scope (js2-symbol-ast-node (js2-scope-get-symbol scope name)))))
12438 (provide 'js2-mode)
12440 ;;; js2-mode.el ends here