Restart blink cursor timers on interval changes
[emacs.git] / lisp / progmodes / js.el
blob5d5d101835aa11ae20380971aeda059b0147f97a
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
3 ;; Copyright (C) 2008-2016 Free Software Foundation, Inc.
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
12 ;; This file is part of GNU Emacs.
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.
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.
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/>.
27 ;;; Commentary
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).
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.
38 ;; General Remarks:
40 ;; XXX: This mode assumes that block comments are not nested inside block
41 ;; XXX: comments
43 ;; Exported names start with "js-"; private names start with
44 ;; "js--".
46 ;;; Code:
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)
57 (eval-when-compile
58 (require 'cl-lib)
59 (require 'ido))
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" (&optional arg))
66 (declare-function inferior-moz-process "ext:mozrepl" ())
68 ;;; Constants
70 (defconst js--name-start-re "[a-zA-Z_$]"
71 "Regexp matching the start of a JavaScript identifier, without grouping.")
73 (defconst js--stmt-delim-chars "^;{}?:")
75 (defconst js--name-re (concat js--name-start-re
76 "\\(?:\\s_\\|\\sw\\)*")
77 "Regexp matching a JavaScript identifier, without grouping.")
79 (defconst js--objfield-re (concat js--name-re ":")
80 "Regexp matching the start of a JavaScript object field.")
82 (defconst js--dotted-name-re
83 (concat js--name-re "\\(?:\\." js--name-re "\\)*")
84 "Regexp matching a dot-separated sequence of JavaScript names.")
86 (defconst js--cpp-name-re js--name-re
87 "Regexp matching a C preprocessor name.")
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.")
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.")
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: ...}\".")
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-*$"))
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()"))
122 (defconst js--prototype-objextend-class-decl-re-1
123 (concat "^\\s-*Object\\.extend\\s-*("
124 "\\(" js--dotted-name-re "\\)"
125 "\\s-*,\\s-*{"))
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-*("))
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-*\\)?{?"))
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 "\\)"))
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).")
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).")
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.")
162 (defconst js--dummy-class-style
163 '(:name "[Automatically Generated Class]"))
165 (defconst js--class-styles
166 `((:name "Plain"
167 :class-decl ,js--plain-class-re
168 :prototype t
169 :contexts (toplevel)
170 :framework javascript)
172 (:name "MochiKit"
173 :class-decl ,js--mochikit-class-re
174 :prototype t
175 :contexts (toplevel)
176 :framework mochikit)
178 (:name "Prototype (Obsolete)"
179 :class-decl ,js--prototype-obsolete-class-decl-re
180 :contexts (toplevel)
181 :framework prototype)
183 (:name "Prototype (Modern)"
184 :class-decl ,js--prototype-class-decl-re
185 :contexts (toplevel)
186 :framework prototype)
188 (:name "Prototype (Object.extend)"
189 :class-decl ,js--prototype-objextend-class-decl-re-1
190 :prototype t
191 :contexts (toplevel)
192 :framework prototype)
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)
200 (:name "Dojo"
201 :class-decl ,js--dojo-class-decl-re
202 :contexts (toplevel)
203 :framework dojo)
205 (:name "ExtJS (style 1)"
206 :class-decl ,js--extjs-class-decl-re-1
207 :prototype t
208 :contexts (toplevel)
209 :framework extjs)
211 (:name "ExtJS (style 2)"
212 :class-decl ,js--extjs-class-decl-re-2
213 :contexts (toplevel)
214 :framework extjs)
216 (:name "Merrill Press"
217 :class-decl ,js--mp-class-decl-re
218 :contexts (toplevel)
219 :framework merrillpress))
221 "List of JavaScript class definition styles.
223 A class definition style is a plist with the following keys:
225 :name is a human-readable name of the class type
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.
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.
238 If :strip-prototype is present and non-nil, then if the class
239 name as matched contains
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.")
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.")
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.")
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.")
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.")
274 (defun js--regexp-opt-symbol (list)
275 "Like `regexp-opt', but surround the result with `\\\\_<' and `\\\\_>'."
276 (concat "\\_<" (regexp-opt list t) "\\_>"))
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.")
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.")
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.")
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'.")
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'.")
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:
327 ;; function foo(a,b,c) { return 42; }
328 ;; ^ ^ ^
329 ;; | | |
330 ;; +- h-begin +- h-end +- b-end
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.)
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.
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.
347 ;; The three points obey the following relationship:
349 ;; h-begin < h-end <= b-end
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.
354 ;; The text property for h-end, js--pstate, is actually a list
355 ;; of all js--pitem instances open after the marked character.
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.)
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.
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.)
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.
381 ;; List of children inside this pitem's body
382 (children nil :read-only t)
384 ;; When we reach this paren depth after h-end, the pitem ends
385 (paren-depth nil :read-only t)
387 ;; Symbol or class-style plist if this is a class
388 (type nil :read-only t)
390 ;; See above
391 (h-begin nil :read-only t)
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)
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.
402 ;; The field value is either a number (buffer location) or nil if
403 ;; unknown.
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.)
411 (b-end nil))
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))
419 ;;; User Customization
421 (defgroup js nil
422 "Customization variables for JavaScript mode."
423 :tag "JavaScript"
424 :group 'languages)
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)
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)
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")
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")
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")
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")
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)
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)
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)
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)
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)
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)
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:
518 var o = {
519 foo: 3
522 var o = {
523 foo: 3
525 bar = 2;
527 If this option has the value t, indent the first declaration's
528 initializer by an additional level:
530 var o = {
531 foo: 3
534 var o = {
535 foo: 3
537 bar = 2;
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.
542 var o = {
543 foo: 3
546 var o = {
547 foo: 3
549 bar = 2;"
550 :version "25.1"
551 :type '(choice (const nil) (const t) (const dynamic))
552 :safe 'symbolp
553 :group 'js)
555 ;;; KeyMap
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'.")
574 ;;; Syntax table and parsing
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'.")
584 (defvar js--quick-match-re nil
585 "Autogenerated regexp used by `js-mode' to match buffer constructs.")
587 (defvar js--quick-match-re-func nil
588 "Autogenerated regexp used by `js-mode' to match constructs and functions.")
590 (make-variable-buffer-local 'js--quick-match-re)
591 (make-variable-buffer-local 'js--quick-match-re-func)
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)
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)
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)
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)))))
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)))
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]*\\(?:" "\\|" "\\)"
630 ;; #define mumble
631 "#define[ \t]+[a-zA-Z_]"
633 (when (memq 'extjs js-enabled-frameworks)
634 "Ext\\.extend")
636 (when (memq 'prototype js-enabled-frameworks)
637 "Object\\.extend")
639 ;; var mumble = THING (
640 (js--maybe-join
641 "\\(?:var[ \t]+\\)?[a-zA-Z_$0-9.]+[ \t]*=[ \t]*\\(?:"
642 "\\|"
643 "\\)[ \t]*("
645 (when (memq 'prototype js-enabled-frameworks)
646 "Class\\.create")
648 (when (memq 'extjs js-enabled-frameworks)
649 "Ext\\.extend")
651 (when (memq 'merrillpress js-enabled-frameworks)
652 "[a-zA-Z_$0-9]+\\.extend\\(?:Final\\)?"))
654 (when (memq 'dojo js-enabled-frameworks)
655 "dojo\\.declare[ \t]*(")
657 (when (memq 'mochikit js-enabled-frameworks)
658 "MochiKit\\.Base\\.update[ \t]*(")
660 ;; mumble.prototypeTHING
661 (js--maybe-join
662 "[a-zA-Z_$0-9.]+\\.prototype\\(?:" "\\|" "\\)"
664 (when (memq 'javascript js-enabled-frameworks)
665 '( ;; foo.prototype.bar = function(
666 "\\.[a-zA-Z_$0-9]+[ \t]*=[ \t]*function[ \t]*("
668 ;; mumble.prototype = {
669 "[ \t]*=[ \t]*{")))))
671 (setq js--quick-match-re-func
672 (concat "function\\|" js--quick-match-re)))
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)
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)))
688 next-value))
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)
700 (goto-char (previous-single-property-change
701 (point) propname nil (point-min)))
703 (unless (bobp)
704 (backward-char)
705 (setq prev-value (get-text-property (point) propname))))
707 prev-value)))
709 (defsubst js--forward-pstate ()
710 (js--forward-text-property 'js--pstate))
712 (defsubst js--backward-pstate ()
713 (js--backward-text-property 'js--pstate))
715 (defun js--pitem-goto-h-end (pitem)
716 (goto-char (js--pitem-h-begin pitem))
717 (js--forward-pstate))
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))
746 (setq count (1- count))))))
747 (point))
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.
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)))))))
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)))
801 (setq count (1- count))))))
802 (point))
805 (defun js--re-search-backward (regexp &optional bound noerror count)
806 "Search backward, ignoring strings, preprocessor macros, and comments.
808 This function invokes `re-search-backward' but treats the buffer
809 as if strings, preprocessor macros, and comments have been
810 removed.
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)))
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))
827 while (and (eq (char-after) ?\n)
828 (save-excursion
829 (forward-char)
830 (js--continued-expression-p)))))
832 (defun js--forward-function-decl ()
833 "Move forward over a JavaScript function declaration.
834 This puts point at the `function' keyword.
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-strictly)
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)))))
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)))
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)))
872 (setq prologue-begin (match-beginning 1))
873 (when (<= prologue-begin pos)
874 (goto-char (match-end 0))))
876 (skip-syntax-backward "w_")
877 (and (or (looking-at "\\_<function\\_>")
878 (js--re-search-backward "\\_<function\\_>" nil t))
880 (save-match-data (goto-char (match-beginning 0))
881 (js--forward-function-decl))
883 (<= pos (point))
884 (or prologue-begin (match-beginning 0))))))
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)))
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)))
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."
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)
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)))
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))))))
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))
944 (if (js--re-search-forward
945 "\\_<function\\_>" nil t)
946 (goto-char (js--function-prologue-beginning))
947 (goto-char (point-max))))
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))
956 (let ((prologue-begin (js--function-prologue-beginning)))
957 (cond ((and prologue-begin (< prologue-begin (point)))
958 (goto-char prologue-begin))
960 (js-flat-functions
961 (js--beginning-of-defun-flat))
963 (js--beginning-of-defun-nested))))))
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)))
972 (defmacro js--debug (&rest _arguments)
973 ;; `(message ,@arguments)
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)
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))
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)))
1019 (setq prev-parse-point (point))
1020 (< (point) goal-point)))
1022 (setq open-items (js--ensure-cache--pop-if-ended
1023 open-items (car parse)))))
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))))
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"))
1041 (setq name (remove "prototype" name)))))
1043 (defvar js--guess-function-name-start nil)
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.
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)))
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))))))
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))))
1078 ;; Remove any cache properties after this point
1079 (remove-text-properties (point) (point-max)
1080 '(js--pstate t js--pend t)))
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)
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)
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))
1104 (save-excursion
1105 (save-restriction
1106 (widen)
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))
1114 (unless open-items
1115 (goto-char (previous-single-property-change
1116 (point) 'js--pstate nil (point-min)))
1118 (unless (bobp)
1119 (setq open-items (get-text-property (1- (point))
1120 'js--pstate))
1121 (cl-assert open-items))))
1123 (unless open-items
1124 ;; Make a placeholder for the top-level definition
1125 (setq open-items (list js--initial-pitem)))
1127 (setq parse (syntax-ppss))
1128 (setq prev-parse-point (point))
1130 (js--clear-stale-cache)
1132 (narrow-to-region (point-min) limit)
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)
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)
1151 ;; Regular function declaration
1152 ((and (looking-at "\\_<function\\_>")
1153 (setq name (js--forward-function-decl)))
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))
1162 (setq name t)))
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))))
1174 ;; Macro
1175 ((looking-at js--macro-decl-re)
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)
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))))
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))))))
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))))))
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))
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 )))))
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))))
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)
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)
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))))))
1265 (if found (forward-list)
1266 ;; ... or eob.
1267 (goto-char (point-max))))))
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)))
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)
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))
1298 (t (js--end-of-defun-nested)))))))
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))
1311 (goto-char here)
1312 nil))))
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)))
1319 (let ((in-macro (save-excursion (js--beginning-of-macro)))
1320 (pos (point)))
1322 (while (progn (unless in-macro (js--beginning-of-macro))
1323 (forward-comment most-negative-fixnum)
1324 (/= (point)
1325 (prog1
1327 (setq pos (point)))))))))
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
1341 (setq pos (point)))))))))
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)))
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"))))))))
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)))))))
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)))))
1385 (defvar js--tmp-location nil)
1386 (make-variable-buffer-local 'js--tmp-location)
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))
1402 ((eq (char-after) ?,)
1403 (forward-char)
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)
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))
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))))
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)
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)
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)))
1458 ((save-excursion
1459 (js--forward-destructuring-spec))
1461 (js--forward-destructuring-spec
1462 (lambda ()
1463 (font-lock-apply-highlight
1464 '(0 font-lock-variable-name-face)))))))
1466 (forward-comment most-positive-fixnum)
1467 (when (eq (char-after) ?=)
1468 (forward-char)
1469 (js--forward-expression)
1470 (forward-comment most-positive-fixnum))
1472 (setq first nil))))
1474 ;; Conditions to handle
1475 (scan-error nil)
1476 (end-of-buffer nil))
1478 ;; Matcher always "fails"
1479 nil)
1481 (defconst js--font-lock-keywords-3
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
1490 ,@js--font-lock-keywords-2
1492 ("\\.\\(prototype\\)\\_>"
1493 (1 font-lock-constant-face))
1495 ;; Highlights class being declared, in parts
1496 (js--class-decl-matcher
1497 ,(concat "\\(" js--name-re "\\)\\(?:\\.\\|.*$\\)")
1498 (goto-char (match-beginning 1))
1500 (1 font-lock-type-face))
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))
1519 ;; Highlights parent class
1520 (js--class-decl-matcher
1521 (2 font-lock-type-face nil t))
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))
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))
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))
1557 ;; variable declarations
1558 ,(list
1559 (concat "\\_<\\(const\\|var\\|let\\)\\_>\\|" js--basic-type-re)
1560 (list #'js--variable-decl-matcher nil nil nil))
1562 ;; class instantiation
1563 ,(list
1564 (concat "\\_<new\\_>\\s-+\\(" js--dotted-name-re "\\)")
1565 (list 1 'font-lock-type-face))
1567 ;; instanceof
1568 ,(list
1569 (concat "\\_<instanceof\\_>\\s-+\\(" js--dotted-name-re "\\)")
1570 (list 1 'font-lock-type-face))
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)))
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'.")
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))
1601 (and (> (point) (js--pitem-h-begin pitem))
1602 (or (null (js--pitem-b-end pitem))
1603 (> (js--pitem-b-end pitem) (point)))))
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))))
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))
1626 pstate))))
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))))
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))))
1645 (when (called-interactively-p 'interactive)
1646 (message "Syntactic context: %s" syntactic-context))
1648 syntactic-context))
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)))
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'.")
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))
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.
1696 (put-text-property (1- (point)) (point)
1697 'syntax-table (string-to-syntax "\"/"))
1698 nil))))))
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 ("\\`\\(#\\)!" (1 "< b")))
1727 (point) end))
1729 (defconst js--prettify-symbols-alist
1730 '(("=>" . ?⇒)
1731 (">=" . ?≥)
1732 ("<=" . ?≤))
1733 "Alist of symbol prettifications for JavaScript.")
1735 ;;; Indentation
1737 (defconst js--possibly-braceless-keyword-re
1738 (js--regexp-opt-symbol
1739 '("catch" "do" "else" "finally" "for" "if" "try" "while" "with"
1740 "each"))
1741 "Regexp matching keywords optionally followed by an opening brace.")
1743 (defconst js--declaration-keyword-re
1744 (regexp-opt '("var" "let" "const") 'words)
1745 "Regular expression matching variable declaration keywords.")
1747 (defconst js--indent-operator-re
1748 (concat "[-+*/%<>&^|?:.]\\([^-+*/.]\\|$\\)\\|!?=\\|"
1749 (js--regexp-opt-symbol '("in" "instanceof")))
1750 "Regexp matching operators that affect indentation of continued expressions.")
1752 (defun js--looking-at-operator-p ()
1753 "Return non-nil if point is on a JavaScript operator, other than a comma."
1754 (save-match-data
1755 (and (looking-at js--indent-operator-re)
1756 (or (not (eq (char-after) ?:))
1757 (save-excursion
1758 (and (js--re-search-backward "[?:{]\\|\\_<case\\_>" nil t)
1759 (eq (char-after) ??))))
1760 (not (and
1761 (eq (char-after) ?*)
1762 ;; Generator method (possibly using computed property).
1763 (looking-at (concat "\\* *\\(?:\\[\\|" js--name-re " *(\\)"))
1764 (save-excursion
1765 (js--backward-syntactic-ws)
1766 ;; We might misindent some expressions that would
1767 ;; return NaN anyway. Shouldn't be a problem.
1768 (memq (char-before) '(?, ?} ?{))))))))
1770 (defun js--continued-expression-p ()
1771 "Return non-nil if the current line continues an expression."
1772 (save-excursion
1773 (back-to-indentation)
1774 (if (js--looking-at-operator-p)
1775 (or (not (memq (char-after) '(?- ?+)))
1776 (progn
1777 (forward-comment (- (point)))
1778 (not (memq (char-before) '(?, ?\[ ?\()))))
1779 (and (js--re-search-backward "\n" nil t)
1780 (progn
1781 (skip-chars-backward " \t")
1782 (or (bobp) (backward-char))
1783 (and (> (point) (point-min))
1784 (save-excursion (backward-char) (not (looking-at "[/*]/")))
1785 (js--looking-at-operator-p)
1786 (and (progn (backward-char)
1787 (not (looking-at "+\\+\\|--\\|/[/*]"))))))))))
1790 (defun js--end-of-do-while-loop-p ()
1791 "Return non-nil if point is on the \"while\" of a do-while statement.
1792 Otherwise, return nil. A braceless do-while statement spanning
1793 several lines requires that the start of the loop is indented to
1794 the same column as the current line."
1795 (interactive)
1796 (save-excursion
1797 (save-match-data
1798 (when (looking-at "\\s-*\\_<while\\_>")
1799 (if (save-excursion
1800 (skip-chars-backward "[ \t\n]*}")
1801 (looking-at "[ \t\n]*}"))
1802 (save-excursion
1803 (backward-list) (forward-symbol -1) (looking-at "\\_<do\\_>"))
1804 (js--re-search-backward "\\_<do\\_>" (point-at-bol) t)
1805 (or (looking-at "\\_<do\\_>")
1806 (let ((saved-indent (current-indentation)))
1807 (while (and (js--re-search-backward "^\\s-*\\_<" nil t)
1808 (/= (current-indentation) saved-indent)))
1809 (and (looking-at "\\s-*\\_<do\\_>")
1810 (not (js--re-search-forward
1811 "\\_<while\\_>" (point-at-eol) t))
1812 (= (current-indentation) saved-indent)))))))))
1815 (defun js--ctrl-statement-indentation ()
1816 "Helper function for `js--proper-indentation'.
1817 Return the proper indentation of the current line if it starts
1818 the body of a control statement without braces; otherwise, return
1819 nil."
1820 (save-excursion
1821 (back-to-indentation)
1822 (when (save-excursion
1823 (and (not (eq (point-at-bol) (point-min)))
1824 (not (looking-at "[{]"))
1825 (js--re-search-backward "[[:graph:]]" nil t)
1826 (progn
1827 (or (eobp) (forward-char))
1828 (when (= (char-before) ?\)) (backward-list))
1829 (skip-syntax-backward " ")
1830 (skip-syntax-backward "w_")
1831 (looking-at js--possibly-braceless-keyword-re))
1832 (memq (char-before) '(?\s ?\t ?\n ?\}))
1833 (not (js--end-of-do-while-loop-p))))
1834 (save-excursion
1835 (goto-char (match-beginning 0))
1836 (+ (current-indentation) js-indent-level)))))
1838 (defun js--get-c-offset (symbol anchor)
1839 (let ((c-offsets-alist
1840 (list (cons 'c js-comment-lineup-func))))
1841 (c-get-syntactic-indentation (list (cons symbol anchor)))))
1843 (defun js--same-line (pos)
1844 (and (>= pos (point-at-bol))
1845 (<= pos (point-at-eol))))
1847 (defun js--multi-line-declaration-indentation ()
1848 "Helper function for `js--proper-indentation'.
1849 Return the proper indentation of the current line if it belongs to a declaration
1850 statement spanning multiple lines; otherwise, return nil."
1851 (let (at-opening-bracket)
1852 (save-excursion
1853 (back-to-indentation)
1854 (when (not (looking-at js--declaration-keyword-re))
1855 (when (looking-at js--indent-operator-re)
1856 (goto-char (match-end 0)))
1857 (while (and (not at-opening-bracket)
1858 (not (bobp))
1859 (let ((pos (point)))
1860 (save-excursion
1861 (js--backward-syntactic-ws)
1862 (or (eq (char-before) ?,)
1863 (and (not (eq (char-before) ?\;))
1864 (prog2
1865 (skip-syntax-backward ".")
1866 (looking-at js--indent-operator-re)
1867 (js--backward-syntactic-ws))
1868 (not (eq (char-before) ?\;)))
1869 (js--same-line pos)))))
1870 (condition-case nil
1871 (backward-sexp)
1872 (scan-error (setq at-opening-bracket t))))
1873 (when (looking-at js--declaration-keyword-re)
1874 (goto-char (match-end 0))
1875 (1+ (current-column)))))))
1877 (defun js--indent-in-array-comp (bracket)
1878 "Return non-nil if we think we're in an array comprehension.
1879 In particular, return the buffer position of the first `for' kwd."
1880 (let ((end (point)))
1881 (save-excursion
1882 (goto-char bracket)
1883 (when (looking-at "\\[")
1884 (forward-char 1)
1885 (js--forward-syntactic-ws)
1886 (if (looking-at "[[{]")
1887 (let (forward-sexp-function) ; Use Lisp version.
1888 (forward-sexp) ; Skip destructuring form.
1889 (js--forward-syntactic-ws)
1890 (if (and (/= (char-after) ?,) ; Regular array.
1891 (looking-at "for"))
1892 (match-beginning 0)))
1893 ;; To skip arbitrary expressions we need the parser,
1894 ;; so we'll just guess at it.
1895 (if (and (> end (point)) ; Not empty literal.
1896 (re-search-forward "[^,]]* \\(for\\_>\\)" end t)
1897 ;; Not inside comment or string literal.
1898 (let ((status (parse-partial-sexp bracket (point))))
1899 (and (= 1 (car status))
1900 (not (nth 8 status)))))
1901 (match-beginning 1)))))))
1903 (defun js--array-comp-indentation (bracket for-kwd)
1904 (if (js--same-line for-kwd)
1905 ;; First continuation line.
1906 (save-excursion
1907 (goto-char bracket)
1908 (forward-char 1)
1909 (skip-chars-forward " \t")
1910 (current-column))
1911 (save-excursion
1912 (goto-char for-kwd)
1913 (current-column))))
1915 (defun js--maybe-goto-declaration-keyword-end (parse-status)
1916 "Helper function for `js--proper-indentation'.
1917 Depending on the value of `js-indent-first-init', move
1918 point to the end of a variable declaration keyword so that
1919 indentation is aligned to that column."
1920 (cond
1921 ((eq js-indent-first-init t)
1922 (when (looking-at js--declaration-keyword-re)
1923 (goto-char (1+ (match-end 0)))))
1924 ((eq js-indent-first-init 'dynamic)
1925 (let ((bracket (nth 1 parse-status))
1926 declaration-keyword-end
1927 at-closing-bracket-p
1928 comma-p)
1929 (when (looking-at js--declaration-keyword-re)
1930 (setq declaration-keyword-end (match-end 0))
1931 (save-excursion
1932 (goto-char bracket)
1933 (setq at-closing-bracket-p
1934 (condition-case nil
1935 (progn
1936 (forward-sexp)
1938 (error nil)))
1939 (when at-closing-bracket-p
1940 (while (forward-comment 1))
1941 (setq comma-p (looking-at-p ","))))
1942 (when comma-p
1943 (goto-char (1+ declaration-keyword-end))))))))
1945 (defun js--proper-indentation (parse-status)
1946 "Return the proper indentation for the current line."
1947 (save-excursion
1948 (back-to-indentation)
1949 (cond ((nth 4 parse-status) ; inside comment
1950 (js--get-c-offset 'c (nth 8 parse-status)))
1951 ((nth 3 parse-status) 0) ; inside string
1952 ((eq (char-after) ?#) 0)
1953 ((save-excursion (js--beginning-of-macro)) 4)
1954 ;; Indent array comprehension continuation lines specially.
1955 ((let ((bracket (nth 1 parse-status))
1956 beg)
1957 (and bracket
1958 (not (js--same-line bracket))
1959 (setq beg (js--indent-in-array-comp bracket))
1960 ;; At or after the first loop?
1961 (>= (point) beg)
1962 (js--array-comp-indentation bracket beg))))
1963 ((js--ctrl-statement-indentation))
1964 ((js--multi-line-declaration-indentation))
1965 ((nth 1 parse-status)
1966 ;; A single closing paren/bracket should be indented at the
1967 ;; same level as the opening statement. Same goes for
1968 ;; "case" and "default".
1969 (let ((same-indent-p (looking-at "[]})]"))
1970 (switch-keyword-p (looking-at "default\\_>\\|case\\_>[^:]"))
1971 (continued-expr-p (js--continued-expression-p)))
1972 (goto-char (nth 1 parse-status)) ; go to the opening char
1973 (if (looking-at "[({[]\\s-*\\(/[/*]\\|$\\)")
1974 (progn ; nothing following the opening paren/bracket
1975 (skip-syntax-backward " ")
1976 (when (eq (char-before) ?\)) (backward-list))
1977 (back-to-indentation)
1978 (js--maybe-goto-declaration-keyword-end parse-status)
1979 (let* ((in-switch-p (unless same-indent-p
1980 (looking-at "\\_<switch\\_>")))
1981 (same-indent-p (or same-indent-p
1982 (and switch-keyword-p
1983 in-switch-p)))
1984 (indent
1985 (cond (same-indent-p
1986 (current-column))
1987 (continued-expr-p
1988 (+ (current-column) (* 2 js-indent-level)
1989 js-expr-indent-offset))
1991 (+ (current-column) js-indent-level
1992 (pcase (char-after (nth 1 parse-status))
1993 (?\( js-paren-indent-offset)
1994 (?\[ js-square-indent-offset)
1995 (?\{ js-curly-indent-offset)))))))
1996 (if in-switch-p
1997 (+ indent js-switch-indent-offset)
1998 indent)))
1999 ;; If there is something following the opening
2000 ;; paren/bracket, everything else should be indented at
2001 ;; the same level.
2002 (unless same-indent-p
2003 (forward-char)
2004 (skip-chars-forward " \t"))
2005 (current-column))))
2007 ((js--continued-expression-p)
2008 (+ js-indent-level js-expr-indent-offset))
2009 (t 0))))
2011 ;;; JSX Indentation
2013 (defsubst js--jsx-find-before-tag ()
2014 "Find where JSX starts.
2016 Assume JSX appears in the following instances:
2017 - Inside parentheses, when returned or as the first argument
2018 to a function, and after a newline
2019 - When assigned to variables or object properties, but only
2020 on a single line
2021 - As the N+1th argument to a function
2023 This is an optimized version of (re-search-backward \"[(,]\n\"
2024 nil t), except set point to the end of the match. This logic
2025 executes up to the number of lines in the file, so it should be
2026 really fast to reduce that impact."
2027 (let (pos)
2028 (while (and (> (point) (point-min))
2029 (not (progn
2030 (end-of-line 0)
2031 (when (or (eq (char-before) 40) ; (
2032 (eq (char-before) 44)) ; ,
2033 (setq pos (1- (point))))))))
2034 pos))
2036 (defconst js--jsx-end-tag-re
2037 (concat "</" sgml-name-re ">\\|/>")
2038 "Find the end of a JSX element.")
2040 (defconst js--jsx-after-tag-re "[),]"
2041 "Find where JSX ends.
2042 This complements the assumption of where JSX appears from
2043 `js--jsx-before-tag-re', which see.")
2045 (defun js--jsx-indented-element-p ()
2046 "Determine if/how the current line should be indented as JSX.
2048 Return `first' for the first JSXElement on its own line.
2049 Return `nth' for subsequent lines of the first JSXElement.
2050 Return `expression' for an embedded JS expression.
2051 Return `after' for anything after the last JSXElement.
2052 Return nil for non-JSX lines.
2054 Currently, JSX indentation supports the following styles:
2056 - Single-line elements (indented like normal JS):
2058 var element = <div></div>;
2060 - Multi-line elements (enclosed in parentheses):
2062 function () {
2063 return (
2064 <div>
2065 <div></div>
2066 </div>
2070 - Function arguments:
2072 React.render(
2073 <div></div>,
2074 document.querySelector('.root')
2076 (let ((current-pos (point))
2077 (current-line (line-number-at-pos))
2078 last-pos
2079 before-tag-pos before-tag-line
2080 tag-start-pos tag-start-line
2081 tag-end-pos tag-end-line
2082 after-tag-line
2083 parens paren type)
2084 (save-excursion
2085 (and
2086 ;; Determine if we're inside a jsx element
2087 (progn
2088 (end-of-line)
2089 (while (and (not tag-start-pos)
2090 (setq last-pos (js--jsx-find-before-tag)))
2091 (while (forward-comment 1))
2092 (when (= (char-after) 60) ; <
2093 (setq before-tag-pos last-pos
2094 tag-start-pos (point)))
2095 (goto-char last-pos))
2096 tag-start-pos)
2097 (progn
2098 (setq before-tag-line (line-number-at-pos before-tag-pos)
2099 tag-start-line (line-number-at-pos tag-start-pos))
2100 (and
2101 ;; A "before" line which also starts an element begins with js, so
2102 ;; indent it like js
2103 (> current-line before-tag-line)
2104 ;; Only indent the jsx lines like jsx
2105 (>= current-line tag-start-line)))
2106 (cond
2107 ;; Analyze bounds if there are any
2108 ((progn
2109 (while (and (not tag-end-pos)
2110 (setq last-pos (re-search-forward js--jsx-end-tag-re nil t)))
2111 (while (forward-comment 1))
2112 (when (looking-at js--jsx-after-tag-re)
2113 (setq tag-end-pos last-pos)))
2114 tag-end-pos)
2115 (setq tag-end-line (line-number-at-pos tag-end-pos)
2116 after-tag-line (line-number-at-pos after-tag-line))
2117 (or (and
2118 ;; Ensure we're actually within the bounds of the jsx
2119 (<= current-line tag-end-line)
2120 ;; An "after" line which does not end an element begins with
2121 ;; js, so indent it like js
2122 (<= current-line after-tag-line))
2123 (and
2124 ;; Handle another case where there could be e.g. comments after
2125 ;; the element
2126 (> current-line tag-end-line)
2127 (< current-line after-tag-line)
2128 (setq type 'after))))
2129 ;; They may not be any bounds (yet)
2130 (t))
2131 ;; Check if we're inside an embedded multi-line js expression
2132 (cond
2133 ((not type)
2134 (goto-char current-pos)
2135 (end-of-line)
2136 (setq parens (nth 9 (syntax-ppss)))
2137 (while (and parens (not type))
2138 (setq paren (car parens))
2139 (cond
2140 ((and (>= paren tag-start-pos)
2141 ;; Curly bracket indicates the start of an embedded expression
2142 (= (char-after paren) 123) ; {
2143 ;; The first line of the expression is indented like sgml
2144 (> current-line (line-number-at-pos paren))
2145 ;; Check if within a closing curly bracket (if any)
2146 ;; (exclusive, as the closing bracket is indented like sgml)
2147 (cond
2148 ((progn
2149 (goto-char paren)
2150 (ignore-errors (let (forward-sexp-function)
2151 (forward-sexp))))
2152 (< current-line (line-number-at-pos)))
2153 (t)))
2154 ;; Indicate this guy will be indented specially
2155 (setq type 'expression))
2156 (t (setq parens (cdr parens)))))
2158 (t))
2159 (cond
2160 (type)
2161 ;; Indent the first jsx thing like js so we can indent future jsx things
2162 ;; like sgml relative to the first thing
2163 ((= current-line tag-start-line) 'first)
2164 ('nth))))))
2166 (defmacro js--as-sgml (&rest body)
2167 "Execute BODY as if in sgml-mode."
2168 `(with-syntax-table sgml-mode-syntax-table
2169 (let (forward-sexp-function
2170 parse-sexp-lookup-properties)
2171 ,@body)))
2173 (defun js--expression-in-sgml-indent-line ()
2174 "Indent the current line as JavaScript or SGML (whichever is farther)."
2175 (let* (indent-col
2176 (savep (point))
2177 ;; Don't whine about errors/warnings when we're indenting.
2178 ;; This has to be set before calling parse-partial-sexp below.
2179 (inhibit-point-motion-hooks t)
2180 (parse-status (save-excursion
2181 (syntax-ppss (point-at-bol)))))
2182 ;; Don't touch multiline strings.
2183 (unless (nth 3 parse-status)
2184 (setq indent-col (save-excursion
2185 (back-to-indentation)
2186 (if (>= (point) savep) (setq savep nil))
2187 (js--as-sgml (sgml-calculate-indent))))
2188 (if (null indent-col)
2189 'noindent
2190 ;; Use whichever indentation column is greater, such that the sgml
2191 ;; column is effectively a minimum
2192 (setq indent-col (max (js--proper-indentation parse-status)
2193 (+ indent-col js-indent-level)))
2194 (if savep
2195 (save-excursion (indent-line-to indent-col))
2196 (indent-line-to indent-col))))))
2198 (defun js-indent-line ()
2199 "Indent the current line as JavaScript."
2200 (interactive)
2201 (let* ((parse-status
2202 (save-excursion (syntax-ppss (point-at-bol))))
2203 (offset (- (point) (save-excursion (back-to-indentation) (point)))))
2204 (unless (nth 3 parse-status)
2205 (indent-line-to (js--proper-indentation parse-status))
2206 (when (> offset 0) (forward-char offset)))))
2208 (defun js-jsx-indent-line ()
2209 "Indent the current line as JSX (with SGML offsets).
2210 i.e., customize JSX element indentation with `sgml-basic-offset',
2211 `sgml-attribute-offset' et al."
2212 (interactive)
2213 (let ((indentation-type (js--jsx-indented-element-p)))
2214 (cond
2215 ((eq indentation-type 'expression)
2216 (js--expression-in-sgml-indent-line))
2217 ((or (eq indentation-type 'first)
2218 (eq indentation-type 'after))
2219 ;; Don't treat this first thing as a continued expression (often a "<" or
2220 ;; ">" causes this misinterpretation)
2221 (cl-letf (((symbol-function #'js--continued-expression-p) 'ignore))
2222 (js-indent-line)))
2223 ((eq indentation-type 'nth)
2224 (js--as-sgml (sgml-indent-line)))
2225 (t (js-indent-line)))))
2227 ;;; Filling
2229 (defvar js--filling-paragraph nil)
2231 ;; FIXME: Such redefinitions are bad style. We should try and use some other
2232 ;; way to get the same result.
2233 (defadvice c-forward-sws (around js-fill-paragraph activate)
2234 (if js--filling-paragraph
2235 (setq ad-return-value (js--forward-syntactic-ws (ad-get-arg 0)))
2236 ad-do-it))
2238 (defadvice c-backward-sws (around js-fill-paragraph activate)
2239 (if js--filling-paragraph
2240 (setq ad-return-value (js--backward-syntactic-ws (ad-get-arg 0)))
2241 ad-do-it))
2243 (defadvice c-beginning-of-macro (around js-fill-paragraph activate)
2244 (if js--filling-paragraph
2245 (setq ad-return-value (js--beginning-of-macro (ad-get-arg 0)))
2246 ad-do-it))
2248 (defun js-c-fill-paragraph (&optional justify)
2249 "Fill the paragraph with `c-fill-paragraph'."
2250 (interactive "*P")
2251 (let ((js--filling-paragraph t)
2252 (fill-paragraph-function #'c-fill-paragraph))
2253 (c-fill-paragraph justify)))
2255 ;;; Type database and Imenu
2257 ;; We maintain a cache of semantic information, i.e., the classes and
2258 ;; functions we've encountered so far. In order to avoid having to
2259 ;; re-parse the buffer on every change, we cache the parse state at
2260 ;; each interesting point in the buffer. Each parse state is a
2261 ;; modified copy of the previous one, or in the case of the first
2262 ;; parse state, the empty state.
2264 ;; The parse state itself is just a stack of js--pitem
2265 ;; instances. It starts off containing one element that is never
2266 ;; closed, that is initially js--initial-pitem.
2270 (defun js--pitem-format (pitem)
2271 (let ((name (js--pitem-name pitem))
2272 (type (js--pitem-type pitem)))
2274 (format "name:%S type:%S"
2275 name
2276 (if (atom type)
2277 type
2278 (plist-get type :name)))))
2280 (defun js--make-merged-item (item child name-parts)
2281 "Helper function for `js--splice-into-items'.
2282 Return a new item that is the result of merging CHILD into
2283 ITEM. NAME-PARTS is a list of parts of the name of CHILD
2284 that we haven't consumed yet."
2285 (js--debug "js--make-merged-item: {%s} into {%s}"
2286 (js--pitem-format child)
2287 (js--pitem-format item))
2289 ;; If the item we're merging into isn't a class, make it into one
2290 (unless (consp (js--pitem-type item))
2291 (js--debug "js--make-merged-item: changing dest into class")
2292 (setq item (make-js--pitem
2293 :children (list item)
2295 ;; Use the child's class-style if it's available
2296 :type (if (atom (js--pitem-type child))
2297 js--dummy-class-style
2298 (js--pitem-type child))
2300 :name (js--pitem-strname item))))
2302 ;; Now we can merge either a function or a class into a class
2303 (cons (cond
2304 ((cdr name-parts)
2305 (js--debug "js--make-merged-item: recursing")
2306 ;; if we have more name-parts to go before we get to the
2307 ;; bottom of the class hierarchy, call the merger
2308 ;; recursively
2309 (js--splice-into-items (car item) child
2310 (cdr name-parts)))
2312 ((atom (js--pitem-type child))
2313 (js--debug "js--make-merged-item: straight merge")
2314 ;; Not merging a class, but something else, so just prepend
2315 ;; it
2316 (cons child (car item)))
2319 ;; Otherwise, merge the new child's items into those
2320 ;; of the new class
2321 (js--debug "js--make-merged-item: merging class contents")
2322 (append (car child) (car item))))
2323 (cdr item)))
2325 (defun js--pitem-strname (pitem)
2326 "Last part of the name of PITEM, as a string or symbol."
2327 (let ((name (js--pitem-name pitem)))
2328 (if (consp name)
2329 (car (last name))
2330 name)))
2332 (defun js--splice-into-items (items child name-parts)
2333 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2334 If a class doesn't exist in the tree, create it. Return
2335 the new items list. NAME-PARTS is a list of strings given
2336 the broken-down class name of the item to insert."
2338 (let ((top-name (car name-parts))
2339 (item-ptr items)
2340 new-items last-new-item new-cons)
2342 (js--debug "js--splice-into-items: name-parts: %S items:%S"
2343 name-parts
2344 (mapcar #'js--pitem-name items))
2346 (cl-assert (stringp top-name))
2347 (cl-assert (> (length top-name) 0))
2349 ;; If top-name isn't found in items, then we build a copy of items
2350 ;; and throw it away. But that's okay, since most of the time, we
2351 ;; *will* find an instance.
2353 (while (and item-ptr
2354 (cond ((equal (js--pitem-strname (car item-ptr)) top-name)
2355 ;; Okay, we found an entry with the right name. Splice
2356 ;; the merged item into the list...
2357 (setq new-cons (cons (js--make-merged-item
2358 (car item-ptr) child
2359 name-parts)
2360 (cdr item-ptr)))
2362 (if last-new-item
2363 (setcdr last-new-item new-cons)
2364 (setq new-items new-cons))
2366 ;; ...and terminate the loop
2367 nil)
2370 ;; Otherwise, copy the current cons and move onto the
2371 ;; text. This is tricky; we keep track of the tail of
2372 ;; the list that begins with new-items in
2373 ;; last-new-item.
2374 (setq new-cons (cons (car item-ptr) nil))
2375 (if last-new-item
2376 (setcdr last-new-item new-cons)
2377 (setq new-items new-cons))
2378 (setq last-new-item new-cons)
2380 ;; Go to the next cell in items
2381 (setq item-ptr (cdr item-ptr))))))
2383 (if item-ptr
2384 ;; Yay! We stopped because we found something, not because
2385 ;; we ran out of items to search. Just return the new
2386 ;; list.
2387 (progn
2388 (js--debug "search succeeded: %S" name-parts)
2389 new-items)
2391 ;; We didn't find anything. If the child is a class and we don't
2392 ;; have any classes to drill down into, just push that class;
2393 ;; otherwise, make a fake class and carry on.
2394 (js--debug "search failed: %S" name-parts)
2395 (cons (if (cdr name-parts)
2396 ;; We have name-parts left to process. Make a fake
2397 ;; class for this particular part...
2398 (make-js--pitem
2399 ;; ...and recursively digest the rest of the name
2400 :children (js--splice-into-items
2401 nil child (cdr name-parts))
2402 :type js--dummy-class-style
2403 :name top-name)
2405 ;; Otherwise, this is the only name we have, so stick
2406 ;; the item on the front of the list
2407 child)
2408 items))))
2410 (defun js--pitem-add-child (pitem child)
2411 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2412 (cl-assert (integerp (js--pitem-h-begin child)))
2413 (cl-assert (if (consp (js--pitem-name child))
2414 (cl-loop for part in (js--pitem-name child)
2415 always (stringp part))
2418 ;; This trick works because we know (based on our defstructs) that
2419 ;; the child list is always the first element, and so the second
2420 ;; element and beyond can be shared when we make our "copy".
2421 (cons
2423 (let ((name (js--pitem-name child))
2424 (type (js--pitem-type child)))
2426 (cond ((cdr-safe name) ; true if a list of at least two elements
2427 ;; Use slow path because we need class lookup
2428 (js--splice-into-items (car pitem) child name))
2430 ((and (consp type)
2431 (plist-get type :prototype))
2433 ;; Use slow path because we need class merging. We know
2434 ;; name is a list here because down in
2435 ;; `js--ensure-cache', we made sure to only add
2436 ;; class entries with lists for :name
2437 (cl-assert (consp name))
2438 (js--splice-into-items (car pitem) child name))
2441 ;; Fast path
2442 (cons child (car pitem)))))
2444 (cdr pitem)))
2446 (defun js--maybe-make-marker (location)
2447 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2448 (if imenu-use-markers
2449 (set-marker (make-marker) location)
2450 location))
2452 (defun js--pitems-to-imenu (pitems unknown-ctr)
2453 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2455 (let (imenu-items pitem pitem-type pitem-name subitems)
2457 (while (setq pitem (pop pitems))
2458 (setq pitem-type (js--pitem-type pitem))
2459 (setq pitem-name (js--pitem-strname pitem))
2460 (when (eq pitem-name t)
2461 (setq pitem-name (format "[unknown %s]"
2462 (cl-incf (car unknown-ctr)))))
2464 (cond
2465 ((memq pitem-type '(function macro))
2466 (cl-assert (integerp (js--pitem-h-begin pitem)))
2467 (push (cons pitem-name
2468 (js--maybe-make-marker
2469 (js--pitem-h-begin pitem)))
2470 imenu-items))
2472 ((consp pitem-type) ; class definition
2473 (setq subitems (js--pitems-to-imenu
2474 (js--pitem-children pitem)
2475 unknown-ctr))
2476 (cond (subitems
2477 (push (cons pitem-name subitems)
2478 imenu-items))
2480 ((js--pitem-h-begin pitem)
2481 (cl-assert (integerp (js--pitem-h-begin pitem)))
2482 (setq subitems (list
2483 (cons "[empty]"
2484 (js--maybe-make-marker
2485 (js--pitem-h-begin pitem)))))
2486 (push (cons pitem-name subitems)
2487 imenu-items))))
2489 (t (error "Unknown item type: %S" pitem-type))))
2491 imenu-items))
2493 (defun js--imenu-create-index ()
2494 "Return an imenu index for the current buffer."
2495 (save-excursion
2496 (save-restriction
2497 (widen)
2498 (goto-char (point-max))
2499 (js--ensure-cache)
2500 (cl-assert (or (= (point-min) (point-max))
2501 (eq js--last-parse-pos (point))))
2502 (when js--last-parse-pos
2503 (let ((state js--state-at-last-parse-pos)
2504 (unknown-ctr (cons -1 nil)))
2506 ;; Make sure everything is closed
2507 (while (cdr state)
2508 (setq state
2509 (cons (js--pitem-add-child (cl-second state) (car state))
2510 (cddr state))))
2512 (cl-assert (= (length state) 1))
2514 ;; Convert the new-finalized state into what imenu expects
2515 (js--pitems-to-imenu
2516 (car (js--pitem-children state))
2517 unknown-ctr))))))
2519 ;; Silence the compiler.
2520 (defvar which-func-imenu-joiner-function)
2522 (defun js--which-func-joiner (parts)
2523 (mapconcat #'identity parts "."))
2525 (defun js--imenu-to-flat (items prefix symbols)
2526 (cl-loop for item in items
2527 if (imenu--subalist-p item)
2528 do (js--imenu-to-flat
2529 (cdr item) (concat prefix (car item) ".")
2530 symbols)
2531 else
2532 do (let* ((name (concat prefix (car item)))
2533 (name2 name)
2534 (ctr 0))
2536 (while (gethash name2 symbols)
2537 (setq name2 (format "%s<%d>" name (cl-incf ctr))))
2539 (puthash name2 (cdr item) symbols))))
2541 (defun js--get-all-known-symbols ()
2542 "Return a hash table of all JavaScript symbols.
2543 This searches all existing `js-mode' buffers. Each key is the
2544 name of a symbol (possibly disambiguated with <N>, where N > 1),
2545 and each value is a marker giving the location of that symbol."
2546 (cl-loop with symbols = (make-hash-table :test 'equal)
2547 with imenu-use-markers = t
2548 for buffer being the buffers
2549 for imenu-index = (with-current-buffer buffer
2550 (when (derived-mode-p 'js-mode)
2551 (js--imenu-create-index)))
2552 do (js--imenu-to-flat imenu-index "" symbols)
2553 finally return symbols))
2555 (defvar js--symbol-history nil
2556 "History of entered JavaScript symbols.")
2558 (defun js--read-symbol (symbols-table prompt &optional initial-input)
2559 "Helper function for `js-find-symbol'.
2560 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2561 one from `js--get-all-known-symbols', using prompt PROMPT and
2562 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2563 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2564 marker."
2565 (unless ido-mode
2566 (ido-mode 1)
2567 (ido-mode -1))
2569 (let ((choice (ido-completing-read
2570 prompt
2571 (cl-loop for key being the hash-keys of symbols-table
2572 collect key)
2573 nil t initial-input 'js--symbol-history)))
2574 (cons choice (gethash choice symbols-table))))
2576 (defun js--guess-symbol-at-point ()
2577 (let ((bounds (bounds-of-thing-at-point 'symbol)))
2578 (when bounds
2579 (save-excursion
2580 (goto-char (car bounds))
2581 (when (eq (char-before) ?.)
2582 (backward-char)
2583 (setf (car bounds) (point))))
2584 (buffer-substring (car bounds) (cdr bounds)))))
2586 (defvar find-tag-marker-ring) ; etags
2588 ;; etags loads ring.
2589 (declare-function ring-insert "ring" (ring item))
2591 (defun js-find-symbol (&optional arg)
2592 "Read a JavaScript symbol and jump to it.
2593 With a prefix argument, restrict symbols to those from the
2594 current buffer. Pushes a mark onto the tag ring just like
2595 `find-tag'."
2596 (interactive "P")
2597 (require 'etags)
2598 (let (symbols marker)
2599 (if (not arg)
2600 (setq symbols (js--get-all-known-symbols))
2601 (setq symbols (make-hash-table :test 'equal))
2602 (js--imenu-to-flat (js--imenu-create-index)
2603 "" symbols))
2605 (setq marker (cdr (js--read-symbol
2606 symbols "Jump to: "
2607 (js--guess-symbol-at-point))))
2609 (ring-insert find-tag-marker-ring (point-marker))
2610 (switch-to-buffer (marker-buffer marker))
2611 (push-mark)
2612 (goto-char marker)))
2614 ;;; MozRepl integration
2616 (define-error 'js-moz-bad-rpc "Mozilla RPC Error") ;; '(timeout error))
2617 (define-error 'js-js-error "Javascript Error") ;; '(js-error error))
2619 (defun js--wait-for-matching-output
2620 (process regexp timeout &optional start)
2621 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2622 On timeout, return nil. On success, return t with match data
2623 set. If START is non-nil, look for output starting from START.
2624 Otherwise, use the current value of `process-mark'."
2625 (with-current-buffer (process-buffer process)
2626 (cl-loop with start-pos = (or start
2627 (marker-position (process-mark process)))
2628 with end-time = (+ (float-time) timeout)
2629 for time-left = (- end-time (float-time))
2630 do (goto-char (point-max))
2631 if (looking-back regexp start-pos) return t
2632 while (> time-left 0)
2633 do (accept-process-output process time-left nil t)
2634 do (goto-char (process-mark process))
2635 finally do (signal
2636 'js-moz-bad-rpc
2637 (list (format "Timed out waiting for output matching %S" regexp))))))
2639 (cl-defstruct js--js-handle
2640 ;; Integer, mirrors the value we see in JS
2641 (id nil :read-only t)
2643 ;; Process to which this thing belongs
2644 (process nil :read-only t))
2646 (defun js--js-handle-expired-p (x)
2647 (not (eq (js--js-handle-process x)
2648 (inferior-moz-process))))
2650 (defvar js--js-references nil
2651 "Maps Elisp JavaScript proxy objects to their JavaScript IDs.")
2653 (defvar js--js-process nil
2654 "The most recent MozRepl process object.")
2656 (defvar js--js-gc-idle-timer nil
2657 "Idle timer for cleaning up JS object references.")
2659 (defvar js--js-last-gcs-done nil)
2661 (defconst js--moz-interactor
2662 (replace-regexp-in-string
2663 "[ \n]+" " "
2664 ; */" Make Emacs happy
2665 "(function(repl) {
2666 repl.defineInteractor('js', {
2667 onStart: function onStart(repl) {
2668 if(!repl._jsObjects) {
2669 repl._jsObjects = {};
2670 repl._jsLastID = 0;
2671 repl._jsGC = this._jsGC;
2673 this._input = '';
2676 _jsGC: function _jsGC(ids_in_use) {
2677 var objects = this._jsObjects;
2678 var keys = [];
2679 var num_freed = 0;
2681 for(var pn in objects) {
2682 keys.push(Number(pn));
2685 keys.sort(function(x, y) x - y);
2686 ids_in_use.sort(function(x, y) x - y);
2687 var i = 0;
2688 var j = 0;
2690 while(i < ids_in_use.length && j < keys.length) {
2691 var id = ids_in_use[i++];
2692 while(j < keys.length && keys[j] !== id) {
2693 var k_id = keys[j++];
2694 delete objects[k_id];
2695 ++num_freed;
2697 ++j;
2700 while(j < keys.length) {
2701 var k_id = keys[j++];
2702 delete objects[k_id];
2703 ++num_freed;
2706 return num_freed;
2709 _mkArray: function _mkArray() {
2710 var result = [];
2711 for(var i = 0; i < arguments.length; ++i) {
2712 result.push(arguments[i]);
2714 return result;
2717 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2718 if(typeof parts === 'string') {
2719 parts = [ parts ];
2722 var obj = parts[0];
2723 var start = 1;
2725 if(typeof obj === 'string') {
2726 obj = window;
2727 start = 0;
2728 } else if(parts.length < 2) {
2729 throw new Error('expected at least 2 arguments');
2732 for(var i = start; i < parts.length - 1; ++i) {
2733 obj = obj[parts[i]];
2736 return [obj, parts[parts.length - 1]];
2739 _getProp: function _getProp(/*...*/) {
2740 if(arguments.length === 0) {
2741 throw new Error('no arguments supplied to getprop');
2744 if(arguments.length === 1 &&
2745 (typeof arguments[0]) !== 'string')
2747 return arguments[0];
2750 var [obj, propname] = this._parsePropDescriptor(arguments);
2751 return obj[propname];
2754 _putProp: function _putProp(properties, value) {
2755 var [obj, propname] = this._parsePropDescriptor(properties);
2756 obj[propname] = value;
2759 _delProp: function _delProp(propname) {
2760 var [obj, propname] = this._parsePropDescriptor(arguments);
2761 delete obj[propname];
2764 _typeOf: function _typeOf(thing) {
2765 return typeof thing;
2768 _callNew: function(constructor) {
2769 if(typeof constructor === 'string')
2771 constructor = window[constructor];
2772 } else if(constructor.length === 1 &&
2773 typeof constructor[0] !== 'string')
2775 constructor = constructor[0];
2776 } else {
2777 var [obj,propname] = this._parsePropDescriptor(constructor);
2778 constructor = obj[propname];
2781 /* Hacky, but should be robust */
2782 var s = 'new constructor(';
2783 for(var i = 1; i < arguments.length; ++i) {
2784 if(i != 1) {
2785 s += ',';
2788 s += 'arguments[' + i + ']';
2791 s += ')';
2792 return eval(s);
2795 _callEval: function(thisobj, js) {
2796 return eval.call(thisobj, js);
2799 getPrompt: function getPrompt(repl) {
2800 return 'EVAL>'
2803 _lookupObject: function _lookupObject(repl, id) {
2804 if(typeof id === 'string') {
2805 switch(id) {
2806 case 'global':
2807 return window;
2808 case 'nil':
2809 return null;
2810 case 't':
2811 return true;
2812 case 'false':
2813 return false;
2814 case 'undefined':
2815 return undefined;
2816 case 'repl':
2817 return repl;
2818 case 'interactor':
2819 return this;
2820 case 'NaN':
2821 return NaN;
2822 case 'Infinity':
2823 return Infinity;
2824 case '-Infinity':
2825 return -Infinity;
2826 default:
2827 throw new Error('No object with special id:' + id);
2831 var ret = repl._jsObjects[id];
2832 if(ret === undefined) {
2833 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2835 return ret;
2838 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2839 if(typeof value !== 'object' && typeof value !== 'function') {
2840 throw new Error('_findOrAllocateObject called on non-object('
2841 + typeof(value) + '): '
2842 + value)
2845 for(var id in repl._jsObjects) {
2846 id = Number(id);
2847 var obj = repl._jsObjects[id];
2848 if(obj === value) {
2849 return id;
2853 var id = ++repl._jsLastID;
2854 repl._jsObjects[id] = value;
2855 return id;
2858 _fixupList: function _fixupList(repl, list) {
2859 for(var i = 0; i < list.length; ++i) {
2860 if(list[i] instanceof Array) {
2861 this._fixupList(repl, list[i]);
2862 } else if(typeof list[i] === 'object') {
2863 var obj = list[i];
2864 if(obj.funcall) {
2865 var parts = obj.funcall;
2866 this._fixupList(repl, parts);
2867 var [thisobj, func] = this._parseFunc(parts[0]);
2868 list[i] = func.apply(thisobj, parts.slice(1));
2869 } else if(obj.objid) {
2870 list[i] = this._lookupObject(repl, obj.objid);
2871 } else {
2872 throw new Error('Unknown object type: ' + obj.toSource());
2878 _parseFunc: function(func) {
2879 var thisobj = null;
2881 if(typeof func === 'string') {
2882 func = window[func];
2883 } else if(func instanceof Array) {
2884 if(func.length === 1 && typeof func[0] !== 'string') {
2885 func = func[0];
2886 } else {
2887 [thisobj, func] = this._parsePropDescriptor(func);
2888 func = thisobj[func];
2892 return [thisobj,func];
2895 _encodeReturn: function(value, array_as_mv) {
2896 var ret;
2898 if(value === null) {
2899 ret = ['special', 'null'];
2900 } else if(value === true) {
2901 ret = ['special', 'true'];
2902 } else if(value === false) {
2903 ret = ['special', 'false'];
2904 } else if(value === undefined) {
2905 ret = ['special', 'undefined'];
2906 } else if(typeof value === 'number') {
2907 if(isNaN(value)) {
2908 ret = ['special', 'NaN'];
2909 } else if(value === Infinity) {
2910 ret = ['special', 'Infinity'];
2911 } else if(value === -Infinity) {
2912 ret = ['special', '-Infinity'];
2913 } else {
2914 ret = ['atom', value];
2916 } else if(typeof value === 'string') {
2917 ret = ['atom', value];
2918 } else if(array_as_mv && value instanceof Array) {
2919 ret = ['array', value.map(this._encodeReturn, this)];
2920 } else {
2921 ret = ['objid', this._findOrAllocateObject(repl, value)];
2924 return ret;
2927 _handleInputLine: function _handleInputLine(repl, line) {
2928 var ret;
2929 var array_as_mv = false;
2931 try {
2932 if(line[0] === '*') {
2933 array_as_mv = true;
2934 line = line.substring(1);
2936 var parts = eval(line);
2937 this._fixupList(repl, parts);
2938 var [thisobj, func] = this._parseFunc(parts[0]);
2939 ret = this._encodeReturn(
2940 func.apply(thisobj, parts.slice(1)),
2941 array_as_mv);
2942 } catch(x) {
2943 ret = ['error', x.toString() ];
2946 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2947 repl.print(JSON.encode(ret));
2948 repl._prompt();
2951 handleInput: function handleInput(repl, chunk) {
2952 this._input += chunk;
2953 var match, line;
2954 while(match = this._input.match(/.*\\n/)) {
2955 line = match[0];
2957 if(line === 'EXIT\\n') {
2958 repl.popInteractor();
2959 repl._prompt();
2960 return;
2963 this._input = this._input.substring(line.length);
2964 this._handleInputLine(repl, line);
2971 "String to set MozRepl up into a simple-minded evaluation mode.")
2973 (defun js--js-encode-value (x)
2974 "Marshall the given value for JS.
2975 Strings and numbers are JSON-encoded. Lists (including nil) are
2976 made into JavaScript array literals and their contents encoded
2977 with `js--js-encode-value'."
2978 (cond ((stringp x) (json-encode-string x))
2979 ((numberp x) (json-encode-number x))
2980 ((symbolp x) (format "{objid:%S}" (symbol-name x)))
2981 ((js--js-handle-p x)
2983 (when (js--js-handle-expired-p x)
2984 (error "Stale JS handle"))
2986 (format "{objid:%s}" (js--js-handle-id x)))
2988 ((sequencep x)
2989 (if (eq (car-safe x) 'js--funcall)
2990 (format "{funcall:[%s]}"
2991 (mapconcat #'js--js-encode-value (cdr x) ","))
2992 (concat
2993 "[" (mapconcat #'js--js-encode-value x ",") "]")))
2995 (error "Unrecognized item: %S" x))))
2997 (defconst js--js-prompt-regexp "\\(repl[0-9]*\\)> $")
2998 (defconst js--js-repl-prompt-regexp "^EVAL>$")
2999 (defvar js--js-repl-depth 0)
3001 (defun js--js-wait-for-eval-prompt ()
3002 (js--wait-for-matching-output
3003 (inferior-moz-process)
3004 js--js-repl-prompt-regexp js-js-timeout
3006 ;; start matching against the beginning of the line in
3007 ;; order to catch a prompt that's only partially arrived
3008 (save-excursion (forward-line 0) (point))))
3010 ;; Presumably "inferior-moz-process" loads comint.
3011 (declare-function comint-send-string "comint" (process string))
3012 (declare-function comint-send-input "comint"
3013 (&optional no-newline artificial))
3015 (defun js--js-enter-repl ()
3016 (inferior-moz-process) ; called for side-effect
3017 (with-current-buffer inferior-moz-buffer
3018 (goto-char (point-max))
3020 ;; Do some initialization the first time we see a process
3021 (unless (eq (inferior-moz-process) js--js-process)
3022 (setq js--js-process (inferior-moz-process))
3023 (setq js--js-references (make-hash-table :test 'eq :weakness t))
3024 (setq js--js-repl-depth 0)
3026 ;; Send interactor definition
3027 (comint-send-string js--js-process js--moz-interactor)
3028 (comint-send-string js--js-process
3029 (concat "(" moz-repl-name ")\n"))
3030 (js--wait-for-matching-output
3031 (inferior-moz-process) js--js-prompt-regexp
3032 js-js-timeout))
3034 ;; Sanity check
3035 (when (looking-back js--js-prompt-regexp
3036 (save-excursion (forward-line 0) (point)))
3037 (setq js--js-repl-depth 0))
3039 (if (> js--js-repl-depth 0)
3040 ;; If js--js-repl-depth > 0, we *should* be seeing an
3041 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
3042 ;; up with us.
3043 (js--js-wait-for-eval-prompt)
3045 ;; Otherwise, tell Mozilla to enter the interactor mode
3046 (insert (match-string-no-properties 1)
3047 ".pushInteractor('js')")
3048 (comint-send-input nil t)
3049 (js--wait-for-matching-output
3050 (inferior-moz-process) js--js-repl-prompt-regexp
3051 js-js-timeout))
3053 (cl-incf js--js-repl-depth)))
3055 (defun js--js-leave-repl ()
3056 (cl-assert (> js--js-repl-depth 0))
3057 (when (= 0 (cl-decf js--js-repl-depth))
3058 (with-current-buffer inferior-moz-buffer
3059 (goto-char (point-max))
3060 (js--js-wait-for-eval-prompt)
3061 (insert "EXIT")
3062 (comint-send-input nil t)
3063 (js--wait-for-matching-output
3064 (inferior-moz-process) js--js-prompt-regexp
3065 js-js-timeout))))
3067 (defsubst js--js-not (value)
3068 (memq value '(nil null false undefined)))
3070 (defsubst js--js-true (value)
3071 (not (js--js-not value)))
3073 (eval-and-compile
3074 (defun js--optimize-arglist (arglist)
3075 "Convert immediate js< and js! references to deferred ones."
3076 (cl-loop for item in arglist
3077 if (eq (car-safe item) 'js<)
3078 collect (append (list 'list ''js--funcall
3079 '(list 'interactor "_getProp"))
3080 (js--optimize-arglist (cdr item)))
3081 else if (eq (car-safe item) 'js>)
3082 collect (append (list 'list ''js--funcall
3083 '(list 'interactor "_putProp"))
3085 (if (atom (cadr item))
3086 (list (cadr item))
3087 (list
3088 (append
3089 (list 'list ''js--funcall
3090 '(list 'interactor "_mkArray"))
3091 (js--optimize-arglist (cadr item)))))
3092 (js--optimize-arglist (cddr item)))
3093 else if (eq (car-safe item) 'js!)
3094 collect (pcase-let ((`(,_ ,function . ,body) item))
3095 (append (list 'list ''js--funcall
3096 (if (consp function)
3097 (cons 'list
3098 (js--optimize-arglist function))
3099 function))
3100 (js--optimize-arglist body)))
3101 else
3102 collect item)))
3104 (defmacro js--js-get-service (class-name interface-name)
3105 `(js! ("Components" "classes" ,class-name "getService")
3106 (js< "Components" "interfaces" ,interface-name)))
3108 (defmacro js--js-create-instance (class-name interface-name)
3109 `(js! ("Components" "classes" ,class-name "createInstance")
3110 (js< "Components" "interfaces" ,interface-name)))
3112 (defmacro js--js-qi (object interface-name)
3113 `(js! (,object "QueryInterface")
3114 (js< "Components" "interfaces" ,interface-name)))
3116 (defmacro with-js (&rest forms)
3117 "Run FORMS with the Mozilla repl set up for js commands.
3118 Inside the lexical scope of `with-js', `js?', `js!',
3119 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
3120 `js-create-instance', and `js-qi' are defined."
3122 `(progn
3123 (js--js-enter-repl)
3124 (unwind-protect
3125 (cl-macrolet ((js? (&rest body) `(js--js-true ,@body))
3126 (js! (function &rest body)
3127 `(js--js-funcall
3128 ,(if (consp function)
3129 (cons 'list
3130 (js--optimize-arglist function))
3131 function)
3132 ,@(js--optimize-arglist body)))
3134 (js-new (function &rest body)
3135 `(js--js-new
3136 ,(if (consp function)
3137 (cons 'list
3138 (js--optimize-arglist function))
3139 function)
3140 ,@body))
3142 (js-eval (thisobj js)
3143 `(js--js-eval
3144 ,@(js--optimize-arglist
3145 (list thisobj js))))
3147 (js-list (&rest args)
3148 `(js--js-list
3149 ,@(js--optimize-arglist args)))
3151 (js-get-service (&rest args)
3152 `(js--js-get-service
3153 ,@(js--optimize-arglist args)))
3155 (js-create-instance (&rest args)
3156 `(js--js-create-instance
3157 ,@(js--optimize-arglist args)))
3159 (js-qi (&rest args)
3160 `(js--js-qi
3161 ,@(js--optimize-arglist args)))
3163 (js< (&rest body) `(js--js-get
3164 ,@(js--optimize-arglist body)))
3165 (js> (props value)
3166 `(js--js-funcall
3167 '(interactor "_putProp")
3168 ,(if (consp props)
3169 (cons 'list
3170 (js--optimize-arglist props))
3171 props)
3172 ,@(js--optimize-arglist (list value))
3174 (js-handle? (arg) `(js--js-handle-p ,arg)))
3175 ,@forms)
3176 (js--js-leave-repl))))
3178 (defvar js--js-array-as-list nil
3179 "Whether to listify any Array returned by a Mozilla function.
3180 If nil, the whole Array is treated as a JS symbol.")
3182 (defun js--js-decode-retval (result)
3183 (pcase (intern (cl-first result))
3184 (`atom (cl-second result))
3185 (`special (intern (cl-second result)))
3186 (`array
3187 (mapcar #'js--js-decode-retval (cl-second result)))
3188 (`objid
3189 (or (gethash (cl-second result)
3190 js--js-references)
3191 (puthash (cl-second result)
3192 (make-js--js-handle
3193 :id (cl-second result)
3194 :process (inferior-moz-process))
3195 js--js-references)))
3197 (`error (signal 'js-js-error (list (cl-second result))))
3198 (x (error "Unmatched case in js--js-decode-retval: %S" x))))
3200 (defvar comint-last-input-end)
3202 (defun js--js-funcall (function &rest arguments)
3203 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
3204 If function is a string, look it up as a property on the global
3205 object and use the global object for `this'.
3206 If FUNCTION is a list with one element, use that element as the
3207 function with the global object for `this', except that if that
3208 single element is a string, look it up on the global object.
3209 If FUNCTION is a list with more than one argument, use the list
3210 up to the last value as a property descriptor and the last
3211 argument as a function."
3213 (with-js
3214 (let ((argstr (js--js-encode-value
3215 (cons function arguments))))
3217 (with-current-buffer inferior-moz-buffer
3218 ;; Actual funcall
3219 (when js--js-array-as-list
3220 (insert "*"))
3221 (insert argstr)
3222 (comint-send-input nil t)
3223 (js--wait-for-matching-output
3224 (inferior-moz-process) "EVAL>"
3225 js-js-timeout)
3226 (goto-char comint-last-input-end)
3228 ;; Read the result
3229 (let* ((json-array-type 'list)
3230 (result (prog1 (json-read)
3231 (goto-char (point-max)))))
3232 (js--js-decode-retval result))))))
3234 (defun js--js-new (constructor &rest arguments)
3235 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
3236 CONSTRUCTOR is a JS handle, a string, or a list of these things."
3237 (apply #'js--js-funcall
3238 '(interactor "_callNew")
3239 constructor arguments))
3241 (defun js--js-eval (thisobj js)
3242 (js--js-funcall '(interactor "_callEval") thisobj js))
3244 (defun js--js-list (&rest arguments)
3245 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
3246 (let ((js--js-array-as-list t))
3247 (apply #'js--js-funcall '(interactor "_mkArray")
3248 arguments)))
3250 (defun js--js-get (&rest props)
3251 (apply #'js--js-funcall '(interactor "_getProp") props))
3253 (defun js--js-put (props value)
3254 (js--js-funcall '(interactor "_putProp") props value))
3256 (defun js-gc (&optional force)
3257 "Tell the repl about any objects we don't reference anymore.
3258 With argument, run even if no intervening GC has happened."
3259 (interactive)
3261 (when force
3262 (setq js--js-last-gcs-done nil))
3264 (let ((this-gcs-done gcs-done) keys num)
3265 (when (and js--js-references
3266 (boundp 'inferior-moz-buffer)
3267 (buffer-live-p inferior-moz-buffer)
3269 ;; Don't bother running unless we've had an intervening
3270 ;; garbage collection; without a gc, nothing is deleted
3271 ;; from the weak hash table, so it's pointless telling
3272 ;; MozRepl about that references we still hold
3273 (not (eq js--js-last-gcs-done this-gcs-done))
3275 ;; Are we looking at a normal prompt? Make sure not to
3276 ;; interrupt the user if he's doing something
3277 (with-current-buffer inferior-moz-buffer
3278 (save-excursion
3279 (goto-char (point-max))
3280 (looking-back js--js-prompt-regexp
3281 (save-excursion (forward-line 0) (point))))))
3283 (setq keys (cl-loop for x being the hash-keys
3284 of js--js-references
3285 collect x))
3286 (setq num (js--js-funcall '(repl "_jsGC") (or keys [])))
3288 (setq js--js-last-gcs-done this-gcs-done)
3289 (when (called-interactively-p 'interactive)
3290 (message "Cleaned %s entries" num))
3292 num)))
3294 (run-with-idle-timer 30 t #'js-gc)
3296 (defun js-eval (js)
3297 "Evaluate the JavaScript in JS and return JSON-decoded result."
3298 (interactive "MJavascript to evaluate: ")
3299 (with-js
3300 (let* ((content-window (js--js-content-window
3301 (js--get-js-context)))
3302 (result (js-eval content-window js)))
3303 (when (called-interactively-p 'interactive)
3304 (message "%s" (js! "String" result)))
3305 result)))
3307 (defun js--get-tabs ()
3308 "Enumerate all JavaScript contexts available.
3309 Each context is a list:
3310 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3311 (TITLE URL WINDOW) for windows
3313 All tabs of a given window are grouped together. The most recent
3314 window is first. Within each window, the tabs are returned
3315 left-to-right."
3316 (with-js
3317 (let (windows)
3319 (cl-loop with window-mediator = (js! ("Components" "classes"
3320 "@mozilla.org/appshell/window-mediator;1"
3321 "getService")
3322 (js< "Components" "interfaces"
3323 "nsIWindowMediator"))
3324 with enumerator = (js! (window-mediator "getEnumerator") nil)
3326 while (js? (js! (enumerator "hasMoreElements")))
3327 for window = (js! (enumerator "getNext"))
3328 for window-info = (js-list window
3329 (js< window "document" "title")
3330 (js! (window "location" "toString"))
3331 (js< window "closed")
3332 (js< window "windowState"))
3334 unless (or (js? (cl-fourth window-info))
3335 (eq (cl-fifth window-info) 2))
3336 do (push window-info windows))
3338 (cl-loop for window-info in windows
3339 for window = (cl-first window-info)
3340 collect (list (cl-second window-info)
3341 (cl-third window-info)
3342 window)
3344 for gbrowser = (js< window "gBrowser")
3345 if (js-handle? gbrowser)
3346 nconc (cl-loop
3347 for x below (js< gbrowser "browsers" "length")
3348 collect (js-list (js< gbrowser
3349 "browsers"
3351 "contentDocument"
3352 "title")
3354 (js! (gbrowser
3355 "browsers"
3357 "contentWindow"
3358 "location"
3359 "toString"))
3360 (js< gbrowser
3361 "browsers"
3364 (js! (gbrowser
3365 "tabContainer"
3366 "childNodes"
3367 "item")
3370 gbrowser))))))
3372 (defvar js-read-tab-history nil)
3374 (declare-function ido-chop "ido" (items elem))
3376 (defun js--read-tab (prompt)
3377 "Read a Mozilla tab with prompt PROMPT.
3378 Return a cons of (TYPE . OBJECT). TYPE is either `window' or
3379 `tab', and OBJECT is a JavaScript handle to a ChromeWindow or a
3380 browser, respectively."
3382 ;; Prime IDO
3383 (unless ido-mode
3384 (ido-mode 1)
3385 (ido-mode -1))
3387 (with-js
3388 (let ((tabs (js--get-tabs)) selected-tab-cname
3389 selected-tab prev-hitab)
3391 ;; Disambiguate names
3392 (setq tabs
3393 (cl-loop with tab-names = (make-hash-table :test 'equal)
3394 for tab in tabs
3395 for cname = (format "%s (%s)"
3396 (cl-second tab) (cl-first tab))
3397 for num = (cl-incf (gethash cname tab-names -1))
3398 if (> num 0)
3399 do (setq cname (format "%s <%d>" cname num))
3400 collect (cons cname tab)))
3402 (cl-labels
3403 ((find-tab-by-cname
3404 (cname)
3405 (cl-loop for tab in tabs
3406 if (equal (car tab) cname)
3407 return (cdr tab)))
3409 (mogrify-highlighting
3410 (hitab unhitab)
3412 ;; Hack to reduce the number of
3413 ;; round-trips to mozilla
3414 (let (cmds)
3415 (cond
3416 ;; Highlighting tab
3417 ((cl-fourth hitab)
3418 (push '(js! ((cl-fourth hitab) "setAttribute")
3419 "style"
3420 "color: red; font-weight: bold")
3421 cmds)
3423 ;; Highlight window proper
3424 (push '(js! ((cl-third hitab)
3425 "setAttribute")
3426 "style"
3427 "border: 8px solid red")
3428 cmds)
3430 ;; Select tab, when appropriate
3431 (when js-js-switch-tabs
3432 (push
3433 '(js> ((cl-fifth hitab) "selectedTab") (cl-fourth hitab))
3434 cmds)))
3436 ;; Highlighting whole window
3437 ((cl-third hitab)
3438 (push '(js! ((cl-third hitab) "document"
3439 "documentElement" "setAttribute")
3440 "style"
3441 (concat "-moz-appearance: none;"
3442 "border: 8px solid red;"))
3443 cmds)))
3445 (cond
3446 ;; Unhighlighting tab
3447 ((cl-fourth unhitab)
3448 (push '(js! ((cl-fourth unhitab) "setAttribute") "style" "")
3449 cmds)
3450 (push '(js! ((cl-third unhitab) "setAttribute") "style" "")
3451 cmds))
3453 ;; Unhighlighting window
3454 ((cl-third unhitab)
3455 (push '(js! ((cl-third unhitab) "document"
3456 "documentElement" "setAttribute")
3457 "style" "")
3458 cmds)))
3460 (eval (list 'with-js
3461 (cons 'js-list (nreverse cmds))))))
3463 (command-hook
3465 (let* ((tab (find-tab-by-cname (car ido-matches))))
3466 (mogrify-highlighting tab prev-hitab)
3467 (setq prev-hitab tab)))
3469 (setup-hook
3471 ;; Fiddle with the match list a bit: if our first match
3472 ;; is a tabbrowser window, rotate the match list until
3473 ;; the active tab comes up
3474 (let ((matched-tab (find-tab-by-cname (car ido-matches))))
3475 (when (and matched-tab
3476 (null (cl-fourth matched-tab))
3477 (equal "navigator:browser"
3478 (js! ((cl-third matched-tab)
3479 "document"
3480 "documentElement"
3481 "getAttribute")
3482 "windowtype")))
3484 (cl-loop with tab-to-match = (js< (cl-third matched-tab)
3485 "gBrowser"
3486 "selectedTab")
3488 for match in ido-matches
3489 for candidate-tab = (find-tab-by-cname match)
3490 if (eq (cl-fourth candidate-tab) tab-to-match)
3491 do (setq ido-cur-list
3492 (ido-chop ido-cur-list match))
3493 and return t)))
3495 (add-hook 'post-command-hook #'command-hook t t)))
3498 (unwind-protect
3499 ;; FIXME: Don't impose IDO on the user.
3500 (setq selected-tab-cname
3501 (let ((ido-minibuffer-setup-hook
3502 (cons #'setup-hook ido-minibuffer-setup-hook)))
3503 (ido-completing-read
3504 prompt
3505 (mapcar #'car tabs)
3506 nil t nil
3507 'js-read-tab-history)))
3509 (when prev-hitab
3510 (mogrify-highlighting nil prev-hitab)
3511 (setq prev-hitab nil)))
3513 (add-to-history 'js-read-tab-history selected-tab-cname)
3515 (setq selected-tab (cl-loop for tab in tabs
3516 if (equal (car tab) selected-tab-cname)
3517 return (cdr tab)))
3519 (cons (if (cl-fourth selected-tab) 'browser 'window)
3520 (cl-third selected-tab))))))
3522 (defun js--guess-eval-defun-info (pstate)
3523 "Helper function for `js-eval-defun'.
3524 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3525 strings making up the class name and NAME is the name of the
3526 function part."
3527 (cond ((and (= (length pstate) 3)
3528 (eq (js--pitem-type (cl-first pstate)) 'function)
3529 (= (length (js--pitem-name (cl-first pstate))) 1)
3530 (consp (js--pitem-type (cl-second pstate))))
3532 (append (js--pitem-name (cl-second pstate))
3533 (list (cl-first (js--pitem-name (cl-first pstate))))))
3535 ((and (= (length pstate) 2)
3536 (eq (js--pitem-type (cl-first pstate)) 'function))
3538 (append
3539 (butlast (js--pitem-name (cl-first pstate)))
3540 (list (car (last (js--pitem-name (cl-first pstate)))))))
3542 (t (error "Function not a toplevel defun or class member"))))
3544 (defvar js--js-context nil
3545 "The current JavaScript context.
3546 This is a cons like the one returned from `js--read-tab'.
3547 Change with `js-set-js-context'.")
3549 (defconst js--js-inserter
3550 "(function(func_info,func) {
3551 func_info.unshift('window');
3552 var obj = window;
3553 for(var i = 1; i < func_info.length - 1; ++i) {
3554 var next = obj[func_info[i]];
3555 if(typeof next !== 'object' && typeof next !== 'function') {
3556 next = obj.prototype && obj.prototype[func_info[i]];
3557 if(typeof next !== 'object' && typeof next !== 'function') {
3558 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3559 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3560 return;
3563 func_info.splice(i+1, 0, 'prototype');
3564 ++i;
3568 obj[func_info[i]] = func;
3569 alert('Successfully updated '+func_info.join('.'));
3570 })")
3572 (defun js-set-js-context (context)
3573 "Set the JavaScript context to CONTEXT.
3574 When called interactively, prompt for CONTEXT."
3575 (interactive (list (js--read-tab "Javascript Context: ")))
3576 (setq js--js-context context))
3578 (defun js--get-js-context ()
3579 "Return a valid JavaScript context.
3580 If one hasn't been set, or if it's stale, prompt for a new one."
3581 (with-js
3582 (when (or (null js--js-context)
3583 (js--js-handle-expired-p (cdr js--js-context))
3584 (pcase (car js--js-context)
3585 (`window (js? (js< (cdr js--js-context) "closed")))
3586 (`browser (not (js? (js< (cdr js--js-context)
3587 "contentDocument"))))
3588 (x (error "Unmatched case in js--get-js-context: %S" x))))
3589 (setq js--js-context (js--read-tab "Javascript Context: ")))
3590 js--js-context))
3592 (defun js--js-content-window (context)
3593 (with-js
3594 (pcase (car context)
3595 (`window (cdr context))
3596 (`browser (js< (cdr context)
3597 "contentWindow" "wrappedJSObject"))
3598 (x (error "Unmatched case in js--js-content-window: %S" x)))))
3600 (defun js--make-nsilocalfile (path)
3601 (with-js
3602 (let ((file (js-create-instance "@mozilla.org/file/local;1"
3603 "nsILocalFile")))
3604 (js! (file "initWithPath") path)
3605 file)))
3607 (defun js--js-add-resource-alias (alias path)
3608 (with-js
3609 (let* ((io-service (js-get-service "@mozilla.org/network/io-service;1"
3610 "nsIIOService"))
3611 (res-prot (js! (io-service "getProtocolHandler") "resource"))
3612 (res-prot (js-qi res-prot "nsIResProtocolHandler"))
3613 (path-file (js--make-nsilocalfile path))
3614 (path-uri (js! (io-service "newFileURI") path-file)))
3615 (js! (res-prot "setSubstitution") alias path-uri))))
3617 (cl-defun js-eval-defun ()
3618 "Update a Mozilla tab using the JavaScript defun at point."
3619 (interactive)
3621 ;; This function works by generating a temporary file that contains
3622 ;; the function we'd like to insert. We then use the elisp-js bridge
3623 ;; to command mozilla to load this file by inserting a script tag
3624 ;; into the document we set. This way, debuggers and such will have
3625 ;; a way to find the source of the just-inserted function.
3627 ;; We delete the temporary file if there's an error, but otherwise
3628 ;; we add an unload event listener on the Mozilla side to delete the
3629 ;; file.
3631 (save-excursion
3632 (let (begin end pstate defun-info temp-name defun-body)
3633 (js-end-of-defun)
3634 (setq end (point))
3635 (js--ensure-cache)
3636 (js-beginning-of-defun)
3637 (re-search-forward "\\_<function\\_>")
3638 (setq begin (match-beginning 0))
3639 (setq pstate (js--forward-pstate))
3641 (when (or (null pstate)
3642 (> (point) end))
3643 (error "Could not locate function definition"))
3645 (setq defun-info (js--guess-eval-defun-info pstate))
3647 (let ((overlay (make-overlay begin end)))
3648 (overlay-put overlay 'face 'highlight)
3649 (unwind-protect
3650 (unless (y-or-n-p (format "Send %s to Mozilla? "
3651 (mapconcat #'identity defun-info ".")))
3652 (message "") ; question message lingers until next command
3653 (cl-return-from js-eval-defun))
3654 (delete-overlay overlay)))
3656 (setq defun-body (buffer-substring-no-properties begin end))
3658 (make-directory js-js-tmpdir t)
3660 ;; (Re)register a Mozilla resource URL to point to the
3661 ;; temporary directory
3662 (js--js-add-resource-alias "js" js-js-tmpdir)
3664 (setq temp-name (make-temp-file (concat js-js-tmpdir
3665 "/js-")
3666 nil ".js"))
3667 (unwind-protect
3668 (with-js
3669 (with-temp-buffer
3670 (insert js--js-inserter)
3671 (insert "(")
3672 (insert (json-encode-list defun-info))
3673 (insert ",\n")
3674 (insert defun-body)
3675 (insert "\n)")
3676 (write-region (point-min) (point-max) temp-name
3677 nil 1))
3679 ;; Give Mozilla responsibility for deleting this file
3680 (let* ((content-window (js--js-content-window
3681 (js--get-js-context)))
3682 (content-document (js< content-window "document"))
3683 (head (if (js? (js< content-document "body"))
3684 ;; Regular content
3685 (js< (js! (content-document "getElementsByTagName")
3686 "head")
3688 ;; Chrome
3689 (js< content-document "documentElement")))
3690 (elem (js! (content-document "createElementNS")
3691 "http://www.w3.org/1999/xhtml" "script")))
3693 (js! (elem "setAttribute") "type" "text/javascript")
3694 (js! (elem "setAttribute") "src"
3695 (format "resource://js/%s"
3696 (file-name-nondirectory temp-name)))
3698 (js! (head "appendChild") elem)
3700 (js! (content-window "addEventListener") "unload"
3701 (js! ((js-new
3702 "Function" "file"
3703 "return function() { file.remove(false) }"))
3704 (js--make-nsilocalfile temp-name))
3705 'false)
3706 (setq temp-name nil)
3712 ;; temp-name is set to nil on success
3713 (when temp-name
3714 (delete-file temp-name))))))
3716 ;;; Main Function
3718 ;;;###autoload
3719 (define-derived-mode js-mode prog-mode "JavaScript"
3720 "Major mode for editing JavaScript."
3721 :group 'js
3722 (setq-local indent-line-function #'js-indent-line)
3723 (setq-local beginning-of-defun-function #'js-beginning-of-defun)
3724 (setq-local end-of-defun-function #'js-end-of-defun)
3725 (setq-local open-paren-in-column-0-is-defun-start nil)
3726 (setq-local font-lock-defaults (list js--font-lock-keywords))
3727 (setq-local syntax-propertize-function #'js-syntax-propertize)
3728 (setq-local prettify-symbols-alist js--prettify-symbols-alist)
3730 (setq-local parse-sexp-ignore-comments t)
3731 (setq-local parse-sexp-lookup-properties t)
3732 (setq-local which-func-imenu-joiner-function #'js--which-func-joiner)
3734 ;; Comments
3735 (setq-local comment-start "// ")
3736 (setq-local comment-end "")
3737 (setq-local fill-paragraph-function #'js-c-fill-paragraph)
3739 ;; Parse cache
3740 (add-hook 'before-change-functions #'js--flush-caches t t)
3742 ;; Frameworks
3743 (js--update-quick-match-re)
3745 ;; Imenu
3746 (setq imenu-case-fold-search nil)
3747 (setq imenu-create-index-function #'js--imenu-create-index)
3749 ;; for filling, pretend we're cc-mode
3750 (setq c-comment-prefix-regexp "//+\\|\\**"
3751 c-paragraph-start "\\(@[[:alpha:]]+\\>\\|$\\)"
3752 c-paragraph-separate "$"
3753 c-block-comment-prefix "* "
3754 c-line-comment-starter "//"
3755 c-comment-start-regexp "/[*/]\\|\\s!"
3756 comment-start-skip "\\(//+\\|/\\*+\\)\\s *")
3758 (setq-local electric-indent-chars
3759 (append "{}():;," electric-indent-chars)) ;FIXME: js2-mode adds "[]*".
3760 (setq-local electric-layout-rules
3761 '((?\; . after) (?\{ . after) (?\} . before)))
3763 (let ((c-buffer-is-cc-mode t))
3764 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3765 ;; we call it instead? (Bug#6071)
3766 (make-local-variable 'paragraph-start)
3767 (make-local-variable 'paragraph-separate)
3768 (make-local-variable 'paragraph-ignore-fill-prefix)
3769 (make-local-variable 'adaptive-fill-mode)
3770 (make-local-variable 'adaptive-fill-regexp)
3771 (c-setup-paragraph-variables))
3773 ;; Important to fontify the whole buffer syntactically! If we don't,
3774 ;; then we might have regular expression literals that aren't marked
3775 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3776 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3777 ;; When we attempt to find the error and scroll to the portion of
3778 ;; the buffer containing the problem, JIT-lock will apply the
3779 ;; correct syntax to the regular expression literal and the problem
3780 ;; will mysteriously disappear.
3781 ;; FIXME: We should instead do this fontification lazily by adding
3782 ;; calls to syntax-propertize wherever it's really needed.
3783 ;;(syntax-propertize (point-max))
3786 ;;;###autoload
3787 (define-derived-mode js-jsx-mode js-mode "JSX"
3788 "Major mode for editing JSX.
3790 To customize the indentation for this mode, set the SGML offset
3791 variables (`sgml-basic-offset', `sgml-attribute-offset' et al.)
3792 locally, like so:
3794 (defun set-jsx-indentation ()
3795 (setq-local sgml-basic-offset js-indent-level))
3796 (add-hook \\='js-jsx-mode-hook #\\='set-jsx-indentation)"
3797 :group 'js
3798 (setq-local indent-line-function #'js-jsx-indent-line))
3800 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3802 (eval-after-load 'folding
3803 '(when (fboundp 'folding-add-to-marks-list)
3804 (folding-add-to-marks-list 'js-mode "// {{{" "// }}}" )))
3806 ;;;###autoload
3807 (dolist (name (list "node" "nodejs" "gjs" "rhino"))
3808 (add-to-list 'interpreter-mode-alist (cons (purecopy name) 'js-mode)))
3810 (provide 'js)
3812 ;; js.el ends here