]> code.delx.au - gnu-emacs/blob - lisp/progmodes/js.el
Merge from origin/emacs-25
[gnu-emacs] / lisp / progmodes / js.el
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
2
3 ;; Copyright (C) 2008-2016 Free Software Foundation, Inc.
4
5 ;; Author: Karl Landstrom <karl.landstrom@brgeight.se>
6 ;; Daniel Colascione <dan.colascione@gmail.com>
7 ;; Maintainer: Daniel Colascione <dan.colascione@gmail.com>
8 ;; Version: 9
9 ;; Date: 2009-07-25
10 ;; Keywords: languages, javascript
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26
27 ;;; Commentary
28
29 ;; This is based on Karl Landstrom's barebones javascript-mode. This
30 ;; is much more robust and works with cc-mode's comment filling
31 ;; (mostly).
32 ;;
33 ;; The main features of this JavaScript mode are syntactic
34 ;; highlighting (enabled with `font-lock-mode' or
35 ;; `global-font-lock-mode'), automatic indentation and filling of
36 ;; comments, C preprocessor fontification, and MozRepl integration.
37 ;;
38 ;; General Remarks:
39 ;;
40 ;; XXX: This mode assumes that block comments are not nested inside block
41 ;; XXX: comments
42 ;;
43 ;; Exported names start with "js-"; private names start with
44 ;; "js--".
45
46 ;;; Code:
47
48
49 (require 'cc-mode)
50 (require 'newcomment)
51 (require 'thingatpt) ; forward-symbol etc
52 (require 'imenu)
53 (require 'moz nil t)
54 (require 'json nil t)
55 (require 'sgml-mode)
56
57 (eval-when-compile
58 (require 'cl-lib)
59 (require 'ido))
60
61 (defvar inferior-moz-buffer)
62 (defvar moz-repl-name)
63 (defvar ido-cur-list)
64 (defvar electric-layout-rules)
65 (declare-function ido-mode "ido")
66 (declare-function inferior-moz-process "ext:mozrepl" ())
67
68 ;;; Constants
69
70 (defconst js--name-start-re "[a-zA-Z_$]"
71 "Regexp matching the start of a JavaScript identifier, without grouping.")
72
73 (defconst js--stmt-delim-chars "^;{}?:")
74
75 (defconst js--name-re (concat js--name-start-re
76 "\\(?:\\s_\\|\\sw\\)*")
77 "Regexp matching a JavaScript identifier, without grouping.")
78
79 (defconst js--objfield-re (concat js--name-re ":")
80 "Regexp matching the start of a JavaScript object field.")
81
82 (defconst js--dotted-name-re
83 (concat js--name-re "\\(?:\\." js--name-re "\\)*")
84 "Regexp matching a dot-separated sequence of JavaScript names.")
85
86 (defconst js--cpp-name-re js--name-re
87 "Regexp matching a C preprocessor name.")
88
89 (defconst js--opt-cpp-start "^\\s-*#\\s-*\\([[:alnum:]]+\\)"
90 "Regexp matching the prefix of a cpp directive.
91 This includes the directive name, or nil in languages without
92 preprocessor support. The first submatch surrounds the directive
93 name.")
94
95 (defconst js--plain-method-re
96 (concat "^\\s-*?\\(" js--dotted-name-re "\\)\\.prototype"
97 "\\.\\(" js--name-re "\\)\\s-*?=\\s-*?\\(function\\)\\_>")
98 "Regexp matching an explicit JavaScript prototype \"method\" declaration.
99 Group 1 is a (possibly-dotted) class name, group 2 is a method name,
100 and group 3 is the `function' keyword.")
101
102 (defconst js--plain-class-re
103 (concat "^\\s-*\\(" js--dotted-name-re "\\)\\.prototype"
104 "\\s-*=\\s-*{")
105 "Regexp matching a JavaScript explicit prototype \"class\" declaration.
106 An example of this is \"Class.prototype = { method1: ...}\".")
107
108 ;; var NewClass = BaseClass.extend(
109 (defconst js--mp-class-decl-re
110 (concat "^\\s-*var\\s-+"
111 "\\(" js--name-re "\\)"
112 "\\s-*=\\s-*"
113 "\\(" js--dotted-name-re
114 "\\)\\.extend\\(?:Final\\)?\\s-*(\\s-*{?\\s-*$"))
115
116 ;; var NewClass = Class.create()
117 (defconst js--prototype-obsolete-class-decl-re
118 (concat "^\\s-*\\(?:var\\s-+\\)?"
119 "\\(" js--dotted-name-re "\\)"
120 "\\s-*=\\s-*Class\\.create()"))
121
122 (defconst js--prototype-objextend-class-decl-re-1
123 (concat "^\\s-*Object\\.extend\\s-*("
124 "\\(" js--dotted-name-re "\\)"
125 "\\s-*,\\s-*{"))
126
127 (defconst js--prototype-objextend-class-decl-re-2
128 (concat "^\\s-*\\(?:var\\s-+\\)?"
129 "\\(" js--dotted-name-re "\\)"
130 "\\s-*=\\s-*Object\\.extend\\s-*("))
131
132 ;; var NewClass = Class.create({
133 (defconst js--prototype-class-decl-re
134 (concat "^\\s-*\\(?:var\\s-+\\)?"
135 "\\(" js--name-re "\\)"
136 "\\s-*=\\s-*Class\\.create\\s-*(\\s-*"
137 "\\(?:\\(" js--dotted-name-re "\\)\\s-*,\\s-*\\)?{?"))
138
139 ;; Parent class name(s) (yes, multiple inheritance in JavaScript) are
140 ;; matched with dedicated font-lock matchers
141 (defconst js--dojo-class-decl-re
142 (concat "^\\s-*dojo\\.declare\\s-*(\"\\(" js--dotted-name-re "\\)"))
143
144 (defconst js--extjs-class-decl-re-1
145 (concat "^\\s-*Ext\\.extend\\s-*("
146 "\\s-*\\(" js--dotted-name-re "\\)"
147 "\\s-*,\\s-*\\(" js--dotted-name-re "\\)")
148 "Regexp matching an ExtJS class declaration (style 1).")
149
150 (defconst js--extjs-class-decl-re-2
151 (concat "^\\s-*\\(?:var\\s-+\\)?"
152 "\\(" js--name-re "\\)"
153 "\\s-*=\\s-*Ext\\.extend\\s-*(\\s-*"
154 "\\(" js--dotted-name-re "\\)")
155 "Regexp matching an ExtJS class declaration (style 2).")
156
157 (defconst js--mochikit-class-re
158 (concat "^\\s-*MochiKit\\.Base\\.update\\s-*(\\s-*"
159 "\\(" js--dotted-name-re "\\)")
160 "Regexp matching a MochiKit class declaration.")
161
162 (defconst js--dummy-class-style
163 '(:name "[Automatically Generated Class]"))
164
165 (defconst js--class-styles
166 `((:name "Plain"
167 :class-decl ,js--plain-class-re
168 :prototype t
169 :contexts (toplevel)
170 :framework javascript)
171
172 (:name "MochiKit"
173 :class-decl ,js--mochikit-class-re
174 :prototype t
175 :contexts (toplevel)
176 :framework mochikit)
177
178 (:name "Prototype (Obsolete)"
179 :class-decl ,js--prototype-obsolete-class-decl-re
180 :contexts (toplevel)
181 :framework prototype)
182
183 (:name "Prototype (Modern)"
184 :class-decl ,js--prototype-class-decl-re
185 :contexts (toplevel)
186 :framework prototype)
187
188 (:name "Prototype (Object.extend)"
189 :class-decl ,js--prototype-objextend-class-decl-re-1
190 :prototype t
191 :contexts (toplevel)
192 :framework prototype)
193
194 (:name "Prototype (Object.extend) 2"
195 :class-decl ,js--prototype-objextend-class-decl-re-2
196 :prototype t
197 :contexts (toplevel)
198 :framework prototype)
199
200 (:name "Dojo"
201 :class-decl ,js--dojo-class-decl-re
202 :contexts (toplevel)
203 :framework dojo)
204
205 (:name "ExtJS (style 1)"
206 :class-decl ,js--extjs-class-decl-re-1
207 :prototype t
208 :contexts (toplevel)
209 :framework extjs)
210
211 (:name "ExtJS (style 2)"
212 :class-decl ,js--extjs-class-decl-re-2
213 :contexts (toplevel)
214 :framework extjs)
215
216 (:name "Merrill Press"
217 :class-decl ,js--mp-class-decl-re
218 :contexts (toplevel)
219 :framework merrillpress))
220
221 "List of JavaScript class definition styles.
222
223 A class definition style is a plist with the following keys:
224
225 :name is a human-readable name of the class type
226
227 :class-decl is a regular expression giving the start of the
228 class. Its first group must match the name of its class. If there
229 is a parent class, the second group should match, and it should be
230 the name of the class.
231
232 If :prototype is present and non-nil, the parser will merge
233 declarations for this constructs with others at the same lexical
234 level that have the same name. Otherwise, multiple definitions
235 will create multiple top-level entries. Don't use :prototype
236 unnecessarily: it has an associated cost in performance.
237
238 If :strip-prototype is present and non-nil, then if the class
239 name as matched contains
240 ")
241
242 (defconst js--available-frameworks
243 (cl-loop for style in js--class-styles
244 for framework = (plist-get style :framework)
245 unless (memq framework available-frameworks)
246 collect framework into available-frameworks
247 finally return available-frameworks)
248 "List of available JavaScript frameworks symbols.")
249
250 (defconst js--function-heading-1-re
251 (concat
252 "^\\s-*function\\(?:\\s-\\|\\*\\)+\\(" js--name-re "\\)")
253 "Regexp matching the start of a JavaScript function header.
254 Match group 1 is the name of the function.")
255
256 (defconst js--function-heading-2-re
257 (concat
258 "^\\s-*\\(" js--name-re "\\)\\s-*:\\s-*function\\_>")
259 "Regexp matching the start of a function entry in an associative array.
260 Match group 1 is the name of the function.")
261
262 (defconst js--function-heading-3-re
263 (concat
264 "^\\s-*\\(?:var\\s-+\\)?\\(" js--dotted-name-re "\\)"
265 "\\s-*=\\s-*function\\_>")
266 "Regexp matching a line in the JavaScript form \"var MUMBLE = function\".
267 Match group 1 is MUMBLE.")
268
269 (defconst js--macro-decl-re
270 (concat "^\\s-*#\\s-*define\\s-+\\(" js--cpp-name-re "\\)\\s-*(")
271 "Regexp matching a CPP macro definition, up to the opening parenthesis.
272 Match group 1 is the name of the macro.")
273
274 (defun js--regexp-opt-symbol (list)
275 "Like `regexp-opt', but surround the result with `\\\\_<' and `\\\\_>'."
276 (concat "\\_<" (regexp-opt list t) "\\_>"))
277
278 (defconst js--keyword-re
279 (js--regexp-opt-symbol
280 '("abstract" "break" "case" "catch" "class" "const"
281 "continue" "debugger" "default" "delete" "do" "else"
282 "enum" "export" "extends" "final" "finally" "for"
283 "function" "goto" "if" "implements" "import" "in"
284 "instanceof" "interface" "native" "new" "package"
285 "private" "protected" "public" "return" "static"
286 "super" "switch" "synchronized" "throw"
287 "throws" "transient" "try" "typeof" "var" "void" "let"
288 "yield" "volatile" "while" "with"))
289 "Regexp matching any JavaScript keyword.")
290
291 (defconst js--basic-type-re
292 (js--regexp-opt-symbol
293 '("boolean" "byte" "char" "double" "float" "int" "long"
294 "short" "void"))
295 "Regular expression matching any predefined type in JavaScript.")
296
297 (defconst js--constant-re
298 (js--regexp-opt-symbol '("false" "null" "undefined"
299 "Infinity" "NaN"
300 "true" "arguments" "this"))
301 "Regular expression matching any future reserved words in JavaScript.")
302
303
304 (defconst js--font-lock-keywords-1
305 (list
306 "\\_<import\\_>"
307 (list js--function-heading-1-re 1 font-lock-function-name-face)
308 (list js--function-heading-2-re 1 font-lock-function-name-face))
309 "Level one font lock keywords for `js-mode'.")
310
311 (defconst js--font-lock-keywords-2
312 (append js--font-lock-keywords-1
313 (list (list js--keyword-re 1 font-lock-keyword-face)
314 (list "\\_<for\\_>"
315 "\\s-+\\(each\\)\\_>" nil nil
316 (list 1 'font-lock-keyword-face))
317 (cons js--basic-type-re font-lock-type-face)
318 (cons js--constant-re font-lock-constant-face)))
319 "Level two font lock keywords for `js-mode'.")
320
321 ;; js--pitem is the basic building block of the lexical
322 ;; database. When one refers to a real part of the buffer, the region
323 ;; of text to which it refers is split into a conceptual header and
324 ;; body. Consider the (very short) block described by a hypothetical
325 ;; js--pitem:
326 ;;
327 ;; function foo(a,b,c) { return 42; }
328 ;; ^ ^ ^
329 ;; | | |
330 ;; +- h-begin +- h-end +- b-end
331 ;;
332 ;; (Remember that these are buffer positions, and therefore point
333 ;; between characters, not at them. An arrow drawn to a character
334 ;; indicates the corresponding position is between that character and
335 ;; the one immediately preceding it.)
336 ;;
337 ;; The header is the region of text [h-begin, h-end], and is
338 ;; the text needed to unambiguously recognize the start of the
339 ;; construct. If the entire header is not present, the construct is
340 ;; not recognized at all. No other pitems may be nested inside the
341 ;; header.
342 ;;
343 ;; The body is the region [h-end, b-end]. It may contain nested
344 ;; js--pitem instances. The body of a pitem may be empty: in
345 ;; that case, b-end is equal to header-end.
346 ;;
347 ;; The three points obey the following relationship:
348 ;;
349 ;; h-begin < h-end <= b-end
350 ;;
351 ;; We put a text property in the buffer on the character *before*
352 ;; h-end, and if we see it, on the character *before* b-end.
353 ;;
354 ;; The text property for h-end, js--pstate, is actually a list
355 ;; of all js--pitem instances open after the marked character.
356 ;;
357 ;; The text property for b-end, js--pend, is simply the
358 ;; js--pitem that ends after the marked character. (Because
359 ;; pitems always end when the paren-depth drops below a critical
360 ;; value, and because we can only drop one level per character, only
361 ;; one pitem may end at a given character.)
362 ;;
363 ;; In the structure below, we only store h-begin and (sometimes)
364 ;; b-end. We can trivially and quickly find h-end by going to h-begin
365 ;; and searching for an js--pstate text property. Since no other
366 ;; js--pitem instances can be nested inside the header of a
367 ;; pitem, the location after the character with this text property
368 ;; must be h-end.
369 ;;
370 ;; js--pitem instances are never modified (with the exception
371 ;; of the b-end field). Instead, modified copies are added at
372 ;; subsequence parse points.
373 ;; (The exception for b-end and its caveats is described below.)
374 ;;
375
376 (cl-defstruct (js--pitem (:type list))
377 ;; IMPORTANT: Do not alter the position of fields within the list.
378 ;; Various bits of code depend on their positions, particularly
379 ;; anything that manipulates the list of children.
380
381 ;; List of children inside this pitem's body
382 (children nil :read-only t)
383
384 ;; When we reach this paren depth after h-end, the pitem ends
385 (paren-depth nil :read-only t)
386
387 ;; Symbol or class-style plist if this is a class
388 (type nil :read-only t)
389
390 ;; See above
391 (h-begin nil :read-only t)
392
393 ;; List of strings giving the parts of the name of this pitem (e.g.,
394 ;; '("MyClass" "myMethod"), or t if this pitem is anonymous
395 (name nil :read-only t)
396
397 ;; THIS FIELD IS MUTATED, and its value is shared by all copies of
398 ;; this pitem: when we copy-and-modify pitem instances, we share
399 ;; their tail structures, so all the copies actually have the same
400 ;; terminating cons cell. We modify that shared cons cell directly.
401 ;;
402 ;; The field value is either a number (buffer location) or nil if
403 ;; unknown.
404 ;;
405 ;; If the field's value is greater than `js--cache-end', the
406 ;; value is stale and must be treated as if it were nil. Conversely,
407 ;; if this field is nil, it is guaranteed that this pitem is open up
408 ;; to at least `js--cache-end'. (This property is handy when
409 ;; computing whether we're inside a given pitem.)
410 ;;
411 (b-end nil))
412
413 ;; The pitem we start parsing with.
414 (defconst js--initial-pitem
415 (make-js--pitem
416 :paren-depth most-negative-fixnum
417 :type 'toplevel))
418
419 ;;; User Customization
420
421 (defgroup js nil
422 "Customization variables for JavaScript mode."
423 :tag "JavaScript"
424 :group 'languages)
425
426 (defcustom js-indent-level 4
427 "Number of spaces for each indentation step in `js-mode'."
428 :type 'integer
429 :safe 'integerp
430 :group 'js)
431
432 (defcustom js-expr-indent-offset 0
433 "Number of additional spaces for indenting continued expressions.
434 The value must be no less than minus `js-indent-level'."
435 :type 'integer
436 :safe 'integerp
437 :group 'js)
438
439 (defcustom js-paren-indent-offset 0
440 "Number of additional spaces for indenting expressions in parentheses.
441 The value must be no less than minus `js-indent-level'."
442 :type 'integer
443 :safe 'integerp
444 :group 'js
445 :version "24.1")
446
447 (defcustom js-square-indent-offset 0
448 "Number of additional spaces for indenting expressions in square braces.
449 The value must be no less than minus `js-indent-level'."
450 :type 'integer
451 :safe 'integerp
452 :group 'js
453 :version "24.1")
454
455 (defcustom js-curly-indent-offset 0
456 "Number of additional spaces for indenting expressions in curly braces.
457 The value must be no less than minus `js-indent-level'."
458 :type 'integer
459 :safe 'integerp
460 :group 'js
461 :version "24.1")
462
463 (defcustom js-switch-indent-offset 0
464 "Number of additional spaces for indenting the contents of a switch block.
465 The value must not be negative."
466 :type 'integer
467 :safe 'integerp
468 :group 'js
469 :version "24.4")
470
471 (defcustom js-flat-functions nil
472 "Treat nested functions as top-level functions in `js-mode'.
473 This applies to function movement, marking, and so on."
474 :type 'boolean
475 :group 'js)
476
477 (defcustom js-comment-lineup-func #'c-lineup-C-comments
478 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
479 :type 'function
480 :group 'js)
481
482 (defcustom js-enabled-frameworks js--available-frameworks
483 "Frameworks recognized by `js-mode'.
484 To improve performance, you may turn off some frameworks you
485 seldom use, either globally or on a per-buffer basis."
486 :type (cons 'set (mapcar (lambda (x)
487 (list 'const x))
488 js--available-frameworks))
489 :group 'js)
490
491 (defcustom js-js-switch-tabs
492 (and (memq system-type '(darwin)) t)
493 "Whether `js-mode' should display tabs while selecting them.
494 This is useful only if the windowing system has a good mechanism
495 for preventing Firefox from stealing the keyboard focus."
496 :type 'boolean
497 :group 'js)
498
499 (defcustom js-js-tmpdir
500 "~/.emacs.d/js/js"
501 "Temporary directory used by `js-mode' to communicate with Mozilla.
502 This directory must be readable and writable by both Mozilla and Emacs."
503 :type 'directory
504 :group 'js)
505
506 (defcustom js-js-timeout 5
507 "Reply timeout for executing commands in Mozilla via `js-mode'.
508 The value is given in seconds. Increase this value if you are
509 getting timeout messages."
510 :type 'integer
511 :group 'js)
512
513 (defcustom js-indent-first-init nil
514 "Non-nil means specially indent the first variable declaration's initializer.
515 Normally, the first declaration's initializer is unindented, and
516 subsequent declarations have their identifiers aligned with it:
517
518 var o = {
519 foo: 3
520 };
521
522 var o = {
523 foo: 3
524 },
525 bar = 2;
526
527 If this option has the value t, indent the first declaration's
528 initializer by an additional level:
529
530 var o = {
531 foo: 3
532 };
533
534 var o = {
535 foo: 3
536 },
537 bar = 2;
538
539 If this option has the value `dynamic', if there is only one declaration,
540 don't indent the first one's initializer; otherwise, indent it.
541
542 var o = {
543 foo: 3
544 };
545
546 var o = {
547 foo: 3
548 },
549 bar = 2;"
550 :version "25.1"
551 :type '(choice (const nil) (const t) (const dynamic))
552 :safe 'symbolp
553 :group 'js)
554
555 ;;; KeyMap
556
557 (defvar js-mode-map
558 (let ((keymap (make-sparse-keymap)))
559 (define-key keymap [(control ?c) (meta ?:)] #'js-eval)
560 (define-key keymap [(control ?c) (control ?j)] #'js-set-js-context)
561 (define-key keymap [(control meta ?x)] #'js-eval-defun)
562 (define-key keymap [(meta ?.)] #'js-find-symbol)
563 (easy-menu-define nil keymap "Javascript Menu"
564 '("Javascript"
565 ["Select New Mozilla Context..." js-set-js-context
566 (fboundp #'inferior-moz-process)]
567 ["Evaluate Expression in Mozilla Context..." js-eval
568 (fboundp #'inferior-moz-process)]
569 ["Send Current Function to Mozilla..." js-eval-defun
570 (fboundp #'inferior-moz-process)]))
571 keymap)
572 "Keymap for `js-mode'.")
573
574 ;;; Syntax table and parsing
575
576 (defvar js-mode-syntax-table
577 (let ((table (make-syntax-table)))
578 (c-populate-syntax-table table)
579 (modify-syntax-entry ?$ "_" table)
580 (modify-syntax-entry ?` "\"" table)
581 table)
582 "Syntax table for `js-mode'.")
583
584 (defvar js--quick-match-re nil
585 "Autogenerated regexp used by `js-mode' to match buffer constructs.")
586
587 (defvar js--quick-match-re-func nil
588 "Autogenerated regexp used by `js-mode' to match constructs and functions.")
589
590 (make-variable-buffer-local 'js--quick-match-re)
591 (make-variable-buffer-local 'js--quick-match-re-func)
592
593 (defvar js--cache-end 1
594 "Last valid buffer position for the `js-mode' function cache.")
595 (make-variable-buffer-local 'js--cache-end)
596
597 (defvar js--last-parse-pos nil
598 "Latest parse position reached by `js--ensure-cache'.")
599 (make-variable-buffer-local 'js--last-parse-pos)
600
601 (defvar js--state-at-last-parse-pos nil
602 "Parse state at `js--last-parse-pos'.")
603 (make-variable-buffer-local 'js--state-at-last-parse-pos)
604
605 (defun js--flatten-list (list)
606 (cl-loop for item in list
607 nconc (cond ((consp item)
608 (js--flatten-list item))
609 (item (list item)))))
610
611 (defun js--maybe-join (prefix separator suffix &rest list)
612 "Helper function for `js--update-quick-match-re'.
613 If LIST contains any element that is not nil, return its non-nil
614 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
615 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
616 nil. If any element in LIST is itself a list, flatten that
617 element."
618 (setq list (js--flatten-list list))
619 (when list
620 (concat prefix (mapconcat #'identity list separator) suffix)))
621
622 (defun js--update-quick-match-re ()
623 "Internal function used by `js-mode' for caching buffer constructs.
624 This updates `js--quick-match-re', based on the current set of
625 enabled frameworks."
626 (setq js--quick-match-re
627 (js--maybe-join
628 "^[ \t]*\\(?:" "\\|" "\\)"
629
630 ;; #define mumble
631 "#define[ \t]+[a-zA-Z_]"
632
633 (when (memq 'extjs js-enabled-frameworks)
634 "Ext\\.extend")
635
636 (when (memq 'prototype js-enabled-frameworks)
637 "Object\\.extend")
638
639 ;; var mumble = THING (
640 (js--maybe-join
641 "\\(?:var[ \t]+\\)?[a-zA-Z_$0-9.]+[ \t]*=[ \t]*\\(?:"
642 "\\|"
643 "\\)[ \t]*("
644
645 (when (memq 'prototype js-enabled-frameworks)
646 "Class\\.create")
647
648 (when (memq 'extjs js-enabled-frameworks)
649 "Ext\\.extend")
650
651 (when (memq 'merrillpress js-enabled-frameworks)
652 "[a-zA-Z_$0-9]+\\.extend\\(?:Final\\)?"))
653
654 (when (memq 'dojo js-enabled-frameworks)
655 "dojo\\.declare[ \t]*(")
656
657 (when (memq 'mochikit js-enabled-frameworks)
658 "MochiKit\\.Base\\.update[ \t]*(")
659
660 ;; mumble.prototypeTHING
661 (js--maybe-join
662 "[a-zA-Z_$0-9.]+\\.prototype\\(?:" "\\|" "\\)"
663
664 (when (memq 'javascript js-enabled-frameworks)
665 '( ;; foo.prototype.bar = function(
666 "\\.[a-zA-Z_$0-9]+[ \t]*=[ \t]*function[ \t]*("
667
668 ;; mumble.prototype = {
669 "[ \t]*=[ \t]*{")))))
670
671 (setq js--quick-match-re-func
672 (concat "function\\|" js--quick-match-re)))
673
674 (defun js--forward-text-property (propname)
675 "Move over the next value of PROPNAME in the buffer.
676 If found, return that value and leave point after the character
677 having that value; otherwise, return nil and leave point at EOB."
678 (let ((next-value (get-text-property (point) propname)))
679 (if next-value
680 (forward-char)
681
682 (goto-char (next-single-property-change
683 (point) propname nil (point-max)))
684 (unless (eobp)
685 (setq next-value (get-text-property (point) propname))
686 (forward-char)))
687
688 next-value))
689
690 (defun js--backward-text-property (propname)
691 "Move over the previous value of PROPNAME in the buffer.
692 If found, return that value and leave point just before the
693 character that has that value, otherwise return nil and leave
694 point at BOB."
695 (unless (bobp)
696 (let ((prev-value (get-text-property (1- (point)) propname)))
697 (if prev-value
698 (backward-char)
699
700 (goto-char (previous-single-property-change
701 (point) propname nil (point-min)))
702
703 (unless (bobp)
704 (backward-char)
705 (setq prev-value (get-text-property (point) propname))))
706
707 prev-value)))
708
709 (defsubst js--forward-pstate ()
710 (js--forward-text-property 'js--pstate))
711
712 (defsubst js--backward-pstate ()
713 (js--backward-text-property 'js--pstate))
714
715 (defun js--pitem-goto-h-end (pitem)
716 (goto-char (js--pitem-h-begin pitem))
717 (js--forward-pstate))
718
719 (defun js--re-search-forward-inner (regexp &optional bound count)
720 "Helper function for `js--re-search-forward'."
721 (let ((parse)
722 str-terminator
723 (orig-macro-end (save-excursion
724 (when (js--beginning-of-macro)
725 (c-end-of-macro)
726 (point)))))
727 (while (> count 0)
728 (re-search-forward regexp bound)
729 (setq parse (syntax-ppss))
730 (cond ((setq str-terminator (nth 3 parse))
731 (when (eq str-terminator t)
732 (setq str-terminator ?/))
733 (re-search-forward
734 (concat "\\([^\\]\\|^\\)" (string str-terminator))
735 (point-at-eol) t))
736 ((nth 7 parse)
737 (forward-line))
738 ((or (nth 4 parse)
739 (and (eq (char-before) ?\/) (eq (char-after) ?\*)))
740 (re-search-forward "\\*/"))
741 ((and (not (and orig-macro-end
742 (<= (point) orig-macro-end)))
743 (js--beginning-of-macro))
744 (c-end-of-macro))
745 (t
746 (setq count (1- count))))))
747 (point))
748
749
750 (defun js--re-search-forward (regexp &optional bound noerror count)
751 "Search forward, ignoring strings, cpp macros, and comments.
752 This function invokes `re-search-forward', but treats the buffer
753 as if strings, cpp macros, and comments have been removed.
754
755 If invoked while inside a macro, it treats the contents of the
756 macro as normal text."
757 (unless count (setq count 1))
758 (let ((saved-point (point))
759 (search-fun
760 (cond ((< count 0) (setq count (- count))
761 #'js--re-search-backward-inner)
762 ((> count 0) #'js--re-search-forward-inner)
763 (t #'ignore))))
764 (condition-case err
765 (funcall search-fun regexp bound count)
766 (search-failed
767 (goto-char saved-point)
768 (unless noerror
769 (signal (car err) (cdr err)))))))
770
771
772 (defun js--re-search-backward-inner (regexp &optional bound count)
773 "Auxiliary function for `js--re-search-backward'."
774 (let ((parse)
775 str-terminator
776 (orig-macro-start
777 (save-excursion
778 (and (js--beginning-of-macro)
779 (point)))))
780 (while (> count 0)
781 (re-search-backward regexp bound)
782 (when (and (> (point) (point-min))
783 (save-excursion (backward-char) (looking-at "/[/*]")))
784 (forward-char))
785 (setq parse (syntax-ppss))
786 (cond ((setq str-terminator (nth 3 parse))
787 (when (eq str-terminator t)
788 (setq str-terminator ?/))
789 (re-search-backward
790 (concat "\\([^\\]\\|^\\)" (string str-terminator))
791 (point-at-bol) t))
792 ((nth 7 parse)
793 (goto-char (nth 8 parse)))
794 ((or (nth 4 parse)
795 (and (eq (char-before) ?/) (eq (char-after) ?*)))
796 (re-search-backward "/\\*"))
797 ((and (not (and orig-macro-start
798 (>= (point) orig-macro-start)))
799 (js--beginning-of-macro)))
800 (t
801 (setq count (1- count))))))
802 (point))
803
804
805 (defun js--re-search-backward (regexp &optional bound noerror count)
806 "Search backward, ignoring strings, preprocessor macros, and comments.
807
808 This function invokes `re-search-backward' but treats the buffer
809 as if strings, preprocessor macros, and comments have been
810 removed.
811
812 If invoked while inside a macro, treat the macro as normal text."
813 (js--re-search-forward regexp bound noerror (if count (- count) -1)))
814
815 (defun js--forward-expression ()
816 "Move forward over a whole JavaScript expression.
817 This function doesn't move over expressions continued across
818 lines."
819 (cl-loop
820 ;; non-continued case; simplistic, but good enough?
821 do (cl-loop until (or (eolp)
822 (progn
823 (forward-comment most-positive-fixnum)
824 (memq (char-after) '(?\, ?\; ?\] ?\) ?\}))))
825 do (forward-sexp))
826
827 while (and (eq (char-after) ?\n)
828 (save-excursion
829 (forward-char)
830 (js--continued-expression-p)))))
831
832 (defun js--forward-function-decl ()
833 "Move forward over a JavaScript function declaration.
834 This puts point at the `function' keyword.
835
836 If this is a syntactically-correct non-expression function,
837 return the name of the function, or t if the name could not be
838 determined. Otherwise, return nil."
839 (cl-assert (looking-at "\\_<function\\_>"))
840 (let ((name t))
841 (forward-word)
842 (forward-comment most-positive-fixnum)
843 (when (eq (char-after) ?*)
844 (forward-char)
845 (forward-comment most-positive-fixnum))
846 (when (looking-at js--name-re)
847 (setq name (match-string-no-properties 0))
848 (goto-char (match-end 0)))
849 (forward-comment most-positive-fixnum)
850 (and (eq (char-after) ?\( )
851 (ignore-errors (forward-list) t)
852 (progn (forward-comment most-positive-fixnum)
853 (and (eq (char-after) ?{)
854 name)))))
855
856 (defun js--function-prologue-beginning (&optional pos)
857 "Return the start of the JavaScript function prologue containing POS.
858 A function prologue is everything from start of the definition up
859 to and including the opening brace. POS defaults to point.
860 If POS is not in a function prologue, return nil."
861 (let (prologue-begin)
862 (save-excursion
863 (if pos
864 (goto-char pos)
865 (setq pos (point)))
866
867 (when (save-excursion
868 (forward-line 0)
869 (or (looking-at js--function-heading-2-re)
870 (looking-at js--function-heading-3-re)))
871
872 (setq prologue-begin (match-beginning 1))
873 (when (<= prologue-begin pos)
874 (goto-char (match-end 0))))
875
876 (skip-syntax-backward "w_")
877 (and (or (looking-at "\\_<function\\_>")
878 (js--re-search-backward "\\_<function\\_>" nil t))
879
880 (save-match-data (goto-char (match-beginning 0))
881 (js--forward-function-decl))
882
883 (<= pos (point))
884 (or prologue-begin (match-beginning 0))))))
885
886 (defun js--beginning-of-defun-raw ()
887 "Helper function for `js-beginning-of-defun'.
888 Go to previous defun-beginning and return the parse state for it,
889 or nil if we went all the way back to bob and don't find
890 anything."
891 (js--ensure-cache)
892 (let (pstate)
893 (while (and (setq pstate (js--backward-pstate))
894 (not (eq 'function (js--pitem-type (car pstate))))))
895 (and (not (bobp)) pstate)))
896
897 (defun js--pstate-is-toplevel-defun (pstate)
898 "Helper function for `js--beginning-of-defun-nested'.
899 If PSTATE represents a non-empty top-level defun, return the
900 top-most pitem. Otherwise, return nil."
901 (cl-loop for pitem in pstate
902 with func-depth = 0
903 with func-pitem
904 if (eq 'function (js--pitem-type pitem))
905 do (cl-incf func-depth)
906 and do (setq func-pitem pitem)
907 finally return (if (eq func-depth 1) func-pitem)))
908
909 (defun js--beginning-of-defun-nested ()
910 "Helper function for `js--beginning-of-defun'.
911 Return the pitem of the function we went to the beginning of."
912 (or
913 ;; Look for the smallest function that encloses point...
914 (cl-loop for pitem in (js--parse-state-at-point)
915 if (and (eq 'function (js--pitem-type pitem))
916 (js--inside-pitem-p pitem))
917 do (goto-char (js--pitem-h-begin pitem))
918 and return pitem)
919
920 ;; ...and if that isn't found, look for the previous top-level
921 ;; defun
922 (cl-loop for pstate = (js--backward-pstate)
923 while pstate
924 if (js--pstate-is-toplevel-defun pstate)
925 do (goto-char (js--pitem-h-begin it))
926 and return it)))
927
928 (defun js--beginning-of-defun-flat ()
929 "Helper function for `js-beginning-of-defun'."
930 (let ((pstate (js--beginning-of-defun-raw)))
931 (when pstate
932 (goto-char (js--pitem-h-begin (car pstate))))))
933
934 (defun js-beginning-of-defun (&optional arg)
935 "Value of `beginning-of-defun-function' for `js-mode'."
936 (setq arg (or arg 1))
937 (while (and (not (eobp)) (< arg 0))
938 (cl-incf arg)
939 (when (and (not js-flat-functions)
940 (or (eq (js-syntactic-context) 'function)
941 (js--function-prologue-beginning)))
942 (js-end-of-defun))
943
944 (if (js--re-search-forward
945 "\\_<function\\_>" nil t)
946 (goto-char (js--function-prologue-beginning))
947 (goto-char (point-max))))
948
949 (while (> arg 0)
950 (cl-decf arg)
951 ;; If we're just past the end of a function, the user probably wants
952 ;; to go to the beginning of *that* function
953 (when (eq (char-before) ?})
954 (backward-char))
955
956 (let ((prologue-begin (js--function-prologue-beginning)))
957 (cond ((and prologue-begin (< prologue-begin (point)))
958 (goto-char prologue-begin))
959
960 (js-flat-functions
961 (js--beginning-of-defun-flat))
962 (t
963 (js--beginning-of-defun-nested))))))
964
965 (defun js--flush-caches (&optional beg ignored)
966 "Flush the `js-mode' syntax cache after position BEG.
967 BEG defaults to `point-min', meaning to flush the entire cache."
968 (interactive)
969 (setq beg (or beg (save-restriction (widen) (point-min))))
970 (setq js--cache-end (min js--cache-end beg)))
971
972 (defmacro js--debug (&rest _arguments)
973 ;; `(message ,@arguments)
974 )
975
976 (defun js--ensure-cache--pop-if-ended (open-items paren-depth)
977 (let ((top-item (car open-items)))
978 (when (<= paren-depth (js--pitem-paren-depth top-item))
979 (cl-assert (not (get-text-property (1- (point)) 'js-pend)))
980 (put-text-property (1- (point)) (point) 'js--pend top-item)
981 (setf (js--pitem-b-end top-item) (point))
982 (setq open-items
983 ;; open-items must contain at least two items for this to
984 ;; work, but because we push a dummy item to start with,
985 ;; that assumption holds.
986 (cons (js--pitem-add-child (cl-second open-items) top-item)
987 (cddr open-items)))))
988 open-items)
989
990 (defmacro js--ensure-cache--update-parse ()
991 "Helper function for `js--ensure-cache'.
992 Update parsing information up to point, referring to parse,
993 prev-parse-point, goal-point, and open-items bound lexically in
994 the body of `js--ensure-cache'."
995 `(progn
996 (setq goal-point (point))
997 (goto-char prev-parse-point)
998 (while (progn
999 (setq open-items (js--ensure-cache--pop-if-ended
1000 open-items (car parse)))
1001 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
1002 ;; the given depth -- i.e., make sure we're deeper than the target
1003 ;; depth.
1004 (cl-assert (> (nth 0 parse)
1005 (js--pitem-paren-depth (car open-items))))
1006 (setq parse (parse-partial-sexp
1007 prev-parse-point goal-point
1008 (js--pitem-paren-depth (car open-items))
1009 nil parse))
1010
1011 ;; (let ((overlay (make-overlay prev-parse-point (point))))
1012 ;; (overlay-put overlay 'face '(:background "red"))
1013 ;; (unwind-protect
1014 ;; (progn
1015 ;; (js--debug "parsed: %S" parse)
1016 ;; (sit-for 1))
1017 ;; (delete-overlay overlay)))
1018
1019 (setq prev-parse-point (point))
1020 (< (point) goal-point)))
1021
1022 (setq open-items (js--ensure-cache--pop-if-ended
1023 open-items (car parse)))))
1024
1025 (defun js--show-cache-at-point ()
1026 (interactive)
1027 (require 'pp)
1028 (let ((prop (get-text-property (point) 'js--pstate)))
1029 (with-output-to-temp-buffer "*Help*"
1030 (pp prop))))
1031
1032 (defun js--split-name (string)
1033 "Split a JavaScript name into its dot-separated parts.
1034 This also removes any prototype parts from the split name
1035 \(unless the name is just \"prototype\" to start with)."
1036 (let ((name (save-match-data
1037 (split-string string "\\." t))))
1038 (unless (and (= (length name) 1)
1039 (equal (car name) "prototype"))
1040
1041 (setq name (remove "prototype" name)))))
1042
1043 (defvar js--guess-function-name-start nil)
1044
1045 (defun js--guess-function-name (position)
1046 "Guess the name of the JavaScript function at POSITION.
1047 POSITION should be just after the end of the word \"function\".
1048 Return the name of the function, or nil if the name could not be
1049 guessed.
1050
1051 This function clobbers match data. If we find the preamble
1052 begins earlier than expected while guessing the function name,
1053 set `js--guess-function-name-start' to that position; otherwise,
1054 set that variable to nil."
1055 (setq js--guess-function-name-start nil)
1056 (save-excursion
1057 (goto-char position)
1058 (forward-line 0)
1059 (cond
1060 ((looking-at js--function-heading-3-re)
1061 (and (eq (match-end 0) position)
1062 (setq js--guess-function-name-start (match-beginning 1))
1063 (match-string-no-properties 1)))
1064
1065 ((looking-at js--function-heading-2-re)
1066 (and (eq (match-end 0) position)
1067 (setq js--guess-function-name-start (match-beginning 1))
1068 (match-string-no-properties 1))))))
1069
1070 (defun js--clear-stale-cache ()
1071 ;; Clear any endings that occur after point
1072 (let (end-prop)
1073 (save-excursion
1074 (while (setq end-prop (js--forward-text-property
1075 'js--pend))
1076 (setf (js--pitem-b-end end-prop) nil))))
1077
1078 ;; Remove any cache properties after this point
1079 (remove-text-properties (point) (point-max)
1080 '(js--pstate t js--pend t)))
1081
1082 (defun js--ensure-cache (&optional limit)
1083 "Ensures brace cache is valid up to the character before LIMIT.
1084 LIMIT defaults to point."
1085 (setq limit (or limit (point)))
1086 (when (< js--cache-end limit)
1087
1088 (c-save-buffer-state
1089 (open-items
1090 parse
1091 prev-parse-point
1092 name
1093 case-fold-search
1094 filtered-class-styles
1095 goal-point)
1096
1097 ;; Figure out which class styles we need to look for
1098 (setq filtered-class-styles
1099 (cl-loop for style in js--class-styles
1100 if (memq (plist-get style :framework)
1101 js-enabled-frameworks)
1102 collect style))
1103
1104 (save-excursion
1105 (save-restriction
1106 (widen)
1107
1108 ;; Find last known good position
1109 (goto-char js--cache-end)
1110 (unless (bobp)
1111 (setq open-items (get-text-property
1112 (1- (point)) 'js--pstate))
1113
1114 (unless open-items
1115 (goto-char (previous-single-property-change
1116 (point) 'js--pstate nil (point-min)))
1117
1118 (unless (bobp)
1119 (setq open-items (get-text-property (1- (point))
1120 'js--pstate))
1121 (cl-assert open-items))))
1122
1123 (unless open-items
1124 ;; Make a placeholder for the top-level definition
1125 (setq open-items (list js--initial-pitem)))
1126
1127 (setq parse (syntax-ppss))
1128 (setq prev-parse-point (point))
1129
1130 (js--clear-stale-cache)
1131
1132 (narrow-to-region (point-min) limit)
1133
1134 (cl-loop while (re-search-forward js--quick-match-re-func nil t)
1135 for orig-match-start = (goto-char (match-beginning 0))
1136 for orig-match-end = (match-end 0)
1137 do (js--ensure-cache--update-parse)
1138 for orig-depth = (nth 0 parse)
1139
1140 ;; Each of these conditions should return non-nil if
1141 ;; we should add a new item and leave point at the end
1142 ;; of the new item's header (h-end in the
1143 ;; js--pitem diagram). This point is the one
1144 ;; after the last character we need to unambiguously
1145 ;; detect this construct. If one of these evaluates to
1146 ;; nil, the location of the point is ignored.
1147 if (cond
1148 ;; In comment or string
1149 ((nth 8 parse) nil)
1150
1151 ;; Regular function declaration
1152 ((and (looking-at "\\_<function\\_>")
1153 (setq name (js--forward-function-decl)))
1154
1155 (when (eq name t)
1156 (setq name (js--guess-function-name orig-match-end))
1157 (if name
1158 (when js--guess-function-name-start
1159 (setq orig-match-start
1160 js--guess-function-name-start))
1161
1162 (setq name t)))
1163
1164 (cl-assert (eq (char-after) ?{))
1165 (forward-char)
1166 (make-js--pitem
1167 :paren-depth orig-depth
1168 :h-begin orig-match-start
1169 :type 'function
1170 :name (if (eq name t)
1171 name
1172 (js--split-name name))))
1173
1174 ;; Macro
1175 ((looking-at js--macro-decl-re)
1176
1177 ;; Macros often contain unbalanced parentheses.
1178 ;; Make sure that h-end is at the textual end of
1179 ;; the macro no matter what the parenthesis say.
1180 (c-end-of-macro)
1181 (js--ensure-cache--update-parse)
1182
1183 (make-js--pitem
1184 :paren-depth (nth 0 parse)
1185 :h-begin orig-match-start
1186 :type 'macro
1187 :name (list (match-string-no-properties 1))))
1188
1189 ;; "Prototype function" declaration
1190 ((looking-at js--plain-method-re)
1191 (goto-char (match-beginning 3))
1192 (when (save-match-data
1193 (js--forward-function-decl))
1194 (forward-char)
1195 (make-js--pitem
1196 :paren-depth orig-depth
1197 :h-begin orig-match-start
1198 :type 'function
1199 :name (nconc (js--split-name
1200 (match-string-no-properties 1))
1201 (list (match-string-no-properties 2))))))
1202
1203 ;; Class definition
1204 ((cl-loop
1205 with syntactic-context =
1206 (js--syntactic-context-from-pstate open-items)
1207 for class-style in filtered-class-styles
1208 if (and (memq syntactic-context
1209 (plist-get class-style :contexts))
1210 (looking-at (plist-get class-style
1211 :class-decl)))
1212 do (goto-char (match-end 0))
1213 and return
1214 (make-js--pitem
1215 :paren-depth orig-depth
1216 :h-begin orig-match-start
1217 :type class-style
1218 :name (js--split-name
1219 (match-string-no-properties 1))))))
1220
1221 do (js--ensure-cache--update-parse)
1222 and do (push it open-items)
1223 and do (put-text-property
1224 (1- (point)) (point) 'js--pstate open-items)
1225 else do (goto-char orig-match-end))
1226
1227 (goto-char limit)
1228 (js--ensure-cache--update-parse)
1229 (setq js--cache-end limit)
1230 (setq js--last-parse-pos limit)
1231 (setq js--state-at-last-parse-pos open-items)
1232 )))))
1233
1234 (defun js--end-of-defun-flat ()
1235 "Helper function for `js-end-of-defun'."
1236 (cl-loop while (js--re-search-forward "}" nil t)
1237 do (js--ensure-cache)
1238 if (get-text-property (1- (point)) 'js--pend)
1239 if (eq 'function (js--pitem-type it))
1240 return t
1241 finally do (goto-char (point-max))))
1242
1243 (defun js--end-of-defun-nested ()
1244 "Helper function for `js-end-of-defun'."
1245 (message "test")
1246 (let* (pitem
1247 (this-end (save-excursion
1248 (and (setq pitem (js--beginning-of-defun-nested))
1249 (js--pitem-goto-h-end pitem)
1250 (progn (backward-char)
1251 (forward-list)
1252 (point)))))
1253 found)
1254
1255 (if (and this-end (< (point) this-end))
1256 ;; We're already inside a function; just go to its end.
1257 (goto-char this-end)
1258
1259 ;; Otherwise, go to the end of the next function...
1260 (while (and (js--re-search-forward "\\_<function\\_>" nil t)
1261 (not (setq found (progn
1262 (goto-char (match-beginning 0))
1263 (js--forward-function-decl))))))
1264
1265 (if found (forward-list)
1266 ;; ... or eob.
1267 (goto-char (point-max))))))
1268
1269 (defun js-end-of-defun (&optional arg)
1270 "Value of `end-of-defun-function' for `js-mode'."
1271 (setq arg (or arg 1))
1272 (while (and (not (bobp)) (< arg 0))
1273 (cl-incf arg)
1274 (js-beginning-of-defun)
1275 (js-beginning-of-defun)
1276 (unless (bobp)
1277 (js-end-of-defun)))
1278
1279 (while (> arg 0)
1280 (cl-decf arg)
1281 ;; look for function backward. if we're inside it, go to that
1282 ;; function's end. otherwise, search for the next function's end and
1283 ;; go there
1284 (if js-flat-functions
1285 (js--end-of-defun-flat)
1286
1287 ;; if we're doing nested functions, see whether we're in the
1288 ;; prologue. If we are, go to the end of the function; otherwise,
1289 ;; call js--end-of-defun-nested to do the real work
1290 (let ((prologue-begin (js--function-prologue-beginning)))
1291 (cond ((and prologue-begin (<= prologue-begin (point)))
1292 (goto-char prologue-begin)
1293 (re-search-forward "\\_<function")
1294 (goto-char (match-beginning 0))
1295 (js--forward-function-decl)
1296 (forward-list))
1297
1298 (t (js--end-of-defun-nested)))))))
1299
1300 (defun js--beginning-of-macro (&optional lim)
1301 (let ((here (point)))
1302 (save-restriction
1303 (if lim (narrow-to-region lim (point-max)))
1304 (beginning-of-line)
1305 (while (eq (char-before (1- (point))) ?\\)
1306 (forward-line -1))
1307 (back-to-indentation)
1308 (if (and (<= (point) here)
1309 (looking-at js--opt-cpp-start))
1310 t
1311 (goto-char here)
1312 nil))))
1313
1314 (defun js--backward-syntactic-ws (&optional lim)
1315 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1316 (save-restriction
1317 (when lim (narrow-to-region lim (point-max)))
1318
1319 (let ((in-macro (save-excursion (js--beginning-of-macro)))
1320 (pos (point)))
1321
1322 (while (progn (unless in-macro (js--beginning-of-macro))
1323 (forward-comment most-negative-fixnum)
1324 (/= (point)
1325 (prog1
1326 pos
1327 (setq pos (point)))))))))
1328
1329 (defun js--forward-syntactic-ws (&optional lim)
1330 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1331 (save-restriction
1332 (when lim (narrow-to-region (point-min) lim))
1333 (let ((pos (point)))
1334 (while (progn
1335 (forward-comment most-positive-fixnum)
1336 (when (eq (char-after) ?#)
1337 (c-end-of-macro))
1338 (/= (point)
1339 (prog1
1340 pos
1341 (setq pos (point)))))))))
1342
1343 ;; Like (up-list -1), but only considers lists that end nearby"
1344 (defun js--up-nearby-list ()
1345 (save-restriction
1346 ;; Look at a very small region so our computation time doesn't
1347 ;; explode in pathological cases.
1348 (narrow-to-region (max (point-min) (- (point) 500)) (point))
1349 (up-list -1)))
1350
1351 (defun js--inside-param-list-p ()
1352 "Return non-nil if point is in a function parameter list."
1353 (ignore-errors
1354 (save-excursion
1355 (js--up-nearby-list)
1356 (and (looking-at "(")
1357 (progn (forward-symbol -1)
1358 (or (looking-at "function")
1359 (progn (forward-symbol -1)
1360 (looking-at "function"))))))))
1361
1362 (defun js--inside-dojo-class-list-p ()
1363 "Return non-nil if point is in a Dojo multiple-inheritance class block."
1364 (ignore-errors
1365 (save-excursion
1366 (js--up-nearby-list)
1367 (let ((list-begin (point)))
1368 (forward-line 0)
1369 (and (looking-at js--dojo-class-decl-re)
1370 (goto-char (match-end 0))
1371 (looking-at "\"\\s-*,\\s-*\\[")
1372 (eq (match-end 0) (1+ list-begin)))))))
1373
1374 ;;; Font Lock
1375 (defun js--make-framework-matcher (framework &rest regexps)
1376 "Helper function for building `js--font-lock-keywords'.
1377 Create a byte-compiled function for matching a concatenation of
1378 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1379 (setq regexps (apply #'concat regexps))
1380 (byte-compile
1381 `(lambda (limit)
1382 (when (memq (quote ,framework) js-enabled-frameworks)
1383 (re-search-forward ,regexps limit t)))))
1384
1385 (defvar js--tmp-location nil)
1386 (make-variable-buffer-local 'js--tmp-location)
1387
1388 (defun js--forward-destructuring-spec (&optional func)
1389 "Move forward over a JavaScript destructuring spec.
1390 If FUNC is supplied, call it with no arguments before every
1391 variable name in the spec. Return true if this was actually a
1392 spec. FUNC must preserve the match data."
1393 (pcase (char-after)
1394 (?\[
1395 (forward-char)
1396 (while
1397 (progn
1398 (forward-comment most-positive-fixnum)
1399 (cond ((memq (char-after) '(?\[ ?\{))
1400 (js--forward-destructuring-spec func))
1401
1402 ((eq (char-after) ?,)
1403 (forward-char)
1404 t)
1405
1406 ((looking-at js--name-re)
1407 (and func (funcall func))
1408 (goto-char (match-end 0))
1409 t))))
1410 (when (eq (char-after) ?\])
1411 (forward-char)
1412 t))
1413
1414 (?\{
1415 (forward-char)
1416 (forward-comment most-positive-fixnum)
1417 (while
1418 (when (looking-at js--objfield-re)
1419 (goto-char (match-end 0))
1420 (forward-comment most-positive-fixnum)
1421 (and (cond ((memq (char-after) '(?\[ ?\{))
1422 (js--forward-destructuring-spec func))
1423 ((looking-at js--name-re)
1424 (and func (funcall func))
1425 (goto-char (match-end 0))
1426 t))
1427 (progn (forward-comment most-positive-fixnum)
1428 (when (eq (char-after) ?\,)
1429 (forward-char)
1430 (forward-comment most-positive-fixnum)
1431 t)))))
1432 (when (eq (char-after) ?\})
1433 (forward-char)
1434 t))))
1435
1436 (defun js--variable-decl-matcher (limit)
1437 "Font-lock matcher for variable names in a variable declaration.
1438 This is a cc-mode-style matcher that *always* fails, from the
1439 point of view of font-lock. It applies highlighting directly with
1440 `font-lock-apply-highlight'."
1441 (condition-case nil
1442 (save-restriction
1443 (narrow-to-region (point-min) limit)
1444
1445 (let ((first t))
1446 (forward-comment most-positive-fixnum)
1447 (while
1448 (and (or first
1449 (when (eq (char-after) ?,)
1450 (forward-char)
1451 (forward-comment most-positive-fixnum)
1452 t))
1453 (cond ((looking-at js--name-re)
1454 (font-lock-apply-highlight
1455 '(0 font-lock-variable-name-face))
1456 (goto-char (match-end 0)))
1457
1458 ((save-excursion
1459 (js--forward-destructuring-spec))
1460
1461 (js--forward-destructuring-spec
1462 (lambda ()
1463 (font-lock-apply-highlight
1464 '(0 font-lock-variable-name-face)))))))
1465
1466 (forward-comment most-positive-fixnum)
1467 (when (eq (char-after) ?=)
1468 (forward-char)
1469 (js--forward-expression)
1470 (forward-comment most-positive-fixnum))
1471
1472 (setq first nil))))
1473
1474 ;; Conditions to handle
1475 (scan-error nil)
1476 (end-of-buffer nil))
1477
1478 ;; Matcher always "fails"
1479 nil)
1480
1481 (defconst js--font-lock-keywords-3
1482 `(
1483 ;; This goes before keywords-2 so it gets used preferentially
1484 ;; instead of the keywords in keywords-2. Don't use override
1485 ;; because that will override syntactic fontification too, which
1486 ;; will fontify commented-out directives as if they weren't
1487 ;; commented out.
1488 ,@cpp-font-lock-keywords ; from font-lock.el
1489
1490 ,@js--font-lock-keywords-2
1491
1492 ("\\.\\(prototype\\)\\_>"
1493 (1 font-lock-constant-face))
1494
1495 ;; Highlights class being declared, in parts
1496 (js--class-decl-matcher
1497 ,(concat "\\(" js--name-re "\\)\\(?:\\.\\|.*$\\)")
1498 (goto-char (match-beginning 1))
1499 nil
1500 (1 font-lock-type-face))
1501
1502 ;; Highlights parent class, in parts, if available
1503 (js--class-decl-matcher
1504 ,(concat "\\(" js--name-re "\\)\\(?:\\.\\|.*$\\)")
1505 (if (match-beginning 2)
1506 (progn
1507 (setq js--tmp-location (match-end 2))
1508 (goto-char js--tmp-location)
1509 (insert "=")
1510 (goto-char (match-beginning 2)))
1511 (setq js--tmp-location nil)
1512 (goto-char (point-at-eol)))
1513 (when js--tmp-location
1514 (save-excursion
1515 (goto-char js--tmp-location)
1516 (delete-char 1)))
1517 (1 font-lock-type-face))
1518
1519 ;; Highlights parent class
1520 (js--class-decl-matcher
1521 (2 font-lock-type-face nil t))
1522
1523 ;; Dojo needs its own matcher to override the string highlighting
1524 (,(js--make-framework-matcher
1525 'dojo
1526 "^\\s-*dojo\\.declare\\s-*(\""
1527 "\\(" js--dotted-name-re "\\)"
1528 "\\(?:\"\\s-*,\\s-*\\(" js--dotted-name-re "\\)\\)?")
1529 (1 font-lock-type-face t)
1530 (2 font-lock-type-face nil t))
1531
1532 ;; Match Dojo base classes. Of course Mojo has to be different
1533 ;; from everything else under the sun...
1534 (,(js--make-framework-matcher
1535 'dojo
1536 "^\\s-*dojo\\.declare\\s-*(\""
1537 "\\(" js--dotted-name-re "\\)\"\\s-*,\\s-*\\[")
1538 ,(concat "[[,]\\s-*\\(" js--dotted-name-re "\\)\\s-*"
1539 "\\(?:\\].*$\\)?")
1540 (backward-char)
1541 (end-of-line)
1542 (1 font-lock-type-face))
1543
1544 ;; continued Dojo base-class list
1545 (,(js--make-framework-matcher
1546 'dojo
1547 "^\\s-*" js--dotted-name-re "\\s-*[],]")
1548 ,(concat "\\(" js--dotted-name-re "\\)"
1549 "\\s-*\\(?:\\].*$\\)?")
1550 (if (save-excursion (backward-char)
1551 (js--inside-dojo-class-list-p))
1552 (forward-symbol -1)
1553 (end-of-line))
1554 (end-of-line)
1555 (1 font-lock-type-face))
1556
1557 ;; variable declarations
1558 ,(list
1559 (concat "\\_<\\(const\\|var\\|let\\)\\_>\\|" js--basic-type-re)
1560 (list #'js--variable-decl-matcher nil nil nil))
1561
1562 ;; class instantiation
1563 ,(list
1564 (concat "\\_<new\\_>\\s-+\\(" js--dotted-name-re "\\)")
1565 (list 1 'font-lock-type-face))
1566
1567 ;; instanceof
1568 ,(list
1569 (concat "\\_<instanceof\\_>\\s-+\\(" js--dotted-name-re "\\)")
1570 (list 1 'font-lock-type-face))
1571
1572 ;; formal parameters
1573 ,(list
1574 (concat
1575 "\\_<function\\_>\\(\\s-+" js--name-re "\\)?\\s-*(\\s-*"
1576 js--name-start-re)
1577 (list (concat "\\(" js--name-re "\\)\\(\\s-*).*\\)?")
1578 '(backward-char)
1579 '(end-of-line)
1580 '(1 font-lock-variable-name-face)))
1581
1582 ;; continued formal parameter list
1583 ,(list
1584 (concat
1585 "^\\s-*" js--name-re "\\s-*[,)]")
1586 (list js--name-re
1587 '(if (save-excursion (backward-char)
1588 (js--inside-param-list-p))
1589 (forward-symbol -1)
1590 (end-of-line))
1591 '(end-of-line)
1592 '(0 font-lock-variable-name-face))))
1593 "Level three font lock for `js-mode'.")
1594
1595 (defun js--inside-pitem-p (pitem)
1596 "Return whether point is inside the given pitem's header or body."
1597 (js--ensure-cache)
1598 (cl-assert (js--pitem-h-begin pitem))
1599 (cl-assert (js--pitem-paren-depth pitem))
1600
1601 (and (> (point) (js--pitem-h-begin pitem))
1602 (or (null (js--pitem-b-end pitem))
1603 (> (js--pitem-b-end pitem) (point)))))
1604
1605 (defun js--parse-state-at-point ()
1606 "Parse the JavaScript program state at point.
1607 Return a list of `js--pitem' instances that apply to point, most
1608 specific first. In the worst case, the current toplevel instance
1609 will be returned."
1610 (save-excursion
1611 (save-restriction
1612 (widen)
1613 (js--ensure-cache)
1614 (let ((pstate (or (save-excursion
1615 (js--backward-pstate))
1616 (list js--initial-pitem))))
1617
1618 ;; Loop until we either hit a pitem at BOB or pitem ends after
1619 ;; point (or at point if we're at eob)
1620 (cl-loop for pitem = (car pstate)
1621 until (or (eq (js--pitem-type pitem)
1622 'toplevel)
1623 (js--inside-pitem-p pitem))
1624 do (pop pstate))
1625
1626 pstate))))
1627
1628 (defun js--syntactic-context-from-pstate (pstate)
1629 "Return the JavaScript syntactic context corresponding to PSTATE."
1630 (let ((type (js--pitem-type (car pstate))))
1631 (cond ((memq type '(function macro))
1632 type)
1633 ((consp type)
1634 'class)
1635 (t 'toplevel))))
1636
1637 (defun js-syntactic-context ()
1638 "Return the JavaScript syntactic context at point.
1639 When called interactively, also display a message with that
1640 context."
1641 (interactive)
1642 (let* ((syntactic-context (js--syntactic-context-from-pstate
1643 (js--parse-state-at-point))))
1644
1645 (when (called-interactively-p 'interactive)
1646 (message "Syntactic context: %s" syntactic-context))
1647
1648 syntactic-context))
1649
1650 (defun js--class-decl-matcher (limit)
1651 "Font lock function used by `js-mode'.
1652 This performs fontification according to `js--class-styles'."
1653 (cl-loop initially (js--ensure-cache limit)
1654 while (re-search-forward js--quick-match-re limit t)
1655 for orig-end = (match-end 0)
1656 do (goto-char (match-beginning 0))
1657 if (cl-loop for style in js--class-styles
1658 for decl-re = (plist-get style :class-decl)
1659 if (and (memq (plist-get style :framework)
1660 js-enabled-frameworks)
1661 (memq (js-syntactic-context)
1662 (plist-get style :contexts))
1663 decl-re
1664 (looking-at decl-re))
1665 do (goto-char (match-end 0))
1666 and return t)
1667 return t
1668 else do (goto-char orig-end)))
1669
1670 (defconst js--font-lock-keywords
1671 '(js--font-lock-keywords-3 js--font-lock-keywords-1
1672 js--font-lock-keywords-2
1673 js--font-lock-keywords-3)
1674 "Font lock keywords for `js-mode'. See `font-lock-keywords'.")
1675
1676 (defconst js--syntax-propertize-regexp-syntax-table
1677 (let ((st (make-char-table 'syntax-table (string-to-syntax "."))))
1678 (modify-syntax-entry ?\[ "(]" st)
1679 (modify-syntax-entry ?\] ")[" st)
1680 (modify-syntax-entry ?\\ "\\" st)
1681 st))
1682
1683 (defun js-syntax-propertize-regexp (end)
1684 (let ((ppss (syntax-ppss)))
1685 (when (eq (nth 3 ppss) ?/)
1686 ;; A /.../ regexp.
1687 (while
1688 (when (re-search-forward "\\(?:\\=\\|[^\\]\\)\\(?:\\\\\\\\\\)*/"
1689 end 'move)
1690 (if (nth 1 (with-syntax-table
1691 js--syntax-propertize-regexp-syntax-table
1692 (let ((parse-sexp-lookup-properties nil))
1693 (parse-partial-sexp (nth 8 ppss) (point)))))
1694 ;; A / within a character class is not the end of a regexp.
1695 t
1696 (put-text-property (1- (point)) (point)
1697 'syntax-table (string-to-syntax "\"/"))
1698 nil))))))
1699
1700 (defun js-syntax-propertize (start end)
1701 ;; Javascript allows immediate regular expression objects, written /.../.
1702 (goto-char start)
1703 (js-syntax-propertize-regexp end)
1704 (funcall
1705 (syntax-propertize-rules
1706 ;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
1707 ;; FIXME: Allow regexps after infix ops like + ...
1708 ;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
1709 ;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
1710 ;; point I think only * and / would be missing which could also be added,
1711 ;; but need care to avoid affecting the // and */ comment markers.
1712 ("\\(?:^\\|[=([{,:;]\\|\\_<return\\_>\\)\\(?:[ \t]\\)*\\(/\\)[^/*]"
1713 (1 (ignore
1714 (forward-char -1)
1715 (when (or (not (memq (char-after (match-beginning 0)) '(?\s ?\t)))
1716 ;; If the / is at the beginning of line, we have to check
1717 ;; the end of the previous text.
1718 (save-excursion
1719 (goto-char (match-beginning 0))
1720 (forward-comment (- (point)))
1721 (memq (char-before)
1722 (eval-when-compile (append "=({[,:;" '(nil))))))
1723 (put-text-property (match-beginning 1) (match-end 1)
1724 'syntax-table (string-to-syntax "\"/"))
1725 (js-syntax-propertize-regexp end))))))
1726 (point) end))
1727
1728 (defconst js--prettify-symbols-alist
1729 '(("=>" . ?⇒)
1730 (">=" . ?≥)
1731 ("<=" . ?≤))
1732 "Alist of symbol prettifications for JavaScript.")
1733
1734 ;;; Indentation
1735
1736 (defconst js--possibly-braceless-keyword-re
1737 (js--regexp-opt-symbol
1738 '("catch" "do" "else" "finally" "for" "if" "try" "while" "with"
1739 "each"))
1740 "Regexp matching keywords optionally followed by an opening brace.")
1741
1742 (defconst js--declaration-keyword-re
1743 (regexp-opt '("var" "let" "const") 'words)
1744 "Regular expression matching variable declaration keywords.")
1745
1746 (defconst js--indent-operator-re
1747 (concat "[-+*/%<>&^|?:.]\\([^-+*/]\\|$\\)\\|!?=\\|"
1748 (js--regexp-opt-symbol '("in" "instanceof")))
1749 "Regexp matching operators that affect indentation of continued expressions.")
1750
1751 (defun js--looking-at-operator-p ()
1752 "Return non-nil if point is on a JavaScript operator, other than a comma."
1753 (save-match-data
1754 (and (looking-at js--indent-operator-re)
1755 (or (not (eq (char-after) ?:))
1756 (save-excursion
1757 (and (js--re-search-backward "[?:{]\\|\\_<case\\_>" nil t)
1758 (eq (char-after) ??))))
1759 (not (and
1760 (eq (char-after) ?*)
1761 (looking-at (concat "\\* *" js--name-re " *("))
1762 (save-excursion
1763 (goto-char (1- (match-end 0)))
1764 (let (forward-sexp-function) (forward-sexp))
1765 (js--forward-syntactic-ws)
1766 (eq (char-after) ?{)))))))
1767
1768 (defun js--continued-expression-p ()
1769 "Return non-nil if the current line continues an expression."
1770 (save-excursion
1771 (back-to-indentation)
1772 (or (js--looking-at-operator-p)
1773 (and (js--re-search-backward "\n" nil t)
1774 (progn
1775 (skip-chars-backward " \t")
1776 (or (bobp) (backward-char))
1777 (and (> (point) (point-min))
1778 (save-excursion (backward-char) (not (looking-at "[/*]/")))
1779 (js--looking-at-operator-p)
1780 (and (progn (backward-char)
1781 (not (looking-at "+\\+\\|--\\|/[/*]"))))))))))
1782
1783
1784 (defun js--end-of-do-while-loop-p ()
1785 "Return non-nil if point is on the \"while\" of a do-while statement.
1786 Otherwise, return nil. A braceless do-while statement spanning
1787 several lines requires that the start of the loop is indented to
1788 the same column as the current line."
1789 (interactive)
1790 (save-excursion
1791 (save-match-data
1792 (when (looking-at "\\s-*\\_<while\\_>")
1793 (if (save-excursion
1794 (skip-chars-backward "[ \t\n]*}")
1795 (looking-at "[ \t\n]*}"))
1796 (save-excursion
1797 (backward-list) (forward-symbol -1) (looking-at "\\_<do\\_>"))
1798 (js--re-search-backward "\\_<do\\_>" (point-at-bol) t)
1799 (or (looking-at "\\_<do\\_>")
1800 (let ((saved-indent (current-indentation)))
1801 (while (and (js--re-search-backward "^\\s-*\\_<" nil t)
1802 (/= (current-indentation) saved-indent)))
1803 (and (looking-at "\\s-*\\_<do\\_>")
1804 (not (js--re-search-forward
1805 "\\_<while\\_>" (point-at-eol) t))
1806 (= (current-indentation) saved-indent)))))))))
1807
1808
1809 (defun js--ctrl-statement-indentation ()
1810 "Helper function for `js--proper-indentation'.
1811 Return the proper indentation of the current line if it starts
1812 the body of a control statement without braces; otherwise, return
1813 nil."
1814 (save-excursion
1815 (back-to-indentation)
1816 (when (save-excursion
1817 (and (not (eq (point-at-bol) (point-min)))
1818 (not (looking-at "[{]"))
1819 (js--re-search-backward "[[:graph:]]" nil t)
1820 (progn
1821 (or (eobp) (forward-char))
1822 (when (= (char-before) ?\)) (backward-list))
1823 (skip-syntax-backward " ")
1824 (skip-syntax-backward "w_")
1825 (looking-at js--possibly-braceless-keyword-re))
1826 (memq (char-before) '(?\s ?\t ?\n ?\}))
1827 (not (js--end-of-do-while-loop-p))))
1828 (save-excursion
1829 (goto-char (match-beginning 0))
1830 (+ (current-indentation) js-indent-level)))))
1831
1832 (defun js--get-c-offset (symbol anchor)
1833 (let ((c-offsets-alist
1834 (list (cons 'c js-comment-lineup-func))))
1835 (c-get-syntactic-indentation (list (cons symbol anchor)))))
1836
1837 (defun js--same-line (pos)
1838 (and (>= pos (point-at-bol))
1839 (<= pos (point-at-eol))))
1840
1841 (defun js--multi-line-declaration-indentation ()
1842 "Helper function for `js--proper-indentation'.
1843 Return the proper indentation of the current line if it belongs to a declaration
1844 statement spanning multiple lines; otherwise, return nil."
1845 (let (at-opening-bracket)
1846 (save-excursion
1847 (back-to-indentation)
1848 (when (not (looking-at js--declaration-keyword-re))
1849 (when (looking-at js--indent-operator-re)
1850 (goto-char (match-end 0)))
1851 (while (and (not at-opening-bracket)
1852 (not (bobp))
1853 (let ((pos (point)))
1854 (save-excursion
1855 (js--backward-syntactic-ws)
1856 (or (eq (char-before) ?,)
1857 (and (not (eq (char-before) ?\;))
1858 (prog2
1859 (skip-syntax-backward ".")
1860 (looking-at js--indent-operator-re)
1861 (js--backward-syntactic-ws))
1862 (not (eq (char-before) ?\;)))
1863 (js--same-line pos)))))
1864 (condition-case nil
1865 (backward-sexp)
1866 (scan-error (setq at-opening-bracket t))))
1867 (when (looking-at js--declaration-keyword-re)
1868 (goto-char (match-end 0))
1869 (1+ (current-column)))))))
1870
1871 (defun js--indent-in-array-comp (bracket)
1872 "Return non-nil if we think we're in an array comprehension.
1873 In particular, return the buffer position of the first `for' kwd."
1874 (let ((end (point)))
1875 (save-excursion
1876 (goto-char bracket)
1877 (when (looking-at "\\[")
1878 (forward-char 1)
1879 (js--forward-syntactic-ws)
1880 (if (looking-at "[[{]")
1881 (let (forward-sexp-function) ; Use Lisp version.
1882 (forward-sexp) ; Skip destructuring form.
1883 (js--forward-syntactic-ws)
1884 (if (and (/= (char-after) ?,) ; Regular array.
1885 (looking-at "for"))
1886 (match-beginning 0)))
1887 ;; To skip arbitrary expressions we need the parser,
1888 ;; so we'll just guess at it.
1889 (if (and (> end (point)) ; Not empty literal.
1890 (re-search-forward "[^,]]* \\(for\\) " end t)
1891 ;; Not inside comment or string literal.
1892 (not (nth 8 (parse-partial-sexp bracket (point)))))
1893 (match-beginning 1)))))))
1894
1895 (defun js--array-comp-indentation (bracket for-kwd)
1896 (if (js--same-line for-kwd)
1897 ;; First continuation line.
1898 (save-excursion
1899 (goto-char bracket)
1900 (forward-char 1)
1901 (skip-chars-forward " \t")
1902 (current-column))
1903 (save-excursion
1904 (goto-char for-kwd)
1905 (current-column))))
1906
1907 (defun js--maybe-goto-declaration-keyword-end (parse-status)
1908 "Helper function for `js--proper-indentation'.
1909 Depending on the value of `js-indent-first-init', move
1910 point to the end of a variable declaration keyword so that
1911 indentation is aligned to that column."
1912 (cond
1913 ((eq js-indent-first-init t)
1914 (when (looking-at js--declaration-keyword-re)
1915 (goto-char (1+ (match-end 0)))))
1916 ((eq js-indent-first-init 'dynamic)
1917 (let ((bracket (nth 1 parse-status))
1918 declaration-keyword-end
1919 at-closing-bracket-p
1920 comma-p)
1921 (when (looking-at js--declaration-keyword-re)
1922 (setq declaration-keyword-end (match-end 0))
1923 (save-excursion
1924 (goto-char bracket)
1925 (setq at-closing-bracket-p
1926 (condition-case nil
1927 (progn
1928 (forward-sexp)
1929 t)
1930 (error nil)))
1931 (when at-closing-bracket-p
1932 (while (forward-comment 1))
1933 (setq comma-p (looking-at-p ","))))
1934 (when comma-p
1935 (goto-char (1+ declaration-keyword-end))))))))
1936
1937 (defun js--proper-indentation (parse-status)
1938 "Return the proper indentation for the current line."
1939 (save-excursion
1940 (back-to-indentation)
1941 (cond ((nth 4 parse-status) ; inside comment
1942 (js--get-c-offset 'c (nth 8 parse-status)))
1943 ((nth 3 parse-status) 0) ; inside string
1944 ((eq (char-after) ?#) 0)
1945 ((save-excursion (js--beginning-of-macro)) 4)
1946 ;; Indent array comprehension continuation lines specially.
1947 ((let ((bracket (nth 1 parse-status))
1948 beg)
1949 (and bracket
1950 (not (js--same-line bracket))
1951 (setq beg (js--indent-in-array-comp bracket))
1952 ;; At or after the first loop?
1953 (>= (point) beg)
1954 (js--array-comp-indentation bracket beg))))
1955 ((js--ctrl-statement-indentation))
1956 ((js--multi-line-declaration-indentation))
1957 ((nth 1 parse-status)
1958 ;; A single closing paren/bracket should be indented at the
1959 ;; same level as the opening statement. Same goes for
1960 ;; "case" and "default".
1961 (let ((same-indent-p (looking-at "[]})]"))
1962 (switch-keyword-p (looking-at "default\\_>\\|case\\_>[^:]"))
1963 (continued-expr-p (js--continued-expression-p)))
1964 (goto-char (nth 1 parse-status)) ; go to the opening char
1965 (if (looking-at "[({[]\\s-*\\(/[/*]\\|$\\)")
1966 (progn ; nothing following the opening paren/bracket
1967 (skip-syntax-backward " ")
1968 (when (eq (char-before) ?\)) (backward-list))
1969 (back-to-indentation)
1970 (js--maybe-goto-declaration-keyword-end parse-status)
1971 (let* ((in-switch-p (unless same-indent-p
1972 (looking-at "\\_<switch\\_>")))
1973 (same-indent-p (or same-indent-p
1974 (and switch-keyword-p
1975 in-switch-p)))
1976 (indent
1977 (cond (same-indent-p
1978 (current-column))
1979 (continued-expr-p
1980 (+ (current-column) (* 2 js-indent-level)
1981 js-expr-indent-offset))
1982 (t
1983 (+ (current-column) js-indent-level
1984 (pcase (char-after (nth 1 parse-status))
1985 (?\( js-paren-indent-offset)
1986 (?\[ js-square-indent-offset)
1987 (?\{ js-curly-indent-offset)))))))
1988 (if in-switch-p
1989 (+ indent js-switch-indent-offset)
1990 indent)))
1991 ;; If there is something following the opening
1992 ;; paren/bracket, everything else should be indented at
1993 ;; the same level.
1994 (unless same-indent-p
1995 (forward-char)
1996 (skip-chars-forward " \t"))
1997 (current-column))))
1998
1999 ((js--continued-expression-p)
2000 (+ js-indent-level js-expr-indent-offset))
2001 (t 0))))
2002
2003 ;;; JSX Indentation
2004
2005 (defsubst js--jsx-find-before-tag ()
2006 "Find where JSX starts.
2007
2008 Assume JSX appears in the following instances:
2009 - Inside parentheses, when returned or as the first argument
2010 to a function, and after a newline
2011 - When assigned to variables or object properties, but only
2012 on a single line
2013 - As the N+1th argument to a function
2014
2015 This is an optimized version of (re-search-backward \"[(,]\n\"
2016 nil t), except set point to the end of the match. This logic
2017 executes up to the number of lines in the file, so it should be
2018 really fast to reduce that impact."
2019 (let (pos)
2020 (while (and (> (point) (point-min))
2021 (not (progn
2022 (end-of-line 0)
2023 (when (or (eq (char-before) 40) ; (
2024 (eq (char-before) 44)) ; ,
2025 (setq pos (1- (point))))))))
2026 pos))
2027
2028 (defconst js--jsx-end-tag-re
2029 (concat "</" sgml-name-re ">\\|/>")
2030 "Find the end of a JSX element.")
2031
2032 (defconst js--jsx-after-tag-re "[),]"
2033 "Find where JSX ends.
2034 This complements the assumption of where JSX appears from
2035 `js--jsx-before-tag-re', which see.")
2036
2037 (defun js--jsx-indented-element-p ()
2038 "Determine if/how the current line should be indented as JSX.
2039
2040 Return `first' for the first JSXElement on its own line.
2041 Return `nth' for subsequent lines of the first JSXElement.
2042 Return `expression' for an embedded JS expression.
2043 Return `after' for anything after the last JSXElement.
2044 Return nil for non-JSX lines.
2045
2046 Currently, JSX indentation supports the following styles:
2047
2048 - Single-line elements (indented like normal JS):
2049
2050 var element = <div></div>;
2051
2052 - Multi-line elements (enclosed in parentheses):
2053
2054 function () {
2055 return (
2056 <div>
2057 <div></div>
2058 </div>
2059 );
2060 }
2061
2062 - Function arguments:
2063
2064 React.render(
2065 <div></div>,
2066 document.querySelector('.root')
2067 );"
2068 (let ((current-pos (point))
2069 (current-line (line-number-at-pos))
2070 last-pos
2071 before-tag-pos before-tag-line
2072 tag-start-pos tag-start-line
2073 tag-end-pos tag-end-line
2074 after-tag-line
2075 parens paren type)
2076 (save-excursion
2077 (and
2078 ;; Determine if we're inside a jsx element
2079 (progn
2080 (end-of-line)
2081 (while (and (not tag-start-pos)
2082 (setq last-pos (js--jsx-find-before-tag)))
2083 (while (forward-comment 1))
2084 (when (= (char-after) 60) ; <
2085 (setq before-tag-pos last-pos
2086 tag-start-pos (point)))
2087 (goto-char last-pos))
2088 tag-start-pos)
2089 (progn
2090 (setq before-tag-line (line-number-at-pos before-tag-pos)
2091 tag-start-line (line-number-at-pos tag-start-pos))
2092 (and
2093 ;; A "before" line which also starts an element begins with js, so
2094 ;; indent it like js
2095 (> current-line before-tag-line)
2096 ;; Only indent the jsx lines like jsx
2097 (>= current-line tag-start-line)))
2098 (cond
2099 ;; Analyze bounds if there are any
2100 ((progn
2101 (while (and (not tag-end-pos)
2102 (setq last-pos (re-search-forward js--jsx-end-tag-re nil t)))
2103 (while (forward-comment 1))
2104 (when (looking-at js--jsx-after-tag-re)
2105 (setq tag-end-pos last-pos)))
2106 tag-end-pos)
2107 (setq tag-end-line (line-number-at-pos tag-end-pos)
2108 after-tag-line (line-number-at-pos after-tag-line))
2109 (or (and
2110 ;; Ensure we're actually within the bounds of the jsx
2111 (<= current-line tag-end-line)
2112 ;; An "after" line which does not end an element begins with
2113 ;; js, so indent it like js
2114 (<= current-line after-tag-line))
2115 (and
2116 ;; Handle another case where there could be e.g. comments after
2117 ;; the element
2118 (> current-line tag-end-line)
2119 (< current-line after-tag-line)
2120 (setq type 'after))))
2121 ;; They may not be any bounds (yet)
2122 (t))
2123 ;; Check if we're inside an embedded multi-line js expression
2124 (cond
2125 ((not type)
2126 (goto-char current-pos)
2127 (end-of-line)
2128 (setq parens (nth 9 (syntax-ppss)))
2129 (while (and parens (not type))
2130 (setq paren (car parens))
2131 (cond
2132 ((and (>= paren tag-start-pos)
2133 ;; Curly bracket indicates the start of an embedded expression
2134 (= (char-after paren) 123) ; {
2135 ;; The first line of the expression is indented like sgml
2136 (> current-line (line-number-at-pos paren))
2137 ;; Check if within a closing curly bracket (if any)
2138 ;; (exclusive, as the closing bracket is indented like sgml)
2139 (cond
2140 ((progn
2141 (goto-char paren)
2142 (ignore-errors (let (forward-sexp-function)
2143 (forward-sexp))))
2144 (< current-line (line-number-at-pos)))
2145 (t)))
2146 ;; Indicate this guy will be indented specially
2147 (setq type 'expression))
2148 (t (setq parens (cdr parens)))))
2149 t)
2150 (t))
2151 (cond
2152 (type)
2153 ;; Indent the first jsx thing like js so we can indent future jsx things
2154 ;; like sgml relative to the first thing
2155 ((= current-line tag-start-line) 'first)
2156 ('nth))))))
2157
2158 (defmacro js--as-sgml (&rest body)
2159 "Execute BODY as if in sgml-mode."
2160 `(with-syntax-table sgml-mode-syntax-table
2161 (let (forward-sexp-function
2162 parse-sexp-lookup-properties)
2163 ,@body)))
2164
2165 (defun js--expression-in-sgml-indent-line ()
2166 "Indent the current line as JavaScript or SGML (whichever is farther)."
2167 (let* (indent-col
2168 (savep (point))
2169 ;; Don't whine about errors/warnings when we're indenting.
2170 ;; This has to be set before calling parse-partial-sexp below.
2171 (inhibit-point-motion-hooks t)
2172 (parse-status (save-excursion
2173 (syntax-ppss (point-at-bol)))))
2174 ;; Don't touch multiline strings.
2175 (unless (nth 3 parse-status)
2176 (setq indent-col (save-excursion
2177 (back-to-indentation)
2178 (if (>= (point) savep) (setq savep nil))
2179 (js--as-sgml (sgml-calculate-indent))))
2180 (if (null indent-col)
2181 'noindent
2182 ;; Use whichever indentation column is greater, such that the sgml
2183 ;; column is effectively a minimum
2184 (setq indent-col (max (js--proper-indentation parse-status)
2185 (+ indent-col js-indent-level)))
2186 (if savep
2187 (save-excursion (indent-line-to indent-col))
2188 (indent-line-to indent-col))))))
2189
2190 (defun js-indent-line ()
2191 "Indent the current line as JavaScript."
2192 (interactive)
2193 (let* ((parse-status
2194 (save-excursion (syntax-ppss (point-at-bol))))
2195 (offset (- (point) (save-excursion (back-to-indentation) (point)))))
2196 (unless (nth 3 parse-status)
2197 (indent-line-to (js--proper-indentation parse-status))
2198 (when (> offset 0) (forward-char offset)))))
2199
2200 (defun js-jsx-indent-line ()
2201 "Indent the current line as JSX (with SGML offsets).
2202 i.e., customize JSX element indentation with `sgml-basic-offset',
2203 `sgml-attribute-offset' et al."
2204 (interactive)
2205 (let ((indentation-type (js--jsx-indented-element-p)))
2206 (cond
2207 ((eq indentation-type 'expression)
2208 (js--expression-in-sgml-indent-line))
2209 ((or (eq indentation-type 'first)
2210 (eq indentation-type 'after))
2211 ;; Don't treat this first thing as a continued expression (often a "<" or
2212 ;; ">" causes this misinterpretation)
2213 (cl-letf (((symbol-function #'js--continued-expression-p) 'ignore))
2214 (js-indent-line)))
2215 ((eq indentation-type 'nth)
2216 (js--as-sgml (sgml-indent-line)))
2217 (t (js-indent-line)))))
2218
2219 ;;; Filling
2220
2221 (defvar js--filling-paragraph nil)
2222
2223 ;; FIXME: Such redefinitions are bad style. We should try and use some other
2224 ;; way to get the same result.
2225 (defadvice c-forward-sws (around js-fill-paragraph activate)
2226 (if js--filling-paragraph
2227 (setq ad-return-value (js--forward-syntactic-ws (ad-get-arg 0)))
2228 ad-do-it))
2229
2230 (defadvice c-backward-sws (around js-fill-paragraph activate)
2231 (if js--filling-paragraph
2232 (setq ad-return-value (js--backward-syntactic-ws (ad-get-arg 0)))
2233 ad-do-it))
2234
2235 (defadvice c-beginning-of-macro (around js-fill-paragraph activate)
2236 (if js--filling-paragraph
2237 (setq ad-return-value (js--beginning-of-macro (ad-get-arg 0)))
2238 ad-do-it))
2239
2240 (defun js-c-fill-paragraph (&optional justify)
2241 "Fill the paragraph with `c-fill-paragraph'."
2242 (interactive "*P")
2243 (let ((js--filling-paragraph t)
2244 (fill-paragraph-function 'c-fill-paragraph))
2245 (c-fill-paragraph justify)))
2246
2247 ;;; Type database and Imenu
2248
2249 ;; We maintain a cache of semantic information, i.e., the classes and
2250 ;; functions we've encountered so far. In order to avoid having to
2251 ;; re-parse the buffer on every change, we cache the parse state at
2252 ;; each interesting point in the buffer. Each parse state is a
2253 ;; modified copy of the previous one, or in the case of the first
2254 ;; parse state, the empty state.
2255 ;;
2256 ;; The parse state itself is just a stack of js--pitem
2257 ;; instances. It starts off containing one element that is never
2258 ;; closed, that is initially js--initial-pitem.
2259 ;;
2260
2261
2262 (defun js--pitem-format (pitem)
2263 (let ((name (js--pitem-name pitem))
2264 (type (js--pitem-type pitem)))
2265
2266 (format "name:%S type:%S"
2267 name
2268 (if (atom type)
2269 type
2270 (plist-get type :name)))))
2271
2272 (defun js--make-merged-item (item child name-parts)
2273 "Helper function for `js--splice-into-items'.
2274 Return a new item that is the result of merging CHILD into
2275 ITEM. NAME-PARTS is a list of parts of the name of CHILD
2276 that we haven't consumed yet."
2277 (js--debug "js--make-merged-item: {%s} into {%s}"
2278 (js--pitem-format child)
2279 (js--pitem-format item))
2280
2281 ;; If the item we're merging into isn't a class, make it into one
2282 (unless (consp (js--pitem-type item))
2283 (js--debug "js--make-merged-item: changing dest into class")
2284 (setq item (make-js--pitem
2285 :children (list item)
2286
2287 ;; Use the child's class-style if it's available
2288 :type (if (atom (js--pitem-type child))
2289 js--dummy-class-style
2290 (js--pitem-type child))
2291
2292 :name (js--pitem-strname item))))
2293
2294 ;; Now we can merge either a function or a class into a class
2295 (cons (cond
2296 ((cdr name-parts)
2297 (js--debug "js--make-merged-item: recursing")
2298 ;; if we have more name-parts to go before we get to the
2299 ;; bottom of the class hierarchy, call the merger
2300 ;; recursively
2301 (js--splice-into-items (car item) child
2302 (cdr name-parts)))
2303
2304 ((atom (js--pitem-type child))
2305 (js--debug "js--make-merged-item: straight merge")
2306 ;; Not merging a class, but something else, so just prepend
2307 ;; it
2308 (cons child (car item)))
2309
2310 (t
2311 ;; Otherwise, merge the new child's items into those
2312 ;; of the new class
2313 (js--debug "js--make-merged-item: merging class contents")
2314 (append (car child) (car item))))
2315 (cdr item)))
2316
2317 (defun js--pitem-strname (pitem)
2318 "Last part of the name of PITEM, as a string or symbol."
2319 (let ((name (js--pitem-name pitem)))
2320 (if (consp name)
2321 (car (last name))
2322 name)))
2323
2324 (defun js--splice-into-items (items child name-parts)
2325 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2326 If a class doesn't exist in the tree, create it. Return
2327 the new items list. NAME-PARTS is a list of strings given
2328 the broken-down class name of the item to insert."
2329
2330 (let ((top-name (car name-parts))
2331 (item-ptr items)
2332 new-items last-new-item new-cons)
2333
2334 (js--debug "js--splice-into-items: name-parts: %S items:%S"
2335 name-parts
2336 (mapcar #'js--pitem-name items))
2337
2338 (cl-assert (stringp top-name))
2339 (cl-assert (> (length top-name) 0))
2340
2341 ;; If top-name isn't found in items, then we build a copy of items
2342 ;; and throw it away. But that's okay, since most of the time, we
2343 ;; *will* find an instance.
2344
2345 (while (and item-ptr
2346 (cond ((equal (js--pitem-strname (car item-ptr)) top-name)
2347 ;; Okay, we found an entry with the right name. Splice
2348 ;; the merged item into the list...
2349 (setq new-cons (cons (js--make-merged-item
2350 (car item-ptr) child
2351 name-parts)
2352 (cdr item-ptr)))
2353
2354 (if last-new-item
2355 (setcdr last-new-item new-cons)
2356 (setq new-items new-cons))
2357
2358 ;; ...and terminate the loop
2359 nil)
2360
2361 (t
2362 ;; Otherwise, copy the current cons and move onto the
2363 ;; text. This is tricky; we keep track of the tail of
2364 ;; the list that begins with new-items in
2365 ;; last-new-item.
2366 (setq new-cons (cons (car item-ptr) nil))
2367 (if last-new-item
2368 (setcdr last-new-item new-cons)
2369 (setq new-items new-cons))
2370 (setq last-new-item new-cons)
2371
2372 ;; Go to the next cell in items
2373 (setq item-ptr (cdr item-ptr))))))
2374
2375 (if item-ptr
2376 ;; Yay! We stopped because we found something, not because
2377 ;; we ran out of items to search. Just return the new
2378 ;; list.
2379 (progn
2380 (js--debug "search succeeded: %S" name-parts)
2381 new-items)
2382
2383 ;; We didn't find anything. If the child is a class and we don't
2384 ;; have any classes to drill down into, just push that class;
2385 ;; otherwise, make a fake class and carry on.
2386 (js--debug "search failed: %S" name-parts)
2387 (cons (if (cdr name-parts)
2388 ;; We have name-parts left to process. Make a fake
2389 ;; class for this particular part...
2390 (make-js--pitem
2391 ;; ...and recursively digest the rest of the name
2392 :children (js--splice-into-items
2393 nil child (cdr name-parts))
2394 :type js--dummy-class-style
2395 :name top-name)
2396
2397 ;; Otherwise, this is the only name we have, so stick
2398 ;; the item on the front of the list
2399 child)
2400 items))))
2401
2402 (defun js--pitem-add-child (pitem child)
2403 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2404 (cl-assert (integerp (js--pitem-h-begin child)))
2405 (cl-assert (if (consp (js--pitem-name child))
2406 (cl-loop for part in (js--pitem-name child)
2407 always (stringp part))
2408 t))
2409
2410 ;; This trick works because we know (based on our defstructs) that
2411 ;; the child list is always the first element, and so the second
2412 ;; element and beyond can be shared when we make our "copy".
2413 (cons
2414
2415 (let ((name (js--pitem-name child))
2416 (type (js--pitem-type child)))
2417
2418 (cond ((cdr-safe name) ; true if a list of at least two elements
2419 ;; Use slow path because we need class lookup
2420 (js--splice-into-items (car pitem) child name))
2421
2422 ((and (consp type)
2423 (plist-get type :prototype))
2424
2425 ;; Use slow path because we need class merging. We know
2426 ;; name is a list here because down in
2427 ;; `js--ensure-cache', we made sure to only add
2428 ;; class entries with lists for :name
2429 (cl-assert (consp name))
2430 (js--splice-into-items (car pitem) child name))
2431
2432 (t
2433 ;; Fast path
2434 (cons child (car pitem)))))
2435
2436 (cdr pitem)))
2437
2438 (defun js--maybe-make-marker (location)
2439 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2440 (if imenu-use-markers
2441 (set-marker (make-marker) location)
2442 location))
2443
2444 (defun js--pitems-to-imenu (pitems unknown-ctr)
2445 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2446
2447 (let (imenu-items pitem pitem-type pitem-name subitems)
2448
2449 (while (setq pitem (pop pitems))
2450 (setq pitem-type (js--pitem-type pitem))
2451 (setq pitem-name (js--pitem-strname pitem))
2452 (when (eq pitem-name t)
2453 (setq pitem-name (format "[unknown %s]"
2454 (cl-incf (car unknown-ctr)))))
2455
2456 (cond
2457 ((memq pitem-type '(function macro))
2458 (cl-assert (integerp (js--pitem-h-begin pitem)))
2459 (push (cons pitem-name
2460 (js--maybe-make-marker
2461 (js--pitem-h-begin pitem)))
2462 imenu-items))
2463
2464 ((consp pitem-type) ; class definition
2465 (setq subitems (js--pitems-to-imenu
2466 (js--pitem-children pitem)
2467 unknown-ctr))
2468 (cond (subitems
2469 (push (cons pitem-name subitems)
2470 imenu-items))
2471
2472 ((js--pitem-h-begin pitem)
2473 (cl-assert (integerp (js--pitem-h-begin pitem)))
2474 (setq subitems (list
2475 (cons "[empty]"
2476 (js--maybe-make-marker
2477 (js--pitem-h-begin pitem)))))
2478 (push (cons pitem-name subitems)
2479 imenu-items))))
2480
2481 (t (error "Unknown item type: %S" pitem-type))))
2482
2483 imenu-items))
2484
2485 (defun js--imenu-create-index ()
2486 "Return an imenu index for the current buffer."
2487 (save-excursion
2488 (save-restriction
2489 (widen)
2490 (goto-char (point-max))
2491 (js--ensure-cache)
2492 (cl-assert (or (= (point-min) (point-max))
2493 (eq js--last-parse-pos (point))))
2494 (when js--last-parse-pos
2495 (let ((state js--state-at-last-parse-pos)
2496 (unknown-ctr (cons -1 nil)))
2497
2498 ;; Make sure everything is closed
2499 (while (cdr state)
2500 (setq state
2501 (cons (js--pitem-add-child (cl-second state) (car state))
2502 (cddr state))))
2503
2504 (cl-assert (= (length state) 1))
2505
2506 ;; Convert the new-finalized state into what imenu expects
2507 (js--pitems-to-imenu
2508 (car (js--pitem-children state))
2509 unknown-ctr))))))
2510
2511 ;; Silence the compiler.
2512 (defvar which-func-imenu-joiner-function)
2513
2514 (defun js--which-func-joiner (parts)
2515 (mapconcat #'identity parts "."))
2516
2517 (defun js--imenu-to-flat (items prefix symbols)
2518 (cl-loop for item in items
2519 if (imenu--subalist-p item)
2520 do (js--imenu-to-flat
2521 (cdr item) (concat prefix (car item) ".")
2522 symbols)
2523 else
2524 do (let* ((name (concat prefix (car item)))
2525 (name2 name)
2526 (ctr 0))
2527
2528 (while (gethash name2 symbols)
2529 (setq name2 (format "%s<%d>" name (cl-incf ctr))))
2530
2531 (puthash name2 (cdr item) symbols))))
2532
2533 (defun js--get-all-known-symbols ()
2534 "Return a hash table of all JavaScript symbols.
2535 This searches all existing `js-mode' buffers. Each key is the
2536 name of a symbol (possibly disambiguated with <N>, where N > 1),
2537 and each value is a marker giving the location of that symbol."
2538 (cl-loop with symbols = (make-hash-table :test 'equal)
2539 with imenu-use-markers = t
2540 for buffer being the buffers
2541 for imenu-index = (with-current-buffer buffer
2542 (when (derived-mode-p 'js-mode)
2543 (js--imenu-create-index)))
2544 do (js--imenu-to-flat imenu-index "" symbols)
2545 finally return symbols))
2546
2547 (defvar js--symbol-history nil
2548 "History of entered JavaScript symbols.")
2549
2550 (defun js--read-symbol (symbols-table prompt &optional initial-input)
2551 "Helper function for `js-find-symbol'.
2552 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2553 one from `js--get-all-known-symbols', using prompt PROMPT and
2554 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2555 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2556 marker."
2557 (unless ido-mode
2558 (ido-mode 1)
2559 (ido-mode -1))
2560
2561 (let ((choice (ido-completing-read
2562 prompt
2563 (cl-loop for key being the hash-keys of symbols-table
2564 collect key)
2565 nil t initial-input 'js--symbol-history)))
2566 (cons choice (gethash choice symbols-table))))
2567
2568 (defun js--guess-symbol-at-point ()
2569 (let ((bounds (bounds-of-thing-at-point 'symbol)))
2570 (when bounds
2571 (save-excursion
2572 (goto-char (car bounds))
2573 (when (eq (char-before) ?.)
2574 (backward-char)
2575 (setf (car bounds) (point))))
2576 (buffer-substring (car bounds) (cdr bounds)))))
2577
2578 (defvar find-tag-marker-ring) ; etags
2579
2580 ;; etags loads ring.
2581 (declare-function ring-insert "ring" (ring item))
2582
2583 (defun js-find-symbol (&optional arg)
2584 "Read a JavaScript symbol and jump to it.
2585 With a prefix argument, restrict symbols to those from the
2586 current buffer. Pushes a mark onto the tag ring just like
2587 `find-tag'."
2588 (interactive "P")
2589 (require 'etags)
2590 (let (symbols marker)
2591 (if (not arg)
2592 (setq symbols (js--get-all-known-symbols))
2593 (setq symbols (make-hash-table :test 'equal))
2594 (js--imenu-to-flat (js--imenu-create-index)
2595 "" symbols))
2596
2597 (setq marker (cdr (js--read-symbol
2598 symbols "Jump to: "
2599 (js--guess-symbol-at-point))))
2600
2601 (ring-insert find-tag-marker-ring (point-marker))
2602 (switch-to-buffer (marker-buffer marker))
2603 (push-mark)
2604 (goto-char marker)))
2605
2606 ;;; MozRepl integration
2607
2608 (define-error 'js-moz-bad-rpc "Mozilla RPC Error") ;; '(timeout error))
2609 (define-error 'js-js-error "Javascript Error") ;; '(js-error error))
2610
2611 (defun js--wait-for-matching-output
2612 (process regexp timeout &optional start)
2613 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2614 On timeout, return nil. On success, return t with match data
2615 set. If START is non-nil, look for output starting from START.
2616 Otherwise, use the current value of `process-mark'."
2617 (with-current-buffer (process-buffer process)
2618 (cl-loop with start-pos = (or start
2619 (marker-position (process-mark process)))
2620 with end-time = (+ (float-time) timeout)
2621 for time-left = (- end-time (float-time))
2622 do (goto-char (point-max))
2623 if (looking-back regexp start-pos) return t
2624 while (> time-left 0)
2625 do (accept-process-output process time-left nil t)
2626 do (goto-char (process-mark process))
2627 finally do (signal
2628 'js-moz-bad-rpc
2629 (list (format "Timed out waiting for output matching %S" regexp))))))
2630
2631 (cl-defstruct js--js-handle
2632 ;; Integer, mirrors the value we see in JS
2633 (id nil :read-only t)
2634
2635 ;; Process to which this thing belongs
2636 (process nil :read-only t))
2637
2638 (defun js--js-handle-expired-p (x)
2639 (not (eq (js--js-handle-process x)
2640 (inferior-moz-process))))
2641
2642 (defvar js--js-references nil
2643 "Maps Elisp JavaScript proxy objects to their JavaScript IDs.")
2644
2645 (defvar js--js-process nil
2646 "The most recent MozRepl process object.")
2647
2648 (defvar js--js-gc-idle-timer nil
2649 "Idle timer for cleaning up JS object references.")
2650
2651 (defvar js--js-last-gcs-done nil)
2652
2653 (defconst js--moz-interactor
2654 (replace-regexp-in-string
2655 "[ \n]+" " "
2656 ; */" Make Emacs happy
2657 "(function(repl) {
2658 repl.defineInteractor('js', {
2659 onStart: function onStart(repl) {
2660 if(!repl._jsObjects) {
2661 repl._jsObjects = {};
2662 repl._jsLastID = 0;
2663 repl._jsGC = this._jsGC;
2664 }
2665 this._input = '';
2666 },
2667
2668 _jsGC: function _jsGC(ids_in_use) {
2669 var objects = this._jsObjects;
2670 var keys = [];
2671 var num_freed = 0;
2672
2673 for(var pn in objects) {
2674 keys.push(Number(pn));
2675 }
2676
2677 keys.sort(function(x, y) x - y);
2678 ids_in_use.sort(function(x, y) x - y);
2679 var i = 0;
2680 var j = 0;
2681
2682 while(i < ids_in_use.length && j < keys.length) {
2683 var id = ids_in_use[i++];
2684 while(j < keys.length && keys[j] !== id) {
2685 var k_id = keys[j++];
2686 delete objects[k_id];
2687 ++num_freed;
2688 }
2689 ++j;
2690 }
2691
2692 while(j < keys.length) {
2693 var k_id = keys[j++];
2694 delete objects[k_id];
2695 ++num_freed;
2696 }
2697
2698 return num_freed;
2699 },
2700
2701 _mkArray: function _mkArray() {
2702 var result = [];
2703 for(var i = 0; i < arguments.length; ++i) {
2704 result.push(arguments[i]);
2705 }
2706 return result;
2707 },
2708
2709 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2710 if(typeof parts === 'string') {
2711 parts = [ parts ];
2712 }
2713
2714 var obj = parts[0];
2715 var start = 1;
2716
2717 if(typeof obj === 'string') {
2718 obj = window;
2719 start = 0;
2720 } else if(parts.length < 2) {
2721 throw new Error('expected at least 2 arguments');
2722 }
2723
2724 for(var i = start; i < parts.length - 1; ++i) {
2725 obj = obj[parts[i]];
2726 }
2727
2728 return [obj, parts[parts.length - 1]];
2729 },
2730
2731 _getProp: function _getProp(/*...*/) {
2732 if(arguments.length === 0) {
2733 throw new Error('no arguments supplied to getprop');
2734 }
2735
2736 if(arguments.length === 1 &&
2737 (typeof arguments[0]) !== 'string')
2738 {
2739 return arguments[0];
2740 }
2741
2742 var [obj, propname] = this._parsePropDescriptor(arguments);
2743 return obj[propname];
2744 },
2745
2746 _putProp: function _putProp(properties, value) {
2747 var [obj, propname] = this._parsePropDescriptor(properties);
2748 obj[propname] = value;
2749 },
2750
2751 _delProp: function _delProp(propname) {
2752 var [obj, propname] = this._parsePropDescriptor(arguments);
2753 delete obj[propname];
2754 },
2755
2756 _typeOf: function _typeOf(thing) {
2757 return typeof thing;
2758 },
2759
2760 _callNew: function(constructor) {
2761 if(typeof constructor === 'string')
2762 {
2763 constructor = window[constructor];
2764 } else if(constructor.length === 1 &&
2765 typeof constructor[0] !== 'string')
2766 {
2767 constructor = constructor[0];
2768 } else {
2769 var [obj,propname] = this._parsePropDescriptor(constructor);
2770 constructor = obj[propname];
2771 }
2772
2773 /* Hacky, but should be robust */
2774 var s = 'new constructor(';
2775 for(var i = 1; i < arguments.length; ++i) {
2776 if(i != 1) {
2777 s += ',';
2778 }
2779
2780 s += 'arguments[' + i + ']';
2781 }
2782
2783 s += ')';
2784 return eval(s);
2785 },
2786
2787 _callEval: function(thisobj, js) {
2788 return eval.call(thisobj, js);
2789 },
2790
2791 getPrompt: function getPrompt(repl) {
2792 return 'EVAL>'
2793 },
2794
2795 _lookupObject: function _lookupObject(repl, id) {
2796 if(typeof id === 'string') {
2797 switch(id) {
2798 case 'global':
2799 return window;
2800 case 'nil':
2801 return null;
2802 case 't':
2803 return true;
2804 case 'false':
2805 return false;
2806 case 'undefined':
2807 return undefined;
2808 case 'repl':
2809 return repl;
2810 case 'interactor':
2811 return this;
2812 case 'NaN':
2813 return NaN;
2814 case 'Infinity':
2815 return Infinity;
2816 case '-Infinity':
2817 return -Infinity;
2818 default:
2819 throw new Error('No object with special id:' + id);
2820 }
2821 }
2822
2823 var ret = repl._jsObjects[id];
2824 if(ret === undefined) {
2825 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2826 }
2827 return ret;
2828 },
2829
2830 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2831 if(typeof value !== 'object' && typeof value !== 'function') {
2832 throw new Error('_findOrAllocateObject called on non-object('
2833 + typeof(value) + '): '
2834 + value)
2835 }
2836
2837 for(var id in repl._jsObjects) {
2838 id = Number(id);
2839 var obj = repl._jsObjects[id];
2840 if(obj === value) {
2841 return id;
2842 }
2843 }
2844
2845 var id = ++repl._jsLastID;
2846 repl._jsObjects[id] = value;
2847 return id;
2848 },
2849
2850 _fixupList: function _fixupList(repl, list) {
2851 for(var i = 0; i < list.length; ++i) {
2852 if(list[i] instanceof Array) {
2853 this._fixupList(repl, list[i]);
2854 } else if(typeof list[i] === 'object') {
2855 var obj = list[i];
2856 if(obj.funcall) {
2857 var parts = obj.funcall;
2858 this._fixupList(repl, parts);
2859 var [thisobj, func] = this._parseFunc(parts[0]);
2860 list[i] = func.apply(thisobj, parts.slice(1));
2861 } else if(obj.objid) {
2862 list[i] = this._lookupObject(repl, obj.objid);
2863 } else {
2864 throw new Error('Unknown object type: ' + obj.toSource());
2865 }
2866 }
2867 }
2868 },
2869
2870 _parseFunc: function(func) {
2871 var thisobj = null;
2872
2873 if(typeof func === 'string') {
2874 func = window[func];
2875 } else if(func instanceof Array) {
2876 if(func.length === 1 && typeof func[0] !== 'string') {
2877 func = func[0];
2878 } else {
2879 [thisobj, func] = this._parsePropDescriptor(func);
2880 func = thisobj[func];
2881 }
2882 }
2883
2884 return [thisobj,func];
2885 },
2886
2887 _encodeReturn: function(value, array_as_mv) {
2888 var ret;
2889
2890 if(value === null) {
2891 ret = ['special', 'null'];
2892 } else if(value === true) {
2893 ret = ['special', 'true'];
2894 } else if(value === false) {
2895 ret = ['special', 'false'];
2896 } else if(value === undefined) {
2897 ret = ['special', 'undefined'];
2898 } else if(typeof value === 'number') {
2899 if(isNaN(value)) {
2900 ret = ['special', 'NaN'];
2901 } else if(value === Infinity) {
2902 ret = ['special', 'Infinity'];
2903 } else if(value === -Infinity) {
2904 ret = ['special', '-Infinity'];
2905 } else {
2906 ret = ['atom', value];
2907 }
2908 } else if(typeof value === 'string') {
2909 ret = ['atom', value];
2910 } else if(array_as_mv && value instanceof Array) {
2911 ret = ['array', value.map(this._encodeReturn, this)];
2912 } else {
2913 ret = ['objid', this._findOrAllocateObject(repl, value)];
2914 }
2915
2916 return ret;
2917 },
2918
2919 _handleInputLine: function _handleInputLine(repl, line) {
2920 var ret;
2921 var array_as_mv = false;
2922
2923 try {
2924 if(line[0] === '*') {
2925 array_as_mv = true;
2926 line = line.substring(1);
2927 }
2928 var parts = eval(line);
2929 this._fixupList(repl, parts);
2930 var [thisobj, func] = this._parseFunc(parts[0]);
2931 ret = this._encodeReturn(
2932 func.apply(thisobj, parts.slice(1)),
2933 array_as_mv);
2934 } catch(x) {
2935 ret = ['error', x.toString() ];
2936 }
2937
2938 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2939 repl.print(JSON.encode(ret));
2940 repl._prompt();
2941 },
2942
2943 handleInput: function handleInput(repl, chunk) {
2944 this._input += chunk;
2945 var match, line;
2946 while(match = this._input.match(/.*\\n/)) {
2947 line = match[0];
2948
2949 if(line === 'EXIT\\n') {
2950 repl.popInteractor();
2951 repl._prompt();
2952 return;
2953 }
2954
2955 this._input = this._input.substring(line.length);
2956 this._handleInputLine(repl, line);
2957 }
2958 }
2959 });
2960 })
2961 ")
2962
2963 "String to set MozRepl up into a simple-minded evaluation mode.")
2964
2965 (defun js--js-encode-value (x)
2966 "Marshall the given value for JS.
2967 Strings and numbers are JSON-encoded. Lists (including nil) are
2968 made into JavaScript array literals and their contents encoded
2969 with `js--js-encode-value'."
2970 (cond ((stringp x) (json-encode-string x))
2971 ((numberp x) (json-encode-number x))
2972 ((symbolp x) (format "{objid:%S}" (symbol-name x)))
2973 ((js--js-handle-p x)
2974
2975 (when (js--js-handle-expired-p x)
2976 (error "Stale JS handle"))
2977
2978 (format "{objid:%s}" (js--js-handle-id x)))
2979
2980 ((sequencep x)
2981 (if (eq (car-safe x) 'js--funcall)
2982 (format "{funcall:[%s]}"
2983 (mapconcat #'js--js-encode-value (cdr x) ","))
2984 (concat
2985 "[" (mapconcat #'js--js-encode-value x ",") "]")))
2986 (t
2987 (error "Unrecognized item: %S" x))))
2988
2989 (defconst js--js-prompt-regexp "\\(repl[0-9]*\\)> $")
2990 (defconst js--js-repl-prompt-regexp "^EVAL>$")
2991 (defvar js--js-repl-depth 0)
2992
2993 (defun js--js-wait-for-eval-prompt ()
2994 (js--wait-for-matching-output
2995 (inferior-moz-process)
2996 js--js-repl-prompt-regexp js-js-timeout
2997
2998 ;; start matching against the beginning of the line in
2999 ;; order to catch a prompt that's only partially arrived
3000 (save-excursion (forward-line 0) (point))))
3001
3002 ;; Presumably "inferior-moz-process" loads comint.
3003 (declare-function comint-send-string "comint" (process string))
3004 (declare-function comint-send-input "comint"
3005 (&optional no-newline artificial))
3006
3007 (defun js--js-enter-repl ()
3008 (inferior-moz-process) ; called for side-effect
3009 (with-current-buffer inferior-moz-buffer
3010 (goto-char (point-max))
3011
3012 ;; Do some initialization the first time we see a process
3013 (unless (eq (inferior-moz-process) js--js-process)
3014 (setq js--js-process (inferior-moz-process))
3015 (setq js--js-references (make-hash-table :test 'eq :weakness t))
3016 (setq js--js-repl-depth 0)
3017
3018 ;; Send interactor definition
3019 (comint-send-string js--js-process js--moz-interactor)
3020 (comint-send-string js--js-process
3021 (concat "(" moz-repl-name ")\n"))
3022 (js--wait-for-matching-output
3023 (inferior-moz-process) js--js-prompt-regexp
3024 js-js-timeout))
3025
3026 ;; Sanity check
3027 (when (looking-back js--js-prompt-regexp
3028 (save-excursion (forward-line 0) (point)))
3029 (setq js--js-repl-depth 0))
3030
3031 (if (> js--js-repl-depth 0)
3032 ;; If js--js-repl-depth > 0, we *should* be seeing an
3033 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
3034 ;; up with us.
3035 (js--js-wait-for-eval-prompt)
3036
3037 ;; Otherwise, tell Mozilla to enter the interactor mode
3038 (insert (match-string-no-properties 1)
3039 ".pushInteractor('js')")
3040 (comint-send-input nil t)
3041 (js--wait-for-matching-output
3042 (inferior-moz-process) js--js-repl-prompt-regexp
3043 js-js-timeout))
3044
3045 (cl-incf js--js-repl-depth)))
3046
3047 (defun js--js-leave-repl ()
3048 (cl-assert (> js--js-repl-depth 0))
3049 (when (= 0 (cl-decf js--js-repl-depth))
3050 (with-current-buffer inferior-moz-buffer
3051 (goto-char (point-max))
3052 (js--js-wait-for-eval-prompt)
3053 (insert "EXIT")
3054 (comint-send-input nil t)
3055 (js--wait-for-matching-output
3056 (inferior-moz-process) js--js-prompt-regexp
3057 js-js-timeout))))
3058
3059 (defsubst js--js-not (value)
3060 (memq value '(nil null false undefined)))
3061
3062 (defsubst js--js-true (value)
3063 (not (js--js-not value)))
3064
3065 (eval-and-compile
3066 (defun js--optimize-arglist (arglist)
3067 "Convert immediate js< and js! references to deferred ones."
3068 (cl-loop for item in arglist
3069 if (eq (car-safe item) 'js<)
3070 collect (append (list 'list ''js--funcall
3071 '(list 'interactor "_getProp"))
3072 (js--optimize-arglist (cdr item)))
3073 else if (eq (car-safe item) 'js>)
3074 collect (append (list 'list ''js--funcall
3075 '(list 'interactor "_putProp"))
3076
3077 (if (atom (cadr item))
3078 (list (cadr item))
3079 (list
3080 (append
3081 (list 'list ''js--funcall
3082 '(list 'interactor "_mkArray"))
3083 (js--optimize-arglist (cadr item)))))
3084 (js--optimize-arglist (cddr item)))
3085 else if (eq (car-safe item) 'js!)
3086 collect (pcase-let ((`(,_ ,function . ,body) item))
3087 (append (list 'list ''js--funcall
3088 (if (consp function)
3089 (cons 'list
3090 (js--optimize-arglist function))
3091 function))
3092 (js--optimize-arglist body)))
3093 else
3094 collect item)))
3095
3096 (defmacro js--js-get-service (class-name interface-name)
3097 `(js! ("Components" "classes" ,class-name "getService")
3098 (js< "Components" "interfaces" ,interface-name)))
3099
3100 (defmacro js--js-create-instance (class-name interface-name)
3101 `(js! ("Components" "classes" ,class-name "createInstance")
3102 (js< "Components" "interfaces" ,interface-name)))
3103
3104 (defmacro js--js-qi (object interface-name)
3105 `(js! (,object "QueryInterface")
3106 (js< "Components" "interfaces" ,interface-name)))
3107
3108 (defmacro with-js (&rest forms)
3109 "Run FORMS with the Mozilla repl set up for js commands.
3110 Inside the lexical scope of `with-js', `js?', `js!',
3111 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
3112 `js-create-instance', and `js-qi' are defined."
3113
3114 `(progn
3115 (js--js-enter-repl)
3116 (unwind-protect
3117 (cl-macrolet ((js? (&rest body) `(js--js-true ,@body))
3118 (js! (function &rest body)
3119 `(js--js-funcall
3120 ,(if (consp function)
3121 (cons 'list
3122 (js--optimize-arglist function))
3123 function)
3124 ,@(js--optimize-arglist body)))
3125
3126 (js-new (function &rest body)
3127 `(js--js-new
3128 ,(if (consp function)
3129 (cons 'list
3130 (js--optimize-arglist function))
3131 function)
3132 ,@body))
3133
3134 (js-eval (thisobj js)
3135 `(js--js-eval
3136 ,@(js--optimize-arglist
3137 (list thisobj js))))
3138
3139 (js-list (&rest args)
3140 `(js--js-list
3141 ,@(js--optimize-arglist args)))
3142
3143 (js-get-service (&rest args)
3144 `(js--js-get-service
3145 ,@(js--optimize-arglist args)))
3146
3147 (js-create-instance (&rest args)
3148 `(js--js-create-instance
3149 ,@(js--optimize-arglist args)))
3150
3151 (js-qi (&rest args)
3152 `(js--js-qi
3153 ,@(js--optimize-arglist args)))
3154
3155 (js< (&rest body) `(js--js-get
3156 ,@(js--optimize-arglist body)))
3157 (js> (props value)
3158 `(js--js-funcall
3159 '(interactor "_putProp")
3160 ,(if (consp props)
3161 (cons 'list
3162 (js--optimize-arglist props))
3163 props)
3164 ,@(js--optimize-arglist (list value))
3165 ))
3166 (js-handle? (arg) `(js--js-handle-p ,arg)))
3167 ,@forms)
3168 (js--js-leave-repl))))
3169
3170 (defvar js--js-array-as-list nil
3171 "Whether to listify any Array returned by a Mozilla function.
3172 If nil, the whole Array is treated as a JS symbol.")
3173
3174 (defun js--js-decode-retval (result)
3175 (pcase (intern (cl-first result))
3176 (`atom (cl-second result))
3177 (`special (intern (cl-second result)))
3178 (`array
3179 (mapcar #'js--js-decode-retval (cl-second result)))
3180 (`objid
3181 (or (gethash (cl-second result)
3182 js--js-references)
3183 (puthash (cl-second result)
3184 (make-js--js-handle
3185 :id (cl-second result)
3186 :process (inferior-moz-process))
3187 js--js-references)))
3188
3189 (`error (signal 'js-js-error (list (cl-second result))))
3190 (x (error "Unmatched case in js--js-decode-retval: %S" x))))
3191
3192 (defvar comint-last-input-end)
3193
3194 (defun js--js-funcall (function &rest arguments)
3195 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
3196 If function is a string, look it up as a property on the global
3197 object and use the global object for `this'.
3198 If FUNCTION is a list with one element, use that element as the
3199 function with the global object for `this', except that if that
3200 single element is a string, look it up on the global object.
3201 If FUNCTION is a list with more than one argument, use the list
3202 up to the last value as a property descriptor and the last
3203 argument as a function."
3204
3205 (with-js
3206 (let ((argstr (js--js-encode-value
3207 (cons function arguments))))
3208
3209 (with-current-buffer inferior-moz-buffer
3210 ;; Actual funcall
3211 (when js--js-array-as-list
3212 (insert "*"))
3213 (insert argstr)
3214 (comint-send-input nil t)
3215 (js--wait-for-matching-output
3216 (inferior-moz-process) "EVAL>"
3217 js-js-timeout)
3218 (goto-char comint-last-input-end)
3219
3220 ;; Read the result
3221 (let* ((json-array-type 'list)
3222 (result (prog1 (json-read)
3223 (goto-char (point-max)))))
3224 (js--js-decode-retval result))))))
3225
3226 (defun js--js-new (constructor &rest arguments)
3227 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
3228 CONSTRUCTOR is a JS handle, a string, or a list of these things."
3229 (apply #'js--js-funcall
3230 '(interactor "_callNew")
3231 constructor arguments))
3232
3233 (defun js--js-eval (thisobj js)
3234 (js--js-funcall '(interactor "_callEval") thisobj js))
3235
3236 (defun js--js-list (&rest arguments)
3237 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
3238 (let ((js--js-array-as-list t))
3239 (apply #'js--js-funcall '(interactor "_mkArray")
3240 arguments)))
3241
3242 (defun js--js-get (&rest props)
3243 (apply #'js--js-funcall '(interactor "_getProp") props))
3244
3245 (defun js--js-put (props value)
3246 (js--js-funcall '(interactor "_putProp") props value))
3247
3248 (defun js-gc (&optional force)
3249 "Tell the repl about any objects we don't reference anymore.
3250 With argument, run even if no intervening GC has happened."
3251 (interactive)
3252
3253 (when force
3254 (setq js--js-last-gcs-done nil))
3255
3256 (let ((this-gcs-done gcs-done) keys num)
3257 (when (and js--js-references
3258 (boundp 'inferior-moz-buffer)
3259 (buffer-live-p inferior-moz-buffer)
3260
3261 ;; Don't bother running unless we've had an intervening
3262 ;; garbage collection; without a gc, nothing is deleted
3263 ;; from the weak hash table, so it's pointless telling
3264 ;; MozRepl about that references we still hold
3265 (not (eq js--js-last-gcs-done this-gcs-done))
3266
3267 ;; Are we looking at a normal prompt? Make sure not to
3268 ;; interrupt the user if he's doing something
3269 (with-current-buffer inferior-moz-buffer
3270 (save-excursion
3271 (goto-char (point-max))
3272 (looking-back js--js-prompt-regexp
3273 (save-excursion (forward-line 0) (point))))))
3274
3275 (setq keys (cl-loop for x being the hash-keys
3276 of js--js-references
3277 collect x))
3278 (setq num (js--js-funcall '(repl "_jsGC") (or keys [])))
3279
3280 (setq js--js-last-gcs-done this-gcs-done)
3281 (when (called-interactively-p 'interactive)
3282 (message "Cleaned %s entries" num))
3283
3284 num)))
3285
3286 (run-with-idle-timer 30 t #'js-gc)
3287
3288 (defun js-eval (js)
3289 "Evaluate the JavaScript in JS and return JSON-decoded result."
3290 (interactive "MJavascript to evaluate: ")
3291 (with-js
3292 (let* ((content-window (js--js-content-window
3293 (js--get-js-context)))
3294 (result (js-eval content-window js)))
3295 (when (called-interactively-p 'interactive)
3296 (message "%s" (js! "String" result)))
3297 result)))
3298
3299 (defun js--get-tabs ()
3300 "Enumerate all JavaScript contexts available.
3301 Each context is a list:
3302 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3303 (TITLE URL WINDOW) for windows
3304
3305 All tabs of a given window are grouped together. The most recent
3306 window is first. Within each window, the tabs are returned
3307 left-to-right."
3308 (with-js
3309 (let (windows)
3310
3311 (cl-loop with window-mediator = (js! ("Components" "classes"
3312 "@mozilla.org/appshell/window-mediator;1"
3313 "getService")
3314 (js< "Components" "interfaces"
3315 "nsIWindowMediator"))
3316 with enumerator = (js! (window-mediator "getEnumerator") nil)
3317
3318 while (js? (js! (enumerator "hasMoreElements")))
3319 for window = (js! (enumerator "getNext"))
3320 for window-info = (js-list window
3321 (js< window "document" "title")
3322 (js! (window "location" "toString"))
3323 (js< window "closed")
3324 (js< window "windowState"))
3325
3326 unless (or (js? (cl-fourth window-info))
3327 (eq (cl-fifth window-info) 2))
3328 do (push window-info windows))
3329
3330 (cl-loop for window-info in windows
3331 for window = (cl-first window-info)
3332 collect (list (cl-second window-info)
3333 (cl-third window-info)
3334 window)
3335
3336 for gbrowser = (js< window "gBrowser")
3337 if (js-handle? gbrowser)
3338 nconc (cl-loop
3339 for x below (js< gbrowser "browsers" "length")
3340 collect (js-list (js< gbrowser
3341 "browsers"
3342 x
3343 "contentDocument"
3344 "title")
3345
3346 (js! (gbrowser
3347 "browsers"
3348 x
3349 "contentWindow"
3350 "location"
3351 "toString"))
3352 (js< gbrowser
3353 "browsers"
3354 x)
3355
3356 (js! (gbrowser
3357 "tabContainer"
3358 "childNodes"
3359 "item")
3360 x)
3361
3362 gbrowser))))))
3363
3364 (defvar js-read-tab-history nil)
3365
3366 (declare-function ido-chop "ido" (items elem))
3367
3368 (defun js--read-tab (prompt)
3369 "Read a Mozilla tab with prompt PROMPT.
3370 Return a cons of (TYPE . OBJECT). TYPE is either `window' or
3371 `tab', and OBJECT is a JavaScript handle to a ChromeWindow or a
3372 browser, respectively."
3373
3374 ;; Prime IDO
3375 (unless ido-mode
3376 (ido-mode 1)
3377 (ido-mode -1))
3378
3379 (with-js
3380 (let ((tabs (js--get-tabs)) selected-tab-cname
3381 selected-tab prev-hitab)
3382
3383 ;; Disambiguate names
3384 (setq tabs
3385 (cl-loop with tab-names = (make-hash-table :test 'equal)
3386 for tab in tabs
3387 for cname = (format "%s (%s)"
3388 (cl-second tab) (cl-first tab))
3389 for num = (cl-incf (gethash cname tab-names -1))
3390 if (> num 0)
3391 do (setq cname (format "%s <%d>" cname num))
3392 collect (cons cname tab)))
3393
3394 (cl-labels
3395 ((find-tab-by-cname
3396 (cname)
3397 (cl-loop for tab in tabs
3398 if (equal (car tab) cname)
3399 return (cdr tab)))
3400
3401 (mogrify-highlighting
3402 (hitab unhitab)
3403
3404 ;; Hack to reduce the number of
3405 ;; round-trips to mozilla
3406 (let (cmds)
3407 (cond
3408 ;; Highlighting tab
3409 ((cl-fourth hitab)
3410 (push '(js! ((cl-fourth hitab) "setAttribute")
3411 "style"
3412 "color: red; font-weight: bold")
3413 cmds)
3414
3415 ;; Highlight window proper
3416 (push '(js! ((cl-third hitab)
3417 "setAttribute")
3418 "style"
3419 "border: 8px solid red")
3420 cmds)
3421
3422 ;; Select tab, when appropriate
3423 (when js-js-switch-tabs
3424 (push
3425 '(js> ((cl-fifth hitab) "selectedTab") (cl-fourth hitab))
3426 cmds)))
3427
3428 ;; Highlighting whole window
3429 ((cl-third hitab)
3430 (push '(js! ((cl-third hitab) "document"
3431 "documentElement" "setAttribute")
3432 "style"
3433 (concat "-moz-appearance: none;"
3434 "border: 8px solid red;"))
3435 cmds)))
3436
3437 (cond
3438 ;; Unhighlighting tab
3439 ((cl-fourth unhitab)
3440 (push '(js! ((cl-fourth unhitab) "setAttribute") "style" "")
3441 cmds)
3442 (push '(js! ((cl-third unhitab) "setAttribute") "style" "")
3443 cmds))
3444
3445 ;; Unhighlighting window
3446 ((cl-third unhitab)
3447 (push '(js! ((cl-third unhitab) "document"
3448 "documentElement" "setAttribute")
3449 "style" "")
3450 cmds)))
3451
3452 (eval (list 'with-js
3453 (cons 'js-list (nreverse cmds))))))
3454
3455 (command-hook
3456 ()
3457 (let* ((tab (find-tab-by-cname (car ido-matches))))
3458 (mogrify-highlighting tab prev-hitab)
3459 (setq prev-hitab tab)))
3460
3461 (setup-hook
3462 ()
3463 ;; Fiddle with the match list a bit: if our first match
3464 ;; is a tabbrowser window, rotate the match list until
3465 ;; the active tab comes up
3466 (let ((matched-tab (find-tab-by-cname (car ido-matches))))
3467 (when (and matched-tab
3468 (null (cl-fourth matched-tab))
3469 (equal "navigator:browser"
3470 (js! ((cl-third matched-tab)
3471 "document"
3472 "documentElement"
3473 "getAttribute")
3474 "windowtype")))
3475
3476 (cl-loop with tab-to-match = (js< (cl-third matched-tab)
3477 "gBrowser"
3478 "selectedTab")
3479
3480 for match in ido-matches
3481 for candidate-tab = (find-tab-by-cname match)
3482 if (eq (cl-fourth candidate-tab) tab-to-match)
3483 do (setq ido-cur-list
3484 (ido-chop ido-cur-list match))
3485 and return t)))
3486
3487 (add-hook 'post-command-hook #'command-hook t t)))
3488
3489
3490 (unwind-protect
3491 (setq selected-tab-cname
3492 (let ((ido-minibuffer-setup-hook
3493 (cons #'setup-hook ido-minibuffer-setup-hook)))
3494 (ido-completing-read
3495 prompt
3496 (mapcar #'car tabs)
3497 nil t nil
3498 'js-read-tab-history)))
3499
3500 (when prev-hitab
3501 (mogrify-highlighting nil prev-hitab)
3502 (setq prev-hitab nil)))
3503
3504 (add-to-history 'js-read-tab-history selected-tab-cname)
3505
3506 (setq selected-tab (cl-loop for tab in tabs
3507 if (equal (car tab) selected-tab-cname)
3508 return (cdr tab)))
3509
3510 (cons (if (cl-fourth selected-tab) 'browser 'window)
3511 (cl-third selected-tab))))))
3512
3513 (defun js--guess-eval-defun-info (pstate)
3514 "Helper function for `js-eval-defun'.
3515 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3516 strings making up the class name and NAME is the name of the
3517 function part."
3518 (cond ((and (= (length pstate) 3)
3519 (eq (js--pitem-type (cl-first pstate)) 'function)
3520 (= (length (js--pitem-name (cl-first pstate))) 1)
3521 (consp (js--pitem-type (cl-second pstate))))
3522
3523 (append (js--pitem-name (cl-second pstate))
3524 (list (cl-first (js--pitem-name (cl-first pstate))))))
3525
3526 ((and (= (length pstate) 2)
3527 (eq (js--pitem-type (cl-first pstate)) 'function))
3528
3529 (append
3530 (butlast (js--pitem-name (cl-first pstate)))
3531 (list (car (last (js--pitem-name (cl-first pstate)))))))
3532
3533 (t (error "Function not a toplevel defun or class member"))))
3534
3535 (defvar js--js-context nil
3536 "The current JavaScript context.
3537 This is a cons like the one returned from `js--read-tab'.
3538 Change with `js-set-js-context'.")
3539
3540 (defconst js--js-inserter
3541 "(function(func_info,func) {
3542 func_info.unshift('window');
3543 var obj = window;
3544 for(var i = 1; i < func_info.length - 1; ++i) {
3545 var next = obj[func_info[i]];
3546 if(typeof next !== 'object' && typeof next !== 'function') {
3547 next = obj.prototype && obj.prototype[func_info[i]];
3548 if(typeof next !== 'object' && typeof next !== 'function') {
3549 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3550 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3551 return;
3552 }
3553
3554 func_info.splice(i+1, 0, 'prototype');
3555 ++i;
3556 }
3557 }
3558
3559 obj[func_info[i]] = func;
3560 alert('Successfully updated '+func_info.join('.'));
3561 })")
3562
3563 (defun js-set-js-context (context)
3564 "Set the JavaScript context to CONTEXT.
3565 When called interactively, prompt for CONTEXT."
3566 (interactive (list (js--read-tab "Javascript Context: ")))
3567 (setq js--js-context context))
3568
3569 (defun js--get-js-context ()
3570 "Return a valid JavaScript context.
3571 If one hasn't been set, or if it's stale, prompt for a new one."
3572 (with-js
3573 (when (or (null js--js-context)
3574 (js--js-handle-expired-p (cdr js--js-context))
3575 (pcase (car js--js-context)
3576 (`window (js? (js< (cdr js--js-context) "closed")))
3577 (`browser (not (js? (js< (cdr js--js-context)
3578 "contentDocument"))))
3579 (x (error "Unmatched case in js--get-js-context: %S" x))))
3580 (setq js--js-context (js--read-tab "Javascript Context: ")))
3581 js--js-context))
3582
3583 (defun js--js-content-window (context)
3584 (with-js
3585 (pcase (car context)
3586 (`window (cdr context))
3587 (`browser (js< (cdr context)
3588 "contentWindow" "wrappedJSObject"))
3589 (x (error "Unmatched case in js--js-content-window: %S" x)))))
3590
3591 (defun js--make-nsilocalfile (path)
3592 (with-js
3593 (let ((file (js-create-instance "@mozilla.org/file/local;1"
3594 "nsILocalFile")))
3595 (js! (file "initWithPath") path)
3596 file)))
3597
3598 (defun js--js-add-resource-alias (alias path)
3599 (with-js
3600 (let* ((io-service (js-get-service "@mozilla.org/network/io-service;1"
3601 "nsIIOService"))
3602 (res-prot (js! (io-service "getProtocolHandler") "resource"))
3603 (res-prot (js-qi res-prot "nsIResProtocolHandler"))
3604 (path-file (js--make-nsilocalfile path))
3605 (path-uri (js! (io-service "newFileURI") path-file)))
3606 (js! (res-prot "setSubstitution") alias path-uri))))
3607
3608 (cl-defun js-eval-defun ()
3609 "Update a Mozilla tab using the JavaScript defun at point."
3610 (interactive)
3611
3612 ;; This function works by generating a temporary file that contains
3613 ;; the function we'd like to insert. We then use the elisp-js bridge
3614 ;; to command mozilla to load this file by inserting a script tag
3615 ;; into the document we set. This way, debuggers and such will have
3616 ;; a way to find the source of the just-inserted function.
3617 ;;
3618 ;; We delete the temporary file if there's an error, but otherwise
3619 ;; we add an unload event listener on the Mozilla side to delete the
3620 ;; file.
3621
3622 (save-excursion
3623 (let (begin end pstate defun-info temp-name defun-body)
3624 (js-end-of-defun)
3625 (setq end (point))
3626 (js--ensure-cache)
3627 (js-beginning-of-defun)
3628 (re-search-forward "\\_<function\\_>")
3629 (setq begin (match-beginning 0))
3630 (setq pstate (js--forward-pstate))
3631
3632 (when (or (null pstate)
3633 (> (point) end))
3634 (error "Could not locate function definition"))
3635
3636 (setq defun-info (js--guess-eval-defun-info pstate))
3637
3638 (let ((overlay (make-overlay begin end)))
3639 (overlay-put overlay 'face 'highlight)
3640 (unwind-protect
3641 (unless (y-or-n-p (format "Send %s to Mozilla? "
3642 (mapconcat #'identity defun-info ".")))
3643 (message "") ; question message lingers until next command
3644 (cl-return-from js-eval-defun))
3645 (delete-overlay overlay)))
3646
3647 (setq defun-body (buffer-substring-no-properties begin end))
3648
3649 (make-directory js-js-tmpdir t)
3650
3651 ;; (Re)register a Mozilla resource URL to point to the
3652 ;; temporary directory
3653 (js--js-add-resource-alias "js" js-js-tmpdir)
3654
3655 (setq temp-name (make-temp-file (concat js-js-tmpdir
3656 "/js-")
3657 nil ".js"))
3658 (unwind-protect
3659 (with-js
3660 (with-temp-buffer
3661 (insert js--js-inserter)
3662 (insert "(")
3663 (insert (json-encode-list defun-info))
3664 (insert ",\n")
3665 (insert defun-body)
3666 (insert "\n)")
3667 (write-region (point-min) (point-max) temp-name
3668 nil 1))
3669
3670 ;; Give Mozilla responsibility for deleting this file
3671 (let* ((content-window (js--js-content-window
3672 (js--get-js-context)))
3673 (content-document (js< content-window "document"))
3674 (head (if (js? (js< content-document "body"))
3675 ;; Regular content
3676 (js< (js! (content-document "getElementsByTagName")
3677 "head")
3678 0)
3679 ;; Chrome
3680 (js< content-document "documentElement")))
3681 (elem (js! (content-document "createElementNS")
3682 "http://www.w3.org/1999/xhtml" "script")))
3683
3684 (js! (elem "setAttribute") "type" "text/javascript")
3685 (js! (elem "setAttribute") "src"
3686 (format "resource://js/%s"
3687 (file-name-nondirectory temp-name)))
3688
3689 (js! (head "appendChild") elem)
3690
3691 (js! (content-window "addEventListener") "unload"
3692 (js! ((js-new
3693 "Function" "file"
3694 "return function() { file.remove(false) }"))
3695 (js--make-nsilocalfile temp-name))
3696 'false)
3697 (setq temp-name nil)
3698
3699
3700
3701 ))
3702
3703 ;; temp-name is set to nil on success
3704 (when temp-name
3705 (delete-file temp-name))))))
3706
3707 ;;; Main Function
3708
3709 ;;;###autoload
3710 (define-derived-mode js-mode prog-mode "JavaScript"
3711 "Major mode for editing JavaScript."
3712 :group 'js
3713 (setq-local indent-line-function 'js-indent-line)
3714 (setq-local beginning-of-defun-function 'js-beginning-of-defun)
3715 (setq-local end-of-defun-function 'js-end-of-defun)
3716 (setq-local open-paren-in-column-0-is-defun-start nil)
3717 (setq-local font-lock-defaults (list js--font-lock-keywords))
3718 (setq-local syntax-propertize-function #'js-syntax-propertize)
3719 (setq-local prettify-symbols-alist js--prettify-symbols-alist)
3720
3721 (setq-local parse-sexp-ignore-comments t)
3722 (setq-local parse-sexp-lookup-properties t)
3723 (setq-local which-func-imenu-joiner-function #'js--which-func-joiner)
3724
3725 ;; Comments
3726 (setq-local comment-start "// ")
3727 (setq-local comment-end "")
3728 (setq-local fill-paragraph-function 'js-c-fill-paragraph)
3729
3730 ;; Parse cache
3731 (add-hook 'before-change-functions #'js--flush-caches t t)
3732
3733 ;; Frameworks
3734 (js--update-quick-match-re)
3735
3736 ;; Imenu
3737 (setq imenu-case-fold-search nil)
3738 (setq imenu-create-index-function #'js--imenu-create-index)
3739
3740 ;; for filling, pretend we're cc-mode
3741 (setq c-comment-prefix-regexp "//+\\|\\**"
3742 c-paragraph-start "\\(@[[:alpha:]]+\\>\\|$\\)"
3743 c-paragraph-separate "$"
3744 c-block-comment-prefix "* "
3745 c-line-comment-starter "//"
3746 c-comment-start-regexp "/[*/]\\|\\s!"
3747 comment-start-skip "\\(//+\\|/\\*+\\)\\s *")
3748
3749 (setq-local electric-indent-chars
3750 (append "{}():;," electric-indent-chars)) ;FIXME: js2-mode adds "[]*".
3751 (setq-local electric-layout-rules
3752 '((?\; . after) (?\{ . after) (?\} . before)))
3753
3754 (let ((c-buffer-is-cc-mode t))
3755 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3756 ;; we call it instead? (Bug#6071)
3757 (make-local-variable 'paragraph-start)
3758 (make-local-variable 'paragraph-separate)
3759 (make-local-variable 'paragraph-ignore-fill-prefix)
3760 (make-local-variable 'adaptive-fill-mode)
3761 (make-local-variable 'adaptive-fill-regexp)
3762 (c-setup-paragraph-variables))
3763
3764 ;; Important to fontify the whole buffer syntactically! If we don't,
3765 ;; then we might have regular expression literals that aren't marked
3766 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3767 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3768 ;; When we attempt to find the error and scroll to the portion of
3769 ;; the buffer containing the problem, JIT-lock will apply the
3770 ;; correct syntax to the regular expression literal and the problem
3771 ;; will mysteriously disappear.
3772 ;; FIXME: We should instead do this fontification lazily by adding
3773 ;; calls to syntax-propertize wherever it's really needed.
3774 ;;(syntax-propertize (point-max))
3775 )
3776
3777 ;;;###autoload
3778 (define-derived-mode js-jsx-mode js-mode "JSX"
3779 "Major mode for editing JSX.
3780
3781 To customize the indentation for this mode, set the SGML offset
3782 variables (`sgml-basic-offset', `sgml-attribute-offset' et al.)
3783 locally, like so:
3784
3785 (defun set-jsx-indentation ()
3786 (setq-local sgml-basic-offset js-indent-level))
3787 (add-hook \\='js-jsx-mode-hook #\\='set-jsx-indentation)"
3788 :group 'js
3789 (setq-local indent-line-function #'js-jsx-indent-line))
3790
3791 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3792
3793 (eval-after-load 'folding
3794 '(when (fboundp 'folding-add-to-marks-list)
3795 (folding-add-to-marks-list 'js-mode "// {{{" "// }}}" )))
3796
3797 ;;;###autoload
3798 (dolist (name (list "node" "nodejs" "gjs" "rhino"))
3799 (add-to-list 'interpreter-mode-alist (cons (purecopy name) 'js-mode)))
3800
3801 (provide 'js)
3802
3803 ;; js.el ends here