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 ;; Support for JSX is available via the derived mode `js2-jsx-mode'. If you
64 ;; also want JSX support, use that mode instead:
66 ;; (add-to-list 'auto-mode-alist '("\\.jsx?\\'" . js2-jsx-mode))
67 ;; (add-to-list 'interpreter-mode-alist '("node" . js2-jsx-mode))
69 ;; To customize how it works:
70 ;; M-x customize-group RET js2-mode RET
74 ;; This mode includes a port of Mozilla Rhino's scanner, parser and
75 ;; symbol table. Ideally it should stay in sync with Rhino, keeping
76 ;; `js2-mode' current as the EcmaScript language standard evolves.
78 ;; Unlike cc-engine based language modes, js2-mode's line-indentation is not
79 ;; customizable. It is a surprising amount of work to support customizable
80 ;; indentation. The current compromise is that the tab key lets you cycle among
81 ;; various likely indentation points, similar to the behavior of python-mode.
83 ;; This mode does not yet work with "multi-mode" modes such as `mmm-mode'
84 ;; and `mumamo', although it could be made to do so with some effort.
85 ;; This means that `js2-mode' is currently only useful for editing JavaScript
86 ;; files, and not for editing JavaScript within <script> tags or templates.
88 ;; The project page on GitHub is used for development and issue tracking.
89 ;; The original homepage at Google Code has outdated information and is mostly
100 (if (version< emacs-version "25.0")
101 (require 'js2-old-indent)
102 (defvaralias 'js2-basic-offset 'js-indent-level nil)
103 (defalias 'js2-proper-indentation 'js--proper-indentation)
104 (defalias 'js2-jsx-indent-line 'js-jsx-indent-line)
105 (defalias 'js2-indent-line 'js-indent-line)
106 (defalias 'js2-re-search-forward 'js--re-search-forward)))
108 ;;; Externs (variables presumed to be defined by the host system)
110 (defvar js2-ecma-262-externs
112 '(Array Boolean Date Error EvalError Function Infinity JSON
113 Math NaN Number Object RangeError ReferenceError RegExp
114 String SyntaxError TypeError URIError
115 decodeURI decodeURIComponent encodeURI
116 encodeURIComponent escape eval isFinite isNaN
117 parseFloat parseInt undefined unescape))
118 "Ecma-262 externs. Included in `js2-externs' by default.")
120 (defvar js2-browser-externs
123 Attr CDATASection CharacterData Comment DOMException
124 DOMImplementation Document DocumentFragment
125 DocumentType Element Entity EntityReference
126 ExceptionCode NamedNodeMap Node NodeList Notation
127 ProcessingInstruction Text
130 HTMLAnchorElement HTMLAppletElement HTMLAreaElement
131 HTMLBRElement HTMLBaseElement HTMLBaseFontElement
132 HTMLBodyElement HTMLButtonElement HTMLCollection
133 HTMLDListElement HTMLDirectoryElement HTMLDivElement
134 HTMLDocument HTMLElement HTMLFieldSetElement
135 HTMLFontElement HTMLFormElement HTMLFrameElement
136 HTMLFrameSetElement HTMLHRElement HTMLHeadElement
137 HTMLHeadingElement HTMLHtmlElement HTMLIFrameElement
138 HTMLImageElement HTMLInputElement HTMLIsIndexElement
139 HTMLLIElement HTMLLabelElement HTMLLegendElement
140 HTMLLinkElement HTMLMapElement HTMLMenuElement
141 HTMLMetaElement HTMLModElement HTMLOListElement
142 HTMLObjectElement HTMLOptGroupElement
143 HTMLOptionElement HTMLOptionsCollection
144 HTMLParagraphElement HTMLParamElement HTMLPreElement
145 HTMLQuoteElement HTMLScriptElement HTMLSelectElement
146 HTMLStyleElement HTMLTableCaptionElement
147 HTMLTableCellElement HTMLTableColElement
148 HTMLTableElement HTMLTableRowElement
149 HTMLTableSectionElement HTMLTextAreaElement
150 HTMLTitleElement HTMLUListElement
153 DOMConfiguration DOMError DOMException
154 DOMImplementationList DOMImplementationSource
155 DOMLocator DOMStringList NameList TypeInfo
159 window alert confirm document java navigator prompt screen
160 self top requestAnimationFrame cancelAnimationFrame
163 CSSCharsetRule CSSFontFace CSSFontFaceRule
164 CSSImportRule CSSMediaRule CSSPageRule
165 CSSPrimitiveValue CSSProperties CSSRule CSSRuleList
166 CSSStyleDeclaration CSSStyleRule CSSStyleSheet
167 CSSValue CSSValueList Counter DOMImplementationCSS
168 DocumentCSS DocumentStyle ElementCSSInlineStyle
169 LinkStyle MediaList RGBColor Rect StyleSheet
170 StyleSheetList ViewCSS
173 EventListener EventTarget Event DocumentEvent UIEvent
174 MouseEvent MutationEvent KeyboardEvent
177 DocumentRange Range RangeException
180 XPathResult XMLHttpRequest
182 ;; console object. Provided by at least Chrome and Firefox.
185 You can cause these to be included or excluded with the custom
186 variable `js2-include-browser-externs'.")
188 (defvar js2-rhino-externs
190 '(Packages importClass importPackage com org java
191 ;; Global object (shell) externs.
192 defineClass deserialize doctest gc help load
193 loadClass print quit readFile readUrl runCommand seal
194 serialize spawn sync toint32 version))
195 "Mozilla Rhino externs.
196 Set `js2-include-rhino-externs' to t to include them.")
198 (defvar js2-node-externs
200 '(__dirname __filename Buffer clearInterval clearTimeout require
201 console exports global module process setInterval setTimeout
202 querystring setImmediate clearImmediate))
204 Set `js2-include-node-externs' to t to include them.")
206 (defvar js2-typed-array-externs
208 '(ArrayBuffer Uint8ClampedArray DataView
209 Int8Array Uint8Array Int16Array Uint16Array Int32Array Uint32Array
210 Float32Array Float64Array))
211 "Khronos typed array externs. Available in most modern browsers and
212 in node.js >= 0.6. If `js2-include-node-externs' or `js2-include-browser-externs'
213 are enabled, these will also be included.")
215 (defvar js2-harmony-externs
217 '(Map Promise Proxy Reflect Set Symbol WeakMap WeakSet))
218 "ES6 externs. If `js2-include-browser-externs' is enabled and
219 `js2-language-version' is sufficiently high, these will be included.")
223 (defun js2-mark-safe-local (name pred)
224 "Make the variable NAME buffer-local and mark it as safe file-local
225 variable with predicate PRED."
226 (make-variable-buffer-local name)
227 (put name 'safe-local-variable pred))
229 (defcustom js2-highlight-level 2
230 "Amount of syntax highlighting to perform.
231 0 or a negative value means none.
232 1 adds basic syntax highlighting.
233 2 adds highlighting of some Ecma built-in properties.
234 3 adds highlighting of many Ecma built-in functions."
236 :type '(choice (const :tag "None" 0)
237 (const :tag "Basic" 1)
238 (const :tag "Include Properties" 2)
239 (const :tag "Include Functions" 3)))
241 (defvar js2-mode-dev-mode-p nil
242 "Non-nil if running in development mode. Normally nil.")
244 (defgroup js2-mode nil
245 "An improved JavaScript mode."
248 (defcustom js2-idle-timer-delay 0.2
249 "Delay in secs before re-parsing after user makes changes.
250 Multiplied by `js2-dynamic-idle-timer-adjust', which see."
253 (make-variable-buffer-local 'js2-idle-timer-delay)
255 (defcustom js2-dynamic-idle-timer-adjust 0
256 "Positive to adjust `js2-idle-timer-delay' based on file size.
257 The idea is that for short files, parsing is faster so we can be
258 more responsive to user edits without interfering with editing.
259 The buffer length in characters (typically bytes) is divided by
260 this value and used to multiply `js2-idle-timer-delay' for the
261 buffer. For example, a 21k file and 10k adjust yields 21k/10k
262 == 2, so js2-idle-timer-delay is multiplied by 2.
263 If `js2-dynamic-idle-timer-adjust' is 0 or negative,
264 `js2-idle-timer-delay' is not dependent on the file size."
268 (defcustom js2-concat-multiline-strings t
269 "When non-nil, `js2-line-break' in mid-string will make it a
270 string concatenation. When `eol', the '+' will be inserted at the
271 end of the line, otherwise, at the beginning of the next line."
272 :type '(choice (const t) (const eol) (const nil))
275 (defcustom js2-mode-show-parse-errors t
276 "True to highlight parse errors."
280 (defcustom js2-mode-show-strict-warnings t
281 "Non-nil to emit Ecma strict-mode warnings.
282 Some of the warnings can be individually disabled by other flags,
283 even if this flag is non-nil."
287 (defcustom js2-strict-trailing-comma-warning t
288 "Non-nil to warn about trailing commas in array literals.
289 Ecma-262-5.1 allows them, but older versions of IE raise an error."
293 (defcustom js2-strict-missing-semi-warning t
294 "Non-nil to warn about semicolon auto-insertion after statement.
295 Technically this is legal per Ecma-262, but some style guides disallow
300 (defcustom js2-missing-semi-one-line-override nil
301 "Non-nil to permit missing semicolons in one-line functions.
302 In one-liner functions such as `function identity(x) {return x}'
303 people often omit the semicolon for a cleaner look. If you are
304 such a person, you can suppress the missing-semicolon warning
305 by setting this variable to t."
309 (defcustom js2-strict-inconsistent-return-warning t
310 "Non-nil to warn about mixing returns with value-returns.
311 It's perfectly legal to have a `return' and a `return foo' in the
312 same function, but it's often an indicator of a bug, and it also
313 interferes with type inference (in systems that support it.)"
317 (defcustom js2-strict-cond-assign-warning t
318 "Non-nil to warn about expressions like if (a = b).
319 This often should have been '==' instead of '='. If the warning
320 is enabled, you can suppress it on a per-expression basis by
321 parenthesizing the expression, e.g. if ((a = b)) ..."
325 (defcustom js2-strict-var-redeclaration-warning t
326 "Non-nil to warn about redeclaring variables in a script or function."
330 (defcustom js2-strict-var-hides-function-arg-warning t
331 "Non-nil to warn about a var decl hiding a function argument."
335 (defcustom js2-skip-preprocessor-directives nil
336 "Non-nil to treat lines beginning with # as comments.
337 Useful for viewing Mozilla JavaScript source code."
341 (defcustom js2-language-version 200
342 "Configures what JavaScript language version to recognize.
343 Currently versions 150, 160, 170, 180 and 200 are supported,
344 corresponding to JavaScript 1.5, 1.6, 1.7, 1.8 and 2.0 (Harmony),
345 respectively. In a nutshell, 1.6 adds E4X support, 1.7 adds let,
346 yield, and Array comprehensions, and 1.8 adds function closures."
350 (defcustom js2-instanceof-has-side-effects nil
351 "If non-nil, treats the instanceof operator as having side effects.
352 This is useful for xulrunner apps."
356 (defcustom js2-move-point-on-right-click t
357 "Non-nil to move insertion point when you right-click.
358 This makes right-click context menu behavior a bit more intuitive,
359 since menu operations generally apply to the point. The exception
360 is if there is a region selection, in which case the point does -not-
361 move, so cut/copy/paste can work properly.
363 Note that IntelliJ moves the point, and Eclipse leaves it alone,
364 so this behavior is customizable."
368 (defcustom js2-allow-rhino-new-expr-initializer t
369 "Non-nil to support a Rhino's experimental syntactic construct.
371 Rhino supports the ability to follow a `new' expression with an object
372 literal, which is used to set additional properties on the new object
373 after calling its constructor. Syntax:
375 new <expr> [ ( arglist ) ] [initializer]
377 Hence, this expression:
379 new Object {a: 1, b: 2}
381 results in an Object with properties a=1 and b=2. This syntax is
382 apparently not configurable in Rhino - it's currently always enabled,
383 as of Rhino version 1.7R2."
387 (defcustom js2-allow-member-expr-as-function-name nil
388 "Non-nil to support experimental Rhino syntax for function names.
390 Rhino supports an experimental syntax configured via the Rhino Context
391 setting `allowMemberExprAsFunctionName'. The experimental syntax is:
393 function <member-expr> ( [ arg-list ] ) { <body> }
395 Where member-expr is a non-parenthesized 'member expression', which
396 is anything at the grammar level of a new-expression or lower, meaning
397 any expression that does not involve infix or unary operators.
399 When <member-expr> is not a simple identifier, then it is syntactic
400 sugar for assigning the anonymous function to the <member-expr>. Hence,
403 function a.b().c[2] (x, y) { ... }
407 a.b().c[2] = function(x, y) {...}
409 which doesn't seem particularly useful, but Rhino permits it."
415 (defmacro js2-deflocal (name value &optional comment)
416 "Define a buffer-local variable NAME with VALUE and COMMENT."
417 (declare (debug defvar) (doc-string 3))
419 (defvar ,name ,value ,comment)
420 (make-variable-buffer-local ',name)))
422 (defvar js2-EOF_CHAR -1
423 "Represents end of stream. Distinct from js2-EOF token type.")
425 ;; I originally used symbols to represent tokens, but Rhino uses
426 ;; ints and then sets various flag bits in them, so ints it is.
427 ;; The upshot is that we need a `js2-' prefix in front of each name.
428 (defvar js2-ERROR -1)
431 (defvar js2-ENTERWITH 2) ; begin interpreter bytecodes
432 (defvar js2-LEAVEWITH 3)
433 (defvar js2-RETURN 4)
437 (defvar js2-SETNAME 8)
439 (defvar js2-BITXOR 10)
440 (defvar js2-BITAND 11)
450 (defvar js2-ADD 21) ; infix plus
451 (defvar js2-SUB 22) ; infix minus
456 (defvar js2-BITNOT 27)
457 (defvar js2-POS 28) ; unary plus
458 (defvar js2-NEG 29) ; unary minus
460 (defvar js2-DELPROP 31)
461 (defvar js2-TYPEOF 32)
462 (defvar js2-GETPROP 33)
463 (defvar js2-GETPROPNOWARN 34)
464 (defvar js2-SETPROP 35)
465 (defvar js2-GETELEM 36)
466 (defvar js2-SETELEM 37)
468 (defvar js2-NAME 39) ; an identifier
469 (defvar js2-NUMBER 40)
470 (defvar js2-STRING 41)
473 (defvar js2-FALSE 44)
475 (defvar js2-SHEQ 46) ; shallow equality (===)
476 (defvar js2-SHNE 47) ; shallow inequality (!==)
477 (defvar js2-REGEXP 48)
478 (defvar js2-BINDNAME 49)
479 (defvar js2-THROW 50)
480 (defvar js2-RETHROW 51) ; rethrow caught exception: catch (e if ) uses it
482 (defvar js2-INSTANCEOF 53)
483 (defvar js2-LOCAL_LOAD 54)
484 (defvar js2-GETVAR 55)
485 (defvar js2-SETVAR 56)
486 (defvar js2-CATCH_SCOPE 57)
487 (defvar js2-ENUM_INIT_KEYS 58) ; FIXME: what are these?
488 (defvar js2-ENUM_INIT_VALUES 59)
489 (defvar js2-ENUM_INIT_ARRAY 60)
490 (defvar js2-ENUM_NEXT 61)
491 (defvar js2-ENUM_ID 62)
492 (defvar js2-THISFN 63)
493 (defvar js2-RETURN_RESULT 64) ; to return previously stored return result
494 (defvar js2-ARRAYLIT 65) ; array literal
495 (defvar js2-OBJECTLIT 66) ; object literal
496 (defvar js2-GET_REF 67) ; *reference
497 (defvar js2-SET_REF 68) ; *reference = something
498 (defvar js2-DEL_REF 69) ; delete reference
499 (defvar js2-REF_CALL 70) ; f(args) = something or f(args)++
500 (defvar js2-REF_SPECIAL 71) ; reference for special properties like __proto
501 (defvar js2-YIELD 72) ; JS 1.7 yield pseudo keyword
504 (defvar js2-DEFAULTNAMESPACE 73)
505 (defvar js2-ESCXMLATTR 74)
506 (defvar js2-ESCXMLTEXT 75)
507 (defvar js2-REF_MEMBER 76) ; Reference for x.@y, x..y etc.
508 (defvar js2-REF_NS_MEMBER 77) ; Reference for x.ns::y, x..ns::y etc.
509 (defvar js2-REF_NAME 78) ; Reference for @y, @[y] etc.
510 (defvar js2-REF_NS_NAME 79) ; Reference for ns::y, @ns::y@[y] etc.
512 (defvar js2-first-bytecode js2-ENTERWITH)
513 (defvar js2-last-bytecode js2-REF_NS_NAME)
516 (defvar js2-SEMI 81) ; semicolon
517 (defvar js2-LB 82) ; left and right brackets
519 (defvar js2-LC 84) ; left and right curly-braces
521 (defvar js2-LP 86) ; left and right parens
523 (defvar js2-COMMA 88) ; comma operator
525 (defvar js2-ASSIGN 89) ; simple assignment (=)
526 (defvar js2-ASSIGN_BITOR 90) ; |=
527 (defvar js2-ASSIGN_BITXOR 91) ; ^=
528 (defvar js2-ASSIGN_BITAND 92) ; &=
529 (defvar js2-ASSIGN_LSH 93) ; <<=
530 (defvar js2-ASSIGN_RSH 94) ; >>=
531 (defvar js2-ASSIGN_URSH 95) ; >>>=
532 (defvar js2-ASSIGN_ADD 96) ; +=
533 (defvar js2-ASSIGN_SUB 97) ; -=
534 (defvar js2-ASSIGN_MUL 98) ; *=
535 (defvar js2-ASSIGN_DIV 99) ; /=
536 (defvar js2-ASSIGN_MOD 100) ; %=
538 (defvar js2-first-assign js2-ASSIGN)
539 (defvar js2-last-assign js2-ASSIGN_MOD)
541 (defvar js2-HOOK 101) ; conditional (?:)
542 (defvar js2-COLON 102)
543 (defvar js2-OR 103) ; logical or (||)
544 (defvar js2-AND 104) ; logical and (&&)
545 (defvar js2-INC 105) ; increment/decrement (++ --)
547 (defvar js2-DOT 107) ; member operator (.)
548 (defvar js2-FUNCTION 108) ; function keyword
549 (defvar js2-EXPORT 109) ; export keyword
550 (defvar js2-IMPORT 110) ; import keyword
551 (defvar js2-IF 111) ; if keyword
552 (defvar js2-ELSE 112) ; else keyword
553 (defvar js2-SWITCH 113) ; switch keyword
554 (defvar js2-CASE 114) ; case keyword
555 (defvar js2-DEFAULT 115) ; default keyword
556 (defvar js2-WHILE 116) ; while keyword
557 (defvar js2-DO 117) ; do keyword
558 (defvar js2-FOR 118) ; for keyword
559 (defvar js2-BREAK 119) ; break keyword
560 (defvar js2-CONTINUE 120) ; continue keyword
561 (defvar js2-VAR 121) ; var keyword
562 (defvar js2-WITH 122) ; with keyword
563 (defvar js2-CATCH 123) ; catch keyword
564 (defvar js2-FINALLY 124) ; finally keyword
565 (defvar js2-VOID 125) ; void keyword
566 (defvar js2-RESERVED 126) ; reserved keywords
568 (defvar js2-EMPTY 127)
570 ;; Types used for the parse tree - never returned by scanner.
572 (defvar js2-BLOCK 128) ; statement block
573 (defvar js2-LABEL 129) ; label
574 (defvar js2-TARGET 130)
575 (defvar js2-LOOP 131)
576 (defvar js2-EXPR_VOID 132) ; expression statement in functions
577 (defvar js2-EXPR_RESULT 133) ; expression statement in scripts
579 (defvar js2-SCRIPT 135) ; top-level node for entire script
580 (defvar js2-TYPEOFNAME 136) ; for typeof(simple-name)
581 (defvar js2-USE_STACK 137)
582 (defvar js2-SETPROP_OP 138) ; x.y op= something
583 (defvar js2-SETELEM_OP 139) ; x[y] op= something
584 (defvar js2-LOCAL_BLOCK 140)
585 (defvar js2-SET_REF_OP 141) ; *reference op= something
588 (defvar js2-DOTDOT 142) ; member operator (..)
589 (defvar js2-COLONCOLON 143) ; namespace::name
590 (defvar js2-XML 144) ; XML type
591 (defvar js2-DOTQUERY 145) ; .() -- e.g., x.emps.emp.(name == "terry")
592 (defvar js2-XMLATTR 146) ; @
593 (defvar js2-XMLEND 147)
595 ;; Optimizer-only tokens
596 (defvar js2-TO_OBJECT 148)
597 (defvar js2-TO_DOUBLE 149)
599 (defvar js2-GET 150) ; JS 1.5 get pseudo keyword
600 (defvar js2-SET 151) ; JS 1.5 set pseudo keyword
601 (defvar js2-LET 152) ; JS 1.7 let pseudo keyword
602 (defvar js2-CONST 153)
603 (defvar js2-SETCONST 154)
604 (defvar js2-SETCONSTVAR 155)
605 (defvar js2-ARRAYCOMP 156)
606 (defvar js2-LETEXPR 157)
607 (defvar js2-WITHEXPR 158)
608 (defvar js2-DEBUGGER 159)
610 (defvar js2-COMMENT 160)
611 (defvar js2-TRIPLEDOT 161) ; for rest parameter
612 (defvar js2-ARROW 162) ; function arrow (=>)
613 (defvar js2-CLASS 163)
614 (defvar js2-EXTENDS 164)
615 (defvar js2-SUPER 165)
616 (defvar js2-TEMPLATE_HEAD 166) ; part of template literal before substitution
617 (defvar js2-NO_SUBS_TEMPLATE 167) ; template literal without substitutions
618 (defvar js2-TAGGED_TEMPLATE 168) ; tagged template literal
620 (defvar js2-AWAIT 169) ; await (pseudo keyword)
622 (defconst js2-num-tokens (1+ js2-AWAIT))
624 (defconst js2-debug-print-trees nil)
626 ;; Rhino accepts any string or stream as input. Emacs character
627 ;; processing works best in buffers, so we'll assume the input is a
628 ;; buffer. JavaScript strings can be copied into temp buffers before
631 ;; Buffer-local variables yield much cleaner code than using `defstruct'.
632 ;; They're the Emacs equivalent of instance variables, more or less.
634 (js2-deflocal js2-ts-dirty-line nil
635 "Token stream buffer-local variable.
636 Indicates stuff other than whitespace since start of line.")
638 (js2-deflocal js2-ts-hit-eof nil
639 "Token stream buffer-local variable.")
642 (js2-deflocal js2-ts-line-start 0
643 "Token stream buffer-local variable.")
645 (js2-deflocal js2-ts-lineno 1
646 "Token stream buffer-local variable.")
649 (js2-deflocal js2-ts-line-end-char -1
650 "Token stream buffer-local variable.")
652 (js2-deflocal js2-ts-cursor 1 ; emacs buffers are 1-indexed
653 "Token stream buffer-local variable.
654 Current scan position.")
657 (js2-deflocal js2-ts-is-xml-attribute nil
658 "Token stream buffer-local variable.")
660 (js2-deflocal js2-ts-xml-is-tag-content nil
661 "Token stream buffer-local variable.")
663 (js2-deflocal js2-ts-xml-open-tags-count 0
664 "Token stream buffer-local variable.")
666 (js2-deflocal js2-ts-string-buffer nil
667 "Token stream buffer-local variable.
668 List of chars built up while scanning various tokens.")
670 (cl-defstruct (js2-token
672 (:constructor make-js2-token (beg)))
673 "Value returned from the token stream."
680 number-legacy-octal-p
685 ;; Have to call `js2-init-scanner' to initialize the values.
686 (js2-deflocal js2-ti-tokens nil)
687 (js2-deflocal js2-ti-tokens-cursor nil)
688 (js2-deflocal js2-ti-lookahead nil)
690 (cl-defstruct (js2-ts-state
691 (:constructor make-js2-ts-state (&key (lineno js2-ts-lineno)
692 (cursor js2-ts-cursor)
693 (tokens (copy-sequence js2-ti-tokens))
694 (tokens-cursor js2-ti-tokens-cursor)
695 (lookahead js2-ti-lookahead))))
704 (js2-deflocal js2-parsed-errors nil
705 "List of errors produced during scanning/parsing.")
707 (js2-deflocal js2-parsed-warnings nil
708 "List of warnings produced during scanning/parsing.")
710 (js2-deflocal js2-recover-from-parse-errors t
711 "Non-nil to continue parsing after a syntax error.
713 In recovery mode, the AST will be built in full, and any error
714 nodes will be flagged with appropriate error information. If
715 this flag is nil, a syntax error will result in an error being
718 The variable is automatically buffer-local, because different
719 modes that use the parser will need different settings.")
721 (js2-deflocal js2-parse-hook nil
722 "List of callbacks for receiving parsing progress.")
724 (defvar js2-parse-finished-hook nil
725 "List of callbacks to notify when parsing finishes.
726 Not called if parsing was interrupted.")
728 (js2-deflocal js2-is-eval-code nil
729 "True if we're evaluating code in a string.
730 If non-nil, the tokenizer will record the token text, and the AST nodes
731 will record their source text. Off by default for IDE modes, since the
732 text is available in the buffer.")
734 (defvar js2-parse-ide-mode t
735 "Non-nil if the parser is being used for `js2-mode'.
736 If non-nil, the parser will set text properties for fontification
737 and the syntax table. The value should be nil when using the
738 parser as a frontend to an interpreter or byte compiler.")
740 ;;; Parser instance variables (buffer-local vars for js2-parse)
742 (defconst js2-ti-after-eol (lsh 1 16)
743 "Flag: first token of the source line.")
745 ;; Inline Rhino's CompilerEnvirons vars as buffer-locals.
747 (js2-deflocal js2-compiler-generate-debug-info t)
748 (js2-deflocal js2-compiler-use-dynamic-scope nil)
749 (js2-deflocal js2-compiler-reserved-keywords-as-identifier nil)
750 (js2-deflocal js2-compiler-xml-available t)
751 (js2-deflocal js2-compiler-optimization-level 0)
752 (js2-deflocal js2-compiler-generating-source t)
753 (js2-deflocal js2-compiler-strict-mode nil)
754 (js2-deflocal js2-compiler-report-warning-as-error nil)
755 (js2-deflocal js2-compiler-generate-observer-count nil)
756 (js2-deflocal js2-compiler-activation-names nil)
760 ;; There's a compileFunction method in Context.java - may need it.
761 (js2-deflocal js2-called-by-compile-function nil
762 "True if `js2-parse' was called by `js2-compile-function'.
763 Will only be used when we finish implementing the interpreter.")
765 ;; SKIP: ts (we just call `js2-init-scanner' and use its vars)
767 ;; SKIP: node factory - we're going to just call functions directly,
768 ;; and eventually go to a unified AST format.
770 (js2-deflocal js2-nesting-of-function 0)
772 (js2-deflocal js2-recorded-identifiers nil
773 "Tracks identifiers found during parsing.")
775 (js2-deflocal js2-is-in-destructuring nil
776 "True while parsing destructuring expression.")
778 (js2-deflocal js2-in-use-strict-directive nil
779 "True while inside a script or function under strict mode.")
781 (defcustom js2-global-externs nil
782 "A list of any extern names you'd like to consider always declared.
783 This list is global and is used by all `js2-mode' files.
784 You can create buffer-local externs list using `js2-additional-externs'.
786 There is also a buffer-local variable `js2-default-externs',
787 which is initialized by default to include the Ecma-262 externs
788 and the standard browser externs. The three lists are all
789 checked during highlighting."
793 (js2-deflocal js2-default-externs nil
794 "Default external declarations.
796 These are currently only used for highlighting undeclared variables,
797 which only worries about top-level (unqualified) references.
798 As js2-mode's processing improves, we will flesh out this list.
800 The initial value is set to `js2-ecma-262-externs', unless some
801 of the `js2-include-?-externs' variables are set to t, in which
802 case the browser, Rhino and/or Node.js externs are also included.
804 See `js2-additional-externs' for more information.")
806 (defcustom js2-include-browser-externs t
807 "Non-nil to include browser externs in the master externs list.
808 If you work on JavaScript files that are not intended for browsers,
809 such as Mozilla Rhino server-side JavaScript, set this to nil.
810 See `js2-additional-externs' for more information about externs."
814 (defcustom js2-include-rhino-externs nil
815 "Non-nil to include Mozilla Rhino externs in the master externs list.
816 See `js2-additional-externs' for more information about externs."
820 (defcustom js2-include-node-externs nil
821 "Non-nil to include Node.js externs in the master externs list.
822 See `js2-additional-externs' for more information about externs."
826 (js2-deflocal js2-additional-externs nil
827 "A buffer-local list of additional external declarations.
828 It is used to decide whether variables are considered undeclared
829 for purposes of highlighting.
831 Each entry is a Lisp string. The string should be the fully qualified
832 name of an external entity. All externs should be added to this list,
833 so that as js2-mode's processing improves it can take advantage of them.
835 You may want to declare your externs in three ways.
836 First, you can add externs that are valid for all your JavaScript files.
837 You should probably do this by adding them to `js2-global-externs', which
838 is a global list used for all js2-mode files.
840 Next, you can add a function to `js2-init-hook' that adds additional
841 externs appropriate for the specific file, perhaps based on its path.
842 These should go in `js2-additional-externs', which is buffer-local.
844 Third, you can use JSLint's global declaration, as long as
845 `js2-include-jslint-globals' is non-nil, which see.
847 Finally, you can add a function to `js2-post-parse-callbacks',
848 which is called after parsing completes, and `js2-mode-ast' is bound to
849 the root of the parse tree. At this stage you can set up an AST
850 node visitor using `js2-visit-ast' and examine the parse tree
851 for specific import patterns that may imply the existence of
852 other externs, possibly tied to your build system. These should also
853 be added to `js2-additional-externs'.
855 Your post-parse callback may of course also use the simpler and
856 faster (but perhaps less robust) approach of simply scanning the
857 buffer text for your imports, using regular expressions.")
860 ;; SKIP: encoded-source
862 ;;; The following variables are per-function and should be saved/restored
863 ;;; during function parsing...
865 (js2-deflocal js2-current-script-or-fn nil)
866 (js2-deflocal js2-current-scope nil)
867 (js2-deflocal js2-nesting-of-with 0)
868 (js2-deflocal js2-label-set nil
869 "An alist mapping label names to nodes.")
871 (js2-deflocal js2-loop-set nil)
872 (js2-deflocal js2-loop-and-switch-set nil)
873 (js2-deflocal js2-has-return-value nil)
874 (js2-deflocal js2-end-flags 0)
876 ;;; ...end of per function variables
878 ;; These flags enumerate the possible ways a statement/function can
879 ;; terminate. These flags are used by endCheck() and by the Parser to
880 ;; detect inconsistent return usage.
882 ;; END_UNREACHED is reserved for code paths that are assumed to always be
883 ;; able to execute (example: throw, continue)
885 ;; END_DROPS_OFF indicates if the statement can transfer control to the
886 ;; next one. Statement such as return dont. A compound statement may have
887 ;; some branch that drops off control to the next statement.
889 ;; END_RETURNS indicates that the statement can return (without arguments)
890 ;; END_RETURNS_VALUE indicates that the statement can return a value.
892 ;; A compound statement such as
896 ;; Will be detected as (END_DROPS_OFF | END_RETURN_VALUE) by endCheck()
898 (defconst js2-end-unreached #x0)
899 (defconst js2-end-drops-off #x1)
900 (defconst js2-end-returns #x2)
901 (defconst js2-end-returns-value #x4)
903 ;; Rhino awkwardly passes a statementLabel parameter to the
904 ;; statementHelper() function, the main statement parser, which
905 ;; is then used by quite a few of the sub-parsers. We just make
906 ;; it a buffer-local variable and make sure it's cleaned up properly.
907 (js2-deflocal js2-labeled-stmt nil) ; type `js2-labeled-stmt-node'
909 ;; Similarly, Rhino passes an inForInit boolean through about half
910 ;; the expression parsers. We use a dynamically-scoped variable,
911 ;; which makes it easier to funcall the parsers individually without
912 ;; worrying about whether they take the parameter or not.
913 (js2-deflocal js2-in-for-init nil)
914 (js2-deflocal js2-temp-name-counter 0)
915 (js2-deflocal js2-parse-stmt-count 0)
917 (defsubst js2-get-next-temp-name ()
918 (format "$%d" (cl-incf js2-temp-name-counter)))
920 (defvar js2-parse-interruptable-p t
921 "Set this to nil to force parse to continue until finished.
922 This will mostly be useful for interpreters.")
924 (defvar js2-statements-per-pause 50
925 "Pause after this many statements to check for user input.
926 If user input is pending, stop the parse and discard the tree.
927 This makes for a smoother user experience for large files.
928 You may have to wait a second or two before the highlighting
929 and error-reporting appear, but you can always type ahead if
930 you wish. This appears to be more or less how Eclipse, IntelliJ
931 and other editors work.")
933 (js2-deflocal js2-record-comments t
934 "Instructs the scanner to record comments in `js2-scanned-comments'.")
936 (js2-deflocal js2-scanned-comments nil
937 "List of all comments from the current parse.")
939 (defcustom js2-mode-indent-inhibit-undo nil
940 "Non-nil to disable collection of Undo information when indenting lines.
941 Some users have requested this behavior. It's nil by default because
942 other Emacs modes don't work this way."
946 (defcustom js2-mode-indent-ignore-first-tab nil
947 "If non-nil, ignore first TAB keypress if we look indented properly.
948 It's fairly common for users to navigate to an already-indented line
949 and press TAB for reassurance that it's been indented. For this class
950 of users, we want the first TAB press on a line to be ignored if the
951 line is already indented to one of the precomputed alternatives.
953 This behavior is only partly implemented. If you TAB-indent a line,
954 navigate to another line, and then navigate back, it fails to clear
955 the last-indented variable, so it thinks you've already hit TAB once,
956 and performs the indent. A full solution would involve getting on the
957 point-motion hooks for the entire buffer. If we come across another
958 use cases that requires watching point motion, I'll consider doing it.
960 If you set this variable to nil, then the TAB key will always change
961 the indentation of the current line, if more than one alternative
962 indentation spot exists."
966 (defvar js2-indent-hook nil
967 "A hook for user-defined indentation rules.
969 Functions on this hook should expect two arguments: (LIST INDEX)
970 The LIST argument is the list of computed indentation points for
971 the current line. INDEX is the list index of the indentation point
972 that `js2-bounce-indent' plans to use. If INDEX is nil, then the
973 indent function is not going to change the current line indentation.
975 If a hook function on this list returns a non-nil value, then
976 `js2-bounce-indent' assumes the hook function has performed its own
977 indentation, and will do nothing. If all hook functions on the list
978 return nil, then `js2-bounce-indent' will use its computed indentation
979 and reindent the line.
981 When hook functions on this hook list are called, the variable
982 `js2-mode-ast' may or may not be set, depending on whether the
983 parse tree is available. If the variable is nil, you can pass a
984 callback to `js2-mode-wait-for-parse', and your callback will be
985 called after the new parse tree is built. This can take some time
989 `((((class color) (background light))
990 (:underline "orange"))
991 (((class color) (background dark))
992 (:underline "orange"))
994 "Face for JavaScript warnings."
998 `((((class color) (background light))
1000 (((class color) (background dark))
1001 (:foreground "red"))
1002 (t (:foreground "red")))
1003 "Face for JavaScript errors."
1006 (defface js2-jsdoc-tag
1007 '((t :foreground "SlateGray"))
1008 "Face used to highlight @whatever tags in jsdoc comments."
1011 (defface js2-jsdoc-type
1012 '((t :foreground "SteelBlue"))
1013 "Face used to highlight {FooBar} types in jsdoc comments."
1016 (defface js2-jsdoc-value
1017 '((t :foreground "PeachPuff3"))
1018 "Face used to highlight tag values in jsdoc comments."
1021 (defface js2-function-param
1022 '((t :foreground "SeaGreen"))
1023 "Face used to highlight function parameters in javascript."
1026 (defface js2-function-call
1027 '((t :inherit default))
1028 "Face used to highlight function name in calls."
1031 (defface js2-object-property
1032 '((t :inherit default))
1033 "Face used to highlight named property in object literal."
1036 (defface js2-instance-member
1037 '((t :foreground "DarkOrchid"))
1038 "Face used to highlight instance variables in javascript.
1039 Not currently used."
1042 (defface js2-private-member
1043 '((t :foreground "PeachPuff3"))
1044 "Face used to highlight calls to private methods in javascript.
1045 Not currently used."
1048 (defface js2-private-function-call
1049 '((t :foreground "goldenrod"))
1050 "Face used to highlight calls to private functions in javascript.
1051 Not currently used."
1054 (defface js2-jsdoc-html-tag-name
1055 '((((class color) (min-colors 88) (background light))
1056 (:foreground "rosybrown"))
1057 (((class color) (min-colors 8) (background dark))
1058 (:foreground "yellow"))
1059 (((class color) (min-colors 8) (background light))
1060 (:foreground "magenta")))
1061 "Face used to highlight jsdoc html tag names"
1064 (defface js2-jsdoc-html-tag-delimiter
1065 '((((class color) (min-colors 88) (background light))
1066 (:foreground "dark khaki"))
1067 (((class color) (min-colors 8) (background dark))
1068 (:foreground "green"))
1069 (((class color) (min-colors 8) (background light))
1070 (:foreground "green")))
1071 "Face used to highlight brackets in jsdoc html tags."
1074 (defface js2-external-variable
1075 '((t :foreground "orange"))
1076 "Face used to highlight undeclared variable identifiers.")
1078 (defcustom js2-init-hook nil
1079 "List of functions to be called after `js2-mode' or
1080 `js2-minor-mode' has initialized all variables, before parsing
1081 the buffer for the first time."
1084 :version "20130608")
1086 (defcustom js2-post-parse-callbacks nil
1087 "List of callback functions invoked after parsing finishes.
1088 Currently, the main use for this function is to add synthetic
1089 declarations to `js2-recorded-identifiers', which see."
1093 (defcustom js2-build-imenu-callbacks nil
1094 "List of functions called during Imenu index generation.
1095 It's a good place to add additional entries to it, using
1096 `js2-record-imenu-entry'."
1100 (defcustom js2-highlight-external-variables t
1101 "Non-nil to highlight undeclared variable identifiers.
1102 An undeclared variable is any variable not declared with var or let
1103 in the current scope or any lexically enclosing scope. If you use
1104 such a variable, then you are either expecting it to originate from
1105 another file, or you've got a potential bug."
1109 (defcustom js2-warn-about-unused-function-arguments nil
1110 "Non-nil to treat function arguments like declared-but-unused variables."
1114 (defcustom js2-include-jslint-globals t
1115 "Non-nil to include the identifiers from JSLint global
1116 declaration (see http://www.jslint.com/lint.html#global) in the
1117 buffer-local externs list. See `js2-additional-externs' for more
1122 (defvar js2-mode-map
1123 (let ((map (make-sparse-keymap)))
1124 (define-key map [mouse-1] #'js2-mode-show-node)
1125 (define-key map (kbd "M-j") #'js2-line-break)
1126 (define-key map (kbd "C-c C-e") #'js2-mode-hide-element)
1127 (define-key map (kbd "C-c C-s") #'js2-mode-show-element)
1128 (define-key map (kbd "C-c C-a") #'js2-mode-show-all)
1129 (define-key map (kbd "C-c C-f") #'js2-mode-toggle-hide-functions)
1130 (define-key map (kbd "C-c C-t") #'js2-mode-toggle-hide-comments)
1131 (define-key map (kbd "C-c C-o") #'js2-mode-toggle-element)
1132 (define-key map (kbd "C-c C-w") #'js2-mode-toggle-warnings-and-errors)
1133 (define-key map [down-mouse-3] #'js2-down-mouse-3)
1134 (define-key map [remap js-find-symbol] #'js2-jump-to-definition)
1136 (define-key map [menu-bar javascript]
1137 (cons "JavaScript" (make-sparse-keymap "JavaScript")))
1139 (define-key map [menu-bar javascript customize-js2-mode]
1140 '(menu-item "Customize js2-mode" js2-mode-customize
1141 :help "Customize the behavior of this mode"))
1143 (define-key map [menu-bar javascript js2-force-refresh]
1144 '(menu-item "Force buffer refresh" js2-mode-reset
1145 :help "Re-parse the buffer from scratch"))
1147 (define-key map [menu-bar javascript separator-2]
1150 (define-key map [menu-bar javascript next-error]
1151 '(menu-item "Next warning or error" next-error
1152 :enabled (and js2-mode-ast
1153 (or (js2-ast-root-errors js2-mode-ast)
1154 (js2-ast-root-warnings js2-mode-ast)))
1155 :help "Move to next warning or error"))
1157 (define-key map [menu-bar javascript display-errors]
1158 '(menu-item "Show errors and warnings" js2-mode-display-warnings-and-errors
1159 :visible (not js2-mode-show-parse-errors)
1160 :help "Turn on display of warnings and errors"))
1162 (define-key map [menu-bar javascript hide-errors]
1163 '(menu-item "Hide errors and warnings" js2-mode-hide-warnings-and-errors
1164 :visible js2-mode-show-parse-errors
1165 :help "Turn off display of warnings and errors"))
1167 (define-key map [menu-bar javascript separator-1]
1170 (define-key map [menu-bar javascript js2-toggle-function]
1171 '(menu-item "Show/collapse element" js2-mode-toggle-element
1172 :help "Hide or show function body or comment"))
1174 (define-key map [menu-bar javascript show-comments]
1175 '(menu-item "Show block comments" js2-mode-toggle-hide-comments
1176 :visible js2-mode-comments-hidden
1177 :help "Expand all hidden block comments"))
1179 (define-key map [menu-bar javascript hide-comments]
1180 '(menu-item "Hide block comments" js2-mode-toggle-hide-comments
1181 :visible (not js2-mode-comments-hidden)
1182 :help "Show block comments as /*...*/"))
1184 (define-key map [menu-bar javascript show-all-functions]
1185 '(menu-item "Show function bodies" js2-mode-toggle-hide-functions
1186 :visible js2-mode-functions-hidden
1187 :help "Expand all hidden function bodies"))
1189 (define-key map [menu-bar javascript hide-all-functions]
1190 '(menu-item "Hide function bodies" js2-mode-toggle-hide-functions
1191 :visible (not js2-mode-functions-hidden)
1192 :help "Show {...} for all top-level function bodies"))
1195 "Keymap used in `js2-mode' buffers.")
1197 (defcustom js2-bounce-indent-p nil
1198 "Non-nil to bind `js2-indent-bounce' and `js2-indent-bounce-backward'.
1199 They will augment the default indent-line behavior with cycling
1200 among several computed alternatives. See the function
1201 `js2-bounce-indent' for details. The above commands will be
1202 bound to TAB and backtab."
1205 :set (lambda (sym value)
1206 (set-default sym value)
1207 (let ((map js2-mode-map))
1210 (define-key map "\t" nil)
1211 (define-key map (kbd "<backtab>") nil))
1212 (define-key map "\t" #'js2-indent-bounce)
1213 (define-key map (kbd "<backtab>") #'js2-indent-bounce-backward)))))
1215 (defconst js2-mode-identifier-re "[[:alpha:]_$][[:alnum:]_$]*")
1217 (defvar js2-mode-//-comment-re "^\\(\\s-*\\)//.+"
1218 "Matches a //-comment line. Must be first non-whitespace on line.
1219 First match-group is the leading whitespace.")
1221 (defvar js2-mode-hook nil)
1223 (js2-deflocal js2-mode-ast nil "Private variable.")
1224 (js2-deflocal js2-mode-parse-timer nil "Private variable.")
1225 (js2-deflocal js2-mode-buffer-dirty-p nil "Private variable.")
1226 (js2-deflocal js2-mode-parsing nil "Private variable.")
1227 (js2-deflocal js2-mode-node-overlay nil)
1229 (defvar js2-mode-show-overlay js2-mode-dev-mode-p
1230 "Debug: Non-nil to highlight AST nodes on mouse-down.")
1232 (js2-deflocal js2-mode-fontifications nil "Private variable")
1233 (js2-deflocal js2-mode-deferred-properties nil "Private variable")
1234 (js2-deflocal js2-imenu-recorder nil "Private variable")
1235 (js2-deflocal js2-imenu-function-map nil "Private variable")
1237 (defvar js2-mode-verbose-parse-p js2-mode-dev-mode-p
1238 "Non-nil to emit status messages during parsing.")
1240 (defvar js2-mode-functions-hidden nil "Private variable.")
1241 (defvar js2-mode-comments-hidden nil "Private variable.")
1243 (defvar js2-mode-syntax-table
1244 (let ((table (make-syntax-table)))
1245 (c-populate-syntax-table table)
1246 (modify-syntax-entry ?` "\"" table)
1248 "Syntax table used in `js2-mode' buffers.")
1250 (defvar js2-mode-abbrev-table nil
1251 "Abbrev table in use in `js2-mode' buffers.")
1252 (define-abbrev-table 'js2-mode-abbrev-table ())
1254 (defvar js2-mode-pending-parse-callbacks nil
1255 "List of functions waiting to be notified that parse is finished.")
1257 (defvar js2-mode-last-indented-line -1)
1259 ;;; Localizable error and warning messages
1261 ;; Messages are copied from Rhino's Messages.properties.
1262 ;; Many of the Java-specific messages have been elided.
1263 ;; Add any js2-specific ones at the end, so we can keep
1264 ;; this file synced with changes to Rhino's.
1266 (defvar js2-message-table
1267 (make-hash-table :test 'equal :size 250)
1268 "Contains localized messages for `js2-mode'.")
1270 ;; TODO(stevey): construct this table at compile-time.
1271 (defmacro js2-msg (key &rest strings)
1272 `(puthash ,key (concat ,@strings)
1275 (defun js2-get-msg (msg-key)
1276 "Look up a localized message.
1277 MSG-KEY is a list of (MSG ARGS). If the message takes parameters,
1278 the correct number of ARGS must be provided."
1279 (let* ((key (if (listp msg-key) (car msg-key) msg-key))
1280 (args (if (listp msg-key) (cdr msg-key)))
1281 (msg (gethash key js2-message-table)))
1283 (apply #'format msg args)
1284 key))) ; default to showing the key
1286 (js2-msg "msg.dup.parms"
1287 "Duplicate parameter name '%s'.")
1289 (js2-msg "msg.too.big.jump"
1290 "Program too complex: jump offset too big.")
1292 (js2-msg "msg.too.big.index"
1293 "Program too complex: internal index exceeds 64K limit.")
1295 (js2-msg "msg.while.compiling.fn"
1296 "Encountered code generation error while compiling function '%s': %s")
1298 (js2-msg "msg.while.compiling.script"
1299 "Encountered code generation error while compiling script: %s")
1302 (js2-msg "msg.ctor.not.found"
1303 "Constructor for '%s' not found.")
1305 (js2-msg "msg.not.ctor"
1306 "'%s' is not a constructor.")
1309 (js2-msg "msg.varargs.ctor"
1310 "Method or constructor '%s' must be static "
1311 "with the signature (Context cx, Object[] args, "
1312 "Function ctorObj, boolean inNewExpr) "
1313 "to define a variable arguments constructor.")
1315 (js2-msg "msg.varargs.fun"
1316 "Method '%s' must be static with the signature "
1317 "(Context cx, Scriptable thisObj, Object[] args, Function funObj) "
1318 "to define a variable arguments function.")
1320 (js2-msg "msg.incompat.call"
1321 "Method '%s' called on incompatible object.")
1323 (js2-msg "msg.bad.parms"
1324 "Unsupported parameter type '%s' in method '%s'.")
1326 (js2-msg "msg.bad.method.return"
1327 "Unsupported return type '%s' in method '%s'.")
1329 (js2-msg "msg.bad.ctor.return"
1330 "Construction of objects of type '%s' is not supported.")
1332 (js2-msg "msg.no.overload"
1333 "Method '%s' occurs multiple times in class '%s'.")
1335 (js2-msg "msg.method.not.found"
1336 "Method '%s' not found in '%s'.")
1340 (js2-msg "msg.bad.for.in.lhs"
1341 "Invalid left-hand side of for..in loop.")
1343 (js2-msg "msg.mult.index"
1344 "Only one variable allowed in for..in loop.")
1346 (js2-msg "msg.bad.for.in.destruct"
1347 "Left hand side of for..in loop must be an array of "
1348 "length 2 to accept key/value pair.")
1350 (js2-msg "msg.cant.convert"
1351 "Can't convert to type '%s'.")
1353 (js2-msg "msg.bad.assign.left"
1354 "Invalid assignment left-hand side.")
1356 (js2-msg "msg.bad.decr"
1357 "Invalid decrement operand.")
1359 (js2-msg "msg.bad.incr"
1360 "Invalid increment operand.")
1362 (js2-msg "msg.bad.yield"
1363 "yield must be in a function.")
1365 (js2-msg "msg.yield.parenthesized"
1366 "yield expression must be parenthesized.")
1368 (js2-msg "msg.bad.await"
1369 "await must be in async functions.")
1372 (js2-msg "msg.cant.call.indirect"
1373 "Function '%s' must be called directly, and not by way of a "
1374 "function of another name.")
1376 (js2-msg "msg.eval.nonstring"
1377 "Calling eval() with anything other than a primitive "
1378 "string value will simply return the value. "
1379 "Is this what you intended?")
1381 (js2-msg "msg.eval.nonstring.strict"
1382 "Calling eval() with anything other than a primitive "
1383 "string value is not allowed in strict mode.")
1385 (js2-msg "msg.bad.destruct.op"
1386 "Invalid destructuring assignment operator")
1389 (js2-msg "msg.only.from.new"
1390 "'%s' may only be invoked from a `new' expression.")
1392 (js2-msg "msg.deprec.ctor"
1393 "The '%s' constructor is deprecated.")
1396 (js2-msg "msg.no.function.ref.found"
1397 "no source found to decompile function reference %s")
1399 (js2-msg "msg.arg.isnt.array"
1400 "second argument to Function.prototype.apply must be an array")
1403 (js2-msg "msg.bad.esc.mask"
1404 "invalid string escape mask")
1407 (js2-msg "msg.bad.quant"
1408 "Invalid quantifier %s")
1410 (js2-msg "msg.overlarge.backref"
1411 "Overly large back reference %s")
1413 (js2-msg "msg.overlarge.min"
1414 "Overly large minimum %s")
1416 (js2-msg "msg.overlarge.max"
1417 "Overly large maximum %s")
1419 (js2-msg "msg.zero.quant"
1420 "Zero quantifier %s")
1422 (js2-msg "msg.max.lt.min"
1423 "Maximum %s less than minimum")
1425 (js2-msg "msg.unterm.quant"
1426 "Unterminated quantifier %s")
1428 (js2-msg "msg.unterm.paren"
1429 "Unterminated parenthetical %s")
1431 (js2-msg "msg.unterm.class"
1432 "Unterminated character class %s")
1434 (js2-msg "msg.bad.range"
1435 "Invalid range in character class.")
1437 (js2-msg "msg.trail.backslash"
1438 "Trailing \\ in regular expression.")
1440 (js2-msg "msg.re.unmatched.right.paren"
1441 "unmatched ) in regular expression.")
1443 (js2-msg "msg.no.regexp"
1444 "Regular expressions are not available.")
1446 (js2-msg "msg.bad.backref"
1447 "back-reference exceeds number of capturing parentheses.")
1449 (js2-msg "msg.bad.regexp.compile"
1450 "Only one argument may be specified if the first "
1451 "argument to RegExp.prototype.compile is a RegExp object.")
1454 (js2-msg "msg.got.syntax.errors"
1455 "Compilation produced %s syntax errors.")
1457 (js2-msg "msg.var.redecl"
1458 "TypeError: redeclaration of var %s.")
1460 (js2-msg "msg.const.redecl"
1461 "TypeError: redeclaration of const %s.")
1463 (js2-msg "msg.let.redecl"
1464 "TypeError: redeclaration of variable %s.")
1466 (js2-msg "msg.parm.redecl"
1467 "TypeError: redeclaration of formal parameter %s.")
1469 (js2-msg "msg.fn.redecl"
1470 "TypeError: redeclaration of function %s.")
1472 (js2-msg "msg.let.decl.not.in.block"
1473 "SyntaxError: let declaration not directly within block")
1475 (js2-msg "msg.mod.import.decl.at.top.level"
1476 "SyntaxError: import declarations may only appear at the top level")
1478 (js2-msg "msg.mod.as.after.reserved.word"
1479 "SyntaxError: missing keyword 'as' after reserved word %s")
1481 (js2-msg "msg.mod.rc.after.import.spec.list"
1482 "SyntaxError: missing '}' after module specifier list")
1484 (js2-msg "msg.mod.from.after.import.spec.set"
1485 "SyntaxError: missing keyword 'from' after import specifier set")
1487 (js2-msg "msg.mod.declaration.after.import"
1488 "SyntaxError: missing declaration after 'import' keyword")
1490 (js2-msg "msg.mod.spec.after.from"
1491 "SyntaxError: missing module specifier after 'from' keyword")
1493 (js2-msg "msg.mod.export.decl.at.top.level"
1494 "SyntaxError: export declarations may only appear at top level")
1496 (js2-msg "msg.mod.rc.after.export.spec.list"
1497 "SyntaxError: missing '}' after export specifier list")
1500 (js2-msg "msg.dup.label"
1503 (js2-msg "msg.undef.label"
1506 (js2-msg "msg.bad.break"
1507 "unlabelled break must be inside loop or switch")
1509 (js2-msg "msg.continue.outside"
1510 "continue must be inside loop")
1512 (js2-msg "msg.continue.nonloop"
1513 "continue can only use labels of iteration statements")
1515 (js2-msg "msg.bad.throw.eol"
1516 "Line terminator is not allowed between the throw "
1517 "keyword and throw expression.")
1519 (js2-msg "msg.unnamed.function.stmt" ; added by js2-mode
1520 "function statement requires a name")
1522 (js2-msg "msg.no.paren.parms"
1523 "missing ( before function parameters.")
1525 (js2-msg "msg.no.parm"
1526 "missing formal parameter")
1528 (js2-msg "msg.no.paren.after.parms"
1529 "missing ) after formal parameters")
1531 (js2-msg "msg.no.default.after.default.param" ; added by js2-mode
1532 "parameter without default follows parameter with default")
1534 (js2-msg "msg.param.after.rest" ; added by js2-mode
1535 "parameter after rest parameter")
1537 (js2-msg "msg.bad.arrow.args" ; added by js2-mode
1538 "invalid arrow-function arguments (parentheses around the arrow-function may help)")
1540 (js2-msg "msg.no.brace.body"
1541 "missing '{' before function body")
1543 (js2-msg "msg.no.brace.after.body"
1544 "missing } after function body")
1546 (js2-msg "msg.no.paren.cond"
1547 "missing ( before condition")
1549 (js2-msg "msg.no.paren.after.cond"
1550 "missing ) after condition")
1552 (js2-msg "msg.no.semi.stmt"
1553 "missing ; before statement")
1555 (js2-msg "msg.missing.semi"
1556 "missing ; after statement")
1558 (js2-msg "msg.no.name.after.dot"
1559 "missing name after . operator")
1561 (js2-msg "msg.no.name.after.coloncolon"
1562 "missing name after :: operator")
1564 (js2-msg "msg.no.name.after.dotdot"
1565 "missing name after .. operator")
1567 (js2-msg "msg.no.name.after.xmlAttr"
1568 "missing name after .@")
1570 (js2-msg "msg.no.bracket.index"
1571 "missing ] in index expression")
1573 (js2-msg "msg.no.paren.switch"
1574 "missing ( before switch expression")
1576 (js2-msg "msg.no.paren.after.switch"
1577 "missing ) after switch expression")
1579 (js2-msg "msg.no.brace.switch"
1580 "missing '{' before switch body")
1582 (js2-msg "msg.bad.switch"
1583 "invalid switch statement")
1585 (js2-msg "msg.no.colon.case"
1586 "missing : after case expression")
1588 (js2-msg "msg.double.switch.default"
1589 "double default label in the switch statement")
1591 (js2-msg "msg.no.while.do"
1592 "missing while after do-loop body")
1594 (js2-msg "msg.no.paren.for"
1595 "missing ( after for")
1597 (js2-msg "msg.no.semi.for"
1598 "missing ; after for-loop initializer")
1600 (js2-msg "msg.no.semi.for.cond"
1601 "missing ; after for-loop condition")
1603 (js2-msg "msg.in.after.for.name"
1604 "missing in or of after for")
1606 (js2-msg "msg.no.paren.for.ctrl"
1607 "missing ) after for-loop control")
1609 (js2-msg "msg.no.paren.with"
1610 "missing ( before with-statement object")
1612 (js2-msg "msg.no.paren.after.with"
1613 "missing ) after with-statement object")
1615 (js2-msg "msg.no.with.strict"
1616 "with statements not allowed in strict mode")
1618 (js2-msg "msg.no.paren.after.let"
1619 "missing ( after let")
1621 (js2-msg "msg.no.paren.let"
1622 "missing ) after variable list")
1624 (js2-msg "msg.no.curly.let"
1625 "missing } after let statement")
1627 (js2-msg "msg.bad.return"
1630 (js2-msg "msg.no.brace.block"
1631 "missing } in compound statement")
1633 (js2-msg "msg.bad.label"
1636 (js2-msg "msg.bad.var"
1637 "missing variable name")
1639 (js2-msg "msg.bad.var.init"
1640 "invalid variable initialization")
1642 (js2-msg "msg.no.colon.cond"
1643 "missing : in conditional expression")
1645 (js2-msg "msg.no.paren.arg"
1646 "missing ) after argument list")
1648 (js2-msg "msg.no.bracket.arg"
1649 "missing ] after element list")
1651 (js2-msg "msg.bad.prop"
1652 "invalid property id")
1654 (js2-msg "msg.no.colon.prop"
1655 "missing : after property id")
1657 (js2-msg "msg.no.brace.prop"
1658 "missing } after property list")
1660 (js2-msg "msg.no.paren"
1661 "missing ) in parenthetical")
1663 (js2-msg "msg.reserved.id"
1664 "'%s' is a reserved identifier")
1666 (js2-msg "msg.no.paren.catch"
1667 "missing ( before catch-block condition")
1669 (js2-msg "msg.bad.catchcond"
1670 "invalid catch block condition")
1672 (js2-msg "msg.catch.unreachable"
1673 "any catch clauses following an unqualified catch are unreachable")
1675 (js2-msg "msg.no.brace.try"
1676 "missing '{' before try block")
1678 (js2-msg "msg.no.brace.catchblock"
1679 "missing '{' before catch-block body")
1681 (js2-msg "msg.try.no.catchfinally"
1682 "'try' without 'catch' or 'finally'")
1684 (js2-msg "msg.no.return.value"
1685 "function %s does not always return a value")
1687 (js2-msg "msg.anon.no.return.value"
1688 "anonymous function does not always return a value")
1690 (js2-msg "msg.return.inconsistent"
1691 "return statement is inconsistent with previous usage")
1693 (js2-msg "msg.generator.returns"
1694 "TypeError: legacy generator function '%s' returns a value")
1696 (js2-msg "msg.anon.generator.returns"
1697 "TypeError: anonymous legacy generator function returns a value")
1699 (js2-msg "msg.syntax"
1702 (js2-msg "msg.unexpected.eof"
1703 "Unexpected end of file")
1705 (js2-msg "msg.XML.bad.form"
1706 "illegally formed XML syntax")
1708 (js2-msg "msg.XML.not.available"
1709 "XML runtime not available")
1711 (js2-msg "msg.too.deep.parser.recursion"
1712 "Too deep recursion while parsing")
1714 (js2-msg "msg.no.side.effects"
1715 "Code has no side effects")
1717 (js2-msg "msg.extra.trailing.comma"
1718 "Trailing comma is not supported in some browsers")
1720 (js2-msg "msg.array.trailing.comma"
1721 "Trailing comma yields different behavior across browsers")
1723 (js2-msg "msg.equal.as.assign"
1724 (concat "Test for equality (==) mistyped as assignment (=)?"
1725 " (parenthesize to suppress warning)"))
1727 (js2-msg "msg.var.hides.arg"
1728 "Variable %s hides argument")
1730 (js2-msg "msg.destruct.assign.no.init"
1731 "Missing = in destructuring declaration")
1733 (js2-msg "msg.init.no.destruct"
1734 "Binding initializer not in destructuring assignment")
1736 (js2-msg "msg.no.octal.strict"
1737 "Octal numbers prohibited in strict mode.")
1739 (js2-msg "msg.dup.obj.lit.prop.strict"
1740 "Property '%s' already defined in this object literal.")
1742 (js2-msg "msg.dup.param.strict"
1743 "Parameter '%s' already declared in this function.")
1745 (js2-msg "msg.bad.id.strict"
1746 "'%s' is not a valid identifier for this use in strict mode.")
1749 (js2-msg "msg.no.properties"
1750 "%s has no properties.")
1752 (js2-msg "msg.invalid.iterator"
1753 "Invalid iterator value")
1755 (js2-msg "msg.iterator.primitive"
1756 "__iterator__ returned a primitive value")
1758 (js2-msg "msg.assn.create.strict"
1759 "Assignment to undeclared variable %s")
1761 (js2-msg "msg.undeclared.variable" ; added by js2-mode
1762 "Undeclared variable or function '%s'")
1764 (js2-msg "msg.unused.variable" ; added by js2-mode
1765 "Unused variable or function '%s'")
1767 (js2-msg "msg.uninitialized.variable" ; added by js2-mode
1768 "Variable '%s' referenced but never initialized")
1770 (js2-msg "msg.ref.undefined.prop"
1771 "Reference to undefined property '%s'")
1773 (js2-msg "msg.prop.not.found"
1774 "Property %s not found.")
1776 (js2-msg "msg.invalid.type"
1777 "Invalid JavaScript value of type %s")
1779 (js2-msg "msg.primitive.expected"
1780 "Primitive type expected (had %s instead)")
1782 (js2-msg "msg.namespace.expected"
1783 "Namespace object expected to left of :: (found %s instead)")
1785 (js2-msg "msg.null.to.object"
1786 "Cannot convert null to an object.")
1788 (js2-msg "msg.undef.to.object"
1789 "Cannot convert undefined to an object.")
1791 (js2-msg "msg.cyclic.value"
1792 "Cyclic %s value not allowed.")
1794 (js2-msg "msg.is.not.defined"
1795 "'%s' is not defined.")
1797 (js2-msg "msg.undef.prop.read"
1798 "Cannot read property '%s' from %s")
1800 (js2-msg "msg.undef.prop.write"
1801 "Cannot set property '%s' of %s to '%s'")
1803 (js2-msg "msg.undef.prop.delete"
1804 "Cannot delete property '%s' of %s")
1806 (js2-msg "msg.undef.method.call"
1807 "Cannot call method '%s' of %s")
1809 (js2-msg "msg.undef.with"
1810 "Cannot apply 'with' to %s")
1812 (js2-msg "msg.isnt.function"
1813 "%s is not a function, it is %s.")
1815 (js2-msg "msg.isnt.function.in"
1816 "Cannot call property %s in object %s. "
1817 "It is not a function, it is '%s'.")
1819 (js2-msg "msg.function.not.found"
1820 "Cannot find function %s.")
1822 (js2-msg "msg.function.not.found.in"
1823 "Cannot find function %s in object %s.")
1825 (js2-msg "msg.isnt.xml.object"
1826 "%s is not an xml object.")
1828 (js2-msg "msg.no.ref.to.get"
1829 "%s is not a reference to read reference value.")
1831 (js2-msg "msg.no.ref.to.set"
1832 "%s is not a reference to set reference value to %s.")
1834 (js2-msg "msg.no.ref.from.function"
1835 "Function %s can not be used as the left-hand "
1836 "side of assignment or as an operand of ++ or -- operator.")
1838 (js2-msg "msg.bad.default.value"
1839 "Object's getDefaultValue() method returned an object.")
1841 (js2-msg "msg.instanceof.not.object"
1842 "Can't use instanceof on a non-object.")
1844 (js2-msg "msg.instanceof.bad.prototype"
1845 "'prototype' property of %s is not an object.")
1847 (js2-msg "msg.bad.radix"
1848 "illegal radix %s.")
1851 (js2-msg "msg.default.value"
1852 "Cannot find default value for object.")
1854 (js2-msg "msg.zero.arg.ctor"
1855 "Cannot load class '%s' which has no zero-parameter constructor.")
1857 (js2-msg "msg.ctor.multiple.parms"
1858 "Can't define constructor or class %s since more than "
1859 "one constructor has multiple parameters.")
1861 (js2-msg "msg.extend.scriptable"
1862 "%s must extend ScriptableObject in order to define property %s.")
1864 (js2-msg "msg.bad.getter.parms"
1865 "In order to define a property, getter %s must have zero "
1866 "parameters or a single ScriptableObject parameter.")
1868 (js2-msg "msg.obj.getter.parms"
1869 "Expected static or delegated getter %s to take "
1870 "a ScriptableObject parameter.")
1872 (js2-msg "msg.getter.static"
1873 "Getter and setter must both be static or neither be static.")
1875 (js2-msg "msg.setter.return"
1876 "Setter must have void return type: %s")
1878 (js2-msg "msg.setter2.parms"
1879 "Two-parameter setter must take a ScriptableObject as "
1880 "its first parameter.")
1882 (js2-msg "msg.setter1.parms"
1883 "Expected single parameter setter for %s")
1885 (js2-msg "msg.setter2.expected"
1886 "Expected static or delegated setter %s to take two parameters.")
1888 (js2-msg "msg.setter.parms"
1889 "Expected either one or two parameters for setter.")
1891 (js2-msg "msg.setter.bad.type"
1892 "Unsupported parameter type '%s' in setter '%s'.")
1894 (js2-msg "msg.add.sealed"
1895 "Cannot add a property to a sealed object: %s.")
1897 (js2-msg "msg.remove.sealed"
1898 "Cannot remove a property from a sealed object: %s.")
1900 (js2-msg "msg.modify.sealed"
1901 "Cannot modify a property of a sealed object: %s.")
1903 (js2-msg "msg.modify.readonly"
1904 "Cannot modify readonly property: %s.")
1907 (js2-msg "msg.missing.exponent"
1910 (js2-msg "msg.caught.nfe"
1911 "number format error")
1913 (js2-msg "msg.unterminated.string.lit"
1914 "unterminated string literal")
1916 (js2-msg "msg.unterminated.comment"
1917 "unterminated comment")
1919 (js2-msg "msg.unterminated.re.lit"
1920 "unterminated regular expression literal")
1922 (js2-msg "msg.invalid.re.flag"
1923 "invalid flag after regular expression")
1925 (js2-msg "msg.no.re.input.for"
1928 (js2-msg "msg.illegal.character"
1929 "illegal character")
1931 (js2-msg "msg.invalid.escape"
1932 "invalid Unicode escape sequence")
1934 (js2-msg "msg.bad.namespace"
1935 "not a valid default namespace statement. "
1936 "Syntax is: default xml namespace = EXPRESSION;")
1938 ;; TokensStream warnings
1939 (js2-msg "msg.bad.octal.literal"
1940 "illegal octal literal digit %s; "
1941 "interpreting it as a decimal digit")
1943 (js2-msg "msg.missing.hex.digits"
1944 "missing hexadecimal digits after '0x'")
1946 (js2-msg "msg.missing.binary.digits"
1947 "missing binary digits after '0b'")
1949 (js2-msg "msg.missing.octal.digits"
1950 "missing octal digits after '0o'")
1952 (js2-msg "msg.script.is.not.constructor"
1953 "Script objects are not constructors.")
1956 (js2-msg "msg.arraylength.bad"
1957 "Inappropriate array length.")
1960 (js2-msg "msg.arraylength.too.big"
1961 "Array length %s exceeds supported capacity limit.")
1964 (js2-msg "msg.bad.uri"
1965 "Malformed URI sequence.")
1968 (js2-msg "msg.bad.precision"
1969 "Precision %s out of range.")
1972 (js2-msg "msg.send.newborn"
1973 "Attempt to send value to newborn generator")
1975 (js2-msg "msg.already.exec.gen"
1976 "Already executing generator")
1978 (js2-msg "msg.StopIteration.invalid"
1979 "StopIteration may not be changed to an arbitrary object.")
1982 (js2-msg "msg.yield.closing"
1983 "Yield from closing generator")
1986 (js2-msg "msg.unnamed.class.stmt" ; added by js2-mode
1987 "class statement requires a name")
1989 (js2-msg "msg.class.unexpected.comma" ; added by js2-mode
1990 "unexpected ',' between class properties")
1992 (js2-msg "msg.unexpected.static" ; added by js2-mode
1993 "unexpected 'static'")
1995 (js2-msg "msg.missing.extends" ; added by js2-mode
1996 "name is required after extends")
1998 (js2-msg "msg.no.brace.class" ; added by js2-mode
1999 "missing '{' before class body")
2001 (js2-msg "msg.missing.computed.rb" ; added by js2-mode
2002 "missing ']' after computed property expression")
2006 (defconst js2-ti-max-lookahead 2)
2007 (defconst js2-ti-ntokens (1+ js2-ti-max-lookahead))
2009 (defun js2-new-token (offset)
2010 (let ((token (make-js2-token (+ offset js2-ts-cursor))))
2011 (setq js2-ti-tokens-cursor (mod (1+ js2-ti-tokens-cursor) js2-ti-ntokens))
2012 (aset js2-ti-tokens js2-ti-tokens-cursor token)
2015 (defsubst js2-current-token ()
2016 (aref js2-ti-tokens js2-ti-tokens-cursor))
2018 (defsubst js2-current-token-string ()
2019 (js2-token-string (js2-current-token)))
2021 (defsubst js2-current-token-type ()
2022 (js2-token-type (js2-current-token)))
2024 (defsubst js2-current-token-beg ()
2025 (js2-token-beg (js2-current-token)))
2027 (defsubst js2-current-token-end ()
2028 (js2-token-end (js2-current-token)))
2030 (defun js2-current-token-len ()
2031 (let ((token (js2-current-token)))
2032 (- (js2-token-end token)
2033 (js2-token-beg token))))
2035 (defun js2-ts-seek (state)
2036 (setq js2-ts-lineno (js2-ts-state-lineno state)
2037 js2-ts-cursor (js2-ts-state-cursor state)
2038 js2-ti-tokens (js2-ts-state-tokens state)
2039 js2-ti-tokens-cursor (js2-ts-state-tokens-cursor state)
2040 js2-ti-lookahead (js2-ts-state-lookahead state)))
2044 (defun js2-delete-if (predicate list)
2045 "Remove all items satisfying PREDICATE in LIST."
2046 (cl-loop for item in list
2047 if (not (funcall predicate item))
2050 (defun js2-position (element list)
2051 "Find 0-indexed position of ELEMENT in LIST comparing with `eq'.
2052 Returns nil if element is not found in the list."
2055 (while (and list (not found))
2056 (if (eq element (car list))
2058 (setq count (1+ count)
2062 (defun js2-find-if (predicate list)
2063 "Find first item satisfying PREDICATE in LIST."
2065 (while (and list (not result))
2066 (if (funcall predicate (car list))
2067 (setq result (car list)))
2068 (setq list (cdr list)))
2071 (defmacro js2-time (form)
2072 "Evaluate FORM, discard result, and return elapsed time in sec."
2074 (let ((beg (make-symbol "--js2-time-beg--")))
2075 `(let ((,beg (current-time)))
2077 (/ (truncate (* (- (float-time (current-time))
2082 (defsubst js2-same-line (pos)
2083 "Return t if POS is on the same line as current point."
2084 (and (>= pos (point-at-bol))
2085 (<= pos (point-at-eol))))
2087 (defun js2-code-bug ()
2088 "Signal an error when we encounter an unexpected code path."
2089 (error "failed assertion"))
2091 (defsubst js2-record-text-property (beg end prop value)
2092 "Record a text property to set when parsing finishes."
2093 (push (list beg end prop value) js2-mode-deferred-properties))
2095 ;; I'd like to associate errors with nodes, but for now the
2096 ;; easiest thing to do is get the context info from the last token.
2097 (defun js2-record-parse-error (msg &optional arg pos len)
2098 (push (list (list msg arg)
2099 (or pos (js2-current-token-beg))
2100 (or len (js2-current-token-len)))
2103 (defun js2-report-error (msg &optional msg-arg pos len)
2104 "Signal a syntax error or record a parse error."
2105 (if js2-recover-from-parse-errors
2106 (js2-record-parse-error msg msg-arg pos len)
2107 (signal 'js2-syntax-error
2111 (goto-char js2-ts-cursor)
2115 (defun js2-report-warning (msg &optional msg-arg pos len face)
2116 (if js2-compiler-report-warning-as-error
2117 (js2-report-error msg msg-arg pos len)
2118 (push (list (list msg msg-arg)
2119 (or pos (js2-current-token-beg))
2120 (or len (js2-current-token-len))
2122 js2-parsed-warnings)))
2124 (defun js2-add-strict-warning (msg-id &optional msg-arg beg end)
2125 (if js2-compiler-strict-mode
2126 (js2-report-warning msg-id msg-arg beg
2127 (and beg end (- end beg)))))
2129 (put 'js2-syntax-error 'error-conditions
2130 '(error syntax-error js2-syntax-error))
2131 (put 'js2-syntax-error 'error-message "Syntax error")
2133 (put 'js2-parse-error 'error-conditions
2134 '(error parse-error js2-parse-error))
2135 (put 'js2-parse-error 'error-message "Parse error")
2137 (defmacro js2-clear-flag (flags flag)
2138 `(setq ,flags (logand ,flags (lognot ,flag))))
2140 (defmacro js2-set-flag (flags flag)
2141 "Logical-or FLAG into FLAGS."
2142 `(setq ,flags (logior ,flags ,flag)))
2144 (defsubst js2-flag-set-p (flags flag)
2145 (/= 0 (logand flags flag)))
2147 (defsubst js2-flag-not-set-p (flags flag)
2148 (zerop (logand flags flag)))
2150 ;;; AST struct and function definitions
2152 ;; flags for ast node property 'member-type (used for e4x operators)
2153 (defvar js2-property-flag #x1 "Property access: element is valid name.")
2154 (defvar js2-attribute-flag #x2 "x.@y or x..@y.")
2155 (defvar js2-descendants-flag #x4 "x..y or x..@i.")
2157 (defsubst js2-relpos (pos anchor)
2158 "Convert POS to be relative to ANCHOR.
2159 If POS is nil, returns nil."
2160 (and pos (- pos anchor)))
2162 (defun js2-make-pad (indent)
2165 (make-string (* indent js2-basic-offset) ? )))
2167 (defun js2-visit-ast (node callback)
2168 "Visit every node in ast NODE with visitor CALLBACK.
2170 CALLBACK is a function that takes two arguments: (NODE END-P). It is
2171 called twice: once to visit the node, and again after all the node's
2172 children have been processed. The END-P argument is nil on the first
2173 call and non-nil on the second call. The return value of the callback
2174 affects the traversal: if non-nil, the children of NODE are processed.
2175 If the callback returns nil, or if the node has no children, then the
2176 callback is called immediately with a non-nil END-P argument.
2178 The node traversal is approximately lexical-order, although there
2179 are currently no guarantees around this."
2181 (let ((vfunc (get (aref node 0) 'js2-visitor)))
2183 (when (funcall callback node nil)
2186 ((eq vfunc 'js2-visit-none)
2187 nil) ; don't even bother calling it
2188 ;; Each AST node type has to define a `js2-visitor' function
2189 ;; that takes a node and a callback, and calls `js2-visit-ast'
2190 ;; on each child of the node.
2192 (funcall vfunc node callback))
2194 (error "%s does not define a visitor-traversal function"
2196 ;; call the end-visit
2197 (funcall callback node t))))
2199 (cl-defstruct (js2-node
2200 (:constructor nil)) ; abstract
2201 "Base AST node type."
2202 (type -1) ; token type
2203 (pos -1) ; start position of this AST node in parsed input
2204 (len 1) ; num characters spanned by the node
2205 props ; optional node property list (an alist)
2206 parent) ; link to parent node; null for root
2208 (defsubst js2-node-get-prop (node prop &optional default)
2209 (or (cadr (assoc prop (js2-node-props node))) default))
2211 (defsubst js2-node-set-prop (node prop value)
2212 (setf (js2-node-props node)
2213 (cons (list prop value) (js2-node-props node))))
2215 (defun js2-fixup-starts (n nodes)
2216 "Adjust the start positions of NODES to be relative to N.
2217 Any node in the list may be nil, for convenience."
2218 (dolist (node nodes)
2220 (setf (js2-node-pos node) (- (js2-node-pos node)
2221 (js2-node-pos n))))))
2223 (defun js2-node-add-children (parent &rest nodes)
2224 "Set parent node of NODES to PARENT, and return PARENT.
2225 Does nothing if we're not recording parent links.
2226 If any given node in NODES is nil, doesn't record that link."
2227 (js2-fixup-starts parent nodes)
2228 (dolist (node nodes)
2230 (setf (js2-node-parent node) parent))))
2232 ;; Non-recursive since it's called a frightening number of times.
2233 (defun js2-node-abs-pos (n)
2234 (let ((pos (js2-node-pos n)))
2235 (while (setq n (js2-node-parent n))
2236 (setq pos (+ pos (js2-node-pos n))))
2239 (defsubst js2-node-abs-end (n)
2240 "Return absolute buffer position of end of N."
2241 (+ (js2-node-abs-pos n) (js2-node-len n)))
2243 ;; It's important to make sure block nodes have a Lisp list for the
2244 ;; child nodes, to limit printing recursion depth in an AST that
2245 ;; otherwise consists of defstruct vectors. Emacs will crash printing
2246 ;; a sufficiently large vector tree.
2248 (cl-defstruct (js2-block-node
2251 (:constructor make-js2-block-node (&key (type js2-BLOCK)
2252 (pos (js2-current-token-beg))
2256 "A block of statements."
2257 kids) ; a Lisp list of the child statement nodes
2259 (put 'cl-struct-js2-block-node 'js2-visitor 'js2-visit-block)
2260 (put 'cl-struct-js2-block-node 'js2-printer 'js2-print-block)
2262 (defun js2-visit-block (ast callback)
2263 "Visit the `js2-block-node' children of AST."
2264 (dolist (kid (js2-block-node-kids ast))
2265 (js2-visit-ast kid callback)))
2267 (defun js2-print-block (n i)
2268 (let ((pad (js2-make-pad i)))
2270 (dolist (kid (js2-block-node-kids n))
2271 (js2-print-ast kid (1+ i)))
2274 (cl-defstruct (js2-scope
2275 (:include js2-block-node)
2277 (:constructor make-js2-scope (&key (type js2-BLOCK)
2278 (pos (js2-current-token-beg))
2281 ;; The symbol-table is a LinkedHashMap<String,Symbol> in Rhino.
2282 ;; I don't have one of those handy, so I'll use an alist for now.
2283 ;; It's as fast as an emacs hashtable for up to about 50 elements,
2284 ;; and is much lighter-weight to construct (both CPU and mem).
2285 ;; The keys are interned strings (symbols) for faster lookup.
2286 ;; Should switch to hybrid alist/hashtable eventually.
2287 symbol-table ; an alist of (symbol . js2-symbol)
2288 parent-scope ; a `js2-scope'
2289 top) ; top-level `js2-scope' (script/function)
2291 (put 'cl-struct-js2-scope 'js2-visitor 'js2-visit-block)
2292 (put 'cl-struct-js2-scope 'js2-printer 'js2-print-none)
2294 (defun js2-node-get-enclosing-scope (node)
2295 "Return the innermost `js2-scope' node surrounding NODE.
2296 Returns nil if there is no enclosing scope node."
2297 (while (and (setq node (js2-node-parent node))
2298 (not (js2-scope-p node))))
2301 (defun js2-get-defining-scope (scope name &optional point)
2302 "Search up scope chain from SCOPE looking for NAME, a string or symbol.
2303 Returns `js2-scope' in which NAME is defined, or nil if not found.
2305 If POINT is non-nil, and if the found declaration type is
2306 `js2-LET', also check that the declaration node is before POINT."
2307 (let ((sym (if (symbolp name)
2312 (while (and scope continue)
2314 (let ((entry (cdr (assq sym (js2-scope-symbol-table scope)))))
2317 (not (eq js2-LET (js2-symbol-decl-type entry)))
2319 (js2-node-abs-pos (js2-symbol-ast-node entry))))))
2320 (and (eq sym 'arguments)
2321 (js2-function-node-p scope)))
2324 (setq scope (js2-scope-parent-scope scope))))
2327 (defun js2-scope-get-symbol (scope name)
2328 "Return symbol table entry for NAME in SCOPE.
2329 NAME can be a string or symbol. Returns a `js2-symbol' or nil if not found."
2330 (and (js2-scope-symbol-table scope)
2331 (cdr (assq (if (symbolp name)
2334 (js2-scope-symbol-table scope)))))
2336 (defun js2-scope-put-symbol (scope name symbol)
2337 "Enter SYMBOL into symbol-table for SCOPE under NAME.
2338 NAME can be a Lisp symbol or string. SYMBOL is a `js2-symbol'."
2339 (let* ((table (js2-scope-symbol-table scope))
2340 (sym (if (symbolp name) name (intern name)))
2341 (entry (assq sym table)))
2343 (setcdr entry symbol)
2344 (push (cons sym symbol)
2345 (js2-scope-symbol-table scope)))))
2347 (cl-defstruct (js2-symbol
2349 (:constructor make-js2-symbol (decl-type name &optional ast-node)))
2350 "A symbol table entry."
2351 ;; One of js2-FUNCTION, js2-LP (for parameters), js2-VAR,
2352 ;; js2-LET, or js2-CONST
2355 ast-node) ; a `js2-node'
2357 (cl-defstruct (js2-error-node
2359 (:constructor nil) ; silence emacs21 byte-compiler
2360 (:constructor make-js2-error-node (&key (type js2-ERROR)
2361 (pos (js2-current-token-beg))
2363 "AST node representing a parse error.")
2365 (put 'cl-struct-js2-error-node 'js2-visitor 'js2-visit-none)
2366 (put 'cl-struct-js2-error-node 'js2-printer 'js2-print-none)
2368 (cl-defstruct (js2-script-node
2369 (:include js2-scope)
2371 (:constructor make-js2-script-node (&key (type js2-SCRIPT)
2372 (pos (js2-current-token-beg))
2374 ;; FIXME: What are those?
2377 functions ; Lisp list of nested functions
2378 regexps ; Lisp list of (string . flags)
2379 symbols ; alist (every symbol gets unique index)
2381 var-names ; vector of string names
2382 consts ; bool-vector matching var-decls
2383 (temp-number 0)) ; for generating temp variables
2385 (put 'cl-struct-js2-script-node 'js2-visitor 'js2-visit-block)
2386 (put 'cl-struct-js2-script-node 'js2-printer 'js2-print-script)
2388 (defun js2-print-script (node indent)
2389 (dolist (kid (js2-block-node-kids node))
2390 (js2-print-ast kid indent)))
2392 (cl-defstruct (js2-ast-root
2393 (:include js2-script-node)
2395 (:constructor make-js2-ast-root (&key (type js2-SCRIPT)
2396 (pos (js2-current-token-beg))
2399 "The root node of a js2 AST."
2400 buffer ; the source buffer from which the code was parsed
2401 comments ; a Lisp list of comments, ordered by start position
2402 errors ; a Lisp list of errors found during parsing
2403 warnings ; a Lisp list of warnings found during parsing
2404 node-count) ; number of nodes in the tree, including the root
2406 (put 'cl-struct-js2-ast-root 'js2-visitor 'js2-visit-ast-root)
2407 (put 'cl-struct-js2-ast-root 'js2-printer 'js2-print-script)
2409 (defun js2-visit-ast-root (ast callback)
2410 (dolist (kid (js2-ast-root-kids ast))
2411 (js2-visit-ast kid callback))
2412 (dolist (comment (js2-ast-root-comments ast))
2413 (js2-visit-ast comment callback)))
2415 (cl-defstruct (js2-comment-node
2418 (:constructor make-js2-comment-node (&key (type js2-COMMENT)
2419 (pos (js2-current-token-beg))
2422 format) ; 'line, 'block, 'jsdoc or 'html
2424 (put 'cl-struct-js2-comment-node 'js2-visitor 'js2-visit-none)
2425 (put 'cl-struct-js2-comment-node 'js2-printer 'js2-print-comment)
2427 (defun js2-print-comment (n i)
2428 ;; We really ought to link end-of-line comments to their nodes.
2429 ;; Or maybe we could add a new comment type, 'endline.
2430 (insert (js2-make-pad i)
2431 (js2-node-string n)))
2433 (cl-defstruct (js2-expr-stmt-node
2436 (:constructor make-js2-expr-stmt-node (&key (type js2-EXPR_VOID)
2440 "An expression statement."
2443 (defsubst js2-expr-stmt-node-set-has-result (node)
2444 "Change NODE type to `js2-EXPR_RESULT'. Used for code generation."
2445 (setf (js2-node-type node) js2-EXPR_RESULT))
2447 (put 'cl-struct-js2-expr-stmt-node 'js2-visitor 'js2-visit-expr-stmt-node)
2448 (put 'cl-struct-js2-expr-stmt-node 'js2-printer 'js2-print-expr-stmt-node)
2450 (defun js2-visit-expr-stmt-node (n v)
2451 (js2-visit-ast (js2-expr-stmt-node-expr n) v))
2453 (defun js2-print-expr-stmt-node (n indent)
2454 (js2-print-ast (js2-expr-stmt-node-expr n) indent)
2457 (cl-defstruct (js2-loop-node
2458 (:include js2-scope)
2460 "Abstract supertype of loop nodes."
2461 body ; a `js2-block-node'
2462 lp ; position of left-paren, nil if omitted
2463 rp) ; position of right-paren, nil if omitted
2465 (cl-defstruct (js2-do-node
2466 (:include js2-loop-node)
2468 (:constructor make-js2-do-node (&key (type js2-DO)
2469 (pos (js2-current-token-beg))
2476 "AST node for do-loop."
2477 condition ; while (expression)
2478 while-pos) ; buffer position of 'while' keyword
2480 (put 'cl-struct-js2-do-node 'js2-visitor 'js2-visit-do-node)
2481 (put 'cl-struct-js2-do-node 'js2-printer 'js2-print-do-node)
2483 (defun js2-visit-do-node (n v)
2484 (js2-visit-ast (js2-do-node-body n) v)
2485 (js2-visit-ast (js2-do-node-condition n) v))
2487 (defun js2-print-do-node (n i)
2488 (let ((pad (js2-make-pad i)))
2489 (insert pad "do {\n")
2490 (dolist (kid (js2-block-node-kids (js2-do-node-body n)))
2491 (js2-print-ast kid (1+ i)))
2492 (insert pad "} while (")
2493 (js2-print-ast (js2-do-node-condition n) 0)
2496 (cl-defstruct (js2-export-node
2499 (:constructor make-js2-export-node (&key (type js2-EXPORT)
2500 (pos (js2-current-token-beg))
2506 "AST node for an export statement. There are many things that can be exported,
2507 so many of its properties will be nil.
2509 exports-list ; lisp list of js2-export-binding-node to export
2510 from-clause ; js2-from-clause-node for re-exporting symbols from another module
2511 declaration ; js2-var-decl-node (var, let, const) or js2-class-node
2512 default) ; js2-function-node or js2-assign-node
2514 (put 'cl-struct-js2-export-node 'js2-visitor 'js2-visit-export-node)
2515 (put 'cl-struct-js2-export-node 'js2-printer 'js2-print-export-node)
2517 (defun js2-visit-export-node (n v)
2518 (let ((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)))
2523 (dolist (export exports-list)
2524 (js2-visit-ast export v)))
2526 (js2-visit-ast from v))
2528 (js2-visit-ast declaration v))
2530 (js2-visit-ast default v))))
2532 (defun js2-print-export-node (n i)
2533 (let ((pad (js2-make-pad i))
2534 (exports-list (js2-export-node-exports-list n))
2535 (from (js2-export-node-from-clause n))
2536 (declaration (js2-export-node-declaration n))
2537 (default (js2-export-node-default n)))
2538 (insert pad "export ")
2542 (js2-print-ast default i))
2544 (js2-print-ast declaration i))
2545 ((and exports-list from)
2546 (js2-print-named-imports exports-list)
2548 (js2-print-from-clause from))
2551 (js2-print-from-clause from))
2553 (js2-print-named-imports exports-list)))
2554 (unless (or (and default (not (js2-assign-node-p default)))
2555 (and declaration (or (js2-function-node-p declaration)
2556 (js2-class-node-p declaration))))
2559 (cl-defstruct (js2-while-node
2560 (:include js2-loop-node)
2562 (:constructor make-js2-while-node (&key (type js2-WHILE)
2563 (pos (js2-current-token-beg))
2567 "AST node for while-loop."
2568 condition) ; while-condition
2570 (put 'cl-struct-js2-while-node 'js2-visitor 'js2-visit-while-node)
2571 (put 'cl-struct-js2-while-node 'js2-printer 'js2-print-while-node)
2573 (defun js2-visit-while-node (n v)
2574 (js2-visit-ast (js2-while-node-condition n) v)
2575 (js2-visit-ast (js2-while-node-body n) v))
2577 (defun js2-print-while-node (n i)
2578 (let ((pad (js2-make-pad i)))
2579 (insert pad "while (")
2580 (js2-print-ast (js2-while-node-condition n) 0)
2582 (js2-print-body (js2-while-node-body n) (1+ i))
2583 (insert pad "}\n")))
2585 (cl-defstruct (js2-for-node
2586 (:include js2-loop-node)
2588 (:constructor make-js2-for-node (&key (type js2-FOR)
2593 "AST node for a C-style for-loop."
2594 init ; initialization expression
2595 condition ; loop condition
2596 update) ; update clause
2598 (put 'cl-struct-js2-for-node 'js2-visitor 'js2-visit-for-node)
2599 (put 'cl-struct-js2-for-node 'js2-printer 'js2-print-for-node)
2601 (defun js2-visit-for-node (n v)
2602 (js2-visit-ast (js2-for-node-init n) v)
2603 (js2-visit-ast (js2-for-node-condition n) v)
2604 (js2-visit-ast (js2-for-node-update n) v)
2605 (js2-visit-ast (js2-for-node-body n) v))
2607 (defun js2-print-for-node (n i)
2608 (let ((pad (js2-make-pad i)))
2609 (insert pad "for (")
2610 (js2-print-ast (js2-for-node-init n) 0)
2612 (js2-print-ast (js2-for-node-condition n) 0)
2614 (js2-print-ast (js2-for-node-update n) 0)
2616 (js2-print-body (js2-for-node-body n) (1+ i))
2617 (insert pad "}\n")))
2619 (cl-defstruct (js2-for-in-node
2620 (:include js2-loop-node)
2622 (:constructor make-js2-for-in-node (&key (type js2-FOR)
2631 "AST node for a for..in loop."
2632 iterator ; [var] foo in ...
2633 object ; object over which we're iterating
2634 in-pos ; buffer position of 'in' keyword
2635 each-pos ; buffer position of 'each' keyword, if foreach-p
2636 foreach-p ; t if it's a for-each loop
2637 forof-p) ; t if it's a for-of loop
2639 (put 'cl-struct-js2-for-in-node 'js2-visitor 'js2-visit-for-in-node)
2640 (put 'cl-struct-js2-for-in-node 'js2-printer 'js2-print-for-in-node)
2642 (defun js2-visit-for-in-node (n v)
2643 (js2-visit-ast (js2-for-in-node-iterator n) v)
2644 (js2-visit-ast (js2-for-in-node-object n) v)
2645 (js2-visit-ast (js2-for-in-node-body n) v))
2647 (defun js2-print-for-in-node (n i)
2648 (let ((pad (js2-make-pad i))
2649 (foreach (js2-for-in-node-foreach-p n))
2650 (forof (js2-for-in-node-forof-p n)))
2655 (js2-print-ast (js2-for-in-node-iterator n) 0)
2656 (insert (if forof " of " " in "))
2657 (js2-print-ast (js2-for-in-node-object n) 0)
2659 (js2-print-body (js2-for-in-node-body n) (1+ i))
2660 (insert pad "}\n")))
2662 (cl-defstruct (js2-return-node
2665 (:constructor make-js2-return-node (&key (type js2-RETURN)
2669 "AST node for a return statement."
2670 retval) ; expression to return, or 'undefined
2672 (put 'cl-struct-js2-return-node 'js2-visitor 'js2-visit-return-node)
2673 (put 'cl-struct-js2-return-node 'js2-printer 'js2-print-return-node)
2675 (defun js2-visit-return-node (n v)
2676 (js2-visit-ast (js2-return-node-retval n) v))
2678 (defun js2-print-return-node (n i)
2679 (insert (js2-make-pad i) "return")
2680 (when (js2-return-node-retval n)
2682 (js2-print-ast (js2-return-node-retval n) 0))
2685 (cl-defstruct (js2-if-node
2688 (:constructor make-js2-if-node (&key (type js2-IF)
2695 "AST node for an if-statement."
2696 condition ; expression
2697 then-part ; statement or block
2698 else-pos ; optional buffer position of 'else' keyword
2699 else-part ; optional statement or block
2700 lp ; position of left-paren, nil if omitted
2701 rp) ; position of right-paren, nil if omitted
2703 (put 'cl-struct-js2-if-node 'js2-visitor 'js2-visit-if-node)
2704 (put 'cl-struct-js2-if-node 'js2-printer 'js2-print-if-node)
2706 (defun js2-visit-if-node (n v)
2707 (js2-visit-ast (js2-if-node-condition n) v)
2708 (js2-visit-ast (js2-if-node-then-part n) v)
2709 (js2-visit-ast (js2-if-node-else-part n) v))
2711 (defun js2-print-if-node (n i)
2712 (let ((pad (js2-make-pad i))
2713 (then-part (js2-if-node-then-part n))
2714 (else-part (js2-if-node-else-part n)))
2716 (js2-print-ast (js2-if-node-condition n) 0)
2718 (js2-print-body then-part (1+ i))
2723 ((js2-if-node-p else-part)
2725 (js2-print-body else-part i))
2727 (insert " else {\n")
2728 (js2-print-body else-part (1+ i))
2729 (insert pad "}\n")))))
2731 (cl-defstruct (js2-export-binding-node
2734 (:constructor make-js2-export-binding-node (&key (type -1)
2739 "AST node for an external symbol binding.
2740 It contains a local-name node which is the name of the value in the
2741 current scope, and extern-name which is the name of the value in the
2742 imported or exported scope. By default these are the same, but if the
2743 name is aliased as in {foo as bar}, it would have an extern-name node
2744 containing 'foo' and a local-name node containing 'bar'."
2745 local-name ; js2-name-node with the variable name in this scope
2746 extern-name) ; js2-name-node with the value name in the exporting module
2748 (put 'cl-struct-js2-export-binding-node 'js2-printer 'js2-print-extern-binding)
2749 (put 'cl-struct-js2-export-binding-node 'js2-visitor 'js2-visit-extern-binding)
2751 (defun js2-visit-extern-binding (n v)
2752 "Visit an extern binding node. First visit the local-name, and, if
2753 different, visit the extern-name."
2754 (let ((local-name (js2-export-binding-node-local-name n))
2755 (extern-name (js2-export-binding-node-extern-name n)))
2757 (js2-visit-ast local-name v))
2758 (when (not (equal local-name extern-name))
2759 (js2-visit-ast extern-name v))))
2761 (defun js2-print-extern-binding (n _i)
2762 "Print a representation of a single extern binding. E.g. 'foo' or
2764 (let ((local-name (js2-export-binding-node-local-name n))
2765 (extern-name (js2-export-binding-node-extern-name n)))
2766 (insert (js2-name-node-name extern-name))
2767 (when (not (equal local-name extern-name))
2769 (insert (js2-name-node-name local-name)))))
2772 (cl-defstruct (js2-import-node
2775 (:constructor make-js2-import-node (&key (type js2-IMPORT)
2776 (pos (js2-current-token-beg))
2781 "AST node for an import statement. It follows the form
2783 import ModuleSpecifier;
2784 import ImportClause FromClause;"
2785 import ; js2-import-clause-node specifying which names are to imported.
2786 from ; js2-from-clause-node indicating the module from which to import.
2787 module-id) ; module-id of the import. E.g. 'src/mylib'.
2789 (put 'cl-struct-js2-import-node 'js2-printer 'js2-print-import)
2790 (put 'cl-struct-js2-import-node 'js2-visitor 'js2-visit-import)
2792 (defun js2-visit-import (n v)
2793 (let ((import-clause (js2-import-node-import n))
2794 (from-clause (js2-import-node-from n)))
2796 (js2-visit-ast import-clause v))
2798 (js2-visit-ast from-clause v))))
2800 (defun js2-print-import (n i)
2801 "Prints a representation of the import node"
2802 (let ((pad (js2-make-pad i))
2803 (import-clause (js2-import-node-import n))
2804 (from-clause (js2-import-node-from n))
2805 (module-id (js2-import-node-module-id n)))
2806 (insert pad "import ")
2809 (js2-print-import-clause import-clause)
2811 (js2-print-from-clause from-clause))
2817 (cl-defstruct (js2-import-clause-node
2820 (:constructor make-js2-import-clause-node (&key (type -1)
2826 "AST node corresponding to the import clause of an import statement. This is
2827 the portion of the import that bindings names from the external context to the
2829 namespace-import ; js2-namespace-import-node. E.g. '* as lib'
2830 named-imports ; lisp list of js2-export-binding-node for all named imports.
2831 default-binding) ; js2-export-binding-node for the default import binding
2833 (put 'cl-struct-js2-import-clause-node 'js2-visitor 'js2-visit-import-clause)
2834 (put 'cl-struct-js2-import-clause-node 'js2-printer 'js2-print-import-clause)
2836 (defun js2-visit-import-clause (n v)
2837 (let ((ns-import (js2-import-clause-node-namespace-import n))
2838 (named-imports (js2-import-clause-node-named-imports n))
2839 (default (js2-import-clause-node-default-binding n)))
2841 (js2-visit-ast ns-import v))
2843 (dolist (import named-imports)
2844 (js2-visit-ast import v)))
2846 (js2-visit-ast default v))))
2848 (defun js2-print-import-clause (n)
2849 (let ((ns-import (js2-import-clause-node-namespace-import n))
2850 (named-imports (js2-import-clause-node-named-imports n))
2851 (default (js2-import-clause-node-default-binding n)))
2853 ((and default ns-import)
2854 (js2-print-ast default)
2856 (js2-print-namespace-import ns-import))
2857 ((and default named-imports)
2858 (js2-print-ast default)
2860 (js2-print-named-imports named-imports))
2862 (js2-print-ast default))
2864 (js2-print-namespace-import ns-import))
2866 (js2-print-named-imports named-imports)))))
2868 (defun js2-print-namespace-import (node)
2870 (insert (js2-name-node-name (js2-namespace-import-node-name node))))
2872 (defun js2-print-named-imports (imports)
2874 (let ((len (length imports))
2877 (js2-print-extern-binding (nth n imports) 0)
2878 (unless (= n (- len 1))
2883 (cl-defstruct (js2-namespace-import-node
2886 (:constructor make-js2-namespace-import-node (&key (type -1)
2890 "AST node for a complete namespace import.
2891 E.g. the '* as lib' expression in:
2893 import * as lib from 'src/lib'
2895 It contains a single name node referring to the bound name."
2896 name) ; js2-name-node of the bound name.
2898 (defun js2-visit-namespace-import (n v)
2899 (js2-visit-ast (js2-namespace-import-node-name n) v))
2901 (put 'cl-struct-js2-namespace-import-node 'js2-visitor 'js2-visit-namespace-import)
2902 (put 'cl-struct-js2-namespace-import-node 'js2-printer 'js2-print-namespace-import)
2904 (cl-defstruct (js2-from-clause-node
2907 (:constructor make-js2-from-clause-node (&key (type js2-NAME)
2912 "AST node for the from clause in an import or export statement.
2913 E.g. from 'my/module'. It can refere to either an external module, or to the
2914 modules metadata itself."
2915 module-id ; string containing the module specifier.
2916 metadata-p) ; true if this clause refers to the module's metadata
2918 (put 'cl-struct-js2-from-clause-node 'js2-visitor 'js2-visit-none)
2919 (put 'cl-struct-js2-from-clause-node 'js2-printer 'js2-print-from-clause)
2921 (defun js2-print-from-clause (n)
2923 (if (js2-from-clause-node-metadata-p n)
2924 (insert "this module")
2926 (insert (js2-from-clause-node-module-id n))
2929 (cl-defstruct (js2-try-node
2932 (:constructor make-js2-try-node (&key (type js2-TRY)
2938 "AST node for a try-statement."
2940 catch-clauses ; a Lisp list of `js2-catch-node'
2941 finally-block) ; a `js2-finally-node'
2943 (put 'cl-struct-js2-try-node 'js2-visitor 'js2-visit-try-node)
2944 (put 'cl-struct-js2-try-node 'js2-printer 'js2-print-try-node)
2946 (defun js2-visit-try-node (n v)
2947 (js2-visit-ast (js2-try-node-try-block n) v)
2948 (dolist (clause (js2-try-node-catch-clauses n))
2949 (js2-visit-ast clause v))
2950 (js2-visit-ast (js2-try-node-finally-block n) v))
2952 (defun js2-print-try-node (n i)
2953 (let ((pad (js2-make-pad i))
2954 (catches (js2-try-node-catch-clauses n))
2955 (finally (js2-try-node-finally-block n)))
2956 (insert pad "try {\n")
2957 (js2-print-body (js2-try-node-try-block n) (1+ i))
2960 (dolist (catch catches)
2961 (js2-print-ast catch i)))
2963 (js2-print-ast finally i)
2966 (cl-defstruct (js2-catch-node
2967 (:include js2-scope)
2969 (:constructor make-js2-catch-node (&key (type js2-CATCH)
2976 "AST node for a catch clause."
2977 param ; destructuring form or simple name node
2978 guard-kwd ; relative buffer position of "if" in "catch (x if ...)"
2979 guard-expr ; catch condition, a `js2-node'
2980 lp ; buffer position of left-paren, nil if omitted
2981 rp) ; buffer position of right-paren, nil if omitted
2983 (put 'cl-struct-js2-catch-node 'js2-visitor 'js2-visit-catch-node)
2984 (put 'cl-struct-js2-catch-node 'js2-printer 'js2-print-catch-node)
2986 (defun js2-visit-catch-node (n v)
2987 (js2-visit-ast (js2-catch-node-param n) v)
2988 (when (js2-catch-node-guard-kwd n)
2989 (js2-visit-ast (js2-catch-node-guard-expr n) v))
2990 (js2-visit-block n v))
2992 (defun js2-print-catch-node (n i)
2993 (let ((pad (js2-make-pad i))
2994 (guard-kwd (js2-catch-node-guard-kwd n))
2995 (guard-expr (js2-catch-node-guard-expr n)))
2997 (js2-print-ast (js2-catch-node-param n) 0)
3000 (js2-print-ast guard-expr 0))
3002 (js2-print-body n (1+ i))
3005 (cl-defstruct (js2-finally-node
3008 (:constructor make-js2-finally-node (&key (type js2-FINALLY)
3011 "AST node for a finally clause."
3012 body) ; a `js2-node', often but not always a block node
3014 (put 'cl-struct-js2-finally-node 'js2-visitor 'js2-visit-finally-node)
3015 (put 'cl-struct-js2-finally-node 'js2-printer 'js2-print-finally-node)
3017 (defun js2-visit-finally-node (n v)
3018 (js2-visit-ast (js2-finally-node-body n) v))
3020 (defun js2-print-finally-node (n i)
3021 (let ((pad (js2-make-pad i)))
3022 (insert " finally {\n")
3023 (js2-print-body (js2-finally-node-body n) (1+ i))
3024 (insert pad "}\n")))
3026 (cl-defstruct (js2-switch-node
3029 (:constructor make-js2-switch-node (&key (type js2-SWITCH)
3035 "AST node for a switch statement."
3036 discriminant ; a `js2-node' (switch expression)
3037 cases ; a Lisp list of `js2-case-node'
3038 lp ; position of open-paren for discriminant, nil if omitted
3039 rp) ; position of close-paren for discriminant, nil if omitted
3041 (put 'cl-struct-js2-switch-node 'js2-visitor 'js2-visit-switch-node)
3042 (put 'cl-struct-js2-switch-node 'js2-printer 'js2-print-switch-node)
3044 (defun js2-visit-switch-node (n v)
3045 (js2-visit-ast (js2-switch-node-discriminant n) v)
3046 (dolist (c (js2-switch-node-cases n))
3047 (js2-visit-ast c v)))
3049 (defun js2-print-switch-node (n i)
3050 (let ((pad (js2-make-pad i))
3051 (cases (js2-switch-node-cases n)))
3052 (insert pad "switch (")
3053 (js2-print-ast (js2-switch-node-discriminant n) 0)
3055 (dolist (case cases)
3056 (js2-print-ast case i))
3057 (insert pad "}\n")))
3059 (cl-defstruct (js2-case-node
3060 (:include js2-block-node)
3062 (:constructor make-js2-case-node (&key (type js2-CASE)
3065 "AST node for a case clause of a switch statement."
3066 expr) ; the case expression (nil for default)
3068 (put 'cl-struct-js2-case-node 'js2-visitor 'js2-visit-case-node)
3069 (put 'cl-struct-js2-case-node 'js2-printer 'js2-print-case-node)
3071 (defun js2-visit-case-node (n v)
3072 (js2-visit-ast (js2-case-node-expr n) v)
3073 (js2-visit-block n v))
3075 (defun js2-print-case-node (n i)
3076 (let ((pad (js2-make-pad i))
3077 (expr (js2-case-node-expr n)))
3080 (insert "default:\n")
3082 (js2-print-ast expr 0)
3084 (dolist (kid (js2-case-node-kids n))
3085 (js2-print-ast kid (1+ i)))))
3087 (cl-defstruct (js2-throw-node
3090 (:constructor make-js2-throw-node (&key (type js2-THROW)
3093 "AST node for a throw statement."
3094 expr) ; the expression to throw
3096 (put 'cl-struct-js2-throw-node 'js2-visitor 'js2-visit-throw-node)
3097 (put 'cl-struct-js2-throw-node 'js2-printer 'js2-print-throw-node)
3099 (defun js2-visit-throw-node (n v)
3100 (js2-visit-ast (js2-throw-node-expr n) v))
3102 (defun js2-print-throw-node (n i)
3103 (insert (js2-make-pad i) "throw ")
3104 (js2-print-ast (js2-throw-node-expr n) 0)
3107 (cl-defstruct (js2-with-node
3110 (:constructor make-js2-with-node (&key (type js2-WITH)
3114 "AST node for a with-statement."
3117 lp ; buffer position of left-paren around object, nil if omitted
3118 rp) ; buffer position of right-paren around object, nil if omitted
3120 (put 'cl-struct-js2-with-node 'js2-visitor 'js2-visit-with-node)
3121 (put 'cl-struct-js2-with-node 'js2-printer 'js2-print-with-node)
3123 (defun js2-visit-with-node (n v)
3124 (js2-visit-ast (js2-with-node-object n) v)
3125 (js2-visit-ast (js2-with-node-body n) v))
3127 (defun js2-print-with-node (n i)
3128 (let ((pad (js2-make-pad i)))
3129 (insert pad "with (")
3130 (js2-print-ast (js2-with-node-object n) 0)
3132 (js2-print-body (js2-with-node-body n) (1+ i))
3133 (insert pad "}\n")))
3135 (cl-defstruct (js2-label-node
3138 (:constructor make-js2-label-node (&key (type js2-LABEL)
3141 "AST node for a statement label or case label."
3143 loop) ; for validating and code-generating continue-to-label
3145 (put 'cl-struct-js2-label-node 'js2-visitor 'js2-visit-none)
3146 (put 'cl-struct-js2-label-node 'js2-printer 'js2-print-label)
3148 (defun js2-print-label (n i)
3149 (insert (js2-make-pad i)
3150 (js2-label-node-name n)
3153 (cl-defstruct (js2-labeled-stmt-node
3156 ;; type needs to be in `js2-side-effecting-tokens' to avoid spurious
3157 ;; no-side-effects warnings, hence js2-EXPR_RESULT.
3158 (:constructor make-js2-labeled-stmt-node (&key (type js2-EXPR_RESULT)
3161 "AST node for a statement with one or more labels.
3162 Multiple labels for a statement are collapsed into the labels field."
3163 labels ; Lisp list of `js2-label-node'
3164 stmt) ; the statement these labels are for
3166 (put 'cl-struct-js2-labeled-stmt-node 'js2-visitor 'js2-visit-labeled-stmt)
3167 (put 'cl-struct-js2-labeled-stmt-node 'js2-printer 'js2-print-labeled-stmt)
3169 (defun js2-get-label-by-name (lbl-stmt name)
3170 "Return a `js2-label-node' by NAME from LBL-STMT's labels list.
3171 Returns nil if no such label is in the list."
3172 (let ((label-list (js2-labeled-stmt-node-labels lbl-stmt))
3174 (while (and label-list (not result))
3175 (if (string= (js2-label-node-name (car label-list)) name)
3176 (setq result (car label-list))
3177 (setq label-list (cdr label-list))))
3180 (defun js2-visit-labeled-stmt (n v)
3181 (dolist (label (js2-labeled-stmt-node-labels n))
3182 (js2-visit-ast label v))
3183 (js2-visit-ast (js2-labeled-stmt-node-stmt n) v))
3185 (defun js2-print-labeled-stmt (n i)
3186 (dolist (label (js2-labeled-stmt-node-labels n))
3187 (js2-print-ast label i))
3188 (js2-print-ast (js2-labeled-stmt-node-stmt n) i))
3190 (defun js2-labeled-stmt-node-contains (node label)
3191 "Return t if NODE contains LABEL in its label set.
3192 NODE is a `js2-labels-node'. LABEL is an identifier."
3193 (cl-loop for nl in (js2-labeled-stmt-node-labels node)
3194 if (string= label (js2-label-node-name nl))
3196 finally return nil))
3198 (defsubst js2-labeled-stmt-node-add-label (node label)
3199 "Add a `js2-label-node' to the label set for this statement."
3200 (setf (js2-labeled-stmt-node-labels node)
3201 (nconc (js2-labeled-stmt-node-labels node) (list label))))
3203 (cl-defstruct (js2-jump-node
3206 "Abstract supertype of break and continue nodes."
3207 label ; `js2-name-node' for location of label identifier, if present
3208 target) ; target js2-labels-node or loop/switch statement
3210 (defun js2-visit-jump-node (n v)
3211 ;; We don't visit the target, since it's a back-link.
3212 (js2-visit-ast (js2-jump-node-label n) v))
3214 (cl-defstruct (js2-break-node
3215 (:include js2-jump-node)
3217 (:constructor make-js2-break-node (&key (type js2-BREAK)
3220 "AST node for a break statement.
3221 The label field is a `js2-name-node', possibly nil, for the named label
3222 if provided. E.g. in 'break foo', it represents 'foo'. The target field
3223 is the target of the break - a label node or enclosing loop/switch statement.")
3225 (put 'cl-struct-js2-break-node 'js2-visitor 'js2-visit-jump-node)
3226 (put 'cl-struct-js2-break-node 'js2-printer 'js2-print-break-node)
3228 (defun js2-print-break-node (n i)
3229 (insert (js2-make-pad i) "break")
3230 (when (js2-break-node-label n)
3232 (js2-print-ast (js2-break-node-label n) 0))
3235 (cl-defstruct (js2-continue-node
3236 (:include js2-jump-node)
3238 (:constructor make-js2-continue-node (&key (type js2-CONTINUE)
3241 "AST node for a continue statement.
3242 The label field is the user-supplied enclosing label name, a `js2-name-node'.
3243 It is nil if continue specifies no label. The target field is the jump target:
3244 a `js2-label-node' or the innermost enclosing loop.")
3246 (put 'cl-struct-js2-continue-node 'js2-visitor 'js2-visit-jump-node)
3247 (put 'cl-struct-js2-continue-node 'js2-printer 'js2-print-continue-node)
3249 (defun js2-print-continue-node (n i)
3250 (insert (js2-make-pad i) "continue")
3251 (when (js2-continue-node-label n)
3253 (js2-print-ast (js2-continue-node-label n) 0))
3256 (cl-defstruct (js2-function-node
3257 (:include js2-script-node)
3259 (:constructor make-js2-function-node (&key (type js2-FUNCTION)
3263 (form 'FUNCTION_STATEMENT)
3270 "AST node for a function declaration.
3271 The `params' field is a Lisp list of nodes. Each node is either a simple
3272 `js2-name-node', or if it's a destructuring-assignment parameter, a
3273 `js2-array-node' or `js2-object-node'."
3274 ftype ; FUNCTION, GETTER or SETTER
3275 form ; FUNCTION_{STATEMENT|EXPRESSION|ARROW}
3276 name ; function name (a `js2-name-node', or nil if anonymous)
3277 params ; a Lisp list of destructuring forms or simple name nodes
3278 rest-p ; if t, the last parameter is rest parameter
3279 body ; a `js2-block-node' or expression node (1.8 only)
3280 lp ; position of arg-list open-paren, or nil if omitted
3281 rp ; position of arg-list close-paren, or nil if omitted
3282 ignore-dynamic ; ignore value of the dynamic-scope flag (interpreter only)
3283 needs-activation ; t if we need an activation object for this frame
3284 generator-type ; STAR, LEGACY, COMPREHENSION or nil
3285 async ; t if the function is defined as `async function`
3286 member-expr) ; nonstandard Ecma extension from Rhino
3288 (put 'cl-struct-js2-function-node 'js2-visitor 'js2-visit-function-node)
3289 (put 'cl-struct-js2-function-node 'js2-printer 'js2-print-function-node)
3291 (defun js2-visit-function-node (n v)
3292 (js2-visit-ast (js2-function-node-name n) v)
3293 (dolist (p (js2-function-node-params n))
3294 (js2-visit-ast p v))
3295 (js2-visit-ast (js2-function-node-body n) v))
3297 (defun js2-print-function-node (n i)
3298 (let* ((pad (js2-make-pad i))
3299 (method (js2-node-get-prop n 'METHOD_TYPE))
3300 (name (or (js2-function-node-name n)
3301 (js2-function-node-member-expr n)))
3302 (params (js2-function-node-params n))
3303 (arrow (eq (js2-function-node-form n) 'FUNCTION_ARROW))
3304 (rest-p (js2-function-node-rest-p n))
3305 (body (js2-function-node-body n))
3306 (expr (not (eq (js2-function-node-form n) 'FUNCTION_STATEMENT))))
3309 (when (js2-function-node-async n) (insert "async "))
3310 (unless arrow (insert "function"))
3311 (when (eq (js2-function-node-generator-type n) 'STAR)
3315 (js2-print-ast name 0))
3317 (cl-loop with len = (length params)
3321 (when (and rest-p (= count len))
3323 (js2-print-ast param 0)
3330 ;; TODO: fix this to be smarter about indenting, etc.
3333 (if (js2-block-node-p body)
3334 (js2-print-body body (1+ i))
3335 (js2-print-ast body 0))
3340 (defun js2-function-name (node)
3341 "Return function name for NODE, a `js2-function-node', or nil if anonymous."
3342 (and (js2-function-node-name node)
3343 (js2-name-node-name (js2-function-node-name node))))
3345 ;; Having this be an expression node makes it more flexible.
3346 ;; There are IDE contexts, such as indentation in a for-loop initializer,
3347 ;; that work better if you assume it's an expression. Whenever we have
3348 ;; a standalone var/const declaration, we just wrap with an expr stmt.
3349 ;; Eclipse apparently screwed this up and now has two versions, expr and stmt.
3350 (cl-defstruct (js2-var-decl-node
3353 (:constructor make-js2-var-decl-node (&key (type js2-VAR)
3354 (pos (js2-current-token-beg))
3357 "AST node for a variable declaration list (VAR, CONST or LET).
3358 The node bounds differ depending on the declaration type. For VAR or
3359 CONST declarations, the bounds include the var/const keyword. For LET
3360 declarations, the node begins at the position of the first child."
3361 kids ; a Lisp list of `js2-var-init-node' structs.
3362 decl-type) ; js2-VAR, js2-CONST or js2-LET
3364 (put 'cl-struct-js2-var-decl-node 'js2-visitor 'js2-visit-var-decl)
3365 (put 'cl-struct-js2-var-decl-node 'js2-printer 'js2-print-var-decl)
3367 (defun js2-visit-var-decl (n v)
3368 (dolist (kid (js2-var-decl-node-kids n))
3369 (js2-visit-ast kid v)))
3371 (defun js2-print-var-decl (n i)
3372 (let ((pad (js2-make-pad i))
3373 (tt (js2-var-decl-node-decl-type n)))
3376 ((= tt js2-VAR) "var ")
3377 ((= tt js2-LET) "let ")
3378 ((= tt js2-CONST) "const ")
3380 (error "malformed var-decl node"))))
3381 (cl-loop with kids = (js2-var-decl-node-kids n)
3382 with len = (length kids)
3386 (js2-print-ast kid 0)
3390 (cl-defstruct (js2-var-init-node
3393 (:constructor make-js2-var-init-node (&key (type js2-VAR)
3397 "AST node for a variable declaration.
3398 The type field will be js2-CONST for a const decl."
3399 target ; `js2-name-node', `js2-object-node', or `js2-array-node'
3400 initializer) ; initializer expression, a `js2-node'
3402 (put 'cl-struct-js2-var-init-node 'js2-visitor 'js2-visit-var-init-node)
3403 (put 'cl-struct-js2-var-init-node 'js2-printer 'js2-print-var-init-node)
3405 (defun js2-visit-var-init-node (n v)
3406 (js2-visit-ast (js2-var-init-node-target n) v)
3407 (js2-visit-ast (js2-var-init-node-initializer n) v))
3409 (defun js2-print-var-init-node (n i)
3410 (let ((pad (js2-make-pad i))
3411 (name (js2-var-init-node-target n))
3412 (init (js2-var-init-node-initializer n)))
3414 (js2-print-ast name 0)
3417 (js2-print-ast init 0))))
3419 (cl-defstruct (js2-cond-node
3422 (:constructor make-js2-cond-node (&key (type js2-HOOK)
3429 "AST node for the ternary operator"
3433 q-pos ; buffer position of ?
3434 c-pos) ; buffer position of :
3436 (put 'cl-struct-js2-cond-node 'js2-visitor 'js2-visit-cond-node)
3437 (put 'cl-struct-js2-cond-node 'js2-printer 'js2-print-cond-node)
3439 (defun js2-visit-cond-node (n v)
3440 (js2-visit-ast (js2-cond-node-test-expr n) v)
3441 (js2-visit-ast (js2-cond-node-true-expr n) v)
3442 (js2-visit-ast (js2-cond-node-false-expr n) v))
3444 (defun js2-print-cond-node (n i)
3445 (let ((pad (js2-make-pad i)))
3447 (js2-print-ast (js2-cond-node-test-expr n) 0)
3449 (js2-print-ast (js2-cond-node-true-expr n) 0)
3451 (js2-print-ast (js2-cond-node-false-expr n) 0)))
3453 (cl-defstruct (js2-infix-node
3456 (:constructor make-js2-infix-node (&key type
3460 "Represents infix expressions.
3461 Includes assignment ops like `|=', and the comma operator.
3462 The type field inherited from `js2-node' holds the operator."
3463 op-pos ; buffer position where operator begins
3464 left ; any `js2-node'
3465 right) ; any `js2-node'
3467 (put 'cl-struct-js2-infix-node 'js2-visitor 'js2-visit-infix-node)
3468 (put 'cl-struct-js2-infix-node 'js2-printer 'js2-print-infix-node)
3470 (defun js2-visit-infix-node (n v)
3471 (js2-visit-ast (js2-infix-node-left n) v)
3472 (js2-visit-ast (js2-infix-node-right n) v))
3474 (defconst js2-operator-tokens
3475 (let ((table (make-hash-table :test 'eq))
3477 (list (cons js2-IN "in")
3478 (cons js2-TYPEOF "typeof")
3479 (cons js2-INSTANCEOF "instanceof")
3480 (cons js2-DELPROP "delete")
3481 (cons js2-AWAIT "await")
3482 (cons js2-VOID "void")
3483 (cons js2-COMMA ",")
3484 (cons js2-COLON ":")
3489 (cons js2-BITOR "|")
3490 (cons js2-BITXOR "^")
3491 (cons js2-BITAND "&")
3500 (cons js2-URSH ">>>")
3501 (cons js2-ADD "+") ; infix plus
3502 (cons js2-SUB "-") ; infix minus
3507 (cons js2-BITNOT "~")
3508 (cons js2-POS "+") ; unary plus
3509 (cons js2-NEG "-") ; unary minus
3510 (cons js2-TRIPLEDOT "...")
3511 (cons js2-SHEQ "===") ; shallow equality
3512 (cons js2-SHNE "!==") ; shallow inequality
3513 (cons js2-ASSIGN "=")
3514 (cons js2-ASSIGN_BITOR "|=")
3515 (cons js2-ASSIGN_BITXOR "^=")
3516 (cons js2-ASSIGN_BITAND "&=")
3517 (cons js2-ASSIGN_LSH "<<=")
3518 (cons js2-ASSIGN_RSH ">>=")
3519 (cons js2-ASSIGN_URSH ">>>=")
3520 (cons js2-ASSIGN_ADD "+=")
3521 (cons js2-ASSIGN_SUB "-=")
3522 (cons js2-ASSIGN_MUL "*=")
3523 (cons js2-ASSIGN_DIV "/=")
3524 (cons js2-ASSIGN_MOD "%="))))
3525 (cl-loop for (k . v) in tokens do
3526 (puthash k v table))
3529 (defun js2-print-infix-node (n i)
3530 (let* ((tt (js2-node-type n))
3531 (op (gethash tt js2-operator-tokens)))
3533 (error "unrecognized infix operator %s" (js2-node-type n)))
3534 (insert (js2-make-pad i))
3535 (js2-print-ast (js2-infix-node-left n) 0)
3536 (unless (= tt js2-COMMA)
3540 (js2-print-ast (js2-infix-node-right n) 0)))
3542 (cl-defstruct (js2-assign-node
3543 (:include js2-infix-node)
3545 (:constructor make-js2-assign-node (&key type
3549 "Represents any assignment.
3550 The type field holds the actual assignment operator.")
3552 (put 'cl-struct-js2-assign-node 'js2-visitor 'js2-visit-infix-node)
3553 (put 'cl-struct-js2-assign-node 'js2-printer 'js2-print-infix-node)
3555 (cl-defstruct (js2-unary-node
3558 (:constructor make-js2-unary-node (&key type ; required
3561 "AST node type for unary operator nodes.
3562 The type field can be NOT, BITNOT, POS, NEG, INC, DEC,
3563 TYPEOF, DELPROP, TRIPLEDOT or AWAIT. For INC or DEC, a 'postfix node
3564 property is added if the operator follows the operand."
3565 operand) ; a `js2-node' expression
3567 (put 'cl-struct-js2-unary-node 'js2-visitor 'js2-visit-unary-node)
3568 (put 'cl-struct-js2-unary-node 'js2-printer 'js2-print-unary-node)
3570 (defun js2-visit-unary-node (n v)
3571 (js2-visit-ast (js2-unary-node-operand n) v))
3573 (defun js2-print-unary-node (n i)
3574 (let* ((tt (js2-node-type n))
3575 (op (gethash tt js2-operator-tokens))
3576 (postfix (js2-node-get-prop n 'postfix)))
3578 (error "unrecognized unary operator %s" tt))
3579 (insert (js2-make-pad i))
3582 (if (or (= tt js2-TYPEOF)
3587 (js2-print-ast (js2-unary-node-operand n) 0)
3591 (cl-defstruct (js2-let-node
3592 (:include js2-scope)
3594 (:constructor make-js2-let-node (&key (type js2-LETEXPR)
3595 (pos (js2-current-token-beg))
3598 "AST node for a let expression or a let statement.
3599 Note that a let declaration such as let x=6, y=7 is a `js2-var-decl-node'."
3600 vars ; a `js2-var-decl-node'
3601 body ; a `js2-node' representing the expression or body block
3605 (put 'cl-struct-js2-let-node 'js2-visitor 'js2-visit-let-node)
3606 (put 'cl-struct-js2-let-node 'js2-printer 'js2-print-let-node)
3608 (defun js2-visit-let-node (n v)
3609 (js2-visit-ast (js2-let-node-vars n) v)
3610 (js2-visit-ast (js2-let-node-body n) v))
3612 (defun js2-print-let-node (n i)
3613 (insert (js2-make-pad i) "let (")
3615 (js2-print-ast (js2-let-node-vars n) 0)
3616 (delete-region p (+ p 4)))
3618 (js2-print-ast (js2-let-node-body n) i))
3620 (cl-defstruct (js2-keyword-node
3623 (:constructor make-js2-keyword-node (&key type
3624 (pos (js2-current-token-beg))
3625 (len (- js2-ts-cursor pos)))))
3626 "AST node representing a literal keyword such as `null'.
3627 Used for `null', `this', `true', `false' and `debugger'.
3628 The node type is set to js2-NULL, js2-THIS, etc.")
3630 (put 'cl-struct-js2-keyword-node 'js2-visitor 'js2-visit-none)
3631 (put 'cl-struct-js2-keyword-node 'js2-printer 'js2-print-keyword-node)
3633 (defun js2-print-keyword-node (n i)
3634 (insert (js2-make-pad i)
3635 (let ((tt (js2-node-type n)))
3637 ((= tt js2-THIS) "this")
3638 ((= tt js2-SUPER) "super")
3639 ((= tt js2-NULL) "null")
3640 ((= tt js2-TRUE) "true")
3641 ((= tt js2-FALSE) "false")
3642 ((= tt js2-DEBUGGER) "debugger")
3643 (t (error "Invalid keyword literal type: %d" tt))))))
3645 (defsubst js2-this-or-super-node-p (node)
3646 "Return t if NODE is a `js2-literal-node' of type js2-THIS or js2-SUPER."
3647 (let ((type (js2-node-type node)))
3648 (or (eq type js2-THIS) (eq type js2-SUPER))))
3650 (cl-defstruct (js2-new-node
3653 (:constructor make-js2-new-node (&key (type js2-NEW)
3654 (pos (js2-current-token-beg))
3658 "AST node for new-expression such as new Foo()."
3659 target ; an identifier or reference
3660 args ; a Lisp list of argument nodes
3661 lp ; position of left-paren, nil if omitted
3662 rp ; position of right-paren, nil if omitted
3663 initializer) ; experimental Rhino syntax: optional `js2-object-node'
3665 (put 'cl-struct-js2-new-node 'js2-visitor 'js2-visit-new-node)
3666 (put 'cl-struct-js2-new-node 'js2-printer 'js2-print-new-node)
3668 (defun js2-visit-new-node (n v)
3669 (js2-visit-ast (js2-new-node-target n) v)
3670 (dolist (arg (js2-new-node-args n))
3671 (js2-visit-ast arg v))
3672 (js2-visit-ast (js2-new-node-initializer n) v))
3674 (defun js2-print-new-node (n i)
3675 (insert (js2-make-pad i) "new ")
3676 (js2-print-ast (js2-new-node-target n))
3678 (js2-print-list (js2-new-node-args n))
3680 (when (js2-new-node-initializer n)
3682 (js2-print-ast (js2-new-node-initializer n))))
3684 (cl-defstruct (js2-name-node
3687 (:constructor make-js2-name-node (&key (type js2-NAME)
3688 (pos (js2-current-token-beg))
3689 (len (- js2-ts-cursor
3690 (js2-current-token-beg)))
3691 (name (js2-current-token-string)))))
3692 "AST node for a JavaScript identifier"
3694 scope) ; a `js2-scope' (optional, used for codegen)
3696 (put 'cl-struct-js2-name-node 'js2-visitor 'js2-visit-none)
3697 (put 'cl-struct-js2-name-node 'js2-printer 'js2-print-name-node)
3699 (defun js2-print-name-node (n i)
3700 (insert (js2-make-pad i)
3701 (js2-name-node-name n)))
3703 (defsubst js2-name-node-length (node)
3704 "Return identifier length of NODE, a `js2-name-node'.
3705 Returns 0 if NODE is nil or its identifier field is nil."
3707 (length (js2-name-node-name node))
3710 (cl-defstruct (js2-number-node
3713 (:constructor make-js2-number-node (&key (type js2-NUMBER)
3714 (pos (js2-current-token-beg))
3715 (len (- js2-ts-cursor
3716 (js2-current-token-beg)))
3717 (value (js2-current-token-string))
3718 (num-value (js2-token-number
3719 (js2-current-token)))
3720 (num-base (js2-token-number-base
3721 (js2-current-token)))
3722 (legacy-octal-p (js2-token-number-legacy-octal-p
3723 (js2-current-token))))))
3724 "AST node for a number literal."
3725 value ; the original string, e.g. "6.02e23"
3726 num-value ; the parsed number value
3727 num-base ; the number's base
3728 legacy-octal-p) ; whether the number is a legacy octal (0123 instead of 0o123)
3730 (put 'cl-struct-js2-number-node 'js2-visitor 'js2-visit-none)
3731 (put 'cl-struct-js2-number-node 'js2-printer 'js2-print-number-node)
3733 (defun js2-print-number-node (n i)
3734 (insert (js2-make-pad i)
3735 (number-to-string (js2-number-node-num-value n))))
3737 (cl-defstruct (js2-regexp-node
3740 (:constructor make-js2-regexp-node (&key (type js2-REGEXP)
3741 (pos (js2-current-token-beg))
3742 (len (- js2-ts-cursor
3743 (js2-current-token-beg)))
3745 "AST node for a regular expression literal."
3746 value ; the regexp string, without // delimiters
3747 flags) ; a string of flags, e.g. `mi'.
3749 (put 'cl-struct-js2-regexp-node 'js2-visitor 'js2-visit-none)
3750 (put 'cl-struct-js2-regexp-node 'js2-printer 'js2-print-regexp)
3752 (defun js2-print-regexp (n i)
3753 (insert (js2-make-pad i)
3755 (js2-regexp-node-value n)
3757 (if (js2-regexp-node-flags n)
3758 (insert (js2-regexp-node-flags n))))
3760 (cl-defstruct (js2-string-node
3763 (:constructor make-js2-string-node (&key (type js2-STRING)
3764 (pos (js2-current-token-beg))
3765 (len (- js2-ts-cursor
3766 (js2-current-token-beg)))
3767 (value (js2-current-token-string)))))
3769 Escape characters are not evaluated; e.g. \n is 2 chars in value field.
3770 You can tell the quote type by looking at the first character."
3771 value) ; the characters of the string, including the quotes
3773 (put 'cl-struct-js2-string-node 'js2-visitor 'js2-visit-none)
3774 (put 'cl-struct-js2-string-node 'js2-printer 'js2-print-string-node)
3776 (defun js2-print-string-node (n i)
3777 (insert (js2-make-pad i)
3778 (js2-node-string n)))
3780 (cl-defstruct (js2-template-node
3783 (:constructor make-js2-template-node (&key (type js2-TEMPLATE_HEAD)
3786 kids) ; `js2-string-node' is used for string segments, other nodes
3787 ; for substitutions inside.
3789 (put 'cl-struct-js2-template-node 'js2-visitor 'js2-visit-template)
3790 (put 'cl-struct-js2-template-node 'js2-printer 'js2-print-template)
3792 (defun js2-visit-template (n callback)
3793 (dolist (kid (js2-template-node-kids n))
3794 (js2-visit-ast kid callback)))
3796 (defun js2-print-template (n i)
3797 (insert (js2-make-pad i))
3798 (dolist (kid (js2-template-node-kids n))
3799 (if (js2-string-node-p kid)
3800 (insert (js2-node-string kid))
3801 (js2-print-ast kid))))
3803 (cl-defstruct (js2-tagged-template-node
3806 (:constructor make-js2-tagged-template-node (&key (type js2-TAGGED_TEMPLATE)
3807 beg len tag template)))
3808 "Tagged template literal."
3809 tag ; `js2-node' with the tag expression.
3810 template) ; `js2-template-node' with the template.
3812 (put 'cl-struct-js2-tagged-template-node 'js2-visitor 'js2-visit-tagged-template)
3813 (put 'cl-struct-js2-tagged-template-node 'js2-printer 'js2-print-tagged-template)
3815 (defun js2-visit-tagged-template (n callback)
3816 (js2-visit-ast (js2-tagged-template-node-tag n) callback)
3817 (js2-visit-ast (js2-tagged-template-node-template n) callback))
3819 (defun js2-print-tagged-template (n i)
3820 (insert (js2-make-pad i))
3821 (js2-print-ast (js2-tagged-template-node-tag n))
3822 (js2-print-ast (js2-tagged-template-node-template n)))
3824 (cl-defstruct (js2-array-node
3827 (:constructor make-js2-array-node (&key (type js2-ARRAYLIT)
3830 "AST node for an array literal."
3831 elems) ; list of expressions. [foo,,bar] yields a nil middle element.
3833 (put 'cl-struct-js2-array-node 'js2-visitor 'js2-visit-array-node)
3834 (put 'cl-struct-js2-array-node 'js2-printer 'js2-print-array-node)
3836 (defun js2-visit-array-node (n v)
3837 (dolist (e (js2-array-node-elems n))
3838 (js2-visit-ast e v))) ; Can be nil; e.g. [a, ,b].
3840 (defun js2-print-array-node (n i)
3841 (insert (js2-make-pad i) "[")
3842 (let ((elems (js2-array-node-elems n)))
3843 (js2-print-list elems)
3844 (when (and elems (null (car (last elems))))
3848 (cl-defstruct (js2-object-node
3851 (:constructor make-js2-object-node (&key (type js2-OBJECTLIT)
3855 "AST node for an object literal expression.
3856 `elems' is a list of `js2-object-prop-node'."
3859 (put 'cl-struct-js2-object-node 'js2-visitor 'js2-visit-object-node)
3860 (put 'cl-struct-js2-object-node 'js2-printer 'js2-print-object-node)
3862 (defun js2-visit-object-node (n v)
3863 (dolist (e (js2-object-node-elems n))
3864 (js2-visit-ast e v)))
3866 (defun js2-print-object-node (n i)
3867 (insert (js2-make-pad i) "{")
3868 (js2-print-list (js2-object-node-elems n))
3871 (cl-defstruct (js2-class-node
3872 (:include js2-object-node)
3874 (:constructor make-js2-class-node (&key (type js2-CLASS)
3876 (form 'CLASS_STATEMENT)
3878 extends len elems)))
3879 "AST node for an class expression.
3880 `elems' is a list of `js2-object-prop-node', and `extends' is an
3881 optional `js2-expr-node'"
3882 form ; CLASS_{STATEMENT|EXPRESSION}
3883 name ; class name (a `js2-node-name', or nil if anonymous)
3884 extends ; class heritage (a `js2-expr-node', or nil if none)
3887 (put 'cl-struct-js2-class-node 'js2-visitor 'js2-visit-class-node)
3888 (put 'cl-struct-js2-class-node 'js2-printer 'js2-print-class-node)
3890 (defun js2-visit-class-node (n v)
3891 (js2-visit-ast (js2-class-node-name n) v)
3892 (js2-visit-ast (js2-class-node-extends n) v)
3893 (dolist (e (js2-class-node-elems n))
3894 (js2-visit-ast e v)))
3896 (defun js2-print-class-node (n i)
3897 (let* ((pad (js2-make-pad i))
3898 (name (js2-class-node-name n))
3899 (extends (js2-class-node-extends n))
3900 (elems (js2-class-node-elems n)))
3901 (insert pad "class")
3904 (js2-print-ast name 0))
3906 (insert " extends ")
3907 (js2-print-ast extends))
3909 (dolist (elem elems)
3911 (if (js2-node-get-prop elem 'STATIC)
3912 (progn (insert (js2-make-pad (1+ i)) "static ")
3913 (js2-print-ast elem 0)) ;; TODO(sdh): indentation isn't quite right
3914 (js2-print-ast elem (1+ i))))
3915 (insert "\n" pad "}")))
3917 (cl-defstruct (js2-computed-prop-name-node
3920 (:constructor make-js2-computed-prop-name-node
3924 (pos (js2-current-token-beg))
3925 (len (- js2-ts-cursor
3926 (js2-current-token-beg))))))
3927 "AST node for a `ComputedPropertyName'."
3930 (put 'cl-struct-js2-computed-prop-name-node 'js2-visitor 'js2-visit-computed-prop-name-node)
3931 (put 'cl-struct-js2-computed-prop-name-node 'js2-printer 'js2-print-computed-prop-name-node)
3933 (defun js2-visit-computed-prop-name-node (n v)
3934 (js2-visit-ast (js2-computed-prop-name-node-expr n) v))
3936 (defun js2-print-computed-prop-name-node (n i)
3937 (insert (js2-make-pad i) "[")
3938 (js2-print-ast (js2-computed-prop-name-node-expr n) 0)
3941 (cl-defstruct (js2-object-prop-node
3942 (:include js2-infix-node)
3944 (:constructor make-js2-object-prop-node (&key (type js2-COLON)
3948 "AST node for an object literal prop:value entry.
3949 The `left' field is the property: a name node, string node,
3950 number node or expression node. The `right' field is a
3951 `js2-node' representing the initializer value. If the property
3952 is abbreviated, the node's `SHORTHAND' property is non-nil and
3953 both fields have the same value.")
3955 (put 'cl-struct-js2-object-prop-node 'js2-visitor 'js2-visit-infix-node)
3956 (put 'cl-struct-js2-object-prop-node 'js2-printer 'js2-print-object-prop-node)
3958 (defun js2-print-object-prop-node (n i)
3959 (let* ((left (js2-object-prop-node-left n))
3960 (right (js2-object-prop-node-right n)))
3961 (js2-print-ast left i)
3962 (if (not (js2-node-get-prop n 'SHORTHAND))
3965 (js2-print-ast right 0)))))
3967 (cl-defstruct (js2-method-node
3968 (:include js2-infix-node)
3970 (:constructor make-js2-method-node (&key (pos js2-ts-cursor)
3972 "AST node for a method in an object literal or a class body.
3973 The `left' field is the `js2-name-node' naming the method.
3974 The `right' field is always an anonymous `js2-function-node' with a node
3975 property `METHOD_TYPE' set to 'GET or 'SET. ")
3977 (put 'cl-struct-js2-method-node 'js2-visitor 'js2-visit-infix-node)
3978 (put 'cl-struct-js2-method-node 'js2-printer 'js2-print-method)
3980 (defun js2-print-method (n i)
3981 (let* ((pad (js2-make-pad i))
3982 (left (js2-method-node-left n))
3983 (right (js2-method-node-right n))
3984 (type (js2-node-get-prop right 'METHOD_TYPE)))
3987 (insert (cdr (assoc type '((GET . "get ")
3990 (FUNCTION . ""))))))
3991 (when (and (js2-function-node-p right)
3992 (eq 'STAR (js2-function-node-generator-type right)))
3994 (js2-print-ast left 0)
3995 (js2-print-ast right 0)))
3997 (cl-defstruct (js2-prop-get-node
3998 (:include js2-infix-node)
4000 (:constructor make-js2-prop-get-node (&key (type js2-GETPROP)
4003 "AST node for a dotted property reference, e.g. foo.bar or foo().bar")
4005 (put 'cl-struct-js2-prop-get-node 'js2-visitor 'js2-visit-prop-get-node)
4006 (put 'cl-struct-js2-prop-get-node 'js2-printer 'js2-print-prop-get-node)
4008 (defun js2-visit-prop-get-node (n v)
4009 (js2-visit-ast (js2-prop-get-node-left n) v)
4010 (js2-visit-ast (js2-prop-get-node-right n) v))
4012 (defun js2-print-prop-get-node (n i)
4013 (insert (js2-make-pad i))
4014 (js2-print-ast (js2-prop-get-node-left n) 0)
4016 (js2-print-ast (js2-prop-get-node-right n) 0))
4018 (cl-defstruct (js2-elem-get-node
4021 (:constructor make-js2-elem-get-node (&key (type js2-GETELEM)
4025 "AST node for an array index expression such as foo[bar]."
4026 target ; a `js2-node' - the expression preceding the "."
4027 element ; a `js2-node' - the expression in brackets
4028 lb ; position of left-bracket, nil if omitted
4029 rb) ; position of right-bracket, nil if omitted
4031 (put 'cl-struct-js2-elem-get-node 'js2-visitor 'js2-visit-elem-get-node)
4032 (put 'cl-struct-js2-elem-get-node 'js2-printer 'js2-print-elem-get-node)
4034 (defun js2-visit-elem-get-node (n v)
4035 (js2-visit-ast (js2-elem-get-node-target n) v)
4036 (js2-visit-ast (js2-elem-get-node-element n) v))
4038 (defun js2-print-elem-get-node (n i)
4039 (insert (js2-make-pad i))
4040 (js2-print-ast (js2-elem-get-node-target n) 0)
4042 (js2-print-ast (js2-elem-get-node-element n) 0)
4045 (cl-defstruct (js2-call-node
4048 (:constructor make-js2-call-node (&key (type js2-CALL)
4052 "AST node for a JavaScript function call."
4053 target ; a `js2-node' evaluating to the function to call
4054 args ; a Lisp list of `js2-node' arguments
4055 lp ; position of open-paren, or nil if missing
4056 rp) ; position of close-paren, or nil if missing
4058 (put 'cl-struct-js2-call-node 'js2-visitor 'js2-visit-call-node)
4059 (put 'cl-struct-js2-call-node 'js2-printer 'js2-print-call-node)
4061 (defun js2-visit-call-node (n v)
4062 (js2-visit-ast (js2-call-node-target n) v)
4063 (dolist (arg (js2-call-node-args n))
4064 (js2-visit-ast arg v)))
4066 (defun js2-print-call-node (n i)
4067 (insert (js2-make-pad i))
4068 (js2-print-ast (js2-call-node-target n) 0)
4070 (js2-print-list (js2-call-node-args n))
4073 (cl-defstruct (js2-yield-node
4076 (:constructor make-js2-yield-node (&key (type js2-YIELD)
4079 "AST node for yield statement or expression."
4080 star-p ; whether it's yield*
4081 value) ; optional: value to be yielded
4083 (put 'cl-struct-js2-yield-node 'js2-visitor 'js2-visit-yield-node)
4084 (put 'cl-struct-js2-yield-node 'js2-printer 'js2-print-yield-node)
4086 (defun js2-visit-yield-node (n v)
4087 (js2-visit-ast (js2-yield-node-value n) v))
4089 (defun js2-print-yield-node (n i)
4090 (insert (js2-make-pad i))
4092 (when (js2-yield-node-star-p n)
4094 (when (js2-yield-node-value n)
4096 (js2-print-ast (js2-yield-node-value n) 0)))
4098 (cl-defstruct (js2-paren-node
4101 (:constructor make-js2-paren-node (&key (type js2-LP)
4104 "AST node for a parenthesized expression.
4105 In particular, used when the parens are syntactically optional,
4106 as opposed to required parens such as those enclosing an if-conditional."
4109 (put 'cl-struct-js2-paren-node 'js2-visitor 'js2-visit-paren-node)
4110 (put 'cl-struct-js2-paren-node 'js2-printer 'js2-print-paren-node)
4112 (defun js2-visit-paren-node (n v)
4113 (js2-visit-ast (js2-paren-node-expr n) v))
4115 (defun js2-print-paren-node (n i)
4116 (insert (js2-make-pad i))
4118 (js2-print-ast (js2-paren-node-expr n) 0)
4121 (cl-defstruct (js2-comp-node
4122 (:include js2-scope)
4124 (:constructor make-js2-comp-node (&key (type js2-ARRAYCOMP)
4129 "AST node for an Array comprehension such as [[x,y] for (x in foo) for (y in bar)]."
4130 result ; result expression (just after left-bracket)
4131 loops ; a Lisp list of `js2-comp-loop-node'
4132 filters ; a Lisp list of guard/filter expressions
4133 form ; ARRAY, LEGACY_ARRAY or STAR_GENERATOR
4134 ; SpiderMonkey also supports "legacy generator expressions", but we dont.
4137 (put 'cl-struct-js2-comp-node 'js2-visitor 'js2-visit-comp-node)
4138 (put 'cl-struct-js2-comp-node 'js2-printer 'js2-print-comp-node)
4140 (defun js2-visit-comp-node (n v)
4141 (js2-visit-ast (js2-comp-node-result n) v)
4142 (dolist (l (js2-comp-node-loops n))
4143 (js2-visit-ast l v))
4144 (dolist (f (js2-comp-node-filters n))
4145 (js2-visit-ast f v)))
4147 (defun js2-print-comp-node (n i)
4148 (let ((pad (js2-make-pad i))
4149 (result (js2-comp-node-result n))
4150 (loops (js2-comp-node-loops n))
4151 (filters (js2-comp-node-filters n))
4152 (legacy-p (eq (js2-comp-node-form n) 'LEGACY_ARRAY))
4153 (gen-p (eq (js2-comp-node-form n) 'STAR_GENERATOR)))
4154 (insert pad (if gen-p "(" "["))
4156 (js2-print-ast result 0))
4172 (js2-print-ast result 0))
4173 (insert (if gen-p ")" "]"))))
4175 (cl-defstruct (js2-comp-loop-node
4176 (:include js2-for-in-node)
4178 (:constructor make-js2-comp-loop-node (&key (type js2-FOR)
4186 "AST subtree for each 'for (foo in bar)' loop in an array comprehension.")
4188 (put 'cl-struct-js2-comp-loop-node 'js2-visitor 'js2-visit-comp-loop)
4189 (put 'cl-struct-js2-comp-loop-node 'js2-printer 'js2-print-comp-loop)
4191 (defun js2-visit-comp-loop (n v)
4192 (js2-visit-ast (js2-comp-loop-node-iterator n) v)
4193 (js2-visit-ast (js2-comp-loop-node-object n) v))
4195 (defun js2-print-comp-loop (n _i)
4197 (when (js2-comp-loop-node-foreach-p n) (insert "each "))
4199 (js2-print-ast (js2-comp-loop-node-iterator n) 0)
4200 (insert (if (js2-comp-loop-node-forof-p n)
4202 (js2-print-ast (js2-comp-loop-node-object n) 0)
4205 (cl-defstruct (js2-empty-expr-node
4208 (:constructor make-js2-empty-expr-node (&key (type js2-EMPTY)
4209 (pos (js2-current-token-beg))
4211 "AST node for an empty expression.")
4213 (put 'cl-struct-js2-empty-expr-node 'js2-visitor 'js2-visit-none)
4214 (put 'cl-struct-js2-empty-expr-node 'js2-printer 'js2-print-none)
4216 (cl-defstruct (js2-xml-node
4217 (:include js2-block-node)
4219 (:constructor make-js2-xml-node (&key (type js2-XML)
4220 (pos (js2-current-token-beg))
4222 "AST node for initial parse of E4X literals.
4223 The kids field is a list of XML fragments, each a `js2-string-node' or
4224 a `js2-xml-js-expr-node'. Equivalent to Rhino's XmlLiteral node.")
4226 (put 'cl-struct-js2-xml-node 'js2-visitor 'js2-visit-block)
4227 (put 'cl-struct-js2-xml-node 'js2-printer 'js2-print-xml-node)
4229 (defun js2-print-xml-node (n i)
4230 (dolist (kid (js2-xml-node-kids n))
4231 (js2-print-ast kid i)))
4233 (cl-defstruct (js2-xml-js-expr-node
4234 (:include js2-xml-node)
4236 (:constructor make-js2-xml-js-expr-node (&key (type js2-XML)
4239 "AST node for an embedded JavaScript {expression} in an E4X literal.
4240 The start and end fields correspond to the curly-braces."
4241 expr) ; a `js2-expr-node' of some sort
4243 (put 'cl-struct-js2-xml-js-expr-node 'js2-visitor 'js2-visit-xml-js-expr)
4244 (put 'cl-struct-js2-xml-js-expr-node 'js2-printer 'js2-print-xml-js-expr)
4246 (defun js2-visit-xml-js-expr (n v)
4247 (js2-visit-ast (js2-xml-js-expr-node-expr n) v))
4249 (defun js2-print-xml-js-expr (n i)
4250 (insert (js2-make-pad i))
4252 (js2-print-ast (js2-xml-js-expr-node-expr n) 0)
4255 (cl-defstruct (js2-xml-dot-query-node
4256 (:include js2-infix-node)
4258 (:constructor make-js2-xml-dot-query-node (&key (type js2-DOTQUERY)
4262 "AST node for an E4X foo.(bar) filter expression.
4263 Note that the left-paren is automatically the character immediately
4264 following the dot (.) in the operator. No whitespace is permitted
4265 between the dot and the lp by the scanner."
4268 (put 'cl-struct-js2-xml-dot-query-node 'js2-visitor 'js2-visit-infix-node)
4269 (put 'cl-struct-js2-xml-dot-query-node 'js2-printer 'js2-print-xml-dot-query)
4271 (defun js2-print-xml-dot-query (n i)
4272 (insert (js2-make-pad i))
4273 (js2-print-ast (js2-xml-dot-query-node-left n) 0)
4275 (js2-print-ast (js2-xml-dot-query-node-right n) 0)
4278 (cl-defstruct (js2-xml-ref-node
4280 (:constructor nil)) ; abstract
4281 "Base type for E4X XML attribute-access or property-get expressions.
4282 Such expressions can take a variety of forms. The general syntax has
4285 - (optional) an @ (specifying an attribute access)
4286 - (optional) a namespace (a `js2-name-node') and double-colon
4287 - (required) either a `js2-name-node' or a bracketed [expression]
4289 The property-name expressions (examples: ns::name, @name) are
4290 represented as `js2-xml-prop-ref' nodes. The bracketed-expression
4291 versions (examples: ns::[name], @[name]) become `js2-xml-elem-ref' nodes.
4293 This node type (or more specifically, its subclasses) will sometimes
4294 be the right-hand child of a `js2-prop-get-node' or a
4295 `js2-infix-node' of type `js2-DOTDOT', the .. xml-descendants operator.
4296 The `js2-xml-ref-node' may also be a standalone primary expression with
4297 no explicit target, which is valid in certain expression contexts such as
4299 company..employee.(@id < 100)
4301 in this case, the @id is a `js2-xml-ref' that is part of an infix '<'
4302 expression whose parent is a `js2-xml-dot-query-node'."
4307 (defsubst js2-xml-ref-node-attr-access-p (node)
4308 "Return non-nil if this expression began with an @-token."
4309 (and (numberp (js2-xml-ref-node-at-pos node))
4310 (cl-plusp (js2-xml-ref-node-at-pos node))))
4312 (cl-defstruct (js2-xml-prop-ref-node
4313 (:include js2-xml-ref-node)
4315 (:constructor make-js2-xml-prop-ref-node (&key (type js2-REF_NAME)
4316 (pos (js2-current-token-beg))
4320 "AST node for an E4X XML [expr] property-ref expression.
4321 The JavaScript syntax is an optional @, an optional ns::, and a name.
4323 [ '@' ] [ name '::' ] name
4325 Examples include name, ns::name, ns::*, *::name, *::*, @attr, @ns::attr,
4326 @ns::*, @*::attr, @*::*, and @*.
4328 The node starts at the @ token, if present. Otherwise it starts at the
4329 namespace name. The node bounds extend through the closing right-bracket,
4330 or if it is missing due to a syntax error, through the end of the index
4334 (put 'cl-struct-js2-xml-prop-ref-node 'js2-visitor 'js2-visit-xml-prop-ref-node)
4335 (put 'cl-struct-js2-xml-prop-ref-node 'js2-printer 'js2-print-xml-prop-ref-node)
4337 (defun js2-visit-xml-prop-ref-node (n v)
4338 (js2-visit-ast (js2-xml-prop-ref-node-namespace n) v)
4339 (js2-visit-ast (js2-xml-prop-ref-node-propname n) v))
4341 (defun js2-print-xml-prop-ref-node (n i)
4342 (insert (js2-make-pad i))
4343 (if (js2-xml-ref-node-attr-access-p n)
4345 (when (js2-xml-prop-ref-node-namespace n)
4346 (js2-print-ast (js2-xml-prop-ref-node-namespace n) 0)
4348 (if (js2-xml-prop-ref-node-propname n)
4349 (js2-print-ast (js2-xml-prop-ref-node-propname n) 0)))
4351 (cl-defstruct (js2-xml-elem-ref-node
4352 (:include js2-xml-ref-node)
4354 (:constructor make-js2-xml-elem-ref-node (&key (type js2-REF_MEMBER)
4355 (pos (js2-current-token-beg))
4359 "AST node for an E4X XML [expr] member-ref expression.
4362 [ '@' ] [ name '::' ] '[' expr ']'
4364 Examples include ns::[expr], @ns::[expr], @[expr], *::[expr] and @*::[expr].
4366 Note that the form [expr] (i.e. no namespace or attribute-qualifier)
4367 is not a legal E4X XML element-ref expression, since it's already used
4368 for standard JavaScript element-get array indexing. Hence, a
4369 `js2-xml-elem-ref-node' always has either the attribute-qualifier, a
4370 non-nil namespace node, or both.
4372 The node starts at the @ token, if present. Otherwise it starts
4373 at the namespace name. The node bounds extend through the closing
4374 right-bracket, or if it is missing due to a syntax error, through the
4375 end of the index expression."
4376 expr ; the bracketed index expression
4380 (put 'cl-struct-js2-xml-elem-ref-node 'js2-visitor 'js2-visit-xml-elem-ref-node)
4381 (put 'cl-struct-js2-xml-elem-ref-node 'js2-printer 'js2-print-xml-elem-ref-node)
4383 (defun js2-visit-xml-elem-ref-node (n v)
4384 (js2-visit-ast (js2-xml-elem-ref-node-namespace n) v)
4385 (js2-visit-ast (js2-xml-elem-ref-node-expr n) v))
4387 (defun js2-print-xml-elem-ref-node (n i)
4388 (insert (js2-make-pad i))
4389 (if (js2-xml-ref-node-attr-access-p n)
4391 (when (js2-xml-elem-ref-node-namespace n)
4392 (js2-print-ast (js2-xml-elem-ref-node-namespace n) 0)
4395 (if (js2-xml-elem-ref-node-expr n)
4396 (js2-print-ast (js2-xml-elem-ref-node-expr n) 0))
4399 ;;; Placeholder nodes for when we try parsing the XML literals structurally.
4401 (cl-defstruct (js2-xml-start-tag-node
4402 (:include js2-xml-node)
4404 (:constructor make-js2-xml-start-tag-node (&key (type js2-XML)
4408 "AST node for an XML start-tag. Not currently used.
4409 The `kids' field is a Lisp list of child content nodes."
4410 name ; a `js2-xml-name-node'
4411 attrs ; a Lisp list of `js2-xml-attr-node'
4412 empty-p) ; t if this is an empty element such as <foo bar="baz"/>
4414 (put 'cl-struct-js2-xml-start-tag-node 'js2-visitor 'js2-visit-xml-start-tag)
4415 (put 'cl-struct-js2-xml-start-tag-node 'js2-printer 'js2-print-xml-start-tag)
4417 (defun js2-visit-xml-start-tag (n v)
4418 (js2-visit-ast (js2-xml-start-tag-node-name n) v)
4419 (dolist (attr (js2-xml-start-tag-node-attrs n))
4420 (js2-visit-ast attr v))
4421 (js2-visit-block n v))
4423 (defun js2-print-xml-start-tag (n i)
4424 (insert (js2-make-pad i) "<")
4425 (js2-print-ast (js2-xml-start-tag-node-name n) 0)
4426 (when (js2-xml-start-tag-node-attrs n)
4428 (js2-print-list (js2-xml-start-tag-node-attrs n) " "))
4431 ;; I -think- I'm going to make the parent node the corresponding start-tag,
4432 ;; and add the end-tag to the kids list of the parent as well.
4433 (cl-defstruct (js2-xml-end-tag-node
4434 (:include js2-xml-node)
4436 (:constructor make-js2-xml-end-tag-node (&key (type js2-XML)
4439 "AST node for an XML end-tag. Not currently used."
4440 name) ; a `js2-xml-name-node'
4442 (put 'cl-struct-js2-xml-end-tag-node 'js2-visitor 'js2-visit-xml-end-tag)
4443 (put 'cl-struct-js2-xml-end-tag-node 'js2-printer 'js2-print-xml-end-tag)
4445 (defun js2-visit-xml-end-tag (n v)
4446 (js2-visit-ast (js2-xml-end-tag-node-name n) v))
4448 (defun js2-print-xml-end-tag (n i)
4449 (insert (js2-make-pad i))
4451 (js2-print-ast (js2-xml-end-tag-node-name n) 0)
4454 (cl-defstruct (js2-xml-name-node
4455 (:include js2-xml-node)
4457 (:constructor make-js2-xml-name-node (&key (type js2-XML)
4459 len namespace kids)))
4460 "AST node for an E4X XML name. Not currently used.
4461 Any XML name can be qualified with a namespace, hence the namespace field.
4462 Further, any E4X name can be comprised of arbitrary JavaScript {} expressions.
4463 The kids field is a list of `js2-name-node' and `js2-xml-js-expr-node'.
4464 For a simple name, the kids list has exactly one node, a `js2-name-node'."
4465 namespace) ; a `js2-string-node'
4467 (put 'cl-struct-js2-xml-name-node 'js2-visitor 'js2-visit-xml-name-node)
4468 (put 'cl-struct-js2-xml-name-node 'js2-printer 'js2-print-xml-name-node)
4470 (defun js2-visit-xml-name-node (n v)
4471 (js2-visit-ast (js2-xml-name-node-namespace n) v))
4473 (defun js2-print-xml-name-node (n i)
4474 (insert (js2-make-pad i))
4475 (when (js2-xml-name-node-namespace n)
4476 (js2-print-ast (js2-xml-name-node-namespace n) 0)
4478 (dolist (kid (js2-xml-name-node-kids n))
4479 (js2-print-ast kid 0)))
4481 (cl-defstruct (js2-xml-pi-node
4482 (:include js2-xml-node)
4484 (:constructor make-js2-xml-pi-node (&key (type js2-XML)
4487 "AST node for an E4X XML processing instruction. Not currently used."
4488 name ; a `js2-xml-name-node'
4489 attrs) ; a list of `js2-xml-attr-node'
4491 (put 'cl-struct-js2-xml-pi-node 'js2-visitor 'js2-visit-xml-pi-node)
4492 (put 'cl-struct-js2-xml-pi-node 'js2-printer 'js2-print-xml-pi-node)
4494 (defun js2-visit-xml-pi-node (n v)
4495 (js2-visit-ast (js2-xml-pi-node-name n) v)
4496 (dolist (attr (js2-xml-pi-node-attrs n))
4497 (js2-visit-ast attr v)))
4499 (defun js2-print-xml-pi-node (n i)
4500 (insert (js2-make-pad i) "<?")
4501 (js2-print-ast (js2-xml-pi-node-name n))
4502 (when (js2-xml-pi-node-attrs n)
4504 (js2-print-list (js2-xml-pi-node-attrs n)))
4507 (cl-defstruct (js2-xml-cdata-node
4508 (:include js2-xml-node)
4510 (:constructor make-js2-xml-cdata-node (&key (type js2-XML)
4513 "AST node for a CDATA escape section. Not currently used."
4514 content) ; a `js2-string-node' with node-property 'quote-type 'cdata
4516 (put 'cl-struct-js2-xml-cdata-node 'js2-visitor 'js2-visit-xml-cdata-node)
4517 (put 'cl-struct-js2-xml-cdata-node 'js2-printer 'js2-print-xml-cdata-node)
4519 (defun js2-visit-xml-cdata-node (n v)
4520 (js2-visit-ast (js2-xml-cdata-node-content n) v))
4522 (defun js2-print-xml-cdata-node (n i)
4523 (insert (js2-make-pad i))
4524 (js2-print-ast (js2-xml-cdata-node-content n)))
4526 (cl-defstruct (js2-xml-attr-node
4527 (:include js2-xml-node)
4529 (:constructor make-js2-attr-node (&key (type js2-XML)
4532 eq-pos quote-type)))
4533 "AST node representing a foo='bar' XML attribute value. Not yet used."
4534 name ; a `js2-xml-name-node'
4535 value ; a `js2-xml-name-node'
4536 eq-pos ; buffer position of "=" sign
4537 quote-type) ; 'single or 'double
4539 (put 'cl-struct-js2-xml-attr-node 'js2-visitor 'js2-visit-xml-attr-node)
4540 (put 'cl-struct-js2-xml-attr-node 'js2-printer 'js2-print-xml-attr-node)
4542 (defun js2-visit-xml-attr-node (n v)
4543 (js2-visit-ast (js2-xml-attr-node-name n) v)
4544 (js2-visit-ast (js2-xml-attr-node-value n) v))
4546 (defun js2-print-xml-attr-node (n i)
4547 (let ((quote (if (eq (js2-xml-attr-node-quote-type n) 'single)
4550 (insert (js2-make-pad i))
4551 (js2-print-ast (js2-xml-attr-node-name n) 0)
4553 (js2-print-ast (js2-xml-attr-node-value n) 0)
4556 (cl-defstruct (js2-xml-text-node
4557 (:include js2-xml-node)
4559 (:constructor make-js2-text-node (&key (type js2-XML)
4562 "AST node for an E4X XML text node. Not currently used."
4563 content) ; a Lisp list of `js2-string-node' and `js2-xml-js-expr-node'
4565 (put 'cl-struct-js2-xml-text-node 'js2-visitor 'js2-visit-xml-text-node)
4566 (put 'cl-struct-js2-xml-text-node 'js2-printer 'js2-print-xml-text-node)
4568 (defun js2-visit-xml-text-node (n v)
4569 (js2-visit-ast (js2-xml-text-node-content n) v))
4571 (defun js2-print-xml-text-node (n i)
4572 (insert (js2-make-pad i))
4573 (dolist (kid (js2-xml-text-node-content n))
4574 (js2-print-ast kid)))
4576 (cl-defstruct (js2-xml-comment-node
4577 (:include js2-xml-node)
4579 (:constructor make-js2-xml-comment-node (&key (type js2-XML)
4582 "AST node for E4X XML comment. Not currently used.")
4584 (put 'cl-struct-js2-xml-comment-node 'js2-visitor 'js2-visit-none)
4585 (put 'cl-struct-js2-xml-comment-node 'js2-printer 'js2-print-xml-comment)
4587 (defun js2-print-xml-comment (n i)
4588 (insert (js2-make-pad i)
4589 (js2-node-string n)))
4593 (defsubst js2-node-line (n)
4594 "Fetch the source line number at the start of node N.
4595 This is O(n) in the length of the source buffer; use prudently."
4596 (1+ (count-lines (point-min) (js2-node-abs-pos n))))
4598 (defsubst js2-block-node-kid (n i)
4599 "Return child I of node N, or nil if there aren't that many."
4600 (nth i (js2-block-node-kids n)))
4602 (defsubst js2-block-node-first (n)
4603 "Return first child of block node N, or nil if there is none."
4604 (cl-first (js2-block-node-kids n)))
4606 (defun js2-node-root (n)
4607 "Return the root of the AST containing N.
4608 If N has no parent pointer, returns N."
4609 (let ((parent (js2-node-parent n)))
4611 (js2-node-root parent)
4614 (defsubst js2-node-short-name (n)
4615 "Return the short name of node N as a string, e.g. `js2-if-node'."
4616 (substring (symbol-name (aref n 0))
4617 (length "cl-struct-")))
4619 (defun js2-node-child-list (node)
4620 "Return the child list for NODE, a Lisp list of nodes.
4621 Works for block nodes, array nodes, obj literals, funarg lists,
4622 var decls and try nodes (for catch clauses). Note that you should call
4623 `js2-block-node-kids' on the function body for the body statements.
4624 Returns nil for zero-length child lists or unsupported nodes."
4626 ((js2-function-node-p node)
4627 (js2-function-node-params node))
4628 ((js2-block-node-p node)
4629 (js2-block-node-kids node))
4630 ((js2-try-node-p node)
4631 (js2-try-node-catch-clauses node))
4632 ((js2-array-node-p node)
4633 (js2-array-node-elems node))
4634 ((js2-object-node-p node)
4635 (js2-object-node-elems node))
4636 ((js2-call-node-p node)
4637 (js2-call-node-args node))
4638 ((js2-new-node-p node)
4639 (js2-new-node-args node))
4640 ((js2-var-decl-node-p node)
4641 (js2-var-decl-node-kids node))
4645 (defun js2-node-set-child-list (node kids)
4646 "Set the child list for NODE to KIDS."
4648 ((js2-function-node-p node)
4649 (setf (js2-function-node-params node) kids))
4650 ((js2-block-node-p node)
4651 (setf (js2-block-node-kids node) kids))
4652 ((js2-try-node-p node)
4653 (setf (js2-try-node-catch-clauses node) kids))
4654 ((js2-array-node-p node)
4655 (setf (js2-array-node-elems node) kids))
4656 ((js2-object-node-p node)
4657 (setf (js2-object-node-elems node) kids))
4658 ((js2-call-node-p node)
4659 (setf (js2-call-node-args node) kids))
4660 ((js2-new-node-p node)
4661 (setf (js2-new-node-args node) kids))
4662 ((js2-var-decl-node-p node)
4663 (setf (js2-var-decl-node-kids node) kids))
4665 (error "Unsupported node type: %s" (js2-node-short-name node))))
4668 ;; All because Common Lisp doesn't support multiple inheritance for defstructs.
4669 (defconst js2-paren-expr-nodes
4670 '(cl-struct-js2-comp-loop-node
4671 cl-struct-js2-comp-node
4672 cl-struct-js2-call-node
4673 cl-struct-js2-catch-node
4674 cl-struct-js2-do-node
4675 cl-struct-js2-elem-get-node
4676 cl-struct-js2-for-in-node
4677 cl-struct-js2-for-node
4678 cl-struct-js2-function-node
4679 cl-struct-js2-if-node
4680 cl-struct-js2-let-node
4681 cl-struct-js2-new-node
4682 cl-struct-js2-paren-node
4683 cl-struct-js2-switch-node
4684 cl-struct-js2-while-node
4685 cl-struct-js2-with-node
4686 cl-struct-js2-xml-dot-query-node)
4687 "Node types that can have a parenthesized child expression.
4688 In particular, nodes that respond to `js2-node-lp' and `js2-node-rp'.")
4690 (defsubst js2-paren-expr-node-p (node)
4691 "Return t for nodes that typically have a parenthesized child expression.
4692 Useful for computing the indentation anchors for arg-lists and conditions.
4693 Note that it may return a false positive, for instance when NODE is
4694 a `js2-new-node' and there are no arguments or parentheses."
4695 (memq (aref node 0) js2-paren-expr-nodes))
4697 ;; Fake polymorphism... yech.
4698 (defun js2-node-lp (node)
4699 "Return relative left-paren position for NODE, if applicable.
4700 For `js2-elem-get-node' structs, returns left-bracket position.
4701 Note that the position may be nil in the case of a parse error."
4703 ((js2-elem-get-node-p node)
4704 (js2-elem-get-node-lb node))
4705 ((js2-loop-node-p node)
4706 (js2-loop-node-lp node))
4707 ((js2-function-node-p node)
4708 (js2-function-node-lp node))
4709 ((js2-if-node-p node)
4710 (js2-if-node-lp node))
4711 ((js2-new-node-p node)
4712 (js2-new-node-lp node))
4713 ((js2-call-node-p node)
4714 (js2-call-node-lp node))
4715 ((js2-paren-node-p node)
4717 ((js2-switch-node-p node)
4718 (js2-switch-node-lp node))
4719 ((js2-catch-node-p node)
4720 (js2-catch-node-lp node))
4721 ((js2-let-node-p node)
4722 (js2-let-node-lp node))
4723 ((js2-comp-node-p node)
4725 ((js2-with-node-p node)
4726 (js2-with-node-lp node))
4727 ((js2-xml-dot-query-node-p node)
4728 (1+ (js2-infix-node-op-pos node)))
4730 (error "Unsupported node type: %s" (js2-node-short-name node)))))
4732 ;; Fake polymorphism... blech.
4733 (defun js2-node-rp (node)
4734 "Return relative right-paren position for NODE, if applicable.
4735 For `js2-elem-get-node' structs, returns right-bracket position.
4736 Note that the position may be nil in the case of a parse error."
4738 ((js2-elem-get-node-p node)
4739 (js2-elem-get-node-rb node))
4740 ((js2-loop-node-p node)
4741 (js2-loop-node-rp node))
4742 ((js2-function-node-p node)
4743 (js2-function-node-rp node))
4744 ((js2-if-node-p node)
4745 (js2-if-node-rp node))
4746 ((js2-new-node-p node)
4747 (js2-new-node-rp node))
4748 ((js2-call-node-p node)
4749 (js2-call-node-rp node))
4750 ((js2-paren-node-p node)
4751 (1- (js2-node-len node)))
4752 ((js2-switch-node-p node)
4753 (js2-switch-node-rp node))
4754 ((js2-catch-node-p node)
4755 (js2-catch-node-rp node))
4756 ((js2-let-node-p node)
4757 (js2-let-node-rp node))
4758 ((js2-comp-node-p node)
4759 (1- (js2-node-len node)))
4760 ((js2-with-node-p node)
4761 (js2-with-node-rp node))
4762 ((js2-xml-dot-query-node-p node)
4763 (1+ (js2-xml-dot-query-node-rp node)))
4765 (error "Unsupported node type: %s" (js2-node-short-name node)))))
4767 (defsubst js2-node-first-child (node)
4768 "Return the first element of `js2-node-child-list' for NODE."
4769 (car (js2-node-child-list node)))
4771 (defsubst js2-node-last-child (node)
4772 "Return the last element of `js2-node-last-child' for NODE."
4773 (car (last (js2-node-child-list node))))
4775 (defun js2-node-prev-sibling (node)
4776 "Return the previous statement in parent.
4777 Works for parents supported by `js2-node-child-list'.
4778 Returns nil if NODE is not in the parent, or PARENT is
4779 not a supported node, or if NODE is the first child."
4780 (let* ((p (js2-node-parent node))
4781 (kids (js2-node-child-list p))
4784 (not (eq node (cadr kids))))
4785 (setq kids (cdr kids)
4789 (defun js2-node-next-sibling (node)
4790 "Return the next statement in parent block.
4791 Returns nil if NODE is not in the block, or PARENT is not
4792 a block node, or if NODE is the last statement."
4793 (let* ((p (js2-node-parent node))
4794 (kids (js2-node-child-list p)))
4796 (not (eq node (car kids))))
4797 (setq kids (cdr kids)))
4800 (defun js2-node-find-child-before (pos parent &optional after)
4801 "Find the last child that starts before POS in parent.
4802 If AFTER is non-nil, returns first child starting after POS.
4803 POS is an absolute buffer position. PARENT is any node
4804 supported by `js2-node-child-list'.
4805 Returns nil if no applicable child is found."
4806 (let ((kids (if (js2-function-node-p parent)
4807 (js2-block-node-kids (js2-function-node-body parent))
4808 (js2-node-child-list parent)))
4809 (beg (js2-node-abs-pos (if (js2-function-node-p parent)
4810 (js2-function-node-body parent)
4814 (setq fn (if after '>= '<))
4815 (while (and kids continue)
4816 (setq kid (car kids))
4817 (if (funcall fn (+ beg (js2-node-pos kid)) pos)
4819 continue (not after))
4820 (setq continue after))
4821 (setq kids (cdr kids)))
4824 (defun js2-node-find-child-after (pos parent)
4825 "Find first child that starts after POS in parent.
4826 POS is an absolute buffer position. PARENT is any node
4827 supported by `js2-node-child-list'.
4828 Returns nil if no applicable child is found."
4829 (js2-node-find-child-before pos parent 'after))
4831 (defun js2-node-replace-child (pos parent new-node)
4832 "Replace node at index POS in PARENT with NEW-NODE.
4833 Only works for parents supported by `js2-node-child-list'."
4834 (let ((kids (js2-node-child-list parent))
4837 (setq kids (cdr kids)
4839 (setcar kids new-node)
4840 (js2-node-add-children parent new-node)))
4842 (defun js2-node-buffer (n)
4843 "Return the buffer associated with AST N.
4844 Returns nil if the buffer is not set as a property on the root
4845 node, or if parent links were not recorded during parsing."
4846 (let ((root (js2-node-root n)))
4848 (js2-ast-root-p root)
4849 (js2-ast-root-buffer root))))
4851 (defun js2-block-node-push (n kid)
4852 "Push js2-node KID onto the end of js2-block-node N's child list.
4853 KID is always added to the -end- of the kids list.
4854 Function also calls `js2-node-add-children' to add the parent link."
4855 (let ((kids (js2-node-child-list n)))
4857 (setcdr kids (nconc (cdr kids) (list kid)))
4858 (js2-node-set-child-list n (list kid)))
4859 (js2-node-add-children n kid)))
4861 (defun js2-node-string (node)
4862 (with-current-buffer (or (js2-node-buffer node)
4863 (error "No buffer available for node %s" node))
4864 (let ((pos (js2-node-abs-pos node)))
4865 (buffer-substring-no-properties pos (+ pos (js2-node-len node))))))
4867 ;; Container for storing the node we're looking for in a traversal.
4868 (js2-deflocal js2-discovered-node nil)
4870 ;; Keep track of absolute node position during traversals.
4871 (js2-deflocal js2-visitor-offset nil)
4873 (js2-deflocal js2-node-search-point nil)
4875 (when js2-mode-dev-mode-p
4876 (defun js2-find-node-at-point ()
4878 (let ((node (js2-node-at-point)))
4879 (message "%s" (or node "No node found at point"))))
4880 (defun js2-node-name-at-point ()
4882 (let ((node (js2-node-at-point)))
4883 (message "%s" (if node
4884 (js2-node-short-name node)
4885 "No node found at point.")))))
4887 (defun js2-node-at-point (&optional pos skip-comments)
4888 "Return AST node at POS, a buffer position, defaulting to current point.
4889 The `js2-mode-ast' variable must be set to the current parse tree.
4890 Signals an error if the AST (`js2-mode-ast') is nil.
4891 Always returns a node - if it can't find one, it returns the root.
4892 If SKIP-COMMENTS is non-nil, comment nodes are ignored."
4893 (let ((ast js2-mode-ast)
4896 (error "No JavaScript AST available"))
4897 ;; Look through comments first, since they may be inside nodes that
4898 ;; would otherwise report a match.
4899 (setq pos (or pos (point))
4900 result (if (> pos (js2-node-abs-end ast))
4902 (if (not skip-comments)
4903 (js2-comment-at-point pos))))
4905 (setq js2-discovered-node nil
4906 js2-visitor-offset 0
4907 js2-node-search-point pos)
4909 (catch 'js2-visit-done
4910 (js2-visit-ast ast #'js2-node-at-point-visitor))
4911 (setq js2-visitor-offset nil
4912 js2-node-search-point nil))
4913 (setq result js2-discovered-node))
4914 ;; may have found a comment beyond end of last child node,
4915 ;; since visiting the ast-root looks at the comment-list last.
4916 (if (and skip-comments
4917 (js2-comment-node-p result))
4919 (or result js2-mode-ast)))
4921 (defun js2-node-at-point-visitor (node end-p)
4922 (let ((rel-pos (js2-node-pos node))
4925 (point js2-node-search-point))
4928 ;; this evaluates to a non-nil return value, even if it's zero
4929 (cl-decf js2-visitor-offset rel-pos))
4930 ;; we already looked for comments before visiting, and don't want them now
4931 ((js2-comment-node-p node)
4934 (setq abs-pos (cl-incf js2-visitor-offset rel-pos)
4935 ;; we only want to use the node if the point is before
4936 ;; the last character position in the node, so we decrement
4937 ;; the absolute end by 1.
4938 abs-end (+ abs-pos (js2-node-len node) -1))
4940 ;; If this node starts after search-point, stop the search.
4942 (throw 'js2-visit-done nil))
4943 ;; If this node ends before the search-point, don't check kids.
4947 ;; Otherwise point is within this node, possibly in a child.
4948 (setq js2-discovered-node node)
4949 t)))))) ; keep processing kids to look for more specific match
4951 (defsubst js2-block-comment-p (node)
4952 "Return non-nil if NODE is a comment node of format `jsdoc' or `block'."
4953 (and (js2-comment-node-p node)
4954 (memq (js2-comment-node-format node) '(jsdoc block))))
4956 ;; TODO: put the comments in a vector and binary-search them instead
4957 (defun js2-comment-at-point (&optional pos)
4958 "Look through scanned comment nodes for one containing POS.
4959 POS is a buffer position that defaults to current point.
4960 Function returns nil if POS was not in any comment node."
4961 (let ((ast js2-mode-ast)
4962 (x (or pos (point)))
4965 (error "No JavaScript AST available"))
4967 ;; Comments are stored in lexical order.
4968 (dolist (comment (js2-ast-root-comments ast) nil)
4969 (setq beg (js2-node-abs-pos comment)
4970 end (+ beg (js2-node-len comment)))
4973 (throw 'done comment))))))
4975 (defun js2-mode-find-parent-fn (node)
4976 "Find function enclosing NODE.
4977 Returns nil if NODE is not inside a function."
4978 (setq node (js2-node-parent node))
4979 (while (and node (not (js2-function-node-p node)))
4980 (setq node (js2-node-parent node)))
4981 (and (js2-function-node-p node) node))
4983 (defun js2-mode-find-enclosing-fn (node)
4984 "Find function or root enclosing NODE."
4985 (if (js2-ast-root-p node)
4987 (setq node (js2-node-parent node))
4988 (while (not (or (js2-ast-root-p node)
4989 (js2-function-node-p node)))
4990 (setq node (js2-node-parent node)))
4993 (defun js2-mode-find-enclosing-node (beg end)
4994 "Find node fully enclosing BEG and END."
4995 (let ((node (js2-node-at-point beg))
4999 (if (or (js2-ast-root-p node)
5001 (<= (setq pos (js2-node-abs-pos node)) beg)
5002 (>= (+ pos (js2-node-len node)) end)))
5004 (setq node (js2-node-parent node))))
5007 (defun js2-node-parent-script-or-fn (node)
5008 "Find script or function immediately enclosing NODE.
5009 If NODE is the ast-root, returns nil."
5010 (if (js2-ast-root-p node)
5012 (setq node (js2-node-parent node))
5013 (while (and node (not (or (js2-function-node-p node)
5014 (js2-script-node-p node))))
5015 (setq node (js2-node-parent node)))
5018 (defun js2-node-is-descendant (node ancestor)
5019 "Return t if NODE is a descendant of ANCESTOR."
5021 (not (eq node ancestor)))
5022 (setq node (js2-node-parent node)))
5025 ;;; visitor infrastructure
5027 (defun js2-visit-none (_node _callback)
5028 "Visitor for AST node that have no node children."
5031 (defun js2-print-none (_node _indent)
5032 "Visitor for AST node with no printed representation.")
5034 (defun js2-print-body (node indent)
5035 "Print a statement, or a block without braces."
5036 (if (js2-block-node-p node)
5037 (dolist (kid (js2-block-node-kids node))
5038 (js2-print-ast kid indent))
5039 (js2-print-ast node indent)))
5041 (defun js2-print-list (args &optional delimiter)
5042 (cl-loop with len = (length args)
5046 (when arg (js2-print-ast arg 0))
5048 (insert (or delimiter ", ")))))
5050 (defun js2-print-tree (ast)
5051 "Prints an AST to the current buffer.
5052 Makes `js2-ast-parent-nodes' available to the printer functions."
5053 (let ((max-lisp-eval-depth (max max-lisp-eval-depth 1500)))
5054 (js2-print-ast ast)))
5056 (defun js2-print-ast (node &optional indent)
5057 "Helper function for printing AST nodes.
5058 Requires `js2-ast-parent-nodes' to be non-nil.
5059 You should use `js2-print-tree' instead of this function."
5060 (let ((printer (get (aref node 0) 'js2-printer))
5062 ;; TODO: wedge comments in here somewhere
5064 (funcall printer node i))))
5066 (defconst js2-side-effecting-tokens
5067 (let ((tokens (make-bool-vector js2-num-tokens nil)))
5068 (dolist (tt (list js2-ASSIGN
5138 (if js2-instanceof-has-side-effects
5139 (aset tokens js2-INSTANCEOF t))
5142 (defun js2-node-has-side-effects (node)
5143 "Return t if NODE has side effects."
5144 (when node ; makes it easier to handle malformed expressions
5145 (let ((tt (js2-node-type node)))
5147 ;; This doubtless needs some work, since EXPR_VOID is used
5148 ;; in several ways in Rhino and I may not have caught them all.
5149 ;; I'll wait for people to notice incorrect warnings.
5150 ((and (= tt js2-EXPR_VOID)
5151 (js2-expr-stmt-node-p node)) ; but not if EXPR_RESULT
5152 (let ((expr (js2-expr-stmt-node-expr node)))
5153 (or (js2-node-has-side-effects expr)
5154 (when (js2-string-node-p expr)
5155 (member (js2-string-node-value expr) '("use strict" "use asm"))))))
5157 (js2-node-has-side-effects (js2-unary-node-operand node)))
5159 (js2-node-has-side-effects (js2-infix-node-right node)))
5162 (or (js2-node-has-side-effects (js2-infix-node-right node))
5163 (js2-node-has-side-effects (js2-infix-node-left node))))
5165 (and (js2-node-has-side-effects (js2-cond-node-true-expr node))
5166 (js2-node-has-side-effects (js2-cond-node-false-expr node))))
5167 ((js2-paren-node-p node)
5168 (js2-node-has-side-effects (js2-paren-node-expr node)))
5169 ((= tt js2-ERROR) ; avoid cascaded error messages
5172 (aref js2-side-effecting-tokens tt))))))
5174 (defconst js2-stmt-node-types
5178 js2-DEFAULT ; e4x "default xml namespace" statement
5192 "Node types that only appear in statement contexts.
5193 The list does not include nodes that always appear as the child
5194 of another specific statement type, such as switch-cases,
5195 catch and finally blocks, and else-clauses. The list also excludes
5196 nodes like yield, let and var, which may appear in either expression
5197 or statement context, and in the latter context always have a
5198 `js2-expr-stmt-node' parent. Finally, the list does not include
5199 functions or scripts, which are treated separately from statements
5200 by the JavaScript parser and runtime.")
5202 (defun js2-stmt-node-p (node)
5203 "Heuristic for figuring out if NODE is a statement.
5204 Some node types can appear in either an expression context or a
5205 statement context, e.g. let-nodes, yield-nodes, and var-decl nodes.
5206 For these node types in a statement context, the parent will be a
5207 `js2-expr-stmt-node'.
5208 Functions aren't included in the check."
5209 (memq (js2-node-type node) js2-stmt-node-types))
5211 (defun js2-mode-find-first-stmt (node)
5212 "Search upward starting from NODE looking for a statement.
5213 For purposes of this function, a `js2-function-node' counts."
5214 (while (not (or (js2-stmt-node-p node)
5215 (js2-function-node-p node)))
5216 (setq node (js2-node-parent node)))
5219 (defun js2-node-parent-stmt (node)
5220 "Return the node's first ancestor that is a statement.
5221 Returns nil if NODE is a `js2-ast-root'. Note that any expression
5222 appearing in a statement context will have a parent that is a
5223 `js2-expr-stmt-node' that will be returned by this function."
5224 (let ((parent (js2-node-parent node)))
5225 (if (or (null parent)
5226 (js2-stmt-node-p parent)
5227 (and (js2-function-node-p parent)
5228 (not (eq (js2-function-node-form parent)
5229 'FUNCTION_EXPRESSION))))
5231 (js2-node-parent-stmt parent))))
5233 ;; In the Mozilla Rhino sources, Roshan James writes:
5234 ;; Does consistent-return analysis on the function body when strict mode is
5237 ;; function (x) { return (x+1) }
5241 ;; function (x) { if (x < 0) return (x+1); }
5243 ;; is not because the function can potentially return a value when the
5244 ;; condition is satisfied and if not, the function does not explicitly
5247 ;; This extends to checking mismatches such as "return" and "return <value>"
5248 ;; used in the same function. Warnings are not emitted if inconsistent
5249 ;; returns exist in code that can be statically shown to be unreachable.
5251 ;; function (x) { while (true) { ... if (..) { return value } ... } }
5253 ;; emits no warning. However if the loop had a break statement, then a
5254 ;; warning would be emitted.
5256 ;; The consistency analysis looks at control structures such as loops, ifs,
5257 ;; switch, try-catch-finally blocks, examines the reachable code paths and
5258 ;; warns the user about an inconsistent set of termination possibilities.
5260 ;; These flags enumerate the possible ways a statement/function can
5261 ;; terminate. These flags are used by endCheck() and by the Parser to
5262 ;; detect inconsistent return usage.
5264 ;; END_UNREACHED is reserved for code paths that are assumed to always be
5265 ;; able to execute (example: throw, continue)
5267 ;; END_DROPS_OFF indicates if the statement can transfer control to the
5268 ;; next one. Statement such as return dont. A compound statement may have
5269 ;; some branch that drops off control to the next statement.
5271 ;; END_RETURNS indicates that the statement can return with no value.
5272 ;; END_RETURNS_VALUE indicates that the statement can return a value.
5274 ;; A compound statement such as
5278 ;; Will be detected as (END_DROPS_OFF | END_RETURN_VALUE) by endCheck()
5280 (defconst js2-END_UNREACHED 0)
5281 (defconst js2-END_DROPS_OFF 1)
5282 (defconst js2-END_RETURNS 2)
5283 (defconst js2-END_RETURNS_VALUE 4)
5284 (defconst js2-END_YIELDS 8)
5286 (defun js2-has-consistent-return-usage (node)
5287 "Check that every return usage in a function body is consistent.
5288 Returns t if the function satisfies strict mode requirement."
5289 (let ((n (js2-end-check node)))
5290 ;; either it doesn't return a value in any branch...
5291 (or (js2-flag-not-set-p n js2-END_RETURNS_VALUE)
5292 ;; or it returns a value (or is unreached) at every branch
5293 (js2-flag-not-set-p n (logior js2-END_DROPS_OFF
5297 (defun js2-end-check-if (node)
5298 "Ensure that return usage in then/else blocks is consistent.
5299 If there is no else block, then the return statement can fall through.
5300 Returns logical OR of END_* flags"
5301 (let ((th (js2-if-node-then-part node))
5302 (el (js2-if-node-else-part node)))
5305 (logior (js2-end-check th) (if el
5307 js2-END_DROPS_OFF)))))
5309 (defun js2-end-check-switch (node)
5310 "Consistency of return statements is checked between the case statements.
5311 If there is no default, then the switch can fall through. If there is a
5312 default, we check to see if all code paths in the default return or if
5313 there is a code path that can fall through.
5314 Returns logical OR of END_* flags."
5315 (let ((rv js2-END_UNREACHED)
5317 ;; examine the cases
5319 (dolist (c (js2-switch-node-cases node))
5320 (if (js2-case-node-expr c)
5321 (js2-set-flag rv (js2-end-check-block c))
5322 (setq default-case c)
5323 (throw 'break nil))))
5324 ;; we don't care how the cases drop into each other
5325 (js2-clear-flag rv js2-END_DROPS_OFF)
5326 ;; examine the default
5327 (js2-set-flag rv (if default-case
5328 (js2-end-check default-case)
5332 (defun js2-end-check-try (node)
5333 "If the block has a finally, return consistency is checked in the
5334 finally block. If all code paths in the finally return, then the
5335 returns in the try-catch blocks don't matter. If there is a code path
5336 that does not return or if there is no finally block, the returns
5337 of the try and catch blocks are checked for mismatch.
5338 Returns logical OR of END_* flags."
5339 (let ((finally (js2-try-node-finally-block node))
5341 ;; check the finally if it exists
5342 (setq rv (if finally
5343 (js2-end-check (js2-finally-node-body finally))
5345 ;; If the finally block always returns, then none of the returns
5346 ;; in the try or catch blocks matter.
5347 (when (js2-flag-set-p rv js2-END_DROPS_OFF)
5348 (js2-clear-flag rv js2-END_DROPS_OFF)
5349 ;; examine the try block
5350 (js2-set-flag rv (js2-end-check (js2-try-node-try-block node)))
5351 ;; check each catch block
5352 (dolist (cb (js2-try-node-catch-clauses node))
5353 (js2-set-flag rv (js2-end-check cb))))
5356 (defun js2-end-check-loop (node)
5357 "Return statement in the loop body must be consistent.
5358 The default assumption for any kind of a loop is that it will eventually
5359 terminate. The only exception is a loop with a constant true condition.
5360 Code that follows such a loop is examined only if one can determine
5361 statically that there is a break out of the loop.
5363 for(... ; ... ; ...) {}
5368 Returns logical OR of END_* flags."
5369 (let ((rv (js2-end-check (js2-loop-node-body node)))
5371 ((js2-while-node-p node)
5372 (js2-while-node-condition node))
5373 ((js2-do-node-p node)
5374 (js2-do-node-condition node))
5375 ((js2-for-node-p node)
5376 (js2-for-node-condition node)))))
5378 ;; check to see if the loop condition is always true
5380 (eq (js2-always-defined-boolean-p condition) 'ALWAYS_TRUE))
5381 (js2-clear-flag rv js2-END_DROPS_OFF))
5383 ;; look for effect of breaks
5384 (js2-set-flag rv (js2-node-get-prop node
5389 (defun js2-end-check-block (node)
5390 "A general block of code is examined statement by statement.
5391 If any statement (even a compound one) returns in all branches, then
5392 subsequent statements are not examined.
5393 Returns logical OR of END_* flags."
5394 (let* ((rv js2-END_DROPS_OFF)
5395 (kids (js2-block-node-kids node))
5397 ;; Check each statement. If the statement can continue onto the next
5398 ;; one (i.e. END_DROPS_OFF is set), then check the next statement.
5399 (while (and n (js2-flag-set-p rv js2-END_DROPS_OFF))
5400 (js2-clear-flag rv js2-END_DROPS_OFF)
5401 (js2-set-flag rv (js2-end-check n))
5402 (setq kids (cdr kids)
5406 (defun js2-end-check-label (node)
5407 "A labeled statement implies that there may be a break to the label.
5408 The function processes the labeled statement and then checks the
5409 CONTROL_BLOCK_PROP property to see if there is ever a break to the
5411 Returns logical OR of END_* flags."
5412 (let ((rv (js2-end-check (js2-labeled-stmt-node-stmt node))))
5413 (logior rv (js2-node-get-prop node
5415 js2-END_UNREACHED))))
5417 (defun js2-end-check-break (node)
5418 "When a break is encountered annotate the statement being broken
5419 out of by setting its CONTROL_BLOCK_PROP property.
5420 Returns logical OR of END_* flags."
5421 (and (js2-break-node-target node)
5422 (js2-node-set-prop (js2-break-node-target node)
5427 (defun js2-end-check (node)
5428 "Examine the body of a function, doing a basic reachability analysis.
5429 Returns a combination of flags END_* flags that indicate
5430 how the function execution can terminate. These constitute only the
5431 pessimistic set of termination conditions. It is possible that at
5432 runtime certain code paths will never be actually taken. Hence this
5433 analysis will flag errors in cases where there may not be errors.
5434 Returns logical OR of END_* flags"
5437 ((js2-break-node-p node)
5438 (js2-end-check-break node))
5439 ((js2-expr-stmt-node-p node)
5440 (if (setq kid (js2-expr-stmt-node-expr node))
5443 ((or (js2-continue-node-p node)
5444 (js2-throw-node-p node))
5446 ((js2-return-node-p node)
5447 (if (setq kid (js2-return-node-retval node))
5448 js2-END_RETURNS_VALUE
5450 ((js2-loop-node-p node)
5451 (js2-end-check-loop node))
5452 ((js2-switch-node-p node)
5453 (js2-end-check-switch node))
5454 ((js2-labeled-stmt-node-p node)
5455 (js2-end-check-label node))
5456 ((js2-if-node-p node)
5457 (js2-end-check-if node))
5458 ((js2-try-node-p node)
5459 (js2-end-check-try node))
5460 ((js2-block-node-p node)
5461 (if (null (js2-block-node-kids node))
5463 (js2-end-check-block node)))
5464 ((js2-yield-node-p node)
5467 js2-END_DROPS_OFF))))
5469 (defun js2-always-defined-boolean-p (node)
5470 "Check if NODE always evaluates to true or false in boolean context.
5471 Returns 'ALWAYS_TRUE, 'ALWAYS_FALSE, or nil if it's neither always true
5473 (let ((tt (js2-node-type node))
5476 ((or (= tt js2-FALSE) (= tt js2-NULL))
5481 (setq num (js2-number-node-num-value node))
5482 (if (and (not (eq num 0.0e+NaN))
5489 ;;; Scanner -- a port of Mozilla Rhino's lexer.
5490 ;; Corresponds to Rhino files Token.java and TokenStream.java.
5492 (defvar js2-tokens nil
5493 "List of all defined token names.") ; initialized in `js2-token-names'
5495 (defconst js2-token-names
5496 (let* ((names (make-vector js2-num-tokens -1))
5497 (case-fold-search nil) ; only match js2-UPPER_CASE
5498 (syms (apropos-internal "^js2-\\(?:[[:upper:]_]+\\)")))
5499 (cl-loop for sym in syms
5502 (unless (or (memq sym '(js2-EOF_CHAR js2-ERROR))
5504 (aset names (symbol-value sym) ; code, e.g. 152
5506 (substring (symbol-name sym) 4))) ; name, e.g. "let"
5507 (push sym js2-tokens)))
5509 "Vector mapping int values to token string names, sans `js2-' prefix.")
5511 (defun js2-tt-name (tok)
5512 "Return a string name for TOK, a token symbol or code.
5513 Signals an error if it's not a recognized token."
5516 (setq code (symbol-value tok)))
5519 (if (and (numberp code)
5520 (not (cl-minusp code))
5521 (< code js2-num-tokens))
5522 (aref js2-token-names code)
5523 (error "Invalid token: %s" code)))))
5525 (defsubst js2-tt-sym (tok)
5526 "Return symbol for TOK given its code, e.g. 'js2-LP for code 86."
5527 (intern (js2-tt-name tok)))
5529 (defconst js2-token-codes
5530 (let ((table (make-hash-table :test 'eq :size 256)))
5531 (cl-loop for name across js2-token-names
5532 for sym = (intern (concat "js2-" (upcase name)))
5534 (puthash sym (symbol-value sym) table))
5535 ;; clean up a few that are "wrong" in Rhino's token codes
5536 (puthash 'js2-DELETE js2-DELPROP table)
5538 "Hashtable mapping token type symbols to their bytecodes.")
5540 (defsubst js2-tt-code (sym)
5541 "Return code for token symbol SYM, e.g. 86 for 'js2-LP."
5542 (or (gethash sym js2-token-codes)
5543 (error "Invalid token symbol: %s " sym))) ; signal code bug
5545 (defun js2-report-scan-error (msg &optional no-throw beg len)
5546 (setf (js2-token-end (js2-current-token)) js2-ts-cursor)
5547 (js2-report-error msg nil
5548 (or beg (js2-current-token-beg))
5549 (or len (js2-current-token-len)))
5551 (throw 'return js2-ERROR)))
5553 (defun js2-set-string-from-buffer (token)
5554 "Set `string' and `end' slots for TOKEN, return the string."
5555 (setf (js2-token-end token) js2-ts-cursor
5556 (js2-token-string token) (js2-collect-string js2-ts-string-buffer)))
5558 ;; TODO: could potentially avoid a lot of consing by allocating a
5559 ;; char buffer the way Rhino does.
5560 (defsubst js2-add-to-string (c)
5561 (push c js2-ts-string-buffer))
5563 ;; Note that when we "read" the end-of-file, we advance js2-ts-cursor
5564 ;; to (1+ (point-max)), which lets the scanner treat end-of-file like
5565 ;; any other character: when it's not part of the current token, we
5566 ;; unget it, allowing it to be read again by the following call.
5567 (defsubst js2-unget-char ()
5568 (cl-decf js2-ts-cursor))
5570 ;; Rhino distinguishes \r and \n line endings. We don't need to
5571 ;; because we only scan from Emacs buffers, which always use \n.
5572 (defun js2-get-char ()
5573 "Read and return the next character from the input buffer.
5574 Increments `js2-ts-lineno' if the return value is a newline char.
5575 Updates `js2-ts-cursor' to the point after the returned char.
5576 Returns `js2-EOF_CHAR' if we hit the end of the buffer.
5577 Also updates `js2-ts-hit-eof' and `js2-ts-line-start' as needed."
5579 ;; check for end of buffer
5580 (if (>= js2-ts-cursor (point-max))
5581 (setq js2-ts-hit-eof t
5582 js2-ts-cursor (1+ js2-ts-cursor)
5583 c js2-EOF_CHAR) ; return value
5584 ;; otherwise read next char
5585 (setq c (char-before (cl-incf js2-ts-cursor)))
5586 ;; if we read a newline, update counters
5588 (setq js2-ts-line-start js2-ts-cursor
5589 js2-ts-lineno (1+ js2-ts-lineno)))
5590 ;; TODO: skip over format characters
5593 (defun js2-read-unicode-escape ()
5594 "Read a \\uNNNN sequence from the input.
5595 Assumes the ?\ and ?u have already been read.
5596 Returns the unicode character, or nil if it wasn't a valid character.
5597 Doesn't change the values of any scanner variables."
5598 ;; I really wish I knew a better way to do this, but I can't
5599 ;; find the Emacs function that takes a 16-bit int and converts
5600 ;; it to a Unicode/utf-8 character. So I basically eval it with (read).
5601 ;; Have to first check that it's 4 hex characters or it may stop
5604 (let ((s (buffer-substring-no-properties js2-ts-cursor
5605 (+ 4 js2-ts-cursor))))
5606 (if (string-match "[0-9a-fA-F]\\{4\\}" s)
5607 (read (concat "?\\u" s))))))
5609 (defun js2-match-char (test)
5610 "Consume and return next character if it matches TEST, a character.
5611 Returns nil and consumes nothing if TEST is not the next character."
5612 (let ((c (js2-get-char)))
5618 (defun js2-peek-char ()
5623 (defun js2-identifier-start-p (c)
5624 "Is C a valid start to an ES5 Identifier?
5625 See http://es5.github.io/#x7.6"
5628 (memq (get-char-code-property c 'general-category)
5630 '(Lu Ll Lt Lm Lo Nl))))
5632 (defun js2-identifier-part-p (c)
5633 "Is C a valid part of an ES5 Identifier?
5634 See http://es5.github.io/#x7.6"
5636 (memq c '(?$ ?_ ?\u200c ?\u200d))
5637 (memq (get-char-code-property c 'general-category)
5644 ;; Connector Punctuation
5647 (defun js2-alpha-p (c)
5648 (cond ((and (<= ?A c) (<= c ?Z)) t)
5649 ((and (<= ?a c) (<= c ?z)) t)
5652 (defsubst js2-digit-p (c)
5653 (and (<= ?0 c) (<= c ?9)))
5655 (defun js2-js-space-p (c)
5657 (memq c '(#x20 #x9 #xB #xC #xD))
5660 ;; TODO: change this nil to check for Unicode space character
5663 (defconst js2-eol-chars (list js2-EOF_CHAR ?\n ?\r))
5665 (defun js2-skip-line ()
5666 "Skip to end of line."
5667 (while (not (memq (js2-get-char) js2-eol-chars)))
5669 (setf (js2-token-end (js2-current-token)) js2-ts-cursor))
5671 (defun js2-init-scanner (&optional buf line)
5672 "Create token stream for BUF starting on LINE.
5673 BUF defaults to `current-buffer' and LINE defaults to 1.
5675 A buffer can only have one scanner active at a time, which yields
5676 dramatically simpler code than using a defstruct. If you need to
5677 have simultaneous scanners in a buffer, copy the regions to scan
5679 (with-current-buffer (or buf (current-buffer))
5680 (setq js2-ts-dirty-line nil
5683 js2-ts-lineno (or line 1)
5684 js2-ts-line-end-char -1
5685 js2-ts-cursor (point-min)
5686 js2-ti-tokens (make-vector js2-ti-ntokens nil)
5687 js2-ti-tokens-cursor 0
5689 js2-ts-is-xml-attribute nil
5690 js2-ts-xml-is-tag-content nil
5691 js2-ts-xml-open-tags-count 0
5692 js2-ts-string-buffer nil)))
5694 ;; This function uses the cached op, string and number fields in
5695 ;; TokenStream; if getToken has been called since the passed token
5696 ;; was scanned, the op or string printed may be incorrect.
5697 (defun js2-token-to-string (token)
5698 ;; Not sure where this function is used in Rhino. Not tested.
5699 (if (not js2-debug-print-trees)
5701 (let ((name (js2-tt-name token)))
5703 ((memq token '(js2-STRING js2-REGEXP js2-NAME
5704 js2-TEMPLATE_HEAD js2-NO_SUBS_TEMPLATE))
5705 (concat name " `" (js2-current-token-string) "'"))
5706 ((eq token js2-NUMBER)
5707 (format "NUMBER %g" (js2-token-number (js2-current-token))))
5711 (defconst js2-keywords
5713 case catch class const continue
5714 debugger default delete do
5716 false finally for function
5717 if in instanceof import
5722 this throw true try typeof
5727 ;; Token names aren't exactly the same as the keywords, unfortunately.
5728 ;; E.g. delete is js2-DELPROP.
5729 (defconst js2-kwd-tokens
5730 (let ((table (make-vector js2-num-tokens nil))
5733 js2-CASE js2-CATCH js2-CLASS js2-CONST js2-CONTINUE
5734 js2-DEBUGGER js2-DEFAULT js2-DELPROP js2-DO
5736 js2-ELSE js2-EXTENDS js2-EXPORT
5737 js2-FALSE js2-FINALLY js2-FOR js2-FUNCTION
5738 js2-IF js2-IN js2-INSTANCEOF js2-IMPORT
5742 js2-SUPER js2-SWITCH
5743 js2-THIS js2-THROW js2-TRUE js2-TRY js2-TYPEOF
5748 (aset table i 'font-lock-keyword-face))
5749 (aset table js2-STRING 'font-lock-string-face)
5750 (aset table js2-REGEXP 'font-lock-string-face)
5751 (aset table js2-NO_SUBS_TEMPLATE 'font-lock-string-face)
5752 (aset table js2-TEMPLATE_HEAD 'font-lock-string-face)
5753 (aset table js2-COMMENT 'font-lock-comment-face)
5754 (aset table js2-THIS 'font-lock-builtin-face)
5755 (aset table js2-SUPER 'font-lock-builtin-face)
5756 (aset table js2-VOID 'font-lock-constant-face)
5757 (aset table js2-NULL 'font-lock-constant-face)
5758 (aset table js2-TRUE 'font-lock-constant-face)
5759 (aset table js2-FALSE 'font-lock-constant-face)
5760 (aset table js2-NOT 'font-lock-negation-char-face)
5762 "Vector whose values are non-nil for tokens that are keywords.
5763 The values are default faces to use for highlighting the keywords.")
5765 ;; FIXME: Support strict mode-only future reserved words, after we know
5766 ;; which parts scopes are in strict mode, and which are not.
5767 (defconst js2-reserved-words '(class enum export extends import static super)
5768 "Future reserved keywords in ECMAScript 5.1.")
5770 (defconst js2-keyword-names
5771 (let ((table (make-hash-table :test 'equal)))
5772 (cl-loop for k in js2-keywords
5774 (symbol-name k) ; instanceof
5775 (intern (concat "js2-"
5776 (upcase (symbol-name k)))) ; js2-INSTANCEOF
5779 "JavaScript keywords by name, mapped to their symbols.")
5781 (defconst js2-reserved-word-names
5782 (let ((table (make-hash-table :test 'equal)))
5783 (cl-loop for k in js2-reserved-words
5785 (puthash (symbol-name k) 'js2-RESERVED table))
5787 "JavaScript reserved words by name, mapped to 'js2-RESERVED.")
5789 (defun js2-collect-string (buf)
5790 "Convert BUF, a list of chars, to a string.
5791 Reverses BUF before converting."
5793 (apply #'string (nreverse buf))
5796 (defun js2-string-to-keyword (s)
5797 "Return token for S, a string, if S is a keyword or reserved word.
5798 Returns a symbol such as 'js2-BREAK, or nil if not keyword/reserved."
5799 (or (gethash s js2-keyword-names)
5800 (gethash s js2-reserved-word-names)))
5802 (defsubst js2-ts-set-char-token-bounds (token)
5803 "Used when next token is one character."
5804 (setf (js2-token-beg token) (1- js2-ts-cursor)
5805 (js2-token-end token) js2-ts-cursor))
5807 (defsubst js2-ts-return (token type)
5808 "Update the `end' and `type' slots of TOKEN,
5809 then throw `return' with value TYPE."
5810 (setf (js2-token-end token) js2-ts-cursor
5811 (js2-token-type token) type)
5812 (throw 'return type))
5814 (defun js2-x-digit-to-int (c accumulator)
5815 "Build up a hex number.
5816 If C is a hexadecimal digit, return ACCUMULATOR * 16 plus
5817 corresponding number. Otherwise return -1."
5820 ;; Use 0..9 < A..Z < a..z
5825 (throw 'check nil)))
5828 (cl-decf c (- ?A 10))
5829 (throw 'check nil)))
5832 (cl-decf c (- ?a 10))
5833 (throw 'check nil))))
5835 (logior c (lsh accumulator 4))))
5837 (defun js2-get-token (&optional modifier)
5838 "If `js2-ti-lookahead' is zero, call scanner to get new token.
5839 Otherwise, move `js2-ti-tokens-cursor' and return the type of
5842 This function will not return a newline (js2-EOL) - instead, it
5843 gobbles newlines until it finds a non-newline token. Call
5844 `js2-peek-token-or-eol' when you care about newlines.
5846 This function will also not return a js2-COMMENT. Instead, it
5847 records comments found in `js2-scanned-comments'. If the token
5848 returned by this function immediately follows a jsdoc comment,
5849 the token is flagged as such."
5850 (if (zerop js2-ti-lookahead)
5851 (js2-get-token-internal modifier)
5852 (cl-decf js2-ti-lookahead)
5853 (setq js2-ti-tokens-cursor (mod (1+ js2-ti-tokens-cursor) js2-ti-ntokens))
5854 (let ((tt (js2-current-token-type)))
5855 (cl-assert (not (= tt js2-EOL)))
5858 (defun js2-unget-token ()
5859 (cl-assert (< js2-ti-lookahead js2-ti-max-lookahead))
5860 (cl-incf js2-ti-lookahead)
5861 (setq js2-ti-tokens-cursor (mod (1- js2-ti-tokens-cursor) js2-ti-ntokens)))
5863 (defun js2-get-token-internal (modifier)
5864 (let* ((token (js2-get-token-internal-1 modifier)) ; call scanner
5865 (tt (js2-token-type token))
5869 (while (or (= tt js2-EOL) (= tt js2-COMMENT))
5873 (when js2-record-comments
5874 (js2-record-comment token)))
5875 (setq js2-ti-tokens-cursor (mod (1- js2-ti-tokens-cursor) js2-ti-ntokens))
5876 (setq token (js2-get-token-internal-1 modifier) ; call scanner again
5877 tt (js2-token-type token)))
5880 (setf (js2-token-follows-eol-p token) t))
5882 ;; perform lexical fontification as soon as token is scanned
5883 (when js2-parse-ide-mode
5886 (js2-record-face 'js2-error token))
5887 ((setq face (aref js2-kwd-tokens tt))
5888 (js2-record-face face token))
5889 ((and (= tt js2-NAME)
5890 (equal (js2-token-string token) "undefined"))
5891 (js2-record-face 'font-lock-constant-face token))))
5894 (defsubst js2-string-to-number (str base)
5895 ;; TODO: Maybe port ScriptRuntime.stringToNumber.
5897 (string-to-number str base)
5898 (overflow-error -1)))
5900 (defun js2-get-token-internal-1 (modifier)
5901 "Return next JavaScript token type, an int such as js2-RETURN.
5902 During operation, creates an instance of `js2-token' struct, sets
5903 its relevant fields and puts it into `js2-ti-tokens'."
5904 (let (identifier-start
5905 is-unicode-escape-start c
5906 contains-escape escape-val str result base
5907 look-for-slash continue tt legacy-octal
5908 (token (js2-new-token 0)))
5912 (when (eq modifier 'TEMPLATE_TAIL)
5913 (setf (js2-token-beg token) (1- js2-ts-cursor))
5914 (throw 'return (js2-get-string-or-template-token ?` token)))
5916 ;; Eat whitespace, possibly sensitive to newlines.
5919 (setq c (js2-get-char))
5921 ((eq c js2-EOF_CHAR)
5923 (js2-ts-set-char-token-bounds token)
5924 (throw 'return js2-EOF))
5926 (js2-ts-set-char-token-bounds token)
5927 (setq js2-ts-dirty-line nil)
5928 (throw 'return js2-EOL))
5929 ((not (js2-js-space-p c))
5930 (if (/= c ?-) ; in case end of HTML comment
5931 (setq js2-ts-dirty-line t))
5932 (setq continue nil))))
5933 ;; Assume the token will be 1 char - fixed up below.
5934 (js2-ts-set-char-token-bounds token)
5936 (throw 'return js2-XMLATTR))
5937 ;; identifier/keyword/instanceof?
5938 ;; watch out for starting with a <backslash>
5941 (setq c (js2-get-char))
5943 (setq identifier-start t
5944 is-unicode-escape-start t
5945 js2-ts-string-buffer nil)
5946 (setq identifier-start nil)
5950 (when (setq identifier-start (js2-identifier-start-p c))
5951 (setq js2-ts-string-buffer nil)
5952 (js2-add-to-string c))))
5953 (when identifier-start
5954 (setq contains-escape is-unicode-escape-start)
5957 (if is-unicode-escape-start
5958 ;; strictly speaking we should probably push-back
5959 ;; all the bad characters if the <backslash>uXXXX
5960 ;; sequence is malformed. But since there isn't a
5961 ;; correct context(is there?) for a bad Unicode
5962 ;; escape sequence in an identifier, we can report
5967 (setq c (js2-get-char)
5968 escape-val (js2-x-digit-to-int c escape-val))
5969 ;; Next check takes care of c < 0 and bad escape
5970 (if (cl-minusp escape-val)
5971 (throw 'break nil)))
5972 (if (cl-minusp escape-val)
5973 (js2-report-scan-error "msg.invalid.escape" t))
5974 (js2-add-to-string escape-val)
5975 (setq is-unicode-escape-start nil))
5976 (setq c (js2-get-char))
5979 (setq c (js2-get-char))
5981 (setq is-unicode-escape-start t
5983 (js2-report-scan-error "msg.illegal.character" t)))
5985 (if (or (eq c js2-EOF_CHAR)
5986 (not (js2-identifier-part-p c)))
5988 (js2-add-to-string c))))))
5990 (setf str (js2-collect-string js2-ts-string-buffer)
5991 (js2-token-end token) js2-ts-cursor)
5992 ;; FIXME: Invalid in ES5 and ES6, see
5993 ;; https://bugzilla.mozilla.org/show_bug.cgi?id=694360
5994 ;; Probably should just drop this conditional.
5995 (unless contains-escape
5996 ;; OPT we shouldn't have to make a string (object!) to
5997 ;; check if it's a keyword.
5998 ;; Return the corresponding token if it's a keyword
5999 (when (and (not (eq modifier 'KEYWORD_IS_NAME))
6000 (setq result (js2-string-to-keyword str)))
6001 (if (and (< js2-language-version 170)
6002 (memq result '(js2-LET js2-YIELD)))
6003 ;; LET and YIELD are tokens only in 1.7 and later
6004 (setq result 'js2-NAME))
6005 (when (eq result 'js2-RESERVED)
6006 (setf (js2-token-string token) str))
6007 (throw 'return (js2-tt-code result))))
6008 ;; If we want to intern these as Rhino does, just use (intern str)
6009 (setf (js2-token-string token) str)
6010 (throw 'return js2-NAME)) ; end identifier/kwd check
6012 (when (or (js2-digit-p c)
6013 (and (eq c ?.) (js2-digit-p (js2-peek-char))))
6014 (setq js2-ts-string-buffer nil
6017 (setq c (js2-get-char))
6019 ((or (eq c ?x) (eq c ?X))
6021 (setq c (js2-get-char)))
6022 ((and (or (eq c ?b) (eq c ?B))
6023 (>= js2-language-version 200))
6025 (setq c (js2-get-char)))
6026 ((and (or (eq c ?o) (eq c ?O))
6027 (>= js2-language-version 200))
6029 (setq legacy-octal nil)
6030 (setq c (js2-get-char)))
6032 (setq base 'maybe-8))
6034 (js2-add-to-string ?0))))
6037 (if (> 0 (js2-x-digit-to-int c 0))
6038 (js2-report-scan-error "msg.missing.hex.digits")
6039 (while (<= 0 (js2-x-digit-to-int c 0))
6040 (js2-add-to-string c)
6041 (setq c (js2-get-char)))))
6043 (if (not (memq c '(?0 ?1)))
6044 (js2-report-scan-error "msg.missing.binary.digits")
6045 (while (memq c '(?0 ?1))
6046 (js2-add-to-string c)
6047 (setq c (js2-get-char)))))
6049 (if (or (> ?0 c) (< ?7 c))
6050 (js2-report-scan-error "msg.missing.octal.digits")
6051 (while (and (<= ?0 c) (>= ?7 c))
6052 (js2-add-to-string c)
6053 (setq c (js2-get-char)))))
6055 (while (and (<= ?0 c) (<= c ?9))
6056 ;; We permit 08 and 09 as decimal numbers, which
6057 ;; makes our behavior a superset of the ECMA
6058 ;; numeric grammar. We might not always be so
6059 ;; permissive, so we warn about it.
6060 (when (and (eq base 'maybe-8) (>= c ?8))
6061 (js2-report-warning "msg.bad.octal.literal"
6062 (if (eq c ?8) "8" "9"))
6064 (js2-add-to-string c)
6065 (setq c (js2-get-char)))
6066 (when (eq base 'maybe-8)
6069 (when (and (eq base 10) (memq c '(?. ?e ?E)))
6072 (js2-add-to-string c)
6073 (setq c (js2-get-char))
6074 while (js2-digit-p c)))
6075 (when (memq c '(?e ?E))
6076 (js2-add-to-string c)
6077 (setq c (js2-get-char))
6078 (when (memq c '(?+ ?-))
6079 (js2-add-to-string c)
6080 (setq c (js2-get-char)))
6081 (unless (js2-digit-p c)
6082 (js2-report-scan-error "msg.missing.exponent" t))
6084 (js2-add-to-string c)
6085 (setq c (js2-get-char))
6086 while (js2-digit-p c))))
6088 (let ((str (js2-set-string-from-buffer token)))
6089 (setf (js2-token-number token) (js2-string-to-number str base)
6090 (js2-token-number-base token) base
6091 (js2-token-number-legacy-octal-p token) (and (= base 8) legacy-octal)))
6092 (throw 'return js2-NUMBER))
6094 (when (or (memq c '(?\" ?\'))
6095 (and (>= js2-language-version 200)
6098 (js2-get-string-or-template-token c token)))
6099 (js2-ts-return token
6102 (throw 'return js2-SEMI))
6104 (throw 'return js2-LB))
6106 (throw 'return js2-RB))
6108 (throw 'return js2-LC))
6110 (throw 'return js2-RC))
6112 (throw 'return js2-LP))
6114 (throw 'return js2-RP))
6116 (throw 'return js2-COMMA))
6118 (throw 'return js2-HOOK))
6120 (if (js2-match-char ?:)
6122 (throw 'return js2-COLON)))
6124 (if (js2-match-char ?.)
6125 (if (js2-match-char ?.)
6126 js2-TRIPLEDOT js2-DOTDOT)
6127 (if (js2-match-char ?\()
6129 (throw 'return js2-DOT))))
6131 (if (js2-match-char ?|)
6132 (throw 'return js2-OR)
6133 (if (js2-match-char ?=)
6135 (throw 'return js2-BITOR))))
6137 (if (js2-match-char ?=)
6139 (throw 'return js2-BITXOR)))
6141 (if (js2-match-char ?&)
6142 (throw 'return js2-AND)
6143 (if (js2-match-char ?=)
6145 (throw 'return js2-BITAND))))
6147 (if (js2-match-char ?=)
6148 (if (js2-match-char ?=)
6150 (throw 'return js2-EQ))
6151 (if (js2-match-char ?>)
6152 (js2-ts-return token js2-ARROW)
6153 (throw 'return js2-ASSIGN))))
6155 (if (js2-match-char ?=)
6156 (if (js2-match-char ?=)
6159 (throw 'return js2-NOT)))
6161 ;; NB:treat HTML begin-comment as comment-till-eol
6162 (when (js2-match-char ?!)
6163 (when (js2-match-char ?-)
6164 (when (js2-match-char ?-)
6166 (setf (js2-token-comment-type (js2-current-token)) 'html)
6167 (throw 'return js2-COMMENT)))
6169 (if (js2-match-char ?<)
6170 (if (js2-match-char ?=)
6173 (if (js2-match-char ?=)
6175 (throw 'return js2-LT))))
6177 (if (js2-match-char ?>)
6178 (if (js2-match-char ?>)
6179 (if (js2-match-char ?=)
6182 (if (js2-match-char ?=)
6185 (if (js2-match-char ?=)
6187 (throw 'return js2-GT))))
6189 (if (js2-match-char ?=)
6191 (throw 'return js2-MUL)))
6193 ;; is it a // comment?
6194 (when (js2-match-char ?/)
6195 (setf (js2-token-beg token) (- js2-ts-cursor 2))
6197 (setf (js2-token-comment-type token) 'line)
6198 ;; include newline so highlighting goes to end of
6199 ;; window, if there actually is a newline; if we
6200 ;; hit eof, then implicitly there isn't
6201 (unless js2-ts-hit-eof
6202 (cl-incf (js2-token-end token)))
6203 (throw 'return js2-COMMENT))
6204 ;; is it a /* comment?
6205 (when (js2-match-char ?*)
6206 (setf look-for-slash nil
6207 (js2-token-beg token) (- js2-ts-cursor 2)
6208 (js2-token-comment-type token)
6209 (if (js2-match-char ?*)
6211 (setq look-for-slash t)
6215 (setq c (js2-get-char))
6217 ((eq c js2-EOF_CHAR)
6218 (setf (js2-token-end token) (1- js2-ts-cursor))
6219 (js2-report-error "msg.unterminated.comment")
6220 (throw 'return js2-COMMENT))
6222 (setq look-for-slash t))
6225 (js2-ts-return token js2-COMMENT)))
6227 (setf look-for-slash nil
6228 (js2-token-end token) js2-ts-cursor)))))
6229 (if (js2-match-char ?=)
6231 (throw 'return js2-DIV)))
6233 (when js2-skip-preprocessor-directives
6235 (setf (js2-token-comment-type token) 'preprocessor
6236 (js2-token-end token) js2-ts-cursor)
6237 (throw 'return js2-COMMENT))
6238 (throw 'return js2-ERROR))
6240 (if (js2-match-char ?=)
6242 (throw 'return js2-MOD)))
6244 (throw 'return js2-BITNOT))
6246 (if (js2-match-char ?=)
6248 (if (js2-match-char ?+)
6250 (throw 'return js2-ADD))))
6253 ((js2-match-char ?=)
6254 (setq c js2-ASSIGN_SUB))
6255 ((js2-match-char ?-)
6256 (unless js2-ts-dirty-line
6257 ;; treat HTML end-comment after possible whitespace
6258 ;; after line start as comment-until-eol
6259 (when (js2-match-char ?>)
6261 (setf (js2-token-comment-type (js2-current-token)) 'html)
6262 (throw 'return js2-COMMENT)))
6266 (setq js2-ts-dirty-line t)
6269 (js2-report-scan-error "msg.illegal.character")))))))
6270 (setf (js2-token-type token) tt)
6273 (defun js2-get-string-or-template-token (quote-char token)
6274 ;; We attempt to accumulate a string the fast way, by
6275 ;; building it directly out of the reader. But if there
6276 ;; are any escaped characters in the string, we revert to
6277 ;; building it out of a string buffer.
6278 (let ((c (js2-get-char))
6279 js2-ts-string-buffer
6280 nc c1 val escape-val)
6282 (while (/= c quote-char)
6284 (when (eq c js2-EOF_CHAR)
6286 (js2-report-error "msg.unterminated.string.lit")
6288 (when (and (eq c ?\n) (not (eq quote-char ?`)))
6290 (js2-report-error "msg.unterminated.string.lit")
6293 ;; We've hit an escaped character
6294 (setq c (js2-get-char))
6303 (setq c1 (js2-read-unicode-escape))
6304 (if js2-parse-ide-mode
6307 ;; just copy the string in IDE-mode
6308 (js2-add-to-string ?\\)
6309 (js2-add-to-string ?u)
6311 (js2-add-to-string (js2-get-char)))
6312 (setq c (js2-get-char))) ; added at end of loop
6313 ;; flag it as an invalid escape
6314 (js2-report-warning "msg.invalid.escape"
6315 nil (- js2-ts-cursor 2) 6))
6316 ;; Get 4 hex digits; if the u escape is not
6317 ;; followed by 4 hex digits, use 'u' + the
6318 ;; literal character sequence that follows.
6319 (js2-add-to-string ?u)
6322 (setq c (js2-get-char)
6323 escape-val (js2-x-digit-to-int c escape-val))
6324 (if (cl-minusp escape-val)
6325 (throw 'continue nil))
6326 (js2-add-to-string c))
6327 ;; prepare for replace of stored 'u' sequence by escape value
6328 (setq js2-ts-string-buffer (nthcdr 5 js2-ts-string-buffer)
6331 ;; Get 2 hex digits, defaulting to 'x'+literal
6332 ;; sequence, as above.
6333 (setq c (js2-get-char)
6334 escape-val (js2-x-digit-to-int c 0))
6335 (if (cl-minusp escape-val)
6337 (js2-add-to-string ?x)
6338 (throw 'continue nil))
6341 escape-val (js2-x-digit-to-int c escape-val))
6342 (if (cl-minusp escape-val)
6344 (js2-add-to-string ?x)
6345 (js2-add-to-string c1)
6346 (throw 'continue nil))
6348 (setq c escape-val))))
6350 ;; Remove line terminator after escape to follow
6351 ;; SpiderMonkey and C/C++
6352 (setq c (js2-get-char))
6353 (throw 'continue nil))
6355 (when (and (<= ?0 c) (< c ?8))
6358 (when (and (<= ?0 c) (< c ?8))
6359 (setq val (- (+ (* 8 val) c) ?0)
6361 (when (and (<= ?0 c)
6364 ;; c is 3rd char of octal sequence only
6365 ;; if the resulting val <= 0377
6366 (setq val (- (+ (* 8 val) c) ?0)
6370 (when (and (eq quote-char ?`) (eq c ?$))
6371 (when (eq (setq nc (js2-get-char)) ?\{)
6374 (js2-add-to-string c)
6375 (setq c (js2-get-char)))))
6376 (js2-set-string-from-buffer token)
6377 (if (not (eq quote-char ?`))
6379 (if (and (eq c ?$) (eq nc ?\{))
6381 js2-NO_SUBS_TEMPLATE))))
6383 (defun js2-read-regexp (start-tt)
6384 "Called by parser when it gets / or /= in literal context."
6386 in-class ; inside a '[' .. ']' character-class
6389 (token (js2-new-token 0)))
6390 (setq js2-ts-string-buffer nil)
6391 (if (eq start-tt js2-ASSIGN_DIV)
6393 (js2-add-to-string ?=)
6394 (if (not (eq start-tt js2-DIV))
6395 (error "failed assertion")))
6396 (while (and (not err)
6397 (or (/= (setq c (js2-get-char)) ?/)
6402 (setf (js2-token-end token) (1- js2-ts-cursor)
6404 (js2-token-string token) (js2-collect-string js2-ts-string-buffer))
6405 (js2-report-error "msg.unterminated.re.lit"))
6408 (js2-add-to-string c)
6409 (setq c (js2-get-char)))
6413 (setq in-class nil)))
6414 (js2-add-to-string c))))
6418 ((js2-match-char ?g)
6420 ((js2-match-char ?i)
6422 ((js2-match-char ?m)
6424 ((and (js2-match-char ?u)
6425 (>= js2-language-version 200))
6427 ((and (js2-match-char ?y)
6428 (>= js2-language-version 200))
6431 (setq continue nil))))
6432 (if (js2-alpha-p (js2-peek-char))
6433 (js2-report-scan-error "msg.invalid.re.flag" t
6435 (js2-set-string-from-buffer token))
6436 (js2-collect-string flags)))
6438 (defun js2-get-first-xml-token ()
6439 (setq js2-ts-xml-open-tags-count 0
6440 js2-ts-is-xml-attribute nil
6441 js2-ts-xml-is-tag-content nil)
6443 (js2-get-next-xml-token))
6445 (defun js2-xml-discard-string (token)
6446 "Throw away the string in progress and flag an XML parse error."
6447 (setf js2-ts-string-buffer nil
6448 (js2-token-string token) nil)
6449 (js2-report-scan-error "msg.XML.bad.form" t))
6451 (defun js2-get-next-xml-token ()
6452 (setq js2-ts-string-buffer nil) ; for recording the XML
6453 (let ((token (js2-new-token 0))
6458 (setq c (js2-get-char))
6461 (throw 'return js2-ERROR))
6462 (js2-ts-xml-is-tag-content
6465 (js2-add-to-string c)
6466 (setq js2-ts-xml-is-tag-content nil
6467 js2-ts-is-xml-attribute nil))
6469 (js2-add-to-string c)
6470 (when (eq ?> (js2-peek-char))
6471 (setq c (js2-get-char))
6472 (js2-add-to-string c)
6473 (setq js2-ts-xml-is-tag-content nil)
6474 (cl-decf js2-ts-xml-open-tags-count)))
6477 (js2-set-string-from-buffer token)
6478 (throw 'return js2-XML))
6480 (js2-add-to-string c)
6481 (unless (js2-read-quoted-string c token)
6482 (throw 'return js2-ERROR)))
6484 (js2-add-to-string c)
6485 (setq js2-ts-is-xml-attribute t))
6487 (js2-add-to-string c))
6489 (js2-add-to-string c)
6490 (setq js2-ts-is-xml-attribute nil)))
6491 (when (and (not js2-ts-xml-is-tag-content)
6492 (zerop js2-ts-xml-open-tags-count))
6493 (js2-set-string-from-buffer token)
6494 (throw 'return js2-XMLEND)))
6496 ;; else not tag content
6499 (js2-add-to-string c)
6500 (setq c (js2-peek-char))
6503 (setq c (js2-get-char)) ;; skip !
6504 (js2-add-to-string c)
6505 (setq c (js2-peek-char))
6508 (setq c (js2-get-char)) ;; skip -
6509 (js2-add-to-string c)
6512 (js2-add-to-string c)
6513 (unless (js2-read-xml-comment token)
6514 (throw 'return js2-ERROR)))
6515 (js2-xml-discard-string token)
6516 (throw 'return js2-ERROR)))
6518 (setq c (js2-get-char)) ;; skip [
6519 (js2-add-to-string c)
6520 (if (and (= (js2-get-char) ?C)
6521 (= (js2-get-char) ?D)
6522 (= (js2-get-char) ?A)
6523 (= (js2-get-char) ?T)
6524 (= (js2-get-char) ?A)
6525 (= (js2-get-char) ?\[))
6527 (js2-add-to-string ?C)
6528 (js2-add-to-string ?D)
6529 (js2-add-to-string ?A)
6530 (js2-add-to-string ?T)
6531 (js2-add-to-string ?A)
6532 (js2-add-to-string ?\[)
6533 (unless (js2-read-cdata token)
6534 (throw 'return js2-ERROR)))
6535 (js2-xml-discard-string token)
6536 (throw 'return js2-ERROR)))
6538 (unless (js2-read-entity token)
6539 (throw 'return js2-ERROR))))
6540 ;; Allow bare CDATA section, e.g.:
6541 ;; let xml = <![CDATA[ foo bar baz ]]>;
6542 (when (zerop js2-ts-xml-open-tags-count)
6543 (throw 'return js2-XMLEND)))
6545 (setq c (js2-get-char)) ;; skip ?
6546 (js2-add-to-string c)
6547 (unless (js2-read-PI token)
6548 (throw 'return js2-ERROR)))
6551 (setq c (js2-get-char)) ;; skip /
6552 (js2-add-to-string c)
6553 (when (zerop js2-ts-xml-open-tags-count)
6554 (js2-xml-discard-string token)
6555 (throw 'return js2-ERROR))
6556 (setq js2-ts-xml-is-tag-content t)
6557 (cl-decf js2-ts-xml-open-tags-count))
6560 (setq js2-ts-xml-is-tag-content t)
6561 (cl-incf js2-ts-xml-open-tags-count))))
6564 (js2-set-string-from-buffer token)
6565 (throw 'return js2-XML))
6567 (js2-add-to-string c))))))))
6568 (setf (js2-token-end token) js2-ts-cursor)
6569 (setf (js2-token-type token) result)
6572 (defun js2-read-quoted-string (quote token)
6575 (while (/= (setq c (js2-get-char)) js2-EOF_CHAR)
6576 (js2-add-to-string c)
6579 (js2-xml-discard-string token) ;; throw away string in progress
6582 (defun js2-read-xml-comment (token)
6583 (let ((c (js2-get-char)))
6585 (while (/= c js2-EOF_CHAR)
6587 (js2-add-to-string c)
6588 (when (and (eq c ?-) (eq ?- (js2-peek-char)))
6589 (setq c (js2-get-char))
6590 (js2-add-to-string c)
6591 (if (eq (js2-peek-char) ?>)
6593 (setq c (js2-get-char)) ;; skip >
6594 (js2-add-to-string c)
6596 (throw 'continue nil)))
6597 (setq c (js2-get-char))))
6598 (js2-xml-discard-string token)
6601 (defun js2-read-cdata (token)
6602 (let ((c (js2-get-char)))
6604 (while (/= c js2-EOF_CHAR)
6606 (js2-add-to-string c)
6607 (when (and (eq c ?\]) (eq (js2-peek-char) ?\]))
6608 (setq c (js2-get-char))
6609 (js2-add-to-string c)
6610 (if (eq (js2-peek-char) ?>)
6612 (setq c (js2-get-char)) ;; Skip >
6613 (js2-add-to-string c)
6615 (throw 'continue nil)))
6616 (setq c (js2-get-char))))
6617 (js2-xml-discard-string token)
6620 (defun js2-read-entity (token)
6624 (while (/= js2-EOF_CHAR (setq c (js2-get-char)))
6625 (js2-add-to-string c)
6628 (cl-incf decl-tags))
6631 (if (zerop decl-tags)
6632 (throw 'return t)))))
6633 (js2-xml-discard-string token)
6636 (defun js2-read-PI (token)
6637 "Scan an XML processing instruction."
6640 (while (/= js2-EOF_CHAR (setq c (js2-get-char)))
6641 (js2-add-to-string c)
6642 (when (and (eq c ??) (eq (js2-peek-char) ?>))
6643 (setq c (js2-get-char)) ;; Skip >
6644 (js2-add-to-string c)
6646 (js2-xml-discard-string token)
6651 (defun js2-set-face (beg end face &optional record)
6652 "Fontify a region. If RECORD is non-nil, record for later."
6653 (when (cl-plusp js2-highlight-level)
6654 (setq beg (min (point-max) beg)
6655 beg (max (point-min) beg)
6656 end (min (point-max) end)
6657 end (max (point-min) end))
6659 (push (list beg end face) js2-mode-fontifications)
6660 (put-text-property beg end 'font-lock-face face))))
6662 (defsubst js2-clear-face (beg end)
6663 (remove-text-properties beg end '(font-lock-face nil
6666 cursor-sensor-functions nil
6669 (defconst js2-ecma-global-props
6672 '("Infinity" "NaN" "undefined" "arguments") t)
6674 "Value properties of the Ecma-262 Global Object.
6675 Shown at or above `js2-highlight-level' 2.")
6677 ;; might want to add the name "arguments" to this list?
6678 (defconst js2-ecma-object-props
6681 '("prototype" "__proto__" "__parent__") t)
6683 "Value properties of the Ecma-262 Object constructor.
6684 Shown at or above `js2-highlight-level' 2.")
6686 (defconst js2-ecma-global-funcs
6690 '("decodeURI" "decodeURIComponent" "encodeURI" "encodeURIComponent"
6691 "eval" "isFinite" "isNaN" "parseFloat" "parseInt") t)
6693 "Function properties of the Ecma-262 Global object.
6694 Shown at or above `js2-highlight-level' 2.")
6696 (defconst js2-ecma-number-props
6698 (regexp-opt '("MAX_VALUE" "MIN_VALUE" "NaN"
6700 "POSITIVE_INFINITY") t)
6702 "Properties of the Ecma-262 Number constructor.
6703 Shown at or above `js2-highlight-level' 2.")
6705 (defconst js2-ecma-date-props "^\\(parse\\|UTC\\)$"
6706 "Properties of the Ecma-262 Date constructor.
6707 Shown at or above `js2-highlight-level' 2.")
6709 (defconst js2-ecma-math-props
6712 '("E" "LN10" "LN2" "LOG2E" "LOG10E" "PI" "SQRT1_2" "SQRT2")
6715 "Properties of the Ecma-262 Math object.
6716 Shown at or above `js2-highlight-level' 2.")
6718 (defconst js2-ecma-math-funcs
6721 '("abs" "acos" "asin" "atan" "atan2" "ceil" "cos" "exp" "floor"
6722 "log" "max" "min" "pow" "random" "round" "sin" "sqrt" "tan") t)
6724 "Function properties of the Ecma-262 Math object.
6725 Shown at or above `js2-highlight-level' 2.")
6727 (defconst js2-ecma-function-props
6731 '(;; properties of the Object prototype object
6732 "hasOwnProperty" "isPrototypeOf" "propertyIsEnumerable"
6733 "toLocaleString" "toString" "valueOf"
6734 ;; properties of the Function prototype object
6736 ;; properties of the Array prototype object
6737 "concat" "join" "pop" "push" "reverse" "shift" "slice" "sort"
6739 ;; properties of the String prototype object
6740 "charAt" "charCodeAt" "fromCharCode" "indexOf" "lastIndexOf"
6741 "localeCompare" "match" "replace" "search" "split" "substring"
6742 "toLocaleLowerCase" "toLocaleUpperCase" "toLowerCase"
6744 ;; properties of the Number prototype object
6745 "toExponential" "toFixed" "toPrecision"
6746 ;; properties of the Date prototype object
6747 "getDate" "getDay" "getFullYear" "getHours" "getMilliseconds"
6748 "getMinutes" "getMonth" "getSeconds" "getTime"
6749 "getTimezoneOffset" "getUTCDate" "getUTCDay" "getUTCFullYear"
6750 "getUTCHours" "getUTCMilliseconds" "getUTCMinutes" "getUTCMonth"
6751 "getUTCSeconds" "setDate" "setFullYear" "setHours"
6752 "setMilliseconds" "setMinutes" "setMonth" "setSeconds" "setTime"
6753 "setUTCDate" "setUTCFullYear" "setUTCHours" "setUTCMilliseconds"
6754 "setUTCMinutes" "setUTCMonth" "setUTCSeconds" "toDateString"
6755 "toLocaleDateString" "toLocaleString" "toLocaleTimeString"
6756 "toTimeString" "toUTCString"
6757 ;; properties of the RegExp prototype object
6759 ;; properties of the JSON prototype object
6761 ;; SpiderMonkey/Rhino extensions, versions 1.5+
6762 "toSource" "__defineGetter__" "__defineSetter__"
6763 "__lookupGetter__" "__lookupSetter__" "__noSuchMethod__"
6764 "every" "filter" "forEach" "lastIndexOf" "map" "some")
6767 "Built-in functions defined by Ecma-262 and SpiderMonkey extensions.
6768 Shown at or above `js2-highlight-level' 3.")
6770 (defun js2-parse-highlight-prop-get (parent target prop call-p)
6771 (let ((target-name (and target
6772 (js2-name-node-p target)
6773 (js2-name-node-name target)))
6774 (prop-name (if prop (js2-name-node-name prop)))
6775 (level2 (>= js2-highlight-level 2))
6776 (level3 (>= js2-highlight-level 3)))
6783 ((and level3 (string-match js2-ecma-function-props prop-name))
6784 'font-lock-builtin-face)
6785 ((and target-name prop)
6787 ((string= target-name "Date")
6788 (if (string-match js2-ecma-date-props prop-name)
6789 'font-lock-builtin-face))
6790 ((string= target-name "Math")
6791 (if (string-match js2-ecma-math-funcs prop-name)
6792 'font-lock-builtin-face))))))
6794 (if (string-match js2-ecma-global-funcs prop-name)
6795 'font-lock-builtin-face)))
6799 ((string= target-name "Number")
6800 (if (string-match js2-ecma-number-props prop-name)
6801 'font-lock-constant-face))
6802 ((string= target-name "Math")
6803 (if (string-match js2-ecma-math-props prop-name)
6804 'font-lock-constant-face))))
6806 (if (string-match js2-ecma-object-props prop-name)
6807 'font-lock-constant-face))))))
6808 (when (and (not face) target (not call-p) prop-name)
6809 (setq face 'js2-object-property))
6811 (let ((pos (+ (js2-node-pos parent) ; absolute
6812 (js2-node-pos prop)))) ; relative
6814 (+ pos (js2-node-len prop))
6817 (defun js2-parse-highlight-member-expr-node (node)
6818 "Perform syntax highlighting of EcmaScript built-in properties.
6819 The variable `js2-highlight-level' governs this highlighting."
6820 (let (face target prop name pos end parent call-p callee)
6822 ;; case 1: simple name, e.g. foo
6823 ((js2-name-node-p node)
6824 (setq name (js2-name-node-name node))
6825 ;; possible for name to be nil in rare cases - saw it when
6826 ;; running js2-mode on an elisp buffer. Might as well try to
6827 ;; make it so js2-mode never barfs.
6829 (setq face (if (string-match js2-ecma-global-props name)
6830 'font-lock-constant-face))
6832 (setq pos (js2-node-pos node)
6833 end (+ pos (js2-node-len node)))
6834 (js2-set-face pos end face 'record))))
6835 ;; case 2: property access or function call
6836 ((or (js2-prop-get-node-p node)
6837 ;; highlight function call if expr is a prop-get node
6838 ;; or a plain name (i.e. unqualified function call)
6839 (and (setq call-p (js2-call-node-p node))
6840 (setq callee (js2-call-node-target node)) ; separate setq!
6841 (or (js2-prop-get-node-p callee)
6842 (js2-name-node-p callee))))
6844 node (if call-p callee node))
6845 (if (and call-p (js2-name-node-p callee))
6847 (setq target (js2-prop-get-node-left node)
6848 prop (js2-prop-get-node-right node)))
6850 ((js2-name-node-p prop)
6851 ;; case 2(a&c): simple or complex target, simple name, e.g. x[y].bar
6852 (js2-parse-highlight-prop-get parent target prop call-p))
6853 ((js2-name-node-p target)
6854 ;; case 2b: simple target, complex name, e.g. foo.x[y]
6855 (js2-parse-highlight-prop-get parent target nil call-p)))))))
6857 (defun js2-parse-highlight-member-expr-fn-name (expr)
6858 "Highlight the `baz' in function foo.bar.baz(args) {...}.
6859 This is experimental Rhino syntax. EXPR is the foo.bar.baz member expr.
6860 We currently only handle the case where the last component is a prop-get
6861 of a simple name. Called before EXPR has a parent node."
6863 (name (and (js2-prop-get-node-p expr)
6864 (js2-prop-get-node-right expr))))
6865 (when (js2-name-node-p name)
6866 (js2-set-face (setq pos (+ (js2-node-pos expr) ; parent is absolute
6867 (js2-node-pos name)))
6868 (+ pos (js2-node-len name))
6869 'font-lock-function-name-face
6872 ;; source: http://jsdoc.sourceforge.net/
6873 ;; Note - this syntax is for Google's enhanced jsdoc parser that
6874 ;; allows type specifications, and needs work before entering the wild.
6876 (defconst js2-jsdoc-param-tag-regexp
6877 (concat "^\\s-*\\*+\\s-*\\(@"
6878 "\\(?:param\\|arg\\(?:ument\\)?\\|prop\\(?:erty\\)?\\)"
6880 "\\s-*\\({[^}]+}\\)?" ; optional type
6881 "\\s-*\\[?\\([[:alnum:]_$\.]+\\)?\\]?" ; name
6883 "Matches jsdoc tags with optional type and optional param name.")
6885 (defconst js2-jsdoc-typed-tag-regexp
6886 (concat "^\\s-*\\*+\\s-*\\(@\\(?:"
6900 "\\)\\)\\s-*\\({[^}]+}\\)?")
6901 "Matches jsdoc tags with optional type.")
6903 (defconst js2-jsdoc-arg-tag-regexp
6904 (concat "^\\s-*\\*+\\s-*\\(@\\(?:"
6929 "\\)\\)\\s-+\\([^ \t]+\\)")
6930 "Matches jsdoc tags with a single argument.")
6932 (defconst js2-jsdoc-empty-tag-regexp
6933 (concat "^\\s-*\\*+\\s-*\\(@\\(?:"
6975 "Matches empty jsdoc tags.")
6977 (defconst js2-jsdoc-link-tag-regexp
6978 "{\\(@\\(?:link\\|code\\)\\)\\s-+\\([^#}\n]+\\)\\(#.+\\)?}"
6979 "Matches a jsdoc link or code tag.")
6981 (defconst js2-jsdoc-see-tag-regexp
6982 "^\\s-*\\*+\\s-*\\(@see\\)\\s-+\\([^#}\n]+\\)\\(#.+\\)?"
6983 "Matches a jsdoc @see tag.")
6985 (defconst js2-jsdoc-html-tag-regexp
6986 "\\(</?\\)\\([[:alpha:]]+\\)\\s-*\\(/?>\\)"
6987 "Matches a simple (no attributes) html start- or end-tag.")
6989 (defun js2-jsdoc-highlight-helper ()
6990 (js2-set-face (match-beginning 1)
6993 (if (match-beginning 2)
6995 (goto-char (match-beginning 2))
6996 (= (char-after) ?{))
6997 (js2-set-face (1+ (match-beginning 2))
7000 (js2-set-face (match-beginning 2)
7003 (if (match-beginning 3)
7004 (js2-set-face (match-beginning 3)
7008 (defun js2-highlight-jsdoc (ast)
7009 "Highlight doc comment tags."
7010 (let ((comments (js2-ast-root-comments ast))
7013 (dolist (node comments)
7014 (when (eq (js2-comment-node-format node) 'jsdoc)
7015 (setq beg (js2-node-abs-pos node)
7016 end (+ beg (js2-node-len node)))
7018 (narrow-to-region beg end)
7019 (dolist (re (list js2-jsdoc-param-tag-regexp
7020 js2-jsdoc-typed-tag-regexp
7021 js2-jsdoc-arg-tag-regexp
7022 js2-jsdoc-link-tag-regexp
7023 js2-jsdoc-see-tag-regexp
7024 js2-jsdoc-empty-tag-regexp))
7026 (while (re-search-forward re nil t)
7027 (js2-jsdoc-highlight-helper)))
7028 ;; simple highlighting for html tags
7030 (while (re-search-forward js2-jsdoc-html-tag-regexp nil t)
7031 (js2-set-face (match-beginning 1)
7033 'js2-jsdoc-html-tag-delimiter)
7034 (js2-set-face (match-beginning 2)
7036 'js2-jsdoc-html-tag-name)
7037 (js2-set-face (match-beginning 3)
7039 'js2-jsdoc-html-tag-delimiter))))))))
7041 (defun js2-highlight-assign-targets (_node left right)
7042 "Highlight function properties and external variables."
7044 ;; highlight vars and props assigned function values
7045 (when (or (js2-function-node-p right)
7046 (js2-class-node-p right))
7048 ;; var foo = function() {...}
7049 ((js2-name-node-p left)
7051 ;; foo.bar.baz = function() {...}
7052 ((and (js2-prop-get-node-p left)
7053 (js2-name-node-p (js2-prop-get-node-right left)))
7054 (setq name (js2-prop-get-node-right left))))
7056 (js2-set-face (setq leftpos (js2-node-abs-pos name))
7057 (+ leftpos (js2-node-len name))
7058 'font-lock-function-name-face
7061 (defun js2-record-name-node (node)
7062 "Saves NODE to `js2-recorded-identifiers' to check for undeclared variables
7063 later. NODE must be a name node."
7064 (let ((leftpos (js2-node-abs-pos node)))
7065 (push (list node js2-current-scope
7067 (+ leftpos (js2-node-len node)))
7068 js2-recorded-identifiers)))
7070 (defun js2-highlight-undeclared-vars ()
7071 "After entire parse is finished, look for undeclared variable references.
7072 We have to wait until entire buffer is parsed, since JavaScript permits var
7073 decls to occur after they're used.
7075 If any undeclared var name is in `js2-externs' or `js2-additional-externs',
7076 it is considered declared."
7078 (dolist (entry js2-recorded-identifiers)
7079 (cl-destructuring-bind (name-node scope pos end) entry
7080 (setq name (js2-name-node-name name-node))
7081 (unless (or (member name js2-global-externs)
7082 (member name js2-default-externs)
7083 (member name js2-additional-externs)
7084 (js2-get-defining-scope scope name pos))
7085 (js2-report-warning "msg.undeclared.variable" name pos (- end pos)
7086 'js2-external-variable))))))
7088 (defun js2--add-or-update-symbol (symbol inition used vars)
7089 "Add or update SYMBOL entry in VARS, an hash table.
7090 SYMBOL is a js2-name-node, INITION either nil, t, or ?P,
7091 respectively meaning that SYMBOL is a mere declaration, an
7092 assignment or a function parameter; when USED is t, the symbol
7093 node is assumed to be an usage and thus added to the list stored
7094 in the cdr of the entry.
7096 (let* ((nm (js2-name-node-name symbol))
7097 (es (js2-node-get-enclosing-scope symbol))
7098 (ds (js2-get-defining-scope es nm)))
7099 (when (and ds (not (equal nm "arguments")))
7100 (let* ((sym (js2-scope-get-symbol ds nm))
7101 (var (gethash sym vars))
7102 (err-var-p (js2-catch-node-p ds)))
7104 (setq inition err-var-p))
7107 (when (and inition (not (equal (car var) ?P)))
7108 (setcar var inition))
7110 (push symbol (cdr var))))
7111 ;; do not consider the declaration of catch parameter as an usage
7112 (when (and err-var-p used)
7114 (puthash sym (cons inition (if used (list symbol))) vars))))))
7116 (defun js2--classify-variables ()
7117 "Collect and classify variables declared or used within js2-mode-ast.
7118 Traverse the whole ast tree returning a summary of the variables
7119 usage as an hash-table, keyed by their corresponding symbol table
7121 Each variable is described by a tuple where the car is a flag
7122 indicating whether the variable has been initialized and the cdr
7123 is a possibly empty list of name nodes where it is used. External
7124 symbols, i.e. those not present in the whole scopes hierarchy,
7126 (let ((vars (make-hash-table :test #'eq :size 100)))
7129 (lambda (node end-p)
7132 ((js2-var-init-node-p node)
7133 ;; take note about possibly initialized declarations
7134 (let ((target (js2-var-init-node-target node))
7135 (initializer (js2-var-init-node-initializer node)))
7137 (let* ((parent (js2-node-parent node))
7138 (grandparent (if parent (js2-node-parent parent)))
7139 (inited (not (null initializer))))
7143 (js2-for-in-node-p grandparent)
7145 (mapcar #'js2-var-init-node-target
7146 (js2-var-decl-node-kids
7147 (js2-for-in-node-iterator grandparent)))))))
7148 (js2--add-or-update-symbol target inited nil vars)))))
7150 ((js2-assign-node-p node)
7151 ;; take note about assignments
7152 (let ((left (js2-assign-node-left node)))
7153 (when (js2-name-node-p left)
7154 (js2--add-or-update-symbol left t nil vars))))
7156 ((js2-prop-get-node-p node)
7157 ;; handle x.y.z nodes, considering only x
7158 (let ((left (js2-prop-get-node-left node)))
7159 (when (js2-name-node-p left)
7160 (js2--add-or-update-symbol left nil t vars))))
7162 ((js2-name-node-p node)
7163 ;; take note about used variables
7164 (let ((parent (js2-node-parent node)))
7166 (unless (or (and (js2-var-init-node-p parent) ; handled above
7167 (eq node (js2-var-init-node-target parent)))
7168 (and (js2-assign-node-p parent)
7169 (eq node (js2-assign-node-left parent)))
7170 (js2-prop-get-node-p parent))
7171 (let ((used t) inited)
7173 ((and (js2-function-node-p parent)
7174 (js2-wrapper-function-p parent))
7175 (setq inited (if (memq node (js2-function-node-params parent)) ?P t)))
7177 ((js2-for-in-node-p parent)
7178 (if (eq node (js2-for-in-node-iterator parent))
7179 (setq inited t used nil)))
7181 ((js2-function-node-p parent)
7182 (setq inited (if (memq node (js2-function-node-params parent)) ?P t)
7186 (let ((grandparent (js2-node-parent parent)))
7188 (setq used (js2-return-node-p grandparent)))))
7190 (js2--add-or-update-symbol node inited used vars))))))))
7194 (defun js2--get-name-node (node)
7196 ((js2-name-node-p node) node)
7197 ((js2-function-node-p node)
7198 (js2-function-node-name node))
7199 ((js2-class-node-p node)
7200 (js2-class-node-name node))
7201 ((js2-comp-loop-node-p node)
7202 (js2-comp-loop-node-iterator node))
7205 (defun js2--highlight-unused-variable (symbol info)
7206 (let ((name (js2-symbol-name symbol))
7210 (unless (and inited refs)
7213 (setq pos (js2-node-abs-pos ref))
7214 (setq len (js2-name-node-len ref))
7215 (js2-report-warning "msg.uninitialized.variable" name pos len
7217 (when (or js2-warn-about-unused-function-arguments
7218 (not (eq inited ?P)))
7219 (let* ((symn (js2-symbol-ast-node symbol))
7220 (namen (js2--get-name-node symn)))
7221 (unless (js2-node-top-level-decl-p namen)
7222 (setq pos (js2-node-abs-pos namen))
7223 (setq len (js2-name-node-len namen))
7224 (js2-report-warning "msg.unused.variable" name pos len
7225 'js2-warning))))))))
7227 (defun js2-highlight-unused-variables ()
7228 "Highlight unused variables."
7229 (let ((vars (js2--classify-variables)))
7230 (maphash #'js2--highlight-unused-variable vars)))
7233 (define-minor-mode js2-highlight-unused-variables-mode
7234 "Toggle highlight of unused variables."
7236 (if js2-highlight-unused-variables-mode
7237 (add-hook 'js2-post-parse-callbacks
7238 #'js2-highlight-unused-variables nil t)
7239 (remove-hook 'js2-post-parse-callbacks
7240 #'js2-highlight-unused-variables t)))
7242 (defun js2-set-default-externs ()
7243 "Set the value of `js2-default-externs' based on the various
7244 `js2-include-?-externs' variables."
7245 (setq js2-default-externs
7246 (append js2-ecma-262-externs
7247 (if js2-include-browser-externs js2-browser-externs)
7248 (if (and js2-include-browser-externs
7249 (>= js2-language-version 200)) js2-harmony-externs)
7250 (if js2-include-rhino-externs js2-rhino-externs)
7251 (if js2-include-node-externs js2-node-externs)
7252 (if (or js2-include-browser-externs js2-include-node-externs)
7253 js2-typed-array-externs))))
7255 (defun js2-apply-jslint-globals ()
7256 (setq js2-additional-externs
7257 (nconc (js2-get-jslint-globals)
7258 js2-additional-externs)))
7260 (defun js2-get-jslint-globals ()
7261 (cl-loop for node in (js2-ast-root-comments js2-mode-ast)
7262 when (and (eq 'block (js2-comment-node-format node))
7264 (goto-char (js2-node-abs-pos node))
7265 (looking-at "/\\*global ")))
7266 append (js2-get-jslint-globals-in
7268 (js2-node-abs-end node))))
7270 (defun js2-get-jslint-globals-in (beg end)
7274 (while (re-search-forward js2-mode-identifier-re end t)
7275 (let ((match (match-string 0)))
7276 (unless (member match '("true" "false"))
7277 (push match res)))))
7282 ;; We currently only support imenu, but eventually should support speedbar and
7283 ;; possibly other browsing mechanisms.
7285 ;; The basic strategy is to identify function assignment targets of the form
7286 ;; `foo.bar.baz', convert them to (list fn foo bar baz <position>), and push the
7287 ;; list into `js2-imenu-recorder'. The lists are merged into a trie-like tree
7288 ;; for imenu after parsing is finished.
7290 ;; A `foo.bar.baz' assignment target may be expressed in many ways in
7291 ;; JavaScript, and the general problem is undecidable. However, several forms
7292 ;; are readily recognizable at parse-time; the forms we attempt to recognize
7295 ;; function foo() -- function declaration
7296 ;; foo = function() -- function expression assigned to variable
7297 ;; foo.bar.baz = function() -- function expr assigned to nested property-get
7298 ;; foo = {bar: function()} -- fun prop in object literal assigned to var
7299 ;; foo = {bar: {baz: function()}} -- inside nested object literal
7300 ;; foo.bar = {baz: function()}} -- obj lit assigned to nested prop get
7301 ;; a.b = {c: {d: function()}} -- nested obj lit assigned to nested prop get
7302 ;; foo = {get bar() {...}} -- getter/setter in obj literal
7303 ;; function foo() {function bar() {...}} -- nested function
7304 ;; foo['a'] = function() -- fun expr assigned to deterministic element-get
7306 ;; This list boils down to a few forms that can be combined recursively.
7307 ;; Top-level named function declarations include both the left-hand (name)
7308 ;; and the right-hand (function value) expressions needed to produce an imenu
7309 ;; entry. The other "right-hand" forms we need to look for are:
7310 ;; - functions declared as props/getters/setters in object literals
7311 ;; - nested named function declarations
7312 ;; The "left-hand" expressions that functions can be assigned to include:
7313 ;; - local/global variables
7314 ;; - nested property-get expressions like a.b.c.d
7315 ;; - element gets like foo[10] or foo['bar'] where the index
7316 ;; expression can be trivially converted to a property name. They
7317 ;; effectively then become property gets.
7319 ;; All the different definition types are canonicalized into the form
7320 ;; foo.bar.baz = position-of-function-keyword
7322 ;; We need to build a trie-like structure for imenu. As an example,
7323 ;; consider the following JavaScript code:
7325 ;; a = function() {...} // function at position 5
7326 ;; b = function() {...} // function at position 25
7327 ;; foo = function() {...} // function at position 100
7328 ;; foo.bar = function() {...} // function at position 200
7329 ;; foo.bar.baz = function() {...} // function at position 300
7330 ;; foo.bar.zab = function() {...} // function at position 400
7332 ;; During parsing we accumulate an entry for each definition in
7333 ;; the variable `js2-imenu-recorder', like so:
7339 ;; (fn foo bar baz 300)
7340 ;; (fn foo bar zab 400))
7342 ;; Where 'fn' is the respective function node.
7343 ;; After parsing these entries are merged into this alist-trie:
7347 ;; (foo (<definition> . 3)
7348 ;; (bar (<definition> . 6)
7352 ;; Note the wacky need for a <definition> name. The token can be anything
7353 ;; that isn't a valid JavaScript identifier, because you might make foo
7354 ;; a function and then start setting properties on it that are also functions.
7356 (defun js2-prop-node-name (node)
7357 "Return the name of a node that may be a property-get/property-name.
7358 If NODE is not a valid name-node, string-node or integral number-node,
7359 returns nil. Otherwise returns the string name/value of the node."
7361 ((js2-name-node-p node)
7362 (js2-name-node-name node))
7363 ((js2-string-node-p node)
7364 (js2-string-node-value node))
7365 ((and (js2-number-node-p node)
7366 (string-match "^[0-9]+$" (js2-number-node-value node)))
7367 (js2-number-node-value node))
7368 ((eq (js2-node-type node) js2-THIS)
7370 ((eq (js2-node-type node) js2-SUPER)
7373 (defun js2-node-qname-component (node)
7374 "Return the name of this node, if it contributes to a qname.
7375 Returns nil if the node doesn't contribute."
7377 (or (js2-prop-node-name node)
7378 (if (and (js2-function-node-p node)
7379 (js2-function-node-name node))
7380 (js2-name-node-name (js2-function-node-name node))))))
7382 (defun js2-record-imenu-entry (fn-node qname pos)
7383 "Add an entry to `js2-imenu-recorder'.
7384 FN-NODE should be the current item's function node.
7386 Associate FN-NODE with its QNAME for later lookup.
7387 This is used in postprocessing the chain list. For each chain, we find
7388 the parent function, look up its qname, then prepend a copy of it to the chain."
7389 (push (cons fn-node (append qname (list pos))) js2-imenu-recorder)
7390 (unless js2-imenu-function-map
7391 (setq js2-imenu-function-map (make-hash-table :test 'eq)))
7392 (puthash fn-node qname js2-imenu-function-map))
7394 (defun js2-record-imenu-functions (node &optional var)
7395 "Record function definitions for imenu.
7396 NODE is a function node or an object literal.
7397 VAR, if non-nil, is the expression that NODE is being assigned to.
7398 When passed arguments of wrong type, does nothing."
7399 (when js2-parse-ide-mode
7400 (let ((fun-p (js2-function-node-p node))
7403 ;; non-anonymous function declaration?
7406 (setq fname-node (js2-function-node-name node)))
7407 (js2-record-imenu-entry node (list fname-node) (js2-node-pos node)))
7408 ;; for remaining forms, compute left-side tree branch first
7409 ((and var (setq qname (js2-compute-nested-prop-get var)))
7411 ;; foo.bar.baz = function
7413 (js2-record-imenu-entry node qname (js2-node-pos node)))
7414 ;; foo.bar.baz = object-literal
7415 ;; look for nested functions: {a: {b: function() {...} }}
7416 ((js2-object-node-p node)
7417 ;; Node position here is still absolute, since the parser
7418 ;; passes the assignment target and value expressions
7419 ;; to us before they are added as children of the assignment node.
7420 (js2-record-object-literal node qname (js2-node-pos node)))))))))
7422 (defun js2-compute-nested-prop-get (node)
7423 "If NODE is of form foo.bar, foo['bar'], or any nested combination, return
7424 component nodes as a list. Otherwise return nil. Element-gets are treated
7425 as property-gets if the index expression is a string, or a positive integer."
7426 (let (left right head)
7428 ((or (js2-name-node-p node)
7429 (js2-this-or-super-node-p node))
7431 ;; foo.bar.baz is parenthesized as (foo.bar).baz => right operand is a leaf
7432 ((js2-prop-get-node-p node) ; foo.bar
7433 (setq left (js2-prop-get-node-left node)
7434 right (js2-prop-get-node-right node))
7435 (if (setq head (js2-compute-nested-prop-get left))
7436 (nconc head (list right))))
7437 ((js2-elem-get-node-p node) ; foo['bar'] or foo[101]
7438 (setq left (js2-elem-get-node-target node)
7439 right (js2-elem-get-node-element node))
7440 (if (or (js2-string-node-p right) ; ['bar']
7441 (and (js2-number-node-p right) ; [10]
7442 (string-match "^[0-9]+$"
7443 (js2-number-node-value right))))
7444 (if (setq head (js2-compute-nested-prop-get left))
7445 (nconc head (list right))))))))
7447 (defun js2-record-object-literal (node qname pos)
7448 "Recursively process an object literal looking for functions.
7449 NODE is an object literal that is the right-hand child of an assignment
7450 expression. QNAME is a list of nodes representing the assignment target,
7451 e.g. for foo.bar.baz = {...}, QNAME is (foo-node bar-node baz-node).
7452 POS is the absolute position of the node.
7453 We do a depth-first traversal of NODE. For any functions we find,
7454 we append the property name to QNAME, then call `js2-record-imenu-entry'."
7456 (dolist (e (js2-object-node-elems node)) ; e is a `js2-object-prop-node'
7457 (let ((left (js2-infix-node-left e))
7458 ;; Element positions are relative to the parent position.
7459 (pos (+ pos (js2-node-pos e))))
7461 ;; foo: function() {...}
7462 ((js2-function-node-p (setq right (js2-infix-node-right e)))
7463 (when (js2-prop-node-name left)
7464 ;; As a policy decision, we record the position of the property,
7465 ;; not the position of the `function' keyword, since the property
7466 ;; is effectively the name of the function.
7467 (js2-record-imenu-entry right (append qname (list left)) pos)))
7468 ;; foo: {object-literal} -- add foo to qname, offset position, and recurse
7469 ((js2-object-node-p right)
7470 (js2-record-object-literal right
7471 (append qname (list (js2-infix-node-left e)))
7472 (+ pos (js2-node-pos right)))))))))
7474 (defun js2-node-top-level-decl-p (node)
7475 "Return t if NODE's name is defined in the top-level scope.
7476 Also returns t if NODE's name is not defined in any scope, since it implies
7477 that it's an external variable, which must also be in the top-level scope."
7478 (let* ((name (js2-prop-node-name node))
7479 (this-scope (js2-node-get-enclosing-scope node))
7482 ((js2-this-or-super-node-p node)
7486 ((setq defining-scope (js2-get-defining-scope this-scope name))
7487 (js2-ast-root-p defining-scope))
7490 (defun js2-wrapper-function-p (node)
7491 "Return t if NODE is a function expression that's immediately invoked.
7492 NODE must be `js2-function-node'."
7493 (let ((parent (js2-node-parent node)))
7495 ;; function(){...}();
7496 (and (js2-call-node-p parent)
7497 (eq node (js2-call-node-target parent)))
7498 (and (js2-paren-node-p parent)
7499 ;; (function(){...})();
7500 (or (js2-call-node-p (setq parent (js2-node-parent parent)))
7501 ;; (function(){...}).call(this);
7502 (and (js2-prop-get-node-p parent)
7503 (member (js2-name-node-name (js2-prop-get-node-right parent))
7505 (js2-call-node-p (js2-node-parent parent))))))))
7507 (defun js2-browse-postprocess-chains ()
7508 "Modify function-declaration name chains after parsing finishes.
7509 Some of the information is only available after the parse tree is complete.
7510 For instance, processing a nested scope requires a parent function node."
7511 (let (result fn parent-qname p elem)
7512 (dolist (entry js2-imenu-recorder)
7513 ;; function node goes first
7514 (cl-destructuring-bind (current-fn &rest (&whole chain head &rest _)) entry
7515 ;; Examine head's defining scope:
7516 ;; Pre-processed chain, or top-level/external, keep as-is.
7517 (if (or (stringp head) (js2-node-top-level-decl-p head))
7519 (when (js2-this-or-super-node-p head)
7520 (setq chain (cdr chain))) ; discard this-node
7521 (when (setq fn (js2-node-parent-script-or-fn current-fn))
7522 (setq parent-qname (gethash fn js2-imenu-function-map 'not-found))
7523 (when (eq parent-qname 'not-found)
7524 ;; anonymous function expressions are not recorded
7525 ;; during the parse, so we need to handle this case here
7527 (if (js2-wrapper-function-p fn)
7528 (let ((grandparent (js2-node-parent-script-or-fn fn)))
7529 (if (js2-ast-root-p grandparent)
7531 (gethash grandparent js2-imenu-function-map 'skip)))
7533 (puthash fn parent-qname js2-imenu-function-map))
7534 (if (eq parent-qname 'skip)
7535 ;; We don't show it, let's record that fact.
7536 (remhash current-fn js2-imenu-function-map)
7537 ;; Prepend parent fn qname to this chain.
7538 (let ((qname (append parent-qname chain)))
7539 (puthash current-fn (butlast qname) js2-imenu-function-map)
7540 (push qname result)))))))
7541 ;; Collect chains obtained by third-party code.
7542 (let (js2-imenu-recorder)
7543 (run-hooks 'js2-build-imenu-callbacks)
7544 (dolist (entry js2-imenu-recorder)
7545 (push (cdr entry) result)))
7546 ;; Finally replace each node in each chain with its name.
7547 (dolist (chain result)
7550 (if (js2-node-p (setq elem (car p)))
7551 (setcar p (js2-node-qname-component elem)))
7555 ;; Merge name chains into a trie-like tree structure of nested lists.
7556 ;; To simplify construction of the trie, we first build it out using the rule
7557 ;; that the trie consists of lists of pairs. Each pair is a 2-element array:
7558 ;; [key, num-or-list]. The second element can be a number; if so, this key
7559 ;; is a leaf-node with only one value. (I.e. there is only one declaration
7560 ;; associated with the key at this level.) Otherwise the second element is
7561 ;; a list of pairs, with the rule applied recursively. This symmetry permits
7562 ;; a simple recursive formulation.
7564 ;; js2-mode is building the data structure for imenu. The imenu documentation
7565 ;; claims that it's the structure above, but in practice it wants the children
7566 ;; at the same list level as the key for that level, which is how I've drawn
7567 ;; the "Expected final result" above. We'll postprocess the trie to remove the
7568 ;; list wrapper around the children at each level.
7570 ;; A completed nested imenu-alist entry looks like this:
7572 ;; ("<definition>" . 7)
7577 ;; In particular, the documentation for `imenu--index-alist' says that
7578 ;; a nested sub-alist element looks like (INDEX-NAME SUB-ALIST).
7579 ;; The sub-alist entries immediately follow INDEX-NAME, the head of the list.
7581 (defun js2-treeify (lst)
7582 "Convert (a b c d) to (a ((b ((c d)))))."
7583 (if (null (cddr lst)) ; list length <= 2
7585 (list (car lst) (list (js2-treeify (cdr lst))))))
7587 (defun js2-build-alist-trie (chains trie)
7588 "Merge declaration name chains into a trie-like alist structure for imenu.
7589 CHAINS is the qname chain list produced during parsing. TRIE is a
7590 list of elements built up so far."
7591 (let (head tail pos branch kids)
7592 (dolist (chain chains)
7593 (setq head (car chain)
7595 pos (if (numberp (car tail)) (car tail))
7596 branch (js2-find-if (lambda (n)
7597 (string= (car n) head))
7599 kids (cl-second branch))
7601 ;; case 1: this key isn't in the trie yet
7604 (setcdr (last trie) (list (js2-treeify chain)))
7605 (setq trie (list (js2-treeify chain)))))
7606 ;; case 2: key is present with a single number entry: replace w/ list
7607 ;; ("a1" 10) + ("a1" 20) => ("a1" (("<definition>" 10)
7608 ;; ("<definition>" 20)))
7610 (setcar (cdr branch)
7611 (list (list "<definition-1>" kids)
7613 (list "<definition-2>" pos)
7614 (js2-treeify tail)))))
7615 ;; case 3: key is there (with kids), and we're a number entry
7619 (list (format "<definition-%d>"
7620 (1+ (cl-loop for kid in kids
7621 count (eq ?< (aref (car kid) 0)))))
7623 ;; case 4: key is there with kids, need to merge in our chain
7625 (js2-build-alist-trie (list tail) kids))))
7628 (defun js2-flatten-trie (trie)
7629 "Convert TRIE to imenu-format.
7630 Recurses through nodes, and for each one whose second element is a list,
7631 appends the list's flattened elements to the current element. Also
7632 changes the tails into conses. For instance, this pre-flattened trie
7644 Note that the root of the trie has no key, just a list of chains.
7645 This is also true for the value of any key with multiple children,
7646 e.g. key 'c' in the example above."
7649 (mapcar #'js2-flatten-trie trie))
7651 (if (numberp (cl-second trie))
7652 (cons (car trie) (cl-second trie))
7653 ;; else pop list and append its kids
7654 (apply #'append (list (car trie)) (js2-flatten-trie (cdr trie)))))))
7656 (defun js2-build-imenu-index ()
7657 "Turn `js2-imenu-recorder' into an imenu data structure."
7658 (when (eq js2-imenu-recorder 'empty)
7659 (setq js2-imenu-recorder nil))
7660 (let* ((chains (js2-browse-postprocess-chains))
7661 (result (js2-build-alist-trie chains nil)))
7662 (js2-flatten-trie result)))
7664 (defun js2-test-print-chains (chains)
7665 "Print a list of qname chains.
7666 Each element of CHAINS is a list of the form (NODE [NODE *] pos);
7667 i.e. one or more nodes, and an integer position as the list tail."
7668 (mapconcat (lambda (chain)
7670 (mapconcat (lambda (elem)
7671 (if (js2-node-p elem)
7672 (or (js2-node-qname-component elem)
7674 (number-to-string elem)))
7683 (defconst js2-version "1.8.5"
7684 "Version of JavaScript supported.")
7686 (defun js2-record-face (face &optional token)
7687 "Record a style run of FACE for TOKEN or the current token."
7688 (unless token (setq token (js2-current-token)))
7689 (js2-set-face (js2-token-beg token) (js2-token-end token) face 'record))
7691 (defsubst js2-node-end (n)
7692 "Computes the absolute end of node N.
7693 Use with caution! Assumes `js2-node-pos' is -absolute-, which
7694 is only true until the node is added to its parent; i.e., while parsing."
7698 (defun js2-record-comment (token)
7699 "Record a comment in `js2-scanned-comments'."
7700 (let ((ct (js2-token-comment-type token))
7701 (beg (js2-token-beg token))
7702 (end (js2-token-end token)))
7703 (push (make-js2-comment-node :len (- end beg)
7705 js2-scanned-comments)
7706 (when js2-parse-ide-mode
7707 (js2-record-face (if (eq ct 'jsdoc)
7709 'font-lock-comment-face)
7711 (when (memq ct '(html preprocessor))
7712 ;; Tell cc-engine the bounds of the comment.
7713 (js2-record-text-property beg (1- end) 'c-in-sws t)))))
7715 (defun js2-peek-token ()
7716 "Return the next token type without consuming it.
7717 If `js2-ti-lookahead' is positive, return the type of next token
7718 from `js2-ti-tokens'. Otherwise, call `js2-get-token'."
7719 (if (not (zerop js2-ti-lookahead))
7721 (aref js2-ti-tokens (mod (1+ js2-ti-tokens-cursor) js2-ti-ntokens)))
7722 (let ((tt (js2-get-token-internal nil)))
7726 (defalias 'js2-next-token 'js2-get-token)
7728 (defun js2-match-token (match &optional dont-unget)
7729 "Get next token and return t if it matches MATCH, a bytecode.
7730 Returns nil and consumes nothing if MATCH is not the next token."
7731 (if (/= (js2-get-token) match)
7732 (ignore (unless dont-unget (js2-unget-token)))
7735 (defun js2-match-contextual-kwd (name)
7736 "Consume and return t if next token is `js2-NAME', and its
7737 string is NAME. Returns nil and keeps current token otherwise."
7738 (if (js2-contextual-kwd-p (progn (js2-get-token)
7739 (js2-current-token))
7741 (progn (js2-record-face 'font-lock-keyword-face) t)
7745 (defun js2-contextual-kwd-p (token name)
7746 "Return t if TOKEN is `js2-NAME', and its string is NAME."
7747 (and (= (js2-token-type token) js2-NAME)
7748 (string= (js2-token-string token) name)))
7750 (defun js2-match-async-function ()
7751 (when (and (js2-contextual-kwd-p (js2-current-token) "async")
7752 (= (js2-peek-token) js2-FUNCTION))
7753 (js2-record-face 'font-lock-keyword-face)
7757 (defun js2-match-async-arrow-function ()
7758 (and (js2-contextual-kwd-p (js2-current-token) "async")
7759 (/= (js2-peek-token) js2-FUNCTION)))
7761 (defsubst js2-inside-function ()
7762 (cl-plusp js2-nesting-of-function))
7764 (defsubst js2-inside-async-function ()
7765 (and (js2-inside-function)
7766 (js2-function-node-async js2-current-script-or-fn)))
7768 (defun js2-parse-await-maybe (tt)
7769 "Parse \"await\" as an AwaitExpression, if it is one."
7770 (and (= tt js2-NAME)
7771 (js2-contextual-kwd-p (js2-current-token) "await")
7772 ;; Per the proposal, AwaitExpression consists of "await"
7773 ;; followed by a UnaryExpression. So look ahead for one.
7774 (let ((ts-state (make-js2-ts-state))
7775 (recorded-identifiers js2-recorded-identifiers)
7776 (parsed-errors js2-parsed-errors)
7777 (current-token (js2-current-token))
7778 (beg (js2-current-token-beg))
7779 (end (js2-current-token-end))
7782 (setq pn (js2-make-unary js2-AWAIT 'js2-parse-unary-expr))
7783 (if (= (js2-node-type (js2-unary-node-operand pn)) js2-ERROR)
7784 ;; The parse failed, so pretend like nothing happened and restore
7785 ;; the previous parsing state.
7787 (js2-ts-seek ts-state)
7788 (setq js2-recorded-identifiers recorded-identifiers
7789 js2-parsed-errors parsed-errors)
7790 ;; And ensure the caller knows about the failure.
7792 ;; The parse was successful, so process and return the "await".
7793 (js2-record-face 'font-lock-keyword-face current-token)
7794 (unless (js2-inside-async-function)
7795 (js2-report-error "msg.bad.await" nil
7799 (defun js2-get-prop-name-token ()
7800 (js2-get-token (and (>= js2-language-version 170) 'KEYWORD_IS_NAME)))
7802 (defun js2-match-prop-name ()
7803 "Consume token and return t if next token is a valid property name.
7804 If `js2-language-version' is >= 180, a keyword or reserved word
7805 is considered valid name as well."
7806 (if (eq js2-NAME (js2-get-prop-name-token))
7811 (defun js2-must-match-prop-name (msg-id &optional pos len)
7812 (if (js2-match-prop-name)
7814 (js2-report-error msg-id nil pos len)
7817 (defun js2-peek-token-or-eol ()
7818 "Return js2-EOL if the next token immediately follows a newline.
7819 Else returns the next token. Used in situations where we don't
7820 consider certain token types valid if they are preceded by a newline.
7821 One example is the postfix ++ or -- operator, which has to be on the
7822 same line as its operand."
7823 (let ((tt (js2-get-token))
7824 (follows-eol (js2-token-follows-eol-p (js2-current-token))))
7830 (defun js2-must-match (token msg-id &optional pos len)
7831 "Match next token to token code TOKEN, or record a syntax error.
7832 MSG-ID is the error message to report if the match fails.
7833 Returns t on match, nil if no match."
7834 (if (js2-match-token token t)
7836 (js2-report-error msg-id nil pos len)
7840 (defun js2-must-match-name (msg-id)
7841 (if (js2-match-token js2-NAME t)
7843 (if (eq (js2-current-token-type) js2-RESERVED)
7844 (js2-report-error "msg.reserved.id" (js2-current-token-string))
7845 (js2-report-error msg-id)
7849 (defun js2-set-requires-activation ()
7850 (if (js2-function-node-p js2-current-script-or-fn)
7851 (setf (js2-function-node-needs-activation js2-current-script-or-fn) t)))
7853 (defun js2-check-activation-name (name _token)
7854 (when (js2-inside-function)
7855 ;; skip language-version 1.2 check from Rhino
7856 (if (or (string= "arguments" name)
7857 (and js2-compiler-activation-names ; only used in codegen
7858 (gethash name js2-compiler-activation-names)))
7859 (js2-set-requires-activation))))
7861 (defun js2-set-is-generator ()
7862 (let ((fn-node js2-current-script-or-fn))
7863 (when (and (js2-function-node-p fn-node)
7864 (not (js2-function-node-generator-type fn-node)))
7865 (setf (js2-function-node-generator-type js2-current-script-or-fn) 'LEGACY))))
7867 (defun js2-must-have-xml ()
7868 (unless js2-compiler-xml-available
7869 (js2-report-error "msg.XML.not.available")))
7871 (defun js2-push-scope (scope)
7872 "Push SCOPE, a `js2-scope', onto the lexical scope chain."
7873 (cl-assert (js2-scope-p scope))
7874 (cl-assert (null (js2-scope-parent-scope scope)))
7875 (cl-assert (not (eq js2-current-scope scope)))
7876 (setf (js2-scope-parent-scope scope) js2-current-scope
7877 js2-current-scope scope))
7879 (defsubst js2-pop-scope ()
7880 (setq js2-current-scope
7881 (js2-scope-parent-scope js2-current-scope)))
7883 (defun js2-enter-loop (loop-node)
7884 (push loop-node js2-loop-set)
7885 (push loop-node js2-loop-and-switch-set)
7886 (js2-push-scope loop-node)
7887 ;; Tell the current labeled statement (if any) its statement,
7888 ;; and set the jump target of the first label to the loop.
7889 ;; These are used in `js2-parse-continue' to verify that the
7890 ;; continue target is an actual labeled loop. (And for codegen.)
7891 (when js2-labeled-stmt
7892 (setf (js2-labeled-stmt-node-stmt js2-labeled-stmt) loop-node
7893 (js2-label-node-loop (car (js2-labeled-stmt-node-labels
7894 js2-labeled-stmt))) loop-node)))
7896 (defun js2-exit-loop ()
7898 (pop js2-loop-and-switch-set)
7901 (defsubst js2-enter-switch (switch-node)
7902 (push switch-node js2-loop-and-switch-set))
7904 (defsubst js2-exit-switch ()
7905 (pop js2-loop-and-switch-set))
7907 (defsubst js2-get-directive (node)
7908 "Return NODE's value if it is a directive, nil otherwise.
7910 A directive is an otherwise-meaningless expression statement
7911 consisting of a string literal, such as \"use strict\"."
7912 (and (js2-expr-stmt-node-p node)
7913 (js2-string-node-p (setq node (js2-expr-stmt-node-expr node)))
7914 (js2-string-node-value node)))
7916 (defun js2-parse (&optional buf cb)
7917 "Tell the js2 parser to parse a region of JavaScript.
7919 BUF is a buffer or buffer name containing the code to parse.
7920 Call `narrow-to-region' first to parse only part of the buffer.
7922 The returned AST root node is given some additional properties:
7923 `node-count' - total number of nodes in the AST
7924 `buffer' - BUF. The buffer it refers to may change or be killed,
7925 so the value is not necessarily reliable.
7927 An optional callback CB can be specified to report parsing
7928 progress. If `(functionp CB)' returns t, it will be called with
7929 the current line number once before parsing begins, then again
7930 each time the lexer reaches a new line number.
7932 CB can also be a list of the form `(symbol cb ...)' to specify
7933 multiple callbacks with different criteria. Each symbol is a
7934 criterion keyword, and the following element is the callback to
7937 :line - called whenever the line number changes
7938 :token - called for each new token consumed
7940 The list of criteria could be extended to include entering or
7941 leaving a statement, an expression, or a function definition."
7942 (if (and cb (not (functionp cb)))
7943 (error "criteria callbacks not yet implemented"))
7944 (let ((inhibit-point-motion-hooks t)
7945 (js2-compiler-xml-available (>= js2-language-version 160))
7946 ;; This is a recursive-descent parser, so give it a big stack.
7947 (max-lisp-eval-depth (max max-lisp-eval-depth 3000))
7948 (max-specpdl-size (max max-specpdl-size 3000))
7949 (case-fold-search nil)
7951 (with-current-buffer (or buf (current-buffer))
7952 (setq js2-scanned-comments nil
7953 js2-parsed-errors nil
7954 js2-parsed-warnings nil
7955 js2-imenu-recorder nil
7956 js2-imenu-function-map nil
7959 (setq ast (js2-do-parse))
7960 (unless js2-ts-hit-eof
7961 (js2-report-error "msg.got.syntax.errors" (length js2-parsed-errors)))
7962 (setf (js2-ast-root-errors ast) js2-parsed-errors
7963 (js2-ast-root-warnings ast) js2-parsed-warnings)
7964 ;; if we didn't find any declarations, put a dummy in this list so we
7965 ;; don't end up re-parsing the buffer in `js2-mode-create-imenu-index'
7966 (unless js2-imenu-recorder
7967 (setq js2-imenu-recorder 'empty))
7968 (run-hooks 'js2-parse-finished-hook)
7971 ;; Corresponds to Rhino's Parser.parse() method.
7972 (defun js2-do-parse ()
7973 "Parse current buffer starting from current point.
7974 Scanner should be initialized."
7975 (let ((pos js2-ts-cursor)
7976 (end js2-ts-cursor) ; in case file is empty
7978 (in-directive-prologue t)
7979 (js2-in-use-strict-directive js2-in-use-strict-directive)
7981 ;; initialize buffer-local parsing vars
7982 (setf root (make-js2-ast-root :buffer (buffer-name) :pos pos)
7983 js2-current-script-or-fn root
7984 js2-current-scope root
7985 js2-nesting-of-function 0
7986 js2-labeled-stmt nil
7987 js2-recorded-identifiers nil ; for js2-highlight
7988 js2-in-use-strict-directive nil)
7989 (while (/= (setq tt (js2-get-token)) js2-EOF)
7990 (if (= tt js2-FUNCTION)
7992 (setq n (if js2-called-by-compile-function
7993 (js2-parse-function-expr)
7994 (js2-parse-function-stmt))))
7995 ;; not a function - parse a statement
7997 (setq n (js2-parse-statement))
7998 (when in-directive-prologue
7999 (setq directive (js2-get-directive n))
8002 (setq in-directive-prologue nil))
8003 ((string= directive "use strict")
8004 (setq js2-in-use-strict-directive t)))))
8005 ;; add function or statement to script
8006 (setq end (js2-node-end n))
8007 (js2-block-node-push root n))
8008 ;; add comments to root in lexical order
8009 (when js2-scanned-comments
8010 ;; if we find a comment beyond end of normal kids, use its end
8011 (setq end (max end (js2-node-end (cl-first js2-scanned-comments))))
8012 (dolist (comment js2-scanned-comments)
8013 (push comment (js2-ast-root-comments root))
8014 (js2-node-add-children root comment)))
8015 (setf (js2-node-len root) (- end pos))
8016 (setq js2-mode-ast root) ; Make sure this is available for callbacks.
8017 ;; Give extensions a chance to muck with things before highlighting starts.
8018 (let ((js2-additional-externs js2-additional-externs))
8020 (run-hooks 'js2-post-parse-callbacks))
8021 (js2-highlight-undeclared-vars))
8024 (defun js2-parse-function-closure-body (fn-node)
8025 "Parse a JavaScript 1.8 function closure body."
8026 (let ((js2-nesting-of-function (1+ js2-nesting-of-function)))
8028 (js2-report-error "msg.no.brace.body" nil
8029 (js2-node-pos fn-node)
8030 (- js2-ts-cursor (js2-node-pos fn-node)))
8031 (js2-node-add-children fn-node
8032 (setf (js2-function-node-body fn-node)
8033 (js2-parse-expr t))))))
8035 (defun js2-parse-function-body (fn-node)
8036 (js2-must-match js2-LC "msg.no.brace.body"
8037 (js2-node-pos fn-node)
8038 (- js2-ts-cursor (js2-node-pos fn-node)))
8039 (let ((pos (js2-current-token-beg)) ; LC position
8040 (pn (make-js2-block-node)) ; starts at LC position
8043 not-in-directive-prologue
8046 (cl-incf js2-nesting-of-function)
8048 (while (not (or (= (setq tt (js2-peek-token)) js2-ERROR)
8051 (js2-block-node-push
8053 (if (/= tt js2-FUNCTION)
8054 (if not-in-directive-prologue
8055 (js2-parse-statement)
8056 (setq node (js2-parse-statement)
8057 directive (js2-get-directive node))
8060 (setq not-in-directive-prologue t))
8061 ((string= directive "use strict")
8062 ;; Back up and reparse the function, because new rules apply
8063 ;; to the function name and parameters.
8064 (when (not js2-in-use-strict-directive)
8065 (setq js2-in-use-strict-directive t)
8066 (throw 'reparse t))))
8069 (js2-parse-function-stmt))))
8070 (cl-decf js2-nesting-of-function))
8071 (setq end (js2-current-token-end)) ; assume no curly and leave at current token
8072 (if (js2-must-match js2-RC "msg.no.brace.after.body" pos)
8073 (setq end (js2-current-token-end)))
8074 (setf (js2-node-pos pn) pos
8075 (js2-node-len pn) (- end pos))
8076 (setf (js2-function-node-body fn-node) pn)
8077 (js2-node-add-children fn-node pn)
8080 (defun js2-define-destruct-symbols (node decl-type face &optional ignore-not-in-block)
8081 "Declare and fontify destructuring parameters inside NODE.
8082 NODE is either `js2-array-node', `js2-object-node', or `js2-name-node'.
8084 Return a list of `js2-name-node' nodes representing the symbols
8085 declared; probably to check them for errors."
8088 ((js2-name-node-p node)
8090 (js2-define-symbol decl-type (js2-name-node-name node)
8091 node ignore-not-in-block)
8093 (js2-set-face (setq leftpos (js2-node-abs-pos node))
8094 (+ leftpos (js2-node-len node))
8097 ((js2-object-node-p node)
8098 (dolist (elem (js2-object-node-elems node))
8099 ;; js2-infix-node-p catches both object prop node and initialized
8100 ;; binding element (which is directly an infix node).
8101 (when (js2-infix-node-p elem)
8102 (push (js2-define-destruct-symbols
8103 (js2-infix-node-left elem)
8104 decl-type face ignore-not-in-block)
8106 (apply #'append (nreverse name-nodes)))
8107 ((js2-array-node-p node)
8108 (dolist (elem (js2-array-node-elems node))
8110 (if (js2-infix-node-p elem) (setq elem (js2-infix-node-left elem)))
8111 (push (js2-define-destruct-symbols
8112 elem decl-type face ignore-not-in-block)
8114 (apply #'append (nreverse name-nodes)))
8115 (t (js2-report-error "msg.no.parm" nil (js2-node-abs-pos node)
8116 (js2-node-len node))
8119 (defvar js2-illegal-strict-identifiers
8120 '("eval" "arguments")
8121 "Identifiers not allowed as variables in strict mode.")
8123 (defun js2-check-strict-identifier (name-node)
8124 "Check that NAME-NODE makes a legal strict mode identifier."
8125 (when js2-in-use-strict-directive
8126 (let ((param-name (js2-name-node-name name-node)))
8127 (when (member param-name js2-illegal-strict-identifiers)
8128 (js2-report-error "msg.bad.id.strict" param-name
8129 (js2-node-abs-pos name-node) (js2-node-len name-node))))))
8131 (defun js2-check-strict-function-params (preceding-params params)
8132 "Given PRECEDING-PARAMS in a function's parameter list, check
8133 for strict mode errors caused by PARAMS."
8134 (when js2-in-use-strict-directive
8135 (dolist (param params)
8136 (let ((param-name (js2-name-node-name param)))
8137 (js2-check-strict-identifier param)
8138 (when (cl-some (lambda (param)
8139 (string= (js2-name-node-name param) param-name))
8141 (js2-report-error "msg.dup.param.strict" param-name
8142 (js2-node-abs-pos param) (js2-node-len param)))))))
8144 (defun js2-parse-function-params (function-type fn-node pos)
8145 "Parse the parameters of a function of FUNCTION-TYPE
8146 represented by FN-NODE at POS."
8147 (if (js2-match-token js2-RP)
8148 (setf (js2-function-node-rp fn-node) (- (js2-current-token-beg) pos))
8149 (let ((paren-free-arrow (and (eq function-type 'FUNCTION_ARROW)
8150 (eq (js2-current-token-type) js2-NAME)))
8152 param-name-nodes new-param-name-nodes
8154 (when paren-free-arrow
8156 (cl-loop for tt = (js2-peek-token)
8159 ;; destructuring param
8160 ((and (not paren-free-arrow)
8161 (or (= tt js2-LB) (= tt js2-LC)))
8163 (setq param (js2-parse-destruct-primary-expr)
8164 new-param-name-nodes (js2-define-destruct-symbols
8165 param js2-LP 'js2-function-param))
8166 (js2-check-strict-function-params param-name-nodes new-param-name-nodes)
8167 (setq param-name-nodes (append param-name-nodes new-param-name-nodes)))
8170 (when (and (>= js2-language-version 200)
8171 (not paren-free-arrow)
8172 (js2-match-token js2-TRIPLEDOT)
8173 (not rest-param-at))
8174 ;; to report errors if there are more parameters
8175 (setq rest-param-at (length params)))
8176 (js2-must-match-name "msg.no.parm")
8177 (js2-record-face 'js2-function-param)
8178 (setq param (js2-create-name-node))
8179 (js2-define-symbol js2-LP (js2-current-token-string) param)
8180 (js2-check-strict-function-params param-name-nodes (list param))
8181 (setq param-name-nodes (append param-name-nodes (list param)))))
8182 ;; default parameter value
8183 (when (and (not rest-param-at)
8184 (>= js2-language-version 200)
8185 (js2-match-token js2-ASSIGN))
8186 (cl-assert (not paren-free-arrow))
8187 (let* ((pos (js2-node-pos param))
8188 (tt (js2-current-token-type))
8189 (op-pos (- (js2-current-token-beg) pos))
8191 (right (js2-parse-assign-expr))
8192 (len (- (js2-node-end right) pos)))
8193 (setq param (make-js2-assign-node
8194 :type tt :pos pos :len len :op-pos op-pos
8195 :left left :right right))
8196 (js2-node-add-children param left right)))
8198 (when (and rest-param-at (> (length params) (1+ rest-param-at)))
8199 (js2-report-error "msg.param.after.rest" nil
8200 (js2-node-pos param) (js2-node-len param)))
8202 (js2-match-token js2-COMMA))
8203 (when (and (not paren-free-arrow)
8204 (js2-must-match js2-RP "msg.no.paren.after.parms"))
8205 (setf (js2-function-node-rp fn-node) (- (js2-current-token-beg) pos)))
8207 (setf (js2-function-node-rest-p fn-node) t))
8209 (js2-node-add-children fn-node p)
8210 (push p (js2-function-node-params fn-node))))))
8212 (defun js2-check-inconsistent-return-warning (fn-node name)
8213 "Possibly show inconsistent-return warning.
8214 Last token scanned is the close-curly for the function body."
8215 (when (and js2-mode-show-strict-warnings
8216 js2-strict-inconsistent-return-warning
8217 (not (js2-has-consistent-return-usage
8218 (js2-function-node-body fn-node))))
8219 ;; Have it extend from close-curly to bol or beginning of block.
8220 (let ((pos (save-excursion
8221 (goto-char (js2-current-token-end))
8222 (max (js2-node-abs-pos (js2-function-node-body fn-node))
8224 (end (js2-current-token-end)))
8225 (if (cl-plusp (js2-name-node-length name))
8226 (js2-add-strict-warning "msg.no.return.value"
8227 (js2-name-node-name name) pos end)
8228 (js2-add-strict-warning "msg.anon.no.return.value" nil pos end)))))
8230 (defun js2-parse-function-stmt (&optional async-p)
8231 (let ((pos (js2-current-token-beg))
8232 (star-p (js2-match-token js2-MUL)))
8233 (js2-must-match-name "msg.unnamed.function.stmt")
8234 (let ((name (js2-create-name-node t))
8237 ((js2-match-token js2-LP)
8238 (js2-parse-function 'FUNCTION_STATEMENT pos star-p async-p name))
8239 (js2-allow-member-expr-as-function-name
8240 (setq member-expr (js2-parse-member-expr-tail nil name))
8241 (js2-parse-highlight-member-expr-fn-name member-expr)
8242 (js2-must-match js2-LP "msg.no.paren.parms")
8243 (setf pn (js2-parse-function 'FUNCTION_STATEMENT pos star-p async-p)
8244 (js2-function-node-member-expr pn) member-expr)
8247 (js2-report-error "msg.no.paren.parms")
8248 (make-js2-error-node))))))
8250 (defun js2-parse-async-function-stmt ()
8251 (js2-parse-function-stmt t))
8253 (defun js2-parse-function-expr (&optional async-p)
8254 (let ((pos (js2-current-token-beg))
8255 (star-p (js2-match-token js2-MUL))
8257 (when (js2-match-token js2-NAME)
8258 (setq name (js2-create-name-node t)))
8259 (js2-must-match js2-LP "msg.no.paren.parms")
8260 (js2-parse-function 'FUNCTION_EXPRESSION pos star-p async-p name)))
8262 (defun js2-parse-function-internal (function-type pos star-p &optional async-p name)
8264 (if (= (js2-current-token-type) js2-LP) ; eventually matched LP?
8265 (setq lp (js2-current-token-beg)))
8266 (setf fn-node (make-js2-function-node :pos pos
8269 :lp (if lp (- lp pos))
8270 :generator-type (and star-p 'STAR)
8273 (js2-set-face (js2-node-pos name) (js2-node-end name)
8274 'font-lock-function-name-face 'record)
8275 (when (and (eq function-type 'FUNCTION_STATEMENT)
8276 (cl-plusp (js2-name-node-length name)))
8277 ;; Function statements define a symbol in the enclosing scope
8278 (js2-define-symbol js2-FUNCTION (js2-name-node-name name) fn-node))
8279 (when js2-in-use-strict-directive
8280 (js2-check-strict-identifier name)))
8281 (if (or (js2-inside-function) (cl-plusp js2-nesting-of-with))
8282 ;; 1. Nested functions are not affected by the dynamic scope flag
8283 ;; as dynamic scope is already a parent of their scope.
8284 ;; 2. Functions defined under the with statement also immune to
8285 ;; this setup, in which case dynamic scope is ignored in favor
8286 ;; of the with object.
8287 (setf (js2-function-node-ignore-dynamic fn-node) t))
8288 ;; dynamically bind all the per-function variables
8289 (let ((js2-current-script-or-fn fn-node)
8290 (js2-current-scope fn-node)
8291 (js2-nesting-of-with 0)
8295 js2-loop-and-switch-set)
8296 (js2-parse-function-params function-type fn-node pos)
8297 (when (eq function-type 'FUNCTION_ARROW)
8298 (js2-must-match js2-ARROW "msg.bad.arrow.args"))
8299 (if (and (>= js2-language-version 180)
8300 (/= (js2-peek-token) js2-LC))
8301 (js2-parse-function-closure-body fn-node)
8302 (js2-parse-function-body fn-node))
8303 (js2-check-inconsistent-return-warning fn-node name)
8306 (js2-node-add-children fn-node name)
8307 ;; Function expressions define a name only in the body of the
8308 ;; function, and only if not hidden by a parameter name
8309 (when (and (eq function-type 'FUNCTION_EXPRESSION)
8310 (null (js2-scope-get-symbol js2-current-scope
8311 (js2-name-node-name name))))
8312 (js2-define-symbol js2-FUNCTION
8313 (js2-name-node-name name)
8315 (when (eq function-type 'FUNCTION_STATEMENT)
8316 (js2-record-imenu-functions fn-node))))
8318 (setf (js2-node-len fn-node) (- js2-ts-cursor pos))
8319 ;; Rhino doesn't do this, but we need it for finding undeclared vars.
8320 ;; We wait until after parsing the function to set its parent scope,
8321 ;; since `js2-define-symbol' needs the defining-scope check to stop
8322 ;; at the function boundary when checking for redeclarations.
8323 (setf (js2-scope-parent-scope fn-node) js2-current-scope)
8326 (defun js2-parse-function (function-type pos star-p &optional async-p name)
8327 "Function parser. FUNCTION-TYPE is a symbol, POS is the
8328 beginning of the first token (function keyword, unless it's an
8329 arrow function), NAME is js2-name-node."
8333 ;; Preserve strict state outside this function.
8334 (js2-in-use-strict-directive js2-in-use-strict-directive))
8335 ;; Parse multiple times if a new strict mode directive is discovered in the
8336 ;; function body, as new rules will be retroactively applied to the legality
8337 ;; of function names and parameters.
8339 (setq ts-state (make-js2-ts-state))
8340 (setq continue (catch 'reparse
8341 (setq fn-node (js2-parse-function-internal
8342 function-type pos star-p async-p name))
8346 (js2-ts-seek ts-state)))
8349 (defun js2-parse-statements (&optional parent)
8350 "Parse a statement list. Last token consumed must be js2-LC.
8352 PARENT can be a `js2-block-node', in which case the statements are
8353 appended to PARENT. Otherwise a new `js2-block-node' is created
8356 This function does not match the closing js2-RC: the caller
8357 matches the RC so it can provide a suitable error message if not
8358 matched. This means it's up to the caller to set the length of
8359 the node to include the closing RC. The node start pos is set to
8360 the absolute buffer start position, and the caller should fix it
8361 up to be relative to the parent node. All children of this block
8362 node are given relative start positions and correct lengths."
8363 (let ((pn (or parent (make-js2-block-node)))
8365 (while (and (> (setq tt (js2-peek-token)) js2-EOF)
8367 (js2-block-node-push pn (js2-parse-statement)))
8370 (defun js2-parse-statement ()
8372 ;; coarse-grained user-interrupt check - needs work
8373 (and js2-parse-interruptable-p
8374 (zerop (% (cl-incf js2-parse-stmt-count)
8375 js2-statements-per-pause))
8377 (throw 'interrupted t))
8378 (setq pn (js2-statement-helper))
8379 ;; no-side-effects warning check
8380 (unless (js2-node-has-side-effects pn)
8381 (setq end (js2-node-end pn))
8384 (setq beg (max (js2-node-pos pn) (point-at-bol))))
8385 (js2-add-strict-warning "msg.no.side.effects" nil beg end))
8388 ;; These correspond to the switch cases in Parser.statementHelper
8389 (defconst js2-parsers
8390 (let ((parsers (make-vector js2-num-tokens
8391 #'js2-parse-expr-stmt)))
8392 (aset parsers js2-BREAK #'js2-parse-break)
8393 (aset parsers js2-CLASS #'js2-parse-class-stmt)
8394 (aset parsers js2-CONST #'js2-parse-const-var)
8395 (aset parsers js2-CONTINUE #'js2-parse-continue)
8396 (aset parsers js2-DEBUGGER #'js2-parse-debugger)
8397 (aset parsers js2-DEFAULT #'js2-parse-default-xml-namespace)
8398 (aset parsers js2-DO #'js2-parse-do)
8399 (aset parsers js2-EXPORT #'js2-parse-export)
8400 (aset parsers js2-FOR #'js2-parse-for)
8401 (aset parsers js2-FUNCTION #'js2-parse-function-stmt)
8402 (aset parsers js2-IF #'js2-parse-if)
8403 (aset parsers js2-IMPORT #'js2-parse-import)
8404 (aset parsers js2-LC #'js2-parse-block)
8405 (aset parsers js2-LET #'js2-parse-let-stmt)
8406 (aset parsers js2-NAME #'js2-parse-name-or-label)
8407 (aset parsers js2-RETURN #'js2-parse-ret-yield)
8408 (aset parsers js2-SEMI #'js2-parse-semi)
8409 (aset parsers js2-SWITCH #'js2-parse-switch)
8410 (aset parsers js2-THROW #'js2-parse-throw)
8411 (aset parsers js2-TRY #'js2-parse-try)
8412 (aset parsers js2-VAR #'js2-parse-const-var)
8413 (aset parsers js2-WHILE #'js2-parse-while)
8414 (aset parsers js2-WITH #'js2-parse-with)
8415 (aset parsers js2-YIELD #'js2-parse-ret-yield)
8417 "A vector mapping token types to parser functions.")
8419 (defun js2-parse-warn-missing-semi (beg end)
8420 (and js2-mode-show-strict-warnings
8421 js2-strict-missing-semi-warning
8422 (js2-add-strict-warning
8423 "msg.missing.semi" nil
8424 ;; back up to beginning of statement or line
8425 (max beg (save-excursion
8430 (defconst js2-no-semi-insertion
8444 "List of tokens that don't do automatic semicolon insertion.")
8446 (defconst js2-autoinsert-semi-and-warn
8447 (list js2-ERROR js2-EOF js2-RC))
8449 (defun js2-statement-helper ()
8450 (let* ((tt (js2-get-token))
8452 (async-stmt (js2-match-async-function))
8453 (parser (if (= tt js2-ERROR)
8456 #'js2-parse-async-function-stmt
8457 (aref js2-parsers tt))))
8459 ;; If the statement is set, then it's been told its label by now.
8460 (and js2-labeled-stmt
8461 (js2-labeled-stmt-node-stmt js2-labeled-stmt)
8462 (setq js2-labeled-stmt nil))
8463 (setq pn (funcall parser))
8464 ;; Don't do auto semi insertion for certain statement types.
8465 (unless (or (memq first-tt js2-no-semi-insertion)
8466 (js2-labeled-stmt-node-p pn)
8468 (js2-auto-insert-semicolon pn))
8471 (defun js2-auto-insert-semicolon (pn)
8472 (let* ((tt (js2-get-token))
8473 (pos (js2-node-pos pn)))
8476 ;; extend the node bounds to include the semicolon.
8477 (setf (js2-node-len pn) (- (js2-current-token-end) pos)))
8478 ((memq tt js2-autoinsert-semi-and-warn)
8479 (js2-unget-token) ; Not ';', do not consume.
8481 (js2-parse-warn-missing-semi pos (js2-node-end pn)))
8483 (if (not (js2-token-follows-eol-p (js2-current-token)))
8484 ;; Report error if no EOL or autoinsert ';' otherwise
8485 (js2-report-error "msg.no.semi.stmt")
8486 (js2-parse-warn-missing-semi pos (js2-node-end pn)))
8487 (js2-unget-token) ; Not ';', do not consume.
8490 (defun js2-parse-condition ()
8491 "Parse a parenthesized boolean expression, e.g. in an if- or while-stmt.
8492 The parens are discarded and the expression node is returned.
8493 The `pos' field of the return value is set to an absolute position
8494 that must be fixed up by the caller.
8495 Return value is a list (EXPR LP RP), with absolute paren positions."
8497 (if (js2-must-match js2-LP "msg.no.paren.cond")
8498 (setq lp (js2-current-token-beg)))
8499 (setq pn (js2-parse-expr))
8500 (if (js2-must-match js2-RP "msg.no.paren.after.cond")
8501 (setq rp (js2-current-token-beg)))
8502 ;; Report strict warning on code like "if (a = 7) ..."
8503 (if (and js2-strict-cond-assign-warning
8504 (js2-assign-node-p pn))
8505 (js2-add-strict-warning "msg.equal.as.assign" nil
8507 (+ (js2-node-pos pn)
8508 (js2-node-len pn))))
8511 (defun js2-parse-if ()
8512 "Parser for if-statement. Last matched token must be js2-IF."
8513 (let ((pos (js2-current-token-beg))
8514 cond if-true if-false else-pos end pn)
8515 (setq cond (js2-parse-condition)
8516 if-true (js2-parse-statement)
8517 if-false (if (js2-match-token js2-ELSE)
8519 (setq else-pos (- (js2-current-token-beg) pos))
8520 (js2-parse-statement)))
8521 end (js2-node-end (or if-false if-true))
8522 pn (make-js2-if-node :pos pos
8524 :condition (car cond)
8528 :lp (js2-relpos (cl-second cond) pos)
8529 :rp (js2-relpos (cl-third cond) pos)))
8530 (js2-node-add-children pn (car cond) if-true if-false)
8533 (defun js2-parse-import ()
8534 "Parse import statement. The current token must be js2-IMPORT."
8535 (unless (js2-ast-root-p js2-current-scope)
8536 (js2-report-error "msg.mod.import.decl.at.top.level"))
8537 (let ((beg (js2-current-token-beg)))
8538 (cond ((js2-match-token js2-STRING)
8539 (make-js2-import-node
8541 :len (- (js2-current-token-end) beg)
8542 :module-id (js2-current-token-string)))
8544 (let* ((import-clause (js2-parse-import-clause))
8545 (from-clause (and import-clause (js2-parse-from-clause)))
8546 (module-id (when from-clause (js2-from-clause-node-module-id from-clause)))
8547 (node (make-js2-import-node
8549 :len (- (js2-current-token-end) beg)
8550 :import import-clause
8552 :module-id module-id)))
8554 (js2-node-add-children node import-clause))
8556 (js2-node-add-children node from-clause))
8559 (defun js2-parse-import-clause ()
8560 "Parse the bindings in an import statement.
8561 This can take many forms:
8563 ImportedDefaultBinding -> 'foo'
8564 NameSpaceImport -> '* as lib'
8565 NamedImports -> '{foo as bar, bang}'
8566 ImportedDefaultBinding , NameSpaceImport -> 'foo, * as lib'
8567 ImportedDefaultBinding , NamedImports -> 'foo, {bar, baz as bif}'
8569 Try to match namespace imports and named imports first because nothing can
8570 come after them. If it is an imported default binding, then it could have named
8571 imports or a namespace import that follows it.
8573 (let* ((beg (js2-current-token-beg))
8574 (clause (make-js2-import-clause-node
8578 ((js2-match-token js2-MUL)
8579 (let ((ns-import (js2-parse-namespace-import)))
8581 (let ((name-node (js2-namespace-import-node-name ns-import)))
8583 js2-LET (js2-name-node-name name-node) name-node t)))
8584 (setf (js2-import-clause-node-namespace-import clause) ns-import)
8585 (push ns-import children)))
8586 ((js2-match-token js2-LC)
8587 (let ((imports (js2-parse-export-bindings t)))
8588 (setf (js2-import-clause-node-named-imports clause) imports)
8589 (dolist (import imports)
8590 (push import children)
8591 (let ((name-node (js2-export-binding-node-local-name import)))
8594 js2-LET (js2-name-node-name name-node) name-node t))))))
8595 ((= (js2-peek-token) js2-NAME)
8596 (let ((binding (js2-maybe-parse-export-binding)))
8597 (let ((node-name (js2-export-binding-node-local-name binding)))
8598 (js2-define-symbol js2-LET (js2-name-node-name node-name) node-name t))
8599 (setf (js2-import-clause-node-default-binding clause) binding)
8600 (push binding children))
8601 (when (js2-match-token js2-COMMA)
8603 ((js2-match-token js2-MUL)
8604 (let ((ns-import (js2-parse-namespace-import)))
8605 (let ((name-node (js2-namespace-import-node-name ns-import)))
8607 js2-LET (js2-name-node-name name-node) name-node t))
8608 (setf (js2-import-clause-node-namespace-import clause) ns-import)
8609 (push ns-import children)))
8610 ((js2-match-token js2-LC)
8611 (let ((imports (js2-parse-export-bindings t)))
8612 (setf (js2-import-clause-node-named-imports clause) imports)
8613 (dolist (import imports)
8614 (push import children)
8615 (let ((name-node (js2-export-binding-node-local-name import)))
8618 js2-LET (js2-name-node-name name-node) name-node t))))))
8619 (t (js2-report-error "msg.syntax")))))
8620 (t (js2-report-error "msg.mod.declaration.after.import")))
8621 (setf (js2-node-len clause) (- (js2-current-token-end) beg))
8622 (apply #'js2-node-add-children clause children)
8625 (defun js2-parse-namespace-import ()
8626 "Parse a namespace import expression such as '* as bar'.
8627 The current token must be js2-MUL."
8628 (let ((beg (js2-current-token-beg)))
8629 (when (js2-must-match js2-NAME "msg.syntax")
8630 (if (equal "as" (js2-current-token-string))
8631 (when (js2-must-match-prop-name "msg.syntax")
8632 (let ((node (make-js2-namespace-import-node
8634 :len (- (js2-current-token-end) beg)
8635 :name (make-js2-name-node
8636 :pos (js2-current-token-beg)
8637 :len (js2-current-token-end)
8638 :name (js2-current-token-string)))))
8639 (js2-node-add-children node (js2-namespace-import-node-name node))
8642 (js2-report-error "msg.syntax")))))
8645 (defun js2-parse-from-clause ()
8646 "Parse the from clause in an import or export statement. E.g. from 'src/lib'"
8647 (when (js2-must-match-name "msg.mod.from.after.import.spec.set")
8648 (let ((beg (js2-current-token-beg)))
8649 (if (equal "from" (js2-current-token-string))
8651 ((js2-match-token js2-STRING)
8652 (make-js2-from-clause-node
8654 :len (- (js2-current-token-end) beg)
8655 :module-id (js2-current-token-string)
8657 ((js2-match-token js2-THIS)
8658 (when (js2-must-match-name "msg.mod.spec.after.from")
8659 (if (equal "module" (js2-current-token-string))
8660 (make-js2-from-clause-node
8662 :len (- (js2-current-token-end) beg)
8667 (js2-report-error "msg.mod.spec.after.from")
8669 (t (js2-report-error "msg.mod.spec.after.from") nil))
8671 (js2-report-error "msg.mod.from.after.import.spec.set")
8674 (defun js2-parse-export-bindings (&optional import-p)
8675 "Parse a list of export binding expressions such as {}, {foo, bar}, and
8676 {foo as bar, baz as bang}. The current token must be
8677 js2-LC. Return a lisp list of js2-export-binding-node"
8678 (let ((bindings (list)))
8680 (let ((binding (js2-maybe-parse-export-binding)))
8682 (push binding bindings))
8683 (js2-match-token js2-COMMA)))
8684 (when (js2-must-match js2-RC (if import-p
8685 "msg.mod.rc.after.import.spec.list"
8686 "msg.mod.rc.after.export.spec.list"))
8687 (reverse bindings))))
8689 (defun js2-maybe-parse-export-binding ()
8690 "Attempt to parse a binding expression found inside an import/export statement.
8691 This can take the form of either as single js2-NAME token as in 'foo' or as in a
8692 rebinding expression 'bar as foo'. If it matches, it will return an instance of
8693 js2-export-binding-node and consume all the tokens. If it does not match, it
8694 consumes no tokens."
8695 (let ((extern-name (when (js2-match-prop-name) (js2-current-token-string)))
8696 (beg (js2-current-token-beg))
8697 (extern-name-len (js2-current-token-len))
8698 (is-reserved-name (or (= (js2-current-token-type) js2-RESERVED)
8699 (aref js2-kwd-tokens (js2-current-token-type)))))
8701 (let ((as (and (js2-match-token js2-NAME) (js2-current-token-string))))
8702 (if (and as (equal "as" (js2-current-token-string)))
8705 (and (js2-match-token js2-DEFAULT) "default")
8706 (and (js2-match-token js2-NAME) (js2-current-token-string)))))
8708 (let ((node (make-js2-export-binding-node
8710 :len (- (js2-current-token-end) beg)
8711 :local-name (make-js2-name-node
8713 :pos (js2-current-token-beg)
8714 :len (js2-current-token-len))
8715 :extern-name (make-js2-name-node
8718 :len extern-name-len))))
8719 (js2-node-add-children
8721 (js2-export-binding-node-local-name node)
8722 (js2-export-binding-node-extern-name node))
8726 (when as (js2-unget-token))
8727 (let* ((name-node (make-js2-name-node
8728 :name (js2-current-token-string)
8729 :pos (js2-current-token-beg)
8730 :len (js2-current-token-len)))
8731 (node (make-js2-export-binding-node
8732 :pos (js2-current-token-beg)
8733 :len (js2-current-token-len)
8734 :local-name name-node
8735 :extern-name name-node)))
8736 (when is-reserved-name
8737 (js2-report-error "msg.mod.as.after.reserved.word" extern-name))
8738 (js2-node-add-children node name-node)
8742 (defun js2-parse-switch ()
8743 "Parser for switch-statement. Last matched token must be js2-SWITCH."
8744 (let ((pos (js2-current-token-beg))
8745 tt pn discriminant has-default case-expr case-node
8746 case-pos cases stmt lp)
8747 (if (js2-must-match js2-LP "msg.no.paren.switch")
8748 (setq lp (js2-current-token-beg)))
8749 (setq discriminant (js2-parse-expr)
8750 pn (make-js2-switch-node :discriminant discriminant
8752 :lp (js2-relpos lp pos)))
8753 (js2-node-add-children pn discriminant)
8754 (js2-enter-switch pn)
8757 (if (js2-must-match js2-RP "msg.no.paren.after.switch")
8758 (setf (js2-switch-node-rp pn) (- (js2-current-token-beg) pos)))
8759 (js2-must-match js2-LC "msg.no.brace.switch")
8762 (setq tt (js2-next-token)
8763 case-pos (js2-current-token-beg))
8766 (setf (js2-node-len pn) (- (js2-current-token-end) pos))
8767 (throw 'break nil)) ; done
8769 (setq case-expr (js2-parse-expr))
8770 (js2-must-match js2-COLON "msg.no.colon.case"))
8773 (js2-report-error "msg.double.switch.default"))
8776 (js2-must-match js2-COLON "msg.no.colon.case"))
8778 (js2-report-error "msg.bad.switch")
8779 (throw 'break nil)))
8780 (setq case-node (make-js2-case-node :pos case-pos
8781 :len (- (js2-current-token-end) case-pos)
8783 (js2-node-add-children case-node case-expr)
8784 (while (and (/= (setq tt (js2-peek-token)) js2-RC)
8788 (setf stmt (js2-parse-statement)
8789 (js2-node-len case-node) (- (js2-node-end stmt) case-pos))
8790 (js2-block-node-push case-node stmt))
8791 (push case-node cases)))
8792 ;; add cases last, as pushing reverses the order to be correct
8794 (js2-node-add-children pn kid)
8795 (push kid (js2-switch-node-cases pn)))
8797 (js2-exit-switch))))
8799 (defun js2-parse-while ()
8800 "Parser for while-statement. Last matched token must be js2-WHILE."
8801 (let ((pos (js2-current-token-beg))
8802 (pn (make-js2-while-node))
8807 (setf cond (js2-parse-condition)
8808 (js2-while-node-condition pn) (car cond)
8809 body (js2-parse-statement)
8810 (js2-while-node-body pn) body
8811 (js2-node-len pn) (- (js2-node-end body) pos)
8812 (js2-while-node-lp pn) (js2-relpos (cl-second cond) pos)
8813 (js2-while-node-rp pn) (js2-relpos (cl-third cond) pos))
8814 (js2-node-add-children pn body (car cond)))
8818 (defun js2-parse-do ()
8819 "Parser for do-statement. Last matched token must be js2-DO."
8820 (let ((pos (js2-current-token-beg))
8821 (pn (make-js2-do-node))
8826 (setq body (js2-parse-statement))
8827 (js2-must-match js2-WHILE "msg.no.while.do")
8828 (setf (js2-do-node-while-pos pn) (- (js2-current-token-beg) pos)
8829 cond (js2-parse-condition)
8830 (js2-do-node-condition pn) (car cond)
8831 (js2-do-node-body pn) body
8833 (js2-do-node-lp pn) (js2-relpos (cl-second cond) pos)
8834 (js2-do-node-rp pn) (js2-relpos (cl-third cond) pos))
8835 (js2-node-add-children pn (car cond) body))
8837 ;; Always auto-insert semicolon to follow SpiderMonkey:
8838 ;; It is required by ECMAScript but is ignored by the rest of
8839 ;; world; see bug 238945
8840 (if (js2-match-token js2-SEMI)
8841 (setq end js2-ts-cursor))
8842 (setf (js2-node-len pn) (- end pos))
8845 (defun js2-parse-export ()
8846 "Parse an export statement.
8847 The Last matched token must be js2-EXPORT. Currently, the 'default' and 'expr'
8848 expressions should only be either hoistable expressions (function or generator)
8849 or assignment expressions, but there is no checking to enforce that and so it
8850 will parse without error a small subset of
8851 invalid export statements."
8852 (unless (js2-ast-root-p js2-current-scope)
8853 (js2-report-error "msg.mod.export.decl.at.top.level"))
8854 (let ((beg (js2-current-token-beg))
8856 exports-list from-clause declaration default)
8858 ((js2-match-token js2-MUL)
8859 (setq from-clause (js2-parse-from-clause))
8861 (push from-clause children)))
8862 ((js2-match-token js2-LC)
8863 (setq exports-list (js2-parse-export-bindings))
8865 (dolist (export exports-list)
8866 (push export children)))
8867 (when (js2-match-token js2-NAME)
8868 (if (equal "from" (js2-current-token-string))
8871 (setq from-clause (js2-parse-from-clause)))
8872 (js2-unget-token))))
8873 ((js2-match-token js2-DEFAULT)
8874 (setq default (cond ((js2-match-token js2-CLASS)
8875 (js2-parse-class-stmt))
8876 ((js2-match-token js2-NAME)
8877 (if (js2-match-async-function)
8878 (js2-parse-async-function-stmt)
8881 ((js2-match-token js2-FUNCTION)
8882 (js2-parse-function-stmt))
8883 (t (js2-parse-expr)))))
8884 ((or (js2-match-token js2-VAR) (js2-match-token js2-CONST) (js2-match-token js2-LET))
8885 (setq declaration (js2-parse-variables (js2-current-token-type) (js2-current-token-beg))))
8886 ((js2-match-token js2-CLASS)
8887 (setq declaration (js2-parse-class-stmt)))
8888 ((js2-match-token js2-NAME)
8890 (if (js2-match-async-function)
8891 (js2-parse-async-function-stmt)
8894 ((js2-match-token js2-FUNCTION)
8895 (setq declaration (js2-parse-function-stmt)))
8897 (setq declaration (js2-parse-expr))))
8899 (push from-clause children))
8901 (push declaration children)
8902 (when (not (or (js2-function-node-p declaration)
8903 (js2-class-node-p declaration)))
8904 (js2-auto-insert-semicolon declaration)))
8906 (push default children)
8907 (when (not (or (js2-function-node-p default)
8908 (js2-class-node-p default)))
8909 (js2-auto-insert-semicolon default)))
8910 (let ((node (make-js2-export-node
8912 :len (- (js2-current-token-end) beg)
8913 :exports-list exports-list
8914 :from-clause from-clause
8915 :declaration declaration
8917 (apply #'js2-node-add-children node children)
8920 (defun js2-parse-for ()
8921 "Parse a for, for-in or for each-in statement.
8922 Last matched token must be js2-FOR."
8923 (let ((for-pos (js2-current-token-beg))
8924 (tmp-scope (make-js2-scope))
8925 pn is-for-each is-for-in-or-of is-for-of
8926 in-pos each-pos tmp-pos
8927 init ; Node init is also foo in 'foo in object'.
8928 cond ; Node cond is also object in 'foo in object'.
8929 incr ; 3rd section of for-loop initializer.
8931 ;; See if this is a for each () instead of just a for ()
8932 (when (js2-match-token js2-NAME)
8933 (if (string= "each" (js2-current-token-string))
8936 each-pos (- (js2-current-token-beg) for-pos)) ; relative
8937 (js2-record-face 'font-lock-keyword-face))
8938 (js2-report-error "msg.no.paren.for")))
8939 (if (js2-must-match js2-LP "msg.no.paren.for")
8940 (setq lp (- (js2-current-token-beg) for-pos)))
8941 (setq tt (js2-get-token))
8942 ;; Capture identifiers inside parens. We can't create the node
8943 ;; (and use it as the current scope) until we know its type.
8944 (js2-push-scope tmp-scope)
8947 ;; parse init clause
8948 (let ((js2-in-for-init t)) ; set as dynamic variable
8952 (setq init (make-js2-empty-expr-node)))
8953 ((or (= tt js2-VAR) (= tt js2-LET) (= tt js2-CONST))
8954 (setq init (js2-parse-variables tt (js2-current-token-beg))))
8957 (setq init (js2-parse-expr)))))
8958 (if (or (js2-match-token js2-IN)
8959 (and (>= js2-language-version 200)
8960 (js2-match-contextual-kwd "of")
8961 (setq is-for-of t)))
8962 (setq is-for-in-or-of t
8963 in-pos (- (js2-current-token-beg) for-pos)
8964 ;; scope of iteration target object is not the scope we've created above.
8965 ;; stash current scope temporary.
8966 cond (let ((js2-current-scope (js2-scope-parent-scope js2-current-scope)))
8967 (js2-parse-expr))) ; object over which we're iterating
8968 ;; else ordinary for loop - parse cond and incr
8969 (js2-must-match js2-SEMI "msg.no.semi.for")
8970 (setq cond (if (= (js2-peek-token) js2-SEMI)
8971 (make-js2-empty-expr-node) ; no loop condition
8973 (js2-must-match js2-SEMI "msg.no.semi.for.cond")
8974 (setq tmp-pos (js2-current-token-end)
8975 incr (if (= (js2-peek-token) js2-RP)
8976 (make-js2-empty-expr-node :pos tmp-pos)
8977 (js2-parse-expr)))))
8979 (if (js2-must-match js2-RP "msg.no.paren.for.ctrl")
8980 (setq rp (- (js2-current-token-beg) for-pos)))
8981 (if (not is-for-in-or-of)
8982 (setq pn (make-js2-for-node :init init
8987 ;; cond could be null if 'in obj' got eaten by the init node.
8988 (if (js2-infix-node-p init)
8989 ;; it was (foo in bar) instead of (var foo in bar)
8990 (setq cond (js2-infix-node-right init)
8991 init (js2-infix-node-left init))
8992 (if (and (js2-var-decl-node-p init)
8993 (> (length (js2-var-decl-node-kids init)) 1))
8994 (js2-report-error "msg.mult.index")))
8995 (setq pn (make-js2-for-in-node :iterator init
8998 :foreach-p is-for-each
9003 ;; Transplant the declarations.
9004 (setf (js2-scope-symbol-table pn)
9005 (js2-scope-symbol-table tmp-scope))
9009 ;; We have to parse the body -after- creating the loop node,
9010 ;; so that the loop node appears in the js2-loop-set, allowing
9011 ;; break/continue statements to find the enclosing loop.
9012 (setf body (js2-parse-statement)
9013 (js2-loop-node-body pn) body
9014 (js2-node-pos pn) for-pos
9015 (js2-node-len pn) (- (js2-node-end body) for-pos))
9016 (js2-node-add-children pn init cond incr body))
9021 (defun js2-parse-try ()
9022 "Parse a try statement. Last matched token must be js2-TRY."
9023 (let ((try-pos (js2-current-token-beg))
9030 (if (/= (js2-peek-token) js2-LC)
9031 (js2-report-error "msg.no.brace.try"))
9032 (setq try-block (js2-parse-statement)
9033 try-end (js2-node-end try-block)
9034 peek (js2-peek-token))
9037 (while (js2-match-token js2-CATCH)
9038 (let* ((catch-pos (js2-current-token-beg))
9039 (catch-node (make-js2-catch-node :pos catch-pos))
9044 (if saw-default-catch
9045 (js2-report-error "msg.catch.unreachable"))
9046 (if (js2-must-match js2-LP "msg.no.paren.catch")
9047 (setq lp (- (js2-current-token-beg) catch-pos)))
9048 (js2-push-scope catch-node)
9049 (let ((tt (js2-peek-token)))
9051 ;; Destructuring pattern:
9052 ;; catch ({ message, file }) { ... }
9053 ((or (= tt js2-LB) (= tt js2-LC))
9055 (setq param (js2-parse-destruct-primary-expr))
9056 (js2-define-destruct-symbols param js2-LET nil))
9059 (js2-must-match-name "msg.bad.catchcond")
9060 (setq param (js2-create-name-node))
9061 (js2-define-symbol js2-LET (js2-current-token-string) param)
9062 (js2-check-strict-identifier param))))
9064 (if (js2-match-token js2-IF)
9065 (setq guard-kwd (- (js2-current-token-beg) catch-pos)
9066 catch-cond (js2-parse-expr))
9067 (setq saw-default-catch t))
9068 (if (js2-must-match js2-RP "msg.bad.catchcond")
9069 (setq rp (- (js2-current-token-beg) catch-pos)))
9070 (js2-must-match js2-LC "msg.no.brace.catchblock")
9071 (js2-parse-statements catch-node)
9072 (if (js2-must-match js2-RC "msg.no.brace.after.body")
9073 (setq try-end (js2-current-token-end)))
9075 (setf (js2-node-len catch-node) (- try-end catch-pos)
9076 (js2-catch-node-param catch-node) param
9077 (js2-catch-node-guard-expr catch-node) catch-cond
9078 (js2-catch-node-guard-kwd catch-node) guard-kwd
9079 (js2-catch-node-lp catch-node) lp
9080 (js2-catch-node-rp catch-node) rp)
9081 (js2-node-add-children catch-node param catch-cond)
9082 (push catch-node catch-blocks))))
9083 ((/= peek js2-FINALLY)
9084 (js2-must-match js2-FINALLY "msg.try.no.catchfinally"
9085 (js2-node-pos try-block)
9086 (- (setq try-end (js2-node-end try-block))
9087 (js2-node-pos try-block)))))
9088 (when (js2-match-token js2-FINALLY)
9089 (let ((finally-pos (js2-current-token-beg))
9090 (block (js2-parse-statement)))
9091 (setq try-end (js2-node-end block)
9092 finally-block (make-js2-finally-node :pos finally-pos
9093 :len (- try-end finally-pos)
9095 (js2-node-add-children finally-block block)))
9096 (let ((pn (make-js2-try-node :pos try-pos
9097 :len (- try-end try-pos)
9098 :try-block try-block
9099 :finally-block finally-block)))
9100 (js2-node-add-children pn try-block finally-block)
9101 ;; Push them onto the try-node, which reverses and corrects their order.
9102 (dolist (cb catch-blocks)
9103 (js2-node-add-children pn cb)
9104 (push cb (js2-try-node-catch-clauses pn)))
9107 (defun js2-parse-throw ()
9108 "Parser for throw-statement. Last matched token must be js2-THROW."
9109 (let ((pos (js2-current-token-beg))
9111 (if (= (js2-peek-token-or-eol) js2-EOL)
9112 ;; ECMAScript does not allow new lines before throw expression,
9114 (js2-report-error "msg.bad.throw.eol"))
9115 (setq expr (js2-parse-expr)
9116 pn (make-js2-throw-node :pos pos
9117 :len (- (js2-node-end expr) pos)
9119 (js2-node-add-children pn expr)
9122 (defun js2-match-jump-label-name (label-name)
9123 "If break/continue specified a label, return that label's labeled stmt.
9124 Returns the corresponding `js2-labeled-stmt-node', or if LABEL-NAME
9125 does not match an existing label, reports an error and returns nil."
9126 (let ((bundle (cdr (assoc label-name js2-label-set))))
9128 (js2-report-error "msg.undef.label"))
9131 (defun js2-parse-break ()
9132 "Parser for break-statement. Last matched token must be js2-BREAK."
9133 (let ((pos (js2-current-token-beg))
9134 (end (js2-current-token-end))
9135 break-target ; statement to break from
9136 break-label ; in "break foo", name-node representing the foo
9137 labels ; matching labeled statement to break to
9139 (when (eq (js2-peek-token-or-eol) js2-NAME)
9141 (setq break-label (js2-create-name-node)
9142 end (js2-node-end break-label)
9143 ;; matchJumpLabelName only matches if there is one
9144 labels (js2-match-jump-label-name (js2-current-token-string))
9145 break-target (if labels (car (js2-labeled-stmt-node-labels labels)))))
9146 (unless (or break-target break-label)
9147 ;; no break target specified - try for innermost enclosing loop/switch
9148 (if (null js2-loop-and-switch-set)
9150 (js2-report-error "msg.bad.break" nil pos (length "break")))
9151 (setq break-target (car js2-loop-and-switch-set))))
9152 (setq pn (make-js2-break-node :pos pos
9155 :target break-target))
9156 (js2-node-add-children pn break-label) ; but not break-target
9159 (defun js2-parse-continue ()
9160 "Parser for continue-statement. Last matched token must be js2-CONTINUE."
9161 (let ((pos (js2-current-token-beg))
9162 (end (js2-current-token-end))
9163 label ; optional user-specified label, a `js2-name-node'
9164 labels ; current matching labeled stmt, if any
9165 target ; the `js2-loop-node' target of this continue stmt
9167 (when (= (js2-peek-token-or-eol) js2-NAME)
9169 (setq label (js2-create-name-node)
9170 end (js2-node-end label)
9171 ;; matchJumpLabelName only matches if there is one
9172 labels (js2-match-jump-label-name (js2-current-token-string))))
9174 ((null labels) ; no current label to go to
9175 (if (null js2-loop-set) ; no loop to continue to
9176 (js2-report-error "msg.continue.outside" nil pos
9177 (length "continue"))
9178 (setq target (car js2-loop-set)))) ; innermost enclosing loop
9180 (if (js2-loop-node-p (js2-labeled-stmt-node-stmt labels))
9181 (setq target (js2-labeled-stmt-node-stmt labels))
9182 (js2-report-error "msg.continue.nonloop" nil pos (- end pos)))))
9183 (setq pn (make-js2-continue-node :pos pos
9187 (js2-node-add-children pn label) ; but not target - it's not our child
9190 (defun js2-parse-with ()
9191 "Parser for with-statement. Last matched token must be js2-WITH."
9192 (when js2-in-use-strict-directive
9193 (js2-report-error "msg.no.with.strict"))
9194 (let ((pos (js2-current-token-beg))
9196 (if (js2-must-match js2-LP "msg.no.paren.with")
9197 (setq lp (js2-current-token-beg)))
9198 (setq obj (js2-parse-expr))
9199 (if (js2-must-match js2-RP "msg.no.paren.after.with")
9200 (setq rp (js2-current-token-beg)))
9201 (let ((js2-nesting-of-with (1+ js2-nesting-of-with)))
9202 (setq body (js2-parse-statement)))
9203 (setq pn (make-js2-with-node :pos pos
9204 :len (- (js2-node-end body) pos)
9207 :lp (js2-relpos lp pos)
9208 :rp (js2-relpos rp pos)))
9209 (js2-node-add-children pn obj body)
9212 (defun js2-parse-const-var ()
9213 "Parser for var- or const-statement.
9214 Last matched token must be js2-CONST or js2-VAR."
9215 (let ((tt (js2-current-token-type))
9216 (pos (js2-current-token-beg))
9218 (setq expr (js2-parse-variables tt (js2-current-token-beg))
9219 pn (make-js2-expr-stmt-node :pos pos
9220 :len (- (js2-node-end expr) pos)
9222 (js2-node-add-children pn expr)
9225 (defun js2-wrap-with-expr-stmt (pos expr &optional add-child)
9226 (let ((pn (make-js2-expr-stmt-node :pos pos
9227 :len (js2-node-len expr)
9228 :type (if (js2-inside-function)
9233 (js2-node-add-children pn expr))
9236 (defun js2-parse-let-stmt ()
9237 "Parser for let-statement. Last matched token must be js2-LET."
9238 (let ((pos (js2-current-token-beg))
9240 (if (= (js2-peek-token) js2-LP)
9241 ;; let expression in statement context
9242 (setq expr (js2-parse-let pos 'statement)
9243 pn (js2-wrap-with-expr-stmt pos expr t))
9244 ;; else we're looking at a statement like let x=6, y=7;
9245 (setf expr (js2-parse-variables js2-LET pos)
9246 pn (js2-wrap-with-expr-stmt pos expr t)
9247 (js2-node-type pn) js2-EXPR_RESULT))
9250 (defun js2-parse-ret-yield ()
9251 (js2-parse-return-or-yield (js2-current-token-type) nil))
9253 (defconst js2-parse-return-stmt-enders
9254 (list js2-SEMI js2-RC js2-EOF js2-EOL js2-ERROR js2-RB js2-RP js2-YIELD))
9256 (defsubst js2-now-all-set (before after mask)
9257 "Return whether or not the bits in the mask have changed to all set.
9258 BEFORE is bits before change, AFTER is bits after change, and MASK is
9259 the mask for bits. Returns t if all the bits in the mask are set in AFTER
9261 (and (/= (logand before mask) mask)
9262 (= (logand after mask) mask)))
9264 (defun js2-parse-return-or-yield (tt expr-context)
9265 (let* ((pos (js2-current-token-beg))
9266 (end (js2-current-token-end))
9267 (before js2-end-flags)
9268 (inside-function (js2-inside-function))
9269 (gen-type (and inside-function (js2-function-node-generator-type
9270 js2-current-script-or-fn)))
9271 e ret name yield-star-p)
9272 (unless inside-function
9273 (js2-report-error (if (eq tt js2-RETURN)
9276 (when (and inside-function
9278 (js2-match-token js2-MUL))
9279 (setq yield-star-p t))
9280 ;; This is ugly, but we don't want to require a semicolon.
9281 (unless (memq (js2-peek-token-or-eol) js2-parse-return-stmt-enders)
9282 (setq e (js2-parse-expr)
9283 end (js2-node-end e)))
9286 (js2-set-flag js2-end-flags (if (null e)
9288 js2-end-returns-value))
9289 (setq ret (make-js2-return-node :pos pos
9292 (js2-node-add-children ret e)
9293 ;; See if we need a strict mode warning.
9294 ;; TODO: The analysis done by `js2-has-consistent-return-usage' is
9295 ;; more thorough and accurate than this before/after flag check.
9296 ;; E.g. if there's a finally-block that always returns, we shouldn't
9297 ;; show a warning generated by inconsistent returns in the catch blocks.
9298 ;; Basically `js2-has-consistent-return-usage' needs to keep more state,
9299 ;; so we know which returns/yields to highlight, and we should get rid of
9300 ;; all the checking in `js2-parse-return-or-yield'.
9301 (if (and js2-strict-inconsistent-return-warning
9302 (js2-now-all-set before js2-end-flags
9303 (logior js2-end-returns js2-end-returns-value)))
9304 (js2-add-strict-warning "msg.return.inconsistent" nil pos end)))
9305 ((eq gen-type 'COMPREHENSION)
9306 ;; FIXME: We should probably switch to saving and using lastYieldOffset,
9307 ;; like SpiderMonkey does.
9308 (js2-report-error "msg.syntax" nil pos 5))
9310 (setq ret (make-js2-yield-node :pos pos
9313 :star-p yield-star-p))
9314 (js2-node-add-children ret e)
9315 (unless expr-context
9317 ret (js2-wrap-with-expr-stmt pos e t))
9318 (js2-set-requires-activation)
9319 (js2-set-is-generator))))
9320 ;; see if we are mixing yields and value returns.
9321 (when (and inside-function
9322 (js2-flag-set-p js2-end-flags js2-end-returns-value)
9323 (eq (js2-function-node-generator-type js2-current-script-or-fn)
9325 (setq name (js2-function-name js2-current-script-or-fn))
9326 (if (zerop (length name))
9327 (js2-report-error "msg.anon.generator.returns" nil pos (- end pos))
9328 (js2-report-error "msg.generator.returns" name pos (- end pos))))
9331 (defun js2-parse-debugger ()
9332 (make-js2-keyword-node :type js2-DEBUGGER))
9334 (defun js2-parse-block ()
9335 "Parser for a curly-delimited statement block.
9336 Last token matched must be `js2-LC'."
9337 (let ((pos (js2-current-token-beg))
9338 (pn (make-js2-scope)))
9342 (js2-parse-statements pn)
9343 (js2-must-match js2-RC "msg.no.brace.block")
9344 (setf (js2-node-len pn) (- (js2-current-token-end) pos)))
9348 ;; For `js2-ERROR' too, to have a node for error recovery to work on.
9349 (defun js2-parse-semi ()
9350 "Parse a statement or handle an error.
9351 Current token type is `js2-SEMI' or `js2-ERROR'."
9352 (let ((tt (js2-current-token-type)) pos len)
9353 (if (eq tt js2-SEMI)
9354 (make-js2-empty-expr-node :len 1)
9355 (setq pos (js2-current-token-beg)
9356 len (- (js2-current-token-end) pos))
9357 (js2-report-error "msg.syntax" nil pos len)
9358 (make-js2-error-node :pos pos :len len))))
9360 (defun js2-parse-default-xml-namespace ()
9361 "Parse a `default xml namespace = <expr>' e4x statement."
9362 (let ((pos (js2-current-token-beg))
9365 (js2-set-requires-activation)
9366 (setq len (- js2-ts-cursor pos))
9367 (unless (and (js2-match-token js2-NAME)
9368 (string= (js2-current-token-string) "xml"))
9369 (js2-report-error "msg.bad.namespace" nil pos len))
9370 (unless (and (js2-match-token js2-NAME)
9371 (string= (js2-current-token-string) "namespace"))
9372 (js2-report-error "msg.bad.namespace" nil pos len))
9373 (unless (js2-match-token js2-ASSIGN)
9374 (js2-report-error "msg.bad.namespace" nil pos len))
9375 (setq expr (js2-parse-expr)
9376 end (js2-node-end expr)
9377 unary (make-js2-unary-node :type js2-DEFAULTNAMESPACE
9381 (js2-node-add-children unary expr)
9382 (make-js2-expr-stmt-node :pos pos
9386 (defun js2-record-label (label bundle)
9387 ;; current token should be colon that `js2-parse-primary-expr' left untouched
9389 (let ((name (js2-label-node-name label))
9392 (when (setq labeled-stmt (cdr (assoc name js2-label-set)))
9393 ;; flag both labels if possible when used in editing mode
9394 (if (and js2-parse-ide-mode
9395 (setq dup (js2-get-label-by-name labeled-stmt name)))
9396 (js2-report-error "msg.dup.label" nil
9397 (js2-node-abs-pos dup) (js2-node-len dup)))
9398 (js2-report-error "msg.dup.label" nil
9399 (js2-node-pos label) (js2-node-len label)))
9400 (js2-labeled-stmt-node-add-label bundle label)
9401 (js2-node-add-children bundle label)
9402 ;; Add one reference to the bundle per label in `js2-label-set'
9403 (push (cons name bundle) js2-label-set)))
9405 (defun js2-parse-name-or-label ()
9406 "Parser for identifier or label. Last token matched must be js2-NAME.
9407 Called when we found a name in a statement context. If it's a label, we gather
9408 up any following labels and the next non-label statement into a
9409 `js2-labeled-stmt-node' bundle and return that. Otherwise we parse an
9410 expression and return it wrapped in a `js2-expr-stmt-node'."
9411 (let ((pos (js2-current-token-beg))
9414 ;; set check for label and call down to `js2-parse-primary-expr'
9415 (setq expr (js2-maybe-parse-label))
9417 ;; Parse the non-label expression and wrap with expression stmt.
9418 (js2-wrap-with-expr-stmt pos (js2-parse-expr) t)
9419 ;; else parsed a label
9420 (setq bundle (make-js2-labeled-stmt-node :pos pos))
9421 (js2-record-label expr bundle)
9422 ;; look for more labels
9423 (while (and continue (= (js2-get-token) js2-NAME))
9424 (if (setq expr (js2-maybe-parse-label))
9425 (js2-record-label expr bundle)
9426 (setq expr (js2-parse-expr)
9427 stmt (js2-wrap-with-expr-stmt (js2-node-pos expr) expr t)
9429 (js2-auto-insert-semicolon stmt)))
9430 ;; no more labels; now parse the labeled statement
9433 (let ((js2-labeled-stmt bundle)) ; bind dynamically
9435 (setq stmt (js2-statement-helper))))
9436 ;; remove the labels for this statement from the global set
9437 (dolist (label (js2-labeled-stmt-node-labels bundle))
9438 (setq js2-label-set (remove label js2-label-set))))
9439 (setf (js2-labeled-stmt-node-stmt bundle) stmt
9440 (js2-node-len bundle) (- (js2-node-end stmt) pos))
9441 (js2-node-add-children bundle stmt)
9444 (defun js2-maybe-parse-label ()
9445 (cl-assert (= (js2-current-token-type) js2-NAME))
9447 (next-tt (js2-get-token))
9448 (label-end (js2-current-token-end)))
9449 ;; Do not consume colon, it is used as unwind indicator
9450 ;; to return to statementHelper.
9452 (if (= next-tt js2-COLON)
9454 (setq label-pos (js2-current-token-beg))
9455 (make-js2-label-node :pos label-pos
9456 :len (- label-end label-pos)
9457 :name (js2-current-token-string))
9458 (js2-set-face label-pos
9460 'font-lock-variable-name-face 'record))
9461 ;; Backtrack from the name token, too.
9465 (defun js2-parse-expr-stmt ()
9466 "Default parser in statement context, if no recognized statement found."
9467 (js2-wrap-with-expr-stmt (js2-current-token-beg)
9470 (js2-parse-expr)) t))
9472 (defun js2-parse-variables (decl-type pos)
9473 "Parse a comma-separated list of variable declarations.
9474 Could be a 'var', 'const' or 'let' expression, possibly in a for-loop initializer.
9476 DECL-TYPE is a token value: either VAR, CONST, or LET depending on context.
9477 For 'var' or 'const', the keyword should be the token last scanned.
9479 POS is the position where the node should start. It's sometimes the
9480 var/const/let keyword, and other times the beginning of the first token
9481 in the first variable declaration.
9483 Returns the parsed `js2-var-decl-node' expression node."
9484 (let* ((result (make-js2-var-decl-node :decl-type decl-type
9486 destructuring kid-pos tt init name end nbeg nend vi
9489 ;; var foo = {a: 1, b: 2}, bar = [3, 4];
9490 ;; var {b: s2, a: s1} = foo, x = 6, y, [s3, s4] = bar;
9491 ;; var {a, b} = baz;
9493 (setq destructuring nil
9496 kid-pos (js2-current-token-beg)
9497 end (js2-current-token-end)
9499 (if (or (= tt js2-LB) (= tt js2-LC))
9500 ;; Destructuring assignment, e.g., var [a, b] = ...
9501 (setq destructuring (js2-parse-destruct-primary-expr)
9502 end (js2-node-end destructuring))
9503 ;; Simple variable name
9505 (when (js2-must-match-name "msg.bad.var")
9506 (setq name (js2-create-name-node)
9507 nbeg (js2-current-token-beg)
9508 nend (js2-current-token-end)
9510 (js2-define-symbol decl-type (js2-current-token-string) name js2-in-for-init)
9511 (js2-check-strict-identifier name)))
9512 (when (js2-match-token js2-ASSIGN)
9513 (setq init (js2-parse-assign-expr)
9514 end (js2-node-end init))
9515 (js2-record-imenu-functions init name))
9517 (js2-set-face nbeg nend (if (js2-function-node-p init)
9518 'font-lock-function-name-face
9519 'font-lock-variable-name-face)
9521 (setq vi (make-js2-var-init-node :pos kid-pos
9522 :len (- end kid-pos)
9526 (if (and (null init) (not js2-in-for-init))
9527 (js2-report-error "msg.destruct.assign.no.init"))
9528 (js2-define-destruct-symbols destructuring
9530 'font-lock-variable-name-face)
9531 (setf (js2-var-init-node-target vi) destructuring))
9532 (setf (js2-var-init-node-target vi) name))
9533 (setf (js2-var-init-node-initializer vi) init)
9534 (js2-node-add-children vi name destructuring init)
9535 (js2-block-node-push result vi)
9536 (unless (js2-match-token js2-COMMA)
9537 (setq continue nil)))
9538 (setf (js2-node-len result) (- end pos))
9541 (defun js2-parse-let (pos &optional stmt-p)
9542 "Parse a let expression or statement.
9543 A let-expression is of the form `let (vars) expr'.
9544 A let-statement is of the form `let (vars) {statements}'.
9545 The third form of let is a variable declaration list, handled
9546 by `js2-parse-variables'."
9547 (let ((pn (make-js2-let-node :pos pos))
9549 (if (js2-must-match js2-LP "msg.no.paren.after.let")
9550 (setf (js2-let-node-lp pn) (- (js2-current-token-beg) pos)))
9554 (setq vars (js2-parse-variables js2-LET (js2-current-token-beg)))
9555 (if (js2-must-match js2-RP "msg.no.paren.let")
9556 (setf (js2-let-node-rp pn) (- (js2-current-token-beg) pos)))
9557 (if (and stmt-p (js2-match-token js2-LC))
9560 (setf beg (js2-current-token-beg) ; position stmt at LC
9561 body (js2-parse-statements))
9562 (js2-must-match js2-RC "msg.no.curly.let")
9563 (setf (js2-node-len body) (- (js2-current-token-end) beg)
9564 (js2-node-len pn) (- (js2-current-token-end) pos)
9565 (js2-let-node-body pn) body
9566 (js2-node-type pn) js2-LET))
9568 (setf body (js2-parse-expr)
9569 (js2-node-len pn) (- (js2-node-end body) pos)
9570 (js2-let-node-body pn) body))
9571 (setf (js2-let-node-vars pn) vars)
9572 (js2-node-add-children pn vars body))
9576 (defun js2-define-new-symbol (decl-type name node &optional scope)
9577 (js2-scope-put-symbol (or scope js2-current-scope)
9579 (make-js2-symbol decl-type name node)))
9581 (defun js2-define-symbol (decl-type name &optional node ignore-not-in-block)
9582 "Define a symbol in the current scope.
9583 If NODE is non-nil, it is the AST node associated with the symbol."
9584 (let* ((defining-scope (js2-get-defining-scope js2-current-scope name))
9585 (symbol (if defining-scope
9586 (js2-scope-get-symbol defining-scope name)))
9587 (sdt (if symbol (js2-symbol-decl-type symbol) -1))
9588 (pos (if node (js2-node-abs-pos node)))
9589 (len (if node (js2-node-len node))))
9591 ((and symbol ; already defined
9592 (or (if js2-in-use-strict-directive
9593 ;; two const-bound vars in this block have same name
9594 (and (= sdt js2-CONST)
9595 (eq defining-scope js2-current-scope))
9596 (or (= sdt js2-CONST) ; old version is const
9597 (= decl-type js2-CONST))) ; new version is const
9598 ;; two let-bound vars in this block have same name
9599 (and (= sdt js2-LET)
9600 (eq defining-scope js2-current-scope))))
9603 ((= sdt js2-CONST) "msg.const.redecl")
9604 ((= sdt js2-LET) "msg.let.redecl")
9605 ((= sdt js2-VAR) "msg.var.redecl")
9606 ((= sdt js2-FUNCTION) "msg.function.redecl")
9607 (t "msg.parm.redecl"))
9609 ((or (= decl-type js2-LET)
9610 ;; strict mode const is scoped to the current LexicalEnvironment
9611 (and js2-in-use-strict-directive
9612 (= decl-type js2-CONST)))
9613 (if (and (= decl-type js2-LET)
9614 (not ignore-not-in-block)
9615 (or (= (js2-node-type js2-current-scope) js2-IF)
9616 (js2-loop-node-p js2-current-scope)))
9617 (js2-report-error "msg.let.decl.not.in.block")
9618 (js2-define-new-symbol decl-type name node)))
9619 ((or (= decl-type js2-VAR)
9620 (= decl-type js2-FUNCTION)
9621 ;; sloppy mode const is scoped to the current VariableEnvironment
9622 (and (not js2-in-use-strict-directive)
9623 (= decl-type js2-CONST)))
9625 (if (and js2-strict-var-redeclaration-warning (= sdt js2-VAR))
9626 (js2-add-strict-warning "msg.var.redecl" name)
9627 (if (and js2-strict-var-hides-function-arg-warning (= sdt js2-LP))
9628 (js2-add-strict-warning "msg.var.hides.arg" name)))
9629 (js2-define-new-symbol decl-type name node
9630 js2-current-script-or-fn)))
9631 ((= decl-type js2-LP)
9633 ;; must be duplicate parameter. Second parameter hides the
9634 ;; first, so go ahead and add the second pararameter
9635 (js2-report-warning "msg.dup.parms" name))
9636 (js2-define-new-symbol decl-type name node))
9637 (t (js2-code-bug)))))
9639 (defun js2-parse-paren-expr-or-generator-comp ()
9640 (let ((px-pos (js2-current-token-beg)))
9642 ((and (>= js2-language-version 200)
9643 (js2-match-token js2-FOR))
9644 (js2-parse-generator-comp px-pos))
9645 ((and (>= js2-language-version 200)
9646 (js2-match-token js2-RP))
9647 ;; Not valid expression syntax, but this is valid in an arrow
9648 ;; function with no params: () => body.
9649 (if (eq (js2-peek-token) js2-ARROW)
9650 ;; Return whatever, it will hopefully be rewinded and
9651 ;; reparsed when we reach the =>.
9652 (make-js2-keyword-node :type js2-NULL)
9653 (js2-report-error "msg.syntax")
9654 (make-js2-error-node)))
9656 (let* ((js2-in-for-init nil)
9657 (expr (js2-parse-expr))
9658 (pn (make-js2-paren-node :pos px-pos
9660 (js2-node-add-children pn (js2-paren-node-expr pn))
9661 (js2-must-match js2-RP "msg.no.paren")
9662 (setf (js2-node-len pn) (- (js2-current-token-end) px-pos))
9665 (defun js2-parse-expr (&optional oneshot)
9666 (let* ((pn (js2-parse-assign-expr))
9667 (pos (js2-node-pos pn))
9671 (while (and (not oneshot)
9672 (js2-match-token js2-COMMA))
9673 (setq op-pos (- (js2-current-token-beg) pos)) ; relative
9674 (if (= (js2-peek-token) js2-YIELD)
9675 (js2-report-error "msg.yield.parenthesized"))
9676 (setq right (js2-parse-assign-expr)
9678 pn (make-js2-infix-node :type js2-COMMA
9680 :len (- js2-ts-cursor pos)
9684 (js2-node-add-children pn left right))
9687 (defun js2-parse-assign-expr ()
9688 (let ((tt (js2-get-token))
9689 (pos (js2-current-token-beg))
9690 pn left right op-pos
9691 ts-state recorded-identifiers parsed-errors
9693 (if (= tt js2-YIELD)
9694 (js2-parse-return-or-yield tt t)
9695 ;; TODO(mooz): Bit confusing.
9696 ;; If we meet `async` token and it's not part of `async
9697 ;; function`, then this `async` is for a succeeding async arrow
9699 ;; Since arrow function parsing doesn't rely on neither
9700 ;; `js2-parse-function-stmt' nor `js2-parse-function-expr' that
9701 ;; interpret `async` token, we trash `async` and just remember
9702 ;; we met `async` keyword to `async-p'.
9703 (when (js2-match-async-arrow-function)
9705 ;; Save the tokenizer state in case we find an arrow function
9706 ;; and have to rewind.
9707 (setq ts-state (make-js2-ts-state)
9708 recorded-identifiers js2-recorded-identifiers
9709 parsed-errors js2-parsed-errors)
9710 ;; not yield - parse assignment expression
9711 (setq pn (js2-parse-cond-expr)
9714 ((and (<= js2-first-assign tt)
9715 (<= tt js2-last-assign))
9716 ;; tt express assignment (=, |=, ^=, ..., %=)
9717 (setq op-pos (- (js2-current-token-beg) pos) ; relative
9719 ;; The assigned node could be a js2-prop-get-node (foo.bar = 0), we only
9720 ;; care about assignment to strict variable names.
9721 (when (js2-name-node-p left)
9722 (js2-check-strict-identifier left))
9723 (setq right (js2-parse-assign-expr)
9724 pn (make-js2-assign-node :type tt
9726 :len (- (js2-node-end right) pos)
9730 (when js2-parse-ide-mode
9731 (js2-highlight-assign-targets pn left right)
9732 (js2-record-imenu-functions right left))
9733 ;; do this last so ide checks above can use absolute positions
9734 (js2-node-add-children pn left right))
9735 ((and (= tt js2-ARROW)
9736 (>= js2-language-version 200))
9737 (js2-ts-seek ts-state)
9739 (js2-record-face 'font-lock-keyword-face)
9741 (setq js2-recorded-identifiers recorded-identifiers
9742 js2-parsed-errors parsed-errors)
9743 (setq pn (js2-parse-function 'FUNCTION_ARROW (js2-current-token-beg) nil async-p)))
9748 (defun js2-parse-cond-expr ()
9749 (let ((pos (js2-current-token-beg))
9750 (pn (js2-parse-or-expr))
9756 (when (js2-match-token js2-HOOK)
9757 (setq q-pos (- (js2-current-token-beg) pos)
9758 if-true (let (js2-in-for-init) (js2-parse-assign-expr)))
9759 (js2-must-match js2-COLON "msg.no.colon.cond")
9760 (setq c-pos (- (js2-current-token-beg) pos)
9761 if-false (js2-parse-assign-expr)
9763 pn (make-js2-cond-node :pos pos
9764 :len (- (js2-node-end if-false) pos)
9765 :test-expr test-expr
9767 :false-expr if-false
9770 (js2-node-add-children pn test-expr if-true if-false))
9773 (defun js2-make-binary (type left parser &optional no-get)
9774 "Helper for constructing a binary-operator AST node.
9775 LEFT is the left-side-expression, already parsed, and the
9776 binary operator should have just been matched.
9777 PARSER is a function to call to parse the right operand,
9778 or a `js2-node' struct if it has already been parsed.
9779 FIXME: The latter option is unused?"
9780 (let* ((pos (js2-node-pos left))
9781 (op-pos (- (js2-current-token-beg) pos))
9782 (right (if (js2-node-p parser)
9784 (unless no-get (js2-get-token))
9786 (pn (make-js2-infix-node :type type
9788 :len (- (js2-node-end right) pos)
9792 (js2-node-add-children pn left right)
9795 (defun js2-parse-or-expr ()
9796 (let ((pn (js2-parse-and-expr)))
9797 (when (js2-match-token js2-OR)
9798 (setq pn (js2-make-binary js2-OR
9800 'js2-parse-or-expr)))
9803 (defun js2-parse-and-expr ()
9804 (let ((pn (js2-parse-bit-or-expr)))
9805 (when (js2-match-token js2-AND)
9806 (setq pn (js2-make-binary js2-AND
9808 'js2-parse-and-expr)))
9811 (defun js2-parse-bit-or-expr ()
9812 (let ((pn (js2-parse-bit-xor-expr)))
9813 (while (js2-match-token js2-BITOR)
9814 (setq pn (js2-make-binary js2-BITOR
9816 'js2-parse-bit-xor-expr)))
9819 (defun js2-parse-bit-xor-expr ()
9820 (let ((pn (js2-parse-bit-and-expr)))
9821 (while (js2-match-token js2-BITXOR)
9822 (setq pn (js2-make-binary js2-BITXOR
9824 'js2-parse-bit-and-expr)))
9827 (defun js2-parse-bit-and-expr ()
9828 (let ((pn (js2-parse-eq-expr)))
9829 (while (js2-match-token js2-BITAND)
9830 (setq pn (js2-make-binary js2-BITAND
9832 'js2-parse-eq-expr)))
9835 (defconst js2-parse-eq-ops
9836 (list js2-EQ js2-NE js2-SHEQ js2-SHNE))
9838 (defun js2-parse-eq-expr ()
9839 (let ((pn (js2-parse-rel-expr))
9841 (while (memq (setq tt (js2-get-token)) js2-parse-eq-ops)
9842 (setq pn (js2-make-binary tt
9844 'js2-parse-rel-expr)))
9848 (defconst js2-parse-rel-ops
9849 (list js2-IN js2-INSTANCEOF js2-LE js2-LT js2-GE js2-GT))
9851 (defun js2-parse-rel-expr ()
9852 (let ((pn (js2-parse-shift-expr))
9856 (setq tt (js2-get-token))
9858 ((and js2-in-for-init (= tt js2-IN))
9860 (setq continue nil))
9861 ((memq tt js2-parse-rel-ops)
9862 (setq pn (js2-make-binary tt pn 'js2-parse-shift-expr)))
9865 (setq continue nil))))
9868 (defconst js2-parse-shift-ops
9869 (list js2-LSH js2-URSH js2-RSH))
9871 (defun js2-parse-shift-expr ()
9872 (let ((pn (js2-parse-add-expr))
9876 (setq tt (js2-get-token))
9877 (if (memq tt js2-parse-shift-ops)
9878 (setq pn (js2-make-binary tt pn 'js2-parse-add-expr))
9880 (setq continue nil)))
9883 (defun js2-parse-add-expr ()
9884 (let ((pn (js2-parse-mul-expr))
9888 (setq tt (js2-get-token))
9889 (if (or (= tt js2-ADD) (= tt js2-SUB))
9890 (setq pn (js2-make-binary tt pn 'js2-parse-mul-expr))
9892 (setq continue nil)))
9895 (defconst js2-parse-mul-ops
9896 (list js2-MUL js2-DIV js2-MOD))
9898 (defun js2-parse-mul-expr ()
9899 (let ((pn (js2-parse-unary-expr))
9903 (setq tt (js2-get-token))
9904 (if (memq tt js2-parse-mul-ops)
9905 (setq pn (js2-make-binary tt pn 'js2-parse-unary-expr))
9907 (setq continue nil)))
9910 (defun js2-make-unary (type parser &rest args)
9911 "Make a unary node of type TYPE.
9912 PARSER is either a node (for postfix operators) or a function to call
9913 to parse the operand (for prefix operators)."
9914 (let* ((pos (js2-current-token-beg))
9915 (postfix (js2-node-p parser))
9918 (apply parser args)))
9921 (if postfix ; e.g. i++
9922 (setq pos (js2-node-pos expr)
9923 end (js2-current-token-end))
9924 (setq end (js2-node-end expr)))
9925 (setq pn (make-js2-unary-node :type type
9929 (js2-node-add-children pn expr)
9932 (defconst js2-incrementable-node-types
9933 (list js2-NAME js2-GETPROP js2-GETELEM js2-GET_REF js2-CALL)
9934 "Node types that can be the operand of a ++ or -- operator.")
9936 (defun js2-check-bad-inc-dec (tt beg end unary)
9937 (unless (memq (js2-node-type (js2-unary-node-operand unary))
9938 js2-incrementable-node-types)
9939 (js2-report-error (if (= tt js2-INC)
9942 nil beg (- end beg))))
9944 (defun js2-parse-unary-expr ()
9945 (let ((tt (js2-current-token-type))
9948 ((or (= tt js2-VOID)
9953 (js2-make-unary tt 'js2-parse-unary-expr))
9956 ;; Convert to special POS token in decompiler and parse tree
9957 (js2-make-unary js2-POS 'js2-parse-unary-expr))
9960 ;; Convert to special NEG token in decompiler and parse tree
9961 (js2-make-unary js2-NEG 'js2-parse-unary-expr))
9966 (setq beg (js2-current-token-beg)
9967 end (js2-current-token-end)
9968 expr (js2-make-unary tt 'js2-parse-member-expr t))
9969 (js2-check-bad-inc-dec tt beg end expr)))
9972 (js2-make-unary js2-DELPROP 'js2-parse-unary-expr))
9973 ((js2-parse-await-maybe tt))
9976 (make-js2-error-node)) ; try to continue
9978 js2-compiler-xml-available)
9979 ;; XML stream encountered in expression.
9980 (js2-parse-member-expr-tail t (js2-parse-xml-initializer)))
9982 (setq pn (js2-parse-member-expr t)
9983 ;; Don't look across a newline boundary for a postfix incop.
9984 tt (js2-peek-token-or-eol))
9985 (when (or (= tt js2-INC) (= tt js2-DEC))
9988 pn (js2-make-unary tt expr))
9989 (js2-node-set-prop pn 'postfix t)
9990 (js2-check-bad-inc-dec tt (js2-current-token-beg) (js2-current-token-end) pn))
9993 (defun js2-parse-xml-initializer ()
9994 "Parse an E4X XML initializer.
9995 I'm parsing it the way Rhino parses it, but without the tree-rewriting.
9996 Then I'll postprocess the result, depending on whether we're in IDE
9997 mode or codegen mode, and generate the appropriate rewritten AST.
9998 IDE mode uses a rich AST that models the XML structure. Codegen mode
9999 just concatenates everything and makes a new XML or XMLList out of it."
10000 (let ((tt (js2-get-first-xml-token))
10001 pn-xml pn expr kids expr-pos
10004 (when (not (or (= tt js2-XML) (= tt js2-XMLEND)))
10005 (js2-report-error "msg.syntax"))
10006 (setq pn-xml (make-js2-xml-node))
10009 (setq first-token nil)
10010 (setq tt (js2-get-next-xml-token)))
10012 ;; js2-XML means we found a {expr} in the XML stream.
10013 ;; The token string is the XML up to the left-curly.
10015 (push (make-js2-string-node :pos (js2-current-token-beg)
10016 :len (- js2-ts-cursor (js2-current-token-beg)))
10018 (js2-must-match js2-LC "msg.syntax")
10019 (setq expr-pos js2-ts-cursor
10020 expr (if (eq (js2-peek-token) js2-RC)
10021 (make-js2-empty-expr-node :pos expr-pos)
10023 (js2-must-match js2-RC "msg.syntax")
10024 (setq pn (make-js2-xml-js-expr-node :pos (js2-node-pos expr)
10025 :len (js2-node-len expr)
10027 (js2-node-add-children pn expr)
10029 ;; a js2-XMLEND token means we hit the final close-tag.
10031 (push (make-js2-string-node :pos (js2-current-token-beg)
10032 :len (- js2-ts-cursor (js2-current-token-beg)))
10034 (dolist (kid (nreverse kids))
10035 (js2-block-node-push pn-xml kid))
10036 (setf (js2-node-len pn-xml) (- js2-ts-cursor
10037 (js2-node-pos pn-xml))
10040 (js2-report-error "msg.syntax")
10041 (setq continue nil))))
10045 (defun js2-parse-argument-list ()
10046 "Parse an argument list and return it as a Lisp list of nodes.
10047 Returns the list in reverse order. Consumes the right-paren token."
10049 (unless (js2-match-token js2-RP)
10051 (let ((tt (js2-get-token)))
10052 (if (= tt js2-YIELD)
10053 (js2-report-error "msg.yield.parenthesized"))
10054 (if (and (= tt js2-TRIPLEDOT)
10055 (>= js2-language-version 200))
10056 (push (js2-make-unary tt 'js2-parse-assign-expr) result)
10058 (push (js2-parse-assign-expr) result)))
10060 (js2-match-token js2-COMMA))
10061 (js2-must-match js2-RP "msg.no.paren.arg")
10064 (defun js2-parse-member-expr (&optional allow-call-syntax)
10065 (let ((tt (js2-current-token-type))
10066 pn pos target args beg end init)
10067 (if (/= tt js2-NEW)
10068 (setq pn (js2-parse-primary-expr))
10069 ;; parse a 'new' expression
10071 (setq pos (js2-current-token-beg)
10073 target (js2-parse-member-expr)
10074 end (js2-node-end target)
10075 pn (make-js2-new-node :pos pos
10078 (js2-highlight-function-call (js2-current-token))
10079 (js2-node-add-children pn target)
10080 (when (js2-match-token js2-LP)
10081 ;; Add the arguments to pn, if any are supplied.
10082 (setf beg pos ; start of "new" keyword
10083 pos (js2-current-token-beg)
10084 args (nreverse (js2-parse-argument-list))
10085 (js2-new-node-args pn) args
10086 end (js2-current-token-end)
10087 (js2-new-node-lp pn) (- pos beg)
10088 (js2-new-node-rp pn) (- end 1 beg))
10089 (apply #'js2-node-add-children pn args))
10090 (when (and js2-allow-rhino-new-expr-initializer
10091 (js2-match-token js2-LC))
10092 (setf init (js2-parse-object-literal)
10093 end (js2-node-end init)
10094 (js2-new-node-initializer pn) init)
10095 (js2-node-add-children pn init))
10096 (setf (js2-node-len pn) (- end beg))) ; end outer if
10097 (js2-parse-member-expr-tail allow-call-syntax pn)))
10099 (defun js2-parse-member-expr-tail (allow-call-syntax pn)
10100 "Parse a chain of property/array accesses or function calls.
10101 Includes parsing for E4X operators like `..' and `.@'.
10102 If ALLOW-CALL-SYNTAX is nil, stops when we encounter a left-paren.
10103 Returns an expression tree that includes PN, the parent node."
10107 (setq tt (js2-get-token))
10109 ((or (= tt js2-DOT) (= tt js2-DOTDOT))
10110 (setq pn (js2-parse-property-access tt pn)))
10111 ((= tt js2-DOTQUERY)
10112 (setq pn (js2-parse-dot-query pn)))
10114 (setq pn (js2-parse-element-get pn)))
10117 (if allow-call-syntax
10118 (setq pn (js2-parse-function-call pn))
10119 (setq continue nil)))
10120 ((= tt js2-TEMPLATE_HEAD)
10121 (setq pn (js2-parse-tagged-template pn (js2-parse-template-literal))))
10122 ((= tt js2-NO_SUBS_TEMPLATE)
10123 (setq pn (js2-parse-tagged-template pn (make-js2-string-node :type tt))))
10126 (setq continue nil)))
10127 (if (>= js2-highlight-level 2)
10128 (js2-parse-highlight-member-expr-node pn)))
10131 (defun js2-parse-tagged-template (tag-node tpl-node)
10132 "Parse tagged template expression."
10133 (let* ((beg (js2-node-pos tag-node))
10134 (pn (make-js2-tagged-template-node :beg beg
10135 :len (- (js2-current-token-end) beg)
10137 :template tpl-node)))
10138 (js2-node-add-children pn tag-node tpl-node)
10141 (defun js2-parse-dot-query (pn)
10142 "Parse a dot-query expression, e.g. foo.bar.(@name == 2)
10143 Last token parsed must be `js2-DOTQUERY'."
10144 (let ((pos (js2-node-pos pn))
10146 (js2-must-have-xml)
10147 (js2-set-requires-activation)
10148 (setq op-pos (js2-current-token-beg)
10149 expr (js2-parse-expr)
10150 end (js2-node-end expr)
10151 pn (make-js2-xml-dot-query-node :left pn
10155 (js2-node-add-children pn
10156 (js2-xml-dot-query-node-left pn)
10157 (js2-xml-dot-query-node-right pn))
10158 (if (js2-must-match js2-RP "msg.no.paren")
10159 (setf (js2-xml-dot-query-node-rp pn) (js2-current-token-beg)
10160 end (js2-current-token-end)))
10161 (setf (js2-node-len pn) (- end pos))
10164 (defun js2-parse-element-get (pn)
10165 "Parse an element-get expression, e.g. foo[bar].
10166 Last token parsed must be `js2-RB'."
10167 (let ((lb (js2-current-token-beg))
10168 (pos (js2-node-pos pn))
10170 (setq expr (js2-parse-expr))
10171 (if (js2-must-match js2-RB "msg.no.bracket.index")
10172 (setq rb (js2-current-token-beg)))
10173 (setq pn (make-js2-elem-get-node :target pn
10176 :lb (js2-relpos lb pos)
10177 :rb (js2-relpos rb pos)
10178 :len (- (js2-current-token-end) pos)))
10179 (js2-node-add-children pn
10180 (js2-elem-get-node-target pn)
10181 (js2-elem-get-node-element pn))
10184 (defun js2-highlight-function-call (token)
10185 (when (eq (js2-token-type token) js2-NAME)
10186 (js2-record-face 'js2-function-call token)))
10188 (defun js2-parse-function-call (pn)
10189 (js2-highlight-function-call (js2-current-token))
10192 (pos (js2-node-pos pn)))
10193 (setq pn (make-js2-call-node :pos pos
10195 :lp (- (js2-current-token-beg) pos)))
10196 (js2-node-add-children pn (js2-call-node-target pn))
10197 ;; Add the arguments to pn, if any are supplied.
10198 (setf args (nreverse (js2-parse-argument-list))
10199 (js2-call-node-rp pn) (- (js2-current-token-beg) pos)
10200 (js2-call-node-args pn) args)
10201 (apply #'js2-node-add-children pn args)
10202 (setf (js2-node-len pn) (- js2-ts-cursor pos))
10205 (defun js2-parse-property-access (tt pn)
10206 "Parse a property access, XML descendants access, or XML attr access."
10207 (let ((member-type-flags 0)
10208 (dot-pos (js2-current-token-beg))
10209 (dot-len (if (= tt js2-DOTDOT) 2 1))
10211 ref ; right side of . or .. operator
10213 (when (= tt js2-DOTDOT)
10214 (js2-must-have-xml)
10215 (setq member-type-flags js2-descendants-flag))
10216 (if (not js2-compiler-xml-available)
10218 (js2-must-match-prop-name "msg.no.name.after.dot")
10219 (setq name (js2-create-name-node t js2-GETPROP)
10220 result (make-js2-prop-get-node :left pn
10221 :pos (js2-current-token-beg)
10223 :len (js2-current-token-len)))
10224 (js2-node-add-children result pn name)
10226 ;; otherwise look for XML operators
10227 (setf result (if (= tt js2-DOT)
10228 (make-js2-prop-get-node)
10229 (make-js2-infix-node :type js2-DOTDOT))
10230 (js2-node-pos result) (js2-node-pos pn)
10231 (js2-infix-node-op-pos result) dot-pos
10232 (js2-infix-node-left result) pn ; do this after setting position
10233 tt (js2-get-prop-name-token))
10235 ;; handles: name, ns::name, ns::*, ns::[expr]
10237 (setq ref (js2-parse-property-name -1 nil member-type-flags)))
10238 ;; handles: *, *::name, *::*, *::[expr]
10240 (setq ref (js2-parse-property-name nil "*" member-type-flags)))
10241 ;; handles: '@attr', '@ns::attr', '@ns::*', '@ns::[expr]', etc.
10242 ((= tt js2-XMLATTR)
10243 (setq result (js2-parse-attribute-access)))
10245 (js2-report-error "msg.no.name.after.dot" nil dot-pos dot-len)))
10247 (setf (js2-node-len result) (- (js2-node-end ref)
10248 (js2-node-pos result))
10249 (js2-infix-node-right result) ref))
10250 (if (js2-infix-node-p result)
10251 (js2-node-add-children result
10252 (js2-infix-node-left result)
10253 (js2-infix-node-right result)))
10256 (defun js2-parse-attribute-access ()
10257 "Parse an E4X XML attribute expression.
10258 This includes expressions of the forms:
10260 @attr @ns::attr @ns::*
10262 @[expr] @*::[expr] @ns::[expr]
10264 Called if we peeked an '@' token."
10265 (let ((tt (js2-get-prop-name-token))
10266 (at-pos (js2-current-token-beg)))
10268 ;; handles: @name, @ns::name, @ns::*, @ns::[expr]
10270 (js2-parse-property-name at-pos nil 0))
10271 ;; handles: @*, @*::name, @*::*, @*::[expr]
10273 (js2-parse-property-name (js2-current-token-beg) "*" 0))
10276 (js2-parse-xml-elem-ref at-pos))
10278 (js2-report-error "msg.no.name.after.xmlAttr")
10279 ;; Avoid cascaded errors that happen if we make an error node here.
10280 (js2-parse-property-name (js2-current-token-beg) "" 0)))))
10282 (defun js2-parse-property-name (at-pos s member-type-flags)
10283 "Check if :: follows name in which case it becomes qualified name.
10285 AT-POS is a natural number if we just read an '@' token, else nil.
10286 S is the name or string that was matched: an identifier, 'throw' or '*'.
10287 MEMBER-TYPE-FLAGS is a bit set tracking whether we're a '.' or '..' child.
10289 Returns a `js2-xml-ref-node' if it's an attribute access, a child of a '..'
10290 operator, or the name is followed by ::. For a plain name, returns a
10291 `js2-name-node'. Returns a `js2-error-node' for malformed XML expressions."
10292 (let ((pos (or at-pos (js2-current-token-beg)))
10294 (name (js2-create-name-node t (js2-current-token-type) s))
10297 (when (js2-match-token js2-COLONCOLON)
10299 colon-pos (js2-current-token-beg)
10300 tt (js2-get-prop-name-token))
10302 ;; handles name::name
10304 (setq name (js2-create-name-node)))
10307 (setq name (js2-create-name-node nil nil "*")))
10308 ;; handles name::[expr]
10310 (throw 'return (js2-parse-xml-elem-ref at-pos ns colon-pos)))
10312 (js2-report-error "msg.no.name.after.coloncolon"))))
10313 (if (and (null ns) (zerop member-type-flags))
10317 (make-js2-xml-prop-ref-node :pos pos
10318 :len (- (js2-node-end name) pos)
10320 :colon-pos colon-pos
10322 (js2-node-add-children pn name))))))
10324 (defun js2-parse-xml-elem-ref (at-pos &optional namespace colon-pos)
10325 "Parse the [expr] portion of an xml element reference.
10326 For instance, @[expr], @*::[expr], or ns::[expr]."
10327 (let* ((lb (js2-current-token-beg))
10328 (pos (or at-pos lb))
10330 (expr (js2-parse-expr))
10331 (end (js2-node-end expr))
10333 (if (js2-must-match js2-RB "msg.no.bracket.index")
10334 (setq rb (js2-current-token-beg)
10335 end (js2-current-token-end)))
10338 (make-js2-xml-elem-ref-node :pos pos
10340 :namespace namespace
10341 :colon-pos colon-pos
10344 :lb (js2-relpos lb pos)
10345 :rb (js2-relpos rb pos)))
10346 (js2-node-add-children pn namespace expr))))
10348 (defun js2-parse-destruct-primary-expr ()
10349 (let ((js2-is-in-destructuring t))
10350 (js2-parse-primary-expr)))
10352 (defun js2-parse-primary-expr ()
10353 "Parse a literal (leaf) expression of some sort.
10354 Includes complex literals such as functions, object-literals,
10355 array-literals, array comprehensions and regular expressions."
10357 (setq tt (js2-current-token-type))
10360 (js2-parse-class-expr))
10361 ((= tt js2-FUNCTION)
10362 (js2-parse-function-expr))
10363 ((js2-match-async-function)
10364 (js2-parse-function-expr t))
10366 (js2-parse-array-comp-or-literal))
10368 (js2-parse-object-literal))
10370 (js2-parse-let (js2-current-token-beg)))
10372 (js2-parse-paren-expr-or-generator-comp))
10373 ((= tt js2-XMLATTR)
10374 (js2-must-have-xml)
10375 (js2-parse-attribute-access))
10377 (js2-parse-name tt))
10379 (setq node (make-js2-number-node))
10380 (when (and js2-in-use-strict-directive
10381 (= (js2-number-node-num-base node) 8)
10382 (js2-number-node-legacy-octal-p node))
10383 (js2-report-error "msg.no.octal.strict"))
10385 ((or (= tt js2-STRING) (= tt js2-NO_SUBS_TEMPLATE))
10386 (make-js2-string-node :type tt))
10387 ((= tt js2-TEMPLATE_HEAD)
10388 (js2-parse-template-literal))
10389 ((or (= tt js2-DIV) (= tt js2-ASSIGN_DIV))
10390 ;; Got / or /= which in this context means a regexp literal
10391 (let ((px-pos (js2-current-token-beg))
10392 (flags (js2-read-regexp tt))
10393 (end (js2-current-token-end)))
10395 (make-js2-regexp-node :pos px-pos
10396 :len (- end px-pos)
10397 :value (js2-current-token-string)
10399 (js2-set-face px-pos end 'font-lock-string-face 'record)
10400 (js2-record-text-property px-pos end 'syntax-table '(2)))))
10401 ((or (= tt js2-NULL)
10406 (make-js2-keyword-node :type tt))
10407 ((= tt js2-TRIPLEDOT)
10408 ;; Likewise, only valid in an arrow function with a rest param.
10409 (if (and (js2-match-token js2-NAME)
10410 (js2-match-token js2-RP)
10411 (eq (js2-peek-token) js2-ARROW))
10413 (js2-unget-token) ; Put back the right paren.
10414 ;; See the previous case.
10415 (make-js2-keyword-node :type js2-NULL))
10416 (js2-report-error "msg.syntax")
10417 (make-js2-error-node)))
10418 ((= tt js2-RESERVED)
10419 (js2-report-error "msg.reserved.id")
10420 (make-js2-name-node))
10422 ;; the scanner or one of its subroutines reported the error.
10423 (make-js2-error-node))
10425 (let* ((px-pos (point-at-bol))
10426 (len (- js2-ts-cursor px-pos)))
10427 (js2-report-error "msg.unexpected.eof" nil px-pos len))
10428 (make-js2-error-node :pos (1- js2-ts-cursor)))
10430 (js2-report-error "msg.syntax")
10431 (make-js2-error-node)))))
10433 (defun js2-parse-template-literal ()
10434 (let ((beg (js2-current-token-beg))
10435 (kids (list (make-js2-string-node :type js2-TEMPLATE_HEAD)))
10436 (tt js2-TEMPLATE_HEAD))
10437 (while (eq tt js2-TEMPLATE_HEAD)
10438 (push (js2-parse-expr) kids)
10439 (js2-must-match js2-RC "msg.syntax")
10440 (setq tt (js2-get-token 'TEMPLATE_TAIL))
10441 (push (make-js2-string-node :type tt) kids))
10442 (setq kids (nreverse kids))
10443 (let ((tpl (make-js2-template-node :beg beg
10444 :len (- (js2-current-token-end) beg)
10446 (apply #'js2-node-add-children tpl kids)
10449 (defun js2-parse-name (_tt)
10450 (let ((name (js2-current-token-string))
10452 (setq node (if js2-compiler-xml-available
10453 (js2-parse-property-name nil name 0)
10454 (js2-create-name-node 'check-activation nil name)))
10455 (if js2-highlight-external-variables
10456 (js2-record-name-node node))
10459 (defun js2-parse-warn-trailing-comma (msg pos elems comma-pos)
10460 (js2-add-strict-warning
10462 ;; back up from comma to beginning of line or array/objlit
10464 (js2-node-pos (car elems))
10467 (goto-char comma-pos)
10468 (back-to-indentation)
10472 (defun js2-parse-array-comp-or-literal ()
10473 (let ((pos (js2-current-token-beg)))
10474 (if (and (>= js2-language-version 200)
10475 (js2-match-token js2-FOR))
10476 (js2-parse-array-comp pos)
10477 (js2-parse-array-literal pos))))
10479 (defun js2-parse-array-literal (pos)
10480 (let ((after-lb-or-comma t)
10481 after-comma tt elems pn
10483 (unless js2-is-in-destructuring
10484 (js2-push-scope (make-js2-scope))) ; for the legacy array comp
10486 (setq tt (js2-get-token))
10490 (setq after-comma (js2-current-token-end))
10491 (if (not after-lb-or-comma)
10492 (setq after-lb-or-comma t)
10496 (= tt js2-EOF)) ; prevent infinite loop
10498 (js2-report-error "msg.no.bracket.arg" nil pos))
10499 (when (and after-comma (< js2-language-version 170))
10500 (js2-parse-warn-trailing-comma "msg.array.trailing.comma"
10501 pos (remove nil elems) after-comma))
10503 pn (make-js2-array-node :pos pos
10504 :len (- js2-ts-cursor pos)
10505 :elems (nreverse elems)))
10506 (apply #'js2-node-add-children pn (js2-array-node-elems pn)))
10507 ;; destructuring binding
10508 (js2-is-in-destructuring
10510 ((and (= tt js2-NAME)
10511 (= js2-ASSIGN (js2-peek-token)))
10513 (js2-parse-initialized-binding (js2-parse-name js2-NAME)))
10517 ;; [a, b, c] | {a, b, c} | {a:x, b:y, c:z} | a
10518 (js2-parse-destruct-primary-expr))
10521 (js2-report-error "msg.bad.var")
10522 (make-js2-error-node)))
10524 (setq after-lb-or-comma nil
10527 ((and (>= js2-language-version 170)
10528 (= tt js2-FOR) ; check for array comprehension
10529 (not after-lb-or-comma) ; "for" can't follow a comma
10530 elems ; must have at least 1 element
10531 (not (cdr elems))) ; but no 2nd element
10534 pn (js2-parse-legacy-array-comp (car elems) pos)))
10537 (unless after-lb-or-comma
10538 (js2-report-error "msg.no.bracket.arg"))
10539 (if (and (= tt js2-TRIPLEDOT)
10540 (>= js2-language-version 200))
10542 (push (js2-make-unary tt 'js2-parse-assign-expr)
10545 (push (js2-parse-assign-expr) elems))
10546 (setq after-lb-or-comma nil
10547 after-comma nil))))
10548 (unless js2-is-in-destructuring
10552 (defun js2-parse-legacy-array-comp (expr pos)
10553 "Parse a legacy array comprehension (JavaScript 1.7).
10554 EXPR is the first expression after the opening left-bracket.
10555 POS is the beginning of the LB token preceding EXPR.
10556 We should have just parsed the 'for' keyword before calling this function."
10557 (let ((current-scope js2-current-scope)
10558 loops first filter result)
10561 (while (js2-match-token js2-FOR)
10562 (let ((loop (make-js2-comp-loop-node)))
10563 (js2-push-scope loop)
10565 (js2-parse-comp-loop loop)))
10566 ;; First loop takes expr scope's parent.
10567 (setf (js2-scope-parent-scope (setq first (car (last loops))))
10568 (js2-scope-parent-scope current-scope))
10569 ;; Set expr scope's parent to the last loop.
10570 (setf (js2-scope-parent-scope current-scope) (car loops))
10571 (if (/= (js2-get-token) js2-IF)
10573 (setq filter (js2-parse-condition))))
10574 (dotimes (_ (1- (length loops)))
10576 (js2-must-match js2-RB "msg.no.bracket.arg" pos)
10577 (setq result (make-js2-comp-node :pos pos
10578 :len (- js2-ts-cursor pos)
10580 :loops (nreverse loops)
10581 :filters (and filter (list (car filter)))
10582 :form 'LEGACY_ARRAY))
10583 ;; Set comp loop's parent to the last loop.
10584 ;; TODO: Get rid of the bogus expr scope.
10585 (setf (js2-scope-parent-scope result) first)
10586 (apply #'js2-node-add-children result expr (car filter)
10587 (js2-comp-node-loops result))
10590 (defun js2-parse-array-comp (pos)
10591 "Parse an ES6 array comprehension.
10592 POS is the beginning of the LB token.
10593 We should have just parsed the 'for' keyword before calling this function."
10594 (let ((pn (js2-parse-comprehension pos 'ARRAY)))
10595 (js2-must-match js2-RB "msg.no.bracket.arg" pos)
10598 (defun js2-parse-generator-comp (pos)
10599 (let* ((js2-nesting-of-function (1+ js2-nesting-of-function))
10600 (js2-current-script-or-fn
10601 (make-js2-function-node :generator-type 'COMPREHENSION))
10602 (pn (js2-parse-comprehension pos 'STAR_GENERATOR)))
10603 (js2-must-match js2-RP "msg.no.paren" pos)
10606 (defun js2-parse-comprehension (pos form)
10607 (let (loops filters expr result last)
10611 (while (js2-match-token js2-FOR)
10612 (let ((loop (make-js2-comp-loop-node)))
10613 (js2-push-scope loop)
10615 (js2-parse-comp-loop loop)))
10616 (while (js2-match-token js2-IF)
10617 (push (car (js2-parse-condition)) filters))
10618 (setq expr (js2-parse-assign-expr))
10619 (setq last (car loops)))
10622 (setq result (make-js2-comp-node :pos pos
10623 :len (- js2-ts-cursor pos)
10625 :loops (nreverse loops)
10626 :filters (nreverse filters)
10628 (apply #'js2-node-add-children result (js2-comp-node-loops result))
10629 (apply #'js2-node-add-children result expr (js2-comp-node-filters result))
10630 (setf (js2-scope-parent-scope result) last)
10633 (defun js2-parse-comp-loop (pn &optional only-of-p)
10634 "Parse a 'for [each] (foo [in|of] bar)' expression in an Array comprehension.
10635 The current token should be the initial FOR.
10636 If ONLY-OF-P is non-nil, only the 'for (foo of bar)' form is allowed."
10637 (let ((pos (js2-comp-loop-node-pos pn))
10638 tt iter obj foreach-p forof-p in-pos each-pos lp rp)
10639 (when (and (not only-of-p) (js2-match-token js2-NAME))
10640 (if (string= (js2-current-token-string) "each")
10643 each-pos (- (js2-current-token-beg) pos)) ; relative
10644 (js2-record-face 'font-lock-keyword-face))
10645 (js2-report-error "msg.no.paren.for")))
10646 (if (js2-must-match js2-LP "msg.no.paren.for")
10647 (setq lp (- (js2-current-token-beg) pos)))
10648 (setq tt (js2-peek-token))
10653 (setq iter (js2-parse-destruct-primary-expr))
10654 (js2-define-destruct-symbols iter js2-LET
10655 'font-lock-variable-name-face t))
10656 ((js2-match-token js2-NAME)
10657 (setq iter (js2-create-name-node)))
10659 (js2-report-error "msg.bad.var")))
10660 ;; Define as a let since we want the scope of the variable to
10661 ;; be restricted to the array comprehension
10662 (if (js2-name-node-p iter)
10663 (js2-define-symbol js2-LET (js2-name-node-name iter) pn t))
10664 (if (or (and (not only-of-p) (js2-match-token js2-IN))
10665 (and (>= js2-language-version 200)
10666 (js2-match-contextual-kwd "of")
10668 (setq in-pos (- (js2-current-token-beg) pos))
10669 (js2-report-error "msg.in.after.for.name"))
10670 (setq obj (js2-parse-expr))
10671 (if (js2-must-match js2-RP "msg.no.paren.for.ctrl")
10672 (setq rp (- (js2-current-token-beg) pos)))
10673 (setf (js2-node-pos pn) pos
10674 (js2-node-len pn) (- js2-ts-cursor pos)
10675 (js2-comp-loop-node-iterator pn) iter
10676 (js2-comp-loop-node-object pn) obj
10677 (js2-comp-loop-node-in-pos pn) in-pos
10678 (js2-comp-loop-node-each-pos pn) each-pos
10679 (js2-comp-loop-node-foreach-p pn) foreach-p
10680 (js2-comp-loop-node-forof-p pn) forof-p
10681 (js2-comp-loop-node-lp pn) lp
10682 (js2-comp-loop-node-rp pn) rp)
10683 (js2-node-add-children pn iter obj)
10686 (defun js2-parse-class-stmt ()
10687 (let ((pos (js2-current-token-beg))
10688 (_ (js2-must-match-name "msg.unnamed.class.stmt"))
10689 (name (js2-create-name-node t)))
10690 (js2-set-face (js2-node-pos name) (js2-node-end name)
10691 'font-lock-function-name-face 'record)
10692 (let ((node (js2-parse-class pos 'CLASS_STATEMENT name)))
10693 (js2-record-imenu-functions node name)
10694 (js2-define-symbol js2-FUNCTION
10695 (js2-name-node-name name)
10699 (defun js2-parse-class-expr ()
10700 (let ((pos (js2-current-token-beg))
10702 (when (js2-match-token js2-NAME)
10703 (setq name (js2-create-name-node t)))
10704 (js2-parse-class pos 'CLASS_EXPRESSION name)))
10706 (defun js2-parse-class (pos form name)
10707 ;; class X [extends ...] {
10708 (let (pn elems extends)
10709 (if (js2-match-token js2-EXTENDS)
10710 (if (= (js2-peek-token) js2-LC)
10711 (js2-report-error "msg.missing.extends")
10712 ;; TODO(sdh): this should be left-hand-side-expr, not assign-expr
10713 (setq extends (js2-parse-assign-expr))
10715 (js2-report-error "msg.bad.extends"))))
10716 (js2-must-match js2-LC "msg.no.brace.class")
10717 (setq elems (js2-parse-object-literal-elems t)
10718 pn (make-js2-class-node :pos pos
10719 :len (- js2-ts-cursor pos)
10724 (apply #'js2-node-add-children pn (js2-class-node-elems pn))
10727 (defun js2-parse-object-literal ()
10728 (let* ((pos (js2-current-token-beg))
10729 (elems (js2-parse-object-literal-elems))
10730 (result (make-js2-object-node :pos pos
10731 :len (- js2-ts-cursor pos)
10733 (apply #'js2-node-add-children result (js2-object-node-elems result))
10736 (defun js2-property-key-string (property-node)
10737 "Return the key of PROPERTY-NODE (a `js2-object-prop-node' or
10738 `js2-method-node') as a string, or nil if it can't be
10739 represented as a string (e.g., the key is computed by an
10741 (let ((key (js2-infix-node-left property-node)))
10742 (when (js2-computed-prop-name-node-p key)
10743 (setq key (js2-computed-prop-name-node-expr key)))
10745 ((js2-name-node-p key)
10746 (js2-name-node-name key))
10747 ((js2-string-node-p key)
10748 (js2-string-node-value key))
10749 ((js2-number-node-p key)
10750 (js2-number-node-value key)))))
10752 (defun js2-parse-object-literal-elems (&optional class-p)
10753 (let ((pos (js2-current-token-beg))
10757 elem-key-string previous-elem-key-string
10758 after-comma previous-token)
10760 (setq tt (js2-get-prop-name-token)
10763 previous-token nil)
10764 ;; Handle 'static' keyword only if we're in a class
10765 (when (and class-p (= js2-NAME tt)
10766 (string= "static" (js2-current-token-string)))
10767 (js2-record-face 'font-lock-keyword-face)
10769 tt (js2-get-prop-name-token)))
10770 ;; Handle generator * before the property name for in-line functions
10771 (when (and (>= js2-language-version 200)
10773 (setq previous-token (js2-current-token)
10774 tt (js2-get-prop-name-token)))
10775 ;; Handle getter, setter and async methods
10776 (let ((prop (js2-current-token-string)))
10777 (when (and (>= js2-language-version 200)
10779 (member prop '("get" "set" "async"))
10780 (member (js2-peek-token)
10781 (list js2-NAME js2-STRING js2-NUMBER js2-LB)))
10782 (setq previous-token (js2-current-token)
10783 tt (js2-get-prop-name-token))))
10785 ;; Found a property (of any sort)
10786 ((member tt (list js2-NAME js2-STRING js2-NUMBER js2-LB))
10787 (setq after-comma nil
10788 elem (js2-parse-named-prop tt previous-token))
10789 (if (and (null elem)
10790 (not js2-recover-from-parse-errors))
10791 (setq continue nil)))
10792 ;; Break out of loop, and handle trailing commas.
10796 (setq continue nil)
10798 (js2-parse-warn-trailing-comma "msg.extra.trailing.comma"
10799 pos elems after-comma)))
10800 ;; Skip semicolons in a class body
10805 (js2-report-error "msg.bad.prop")
10806 (unless js2-recover-from-parse-errors
10807 (setq continue nil)))) ; end switch
10808 ;; Handle static for classes' codegen.
10810 (if elem (js2-node-set-prop elem 'STATIC t)
10811 (js2-report-error "msg.unexpected.static")))
10812 ;; Handle commas, depending on class-p.
10813 (let ((tok (js2-get-prop-name-token)))
10814 (if (eq tok js2-COMMA)
10816 (js2-report-error "msg.class.unexpected.comma")
10817 (setq after-comma (js2-current-token-end)))
10819 (unless class-p (setq continue nil))))
10821 (when (and js2-in-use-strict-directive
10822 (setq elem-key-string (js2-property-key-string elem))
10824 (lambda (previous-elem)
10825 (and (setq previous-elem-key-string
10826 (js2-property-key-string previous-elem))
10827 ;; Check if the property is a duplicate.
10828 (string= previous-elem-key-string elem-key-string)
10829 ;; But make an exception for getter / setter pairs.
10830 (not (and (js2-method-node-p elem)
10831 (js2-method-node-p previous-elem)
10832 (let ((type (js2-node-get-prop (js2-method-node-right elem) 'METHOD_TYPE))
10833 (previous-type (js2-node-get-prop (js2-method-node-right previous-elem) 'METHOD_TYPE)))
10834 (and (member type '(GET SET))
10835 (member previous-type '(GET SET))
10836 (not (eq type previous-type))))))))
10838 (js2-report-error "msg.dup.obj.lit.prop.strict"
10840 (js2-node-abs-pos (js2-infix-node-left elem))
10841 (js2-node-len (js2-infix-node-left elem))))
10842 ;; Append any parsed element.
10843 (push elem elems))) ; end loop
10844 (js2-must-match js2-RC "msg.no.brace.prop")
10847 (defun js2-parse-named-prop (tt previous-token)
10848 "Parse a name, string, or getter/setter object property.
10849 When `js2-is-in-destructuring' is t, forms like {a, b, c} will be permitted."
10850 (let ((key (js2-parse-prop-name tt))
10851 (prop (and previous-token (js2-token-string previous-token)))
10852 (property-type (when previous-token
10853 (if (= (js2-token-type previous-token) js2-MUL)
10855 (js2-token-string previous-token))))
10857 (when (member prop '("get" "set" "async"))
10858 (setq pos (js2-token-beg previous-token))
10859 (js2-set-face (js2-token-beg previous-token)
10860 (js2-token-end previous-token)
10861 'font-lock-keyword-face 'record)) ; get/set/async
10863 ;; method definition: {f() {...}}
10864 ((and (= (js2-peek-token) js2-LP)
10865 (>= js2-language-version 200))
10866 (when (js2-name-node-p key) ; highlight function name properties
10867 (js2-record-face 'font-lock-function-name-face))
10868 (js2-parse-method-prop pos key property-type))
10869 ;; binding element with initializer
10870 ((and (= (js2-peek-token) js2-ASSIGN)
10871 (>= js2-language-version 200))
10872 (if (not js2-is-in-destructuring)
10873 (js2-report-error "msg.init.no.destruct"))
10874 (js2-parse-initialized-binding key))
10877 (let ((beg (js2-current-token-beg))
10878 (end (js2-current-token-end))
10879 (expr (js2-parse-plain-property key)))
10880 (when (and (= tt js2-NAME)
10881 (not js2-is-in-destructuring)
10882 js2-highlight-external-variables
10883 (js2-node-get-prop expr 'SHORTHAND))
10884 (js2-record-name-node key))
10885 (js2-set-face beg end
10886 (if (js2-function-node-p
10887 (js2-object-prop-node-right expr))
10888 'font-lock-function-name-face
10889 'js2-object-property)
10893 (defun js2-parse-initialized-binding (name)
10894 "Parse a `SingleNameBinding' with initializer.
10896 `name' is the `BindingIdentifier'."
10897 (when (js2-match-token js2-ASSIGN)
10898 (js2-make-binary js2-ASSIGN name 'js2-parse-assign-expr t)))
10900 (defun js2-parse-prop-name (tt)
10902 ;; Literal string keys: {'foo': 'bar'}
10904 (make-js2-string-node))
10905 ;; Handle computed keys: {[Symbol.iterator]: ...}, *[1+2]() {...}},
10906 ;; {[foo + bar]() { ... }}, {[get ['x' + 1]() {...}}
10907 ((and (= tt js2-LB)
10908 (>= js2-language-version 200))
10909 (make-js2-computed-prop-name-node
10910 :expr (prog1 (js2-parse-assign-expr)
10911 (js2-must-match js2-RB "msg.missing.computed.rb"))))
10912 ;; Numeric keys: {12: 'foo'}, {10.7: 'bar'}
10914 (make-js2-number-node))
10915 ;; Unquoted names: {foo: 12}
10917 (js2-create-name-node))
10918 ;; Anything else is an error
10919 (t (js2-report-error "msg.bad.prop"))))
10921 (defun js2-parse-plain-property (prop)
10922 "Parse a non-getter/setter property in an object literal.
10923 PROP is the node representing the property: a number, name,
10924 string or expression."
10925 (let* ((tt (js2-get-token))
10926 (pos (js2-node-pos prop))
10929 ;; Abbreviated property, as in {foo, bar}
10930 ((and (>= js2-language-version 200)
10931 (or (= tt js2-COMMA)
10933 (not (js2-number-node-p prop)))
10935 (setq result (make-js2-object-prop-node
10939 :op-pos (js2-current-token-len)))
10940 (js2-node-add-children result prop)
10941 (js2-node-set-prop result 'SHORTHAND t)
10945 (if (= tt js2-COLON)
10946 (setq colon (- (js2-current-token-beg) pos)
10947 expr (js2-parse-assign-expr))
10948 (js2-report-error "msg.no.colon.prop")
10949 (setq expr (make-js2-error-node)))
10950 (setq result (make-js2-object-prop-node
10952 ;; don't include last consumed token in length
10953 :len (- (+ (js2-node-pos expr)
10954 (js2-node-len expr))
10959 (js2-node-add-children result prop expr)
10962 (defun js2-parse-method-prop (pos prop type-string)
10963 "Parse method property in an object literal or a class body.
10964 JavaScript syntax is:
10966 { foo(...) {...}, get foo() {...}, set foo(x) {...}, *foo(...) {...},
10967 async foo(...) {...} }
10969 and expression closure style is also supported
10971 { get foo() x, set foo(x) _x = x }
10973 POS is the start position of the `get' or `set' keyword.
10974 PROP is the `js2-name-node' representing the property name.
10975 TYPE-STRING is a string `get', `set', `*', or nil, indicating a found keyword."
10976 (let* ((type (or (cdr (assoc type-string '(("get" . GET)
10978 ("async" . ASYNC))))
10981 (fn (js2-parse-function-expr (eq type 'ASYNC))))
10982 ;; it has to be an anonymous function, as we already parsed the name
10983 (if (/= (js2-node-type fn) js2-FUNCTION)
10984 (js2-report-error "msg.bad.prop")
10985 (if (cl-plusp (length (js2-function-name fn)))
10986 (js2-report-error "msg.bad.prop")))
10987 (js2-node-set-prop fn 'METHOD_TYPE type) ; for codegen
10988 (when (string= type-string "*")
10989 (setf (js2-function-node-generator-type fn) 'STAR))
10990 (unless pos (setq pos (js2-node-pos prop)))
10991 (setq end (js2-node-end fn)
10992 result (make-js2-method-node :pos pos
10996 (js2-node-add-children result prop fn)
10999 (defun js2-create-name-node (&optional check-activation-p token string)
11000 "Create a name node using the current token and, optionally, STRING.
11001 And, if CHECK-ACTIVATION-P is non-nil, use the value of TOKEN."
11002 (let* ((beg (js2-current-token-beg))
11003 (tt (js2-current-token-type))
11005 (if (= js2-NAME tt)
11006 (js2-current-token-string)
11007 (js2-tt-name tt))))
11009 (setq name (make-js2-name-node :pos beg
11012 (if check-activation-p
11013 (js2-check-activation-name s (or token js2-NAME)))
11016 ;;; Use AST to extract semantic information
11018 (defun js2-get-element-index-from-array-node (elem array-node &optional hardcoded-array-index)
11019 "Get index of ELEM from ARRAY-NODE or 0 and return it as string."
11020 (let ((idx 0) elems (rlt hardcoded-array-index))
11021 (setq elems (js2-array-node-elems array-node))
11022 (if (and elem (not hardcoded-array-index))
11023 (setq rlt (catch 'nth-elt
11025 ;; We know the ELEM does belong to ARRAY-NODE,
11026 (if (eq elem x) (throw 'nth-elt idx))
11027 (setq idx (1+ idx)))
11029 (format "[%s]" rlt)))
11031 (defun js2-print-json-path (&optional hardcoded-array-index)
11032 "Print the path to the JSON value under point, and save it in the kill ring.
11033 If HARDCODED-ARRAY-INDEX provided, array index in JSON path is replaced with it."
11035 (let (previous-node current-node
11039 ;; The `js2-node-at-point' starts scanning from AST root node.
11040 ;; So there is no way to optimize it.
11041 (setq current-node (js2-node-at-point))
11043 (while (not (js2-ast-root-p current-node))
11045 ;; JSON property node
11046 ((js2-object-prop-node-p current-node)
11047 (setq key-name (js2-prop-node-name (js2-object-prop-node-left current-node)))
11048 (if rlt (setq rlt (concat "." key-name rlt))
11049 (setq rlt (concat "." key-name))))
11052 ((or (js2-array-node-p current-node))
11053 (setq rlt (concat (js2-get-element-index-from-array-node previous-node
11055 hardcoded-array-index)
11058 ;; Other nodes are ignored
11061 ;; current node is archived
11062 (setq previous-node current-node)
11063 ;; Get parent node and continue the loop
11064 (setq current-node (js2-node-parent current-node)))
11068 ;; Clean the final result
11069 (setq rlt (replace-regexp-in-string "^\\." "" rlt))
11071 (message "%s => kill-ring" rlt))
11073 (message "No JSON path found!")))
11077 ;;; Indentation support (bouncing)
11079 ;; In recent-enough Emacs, we reuse the indentation code from
11080 ;; `js-mode'. To continue support for the older versions, some code
11081 ;; that was here previously was moved to `js2-old-indent.el'.
11083 ;; Whichever indenter is used, it's often "wrong", however, and needs
11084 ;; to be overridden. The right long-term solution is probably to
11085 ;; emulate (or integrate with) cc-engine, but it's a nontrivial amount
11086 ;; of coding. Even when a parse tree from `js2-parse' is present,
11087 ;; which is not true at the moment the user is typing, computing
11088 ;; indentation is still thousands of lines of code to handle every
11089 ;; possible syntactic edge case.
11091 ;; In the meantime, the compromise solution is that we offer a "bounce
11092 ;; indenter", configured with `js2-bounce-indent-p', which cycles the
11093 ;; current line indent among various likely guess points. This approach
11094 ;; is far from perfect, but should at least make it slightly easier to
11095 ;; move the line towards its desired indentation when manually
11096 ;; overriding Karl's heuristic nesting guesser.
11098 (defun js2-backward-sws ()
11099 "Move backward through whitespace and comments."
11101 (while (forward-comment -1)))
11103 (defun js2-forward-sws ()
11104 "Move forward through whitespace and comments."
11106 (while (forward-comment 1)))
11108 (defun js2-arglist-close ()
11109 "Return non-nil if we're on a line beginning with a close-paren/brace."
11111 (goto-char (point-at-bol))
11113 (looking-at "[])}]")))
11115 (defun js2-indent-looks-like-label-p ()
11116 (goto-char (point-at-bol))
11118 (looking-at (concat js2-mode-identifier-re ":")))
11120 (defun js2-indent-in-objlit-p (parse-status)
11121 "Return non-nil if this looks like an object-literal entry."
11122 (let ((start (nth 1 parse-status)))
11126 (and (zerop (forward-line -1))
11127 (not (< (point) start)) ; crossed a {} boundary
11128 (js2-indent-looks-like-label-p)))
11130 (js2-indent-looks-like-label-p)))))
11132 ;; If prev line looks like foobar({ then we're passing an object
11133 ;; literal to a function call, and people pretty much always want to
11134 ;; de-dent back to the previous line, so move the 'basic-offset'
11135 ;; position to the front.
11136 (defun js2-indent-objlit-arg-p (parse-status)
11138 (back-to-indentation)
11140 (and (eq (1- (point)) (nth 1 parse-status))
11141 (eq (char-before) ?{)
11144 (skip-chars-backward " \t")
11145 (eq (char-before) ?\()))))
11147 (defun js2-indent-case-block-p ()
11149 (back-to-indentation)
11151 (goto-char (point-at-bol))
11152 (skip-chars-forward " \t")
11153 (looking-at "case\\s-.+:")))
11155 (defun js2-bounce-indent (normal-col parse-status &optional backward)
11156 "Cycle among alternate computed indentation positions.
11157 PARSE-STATUS is the result of `parse-partial-sexp' from the beginning
11158 of the buffer to the current point. NORMAL-COL is the indentation
11159 column computed by the heuristic guesser based on current paren,
11160 bracket, brace and statement nesting. If BACKWARDS, cycle positions
11162 (let ((cur-indent (current-indentation))
11163 (old-buffer-undo-list buffer-undo-list)
11164 ;; Emacs 21 only has `count-lines', not `line-number-at-pos'
11165 (current-line (save-excursion
11166 (forward-line 0) ; move to bol
11167 (1+ (count-lines (point-min) (point)))))
11168 positions pos main-pos anchor arglist-cont same-indent
11169 basic-offset computed-pos)
11170 ;; temporarily don't record undo info, if user requested this
11171 (when js2-mode-indent-inhibit-undo
11172 (setq buffer-undo-list t))
11175 ;; First likely point: indent from beginning of previous code line
11176 (push (setq basic-offset
11178 (back-to-indentation)
11180 (back-to-indentation)
11185 ;; (First + epsilon) likely point: indent 2x from beginning of
11186 ;; previous code line. Google does it this way.
11187 (push (setq basic-offset
11189 (back-to-indentation)
11191 (back-to-indentation)
11193 (* 2 js2-basic-offset)))
11196 ;; Second likely point: indent from assign-expr RHS. This
11197 ;; is just a crude guess based on finding " = " on the previous
11198 ;; line containing actual code.
11199 (setq pos (save-excursion
11201 (goto-char (point-at-bol))
11202 (when (re-search-forward "\\s-+\\(=\\)\\s-+"
11204 (goto-char (match-end 1))
11205 (skip-chars-forward " \t\r\n")
11206 (current-column))))
11208 (cl-incf pos js2-basic-offset)
11209 (push pos positions))
11211 ;; Third likely point: same indent as previous line of code.
11212 ;; Make it the first likely point if we're not on an
11213 ;; arglist-close line and previous line ends in a comma, or
11214 ;; both this line and prev line look like object-literal
11216 (setq pos (save-excursion
11217 (goto-char (point-at-bol))
11219 (back-to-indentation)
11222 ;; while we're here, look for trailing comma
11223 (if (save-excursion
11224 (goto-char (point-at-eol))
11226 (eq (char-before) ?,))
11227 (setq arglist-cont (1- (point)))))))
11229 (if (and (or arglist-cont
11230 (js2-indent-in-objlit-p parse-status))
11231 (not (js2-arglist-close)))
11232 (setq same-indent pos))
11233 (push pos positions))
11235 ;; Fourth likely point: first preceding code with less indentation.
11236 ;; than the immediately preceding code line.
11237 (setq pos (save-excursion
11238 (back-to-indentation)
11240 (back-to-indentation)
11241 (setq anchor (current-column))
11242 (while (and (zerop (forward-line -1))
11244 (back-to-indentation)
11247 (setq pos (current-column))))
11248 (push pos positions)
11250 ;; nesting-heuristic position, main by default
11251 (push (setq main-pos normal-col) positions)
11253 ;; delete duplicates and sort positions list
11254 (setq positions (sort (delete-dups positions) '<))
11256 ;; comma-list continuation lines: prev line indent takes precedence
11258 (setq main-pos same-indent))
11260 ;; common special cases where we want to indent in from previous line
11261 (if (or (js2-indent-case-block-p)
11262 (js2-indent-objlit-arg-p parse-status))
11263 (setq main-pos basic-offset))
11265 ;; if bouncing backward, reverse positions list
11267 (setq positions (reverse positions)))
11269 ;; record whether we're already sitting on one of the alternatives
11270 (setq pos (member cur-indent positions))
11273 ;; case 0: we're one one of the alternatives and this is the
11274 ;; first time they've pressed TAB on this line (best-guess).
11275 ((and js2-mode-indent-ignore-first-tab
11277 ;; first time pressing TAB on this line?
11278 (not (eq js2-mode-last-indented-line current-line)))
11280 (setq computed-pos nil))
11281 ;; case 1: only one computed position => use it
11282 ((null (cdr positions))
11283 (setq computed-pos 0))
11284 ;; case 2: not on any of the computed spots => use main spot
11286 (setq computed-pos (js2-position main-pos positions)))
11287 ;; case 3: on last position: cycle to first position
11289 (setq computed-pos 0))
11290 ;; case 4: on intermediate position: cycle to next position
11292 (setq computed-pos (js2-position (cl-second pos) positions))))
11294 ;; see if any hooks want to indent; otherwise we do it
11295 (cl-loop with result = nil
11296 for hook in js2-indent-hook
11297 while (null result)
11299 (setq result (funcall hook positions computed-pos))
11301 (unless (or result (null computed-pos))
11302 (indent-line-to (nth computed-pos positions)))))
11305 (if js2-mode-indent-inhibit-undo
11306 (setq buffer-undo-list old-buffer-undo-list))
11307 ;; see commentary for `js2-mode-last-indented-line'
11308 (setq js2-mode-last-indented-line current-line))))
11310 (defun js2-1-line-comment-continuation-p ()
11311 "Return t if we're in a 1-line comment continuation.
11312 If so, we don't ever want to use bounce-indent."
11316 (looking-at "\\s-*//"))
11320 (when (looking-at "\\s-*$")
11323 (looking-at "\\s-*//")))))
11325 (defun js2-indent-bounce (&optional backward)
11326 "Indent the current line, bouncing between several positions."
11328 (let (parse-status offset indent-col
11329 ;; Don't whine about errors/warnings when we're indenting.
11330 ;; This has to be set before calling parse-partial-sexp below.
11331 (inhibit-point-motion-hooks t))
11332 (setq parse-status (save-excursion
11333 (syntax-ppss (point-at-bol)))
11334 offset (- (point) (save-excursion
11335 (back-to-indentation)
11337 ;; Don't touch multiline strings.
11338 (unless (nth 3 parse-status)
11339 (setq indent-col (js2-proper-indentation parse-status))
11341 ;; It doesn't work well on first line of buffer.
11342 ((and (not (nth 4 parse-status))
11343 (not (js2-same-line (point-min)))
11344 (not (js2-1-line-comment-continuation-p)))
11345 (js2-bounce-indent indent-col parse-status backward))
11346 ;; just indent to the guesser's likely spot
11347 (t (indent-line-to indent-col)))
11348 (when (cl-plusp offset)
11349 (forward-char offset)))))
11351 (defun js2-indent-bounce-backward ()
11352 "Indent the current line, bouncing between positions in reverse."
11354 (js2-indent-bounce t))
11356 (defun js2-indent-region (start end)
11357 "Indent the region, but don't use bounce indenting."
11358 (let ((js2-bounce-indent-p nil)
11359 (indent-region-function nil)
11360 (after-change-functions (remq 'js2-mode-edit
11361 after-change-functions)))
11362 (indent-region start end nil) ; nil for byte-compiler
11363 (js2-mode-edit start end (- end start))))
11365 (defvar js2-minor-mode-map
11366 (let ((map (make-sparse-keymap)))
11367 (define-key map (kbd "C-c C-`") #'js2-next-error)
11368 (define-key map [mouse-1] #'js2-mode-show-node)
11370 "Keymap used when `js2-minor-mode' is active.")
11373 (define-minor-mode js2-minor-mode
11374 "Minor mode for running js2 as a background linter.
11375 This allows you to use a different major mode for JavaScript editing,
11376 such as `js-mode', while retaining the asynchronous error/warning
11377 highlighting features of `js2-mode'."
11379 :lighter " js-lint"
11380 (if (derived-mode-p 'js2-mode)
11381 (setq js2-minor-mode nil)
11383 (js2-minor-mode-enter)
11384 (js2-minor-mode-exit))))
11386 (defun js2-minor-mode-enter ()
11387 "Initialization for `js2-minor-mode'."
11388 (set (make-local-variable 'max-lisp-eval-depth)
11389 (max max-lisp-eval-depth 3000))
11390 (setq next-error-function #'js2-next-error)
11391 (js2-set-default-externs)
11392 ;; Experiment: make reparse-delay longer for longer files.
11393 (if (cl-plusp js2-dynamic-idle-timer-adjust)
11394 (setq js2-idle-timer-delay
11395 (* js2-idle-timer-delay
11396 (/ (point-max) js2-dynamic-idle-timer-adjust))))
11397 (setq js2-mode-buffer-dirty-p t
11398 js2-mode-parsing nil)
11399 (set (make-local-variable 'js2-highlight-level) 0) ; no syntax highlighting
11400 (add-hook 'after-change-functions #'js2-minor-mode-edit nil t)
11401 (add-hook 'change-major-mode-hook #'js2-minor-mode-exit nil t)
11402 (when js2-include-jslint-globals
11403 (add-hook 'js2-post-parse-callbacks 'js2-apply-jslint-globals nil t))
11404 (run-hooks 'js2-init-hook)
11407 (defun js2-minor-mode-exit ()
11408 "Turn off `js2-minor-mode'."
11409 (setq next-error-function nil)
11410 (remove-hook 'after-change-functions #'js2-mode-edit t)
11411 (remove-hook 'change-major-mode-hook #'js2-minor-mode-exit t)
11412 (when js2-mode-node-overlay
11413 (delete-overlay js2-mode-node-overlay)
11414 (setq js2-mode-node-overlay nil))
11415 (js2-remove-overlays)
11416 (remove-hook 'js2-post-parse-callbacks 'js2-apply-jslint-globals t)
11417 (setq js2-mode-ast nil))
11419 (defvar js2-source-buffer nil "Linked source buffer for diagnostics view")
11420 (make-variable-buffer-local 'js2-source-buffer)
11422 (cl-defun js2-display-error-list ()
11423 "Display a navigable buffer listing parse errors/warnings."
11425 (unless (js2-have-errors-p)
11426 (message "No errors")
11427 (cl-return-from js2-display-error-list))
11428 (cl-labels ((annotate-list
11430 "Add diagnostic TYPE and line number to errs list"
11431 (mapcar (lambda (err)
11432 (list err type (line-number-at-pos (nth 1 err))))
11434 (let* ((srcbuf (current-buffer))
11435 (errbuf (get-buffer-create "*js-lint*"))
11436 (errors (annotate-list
11437 (when js2-mode-ast (js2-ast-root-errors js2-mode-ast))
11438 'js2-error)) ; must be a valid face name
11439 (warnings (annotate-list
11440 (when js2-mode-ast (js2-ast-root-warnings js2-mode-ast))
11441 'js2-warning)) ; must be a valid face name
11442 (all-errs (sort (append errors warnings)
11443 (lambda (e1 e2) (< (cl-cadar e1) (cl-cadar e2))))))
11444 (with-current-buffer errbuf
11445 (let ((inhibit-read-only t))
11447 (dolist (err all-errs)
11448 (cl-destructuring-bind ((msg-key beg _end &rest) type line) err
11449 (insert-text-button
11450 (format "line %d: %s" line (js2-get-msg msg-key))
11452 'follow-link "\C-m"
11453 'action 'js2-error-buffer-jump
11454 'js2-msg (js2-get-msg msg-key)
11457 (js2-error-buffer-mode)
11458 (setq js2-source-buffer srcbuf)
11459 (pop-to-buffer errbuf)
11460 (goto-char (point-min))
11462 (js2-error-buffer-view))))))
11464 (defvar js2-error-buffer-mode-map
11465 (let ((map (make-sparse-keymap)))
11466 (define-key map "n" #'js2-error-buffer-next)
11467 (define-key map "p" #'js2-error-buffer-prev)
11468 (define-key map (kbd "RET") #'js2-error-buffer-jump)
11469 (define-key map "o" #'js2-error-buffer-view)
11470 (define-key map "q" #'js2-error-buffer-quit)
11472 "Keymap used for js2 diagnostics buffers.")
11474 (defun js2-error-buffer-mode ()
11475 "Major mode for js2 diagnostics buffers.
11476 Selecting an error will jump it to the corresponding source-buffer error.
11477 \\{js2-error-buffer-mode-map}"
11479 (setq major-mode 'js2-error-buffer-mode
11480 mode-name "JS Lint Diagnostics")
11481 (use-local-map js2-error-buffer-mode-map)
11482 (setq truncate-lines t)
11483 (set-buffer-modified-p nil)
11484 (setq buffer-read-only t)
11485 (run-hooks 'js2-error-buffer-mode-hook))
11487 (defun js2-error-buffer-next ()
11488 "Move to next error and view it."
11490 (when (zerop (forward-line 1))
11491 (js2-error-buffer-view)))
11493 (defun js2-error-buffer-prev ()
11494 "Move to previous error and view it."
11496 (when (zerop (forward-line -1))
11497 (js2-error-buffer-view)))
11499 (defun js2-error-buffer-quit ()
11500 "Kill the current buffer."
11504 (defun js2-error-buffer-jump (&rest ignored)
11505 "Jump cursor to current error in source buffer."
11507 (when (js2-error-buffer-view)
11508 (pop-to-buffer js2-source-buffer)))
11510 (defun js2-error-buffer-view ()
11511 "Scroll source buffer to show error at current line."
11514 ((not (eq major-mode 'js2-error-buffer-mode))
11515 (message "Not in a js2 errors buffer"))
11516 ((not (buffer-live-p js2-source-buffer))
11517 (message "Source buffer has been killed"))
11518 ((not (wholenump (get-text-property (point) 'js2-pos)))
11519 (message "There does not seem to be an error here"))
11521 (let ((pos (get-text-property (point) 'js2-pos))
11522 (msg (get-text-property (point) 'js2-msg)))
11523 (save-selected-window
11524 (pop-to-buffer js2-source-buffer)
11529 (define-derived-mode js2-mode js-mode "Javascript-IDE"
11530 "Major mode for editing JavaScript code."
11531 (set (make-local-variable 'max-lisp-eval-depth)
11532 (max max-lisp-eval-depth 3000))
11533 (set (make-local-variable 'indent-line-function) #'js2-indent-line)
11534 (set (make-local-variable 'indent-region-function) #'js2-indent-region)
11535 (set (make-local-variable 'syntax-propertize-function) nil)
11536 (set (make-local-variable 'comment-line-break-function) #'js2-line-break)
11537 (set (make-local-variable 'beginning-of-defun-function) #'js2-beginning-of-defun)
11538 (set (make-local-variable 'end-of-defun-function) #'js2-end-of-defun)
11539 ;; We un-confuse `parse-partial-sexp' by setting syntax-table properties
11540 ;; for characters inside regexp literals.
11541 (set (make-local-variable 'parse-sexp-lookup-properties) t)
11542 ;; this is necessary to make `show-paren-function' work properly
11543 (set (make-local-variable 'parse-sexp-ignore-comments) t)
11544 ;; needed for M-x rgrep, among other things
11545 (put 'js2-mode 'find-tag-default-function #'js2-mode-find-tag)
11547 (setq font-lock-defaults '(nil t))
11549 ;; Experiment: make reparse-delay longer for longer files.
11550 (when (cl-plusp js2-dynamic-idle-timer-adjust)
11551 (setq js2-idle-timer-delay
11552 (* js2-idle-timer-delay
11553 (/ (point-max) js2-dynamic-idle-timer-adjust))))
11555 (add-hook 'change-major-mode-hook #'js2-mode-exit nil t)
11556 (add-hook 'after-change-functions #'js2-mode-edit nil t)
11557 (setq imenu-create-index-function #'js2-mode-create-imenu-index)
11558 (setq next-error-function #'js2-next-error)
11559 (imenu-add-to-menubar (concat "IM-" mode-name))
11560 (add-to-invisibility-spec '(js2-outline . t))
11561 (set (make-local-variable 'line-move-ignore-invisible) t)
11562 (set (make-local-variable 'forward-sexp-function) #'js2-mode-forward-sexp)
11563 (when (fboundp 'cursor-sensor-mode) (cursor-sensor-mode 1))
11565 (setq js2-mode-functions-hidden nil
11566 js2-mode-comments-hidden nil
11567 js2-mode-buffer-dirty-p t
11568 js2-mode-parsing nil)
11570 (js2-set-default-externs)
11572 (when js2-include-jslint-globals
11573 (add-hook 'js2-post-parse-callbacks 'js2-apply-jslint-globals nil t))
11575 (run-hooks 'js2-init-hook)
11579 ;; We may eventually want js2-jsx-mode to derive from js-jsx-mode, but that'd be
11580 ;; a bit more complicated and it doesn't net us much yet.
11582 (define-derived-mode js2-jsx-mode js2-mode "JSX-IDE"
11583 "Major mode for editing JSX code.
11585 To customize the indentation for this mode, set the SGML offset
11586 variables (`sgml-basic-offset' et al) locally, like so:
11588 (defun set-jsx-indentation ()
11589 (setq-local sgml-basic-offset js2-basic-offset))
11590 (add-hook 'js2-jsx-mode-hook #'set-jsx-indentation)"
11591 (set (make-local-variable 'indent-line-function) #'js2-jsx-indent-line))
11593 (defun js2-mode-exit ()
11594 "Exit `js2-mode' and clean up."
11596 (when js2-mode-node-overlay
11597 (delete-overlay js2-mode-node-overlay)
11598 (setq js2-mode-node-overlay nil))
11599 (js2-remove-overlays)
11600 (setq js2-mode-ast nil)
11601 (remove-hook 'change-major-mode-hook #'js2-mode-exit t)
11602 (remove-from-invisibility-spec '(js2-outline . t))
11603 (js2-mode-show-all)
11604 (with-silent-modifications
11605 (js2-clear-face (point-min) (point-max))))
11607 (defun js2-mode-reset-timer ()
11608 "Cancel any existing parse timer and schedule a new one."
11609 (if js2-mode-parse-timer
11610 (cancel-timer js2-mode-parse-timer))
11611 (setq js2-mode-parsing nil)
11612 (let ((timer (timer-create)))
11613 (setq js2-mode-parse-timer timer)
11614 (timer-set-function timer 'js2-mode-idle-reparse (list (current-buffer)))
11615 (timer-set-idle-time timer js2-idle-timer-delay)
11616 ;; http://debbugs.gnu.org/cgi/bugreport.cgi?bug=12326
11617 (timer-activate-when-idle timer nil)))
11619 (defun js2-mode-idle-reparse (buffer)
11620 "Run `js2-reparse' if BUFFER is the current buffer, or schedule
11621 it to be reparsed when the buffer is selected."
11622 (cond ((eq buffer (current-buffer))
11624 ((buffer-live-p buffer)
11625 ;; reparse when the buffer is selected again
11626 (with-current-buffer buffer
11627 (add-hook 'window-configuration-change-hook
11628 #'js2-mode-idle-reparse-inner
11631 (defun js2-mode-idle-reparse-inner ()
11632 (remove-hook 'window-configuration-change-hook
11633 #'js2-mode-idle-reparse-inner
11637 (defun js2-mode-edit (_beg _end _len)
11638 "Schedule a new parse after buffer is edited.
11639 Buffer edit spans from BEG to END and is of length LEN."
11640 (setq js2-mode-buffer-dirty-p t)
11641 (js2-mode-hide-overlay)
11642 (js2-mode-reset-timer))
11644 (defun js2-minor-mode-edit (_beg _end _len)
11645 "Callback for buffer edits in `js2-mode'.
11646 Schedules a new parse after buffer is edited.
11647 Buffer edit spans from BEG to END and is of length LEN."
11648 (setq js2-mode-buffer-dirty-p t)
11649 (js2-mode-hide-overlay)
11650 (js2-mode-reset-timer))
11652 (defun js2-reparse (&optional force)
11653 "Re-parse current buffer after user finishes some data entry.
11654 If we get any user input while parsing, including cursor motion,
11655 we discard the parse and reschedule it. If FORCE is nil, then the
11656 buffer will only rebuild its `js2-mode-ast' if the buffer is dirty."
11659 (js2-compiler-strict-mode js2-mode-show-strict-warnings))
11660 (unless js2-mode-parsing
11661 (setq js2-mode-parsing t)
11663 (when (or js2-mode-buffer-dirty-p force)
11664 (js2-remove-overlays)
11665 (setq js2-mode-buffer-dirty-p nil
11666 js2-mode-fontifications nil
11667 js2-mode-deferred-properties nil)
11668 (if js2-mode-verbose-parse-p
11669 (message "parsing..."))
11672 (setq interrupted-p
11673 (catch 'interrupted
11675 (with-silent-modifications
11676 ;; if parsing is interrupted, comments and regex
11677 ;; literals stay ignored by `parse-partial-sexp'
11678 (remove-text-properties (point-min) (point-max)
11680 (js2-mode-apply-deferred-properties)
11681 (js2-mode-remove-suppressed-warnings)
11682 (js2-mode-show-warnings)
11683 (js2-mode-show-errors)
11684 (if (>= js2-highlight-level 1)
11685 (js2-highlight-jsdoc js2-mode-ast)))
11689 ;; unfinished parse => try again
11690 (setq js2-mode-buffer-dirty-p t)
11691 (js2-mode-reset-timer))
11692 (if js2-mode-verbose-parse-p
11693 (message "Parse time: %s" time))))
11694 (setq js2-mode-parsing nil)
11695 (unless interrupted-p
11696 (setq js2-mode-parse-timer nil))))))
11698 (defun js2-mode-show-node (event)
11699 "Debugging aid: highlight selected AST node on mouse click."
11701 (mouse-set-point event)
11702 (setq deactivate-mark t)
11703 (when js2-mode-show-overlay
11704 (let ((node (js2-node-at-point))
11707 (message "No node found at location %s" (point))
11708 (setq beg (js2-node-abs-pos node)
11709 end (+ beg (js2-node-len node)))
11710 (if js2-mode-node-overlay
11711 (move-overlay js2-mode-node-overlay beg end)
11712 (setq js2-mode-node-overlay (make-overlay beg end))
11713 (overlay-put js2-mode-node-overlay 'font-lock-face 'highlight))
11714 (with-silent-modifications
11715 (if (fboundp 'cursor-sensor-mode)
11716 (put-text-property beg end 'cursor-sensor-functions
11717 '(js2-mode-hide-overlay))
11718 (put-text-property beg end 'point-left #'js2-mode-hide-overlay)))
11719 (message "%s, parent: %s"
11720 (js2-node-short-name node)
11721 (if (js2-node-parent node)
11722 (js2-node-short-name (js2-node-parent node))
11725 (defun js2-mode-hide-overlay (&optional arg1 arg2 _arg3)
11726 "Remove the debugging overlay when point moves.
11727 ARG1, ARG2 and ARG3 have different values depending on whether this function
11728 was found on `point-left' or in `cursor-sensor-functions'."
11729 (when js2-mode-node-overlay
11730 (let ((beg (overlay-start js2-mode-node-overlay))
11731 (end (overlay-end js2-mode-node-overlay))
11732 (p2 (if (windowp arg1)
11733 ;; Called from cursor-sensor-functions.
11734 (window-point arg1)
11735 ;; Called from point-left.
11737 ;; Sometimes we're called spuriously.
11741 (with-silent-modifications
11742 (remove-text-properties beg end
11743 '(point-left nil cursor-sensor-functions)))
11744 (delete-overlay js2-mode-node-overlay)
11745 (setq js2-mode-node-overlay nil)))))
11747 (defun js2-mode-reset ()
11748 "Debugging helper: reset everything."
11753 (defun js2-mode-show-warn-or-err (e face)
11754 "Highlight a warning or error E with FACE.
11755 E is a list of ((MSG-KEY MSG-ARG) BEG LEN OVERRIDE-FACE).
11756 The last element is optional. When present, use instead of FACE."
11757 (let* ((key (cl-first e))
11758 (beg (cl-second e))
11759 (end (+ beg (cl-third e)))
11760 ;; Don't inadvertently go out of bounds.
11761 (beg (max (point-min) (min beg (point-max))))
11762 (end (max (point-min) (min end (point-max))))
11763 (ovl (make-overlay beg end)))
11764 ;; FIXME: Why a mix of overlays and text-properties?
11765 (overlay-put ovl 'font-lock-face (or (cl-fourth e) face))
11766 (overlay-put ovl 'js2-error t)
11767 (put-text-property beg end 'help-echo (js2-get-msg key))
11768 (if (fboundp 'cursor-sensor-mode)
11769 (put-text-property beg end 'cursor-sensor-functions '(js2-echo-error))
11770 (put-text-property beg end 'point-entered #'js2-echo-error))))
11772 (defun js2-remove-overlays ()
11773 "Remove overlays from buffer that have a `js2-error' property."
11774 (let ((beg (point-min))
11777 (dolist (o (overlays-in beg end))
11778 (when (overlay-get o 'js2-error)
11779 (delete-overlay o))))))
11781 (defun js2-mode-apply-deferred-properties ()
11782 "Apply fontifications and other text properties recorded during parsing."
11783 (when (cl-plusp js2-highlight-level)
11784 ;; We defer clearing faces as long as possible to eliminate flashing.
11785 (js2-clear-face (point-min) (point-max))
11786 ;; Have to reverse the recorded fontifications list so that errors
11787 ;; and warnings overwrite the normal fontifications.
11788 (dolist (f (nreverse js2-mode-fontifications))
11789 (put-text-property (cl-first f) (cl-second f) 'font-lock-face (cl-third f)))
11790 (setq js2-mode-fontifications nil))
11791 (dolist (p js2-mode-deferred-properties)
11792 (apply #'put-text-property p))
11793 (setq js2-mode-deferred-properties nil))
11795 (defun js2-mode-show-errors ()
11796 "Highlight syntax errors."
11797 (when js2-mode-show-parse-errors
11798 (dolist (e (js2-ast-root-errors js2-mode-ast))
11799 (js2-mode-show-warn-or-err e 'js2-error))))
11801 (defun js2-mode-remove-suppressed-warnings ()
11802 "Take suppressed warnings out of the AST warnings list.
11803 This ensures that the counts and `next-error' are correct."
11804 (setf (js2-ast-root-warnings js2-mode-ast)
11807 (let ((key (caar e)))
11809 (and (not js2-strict-trailing-comma-warning)
11810 (string-match "trailing\\.comma" key))
11811 (and (not js2-strict-cond-assign-warning)
11812 (string= key "msg.equal.as.assign"))
11813 (and js2-missing-semi-one-line-override
11814 (string= key "msg.missing.semi")
11815 (let* ((beg (cl-second e))
11816 (node (js2-node-at-point beg))
11817 (fn (js2-mode-find-parent-fn node))
11818 (body (and fn (js2-function-node-body fn)))
11819 (lc (and body (js2-node-abs-pos body)))
11820 (rc (and lc (+ lc (js2-node-len body)))))
11825 (and (js2-same-line lc)
11826 (js2-same-line rc))))))))))
11827 (js2-ast-root-warnings js2-mode-ast))))
11829 (defun js2-mode-show-warnings ()
11830 "Highlight strict-mode warnings."
11831 (when js2-mode-show-strict-warnings
11832 (dolist (e (js2-ast-root-warnings js2-mode-ast))
11833 (js2-mode-show-warn-or-err e 'js2-warning))))
11835 (defun js2-echo-error (arg1 arg2 &optional _arg3)
11836 "Called by point-motion hooks.
11837 ARG1, ARG2 and ARG3 have different values depending on whether this function
11838 was found on `point-entered' or in `cursor-sensor-functions'."
11839 (let* ((new-point (if (windowp arg1)
11840 ;; Called from cursor-sensor-functions.
11841 (window-point arg1)
11842 ;; Called from point-left.
11844 (msg (get-text-property new-point 'help-echo)))
11845 (when (and (stringp msg)
11846 (not (active-minibuffer-window))
11847 (not (current-message)))
11850 (defun js2-line-break (&optional _soft)
11851 "Break line at point and indent, continuing comment if within one.
11852 If inside a string, and `js2-concat-multiline-strings' is not
11853 nil, turn it into concatenation."
11855 (let ((parse-status (syntax-ppss)))
11857 ;; Check if we're inside a string.
11858 ((nth 3 parse-status)
11859 (if js2-concat-multiline-strings
11860 (js2-mode-split-string parse-status)
11862 ;; Check if inside a block comment.
11863 ((nth 4 parse-status)
11864 (js2-mode-extend-comment (nth 8 parse-status)))
11866 (newline-and-indent)))))
11868 (defun js2-mode-split-string (parse-status)
11869 "Turn a newline in mid-string into a string concatenation.
11870 PARSE-STATUS is as documented in `parse-partial-sexp'."
11871 (let* ((quote-char (nth 3 parse-status))
11872 (at-eol (eq js2-concat-multiline-strings 'eol)))
11873 (insert quote-char)
11874 (insert (if at-eol " +\n" "\n"))
11878 (insert quote-char)
11880 (insert quote-char)
11881 (backward-char 1))))
11883 (defun js2-mode-extend-comment (start-pos)
11884 "Indent the line and, when inside a comment block, add comment prefix."
11885 (let (star single col first-line needs-close)
11887 (back-to-indentation)
11888 (when (< (point) start-pos)
11889 (goto-char start-pos))
11891 ((looking-at "\\*[^/]")
11893 col (current-column)))
11894 ((looking-at "/\\*")
11897 col (1+ (current-column))))
11900 col (current-column)))))
11901 ;; Heuristic for whether we need to close the comment:
11902 ;; if we've got a parse error here, assume it's an unterminated
11906 (get-char-property (1- (point)) 'js2-error)
11907 ;; The heuristic above doesn't work well when we're
11908 ;; creating a comment and there's another one downstream,
11909 ;; as our parser thinks this one ends at the end of the
11910 ;; next one. (You can have a /* inside a js block comment.)
11911 ;; So just close it if the next non-ws char isn't a *.
11915 (skip-chars-forward " \t\r\n")
11916 (not (eq (char-after) ?*))))))
11917 (delete-horizontal-space)
11923 (if (and first-line needs-close)
11931 ;; Don't need to extend the comment after all.
11932 (js2-indent-line)))
11934 (defun js2-beginning-of-line ()
11935 "Toggle point between bol and first non-whitespace char in line.
11936 Also moves past comment delimiters when inside comments."
11941 (back-to-indentation))
11943 (skip-chars-forward "/ \t"))
11944 ((and (eq (char-after) ?*)
11945 (setq node (js2-comment-at-point))
11946 (memq (js2-comment-node-format node) '(jsdoc block))
11948 (skip-chars-backward " \t")
11950 (skip-chars-forward "\* \t"))
11952 (goto-char (point-at-bol))))))
11954 (defun js2-end-of-line ()
11955 "Toggle point between eol and last non-whitespace char in line."
11958 (skip-chars-backward " \t")
11959 (goto-char (point-at-eol))))
11961 (defun js2-mode-wait-for-parse (callback)
11962 "Invoke CALLBACK when parsing is finished.
11963 If parsing is already finished, calls CALLBACK immediately."
11964 (if (not js2-mode-buffer-dirty-p)
11966 (push callback js2-mode-pending-parse-callbacks)
11967 (add-hook 'js2-parse-finished-hook #'js2-mode-parse-finished)))
11969 (defun js2-mode-parse-finished ()
11970 "Invoke callbacks in `js2-mode-pending-parse-callbacks'."
11971 ;; We can't let errors propagate up, since it prevents the
11972 ;; `js2-parse' method from completing normally and returning
11973 ;; the ast, which makes things mysteriously not work right.
11975 (dolist (cb js2-mode-pending-parse-callbacks)
11976 (condition-case err
11978 (error (message "%s" err))))
11979 (setq js2-mode-pending-parse-callbacks nil)))
11981 (defun js2-mode-flag-region (from to flag)
11982 "Hide or show text from FROM to TO, according to FLAG.
11983 If FLAG is nil then text is shown, while if FLAG is t the text is hidden.
11984 Returns the created overlay if FLAG is non-nil."
11985 (remove-overlays from to 'invisible 'js2-outline)
11987 (let ((o (make-overlay from to)))
11988 (overlay-put o 'invisible 'js2-outline)
11989 (overlay-put o 'isearch-open-invisible
11990 'js2-isearch-open-invisible)
11993 ;; Function to be set as an outline-isearch-open-invisible' property
11994 ;; to the overlay that makes the outline invisible (see
11995 ;; `js2-mode-flag-region').
11996 (defun js2-isearch-open-invisible (_overlay)
11997 ;; We rely on the fact that isearch places point on the matched text.
11998 (js2-mode-show-element))
12000 (defun js2-mode-invisible-overlay-bounds (&optional pos)
12001 "Return cons cell of bounds of folding overlay at POS.
12002 Returns nil if not found."
12003 (let ((overlays (overlays-at (or pos (point))))
12005 (while (and overlays
12007 (if (overlay-get (car overlays) 'invisible)
12008 (setq o (car overlays))
12009 (setq overlays (cdr overlays))))
12011 (cons (overlay-start o) (overlay-end o)))))
12013 (defun js2-mode-function-at-point (&optional pos)
12014 "Return the innermost function node enclosing current point.
12015 Returns nil if point is not in a function."
12016 (let ((node (js2-node-at-point pos)))
12017 (while (and node (not (js2-function-node-p node)))
12018 (setq node (js2-node-parent node)))
12019 (if (js2-function-node-p node)
12022 (defun js2-mode-toggle-element ()
12023 "Hide or show the foldable element at the point."
12025 (let (comment fn pos)
12028 ;; /* ... */ comment?
12029 ((js2-block-comment-p (setq comment (js2-comment-at-point)))
12030 (if (js2-mode-invisible-overlay-bounds
12031 (setq pos (+ 3 (js2-node-abs-pos comment))))
12034 (js2-mode-show-element))
12035 (js2-mode-hide-element)))
12038 (back-to-indentation)
12039 (looking-at js2-mode-//-comment-re))
12040 (js2-mode-toggle-//-comment))
12042 ((setq fn (js2-mode-function-at-point))
12043 (setq pos (and (js2-function-node-body fn)
12044 (js2-node-abs-pos (js2-function-node-body fn))))
12045 (goto-char (1+ pos))
12046 (if (js2-mode-invisible-overlay-bounds)
12047 (js2-mode-show-element)
12048 (js2-mode-hide-element)))
12050 (message "Nothing at point to hide or show"))))))
12052 (defun js2-mode-hide-element ()
12053 "Fold/hide contents of a block, showing ellipses.
12054 Show the hidden text with \\[js2-mode-show-element]."
12056 (if js2-mode-buffer-dirty-p
12057 (js2-mode-wait-for-parse #'js2-mode-hide-element))
12058 (let (node body beg end)
12060 ((js2-mode-invisible-overlay-bounds)
12061 (message "already hidden"))
12063 (setq node (js2-node-at-point))
12065 ((js2-block-comment-p node)
12066 (js2-mode-hide-comment node))
12068 (while (and node (not (js2-function-node-p node)))
12069 (setq node (js2-node-parent node)))
12071 (setq body (js2-function-node-body node)))
12073 (setq beg (js2-node-abs-pos body)
12074 end (+ beg (js2-node-len body)))
12075 (js2-mode-flag-region (1+ beg) (1- end) 'hide))
12076 (message "No collapsable element found at point"))))))))
12078 (defun js2-mode-show-element ()
12079 "Show the hidden element at current point."
12081 (let ((bounds (js2-mode-invisible-overlay-bounds)))
12083 (js2-mode-flag-region (car bounds) (cdr bounds) nil)
12084 (message "Nothing to un-hide"))))
12086 (defun js2-mode-show-all ()
12087 "Show all of the text in the buffer."
12089 (js2-mode-flag-region (point-min) (point-max) nil))
12091 (defun js2-mode-toggle-hide-functions ()
12093 (if js2-mode-functions-hidden
12094 (js2-mode-show-functions)
12095 (js2-mode-hide-functions)))
12097 (defun js2-mode-hide-functions ()
12098 "Hides all non-nested function bodies in the buffer.
12099 Use \\[js2-mode-show-all] to reveal them, or \\[js2-mode-show-element]
12100 to open an individual entry."
12102 (if js2-mode-buffer-dirty-p
12103 (js2-mode-wait-for-parse #'js2-mode-hide-functions))
12104 (if (null js2-mode-ast)
12105 (message "Oops - parsing failed")
12106 (setq js2-mode-functions-hidden t)
12107 (js2-visit-ast js2-mode-ast #'js2-mode-function-hider)))
12109 (defun js2-mode-function-hider (n endp)
12111 (let ((tt (js2-node-type n))
12114 ((and (= tt js2-FUNCTION)
12115 (setq body (js2-function-node-body n)))
12116 (setq beg (js2-node-abs-pos body)
12117 end (+ beg (js2-node-len body)))
12118 (js2-mode-flag-region (1+ beg) (1- end) 'hide)
12119 nil) ; don't process children of function
12121 t))))) ; keep processing other AST nodes
12123 (defun js2-mode-show-functions ()
12124 "Un-hide any folded function bodies in the buffer."
12126 (setq js2-mode-functions-hidden nil)
12128 (goto-char (point-min))
12129 (while (/= (goto-char (next-overlay-change (point)))
12131 (dolist (o (overlays-at (point)))
12132 (when (and (overlay-get o 'invisible)
12133 (not (overlay-get o 'comment)))
12134 (js2-mode-flag-region (overlay-start o) (overlay-end o) nil))))))
12136 (defun js2-mode-hide-comment (n)
12137 (let* ((head (if (eq (js2-comment-node-format n) 'jsdoc)
12140 (beg (+ (js2-node-abs-pos n) head))
12141 (end (- (+ beg (js2-node-len n)) head 2))
12142 (o (js2-mode-flag-region beg end 'hide)))
12143 (overlay-put o 'comment t)))
12145 (defun js2-mode-toggle-hide-comments ()
12146 "Folds all block comments in the buffer.
12147 Use \\[js2-mode-show-all] to reveal them, or \\[js2-mode-show-element]
12148 to open an individual entry."
12150 (if js2-mode-comments-hidden
12151 (js2-mode-show-comments)
12152 (js2-mode-hide-comments)))
12154 (defun js2-mode-hide-comments ()
12156 (if js2-mode-buffer-dirty-p
12157 (js2-mode-wait-for-parse #'js2-mode-hide-comments))
12158 (if (null js2-mode-ast)
12159 (message "Oops - parsing failed")
12160 (setq js2-mode-comments-hidden t)
12161 (dolist (n (js2-ast-root-comments js2-mode-ast))
12162 (when (js2-block-comment-p n)
12163 (js2-mode-hide-comment n)))
12164 (js2-mode-hide-//-comments)))
12166 (defun js2-mode-extend-//-comment (direction)
12167 "Find start or end of a block of similar //-comment lines.
12168 DIRECTION is -1 to look back, 1 to look forward.
12169 INDENT is the indentation level to match.
12170 Returns the end-of-line position of the furthest adjacent
12171 //-comment line with the same indentation as the current line.
12172 If there is no such matching line, returns current end of line."
12173 (let ((pos (point-at-eol))
12174 (indent (current-indentation)))
12176 (while (and (zerop (forward-line direction))
12177 (looking-at js2-mode-//-comment-re)
12178 (eq indent (length (match-string 1))))
12179 (setq pos (point-at-eol)))
12182 (defun js2-mode-hide-//-comments ()
12183 "Fold adjacent 1-line comments, showing only snippet of first one."
12186 (goto-char (point-min))
12187 (while (re-search-forward js2-mode-//-comment-re nil t)
12189 end (js2-mode-extend-//-comment 1))
12190 (unless (eq beg end)
12191 (overlay-put (js2-mode-flag-region beg end 'hide)
12194 (forward-char 1)))))
12196 (defun js2-mode-toggle-//-comment ()
12197 "Fold or un-fold any multi-line //-comment at point.
12198 Caller should have determined that this line starts with a //-comment."
12199 (let* ((beg (point-at-eol))
12203 (if (js2-mode-invisible-overlay-bounds)
12204 (js2-mode-show-element)
12205 ;; else hide the comment
12206 (setq beg (js2-mode-extend-//-comment -1)
12207 end (js2-mode-extend-//-comment 1))
12208 (unless (eq beg end)
12209 (overlay-put (js2-mode-flag-region beg end 'hide)
12212 (defun js2-mode-show-comments ()
12213 "Un-hide any hidden comments, leaving other hidden elements alone."
12215 (setq js2-mode-comments-hidden nil)
12217 (goto-char (point-min))
12218 (while (/= (goto-char (next-overlay-change (point)))
12220 (dolist (o (overlays-at (point)))
12221 (when (overlay-get o 'comment)
12222 (js2-mode-flag-region (overlay-start o) (overlay-end o) nil))))))
12224 (defun js2-mode-display-warnings-and-errors ()
12225 "Turn on display of warnings and errors."
12227 (setq js2-mode-show-parse-errors t
12228 js2-mode-show-strict-warnings t)
12229 (js2-reparse 'force))
12231 (defun js2-mode-hide-warnings-and-errors ()
12232 "Turn off display of warnings and errors."
12234 (setq js2-mode-show-parse-errors nil
12235 js2-mode-show-strict-warnings nil)
12236 (js2-reparse 'force))
12238 (defun js2-mode-toggle-warnings-and-errors ()
12239 "Toggle the display of warnings and errors.
12240 Some users don't like having warnings/errors reported while they type."
12242 (setq js2-mode-show-parse-errors (not js2-mode-show-parse-errors)
12243 js2-mode-show-strict-warnings (not js2-mode-show-strict-warnings))
12244 (if (called-interactively-p 'any)
12245 (message "warnings and errors %s"
12246 (if js2-mode-show-parse-errors
12249 (js2-reparse 'force))
12251 (defun js2-mode-customize ()
12253 (customize-group 'js2-mode))
12255 (defun js2-mode-forward-sexp (&optional arg)
12256 "Move forward across one statement or balanced expression.
12257 With ARG, do it that many times. Negative arg -N means
12258 move backward across N balanced expressions."
12260 (setq arg (or arg 1))
12262 (widen) ;; `blink-matching-open' calls `narrow-to-region'
12264 (let (forward-sexp-function
12265 node (start (point)) pos lp rp child)
12268 ;; could probably make this better for some cases:
12269 ;; - if in statement block (e.g. function body), go to parent
12270 ;; - infix exprs like (foo in bar) - maybe go to beginning
12271 ;; of infix expr if in the right-side expression?
12272 ((and arg (cl-minusp arg))
12273 (dotimes (_ (- arg))
12275 (forward-char -1) ; Enter the node we backed up to.
12276 (when (setq node (js2-node-at-point (point) t))
12277 (setq pos (js2-node-abs-pos node))
12278 (let ((parens (js2-mode-forward-sexp-parens node pos)))
12279 (setq lp (car parens)
12281 (when (and lp (> start lp))
12282 (if (and rp (<= start rp))
12283 ;; Between parens, check if there's a child node we can jump.
12284 (when (setq child (js2-node-closest-child node (point) lp t))
12285 (setq pos (js2-node-abs-pos child)))
12286 ;; Before both parens.
12288 (let ((state (parse-partial-sexp start pos)))
12289 (goto-char (if (not (zerop (car state)))
12290 ;; Stumble at the unbalanced paren if < 0, or
12291 ;; jump a bit further if > 0.
12292 (scan-sexps start -1)
12294 (unless pos (goto-char (point-min)))))
12299 (when (setq node (js2-node-at-point (point) t))
12300 (setq pos (js2-node-abs-pos node))
12301 (let ((parens (js2-mode-forward-sexp-parens node pos)))
12302 (setq lp (car parens)
12305 (when (and rp (<= start rp))
12307 (when (setq child (js2-node-closest-child node (point) rp))
12308 (setq pos (js2-node-abs-end child)))
12309 (setq pos (1+ rp))))
12310 ;; No parens or child nodes, looks for the end of the current node.
12311 (cl-incf pos (js2-node-len
12312 (if (js2-expr-stmt-node-p (js2-node-parent node))
12313 ;; Stop after the semicolon.
12314 (js2-node-parent node)
12316 (let ((state (save-excursion (parse-partial-sexp start pos))))
12317 (goto-char (if (not (zerop (car state)))
12318 (scan-sexps start 1)
12320 (unless pos (goto-char (point-max)))))))))
12322 (defun js2-mode-forward-sexp-parens (node abs-pos)
12323 "Return a cons cell with positions of main parens in NODE."
12325 ((or (js2-array-node-p node)
12326 (js2-object-node-p node)
12327 (js2-comp-node-p node)
12328 (memq (aref node 0) '(cl-struct-js2-block-node cl-struct-js2-scope)))
12329 (cons abs-pos (+ abs-pos (js2-node-len node) -1)))
12330 ((js2-paren-expr-node-p node)
12331 (let ((lp (js2-node-lp node))
12332 (rp (js2-node-rp node)))
12333 (cons (when lp (+ abs-pos lp))
12334 (when rp (+ abs-pos rp)))))))
12336 (defun js2-node-closest-child (parent point limit &optional before)
12337 (let* ((parent-pos (js2-node-abs-pos parent))
12338 (rpoint (- point parent-pos))
12339 (rlimit (- limit parent-pos))
12340 (min (min rpoint rlimit))
12341 (max (max rpoint rlimit))
12346 (lambda (node _end-p)
12347 (if (eq node parent)
12349 (let ((pos (js2-node-pos node)) ;; Both relative values.
12350 (end (+ (js2-node-pos node) (js2-node-len node))))
12351 (when (and (>= pos min) (<= end max)
12352 (if before (< pos rpoint) (> end rpoint)))
12354 (when (> end rpoint)
12355 (throw 'done nil)))
12359 (defun js2-errors ()
12360 "Return a list of errors found."
12362 (js2-ast-root-errors js2-mode-ast)))
12364 (defun js2-warnings ()
12365 "Return a list of warnings found."
12367 (js2-ast-root-warnings js2-mode-ast)))
12369 (defun js2-have-errors-p ()
12370 "Return non-nil if any parse errors or warnings were found."
12371 (or (js2-errors) (js2-warnings)))
12373 (defun js2-errors-and-warnings ()
12374 "Return a copy of the concatenated errors and warnings lists.
12375 They are appended: first the errors, then the warnings.
12376 Entries are of the form (MSG BEG END)."
12378 (append (js2-ast-root-errors js2-mode-ast)
12379 (copy-sequence (js2-ast-root-warnings js2-mode-ast)))))
12381 (defun js2-next-error (&optional arg reset)
12382 "Move to next parse error.
12383 Typically invoked via \\[next-error].
12384 ARG is the number of errors, forward or backward, to move.
12385 RESET means start over from the beginning."
12387 (if (not (or (js2-errors) (js2-warnings)))
12388 (message "No errors")
12390 (goto-char (point-min)))
12391 (let* ((errs (js2-errors-and-warnings))
12395 (backward (cl-minusp count))
12396 (sorter (if backward '> '<))
12397 (stopper (if backward '< '>))
12398 (count (abs count))
12400 ;; Sort by start position.
12401 (setq errs (sort errs (lambda (e1 e2)
12402 (funcall sorter (cl-second e1) (cl-second e2))))
12404 ;; Find nth error with pos > start.
12405 (while (and errs continue)
12406 (when (funcall stopper (cl-cadar errs) start)
12407 (setq err (car errs))
12408 (if (zerop (cl-decf count))
12409 (setq continue nil)))
12410 (setq errs (cdr errs)))
12411 ;; Clear for `js2-echo-error'.
12414 (goto-char (cl-second err))
12415 ;; Wrap around to first error.
12416 (goto-char (cl-second (car all-errs)))
12417 ;; If we were already on it, echo msg again.
12418 (if (= (point) start)
12419 (js2-echo-error (point) (point)))))))
12421 (defun js2-down-mouse-3 ()
12422 "Make right-click move the point to the click location.
12423 This makes right-click context menu operations a bit more intuitive.
12424 The point will not move if the region is active, however, to avoid
12425 destroying the region selection."
12427 (when (and js2-move-point-on-right-click
12429 (let ((e last-input-event))
12431 (goto-char (cl-cadadr e))))))
12433 (defun js2-mode-create-imenu-index ()
12434 "Return an alist for `imenu--index-alist'."
12435 ;; This is built up in `js2-parse-record-imenu' during parsing.
12437 ;; if we have an ast but no recorder, they're requesting a rescan
12438 (unless js2-imenu-recorder
12439 (js2-reparse 'force))
12441 (js2-build-imenu-index)
12442 (setq js2-imenu-recorder nil
12443 js2-imenu-function-map nil))))
12445 (defun js2-mode-find-tag ()
12446 "Replacement for `find-tag-default'.
12447 `find-tag-default' returns a ridiculous answer inside comments."
12450 (if (looking-at "\\_>")
12451 (setq beg (progn (forward-symbol -1) (point))
12452 end (progn (forward-symbol 1) (point)))
12453 (setq beg (progn (forward-symbol 1) (point))
12454 end (progn (forward-symbol -1) (point))))
12455 (replace-regexp-in-string
12457 (buffer-substring-no-properties beg end)))))
12459 (defun js2-mode-forward-sibling ()
12460 "Move to the end of the sibling following point in parent.
12461 Returns non-nil if successful, or nil if there was no following sibling."
12462 (let* ((node (js2-node-at-point))
12463 (parent (js2-mode-find-enclosing-fn node))
12465 (when (setq sib (js2-node-find-child-after (point) parent))
12466 (goto-char (+ (js2-node-abs-pos sib)
12467 (js2-node-len sib))))))
12469 (defun js2-mode-backward-sibling ()
12470 "Move to the beginning of the sibling node preceding point in parent.
12471 Parent is defined as the enclosing script or function."
12472 (let* ((node (js2-node-at-point))
12473 (parent (js2-mode-find-enclosing-fn node))
12475 (when (setq sib (js2-node-find-child-before (point) parent))
12476 (goto-char (js2-node-abs-pos sib)))))
12478 (defun js2-beginning-of-defun (&optional arg)
12479 "Go to line on which current function starts, and return t on success.
12480 If we're not in a function or already at the beginning of one, go
12481 to beginning of previous script-level element.
12482 With ARG N, do that N times. If N is negative, move forward."
12483 (setq arg (or arg 1))
12485 (let ((parent (js2-node-parent-script-or-fn (js2-node-at-point))))
12487 ((js2-function-node-p parent)
12488 (goto-char (js2-node-abs-pos parent)))
12490 (js2-mode-backward-sibling)))
12492 (js2-beginning-of-defun (1- arg))
12494 (when (js2-end-of-defun)
12495 (js2-beginning-of-defun (if (>= arg -1) 1 (1+ arg))))))
12497 (defun js2-end-of-defun ()
12498 "Go to the char after the last position of the current function
12499 or script-level element."
12500 (let* ((node (js2-node-at-point))
12501 (parent (or (and (js2-function-node-p node) node)
12502 (js2-node-parent-script-or-fn node)))
12504 (unless (js2-function-node-p parent)
12505 ;; Use current script-level node, or, if none, the next one.
12506 (setq script (or parent node)
12507 parent (js2-node-find-child-before (point) script))
12508 (when (or (null parent)
12509 (>= (point) (+ (js2-node-abs-pos parent)
12510 (js2-node-len parent))))
12511 (setq parent (js2-node-find-child-after (point) script))))
12513 (goto-char (+ (js2-node-abs-pos parent)
12514 (js2-node-len parent))))))
12516 (defun js2-mark-defun (&optional allow-extend)
12517 "Put mark at end of this function, point at beginning.
12518 The function marked is the one that contains point.
12520 Interactively, if this command is repeated,
12521 or (in Transient Mark mode) if the mark is active,
12522 it marks the next defun after the ones already marked."
12525 (when (and allow-extend
12526 (or (and (eq last-command this-command) (mark t))
12527 (and transient-mark-mode mark-active)))
12528 (let ((sib (save-excursion
12530 (if (js2-mode-forward-sibling)
12536 ;; no more siblings - try extending to enclosing node
12537 (goto-char (mark t)))))
12538 (when (not extended)
12539 (let ((node (js2-node-at-point (point) t)) ; skip comments
12540 ast fn stmt parent beg end)
12541 (when (js2-ast-root-p node)
12543 node (or (js2-node-find-child-after (point) node)
12544 (js2-node-find-child-before (point) node))))
12545 ;; only mark whole buffer if we can't find any children
12548 (if (js2-function-node-p node)
12550 (setq fn (js2-mode-find-enclosing-fn node)
12551 stmt (if (or (null fn)
12552 (js2-ast-root-p fn))
12553 (js2-mode-find-first-stmt node))
12554 parent (or stmt fn)))
12555 (setq beg (js2-node-abs-pos parent)
12556 end (+ beg (js2-node-len parent)))
12559 (exchange-point-and-mark)))))
12561 (defun js2-narrow-to-defun ()
12562 "Narrow to the function enclosing point."
12564 (let* ((node (js2-node-at-point (point) t)) ; skip comments
12565 (fn (if (js2-script-node-p node)
12567 (js2-mode-find-enclosing-fn node)))
12568 (beg (js2-node-abs-pos fn)))
12569 (unless (js2-ast-root-p fn)
12570 (narrow-to-region beg (+ beg (js2-node-len fn))))))
12572 (defun js2-jump-to-definition (&optional arg)
12573 "Jump to the definition of an object's property, variable or function."
12575 (ring-insert find-tag-marker-ring (point-marker))
12576 (let* ((node (js2-node-at-point))
12577 (parent (js2-node-parent node))
12578 (names (if (js2-prop-get-node-p parent)
12579 (reverse (let ((temp (js2-compute-nested-prop-get parent)))
12580 (cl-loop for n in temp
12583 until (equal node n)
12584 finally return result)))))
12586 (unless (and (js2-name-node-p node)
12587 (not (js2-var-init-node-p parent))
12588 (not (js2-function-node-p parent)))
12589 (error "Node is not a supported jump node"))
12590 (push (or (and names (pop names))
12591 (unless (and (js2-object-prop-node-p parent)
12592 (eq node (js2-object-prop-node-left parent)))
12594 (setq node-init (js2-search-scope node names))
12596 ;; todo: display list of results in buffer
12597 ;; todo: group found references by buffer
12603 (with-current-buffer b
12604 (when (derived-mode-p 'js2-mode)
12605 (setq node-init (js2-search-scope js2-mode-ast names))
12607 (throw 'found b)))))
12610 (setq node-init (if (listp node-init) (car node-init) node-init))
12613 (error "No jump location found"))
12614 (goto-char (js2-node-abs-pos node-init))))
12616 (defun js2-search-object (node name-node)
12617 "Check if object NODE contains element with NAME-NODE."
12618 (cl-assert (js2-object-node-p node))
12619 ;; Only support name-node and nodes for the time being
12620 (cl-loop for elem in (js2-object-node-elems node)
12621 for left = (js2-object-prop-node-left elem)
12622 if (or (and (js2-name-node-p left)
12623 (equal (js2-name-node-name name-node)
12624 (js2-name-node-name left)))
12625 (and (js2-string-node-p left)
12626 (string= (js2-name-node-name name-node)
12627 (js2-string-node-value left))))
12630 (defun js2-search-object-for-prop (object prop-names)
12631 "Return node in OBJECT that matches PROP-NAMES or nil.
12632 PROP-NAMES is a list of values representing a path to a value in OBJECT.
12633 i.e. ('name' 'value') = {name : { value: 3}}"
12635 (temp-object object)
12636 (temp t) ;temporay node
12637 (names prop-names))
12638 (while (and temp names (js2-object-node-p temp-object))
12639 (setq temp (js2-search-object temp-object (pop names)))
12640 (and (setq node temp)
12641 (setq temp-object (js2-object-prop-node-right temp))))
12642 (unless names node)))
12644 (defun js2-search-scope (node names)
12645 "Searches NODE scope for jump location matching NAMES.
12646 NAMES is a list of property values to search for. For functions
12647 and variables NAMES will contain one element."
12649 (val (js2-name-node-name (car names))))
12650 (setq node-init (js2-get-symbol-declaration node val))
12652 (when (> (length names) 1)
12654 ;; Check var declarations
12655 (when (and node-init (string= val (js2-name-node-name node-init)))
12656 (let ((parent (js2-node-parent node-init))
12657 (temp-names names))
12658 (pop temp-names) ;; First element is var name
12659 (setq node-init (when (js2-var-init-node-p parent)
12660 (js2-search-object-for-prop
12661 (js2-var-init-node-initializer parent)
12664 ;; Check all assign nodes
12667 (lambda (node endp)
12669 (if (js2-assign-node-p node)
12670 (let ((left (js2-assign-node-left node))
12671 (right (js2-assign-node-right node))
12672 (temp-names names))
12673 (when (js2-prop-get-node-p left)
12674 (let* ((prop-list (js2-compute-nested-prop-get left))
12675 (found (cl-loop for prop in prop-list
12676 until (not (string= (js2-name-node-name
12678 (js2-name-node-name prop)))
12679 if (not temp-names) return prop))
12680 (found-node (or found
12681 (when (js2-object-node-p right)
12682 (js2-search-object-for-prop right
12684 (if found-node (push found-node node-init))))))
12688 (defun js2-get-symbol-declaration (node name)
12689 "Find scope for NAME from NODE."
12690 (let ((scope (js2-get-defining-scope
12691 (or (js2-node-get-enclosing-scope node)
12693 (if scope (js2-symbol-ast-node (js2-scope-get-symbol scope name)))))
12695 (provide 'js2-mode)
12697 ;;; js2-mode.el ends here