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