]> code.delx.au - gnu-emacs/blob - lisp/progmodes/js.el
Fix docstring quoting problems with ‘ '’
[gnu-emacs] / lisp / progmodes / js.el
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
2
3 ;; Copyright (C) 2008-2015 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 (not (js--end-of-do-while-loop-p))))
1827 (save-excursion
1828 (goto-char (match-beginning 0))
1829 (+ (current-indentation) js-indent-level)))))
1830
1831 (defun js--get-c-offset (symbol anchor)
1832 (let ((c-offsets-alist
1833 (list (cons 'c js-comment-lineup-func))))
1834 (c-get-syntactic-indentation (list (cons symbol anchor)))))
1835
1836 (defun js--same-line (pos)
1837 (and (>= pos (point-at-bol))
1838 (<= pos (point-at-eol))))
1839
1840 (defun js--multi-line-declaration-indentation ()
1841 "Helper function for `js--proper-indentation'.
1842 Return the proper indentation of the current line if it belongs to a declaration
1843 statement spanning multiple lines; otherwise, return nil."
1844 (let (at-opening-bracket)
1845 (save-excursion
1846 (back-to-indentation)
1847 (when (not (looking-at js--declaration-keyword-re))
1848 (when (looking-at js--indent-operator-re)
1849 (goto-char (match-end 0)))
1850 (while (and (not at-opening-bracket)
1851 (not (bobp))
1852 (let ((pos (point)))
1853 (save-excursion
1854 (js--backward-syntactic-ws)
1855 (or (eq (char-before) ?,)
1856 (and (not (eq (char-before) ?\;))
1857 (prog2
1858 (skip-syntax-backward ".")
1859 (looking-at js--indent-operator-re)
1860 (js--backward-syntactic-ws))
1861 (not (eq (char-before) ?\;)))
1862 (js--same-line pos)))))
1863 (condition-case nil
1864 (backward-sexp)
1865 (scan-error (setq at-opening-bracket t))))
1866 (when (looking-at js--declaration-keyword-re)
1867 (goto-char (match-end 0))
1868 (1+ (current-column)))))))
1869
1870 (defun js--indent-in-array-comp (bracket)
1871 "Return non-nil if we think we're in an array comprehension.
1872 In particular, return the buffer position of the first `for' kwd."
1873 (let ((end (point)))
1874 (save-excursion
1875 (goto-char bracket)
1876 (when (looking-at "\\[")
1877 (forward-char 1)
1878 (js--forward-syntactic-ws)
1879 (if (looking-at "[[{]")
1880 (let (forward-sexp-function) ; Use Lisp version.
1881 (forward-sexp) ; Skip destructuring form.
1882 (js--forward-syntactic-ws)
1883 (if (and (/= (char-after) ?,) ; Regular array.
1884 (looking-at "for"))
1885 (match-beginning 0)))
1886 ;; To skip arbitrary expressions we need the parser,
1887 ;; so we'll just guess at it.
1888 (if (and (> end (point)) ; Not empty literal.
1889 (re-search-forward "[^,]]* \\(for\\) " end t)
1890 ;; Not inside comment or string literal.
1891 (not (nth 8 (parse-partial-sexp bracket (point)))))
1892 (match-beginning 1)))))))
1893
1894 (defun js--array-comp-indentation (bracket for-kwd)
1895 (if (js--same-line for-kwd)
1896 ;; First continuation line.
1897 (save-excursion
1898 (goto-char bracket)
1899 (forward-char 1)
1900 (skip-chars-forward " \t")
1901 (current-column))
1902 (save-excursion
1903 (goto-char for-kwd)
1904 (current-column))))
1905
1906 (defun js--maybe-goto-declaration-keyword-end (parse-status)
1907 "Helper function for `js--proper-indentation'.
1908 Depending on the value of `js-indent-first-init', move
1909 point to the end of a variable declaration keyword so that
1910 indentation is aligned to that column."
1911 (cond
1912 ((eq js-indent-first-init t)
1913 (when (looking-at js--declaration-keyword-re)
1914 (goto-char (1+ (match-end 0)))))
1915 ((eq js-indent-first-init 'dynamic)
1916 (let ((bracket (nth 1 parse-status))
1917 declaration-keyword-end
1918 at-closing-bracket-p
1919 comma-p)
1920 (when (looking-at js--declaration-keyword-re)
1921 (setq declaration-keyword-end (match-end 0))
1922 (save-excursion
1923 (goto-char bracket)
1924 (setq at-closing-bracket-p
1925 (condition-case nil
1926 (progn
1927 (forward-sexp)
1928 t)
1929 (error nil)))
1930 (when at-closing-bracket-p
1931 (while (forward-comment 1))
1932 (setq comma-p (looking-at-p ","))))
1933 (when comma-p
1934 (goto-char (1+ declaration-keyword-end))))))))
1935
1936 (defun js--proper-indentation (parse-status)
1937 "Return the proper indentation for the current line."
1938 (save-excursion
1939 (back-to-indentation)
1940 (cond ((nth 4 parse-status) ; inside comment
1941 (js--get-c-offset 'c (nth 8 parse-status)))
1942 ((nth 3 parse-status) 0) ; inside string
1943 ((eq (char-after) ?#) 0)
1944 ((save-excursion (js--beginning-of-macro)) 4)
1945 ;; Indent array comprehension continuation lines specially.
1946 ((let ((bracket (nth 1 parse-status))
1947 beg)
1948 (and bracket
1949 (not (js--same-line bracket))
1950 (setq beg (js--indent-in-array-comp bracket))
1951 ;; At or after the first loop?
1952 (>= (point) beg)
1953 (js--array-comp-indentation bracket beg))))
1954 ((js--ctrl-statement-indentation))
1955 ((js--multi-line-declaration-indentation))
1956 ((nth 1 parse-status)
1957 ;; A single closing paren/bracket should be indented at the
1958 ;; same level as the opening statement. Same goes for
1959 ;; "case" and "default".
1960 (let ((same-indent-p (looking-at "[]})]"))
1961 (switch-keyword-p (looking-at "default\\_>\\|case\\_>[^:]"))
1962 (continued-expr-p (js--continued-expression-p)))
1963 (goto-char (nth 1 parse-status)) ; go to the opening char
1964 (if (looking-at "[({[]\\s-*\\(/[/*]\\|$\\)")
1965 (progn ; nothing following the opening paren/bracket
1966 (skip-syntax-backward " ")
1967 (when (eq (char-before) ?\)) (backward-list))
1968 (back-to-indentation)
1969 (js--maybe-goto-declaration-keyword-end parse-status)
1970 (let* ((in-switch-p (unless same-indent-p
1971 (looking-at "\\_<switch\\_>")))
1972 (same-indent-p (or same-indent-p
1973 (and switch-keyword-p
1974 in-switch-p)))
1975 (indent
1976 (cond (same-indent-p
1977 (current-column))
1978 (continued-expr-p
1979 (+ (current-column) (* 2 js-indent-level)
1980 js-expr-indent-offset))
1981 (t
1982 (+ (current-column) js-indent-level
1983 (pcase (char-after (nth 1 parse-status))
1984 (?\( js-paren-indent-offset)
1985 (?\[ js-square-indent-offset)
1986 (?\{ js-curly-indent-offset)))))))
1987 (if in-switch-p
1988 (+ indent js-switch-indent-offset)
1989 indent)))
1990 ;; If there is something following the opening
1991 ;; paren/bracket, everything else should be indented at
1992 ;; the same level.
1993 (unless same-indent-p
1994 (forward-char)
1995 (skip-chars-forward " \t"))
1996 (current-column))))
1997
1998 ((js--continued-expression-p)
1999 (+ js-indent-level js-expr-indent-offset))
2000 (t 0))))
2001
2002 ;;; JSX Indentation
2003
2004 (defsubst js--jsx-find-before-tag ()
2005 "Find where JSX starts.
2006
2007 Assume JSX appears in the following instances:
2008 - Inside parentheses, when returned or as the first argument
2009 to a function, and after a newline
2010 - When assigned to variables or object properties, but only
2011 on a single line
2012 - As the N+1th argument to a function
2013
2014 This is an optimized version of (re-search-backward \"[(,]\n\"
2015 nil t), except set point to the end of the match. This logic
2016 executes up to the number of lines in the file, so it should be
2017 really fast to reduce that impact."
2018 (let (pos)
2019 (while (and (> (point) (point-min))
2020 (not (progn
2021 (end-of-line 0)
2022 (when (or (eq (char-before) 40) ; (
2023 (eq (char-before) 44)) ; ,
2024 (setq pos (1- (point))))))))
2025 pos))
2026
2027 (defconst js--jsx-end-tag-re
2028 (concat "</" sgml-name-re ">\\|/>")
2029 "Find the end of a JSX element.")
2030
2031 (defconst js--jsx-after-tag-re "[),]"
2032 "Find where JSX ends.
2033 This complements the assumption of where JSX appears from
2034 `js--jsx-before-tag-re', which see.")
2035
2036 (defun js--jsx-indented-element-p ()
2037 "Determine if/how the current line should be indented as JSX.
2038
2039 Return `first' for the first JSXElement on its own line.
2040 Return `nth' for subsequent lines of the first JSXElement.
2041 Return `expression' for an embedded JS expression.
2042 Return `after' for anything after the last JSXElement.
2043 Return nil for non-JSX lines.
2044
2045 Currently, JSX indentation supports the following styles:
2046
2047 - Single-line elements (indented like normal JS):
2048
2049 var element = <div></div>;
2050
2051 - Multi-line elements (enclosed in parentheses):
2052
2053 function () {
2054 return (
2055 <div>
2056 <div></div>
2057 </div>
2058 );
2059 }
2060
2061 - Function arguments:
2062
2063 React.render(
2064 <div></div>,
2065 document.querySelector('.root')
2066 );"
2067 (let ((current-pos (point))
2068 (current-line (line-number-at-pos))
2069 last-pos
2070 before-tag-pos before-tag-line
2071 tag-start-pos tag-start-line
2072 tag-end-pos tag-end-line
2073 after-tag-line
2074 parens paren type)
2075 (save-excursion
2076 (and
2077 ;; Determine if we're inside a jsx element
2078 (progn
2079 (end-of-line)
2080 (while (and (not tag-start-pos)
2081 (setq last-pos (js--jsx-find-before-tag)))
2082 (while (forward-comment 1))
2083 (when (= (char-after) 60) ; <
2084 (setq before-tag-pos last-pos
2085 tag-start-pos (point)))
2086 (goto-char last-pos))
2087 tag-start-pos)
2088 (progn
2089 (setq before-tag-line (line-number-at-pos before-tag-pos)
2090 tag-start-line (line-number-at-pos tag-start-pos))
2091 (and
2092 ;; A "before" line which also starts an element begins with js, so
2093 ;; indent it like js
2094 (> current-line before-tag-line)
2095 ;; Only indent the jsx lines like jsx
2096 (>= current-line tag-start-line)))
2097 (cond
2098 ;; Analyze bounds if there are any
2099 ((progn
2100 (while (and (not tag-end-pos)
2101 (setq last-pos (re-search-forward js--jsx-end-tag-re nil t)))
2102 (while (forward-comment 1))
2103 (when (looking-at js--jsx-after-tag-re)
2104 (setq tag-end-pos last-pos)))
2105 tag-end-pos)
2106 (setq tag-end-line (line-number-at-pos tag-end-pos)
2107 after-tag-line (line-number-at-pos after-tag-line))
2108 (or (and
2109 ;; Ensure we're actually within the bounds of the jsx
2110 (<= current-line tag-end-line)
2111 ;; An "after" line which does not end an element begins with
2112 ;; js, so indent it like js
2113 (<= current-line after-tag-line))
2114 (and
2115 ;; Handle another case where there could be e.g. comments after
2116 ;; the element
2117 (> current-line tag-end-line)
2118 (< current-line after-tag-line)
2119 (setq type 'after))))
2120 ;; They may not be any bounds (yet)
2121 (t))
2122 ;; Check if we're inside an embedded multi-line js expression
2123 (cond
2124 ((not type)
2125 (goto-char current-pos)
2126 (end-of-line)
2127 (setq parens (nth 9 (syntax-ppss)))
2128 (while (and parens (not type))
2129 (setq paren (car parens))
2130 (cond
2131 ((and (>= paren tag-start-pos)
2132 ;; Curly bracket indicates the start of an embedded expression
2133 (= (char-after paren) 123) ; {
2134 ;; The first line of the expression is indented like sgml
2135 (> current-line (line-number-at-pos paren))
2136 ;; Check if within a closing curly bracket (if any)
2137 ;; (exclusive, as the closing bracket is indented like sgml)
2138 (cond
2139 ((progn
2140 (goto-char paren)
2141 (ignore-errors (let (forward-sexp-function)
2142 (forward-sexp))))
2143 (< current-line (line-number-at-pos)))
2144 (t)))
2145 ;; Indicate this guy will be indented specially
2146 (setq type 'expression))
2147 (t (setq parens (cdr parens)))))
2148 t)
2149 (t))
2150 (cond
2151 (type)
2152 ;; Indent the first jsx thing like js so we can indent future jsx things
2153 ;; like sgml relative to the first thing
2154 ((= current-line tag-start-line) 'first)
2155 ('nth))))))
2156
2157 (defmacro js--as-sgml (&rest body)
2158 "Execute BODY as if in sgml-mode."
2159 `(with-syntax-table sgml-mode-syntax-table
2160 (let (forward-sexp-function
2161 parse-sexp-lookup-properties)
2162 ,@body)))
2163
2164 (defun js--expression-in-sgml-indent-line ()
2165 "Indent the current line as JavaScript or SGML (whichever is farther)."
2166 (let* (indent-col
2167 (savep (point))
2168 ;; Don't whine about errors/warnings when we're indenting.
2169 ;; This has to be set before calling parse-partial-sexp below.
2170 (inhibit-point-motion-hooks t)
2171 (parse-status (save-excursion
2172 (syntax-ppss (point-at-bol)))))
2173 ;; Don't touch multiline strings.
2174 (unless (nth 3 parse-status)
2175 (setq indent-col (save-excursion
2176 (back-to-indentation)
2177 (if (>= (point) savep) (setq savep nil))
2178 (js--as-sgml (sgml-calculate-indent))))
2179 (if (null indent-col)
2180 'noindent
2181 ;; Use whichever indentation column is greater, such that the sgml
2182 ;; column is effectively a minimum
2183 (setq indent-col (max (js--proper-indentation parse-status)
2184 (+ indent-col js-indent-level)))
2185 (if savep
2186 (save-excursion (indent-line-to indent-col))
2187 (indent-line-to indent-col))))))
2188
2189 (defun js-indent-line ()
2190 "Indent the current line as JavaScript."
2191 (interactive)
2192 (let* ((parse-status
2193 (save-excursion (syntax-ppss (point-at-bol))))
2194 (offset (- (point) (save-excursion (back-to-indentation) (point)))))
2195 (unless (nth 3 parse-status)
2196 (indent-line-to (js--proper-indentation parse-status))
2197 (when (> offset 0) (forward-char offset)))))
2198
2199 (defun js-jsx-indent-line ()
2200 "Indent the current line as JSX (with SGML offsets).
2201 i.e., customize JSX element indentation with `sgml-basic-offset',
2202 `sgml-attribute-offset' et al."
2203 (interactive)
2204 (let ((indentation-type (js--jsx-indented-element-p)))
2205 (cond
2206 ((eq indentation-type 'expression)
2207 (js--expression-in-sgml-indent-line))
2208 ((or (eq indentation-type 'first)
2209 (eq indentation-type 'after))
2210 ;; Don't treat this first thing as a continued expression (often a "<" or
2211 ;; ">" causes this misinterpretation)
2212 (cl-letf (((symbol-function #'js--continued-expression-p) 'ignore))
2213 (js-indent-line)))
2214 ((eq indentation-type 'nth)
2215 (js--as-sgml (sgml-indent-line)))
2216 (t (js-indent-line)))))
2217
2218 ;;; Filling
2219
2220 (defvar js--filling-paragraph nil)
2221
2222 ;; FIXME: Such redefinitions are bad style. We should try and use some other
2223 ;; way to get the same result.
2224 (defadvice c-forward-sws (around js-fill-paragraph activate)
2225 (if js--filling-paragraph
2226 (setq ad-return-value (js--forward-syntactic-ws (ad-get-arg 0)))
2227 ad-do-it))
2228
2229 (defadvice c-backward-sws (around js-fill-paragraph activate)
2230 (if js--filling-paragraph
2231 (setq ad-return-value (js--backward-syntactic-ws (ad-get-arg 0)))
2232 ad-do-it))
2233
2234 (defadvice c-beginning-of-macro (around js-fill-paragraph activate)
2235 (if js--filling-paragraph
2236 (setq ad-return-value (js--beginning-of-macro (ad-get-arg 0)))
2237 ad-do-it))
2238
2239 (defun js-c-fill-paragraph (&optional justify)
2240 "Fill the paragraph with `c-fill-paragraph'."
2241 (interactive "*P")
2242 (let ((js--filling-paragraph t)
2243 (fill-paragraph-function 'c-fill-paragraph))
2244 (c-fill-paragraph justify)))
2245
2246 ;;; Type database and Imenu
2247
2248 ;; We maintain a cache of semantic information, i.e., the classes and
2249 ;; functions we've encountered so far. In order to avoid having to
2250 ;; re-parse the buffer on every change, we cache the parse state at
2251 ;; each interesting point in the buffer. Each parse state is a
2252 ;; modified copy of the previous one, or in the case of the first
2253 ;; parse state, the empty state.
2254 ;;
2255 ;; The parse state itself is just a stack of js--pitem
2256 ;; instances. It starts off containing one element that is never
2257 ;; closed, that is initially js--initial-pitem.
2258 ;;
2259
2260
2261 (defun js--pitem-format (pitem)
2262 (let ((name (js--pitem-name pitem))
2263 (type (js--pitem-type pitem)))
2264
2265 (format "name:%S type:%S"
2266 name
2267 (if (atom type)
2268 type
2269 (plist-get type :name)))))
2270
2271 (defun js--make-merged-item (item child name-parts)
2272 "Helper function for `js--splice-into-items'.
2273 Return a new item that is the result of merging CHILD into
2274 ITEM. NAME-PARTS is a list of parts of the name of CHILD
2275 that we haven't consumed yet."
2276 (js--debug "js--make-merged-item: {%s} into {%s}"
2277 (js--pitem-format child)
2278 (js--pitem-format item))
2279
2280 ;; If the item we're merging into isn't a class, make it into one
2281 (unless (consp (js--pitem-type item))
2282 (js--debug "js--make-merged-item: changing dest into class")
2283 (setq item (make-js--pitem
2284 :children (list item)
2285
2286 ;; Use the child's class-style if it's available
2287 :type (if (atom (js--pitem-type child))
2288 js--dummy-class-style
2289 (js--pitem-type child))
2290
2291 :name (js--pitem-strname item))))
2292
2293 ;; Now we can merge either a function or a class into a class
2294 (cons (cond
2295 ((cdr name-parts)
2296 (js--debug "js--make-merged-item: recursing")
2297 ;; if we have more name-parts to go before we get to the
2298 ;; bottom of the class hierarchy, call the merger
2299 ;; recursively
2300 (js--splice-into-items (car item) child
2301 (cdr name-parts)))
2302
2303 ((atom (js--pitem-type child))
2304 (js--debug "js--make-merged-item: straight merge")
2305 ;; Not merging a class, but something else, so just prepend
2306 ;; it
2307 (cons child (car item)))
2308
2309 (t
2310 ;; Otherwise, merge the new child's items into those
2311 ;; of the new class
2312 (js--debug "js--make-merged-item: merging class contents")
2313 (append (car child) (car item))))
2314 (cdr item)))
2315
2316 (defun js--pitem-strname (pitem)
2317 "Last part of the name of PITEM, as a string or symbol."
2318 (let ((name (js--pitem-name pitem)))
2319 (if (consp name)
2320 (car (last name))
2321 name)))
2322
2323 (defun js--splice-into-items (items child name-parts)
2324 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2325 If a class doesn't exist in the tree, create it. Return
2326 the new items list. NAME-PARTS is a list of strings given
2327 the broken-down class name of the item to insert."
2328
2329 (let ((top-name (car name-parts))
2330 (item-ptr items)
2331 new-items last-new-item new-cons)
2332
2333 (js--debug "js--splice-into-items: name-parts: %S items:%S"
2334 name-parts
2335 (mapcar #'js--pitem-name items))
2336
2337 (cl-assert (stringp top-name))
2338 (cl-assert (> (length top-name) 0))
2339
2340 ;; If top-name isn't found in items, then we build a copy of items
2341 ;; and throw it away. But that's okay, since most of the time, we
2342 ;; *will* find an instance.
2343
2344 (while (and item-ptr
2345 (cond ((equal (js--pitem-strname (car item-ptr)) top-name)
2346 ;; Okay, we found an entry with the right name. Splice
2347 ;; the merged item into the list...
2348 (setq new-cons (cons (js--make-merged-item
2349 (car item-ptr) child
2350 name-parts)
2351 (cdr item-ptr)))
2352
2353 (if last-new-item
2354 (setcdr last-new-item new-cons)
2355 (setq new-items new-cons))
2356
2357 ;; ...and terminate the loop
2358 nil)
2359
2360 (t
2361 ;; Otherwise, copy the current cons and move onto the
2362 ;; text. This is tricky; we keep track of the tail of
2363 ;; the list that begins with new-items in
2364 ;; last-new-item.
2365 (setq new-cons (cons (car item-ptr) nil))
2366 (if last-new-item
2367 (setcdr last-new-item new-cons)
2368 (setq new-items new-cons))
2369 (setq last-new-item new-cons)
2370
2371 ;; Go to the next cell in items
2372 (setq item-ptr (cdr item-ptr))))))
2373
2374 (if item-ptr
2375 ;; Yay! We stopped because we found something, not because
2376 ;; we ran out of items to search. Just return the new
2377 ;; list.
2378 (progn
2379 (js--debug "search succeeded: %S" name-parts)
2380 new-items)
2381
2382 ;; We didn't find anything. If the child is a class and we don't
2383 ;; have any classes to drill down into, just push that class;
2384 ;; otherwise, make a fake class and carry on.
2385 (js--debug "search failed: %S" name-parts)
2386 (cons (if (cdr name-parts)
2387 ;; We have name-parts left to process. Make a fake
2388 ;; class for this particular part...
2389 (make-js--pitem
2390 ;; ...and recursively digest the rest of the name
2391 :children (js--splice-into-items
2392 nil child (cdr name-parts))
2393 :type js--dummy-class-style
2394 :name top-name)
2395
2396 ;; Otherwise, this is the only name we have, so stick
2397 ;; the item on the front of the list
2398 child)
2399 items))))
2400
2401 (defun js--pitem-add-child (pitem child)
2402 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2403 (cl-assert (integerp (js--pitem-h-begin child)))
2404 (cl-assert (if (consp (js--pitem-name child))
2405 (cl-loop for part in (js--pitem-name child)
2406 always (stringp part))
2407 t))
2408
2409 ;; This trick works because we know (based on our defstructs) that
2410 ;; the child list is always the first element, and so the second
2411 ;; element and beyond can be shared when we make our "copy".
2412 (cons
2413
2414 (let ((name (js--pitem-name child))
2415 (type (js--pitem-type child)))
2416
2417 (cond ((cdr-safe name) ; true if a list of at least two elements
2418 ;; Use slow path because we need class lookup
2419 (js--splice-into-items (car pitem) child name))
2420
2421 ((and (consp type)
2422 (plist-get type :prototype))
2423
2424 ;; Use slow path because we need class merging. We know
2425 ;; name is a list here because down in
2426 ;; `js--ensure-cache', we made sure to only add
2427 ;; class entries with lists for :name
2428 (cl-assert (consp name))
2429 (js--splice-into-items (car pitem) child name))
2430
2431 (t
2432 ;; Fast path
2433 (cons child (car pitem)))))
2434
2435 (cdr pitem)))
2436
2437 (defun js--maybe-make-marker (location)
2438 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2439 (if imenu-use-markers
2440 (set-marker (make-marker) location)
2441 location))
2442
2443 (defun js--pitems-to-imenu (pitems unknown-ctr)
2444 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2445
2446 (let (imenu-items pitem pitem-type pitem-name subitems)
2447
2448 (while (setq pitem (pop pitems))
2449 (setq pitem-type (js--pitem-type pitem))
2450 (setq pitem-name (js--pitem-strname pitem))
2451 (when (eq pitem-name t)
2452 (setq pitem-name (format "[unknown %s]"
2453 (cl-incf (car unknown-ctr)))))
2454
2455 (cond
2456 ((memq pitem-type '(function macro))
2457 (cl-assert (integerp (js--pitem-h-begin pitem)))
2458 (push (cons pitem-name
2459 (js--maybe-make-marker
2460 (js--pitem-h-begin pitem)))
2461 imenu-items))
2462
2463 ((consp pitem-type) ; class definition
2464 (setq subitems (js--pitems-to-imenu
2465 (js--pitem-children pitem)
2466 unknown-ctr))
2467 (cond (subitems
2468 (push (cons pitem-name subitems)
2469 imenu-items))
2470
2471 ((js--pitem-h-begin pitem)
2472 (cl-assert (integerp (js--pitem-h-begin pitem)))
2473 (setq subitems (list
2474 (cons "[empty]"
2475 (js--maybe-make-marker
2476 (js--pitem-h-begin pitem)))))
2477 (push (cons pitem-name subitems)
2478 imenu-items))))
2479
2480 (t (error "Unknown item type: %S" pitem-type))))
2481
2482 imenu-items))
2483
2484 (defun js--imenu-create-index ()
2485 "Return an imenu index for the current buffer."
2486 (save-excursion
2487 (save-restriction
2488 (widen)
2489 (goto-char (point-max))
2490 (js--ensure-cache)
2491 (cl-assert (or (= (point-min) (point-max))
2492 (eq js--last-parse-pos (point))))
2493 (when js--last-parse-pos
2494 (let ((state js--state-at-last-parse-pos)
2495 (unknown-ctr (cons -1 nil)))
2496
2497 ;; Make sure everything is closed
2498 (while (cdr state)
2499 (setq state
2500 (cons (js--pitem-add-child (cl-second state) (car state))
2501 (cddr state))))
2502
2503 (cl-assert (= (length state) 1))
2504
2505 ;; Convert the new-finalized state into what imenu expects
2506 (js--pitems-to-imenu
2507 (car (js--pitem-children state))
2508 unknown-ctr))))))
2509
2510 ;; Silence the compiler.
2511 (defvar which-func-imenu-joiner-function)
2512
2513 (defun js--which-func-joiner (parts)
2514 (mapconcat #'identity parts "."))
2515
2516 (defun js--imenu-to-flat (items prefix symbols)
2517 (cl-loop for item in items
2518 if (imenu--subalist-p item)
2519 do (js--imenu-to-flat
2520 (cdr item) (concat prefix (car item) ".")
2521 symbols)
2522 else
2523 do (let* ((name (concat prefix (car item)))
2524 (name2 name)
2525 (ctr 0))
2526
2527 (while (gethash name2 symbols)
2528 (setq name2 (format "%s<%d>" name (cl-incf ctr))))
2529
2530 (puthash name2 (cdr item) symbols))))
2531
2532 (defun js--get-all-known-symbols ()
2533 "Return a hash table of all JavaScript symbols.
2534 This searches all existing `js-mode' buffers. Each key is the
2535 name of a symbol (possibly disambiguated with <N>, where N > 1),
2536 and each value is a marker giving the location of that symbol."
2537 (cl-loop with symbols = (make-hash-table :test 'equal)
2538 with imenu-use-markers = t
2539 for buffer being the buffers
2540 for imenu-index = (with-current-buffer buffer
2541 (when (derived-mode-p 'js-mode)
2542 (js--imenu-create-index)))
2543 do (js--imenu-to-flat imenu-index "" symbols)
2544 finally return symbols))
2545
2546 (defvar js--symbol-history nil
2547 "History of entered JavaScript symbols.")
2548
2549 (defun js--read-symbol (symbols-table prompt &optional initial-input)
2550 "Helper function for `js-find-symbol'.
2551 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2552 one from `js--get-all-known-symbols', using prompt PROMPT and
2553 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2554 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2555 marker."
2556 (unless ido-mode
2557 (ido-mode 1)
2558 (ido-mode -1))
2559
2560 (let ((choice (ido-completing-read
2561 prompt
2562 (cl-loop for key being the hash-keys of symbols-table
2563 collect key)
2564 nil t initial-input 'js--symbol-history)))
2565 (cons choice (gethash choice symbols-table))))
2566
2567 (defun js--guess-symbol-at-point ()
2568 (let ((bounds (bounds-of-thing-at-point 'symbol)))
2569 (when bounds
2570 (save-excursion
2571 (goto-char (car bounds))
2572 (when (eq (char-before) ?.)
2573 (backward-char)
2574 (setf (car bounds) (point))))
2575 (buffer-substring (car bounds) (cdr bounds)))))
2576
2577 (defvar find-tag-marker-ring) ; etags
2578
2579 ;; etags loads ring.
2580 (declare-function ring-insert "ring" (ring item))
2581
2582 (defun js-find-symbol (&optional arg)
2583 "Read a JavaScript symbol and jump to it.
2584 With a prefix argument, restrict symbols to those from the
2585 current buffer. Pushes a mark onto the tag ring just like
2586 `find-tag'."
2587 (interactive "P")
2588 (require 'etags)
2589 (let (symbols marker)
2590 (if (not arg)
2591 (setq symbols (js--get-all-known-symbols))
2592 (setq symbols (make-hash-table :test 'equal))
2593 (js--imenu-to-flat (js--imenu-create-index)
2594 "" symbols))
2595
2596 (setq marker (cdr (js--read-symbol
2597 symbols "Jump to: "
2598 (js--guess-symbol-at-point))))
2599
2600 (ring-insert find-tag-marker-ring (point-marker))
2601 (switch-to-buffer (marker-buffer marker))
2602 (push-mark)
2603 (goto-char marker)))
2604
2605 ;;; MozRepl integration
2606
2607 (define-error 'js-moz-bad-rpc "Mozilla RPC Error") ;; '(timeout error))
2608 (define-error 'js-js-error "Javascript Error") ;; '(js-error error))
2609
2610 (defun js--wait-for-matching-output
2611 (process regexp timeout &optional start)
2612 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2613 On timeout, return nil. On success, return t with match data
2614 set. If START is non-nil, look for output starting from START.
2615 Otherwise, use the current value of `process-mark'."
2616 (with-current-buffer (process-buffer process)
2617 (cl-loop with start-pos = (or start
2618 (marker-position (process-mark process)))
2619 with end-time = (+ (float-time) timeout)
2620 for time-left = (- end-time (float-time))
2621 do (goto-char (point-max))
2622 if (looking-back regexp start-pos) return t
2623 while (> time-left 0)
2624 do (accept-process-output process time-left nil t)
2625 do (goto-char (process-mark process))
2626 finally do (signal
2627 'js-moz-bad-rpc
2628 (list (format "Timed out waiting for output matching %S" regexp))))))
2629
2630 (cl-defstruct js--js-handle
2631 ;; Integer, mirrors the value we see in JS
2632 (id nil :read-only t)
2633
2634 ;; Process to which this thing belongs
2635 (process nil :read-only t))
2636
2637 (defun js--js-handle-expired-p (x)
2638 (not (eq (js--js-handle-process x)
2639 (inferior-moz-process))))
2640
2641 (defvar js--js-references nil
2642 "Maps Elisp JavaScript proxy objects to their JavaScript IDs.")
2643
2644 (defvar js--js-process nil
2645 "The most recent MozRepl process object.")
2646
2647 (defvar js--js-gc-idle-timer nil
2648 "Idle timer for cleaning up JS object references.")
2649
2650 (defvar js--js-last-gcs-done nil)
2651
2652 (defconst js--moz-interactor
2653 (replace-regexp-in-string
2654 "[ \n]+" " "
2655 ; */" Make Emacs happy
2656 "(function(repl) {
2657 repl.defineInteractor('js', {
2658 onStart: function onStart(repl) {
2659 if(!repl._jsObjects) {
2660 repl._jsObjects = {};
2661 repl._jsLastID = 0;
2662 repl._jsGC = this._jsGC;
2663 }
2664 this._input = '';
2665 },
2666
2667 _jsGC: function _jsGC(ids_in_use) {
2668 var objects = this._jsObjects;
2669 var keys = [];
2670 var num_freed = 0;
2671
2672 for(var pn in objects) {
2673 keys.push(Number(pn));
2674 }
2675
2676 keys.sort(function(x, y) x - y);
2677 ids_in_use.sort(function(x, y) x - y);
2678 var i = 0;
2679 var j = 0;
2680
2681 while(i < ids_in_use.length && j < keys.length) {
2682 var id = ids_in_use[i++];
2683 while(j < keys.length && keys[j] !== id) {
2684 var k_id = keys[j++];
2685 delete objects[k_id];
2686 ++num_freed;
2687 }
2688 ++j;
2689 }
2690
2691 while(j < keys.length) {
2692 var k_id = keys[j++];
2693 delete objects[k_id];
2694 ++num_freed;
2695 }
2696
2697 return num_freed;
2698 },
2699
2700 _mkArray: function _mkArray() {
2701 var result = [];
2702 for(var i = 0; i < arguments.length; ++i) {
2703 result.push(arguments[i]);
2704 }
2705 return result;
2706 },
2707
2708 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2709 if(typeof parts === 'string') {
2710 parts = [ parts ];
2711 }
2712
2713 var obj = parts[0];
2714 var start = 1;
2715
2716 if(typeof obj === 'string') {
2717 obj = window;
2718 start = 0;
2719 } else if(parts.length < 2) {
2720 throw new Error('expected at least 2 arguments');
2721 }
2722
2723 for(var i = start; i < parts.length - 1; ++i) {
2724 obj = obj[parts[i]];
2725 }
2726
2727 return [obj, parts[parts.length - 1]];
2728 },
2729
2730 _getProp: function _getProp(/*...*/) {
2731 if(arguments.length === 0) {
2732 throw new Error('no arguments supplied to getprop');
2733 }
2734
2735 if(arguments.length === 1 &&
2736 (typeof arguments[0]) !== 'string')
2737 {
2738 return arguments[0];
2739 }
2740
2741 var [obj, propname] = this._parsePropDescriptor(arguments);
2742 return obj[propname];
2743 },
2744
2745 _putProp: function _putProp(properties, value) {
2746 var [obj, propname] = this._parsePropDescriptor(properties);
2747 obj[propname] = value;
2748 },
2749
2750 _delProp: function _delProp(propname) {
2751 var [obj, propname] = this._parsePropDescriptor(arguments);
2752 delete obj[propname];
2753 },
2754
2755 _typeOf: function _typeOf(thing) {
2756 return typeof thing;
2757 },
2758
2759 _callNew: function(constructor) {
2760 if(typeof constructor === 'string')
2761 {
2762 constructor = window[constructor];
2763 } else if(constructor.length === 1 &&
2764 typeof constructor[0] !== 'string')
2765 {
2766 constructor = constructor[0];
2767 } else {
2768 var [obj,propname] = this._parsePropDescriptor(constructor);
2769 constructor = obj[propname];
2770 }
2771
2772 /* Hacky, but should be robust */
2773 var s = 'new constructor(';
2774 for(var i = 1; i < arguments.length; ++i) {
2775 if(i != 1) {
2776 s += ',';
2777 }
2778
2779 s += 'arguments[' + i + ']';
2780 }
2781
2782 s += ')';
2783 return eval(s);
2784 },
2785
2786 _callEval: function(thisobj, js) {
2787 return eval.call(thisobj, js);
2788 },
2789
2790 getPrompt: function getPrompt(repl) {
2791 return 'EVAL>'
2792 },
2793
2794 _lookupObject: function _lookupObject(repl, id) {
2795 if(typeof id === 'string') {
2796 switch(id) {
2797 case 'global':
2798 return window;
2799 case 'nil':
2800 return null;
2801 case 't':
2802 return true;
2803 case 'false':
2804 return false;
2805 case 'undefined':
2806 return undefined;
2807 case 'repl':
2808 return repl;
2809 case 'interactor':
2810 return this;
2811 case 'NaN':
2812 return NaN;
2813 case 'Infinity':
2814 return Infinity;
2815 case '-Infinity':
2816 return -Infinity;
2817 default:
2818 throw new Error('No object with special id:' + id);
2819 }
2820 }
2821
2822 var ret = repl._jsObjects[id];
2823 if(ret === undefined) {
2824 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2825 }
2826 return ret;
2827 },
2828
2829 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2830 if(typeof value !== 'object' && typeof value !== 'function') {
2831 throw new Error('_findOrAllocateObject called on non-object('
2832 + typeof(value) + '): '
2833 + value)
2834 }
2835
2836 for(var id in repl._jsObjects) {
2837 id = Number(id);
2838 var obj = repl._jsObjects[id];
2839 if(obj === value) {
2840 return id;
2841 }
2842 }
2843
2844 var id = ++repl._jsLastID;
2845 repl._jsObjects[id] = value;
2846 return id;
2847 },
2848
2849 _fixupList: function _fixupList(repl, list) {
2850 for(var i = 0; i < list.length; ++i) {
2851 if(list[i] instanceof Array) {
2852 this._fixupList(repl, list[i]);
2853 } else if(typeof list[i] === 'object') {
2854 var obj = list[i];
2855 if(obj.funcall) {
2856 var parts = obj.funcall;
2857 this._fixupList(repl, parts);
2858 var [thisobj, func] = this._parseFunc(parts[0]);
2859 list[i] = func.apply(thisobj, parts.slice(1));
2860 } else if(obj.objid) {
2861 list[i] = this._lookupObject(repl, obj.objid);
2862 } else {
2863 throw new Error('Unknown object type: ' + obj.toSource());
2864 }
2865 }
2866 }
2867 },
2868
2869 _parseFunc: function(func) {
2870 var thisobj = null;
2871
2872 if(typeof func === 'string') {
2873 func = window[func];
2874 } else if(func instanceof Array) {
2875 if(func.length === 1 && typeof func[0] !== 'string') {
2876 func = func[0];
2877 } else {
2878 [thisobj, func] = this._parsePropDescriptor(func);
2879 func = thisobj[func];
2880 }
2881 }
2882
2883 return [thisobj,func];
2884 },
2885
2886 _encodeReturn: function(value, array_as_mv) {
2887 var ret;
2888
2889 if(value === null) {
2890 ret = ['special', 'null'];
2891 } else if(value === true) {
2892 ret = ['special', 'true'];
2893 } else if(value === false) {
2894 ret = ['special', 'false'];
2895 } else if(value === undefined) {
2896 ret = ['special', 'undefined'];
2897 } else if(typeof value === 'number') {
2898 if(isNaN(value)) {
2899 ret = ['special', 'NaN'];
2900 } else if(value === Infinity) {
2901 ret = ['special', 'Infinity'];
2902 } else if(value === -Infinity) {
2903 ret = ['special', '-Infinity'];
2904 } else {
2905 ret = ['atom', value];
2906 }
2907 } else if(typeof value === 'string') {
2908 ret = ['atom', value];
2909 } else if(array_as_mv && value instanceof Array) {
2910 ret = ['array', value.map(this._encodeReturn, this)];
2911 } else {
2912 ret = ['objid', this._findOrAllocateObject(repl, value)];
2913 }
2914
2915 return ret;
2916 },
2917
2918 _handleInputLine: function _handleInputLine(repl, line) {
2919 var ret;
2920 var array_as_mv = false;
2921
2922 try {
2923 if(line[0] === '*') {
2924 array_as_mv = true;
2925 line = line.substring(1);
2926 }
2927 var parts = eval(line);
2928 this._fixupList(repl, parts);
2929 var [thisobj, func] = this._parseFunc(parts[0]);
2930 ret = this._encodeReturn(
2931 func.apply(thisobj, parts.slice(1)),
2932 array_as_mv);
2933 } catch(x) {
2934 ret = ['error', x.toString() ];
2935 }
2936
2937 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2938 repl.print(JSON.encode(ret));
2939 repl._prompt();
2940 },
2941
2942 handleInput: function handleInput(repl, chunk) {
2943 this._input += chunk;
2944 var match, line;
2945 while(match = this._input.match(/.*\\n/)) {
2946 line = match[0];
2947
2948 if(line === 'EXIT\\n') {
2949 repl.popInteractor();
2950 repl._prompt();
2951 return;
2952 }
2953
2954 this._input = this._input.substring(line.length);
2955 this._handleInputLine(repl, line);
2956 }
2957 }
2958 });
2959 })
2960 ")
2961
2962 "String to set MozRepl up into a simple-minded evaluation mode.")
2963
2964 (defun js--js-encode-value (x)
2965 "Marshall the given value for JS.
2966 Strings and numbers are JSON-encoded. Lists (including nil) are
2967 made into JavaScript array literals and their contents encoded
2968 with `js--js-encode-value'."
2969 (cond ((stringp x) (json-encode-string x))
2970 ((numberp x) (json-encode-number x))
2971 ((symbolp x) (format "{objid:%S}" (symbol-name x)))
2972 ((js--js-handle-p x)
2973
2974 (when (js--js-handle-expired-p x)
2975 (error "Stale JS handle"))
2976
2977 (format "{objid:%s}" (js--js-handle-id x)))
2978
2979 ((sequencep x)
2980 (if (eq (car-safe x) 'js--funcall)
2981 (format "{funcall:[%s]}"
2982 (mapconcat #'js--js-encode-value (cdr x) ","))
2983 (concat
2984 "[" (mapconcat #'js--js-encode-value x ",") "]")))
2985 (t
2986 (error "Unrecognized item: %S" x))))
2987
2988 (defconst js--js-prompt-regexp "\\(repl[0-9]*\\)> $")
2989 (defconst js--js-repl-prompt-regexp "^EVAL>$")
2990 (defvar js--js-repl-depth 0)
2991
2992 (defun js--js-wait-for-eval-prompt ()
2993 (js--wait-for-matching-output
2994 (inferior-moz-process)
2995 js--js-repl-prompt-regexp js-js-timeout
2996
2997 ;; start matching against the beginning of the line in
2998 ;; order to catch a prompt that's only partially arrived
2999 (save-excursion (forward-line 0) (point))))
3000
3001 ;; Presumably "inferior-moz-process" loads comint.
3002 (declare-function comint-send-string "comint" (process string))
3003 (declare-function comint-send-input "comint"
3004 (&optional no-newline artificial))
3005
3006 (defun js--js-enter-repl ()
3007 (inferior-moz-process) ; called for side-effect
3008 (with-current-buffer inferior-moz-buffer
3009 (goto-char (point-max))
3010
3011 ;; Do some initialization the first time we see a process
3012 (unless (eq (inferior-moz-process) js--js-process)
3013 (setq js--js-process (inferior-moz-process))
3014 (setq js--js-references (make-hash-table :test 'eq :weakness t))
3015 (setq js--js-repl-depth 0)
3016
3017 ;; Send interactor definition
3018 (comint-send-string js--js-process js--moz-interactor)
3019 (comint-send-string js--js-process
3020 (concat "(" moz-repl-name ")\n"))
3021 (js--wait-for-matching-output
3022 (inferior-moz-process) js--js-prompt-regexp
3023 js-js-timeout))
3024
3025 ;; Sanity check
3026 (when (looking-back js--js-prompt-regexp
3027 (save-excursion (forward-line 0) (point)))
3028 (setq js--js-repl-depth 0))
3029
3030 (if (> js--js-repl-depth 0)
3031 ;; If js--js-repl-depth > 0, we *should* be seeing an
3032 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
3033 ;; up with us.
3034 (js--js-wait-for-eval-prompt)
3035
3036 ;; Otherwise, tell Mozilla to enter the interactor mode
3037 (insert (match-string-no-properties 1)
3038 ".pushInteractor('js')")
3039 (comint-send-input nil t)
3040 (js--wait-for-matching-output
3041 (inferior-moz-process) js--js-repl-prompt-regexp
3042 js-js-timeout))
3043
3044 (cl-incf js--js-repl-depth)))
3045
3046 (defun js--js-leave-repl ()
3047 (cl-assert (> js--js-repl-depth 0))
3048 (when (= 0 (cl-decf js--js-repl-depth))
3049 (with-current-buffer inferior-moz-buffer
3050 (goto-char (point-max))
3051 (js--js-wait-for-eval-prompt)
3052 (insert "EXIT")
3053 (comint-send-input nil t)
3054 (js--wait-for-matching-output
3055 (inferior-moz-process) js--js-prompt-regexp
3056 js-js-timeout))))
3057
3058 (defsubst js--js-not (value)
3059 (memq value '(nil null false undefined)))
3060
3061 (defsubst js--js-true (value)
3062 (not (js--js-not value)))
3063
3064 (eval-and-compile
3065 (defun js--optimize-arglist (arglist)
3066 "Convert immediate js< and js! references to deferred ones."
3067 (cl-loop for item in arglist
3068 if (eq (car-safe item) 'js<)
3069 collect (append (list 'list ''js--funcall
3070 '(list 'interactor "_getProp"))
3071 (js--optimize-arglist (cdr item)))
3072 else if (eq (car-safe item) 'js>)
3073 collect (append (list 'list ''js--funcall
3074 '(list 'interactor "_putProp"))
3075
3076 (if (atom (cadr item))
3077 (list (cadr item))
3078 (list
3079 (append
3080 (list 'list ''js--funcall
3081 '(list 'interactor "_mkArray"))
3082 (js--optimize-arglist (cadr item)))))
3083 (js--optimize-arglist (cddr item)))
3084 else if (eq (car-safe item) 'js!)
3085 collect (pcase-let ((`(,_ ,function . ,body) item))
3086 (append (list 'list ''js--funcall
3087 (if (consp function)
3088 (cons 'list
3089 (js--optimize-arglist function))
3090 function))
3091 (js--optimize-arglist body)))
3092 else
3093 collect item)))
3094
3095 (defmacro js--js-get-service (class-name interface-name)
3096 `(js! ("Components" "classes" ,class-name "getService")
3097 (js< "Components" "interfaces" ,interface-name)))
3098
3099 (defmacro js--js-create-instance (class-name interface-name)
3100 `(js! ("Components" "classes" ,class-name "createInstance")
3101 (js< "Components" "interfaces" ,interface-name)))
3102
3103 (defmacro js--js-qi (object interface-name)
3104 `(js! (,object "QueryInterface")
3105 (js< "Components" "interfaces" ,interface-name)))
3106
3107 (defmacro with-js (&rest forms)
3108 "Run FORMS with the Mozilla repl set up for js commands.
3109 Inside the lexical scope of `with-js', `js?', `js!',
3110 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
3111 `js-create-instance', and `js-qi' are defined."
3112
3113 `(progn
3114 (js--js-enter-repl)
3115 (unwind-protect
3116 (cl-macrolet ((js? (&rest body) `(js--js-true ,@body))
3117 (js! (function &rest body)
3118 `(js--js-funcall
3119 ,(if (consp function)
3120 (cons 'list
3121 (js--optimize-arglist function))
3122 function)
3123 ,@(js--optimize-arglist body)))
3124
3125 (js-new (function &rest body)
3126 `(js--js-new
3127 ,(if (consp function)
3128 (cons 'list
3129 (js--optimize-arglist function))
3130 function)
3131 ,@body))
3132
3133 (js-eval (thisobj js)
3134 `(js--js-eval
3135 ,@(js--optimize-arglist
3136 (list thisobj js))))
3137
3138 (js-list (&rest args)
3139 `(js--js-list
3140 ,@(js--optimize-arglist args)))
3141
3142 (js-get-service (&rest args)
3143 `(js--js-get-service
3144 ,@(js--optimize-arglist args)))
3145
3146 (js-create-instance (&rest args)
3147 `(js--js-create-instance
3148 ,@(js--optimize-arglist args)))
3149
3150 (js-qi (&rest args)
3151 `(js--js-qi
3152 ,@(js--optimize-arglist args)))
3153
3154 (js< (&rest body) `(js--js-get
3155 ,@(js--optimize-arglist body)))
3156 (js> (props value)
3157 `(js--js-funcall
3158 '(interactor "_putProp")
3159 ,(if (consp props)
3160 (cons 'list
3161 (js--optimize-arglist props))
3162 props)
3163 ,@(js--optimize-arglist (list value))
3164 ))
3165 (js-handle? (arg) `(js--js-handle-p ,arg)))
3166 ,@forms)
3167 (js--js-leave-repl))))
3168
3169 (defvar js--js-array-as-list nil
3170 "Whether to listify any Array returned by a Mozilla function.
3171 If nil, the whole Array is treated as a JS symbol.")
3172
3173 (defun js--js-decode-retval (result)
3174 (pcase (intern (cl-first result))
3175 (`atom (cl-second result))
3176 (`special (intern (cl-second result)))
3177 (`array
3178 (mapcar #'js--js-decode-retval (cl-second result)))
3179 (`objid
3180 (or (gethash (cl-second result)
3181 js--js-references)
3182 (puthash (cl-second result)
3183 (make-js--js-handle
3184 :id (cl-second result)
3185 :process (inferior-moz-process))
3186 js--js-references)))
3187
3188 (`error (signal 'js-js-error (list (cl-second result))))
3189 (x (error "Unmatched case in js--js-decode-retval: %S" x))))
3190
3191 (defvar comint-last-input-end)
3192
3193 (defun js--js-funcall (function &rest arguments)
3194 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
3195 If function is a string, look it up as a property on the global
3196 object and use the global object for `this'.
3197 If FUNCTION is a list with one element, use that element as the
3198 function with the global object for `this', except that if that
3199 single element is a string, look it up on the global object.
3200 If FUNCTION is a list with more than one argument, use the list
3201 up to the last value as a property descriptor and the last
3202 argument as a function."
3203
3204 (with-js
3205 (let ((argstr (js--js-encode-value
3206 (cons function arguments))))
3207
3208 (with-current-buffer inferior-moz-buffer
3209 ;; Actual funcall
3210 (when js--js-array-as-list
3211 (insert "*"))
3212 (insert argstr)
3213 (comint-send-input nil t)
3214 (js--wait-for-matching-output
3215 (inferior-moz-process) "EVAL>"
3216 js-js-timeout)
3217 (goto-char comint-last-input-end)
3218
3219 ;; Read the result
3220 (let* ((json-array-type 'list)
3221 (result (prog1 (json-read)
3222 (goto-char (point-max)))))
3223 (js--js-decode-retval result))))))
3224
3225 (defun js--js-new (constructor &rest arguments)
3226 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
3227 CONSTRUCTOR is a JS handle, a string, or a list of these things."
3228 (apply #'js--js-funcall
3229 '(interactor "_callNew")
3230 constructor arguments))
3231
3232 (defun js--js-eval (thisobj js)
3233 (js--js-funcall '(interactor "_callEval") thisobj js))
3234
3235 (defun js--js-list (&rest arguments)
3236 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
3237 (let ((js--js-array-as-list t))
3238 (apply #'js--js-funcall '(interactor "_mkArray")
3239 arguments)))
3240
3241 (defun js--js-get (&rest props)
3242 (apply #'js--js-funcall '(interactor "_getProp") props))
3243
3244 (defun js--js-put (props value)
3245 (js--js-funcall '(interactor "_putProp") props value))
3246
3247 (defun js-gc (&optional force)
3248 "Tell the repl about any objects we don't reference anymore.
3249 With argument, run even if no intervening GC has happened."
3250 (interactive)
3251
3252 (when force
3253 (setq js--js-last-gcs-done nil))
3254
3255 (let ((this-gcs-done gcs-done) keys num)
3256 (when (and js--js-references
3257 (boundp 'inferior-moz-buffer)
3258 (buffer-live-p inferior-moz-buffer)
3259
3260 ;; Don't bother running unless we've had an intervening
3261 ;; garbage collection; without a gc, nothing is deleted
3262 ;; from the weak hash table, so it's pointless telling
3263 ;; MozRepl about that references we still hold
3264 (not (eq js--js-last-gcs-done this-gcs-done))
3265
3266 ;; Are we looking at a normal prompt? Make sure not to
3267 ;; interrupt the user if he's doing something
3268 (with-current-buffer inferior-moz-buffer
3269 (save-excursion
3270 (goto-char (point-max))
3271 (looking-back js--js-prompt-regexp
3272 (save-excursion (forward-line 0) (point))))))
3273
3274 (setq keys (cl-loop for x being the hash-keys
3275 of js--js-references
3276 collect x))
3277 (setq num (js--js-funcall '(repl "_jsGC") (or keys [])))
3278
3279 (setq js--js-last-gcs-done this-gcs-done)
3280 (when (called-interactively-p 'interactive)
3281 (message "Cleaned %s entries" num))
3282
3283 num)))
3284
3285 (run-with-idle-timer 30 t #'js-gc)
3286
3287 (defun js-eval (js)
3288 "Evaluate the JavaScript in JS and return JSON-decoded result."
3289 (interactive "MJavascript to evaluate: ")
3290 (with-js
3291 (let* ((content-window (js--js-content-window
3292 (js--get-js-context)))
3293 (result (js-eval content-window js)))
3294 (when (called-interactively-p 'interactive)
3295 (message "%s" (js! "String" result)))
3296 result)))
3297
3298 (defun js--get-tabs ()
3299 "Enumerate all JavaScript contexts available.
3300 Each context is a list:
3301 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3302 (TITLE URL WINDOW) for windows
3303
3304 All tabs of a given window are grouped together. The most recent
3305 window is first. Within each window, the tabs are returned
3306 left-to-right."
3307 (with-js
3308 (let (windows)
3309
3310 (cl-loop with window-mediator = (js! ("Components" "classes"
3311 "@mozilla.org/appshell/window-mediator;1"
3312 "getService")
3313 (js< "Components" "interfaces"
3314 "nsIWindowMediator"))
3315 with enumerator = (js! (window-mediator "getEnumerator") nil)
3316
3317 while (js? (js! (enumerator "hasMoreElements")))
3318 for window = (js! (enumerator "getNext"))
3319 for window-info = (js-list window
3320 (js< window "document" "title")
3321 (js! (window "location" "toString"))
3322 (js< window "closed")
3323 (js< window "windowState"))
3324
3325 unless (or (js? (cl-fourth window-info))
3326 (eq (cl-fifth window-info) 2))
3327 do (push window-info windows))
3328
3329 (cl-loop for window-info in windows
3330 for window = (cl-first window-info)
3331 collect (list (cl-second window-info)
3332 (cl-third window-info)
3333 window)
3334
3335 for gbrowser = (js< window "gBrowser")
3336 if (js-handle? gbrowser)
3337 nconc (cl-loop
3338 for x below (js< gbrowser "browsers" "length")
3339 collect (js-list (js< gbrowser
3340 "browsers"
3341 x
3342 "contentDocument"
3343 "title")
3344
3345 (js! (gbrowser
3346 "browsers"
3347 x
3348 "contentWindow"
3349 "location"
3350 "toString"))
3351 (js< gbrowser
3352 "browsers"
3353 x)
3354
3355 (js! (gbrowser
3356 "tabContainer"
3357 "childNodes"
3358 "item")
3359 x)
3360
3361 gbrowser))))))
3362
3363 (defvar js-read-tab-history nil)
3364
3365 (declare-function ido-chop "ido" (items elem))
3366
3367 (defun js--read-tab (prompt)
3368 "Read a Mozilla tab with prompt PROMPT.
3369 Return a cons of (TYPE . OBJECT). TYPE is either `window' or
3370 `tab', and OBJECT is a JavaScript handle to a ChromeWindow or a
3371 browser, respectively."
3372
3373 ;; Prime IDO
3374 (unless ido-mode
3375 (ido-mode 1)
3376 (ido-mode -1))
3377
3378 (with-js
3379 (let ((tabs (js--get-tabs)) selected-tab-cname
3380 selected-tab prev-hitab)
3381
3382 ;; Disambiguate names
3383 (setq tabs
3384 (cl-loop with tab-names = (make-hash-table :test 'equal)
3385 for tab in tabs
3386 for cname = (format "%s (%s)"
3387 (cl-second tab) (cl-first tab))
3388 for num = (cl-incf (gethash cname tab-names -1))
3389 if (> num 0)
3390 do (setq cname (format "%s <%d>" cname num))
3391 collect (cons cname tab)))
3392
3393 (cl-labels
3394 ((find-tab-by-cname
3395 (cname)
3396 (cl-loop for tab in tabs
3397 if (equal (car tab) cname)
3398 return (cdr tab)))
3399
3400 (mogrify-highlighting
3401 (hitab unhitab)
3402
3403 ;; Hack to reduce the number of
3404 ;; round-trips to mozilla
3405 (let (cmds)
3406 (cond
3407 ;; Highlighting tab
3408 ((cl-fourth hitab)
3409 (push '(js! ((cl-fourth hitab) "setAttribute")
3410 "style"
3411 "color: red; font-weight: bold")
3412 cmds)
3413
3414 ;; Highlight window proper
3415 (push '(js! ((cl-third hitab)
3416 "setAttribute")
3417 "style"
3418 "border: 8px solid red")
3419 cmds)
3420
3421 ;; Select tab, when appropriate
3422 (when js-js-switch-tabs
3423 (push
3424 '(js> ((cl-fifth hitab) "selectedTab") (cl-fourth hitab))
3425 cmds)))
3426
3427 ;; Highlighting whole window
3428 ((cl-third hitab)
3429 (push '(js! ((cl-third hitab) "document"
3430 "documentElement" "setAttribute")
3431 "style"
3432 (concat "-moz-appearance: none;"
3433 "border: 8px solid red;"))
3434 cmds)))
3435
3436 (cond
3437 ;; Unhighlighting tab
3438 ((cl-fourth unhitab)
3439 (push '(js! ((cl-fourth unhitab) "setAttribute") "style" "")
3440 cmds)
3441 (push '(js! ((cl-third unhitab) "setAttribute") "style" "")
3442 cmds))
3443
3444 ;; Unhighlighting window
3445 ((cl-third unhitab)
3446 (push '(js! ((cl-third unhitab) "document"
3447 "documentElement" "setAttribute")
3448 "style" "")
3449 cmds)))
3450
3451 (eval (list 'with-js
3452 (cons 'js-list (nreverse cmds))))))
3453
3454 (command-hook
3455 ()
3456 (let* ((tab (find-tab-by-cname (car ido-matches))))
3457 (mogrify-highlighting tab prev-hitab)
3458 (setq prev-hitab tab)))
3459
3460 (setup-hook
3461 ()
3462 ;; Fiddle with the match list a bit: if our first match
3463 ;; is a tabbrowser window, rotate the match list until
3464 ;; the active tab comes up
3465 (let ((matched-tab (find-tab-by-cname (car ido-matches))))
3466 (when (and matched-tab
3467 (null (cl-fourth matched-tab))
3468 (equal "navigator:browser"
3469 (js! ((cl-third matched-tab)
3470 "document"
3471 "documentElement"
3472 "getAttribute")
3473 "windowtype")))
3474
3475 (cl-loop with tab-to-match = (js< (cl-third matched-tab)
3476 "gBrowser"
3477 "selectedTab")
3478
3479 for match in ido-matches
3480 for candidate-tab = (find-tab-by-cname match)
3481 if (eq (cl-fourth candidate-tab) tab-to-match)
3482 do (setq ido-cur-list
3483 (ido-chop ido-cur-list match))
3484 and return t)))
3485
3486 (add-hook 'post-command-hook #'command-hook t t)))
3487
3488
3489 (unwind-protect
3490 (setq selected-tab-cname
3491 (let ((ido-minibuffer-setup-hook
3492 (cons #'setup-hook ido-minibuffer-setup-hook)))
3493 (ido-completing-read
3494 prompt
3495 (mapcar #'car tabs)
3496 nil t nil
3497 'js-read-tab-history)))
3498
3499 (when prev-hitab
3500 (mogrify-highlighting nil prev-hitab)
3501 (setq prev-hitab nil)))
3502
3503 (add-to-history 'js-read-tab-history selected-tab-cname)
3504
3505 (setq selected-tab (cl-loop for tab in tabs
3506 if (equal (car tab) selected-tab-cname)
3507 return (cdr tab)))
3508
3509 (cons (if (cl-fourth selected-tab) 'browser 'window)
3510 (cl-third selected-tab))))))
3511
3512 (defun js--guess-eval-defun-info (pstate)
3513 "Helper function for `js-eval-defun'.
3514 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3515 strings making up the class name and NAME is the name of the
3516 function part."
3517 (cond ((and (= (length pstate) 3)
3518 (eq (js--pitem-type (cl-first pstate)) 'function)
3519 (= (length (js--pitem-name (cl-first pstate))) 1)
3520 (consp (js--pitem-type (cl-second pstate))))
3521
3522 (append (js--pitem-name (cl-second pstate))
3523 (list (cl-first (js--pitem-name (cl-first pstate))))))
3524
3525 ((and (= (length pstate) 2)
3526 (eq (js--pitem-type (cl-first pstate)) 'function))
3527
3528 (append
3529 (butlast (js--pitem-name (cl-first pstate)))
3530 (list (car (last (js--pitem-name (cl-first pstate)))))))
3531
3532 (t (error "Function not a toplevel defun or class member"))))
3533
3534 (defvar js--js-context nil
3535 "The current JavaScript context.
3536 This is a cons like the one returned from `js--read-tab'.
3537 Change with `js-set-js-context'.")
3538
3539 (defconst js--js-inserter
3540 "(function(func_info,func) {
3541 func_info.unshift('window');
3542 var obj = window;
3543 for(var i = 1; i < func_info.length - 1; ++i) {
3544 var next = obj[func_info[i]];
3545 if(typeof next !== 'object' && typeof next !== 'function') {
3546 next = obj.prototype && obj.prototype[func_info[i]];
3547 if(typeof next !== 'object' && typeof next !== 'function') {
3548 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3549 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3550 return;
3551 }
3552
3553 func_info.splice(i+1, 0, 'prototype');
3554 ++i;
3555 }
3556 }
3557
3558 obj[func_info[i]] = func;
3559 alert('Successfully updated '+func_info.join('.'));
3560 })")
3561
3562 (defun js-set-js-context (context)
3563 "Set the JavaScript context to CONTEXT.
3564 When called interactively, prompt for CONTEXT."
3565 (interactive (list (js--read-tab "Javascript Context: ")))
3566 (setq js--js-context context))
3567
3568 (defun js--get-js-context ()
3569 "Return a valid JavaScript context.
3570 If one hasn't been set, or if it's stale, prompt for a new one."
3571 (with-js
3572 (when (or (null js--js-context)
3573 (js--js-handle-expired-p (cdr js--js-context))
3574 (pcase (car js--js-context)
3575 (`window (js? (js< (cdr js--js-context) "closed")))
3576 (`browser (not (js? (js< (cdr js--js-context)
3577 "contentDocument"))))
3578 (x (error "Unmatched case in js--get-js-context: %S" x))))
3579 (setq js--js-context (js--read-tab "Javascript Context: ")))
3580 js--js-context))
3581
3582 (defun js--js-content-window (context)
3583 (with-js
3584 (pcase (car context)
3585 (`window (cdr context))
3586 (`browser (js< (cdr context)
3587 "contentWindow" "wrappedJSObject"))
3588 (x (error "Unmatched case in js--js-content-window: %S" x)))))
3589
3590 (defun js--make-nsilocalfile (path)
3591 (with-js
3592 (let ((file (js-create-instance "@mozilla.org/file/local;1"
3593 "nsILocalFile")))
3594 (js! (file "initWithPath") path)
3595 file)))
3596
3597 (defun js--js-add-resource-alias (alias path)
3598 (with-js
3599 (let* ((io-service (js-get-service "@mozilla.org/network/io-service;1"
3600 "nsIIOService"))
3601 (res-prot (js! (io-service "getProtocolHandler") "resource"))
3602 (res-prot (js-qi res-prot "nsIResProtocolHandler"))
3603 (path-file (js--make-nsilocalfile path))
3604 (path-uri (js! (io-service "newFileURI") path-file)))
3605 (js! (res-prot "setSubstitution") alias path-uri))))
3606
3607 (cl-defun js-eval-defun ()
3608 "Update a Mozilla tab using the JavaScript defun at point."
3609 (interactive)
3610
3611 ;; This function works by generating a temporary file that contains
3612 ;; the function we'd like to insert. We then use the elisp-js bridge
3613 ;; to command mozilla to load this file by inserting a script tag
3614 ;; into the document we set. This way, debuggers and such will have
3615 ;; a way to find the source of the just-inserted function.
3616 ;;
3617 ;; We delete the temporary file if there's an error, but otherwise
3618 ;; we add an unload event listener on the Mozilla side to delete the
3619 ;; file.
3620
3621 (save-excursion
3622 (let (begin end pstate defun-info temp-name defun-body)
3623 (js-end-of-defun)
3624 (setq end (point))
3625 (js--ensure-cache)
3626 (js-beginning-of-defun)
3627 (re-search-forward "\\_<function\\_>")
3628 (setq begin (match-beginning 0))
3629 (setq pstate (js--forward-pstate))
3630
3631 (when (or (null pstate)
3632 (> (point) end))
3633 (error "Could not locate function definition"))
3634
3635 (setq defun-info (js--guess-eval-defun-info pstate))
3636
3637 (let ((overlay (make-overlay begin end)))
3638 (overlay-put overlay 'face 'highlight)
3639 (unwind-protect
3640 (unless (y-or-n-p (format "Send %s to Mozilla? "
3641 (mapconcat #'identity defun-info ".")))
3642 (message "") ; question message lingers until next command
3643 (cl-return-from js-eval-defun))
3644 (delete-overlay overlay)))
3645
3646 (setq defun-body (buffer-substring-no-properties begin end))
3647
3648 (make-directory js-js-tmpdir t)
3649
3650 ;; (Re)register a Mozilla resource URL to point to the
3651 ;; temporary directory
3652 (js--js-add-resource-alias "js" js-js-tmpdir)
3653
3654 (setq temp-name (make-temp-file (concat js-js-tmpdir
3655 "/js-")
3656 nil ".js"))
3657 (unwind-protect
3658 (with-js
3659 (with-temp-buffer
3660 (insert js--js-inserter)
3661 (insert "(")
3662 (insert (json-encode-list defun-info))
3663 (insert ",\n")
3664 (insert defun-body)
3665 (insert "\n)")
3666 (write-region (point-min) (point-max) temp-name
3667 nil 1))
3668
3669 ;; Give Mozilla responsibility for deleting this file
3670 (let* ((content-window (js--js-content-window
3671 (js--get-js-context)))
3672 (content-document (js< content-window "document"))
3673 (head (if (js? (js< content-document "body"))
3674 ;; Regular content
3675 (js< (js! (content-document "getElementsByTagName")
3676 "head")
3677 0)
3678 ;; Chrome
3679 (js< content-document "documentElement")))
3680 (elem (js! (content-document "createElementNS")
3681 "http://www.w3.org/1999/xhtml" "script")))
3682
3683 (js! (elem "setAttribute") "type" "text/javascript")
3684 (js! (elem "setAttribute") "src"
3685 (format "resource://js/%s"
3686 (file-name-nondirectory temp-name)))
3687
3688 (js! (head "appendChild") elem)
3689
3690 (js! (content-window "addEventListener") "unload"
3691 (js! ((js-new
3692 "Function" "file"
3693 "return function() { file.remove(false) }"))
3694 (js--make-nsilocalfile temp-name))
3695 'false)
3696 (setq temp-name nil)
3697
3698
3699
3700 ))
3701
3702 ;; temp-name is set to nil on success
3703 (when temp-name
3704 (delete-file temp-name))))))
3705
3706 ;;; Main Function
3707
3708 ;;;###autoload
3709 (define-derived-mode js-mode prog-mode "JavaScript"
3710 "Major mode for editing JavaScript."
3711 :group 'js
3712 (setq-local indent-line-function 'js-indent-line)
3713 (setq-local beginning-of-defun-function 'js-beginning-of-defun)
3714 (setq-local end-of-defun-function 'js-end-of-defun)
3715 (setq-local open-paren-in-column-0-is-defun-start nil)
3716 (setq-local font-lock-defaults (list js--font-lock-keywords))
3717 (setq-local syntax-propertize-function #'js-syntax-propertize)
3718 (setq-local prettify-symbols-alist js--prettify-symbols-alist)
3719
3720 (setq-local parse-sexp-ignore-comments t)
3721 (setq-local parse-sexp-lookup-properties t)
3722 (setq-local which-func-imenu-joiner-function #'js--which-func-joiner)
3723
3724 ;; Comments
3725 (setq-local comment-start "// ")
3726 (setq-local comment-end "")
3727 (setq-local fill-paragraph-function 'js-c-fill-paragraph)
3728
3729 ;; Parse cache
3730 (add-hook 'before-change-functions #'js--flush-caches t t)
3731
3732 ;; Frameworks
3733 (js--update-quick-match-re)
3734
3735 ;; Imenu
3736 (setq imenu-case-fold-search nil)
3737 (setq imenu-create-index-function #'js--imenu-create-index)
3738
3739 ;; for filling, pretend we're cc-mode
3740 (setq c-comment-prefix-regexp "//+\\|\\**"
3741 c-paragraph-start "\\(@[[:alpha:]]+\\>\\|$\\)"
3742 c-paragraph-separate "$"
3743 c-block-comment-prefix "* "
3744 c-line-comment-starter "//"
3745 c-comment-start-regexp "/[*/]\\|\\s!"
3746 comment-start-skip "\\(//+\\|/\\*+\\)\\s *")
3747
3748 (setq-local electric-indent-chars
3749 (append "{}():;," electric-indent-chars)) ;FIXME: js2-mode adds "[]*".
3750 (setq-local electric-layout-rules
3751 '((?\; . after) (?\{ . after) (?\} . before)))
3752
3753 (let ((c-buffer-is-cc-mode t))
3754 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3755 ;; we call it instead? (Bug#6071)
3756 (make-local-variable 'paragraph-start)
3757 (make-local-variable 'paragraph-separate)
3758 (make-local-variable 'paragraph-ignore-fill-prefix)
3759 (make-local-variable 'adaptive-fill-mode)
3760 (make-local-variable 'adaptive-fill-regexp)
3761 (c-setup-paragraph-variables))
3762
3763 ;; Important to fontify the whole buffer syntactically! If we don't,
3764 ;; then we might have regular expression literals that aren't marked
3765 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3766 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3767 ;; When we attempt to find the error and scroll to the portion of
3768 ;; the buffer containing the problem, JIT-lock will apply the
3769 ;; correct syntax to the regular expression literal and the problem
3770 ;; will mysteriously disappear.
3771 ;; FIXME: We should instead do this fontification lazily by adding
3772 ;; calls to syntax-propertize wherever it's really needed.
3773 ;;(syntax-propertize (point-max))
3774 )
3775
3776 ;;;###autoload
3777 (define-derived-mode js-jsx-mode js-mode "JSX"
3778 "Major mode for editing JSX.
3779
3780 To customize the indentation for this mode, set the SGML offset
3781 variables (`sgml-basic-offset', `sgml-attribute-offset' et al.)
3782 locally, like so:
3783
3784 (defun set-jsx-indentation ()
3785 (setq-local sgml-basic-offset js-indent-level))
3786 (add-hook \\='js-jsx-mode-hook #\\='set-jsx-indentation)"
3787 :group 'js
3788 (setq-local indent-line-function #'js-jsx-indent-line))
3789
3790 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3791
3792 (eval-after-load 'folding
3793 '(when (fboundp 'folding-add-to-marks-list)
3794 (folding-add-to-marks-list 'js-mode "// {{{" "// }}}" )))
3795
3796 ;;;###autoload
3797 (dolist (name (list "node" "nodejs" "gjs" "rhino"))
3798 (add-to-list 'interpreter-mode-alist (cons (purecopy name) 'js-mode)))
3799
3800 (provide 'js)
3801
3802 ;; js.el ends here