| blob | e84215d4301174d2b21cba69abdab73a8525621e |
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
3 ;; Copyright (C) 2008-2017 Free Software Foundation, Inc.
5 ;; Author: Karl Landstrom <karl.landstrom@brgeight.se>
6 ;; Daniel Colascione <dan.colascione@gmail.com>
7 ;; Maintainer: Daniel Colascione <dan.colascione@gmail.com>
8 ;; Version: 9
9 ;; Date: 2009-07-25
10 ;; Keywords: languages, javascript
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary
29 ;; This is based on Karl Landstrom's barebones javascript-mode. This
30 ;; is much more robust and works with cc-mode's comment filling
31 ;; (mostly).
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--".
46 ;;; Code:
68 ;;; Constants
90 "Regexp matching the prefix of a cpp directive.
91 This includes the directive name, or nil in languages without
92 preprocessor support. The first submatch surrounds the directive
99 Group 1 is a (possibly-dotted) class name, group 2 is a method name,
108 ;; var NewClass = BaseClass.extend(
116 ;; var NewClass = Class.create()
132 ;; var NewClass = Class.create({
139 ;; Parent class name(s) (yes, multiple inheritance in JavaScript) are
140 ;; matched with dedicated font-lock matchers
168 :prototype t
174 :prototype t
190 :prototype t
196 :prototype t
207 :prototype t
221 "List of JavaScript class definition styles.
223 A class definition style is a plist with the following keys:
225 :name is a human-readable name of the class type
227 :class-decl is a regular expression giving the start of the
228 class. Its first group must match the name of its class. If there
229 is a parent class, the second group should match, and it should be
230 the name of the class.
232 If :prototype is present and non-nil, the parser will merge
233 declarations for this constructs with others at the same lexical
234 level that have the same name. Otherwise, multiple definitions
235 will create multiple top-level entries. Don't use :prototype
236 unnecessarily: it has an associated cost in performance.
238 If :strip-prototype is present and non-nil, then if the class
239 name as matched contains
246 collect framework into available-frameworks
247 finally return available-frameworks)
253 "Regexp matching the start of a JavaScript function header.
259 "Regexp matching the start of a function entry in an associative array.
271 "Regexp matching a CPP macro definition, up to the opening parenthesis.
321 ;; js--pitem is the basic building block of the lexical
322 ;; database. When one refers to a real part of the buffer, the region
323 ;; of text to which it refers is split into a conceptual header and
324 ;; body. Consider the (very short) block described by a hypothetical
325 ;; js--pitem:
326 ;;
327 ;; function foo(a,b,c) { return 42; }
328 ;; ^ ^ ^
329 ;; | | |
330 ;; +- h-begin +- h-end +- b-end
331 ;;
332 ;; (Remember that these are buffer positions, and therefore point
333 ;; between characters, not at them. An arrow drawn to a character
334 ;; indicates the corresponding position is between that character and
335 ;; the one immediately preceding it.)
336 ;;
337 ;; The header is the region of text [h-begin, h-end], and is
338 ;; the text needed to unambiguously recognize the start of the
339 ;; construct. If the entire header is not present, the construct is
340 ;; not recognized at all. No other pitems may be nested inside the
341 ;; header.
342 ;;
343 ;; The body is the region [h-end, b-end]. It may contain nested
344 ;; js--pitem instances. The body of a pitem may be empty: in
345 ;; that case, b-end is equal to header-end.
346 ;;
347 ;; The three points obey the following relationship:
348 ;;
349 ;; h-begin < h-end <= b-end
350 ;;
351 ;; We put a text property in the buffer on the character *before*
352 ;; h-end, and if we see it, on the character *before* b-end.
353 ;;
354 ;; The text property for h-end, js--pstate, is actually a list
355 ;; of all js--pitem instances open after the marked character.
356 ;;
357 ;; The text property for b-end, js--pend, is simply the
358 ;; js--pitem that ends after the marked character. (Because
359 ;; pitems always end when the paren-depth drops below a critical
360 ;; value, and because we can only drop one level per character, only
361 ;; one pitem may end at a given character.)
362 ;;
363 ;; In the structure below, we only store h-begin and (sometimes)
364 ;; b-end. We can trivially and quickly find h-end by going to h-begin
365 ;; and searching for an js--pstate text property. Since no other
366 ;; js--pitem instances can be nested inside the header of a
367 ;; pitem, the location after the character with this text property
368 ;; must be h-end.
369 ;;
370 ;; js--pitem instances are never modified (with the exception
371 ;; of the b-end field). Instead, modified copies are added at
372 ;; subsequence parse points.
373 ;; (The exception for b-end and its caveats is described below.)
374 ;;
377 ;; IMPORTANT: Do not alter the position of fields within the list.
378 ;; Various bits of code depend on their positions, particularly
379 ;; anything that manipulates the list of children.
381 ;; List of children inside this pitem's body
384 ;; When we reach this paren depth after h-end, the pitem ends
387 ;; Symbol or class-style plist if this is a class
390 ;; See above
393 ;; List of strings giving the parts of the name of this pitem (e.g.,
394 ;; '("MyClass" "myMethod"), or t if this pitem is anonymous
397 ;; THIS FIELD IS MUTATED, and its value is shared by all copies of
398 ;; this pitem: when we copy-and-modify pitem instances, we share
399 ;; their tail structures, so all the copies actually have the same
400 ;; terminating cons cell. We modify that shared cons cell directly.
401 ;;
402 ;; The field value is either a number (buffer location) or nil if
403 ;; unknown.
404 ;;
405 ;; If the field's value is greater than `js--cache-end', the
406 ;; value is stale and must be treated as if it were nil. Conversely,
407 ;; if this field is nil, it is guaranteed that this pitem is open up
408 ;; to at least `js--cache-end'. (This property is handy when
409 ;; computing whether we're inside a given pitem.)
410 ;;
413 ;; The pitem we start parsing with.
416 :paren-depth most-negative-fixnum
419 ;;; User Customization
422 "Customization variables for JavaScript mode."
427 "Number of spaces for each indentation step in `js-mode'."
433 "Number of additional spaces for indenting continued expressions.
434 The value must be no less than minus `js-indent-level'."
440 "Number of additional spaces for indenting expressions in parentheses.
441 The value must be no less than minus `js-indent-level'."
448 "Number of additional spaces for indenting expressions in square braces.
449 The value must be no less than minus `js-indent-level'."
456 "Number of additional spaces for indenting expressions in curly braces.
457 The value must be no less than minus `js-indent-level'."
464 "Number of additional spaces for indenting the contents of a switch block.
465 The value must not be negative."
472 "Treat nested functions as top-level functions in `js-mode'.
473 This applies to function movement, marking, and so on."
478 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
483 "Frameworks recognized by `js-mode'.
484 To improve performance, you may turn off some frameworks you
485 seldom use, either globally or on a per-buffer basis."
488 js--available-frameworks))
493 "Whether `js-mode' should display tabs while selecting them.
494 This is useful only if the windowing system has a good mechanism
495 for preventing Firefox from stealing the keyboard focus."
500 "~/.emacs.d/js/js"
501 "Temporary directory used by `js-mode' to communicate with Mozilla.
502 This directory must be readable and writable by both Mozilla and Emacs."
507 "Reply timeout for executing commands in Mozilla via `js-mode'.
508 The value is given in seconds. Increase this value if you are
509 getting timeout messages."
514 "Non-nil means specially indent the first variable declaration's initializer.
515 Normally, the first declaration's initializer is unindented, and
516 subsequent declarations have their identifiers aligned with it:
518 var o = {
519 foo: 3
520 };
522 var o = {
523 foo: 3
524 },
525 bar = 2;
527 If this option has the value t, indent the first declaration's
528 initializer by an additional level:
530 var o = {
531 foo: 3
532 };
534 var o = {
535 foo: 3
536 },
537 bar = 2;
539 If this option has the value `dynamic', if there is only one declaration,
540 don't indent the first one's initializer; otherwise, indent it.
542 var o = {
543 foo: 3
544 };
546 var o = {
547 foo: 3
548 },
549 bar = 2;"
555 ;;; KeyMap
571 keymap)
574 ;;; Syntax table and parsing
581 table)
612 "Helper function for `js--update-quick-match-re'.
613 If LIST contains any element that is not nil, return its non-nil
614 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
615 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
616 nil. If any element in LIST is itself a list, flatten that
617 element."
623 "Internal function used by `js-mode' for caching buffer constructs.
624 This updates `js--quick-match-re', based on the current set of
625 enabled frameworks."
630 ;; #define mumble
639 ;; var mumble = THING (
660 ;; mumble.prototypeTHING
668 ;; mumble.prototype = {
675 "Move over the next value of PROPNAME in the buffer.
676 If found, return that value and leave point after the character
677 having that value; otherwise, return nil and leave point at EOB."
688 next-value))
691 "Move over the previous value of PROPNAME in the buffer.
692 If found, return that value and leave point just before the
693 character that has that value, otherwise return nil and leave
694 point at BOB."
707 prev-value)))
720 "Helper function for `js--re-search-forward'."
722 str-terminator
751 "Search forward, ignoring strings, cpp macros, and comments.
752 This function invokes `re-search-forward', but treats the buffer
753 as if strings, cpp macros, and comments have been removed.
755 If invoked while inside a macro, it treats the contents of the
756 macro as normal text."
773 "Auxiliary function for `js--re-search-backward'."
775 str-terminator
806 "Search backward, ignoring strings, preprocessor macros, and comments.
808 This function invokes `re-search-backward' but treats the buffer
809 as if strings, preprocessor macros, and comments have been
810 removed.
812 If invoked while inside a macro, treat the macro as normal text."
816 "Move forward over a whole JavaScript expression.
817 This function doesn't move over expressions continued across
818 lines."
820 ;; non-continued case; simplistic, but good enough?
833 "Move forward over a JavaScript function declaration.
834 This puts point at the `function' keyword.
836 If this is a syntactically-correct non-expression function,
837 return the name of the function, or t if the name could not be
838 determined. Otherwise, return nil."
854 name)))))
857 "Return the start of the JavaScript function prologue containing POS.
858 A function prologue is everything from start of the definition up
859 to and including the opening brace. POS defaults to point.
860 If POS is not in a function prologue, return nil."
887 "Helper function for `js-beginning-of-defun'.
888 Go to previous defun-beginning and return the parse state for it,
889 or nil if we went all the way back to bob and don't find
890 anything."
898 "Helper function for `js--beginning-of-defun-nested'.
899 If PSTATE represents a non-empty top-level defun, return the
900 top-most pitem. Otherwise, return nil."
903 with func-pitem
910 "Helper function for `js--beginning-of-defun'.
911 Return the pitem of the function we went to the beginning of."
913 ;; Look for the smallest function that encloses point...
918 and return pitem)
920 ;; ...and if that isn't found, look for the previous top-level
921 ;; defun
923 while pstate
926 and return it)))
929 "Helper function for `js-beginning-of-defun'."
935 "Value of `beginning-of-defun-function' for `js-mode'."
951 ;; If we're just past the end of a function, the user probably wants
952 ;; to go to the beginning of *that* function
966 "Flush the `js-mode' syntax cache after position BEG.
967 BEG defaults to `point-min', meaning to flush the entire cache."
973 ;; `(message ,@arguments)
974 )
983 ;; open-items must contain at least two items for this to
984 ;; work, but because we push a dummy item to start with,
985 ;; that assumption holds.
988 open-items)
991 "Helper function for `js--ensure-cache'.
992 Update parsing information up to point, referring to parse,
993 prev-parse-point, goal-point, and open-items bound lexically in
994 the body of `js--ensure-cache'."
1001 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
1002 ;; the given depth -- i.e., make sure we're deeper than the target
1003 ;; depth.
1007 prev-parse-point goal-point
1009 nil parse))
1011 ;; (let ((overlay (make-overlay prev-parse-point (point))))
1012 ;; (overlay-put overlay 'face '(:background "red"))
1013 ;; (unwind-protect
1014 ;; (progn
1015 ;; (js--debug "parsed: %S" parse)
1016 ;; (sit-for 1))
1017 ;; (delete-overlay overlay)))
1033 "Split a JavaScript name into its dot-separated parts.
1034 This also removes any prototype parts from the split name
1046 "Guess the name of the JavaScript function at POSITION.
1048 Return the name of the function, or nil if the name could not be
1049 guessed.
1051 This function clobbers match data. If we find the preamble
1052 begins earlier than expected while guessing the function name,
1053 set `js--guess-function-name-start' to that position; otherwise,
1054 set that variable to nil."
1071 ;; Clear any endings that occur after point
1078 ;; Remove any cache properties after this point
1083 "Ensures brace cache is valid up to the character before LIMIT.
1084 LIMIT defaults to point."
1090 parse
1091 prev-parse-point
1092 name
1093 case-fold-search
1094 filtered-class-styles
1095 goal-point)
1097 ;; Figure out which class styles we need to look for
1101 js-enabled-frameworks)
1102 collect style))
1108 ;; Find last known good position
1124 ;; Make a placeholder for the top-level definition
1140 ;; Each of these conditions should return non-nil if
1141 ;; we should add a new item and leave point at the end
1142 ;; of the new item's header (h-end in the
1143 ;; js--pitem diagram). This point is the one
1144 ;; after the last character we need to unambiguously
1145 ;; detect this construct. If one of these evaluates to
1146 ;; nil, the location of the point is ignored.
1148 ;; In comment or string
1151 ;; Regular function declaration
1160 js--guess-function-name-start))
1167 :paren-depth orig-depth
1168 :h-begin orig-match-start
1171 name
1174 ;; Macro
1177 ;; Macros often contain unbalanced parentheses.
1178 ;; Make sure that h-end is at the textual end of
1179 ;; the macro no matter what the parenthesis say.
1185 :h-begin orig-match-start
1189 ;; "Prototype function" declaration
1196 :paren-depth orig-depth
1197 :h-begin orig-match-start
1203 ;; Class definition
1205 with syntactic-context =
1207 for class-style in filtered-class-styles
1213 and return
1215 :paren-depth orig-depth
1216 :h-begin orig-match-start
1217 :type class-style
1232 )))))
1235 "Helper function for `js-end-of-defun'."
1240 return t
1244 "Helper function for `js-end-of-defun'."
1253 found)
1256 ;; We're already inside a function; just go to its end.
1259 ;; Otherwise, go to the end of the next function...
1266 ;; ... or eob.
1270 "Value of `end-of-defun-function' for `js-mode'."
1281 ;; look for function backward. if we're inside it, go to that
1282 ;; function's end. otherwise, search for the next function's end and
1283 ;; go there
1287 ;; if we're doing nested functions, see whether we're in the
1288 ;; prologue. If we are, go to the end of the function; otherwise,
1289 ;; call js--end-of-defun-nested to do the real work
1310 t
1312 nil))))
1315 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1326 pos
1330 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1340 pos
1343 ;; Like (up-list -1), but only considers lists that end nearby"
1346 ;; Look at a very small region so our computation time doesn't
1347 ;; explode in pathological cases.
1352 "Return non-nil if point is in a function parameter list."
1363 "Return non-nil if point is in a Dojo multiple-inheritance class block."
1374 ;;; Font Lock
1376 "Helper function for building `js--font-lock-keywords'.
1377 Create a byte-compiled function for matching a concatenation of
1378 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1389 "Move forward over a JavaScript destructuring spec.
1390 If FUNC is supplied, call it with no arguments before every
1391 variable name in the spec. Return true if this was actually a
1392 spec. FUNC must preserve the match data."
1404 t)
1409 t))))
1412 t))
1426 t))
1431 t)))))
1434 t))))
1437 "Font-lock matcher for variable names in a variable declaration.
1438 This is a cc-mode-style matcher that *always* fails, from the
1439 point of view of font-lock. It applies highlighting directly with
1440 `font-lock-apply-highlight'."
1452 t))
1474 ;; Conditions to handle
1478 ;; Matcher always "fails"
1479 nil)
1482 `(
1483 ;; This goes before keywords-2 so it gets used preferentially
1484 ;; instead of the keywords in keywords-2. Don't use override
1485 ;; because that will override syntactic fontification too, which
1486 ;; will fontify commented-out directives as if they weren't
1487 ;; commented out.
1490 ,@js--font-lock-keywords-2
1495 ;; Highlights class being declared, in parts
1499 nil
1502 ;; Highlights parent class, in parts, if available
1519 ;; Highlights parent class
1523 ;; Dojo needs its own matcher to override the string highlighting
1525 'dojo
1532 ;; Match Dojo base classes. Of course Mojo has to be different
1533 ;; from everything else under the sun...
1535 'dojo
1544 ;; continued Dojo base-class list
1546 'dojo
1557 ;; variable declarations
1562 ;; class instantiation
1567 ;; instanceof
1572 ;; formal parameters
1576 js--name-start-re)
1582 ;; continued formal parameter list
1596 "Return whether point is inside the given pitem's header or body."
1606 "Parse the JavaScript program state at point.
1607 Return a list of `js--pitem' instances that apply to point, most
1608 specific first. In the worst case, the current toplevel instance
1609 will be returned."
1618 ;; Loop until we either hit a pitem at BOB or pitem ends after
1619 ;; point (or at point if we're at eob)
1626 pstate))))
1629 "Return the JavaScript syntactic context corresponding to PSTATE."
1632 type)
1638 "Return the JavaScript syntactic context at point.
1639 When called interactively, also display a message with that
1640 context."
1648 syntactic-context))
1651 "Font lock function used by `js-mode'.
1652 This performs fontification according to `js--class-styles'."
1660 js-enabled-frameworks)
1663 decl-re
1666 and return t)
1667 return t
1672 js--font-lock-keywords-2
1673 js--font-lock-keywords-3)
1681 st))
1686 ;; A /.../ regexp.
1691 js--syntax-propertize-regexp-syntax-table
1694 ;; A / within a character class is not the end of a regexp.
1695 t
1698 nil))))))
1701 ;; Javascript allows immediate regular expression objects, written /.../.
1706 ;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
1707 ;; FIXME: Allow regexps after infix ops like + ...
1708 ;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
1709 ;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
1710 ;; point I think only * and / would be missing which could also be added,
1711 ;; but need care to avoid affecting the // and */ comment markers.
1716 ;; If the / is at the beginning of line, we have to check
1717 ;; the end of the previous text.
1735 ;;; Indentation
1753 "Return non-nil if point is on a JavaScript operator, other than a comma."
1766 ;; Generator method (possibly using computed property).
1770 ;; We might misindent some expressions that would
1771 ;; return NaN anyway. Shouldn't be a problem.
1775 "Move backward to the nearest newline that is not in a block comment."
1782 ;; We match the end of a // comment but not a newline in a
1783 ;; block comment.
1786 ;; If we saw a block comment, keep trying.
1790 result))
1793 "Return non-nil if the current line continues an expression."
1814 Otherwise, return nil. A braceless do-while statement spanning
1815 several lines requires that the start of the loop is indented to
1816 the same column as the current line."
1838 "Helper function for `js--proper-indentation'.
1839 Return the proper indentation of the current line if it starts
1840 the body of a control statement without braces; otherwise, return
1841 nil."
1870 "Helper function for `js--proper-indentation'.
1871 Return the proper indentation of the current line if it belongs to a declaration
1872 statement spanning multiple lines; otherwise, return nil."
1874 at-opening-bracket)
1901 "Return non-nil if we think we're in an array comprehension.
1902 In particular, return the buffer position of the first `for' kwd."
1916 ;; To skip arbitrary expressions we need the parser,
1917 ;; so we'll just guess at it.
1920 ;; Not inside comment or string literal.
1928 ;; First continuation line.
1939 "Helper function for `js--proper-indentation'.
1940 Depending on the value of `js-indent-first-init', move
1941 point to the end of a variable declaration keyword so that
1942 indentation is aligned to that column."
1949 declaration-keyword-end
1950 at-closing-bracket-p
1951 forward-sexp-function ; Use Lisp version.
1952 comma-p)
1961 t)
1970 "Return the proper indentation for the current line."
1978 ;; Indent array comprehension continuation lines specially.
1980 beg)
1984 ;; At or after the first loop?
1990 ;; A single closing paren/bracket should be indented at the
1991 ;; same level as the opening statement. Same goes for
1992 ;; "case" and "default".
2007 in-switch-p)))
2013 js-expr-indent-offset))
2022 indent)))
2023 ;; If there is something following the opening
2024 ;; paren/bracket, everything else should be indented at
2025 ;; the same level.
2035 ;;; JSX Indentation
2038 "Find where JSX starts.
2040 Assume JSX appears in the following instances:
2041 - Inside parentheses, when returned or as the first argument
2042 to a function, and after a newline
2043 - When assigned to variables or object properties, but only
2044 on a single line
2045 - As the N+1th argument to a function
2048 nil t), except set point to the end of the match. This logic
2049 executes up to the number of lines in the file, so it should be
2050 really fast to reduce that impact."
2058 pos))
2065 "Find where JSX ends.
2066 This complements the assumption of where JSX appears from
2070 "Determine if/how the current line should be indented as JSX.
2072 Return `first' for the first JSXElement on its own line.
2073 Return `nth' for subsequent lines of the first JSXElement.
2074 Return `expression' for an embedded JS expression.
2075 Return `after' for anything after the last JSXElement.
2076 Return nil for non-JSX lines.
2078 Currently, JSX indentation supports the following styles:
2080 - Single-line elements (indented like normal JS):
2082 var element = <div></div>;
2084 - Multi-line elements (enclosed in parentheses):
2086 function () {
2087 return (
2088 <div>
2089 <div></div>
2090 </div>
2091 );
2092 }
2094 - Function arguments:
2096 React.render(
2097 <div></div>,
2098 document.querySelector('.root')
2099 );"
2102 last-pos
2103 before-tag-pos before-tag-line
2104 tag-start-pos tag-start-line
2105 tag-end-pos tag-end-line
2106 after-tag-line
2107 parens paren type)
2110 ;; Determine if we're inside a jsx element
2120 tag-start-pos)
2125 ;; A "before" line which also starts an element begins with js, so
2126 ;; indent it like js
2128 ;; Only indent the jsx lines like jsx
2131 ;; Analyze bounds if there are any
2138 tag-end-pos)
2142 ;; Ensure we're actually within the bounds of the jsx
2144 ;; An "after" line which does not end an element begins with
2145 ;; js, so indent it like js
2148 ;; Handle another case where there could be e.g. comments after
2149 ;; the element
2153 ;; They may not be any bounds (yet)
2155 ;; Check if we're inside an embedded multi-line js expression
2165 ;; Curly bracket indicates the start of an embedded expression
2167 ;; The first line of the expression is indented like sgml
2169 ;; Check if within a closing curly bracket (if any)
2170 ;; (exclusive, as the closing bracket is indented like sgml)
2178 ;; Indicate this guy will be indented specially
2181 t)
2185 ;; Indent the first jsx thing like js so we can indent future jsx things
2186 ;; like sgml relative to the first thing
2191 "Execute BODY as if in sgml-mode."
2194 parse-sexp-lookup-properties)
2198 "Indent the current line as JavaScript or SGML (whichever is farther)."
2201 ;; Don't whine about errors/warnings when we're indenting.
2202 ;; This has to be set before calling parse-partial-sexp below.
2206 ;; Don't touch multiline strings.
2213 'noindent
2214 ;; Use whichever indentation column is greater, such that the sgml
2215 ;; column is effectively a minimum
2223 "Indent the current line as JavaScript."
2233 "Indent the current line as JSX (with SGML offsets).
2234 i.e., customize JSX element indentation with `sgml-basic-offset',
2235 `sgml-attribute-offset' et al."
2243 ;; Don't treat this first thing as a continued expression (often a "<" or
2244 ;; ">" causes this misinterpretation)
2251 ;;; Filling
2255 ;; FIXME: Such redefinitions are bad style. We should try and use some other
2256 ;; way to get the same result.
2260 ad-do-it))
2265 ad-do-it))
2270 ad-do-it))
2273 "Fill the paragraph with `c-fill-paragraph'."
2279 ;;; Type database and Imenu
2281 ;; We maintain a cache of semantic information, i.e., the classes and
2282 ;; functions we've encountered so far. In order to avoid having to
2283 ;; re-parse the buffer on every change, we cache the parse state at
2284 ;; each interesting point in the buffer. Each parse state is a
2285 ;; modified copy of the previous one, or in the case of the first
2286 ;; parse state, the empty state.
2287 ;;
2288 ;; The parse state itself is just a stack of js--pitem
2289 ;; instances. It starts off containing one element that is never
2290 ;; closed, that is initially js--initial-pitem.
2291 ;;
2299 name
2301 type
2305 "Helper function for `js--splice-into-items'.
2306 Return a new item that is the result of merging CHILD into
2307 ITEM. NAME-PARTS is a list of parts of the name of CHILD
2308 that we haven't consumed yet."
2313 ;; If the item we're merging into isn't a class, make it into one
2319 ;; Use the child's class-style if it's available
2321 js--dummy-class-style
2326 ;; Now we can merge either a function or a class into a class
2330 ;; if we have more name-parts to go before we get to the
2331 ;; bottom of the class hierarchy, call the merger
2332 ;; recursively
2338 ;; Not merging a class, but something else, so just prepend
2339 ;; it
2343 ;; Otherwise, merge the new child's items into those
2344 ;; of the new class
2350 "Last part of the name of PITEM, as a string or symbol."
2354 name)))
2357 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2358 If a class doesn't exist in the tree, create it. Return
2359 the new items list. NAME-PARTS is a list of strings given
2360 the broken-down class name of the item to insert."
2364 new-items last-new-item new-cons)
2367 name-parts
2373 ;; If top-name isn't found in items, then we build a copy of items
2374 ;; and throw it away. But that's okay, since most of the time, we
2375 ;; *will* find an instance.
2379 ;; Okay, we found an entry with the right name. Splice
2380 ;; the merged item into the list...
2383 name-parts)
2390 ;; ...and terminate the loop
2391 nil)
2394 ;; Otherwise, copy the current cons and move onto the
2395 ;; text. This is tricky; we keep track of the tail of
2396 ;; the list that begins with new-items in
2397 ;; last-new-item.
2404 ;; Go to the next cell in items
2408 ;; Yay! We stopped because we found something, not because
2409 ;; we ran out of items to search. Just return the new
2410 ;; list.
2413 new-items)
2415 ;; We didn't find anything. If the child is a class and we don't
2416 ;; have any classes to drill down into, just push that class;
2417 ;; otherwise, make a fake class and carry on.
2420 ;; We have name-parts left to process. Make a fake
2421 ;; class for this particular part...
2423 ;; ...and recursively digest the rest of the name
2426 :type js--dummy-class-style
2429 ;; Otherwise, this is the only name we have, so stick
2430 ;; the item on the front of the list
2431 child)
2432 items))))
2435 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2440 t))
2442 ;; This trick works because we know (based on our defstructs) that
2443 ;; the child list is always the first element, and so the second
2444 ;; element and beyond can be shared when we make our "copy".
2451 ;; Use slow path because we need class lookup
2457 ;; Use slow path because we need class merging. We know
2458 ;; name is a list here because down in
2459 ;; `js--ensure-cache', we made sure to only add
2460 ;; class entries with lists for :name
2465 ;; Fast path
2471 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2474 location))
2477 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2494 imenu-items))
2499 unknown-ctr))
2502 imenu-items))
2511 imenu-items))))
2515 imenu-items))
2518 "Return an imenu index for the current buffer."
2530 ;; Make sure everything is closed
2538 ;; Convert the new-finalized state into what imenu expects
2541 unknown-ctr))))))
2543 ;; Silence the compiler.
2554 symbols)
2555 else
2566 "Return a hash table of all JavaScript symbols.
2567 This searches all existing `js-mode' buffers. Each key is the
2568 name of a symbol (possibly disambiguated with <N>, where N > 1),
2569 and each value is a marker giving the location of that symbol."
2571 with imenu-use-markers = t
2572 for buffer being the buffers
2577 finally return symbols))
2583 "Helper function for `js-find-symbol'.
2584 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2585 one from `js--get-all-known-symbols', using prompt PROMPT and
2586 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2587 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2588 marker."
2594 prompt
2596 collect key)
2612 ;; etags loads ring.
2616 "Read a JavaScript symbol and jump to it.
2617 With a prefix argument, restrict symbols to those from the
2618 current buffer. Pushes a mark onto the tag ring just like
2619 `find-tag'."
2630 symbols "Jump to: "
2638 ;;; MozRepl integration
2645 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2646 On timeout, return nil. On success, return t with match data
2647 set. If START is non-nil, look for output starting from START.
2648 Otherwise, use the current value of `process-mark'."
2660 'js-moz-bad-rpc
2664 ;; Integer, mirrors the value we see in JS
2667 ;; Process to which this thing belongs
2688 ; */" Make Emacs happy
2689 "(function(repl) {
2690 repl.defineInteractor('js', {
2691 onStart: function onStart(repl) {
2692 if(!repl._jsObjects) {
2693 repl._jsObjects = {};
2694 repl._jsLastID = 0;
2695 repl._jsGC = this._jsGC;
2696 }
2697 this._input = '';
2698 },
2700 _jsGC: function _jsGC(ids_in_use) {
2701 var objects = this._jsObjects;
2702 var keys = [];
2703 var num_freed = 0;
2705 for(var pn in objects) {
2706 keys.push(Number(pn));
2707 }
2709 keys.sort(function(x, y) x - y);
2710 ids_in_use.sort(function(x, y) x - y);
2711 var i = 0;
2712 var j = 0;
2714 while(i < ids_in_use.length && j < keys.length) {
2715 var id = ids_in_use[i++];
2716 while(j < keys.length && keys[j] !== id) {
2717 var k_id = keys[j++];
2718 delete objects[k_id];
2719 ++num_freed;
2720 }
2721 ++j;
2722 }
2724 while(j < keys.length) {
2725 var k_id = keys[j++];
2726 delete objects[k_id];
2727 ++num_freed;
2728 }
2730 return num_freed;
2731 },
2733 _mkArray: function _mkArray() {
2734 var result = [];
2735 for(var i = 0; i < arguments.length; ++i) {
2736 result.push(arguments[i]);
2737 }
2738 return result;
2739 },
2741 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2742 if(typeof parts === 'string') {
2743 parts = [ parts ];
2744 }
2746 var obj = parts[0];
2747 var start = 1;
2749 if(typeof obj === 'string') {
2750 obj = window;
2751 start = 0;
2752 } else if(parts.length < 2) {
2753 throw new Error('expected at least 2 arguments');
2754 }
2756 for(var i = start; i < parts.length - 1; ++i) {
2757 obj = obj[parts[i]];
2758 }
2760 return [obj, parts[parts.length - 1]];
2761 },
2763 _getProp: function _getProp(/*...*/) {
2764 if(arguments.length === 0) {
2765 throw new Error('no arguments supplied to getprop');
2766 }
2768 if(arguments.length === 1 &&
2769 (typeof arguments[0]) !== 'string')
2770 {
2771 return arguments[0];
2772 }
2774 var [obj, propname] = this._parsePropDescriptor(arguments);
2775 return obj[propname];
2776 },
2778 _putProp: function _putProp(properties, value) {
2779 var [obj, propname] = this._parsePropDescriptor(properties);
2780 obj[propname] = value;
2781 },
2783 _delProp: function _delProp(propname) {
2784 var [obj, propname] = this._parsePropDescriptor(arguments);
2785 delete obj[propname];
2786 },
2788 _typeOf: function _typeOf(thing) {
2789 return typeof thing;
2790 },
2792 _callNew: function(constructor) {
2793 if(typeof constructor === 'string')
2794 {
2795 constructor = window[constructor];
2796 } else if(constructor.length === 1 &&
2797 typeof constructor[0] !== 'string')
2798 {
2799 constructor = constructor[0];
2800 } else {
2801 var [obj,propname] = this._parsePropDescriptor(constructor);
2802 constructor = obj[propname];
2803 }
2805 /* Hacky, but should be robust */
2806 var s = 'new constructor(';
2807 for(var i = 1; i < arguments.length; ++i) {
2808 if(i != 1) {
2809 s += ',';
2810 }
2812 s += 'arguments[' + i + ']';
2813 }
2815 s += ')';
2816 return eval(s);
2817 },
2819 _callEval: function(thisobj, js) {
2820 return eval.call(thisobj, js);
2821 },
2823 getPrompt: function getPrompt(repl) {
2824 return 'EVAL>'
2825 },
2827 _lookupObject: function _lookupObject(repl, id) {
2828 if(typeof id === 'string') {
2829 switch(id) {
2830 case 'global':
2831 return window;
2832 case 'nil':
2833 return null;
2834 case 't':
2835 return true;
2836 case 'false':
2837 return false;
2838 case 'undefined':
2839 return undefined;
2840 case 'repl':
2841 return repl;
2842 case 'interactor':
2843 return this;
2844 case 'NaN':
2845 return NaN;
2846 case 'Infinity':
2847 return Infinity;
2848 case '-Infinity':
2849 return -Infinity;
2850 default:
2851 throw new Error('No object with special id:' + id);
2852 }
2853 }
2855 var ret = repl._jsObjects[id];
2856 if(ret === undefined) {
2857 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2858 }
2859 return ret;
2860 },
2862 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2863 if(typeof value !== 'object' && typeof value !== 'function') {
2864 throw new Error('_findOrAllocateObject called on non-object('
2865 + typeof(value) + '): '
2866 + value)
2867 }
2869 for(var id in repl._jsObjects) {
2870 id = Number(id);
2871 var obj = repl._jsObjects[id];
2872 if(obj === value) {
2873 return id;
2874 }
2875 }
2877 var id = ++repl._jsLastID;
2878 repl._jsObjects[id] = value;
2879 return id;
2880 },
2882 _fixupList: function _fixupList(repl, list) {
2883 for(var i = 0; i < list.length; ++i) {
2884 if(list[i] instanceof Array) {
2885 this._fixupList(repl, list[i]);
2886 } else if(typeof list[i] === 'object') {
2887 var obj = list[i];
2888 if(obj.funcall) {
2889 var parts = obj.funcall;
2890 this._fixupList(repl, parts);
2891 var [thisobj, func] = this._parseFunc(parts[0]);
2892 list[i] = func.apply(thisobj, parts.slice(1));
2893 } else if(obj.objid) {
2894 list[i] = this._lookupObject(repl, obj.objid);
2895 } else {
2896 throw new Error('Unknown object type: ' + obj.toSource());
2897 }
2898 }
2899 }
2900 },
2902 _parseFunc: function(func) {
2903 var thisobj = null;
2905 if(typeof func === 'string') {
2906 func = window[func];
2907 } else if(func instanceof Array) {
2908 if(func.length === 1 && typeof func[0] !== 'string') {
2909 func = func[0];
2910 } else {
2911 [thisobj, func] = this._parsePropDescriptor(func);
2912 func = thisobj[func];
2913 }
2914 }
2916 return [thisobj,func];
2917 },
2919 _encodeReturn: function(value, array_as_mv) {
2920 var ret;
2922 if(value === null) {
2923 ret = ['special', 'null'];
2924 } else if(value === true) {
2925 ret = ['special', 'true'];
2926 } else if(value === false) {
2927 ret = ['special', 'false'];
2928 } else if(value === undefined) {
2929 ret = ['special', 'undefined'];
2930 } else if(typeof value === 'number') {
2931 if(isNaN(value)) {
2932 ret = ['special', 'NaN'];
2933 } else if(value === Infinity) {
2934 ret = ['special', 'Infinity'];
2935 } else if(value === -Infinity) {
2936 ret = ['special', '-Infinity'];
2937 } else {
2938 ret = ['atom', value];
2939 }
2940 } else if(typeof value === 'string') {
2941 ret = ['atom', value];
2942 } else if(array_as_mv && value instanceof Array) {
2943 ret = ['array', value.map(this._encodeReturn, this)];
2944 } else {
2945 ret = ['objid', this._findOrAllocateObject(repl, value)];
2946 }
2948 return ret;
2949 },
2951 _handleInputLine: function _handleInputLine(repl, line) {
2952 var ret;
2953 var array_as_mv = false;
2955 try {
2956 if(line[0] === '*') {
2957 array_as_mv = true;
2958 line = line.substring(1);
2959 }
2960 var parts = eval(line);
2961 this._fixupList(repl, parts);
2962 var [thisobj, func] = this._parseFunc(parts[0]);
2963 ret = this._encodeReturn(
2964 func.apply(thisobj, parts.slice(1)),
2965 array_as_mv);
2966 } catch(x) {
2967 ret = ['error', x.toString() ];
2968 }
2970 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2971 repl.print(JSON.encode(ret));
2972 repl._prompt();
2973 },
2975 handleInput: function handleInput(repl, chunk) {
2976 this._input += chunk;
2977 var match, line;
2979 line = match[0];
2982 repl.popInteractor();
2983 repl._prompt();
2984 return;
2985 }
2987 this._input = this._input.substring(line.length);
2988 this._handleInputLine(repl, line);
2989 }
2990 }
2991 });
2992 })
2998 "Marshall the given value for JS.
2999 Strings and numbers are JSON-encoded. Lists (including nil) are
3000 made into JavaScript array literals and their contents encoded
3001 with `js--js-encode-value'."
3028 js--js-repl-prompt-regexp js-js-timeout
3030 ;; start matching against the beginning of the line in
3031 ;; order to catch a prompt that's only partially arrived
3034 ;; Presumably "inferior-moz-process" loads comint.
3044 ;; Do some initialization the first time we see a process
3050 ;; Send interactor definition
3056 js-js-timeout))
3058 ;; Sanity check
3064 ;; If js--js-repl-depth > 0, we *should* be seeing an
3065 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
3066 ;; up with us.
3069 ;; Otherwise, tell Mozilla to enter the interactor mode
3075 js-js-timeout))
3089 js-js-timeout))))
3099 "Convert immediate js< and js! references to deferred ones."
3123 function))
3125 else
3126 collect item)))
3141 "Run FORMS with the Mozilla repl set up for js commands.
3142 Inside the lexical scope of `with-js', `js?', `js!',
3143 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
3144 `js-create-instance', and `js-qi' are defined."
3155 function)
3163 function)
3195 props)
3197 ))
3203 "Whether to listify any Array returned by a Mozilla function.
3210 (`array
3212 (`objid
3214 js--js-references)
3219 js--js-references)))
3227 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
3228 If function is a string, look it up as a property on the global
3229 object and use the global object for `this'.
3230 If FUNCTION is a list with one element, use that element as the
3231 function with the global object for `this', except that if that
3232 single element is a string, look it up on the global object.
3233 If FUNCTION is a list with more than one argument, use the list
3234 up to the last value as a property descriptor and the last
3235 argument as a function."
3242 ;; Actual funcall
3249 js-js-timeout)
3252 ;; Read the result
3259 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
3260 CONSTRUCTOR is a JS handle, a string, or a list of these things."
3263 constructor arguments))
3269 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
3272 arguments)))
3281 "Tell the repl about any objects we don't reference anymore.
3282 With argument, run even if no intervening GC has happened."
3293 ;; Don't bother running unless we've had an intervening
3294 ;; garbage collection; without a gc, nothing is deleted
3295 ;; from the weak hash table, so it's pointless telling
3296 ;; MozRepl about that references we still hold
3299 ;; Are we looking at a normal prompt? Make sure not to
3300 ;; interrupt the user if he's doing something
3308 of js--js-references
3309 collect x))
3316 num)))
3321 "Evaluate the JavaScript in JS and return JSON-decoded result."
3329 result)))
3332 "Enumerate all JavaScript contexts available.
3333 Each context is a list:
3334 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3335 (TITLE URL WINDOW) for windows
3337 All tabs of a given window are grouped together. The most recent
3338 window is first. Within each window, the tabs are returned
3339 left-to-right."
3344 "@mozilla.org/appshell/window-mediator;1"
3366 window)
3373 "browsers"
3374 x
3375 "contentDocument"
3379 "browsers"
3380 x
3381 "contentWindow"
3382 "location"
3385 "browsers"
3386 x)
3389 "tabContainer"
3390 "childNodes"
3392 x)
3394 gbrowser))))))
3401 "Read a Mozilla tab with prompt PROMPT.
3402 Return a cons of (TYPE . OBJECT). TYPE is either `window' or
3403 `tab', and OBJECT is a JavaScript handle to a ChromeWindow or a
3404 browser, respectively."
3406 ;; Prime IDO
3413 selected-tab prev-hitab)
3415 ;; Disambiguate names
3418 for tab in tabs
3436 ;; Hack to reduce the number of
3437 ;; round-trips to mozilla
3440 ;; Highlighting tab
3443 "style"
3445 cmds)
3447 ;; Highlight window proper
3450 "style"
3452 cmds)
3454 ;; Select tab, when appropriate
3458 cmds)))
3460 ;; Highlighting whole window
3464 "style"
3467 cmds)))
3470 ;; Unhighlighting tab
3473 cmds)
3475 cmds))
3477 ;; Unhighlighting window
3482 cmds)))
3488 ()
3494 ()
3495 ;; Fiddle with the match list a bit: if our first match
3496 ;; is a tabbrowser window, rotate the match list until
3497 ;; the active tab comes up
3503 "document"
3504 "documentElement"
3509 "gBrowser"
3512 for match in ido-matches
3517 and return t)))
3523 ;; FIXME: Don't impose IDO on the user.
3528 prompt
3530 nil t nil
3547 "Helper function for `js-eval-defun'.
3548 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3549 strings making up the class name and NAME is the name of the
3550 function part."
3569 "The current JavaScript context.
3570 This is a cons like the one returned from `js--read-tab'.
3574 "(function(func_info,func) {
3575 func_info.unshift('window');
3576 var obj = window;
3577 for(var i = 1; i < func_info.length - 1; ++i) {
3578 var next = obj[func_info[i]];
3579 if(typeof next !== 'object' && typeof next !== 'function') {
3580 next = obj.prototype && obj.prototype[func_info[i]];
3581 if(typeof next !== 'object' && typeof next !== 'function') {
3582 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3583 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3584 return;
3585 }
3587 func_info.splice(i+1, 0, 'prototype');
3588 ++i;
3589 }
3590 }
3592 obj[func_info[i]] = func;
3593 alert('Successfully updated '+func_info.join('.'));
3597 "Set the JavaScript context to CONTEXT.
3598 When called interactively, prompt for CONTEXT."
3603 "Return a valid JavaScript context.
3604 If one hasn't been set, or if it's stale, prompt for a new one."
3614 js--js-context))
3629 file)))
3642 "Update a Mozilla tab using the JavaScript defun at point."
3645 ;; This function works by generating a temporary file that contains
3646 ;; the function we'd like to insert. We then use the elisp-js bridge
3647 ;; to command mozilla to load this file by inserting a script tag
3648 ;; into the document we set. This way, debuggers and such will have
3649 ;; a way to find the source of the just-inserted function.
3650 ;;
3651 ;; We delete the temporary file if there's an error, but otherwise
3652 ;; we add an unload event listener on the Mozilla side to delete the
3653 ;; file.
3684 ;; (Re)register a Mozilla resource URL to point to the
3685 ;; temporary directory
3703 ;; Give Mozilla responsibility for deleting this file
3708 ;; Regular content
3712 ;; Chrome
3734 ))
3736 ;; temp-name is set to nil on success
3740 ;;; Main Function
3742 ;;;###autoload
3744 "Major mode for editing JavaScript."
3758 ;; Comments
3763 ;; Parse cache
3766 ;; Frameworks
3769 ;; Imenu
3773 ;; for filling, pretend we're cc-mode
3776 c-paragraph-separate "$"
3777 c-block-comment-prefix "* "
3778 c-line-comment-starter "//"
3790 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3791 ;; we call it instead? (Bug#6071)
3799 ;; Important to fontify the whole buffer syntactically! If we don't,
3800 ;; then we might have regular expression literals that aren't marked
3801 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3802 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3803 ;; When we attempt to find the error and scroll to the portion of
3804 ;; the buffer containing the problem, JIT-lock will apply the
3805 ;; correct syntax to the regular expression literal and the problem
3806 ;; will mysteriously disappear.
3807 ;; FIXME: We should instead do this fontification lazily by adding
3808 ;; calls to syntax-propertize wherever it's really needed.
3809 ;;(syntax-propertize (point-max))
3810 )
3812 ;;;###autoload
3814 "Major mode for editing JSX.
3816 To customize the indentation for this mode, set the SGML offset
3817 variables (`sgml-basic-offset', `sgml-attribute-offset' et al.)
3818 locally, like so:
3820 (defun set-jsx-indentation ()
3821 (setq-local sgml-basic-offset js-indent-level))
3826 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3832 ;;;###autoload
3838 ;; js.el ends here