| blob | 6a800f8abe5d1beea804e35d57dd681be63bc3a4 |
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
3 ;; Copyright (C) 2008-2015 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:
67 ;;; Constants
89 "Regexp matching the prefix of a cpp directive.
90 This includes the directive name, or nil in languages without
91 preprocessor support. The first submatch surrounds the directive
98 Group 1 is a (possibly-dotted) class name, group 2 is a method name,
107 ;; var NewClass = BaseClass.extend(
115 ;; var NewClass = Class.create()
131 ;; var NewClass = Class.create({
138 ;; Parent class name(s) (yes, multiple inheritance in JavaScript) are
139 ;; matched with dedicated font-lock matchers
167 :prototype t
173 :prototype t
189 :prototype t
195 :prototype t
206 :prototype t
220 "List of JavaScript class definition styles.
222 A class definition style is a plist with the following keys:
224 :name is a human-readable name of the class type
226 :class-decl is a regular expression giving the start of the
227 class. Its first group must match the name of its class. If there
228 is a parent class, the second group should match, and it should be
229 the name of the class.
231 If :prototype is present and non-nil, the parser will merge
232 declarations for this constructs with others at the same lexical
233 level that have the same name. Otherwise, multiple definitions
234 will create multiple top-level entries. Don't use :prototype
235 unnecessarily: it has an associated cost in performance.
237 If :strip-prototype is present and non-nil, then if the class
238 name as matched contains
245 collect framework into available-frameworks
246 finally return available-frameworks)
252 "Regexp matching the start of a JavaScript function header.
258 "Regexp matching the start of a function entry in an associative array.
270 "Regexp matching a CPP macro definition, up to the opening parenthesis.
320 ;; js--pitem is the basic building block of the lexical
321 ;; database. When one refers to a real part of the buffer, the region
322 ;; of text to which it refers is split into a conceptual header and
323 ;; body. Consider the (very short) block described by a hypothetical
324 ;; js--pitem:
325 ;;
326 ;; function foo(a,b,c) { return 42; }
327 ;; ^ ^ ^
328 ;; | | |
329 ;; +- h-begin +- h-end +- b-end
330 ;;
331 ;; (Remember that these are buffer positions, and therefore point
332 ;; between characters, not at them. An arrow drawn to a character
333 ;; indicates the corresponding position is between that character and
334 ;; the one immediately preceding it.)
335 ;;
336 ;; The header is the region of text [h-begin, h-end], and is
337 ;; the text needed to unambiguously recognize the start of the
338 ;; construct. If the entire header is not present, the construct is
339 ;; not recognized at all. No other pitems may be nested inside the
340 ;; header.
341 ;;
342 ;; The body is the region [h-end, b-end]. It may contain nested
343 ;; js--pitem instances. The body of a pitem may be empty: in
344 ;; that case, b-end is equal to header-end.
345 ;;
346 ;; The three points obey the following relationship:
347 ;;
348 ;; h-begin < h-end <= b-end
349 ;;
350 ;; We put a text property in the buffer on the character *before*
351 ;; h-end, and if we see it, on the character *before* b-end.
352 ;;
353 ;; The text property for h-end, js--pstate, is actually a list
354 ;; of all js--pitem instances open after the marked character.
355 ;;
356 ;; The text property for b-end, js--pend, is simply the
357 ;; js--pitem that ends after the marked character. (Because
358 ;; pitems always end when the paren-depth drops below a critical
359 ;; value, and because we can only drop one level per character, only
360 ;; one pitem may end at a given character.)
361 ;;
362 ;; In the structure below, we only store h-begin and (sometimes)
363 ;; b-end. We can trivially and quickly find h-end by going to h-begin
364 ;; and searching for an js--pstate text property. Since no other
365 ;; js--pitem instances can be nested inside the header of a
366 ;; pitem, the location after the character with this text property
367 ;; must be h-end.
368 ;;
369 ;; js--pitem instances are never modified (with the exception
370 ;; of the b-end field). Instead, modified copies are added at
371 ;; subsequence parse points.
372 ;; (The exception for b-end and its caveats is described below.)
373 ;;
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.
380 ;; List of children inside this pitem's body
383 ;; When we reach this paren depth after h-end, the pitem ends
386 ;; Symbol or class-style plist if this is a class
389 ;; See above
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
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 ;;
412 ;; The pitem we start parsing with.
415 :paren-depth most-negative-fixnum
418 ;;; User Customization
421 "Customization variables for JavaScript mode."
426 "Number of spaces for each indentation step in `js-mode'."
432 "Number of additional spaces for indenting continued expressions.
433 The value must be no less than minus `js-indent-level'."
439 "Number of additional spaces for indenting expressions in parentheses.
440 The value must be no less than minus `js-indent-level'."
447 "Number of additional spaces for indenting expressions in square braces.
448 The value must be no less than minus `js-indent-level'."
455 "Number of additional spaces for indenting expressions in curly braces.
456 The value must be no less than minus `js-indent-level'."
463 "Number of additional spaces for indenting the contents of a switch block.
464 The value must not be negative."
471 "Treat nested functions as top-level functions in `js-mode'.
472 This applies to function movement, marking, and so on."
477 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
482 "Frameworks recognized by `js-mode'.
483 To improve performance, you may turn off some frameworks you
484 seldom use, either globally or on a per-buffer basis."
487 js--available-frameworks))
492 "Whether `js-mode' should display tabs while selecting them.
493 This is useful only if the windowing system has a good mechanism
494 for preventing Firefox from stealing the keyboard focus."
499 "~/.emacs.d/js/js"
500 "Temporary directory used by `js-mode' to communicate with Mozilla.
501 This directory must be readable and writable by both Mozilla and Emacs."
506 "Reply timeout for executing commands in Mozilla via `js-mode'.
507 The value is given in seconds. Increase this value if you are
508 getting timeout messages."
513 "Non-nil means specially indent the first variable declaration's initializer.
514 Normally, the first declaration's initializer is unindented, and
515 subsequent declarations have their identifiers aligned with it:
517 var o = {
518 foo: 3
519 };
521 var o = {
522 foo: 3
523 },
524 bar = 2;
526 If this option has the value t, indent the first declaration's
527 initializer by an additional level:
529 var o = {
530 foo: 3
531 };
533 var o = {
534 foo: 3
535 },
536 bar = 2;
538 If this option has the value `dynamic', if there is only one declaration,
539 don't indent the first one's initializer; otherwise, indent it.
541 var o = {
542 foo: 3
543 };
545 var o = {
546 foo: 3
547 },
548 bar = 2;"
554 ;;; KeyMap
570 keymap)
573 ;;; Syntax table and parsing
580 table)
611 "Helper function for `js--update-quick-match-re'.
612 If LIST contains any element that is not nil, return its non-nil
613 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
614 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
615 nil. If any element in LIST is itself a list, flatten that
616 element."
622 "Internal function used by `js-mode' for caching buffer constructs.
623 This updates `js--quick-match-re', based on the current set of
624 enabled frameworks."
629 ;; #define mumble
638 ;; var mumble = THING (
659 ;; mumble.prototypeTHING
667 ;; mumble.prototype = {
674 "Move over the next value of PROPNAME in the buffer.
675 If found, return that value and leave point after the character
676 having that value; otherwise, return nil and leave point at EOB."
687 next-value))
690 "Move over the previous value of PROPNAME in the buffer.
691 If found, return that value and leave point just before the
692 character that has that value, otherwise return nil and leave
693 point at BOB."
706 prev-value)))
719 "Helper function for `js--re-search-forward'."
721 str-terminator
750 "Search forward, ignoring strings, cpp macros, and comments.
751 This function invokes `re-search-forward', but treats the buffer
752 as if strings, cpp macros, and comments have been removed.
754 If invoked while inside a macro, it treats the contents of the
755 macro as normal text."
772 "Auxiliary function for `js--re-search-backward'."
774 str-terminator
805 "Search backward, ignoring strings, preprocessor macros, and comments.
807 This function invokes `re-search-backward' but treats the buffer
808 as if strings, preprocessor macros, and comments have been
809 removed.
811 If invoked while inside a macro, treat the macro as normal text."
815 "Move forward over a whole JavaScript expression.
816 This function doesn't move over expressions continued across
817 lines."
819 ;; non-continued case; simplistic, but good enough?
832 "Move forward over a JavaScript function declaration.
833 This puts point at the 'function' keyword.
835 If this is a syntactically-correct non-expression function,
836 return the name of the function, or t if the name could not be
837 determined. Otherwise, return nil."
853 name)))))
856 "Return the start of the JavaScript function prologue containing POS.
857 A function prologue is everything from start of the definition up
858 to and including the opening brace. POS defaults to point.
859 If POS is not in a function prologue, return nil."
886 "Helper function for `js-beginning-of-defun'.
887 Go to previous defun-beginning and return the parse state for it,
888 or nil if we went all the way back to bob and don't find
889 anything."
897 "Helper function for `js--beginning-of-defun-nested'.
898 If PSTATE represents a non-empty top-level defun, return the
899 top-most pitem. Otherwise, return nil."
902 with func-pitem
909 "Helper function for `js--beginning-of-defun'.
910 Return the pitem of the function we went to the beginning of."
912 ;; Look for the smallest function that encloses point...
917 and return pitem)
919 ;; ...and if that isn't found, look for the previous top-level
920 ;; defun
922 while pstate
925 and return it)))
928 "Helper function for `js-beginning-of-defun'."
934 "Value of `beginning-of-defun-function' for `js-mode'."
950 ;; If we're just past the end of a function, the user probably wants
951 ;; to go to the beginning of *that* function
965 "Flush the `js-mode' syntax cache after position BEG.
966 BEG defaults to `point-min', meaning to flush the entire cache."
972 ;; `(message ,@arguments)
973 )
982 ;; open-items must contain at least two items for this to
983 ;; work, but because we push a dummy item to start with,
984 ;; that assumption holds.
987 open-items)
990 "Helper function for `js--ensure-cache'.
991 Update parsing information up to point, referring to parse,
992 prev-parse-point, goal-point, and open-items bound lexically in
993 the body of `js--ensure-cache'."
1000 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
1001 ;; the given depth -- i.e., make sure we're deeper than the target
1002 ;; depth.
1006 prev-parse-point goal-point
1008 nil parse))
1010 ;; (let ((overlay (make-overlay prev-parse-point (point))))
1011 ;; (overlay-put overlay 'face '(:background "red"))
1012 ;; (unwind-protect
1013 ;; (progn
1014 ;; (js--debug "parsed: %S" parse)
1015 ;; (sit-for 1))
1016 ;; (delete-overlay overlay)))
1032 "Split a JavaScript name into its dot-separated parts.
1033 This also removes any prototype parts from the split name
1045 "Guess the name of the JavaScript function at POSITION.
1047 Return the name of the function, or nil if the name could not be
1048 guessed.
1050 This function clobbers match data. If we find the preamble
1051 begins earlier than expected while guessing the function name,
1052 set `js--guess-function-name-start' to that position; otherwise,
1053 set that variable to nil."
1070 ;; Clear any endings that occur after point
1077 ;; Remove any cache properties after this point
1082 "Ensures brace cache is valid up to the character before LIMIT.
1083 LIMIT defaults to point."
1089 parse
1090 prev-parse-point
1091 name
1092 case-fold-search
1093 filtered-class-styles
1094 goal-point)
1096 ;; Figure out which class styles we need to look for
1100 js-enabled-frameworks)
1101 collect style))
1107 ;; Find last known good position
1123 ;; Make a placeholder for the top-level definition
1139 ;; Each of these conditions should return non-nil if
1140 ;; we should add a new item and leave point at the end
1141 ;; of the new item's header (h-end in the
1142 ;; js--pitem diagram). This point is the one
1143 ;; after the last character we need to unambiguously
1144 ;; detect this construct. If one of these evaluates to
1145 ;; nil, the location of the point is ignored.
1147 ;; In comment or string
1150 ;; Regular function declaration
1159 js--guess-function-name-start))
1166 :paren-depth orig-depth
1167 :h-begin orig-match-start
1170 name
1173 ;; Macro
1176 ;; Macros often contain unbalanced parentheses.
1177 ;; Make sure that h-end is at the textual end of
1178 ;; the macro no matter what the parenthesis say.
1184 :h-begin orig-match-start
1188 ;; "Prototype function" declaration
1195 :paren-depth orig-depth
1196 :h-begin orig-match-start
1202 ;; Class definition
1204 with syntactic-context =
1206 for class-style in filtered-class-styles
1212 and return
1214 :paren-depth orig-depth
1215 :h-begin orig-match-start
1216 :type class-style
1231 )))))
1234 "Helper function for `js-end-of-defun'."
1239 return t
1243 "Helper function for `js-end-of-defun'."
1252 found)
1255 ;; We're already inside a function; just go to its end.
1258 ;; Otherwise, go to the end of the next function...
1265 ;; ... or eob.
1269 "Value of `end-of-defun-function' for `js-mode'."
1280 ;; look for function backward. if we're inside it, go to that
1281 ;; function's end. otherwise, search for the next function's end and
1282 ;; go there
1286 ;; if we're doing nested functions, see whether we're in the
1287 ;; prologue. If we are, go to the end of the function; otherwise,
1288 ;; call js--end-of-defun-nested to do the real work
1309 t
1311 nil))))
1314 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1325 pos
1329 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1339 pos
1342 ;; Like (up-list -1), but only considers lists that end nearby"
1345 ;; Look at a very small region so our computation time doesn't
1346 ;; explode in pathological cases.
1351 "Return non-nil if point is in a function parameter list."
1362 "Return non-nil if point is in a Dojo multiple-inheritance class block."
1373 ;;; Font Lock
1375 "Helper function for building `js--font-lock-keywords'.
1376 Create a byte-compiled function for matching a concatenation of
1377 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1388 "Move forward over a JavaScript destructuring spec.
1389 If FUNC is supplied, call it with no arguments before every
1390 variable name in the spec. Return true if this was actually a
1391 spec. FUNC must preserve the match data."
1403 t)
1408 t))))
1411 t))
1425 t))
1430 t)))))
1433 t))))
1436 "Font-lock matcher for variable names in a variable declaration.
1437 This is a cc-mode-style matcher that *always* fails, from the
1438 point of view of font-lock. It applies highlighting directly with
1439 `font-lock-apply-highlight'."
1451 t))
1473 ;; Conditions to handle
1477 ;; Matcher always "fails"
1478 nil)
1481 `(
1482 ;; This goes before keywords-2 so it gets used preferentially
1483 ;; instead of the keywords in keywords-2. Don't use override
1484 ;; because that will override syntactic fontification too, which
1485 ;; will fontify commented-out directives as if they weren't
1486 ;; commented out.
1489 ,@js--font-lock-keywords-2
1494 ;; Highlights class being declared, in parts
1498 nil
1501 ;; Highlights parent class, in parts, if available
1518 ;; Highlights parent class
1522 ;; Dojo needs its own matcher to override the string highlighting
1524 'dojo
1531 ;; Match Dojo base classes. Of course Mojo has to be different
1532 ;; from everything else under the sun...
1534 'dojo
1543 ;; continued Dojo base-class list
1545 'dojo
1556 ;; variable declarations
1561 ;; class instantiation
1566 ;; instanceof
1571 ;; formal parameters
1575 js--name-start-re)
1581 ;; continued formal parameter list
1595 "Return whether point is inside the given pitem's header or body."
1605 "Parse the JavaScript program state at point.
1606 Return a list of `js--pitem' instances that apply to point, most
1607 specific first. In the worst case, the current toplevel instance
1608 will be returned."
1617 ;; Loop until we either hit a pitem at BOB or pitem ends after
1618 ;; point (or at point if we're at eob)
1625 pstate))))
1628 "Return the JavaScript syntactic context corresponding to PSTATE."
1631 type)
1637 "Return the JavaScript syntactic context at point.
1638 When called interactively, also display a message with that
1639 context."
1647 syntactic-context))
1650 "Font lock function used by `js-mode'.
1651 This performs fontification according to `js--class-styles'."
1659 js-enabled-frameworks)
1662 decl-re
1665 and return t)
1666 return t
1671 js--font-lock-keywords-2
1672 js--font-lock-keywords-3)
1680 st))
1685 ;; A /.../ regexp.
1690 js--syntax-propertize-regexp-syntax-table
1693 ;; A / within a character class is not the end of a regexp.
1694 t
1697 nil))))))
1700 ;; Javascript allows immediate regular expression objects, written /.../.
1705 ;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
1706 ;; FIXME: Allow regexps after infix ops like + ...
1707 ;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
1708 ;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
1709 ;; point I think only * and / would be missing which could also be added,
1710 ;; but need care to avoid affecting the // and */ comment markers.
1715 ;; If the / is at the beginning of line, we have to check
1716 ;; the end of the previous text.
1727 ;;; Indentation
1745 "Return non-nil if point is on a JavaScript operator, other than a comma."
1755 "Return non-nil if the current line continues an expression."
1772 Otherwise, return nil. A braceless do-while statement spanning
1773 several lines requires that the start of the loop is indented to
1774 the same column as the current line."
1796 "Helper function for `js--proper-indentation'.
1797 Return the proper indentation of the current line if it starts
1798 the body of a control statement without braces; otherwise, return
1799 nil."
1827 "Helper function for `js--proper-indentation'.
1828 Return the proper indentation of the current line if it belongs to a declaration
1829 statement spanning multiple lines; otherwise, return nil."
1857 "Return non-nil if we think we're in an array comprehension.
1858 In particular, return the buffer position of the first `for' kwd."
1872 ;; To skip arbitrary expressions we need the parser,
1873 ;; so we'll just guess at it.
1876 ;; Not inside comment or string literal.
1882 ;; First continuation line.
1893 "Helper function for `js--proper-indentation'.
1894 Depending on the value of `js-indent-first-init', move
1895 point to the end of a variable declaration keyword so that
1896 indentation is aligned to that column."
1903 declaration-keyword-end
1904 at-closing-bracket-p
1905 comma-p)
1914 t)
1923 "Return the proper indentation for the current line."
1931 ;; Indent array comprehension continuation lines specially.
1933 beg)
1937 ;; At or after the first loop?
1943 ;; A single closing paren/bracket should be indented at the
1944 ;; same level as the opening statement. Same goes for
1945 ;; "case" and "default".
1960 in-switch-p)))
1966 js-expr-indent-offset))
1975 indent)))
1976 ;; If there is something following the opening
1977 ;; paren/bracket, everything else should be indented at
1978 ;; the same level.
1989 "Indent the current line as JavaScript."
1998 ;;; Filling
2002 ;; FIXME: Such redefinitions are bad style. We should try and use some other
2003 ;; way to get the same result.
2007 ad-do-it))
2012 ad-do-it))
2017 ad-do-it))
2020 "Fill the paragraph with `c-fill-paragraph'."
2026 ;;; Type database and Imenu
2028 ;; We maintain a cache of semantic information, i.e., the classes and
2029 ;; functions we've encountered so far. In order to avoid having to
2030 ;; re-parse the buffer on every change, we cache the parse state at
2031 ;; each interesting point in the buffer. Each parse state is a
2032 ;; modified copy of the previous one, or in the case of the first
2033 ;; parse state, the empty state.
2034 ;;
2035 ;; The parse state itself is just a stack of js--pitem
2036 ;; instances. It starts off containing one element that is never
2037 ;; closed, that is initially js--initial-pitem.
2038 ;;
2046 name
2048 type
2052 "Helper function for `js--splice-into-items'.
2053 Return a new item that is the result of merging CHILD into
2054 ITEM. NAME-PARTS is a list of parts of the name of CHILD
2055 that we haven't consumed yet."
2060 ;; If the item we're merging into isn't a class, make it into one
2066 ;; Use the child's class-style if it's available
2068 js--dummy-class-style
2073 ;; Now we can merge either a function or a class into a class
2077 ;; if we have more name-parts to go before we get to the
2078 ;; bottom of the class hierarchy, call the merger
2079 ;; recursively
2085 ;; Not merging a class, but something else, so just prepend
2086 ;; it
2090 ;; Otherwise, merge the new child's items into those
2091 ;; of the new class
2097 "Last part of the name of PITEM, as a string or symbol."
2101 name)))
2104 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2105 If a class doesn't exist in the tree, create it. Return
2106 the new items list. NAME-PARTS is a list of strings given
2107 the broken-down class name of the item to insert."
2111 new-items last-new-item new-cons)
2114 name-parts
2120 ;; If top-name isn't found in items, then we build a copy of items
2121 ;; and throw it away. But that's okay, since most of the time, we
2122 ;; *will* find an instance.
2126 ;; Okay, we found an entry with the right name. Splice
2127 ;; the merged item into the list...
2130 name-parts)
2137 ;; ...and terminate the loop
2138 nil)
2141 ;; Otherwise, copy the current cons and move onto the
2142 ;; text. This is tricky; we keep track of the tail of
2143 ;; the list that begins with new-items in
2144 ;; last-new-item.
2151 ;; Go to the next cell in items
2155 ;; Yay! We stopped because we found something, not because
2156 ;; we ran out of items to search. Just return the new
2157 ;; list.
2160 new-items)
2162 ;; We didn't find anything. If the child is a class and we don't
2163 ;; have any classes to drill down into, just push that class;
2164 ;; otherwise, make a fake class and carry on.
2167 ;; We have name-parts left to process. Make a fake
2168 ;; class for this particular part...
2170 ;; ...and recursively digest the rest of the name
2173 :type js--dummy-class-style
2176 ;; Otherwise, this is the only name we have, so stick
2177 ;; the item on the front of the list
2178 child)
2179 items))))
2182 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2187 t))
2189 ;; This trick works because we know (based on our defstructs) that
2190 ;; the child list is always the first element, and so the second
2191 ;; element and beyond can be shared when we make our "copy".
2198 ;; Use slow path because we need class lookup
2204 ;; Use slow path because we need class merging. We know
2205 ;; name is a list here because down in
2206 ;; `js--ensure-cache', we made sure to only add
2207 ;; class entries with lists for :name
2212 ;; Fast path
2218 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2221 location))
2224 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2241 imenu-items))
2246 unknown-ctr))
2249 imenu-items))
2258 imenu-items))))
2262 imenu-items))
2265 "Return an imenu index for the current buffer."
2277 ;; Make sure everything is closed
2285 ;; Convert the new-finalized state into what imenu expects
2288 unknown-ctr))))))
2290 ;; Silence the compiler.
2301 symbols)
2302 else
2313 "Return a hash table of all JavaScript symbols.
2314 This searches all existing `js-mode' buffers. Each key is the
2315 name of a symbol (possibly disambiguated with <N>, where N > 1),
2316 and each value is a marker giving the location of that symbol."
2318 with imenu-use-markers = t
2319 for buffer being the buffers
2324 finally return symbols))
2330 "Helper function for `js-find-symbol'.
2331 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2332 one from `js--get-all-known-symbols', using prompt PROMPT and
2333 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2334 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2335 marker."
2341 prompt
2343 collect key)
2359 ;; etags loads ring.
2363 "Read a JavaScript symbol and jump to it.
2364 With a prefix argument, restrict symbols to those from the
2365 current buffer. Pushes a mark onto the tag ring just like
2366 `find-tag'."
2377 symbols "Jump to: "
2385 ;;; MozRepl integration
2392 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2393 On timeout, return nil. On success, return t with match data
2394 set. If START is non-nil, look for output starting from START.
2395 Otherwise, use the current value of `process-mark'."
2407 'js-moz-bad-rpc
2411 ;; Integer, mirrors the value we see in JS
2414 ;; Process to which this thing belongs
2435 ; */" Make Emacs happy
2436 "(function(repl) {
2437 repl.defineInteractor('js', {
2438 onStart: function onStart(repl) {
2439 if(!repl._jsObjects) {
2440 repl._jsObjects = {};
2441 repl._jsLastID = 0;
2442 repl._jsGC = this._jsGC;
2443 }
2444 this._input = '';
2445 },
2447 _jsGC: function _jsGC(ids_in_use) {
2448 var objects = this._jsObjects;
2449 var keys = [];
2450 var num_freed = 0;
2452 for(var pn in objects) {
2453 keys.push(Number(pn));
2454 }
2456 keys.sort(function(x, y) x - y);
2457 ids_in_use.sort(function(x, y) x - y);
2458 var i = 0;
2459 var j = 0;
2461 while(i < ids_in_use.length && j < keys.length) {
2462 var id = ids_in_use[i++];
2463 while(j < keys.length && keys[j] !== id) {
2464 var k_id = keys[j++];
2465 delete objects[k_id];
2466 ++num_freed;
2467 }
2468 ++j;
2469 }
2471 while(j < keys.length) {
2472 var k_id = keys[j++];
2473 delete objects[k_id];
2474 ++num_freed;
2475 }
2477 return num_freed;
2478 },
2480 _mkArray: function _mkArray() {
2481 var result = [];
2482 for(var i = 0; i < arguments.length; ++i) {
2483 result.push(arguments[i]);
2484 }
2485 return result;
2486 },
2488 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2489 if(typeof parts === 'string') {
2490 parts = [ parts ];
2491 }
2493 var obj = parts[0];
2494 var start = 1;
2496 if(typeof obj === 'string') {
2497 obj = window;
2498 start = 0;
2499 } else if(parts.length < 2) {
2500 throw new Error('expected at least 2 arguments');
2501 }
2503 for(var i = start; i < parts.length - 1; ++i) {
2504 obj = obj[parts[i]];
2505 }
2507 return [obj, parts[parts.length - 1]];
2508 },
2510 _getProp: function _getProp(/*...*/) {
2511 if(arguments.length === 0) {
2512 throw new Error('no arguments supplied to getprop');
2513 }
2515 if(arguments.length === 1 &&
2516 (typeof arguments[0]) !== 'string')
2517 {
2518 return arguments[0];
2519 }
2521 var [obj, propname] = this._parsePropDescriptor(arguments);
2522 return obj[propname];
2523 },
2525 _putProp: function _putProp(properties, value) {
2526 var [obj, propname] = this._parsePropDescriptor(properties);
2527 obj[propname] = value;
2528 },
2530 _delProp: function _delProp(propname) {
2531 var [obj, propname] = this._parsePropDescriptor(arguments);
2532 delete obj[propname];
2533 },
2535 _typeOf: function _typeOf(thing) {
2536 return typeof thing;
2537 },
2539 _callNew: function(constructor) {
2540 if(typeof constructor === 'string')
2541 {
2542 constructor = window[constructor];
2543 } else if(constructor.length === 1 &&
2544 typeof constructor[0] !== 'string')
2545 {
2546 constructor = constructor[0];
2547 } else {
2548 var [obj,propname] = this._parsePropDescriptor(constructor);
2549 constructor = obj[propname];
2550 }
2552 /* Hacky, but should be robust */
2553 var s = 'new constructor(';
2554 for(var i = 1; i < arguments.length; ++i) {
2555 if(i != 1) {
2556 s += ',';
2557 }
2559 s += 'arguments[' + i + ']';
2560 }
2562 s += ')';
2563 return eval(s);
2564 },
2566 _callEval: function(thisobj, js) {
2567 return eval.call(thisobj, js);
2568 },
2570 getPrompt: function getPrompt(repl) {
2571 return 'EVAL>'
2572 },
2574 _lookupObject: function _lookupObject(repl, id) {
2575 if(typeof id === 'string') {
2576 switch(id) {
2577 case 'global':
2578 return window;
2579 case 'nil':
2580 return null;
2581 case 't':
2582 return true;
2583 case 'false':
2584 return false;
2585 case 'undefined':
2586 return undefined;
2587 case 'repl':
2588 return repl;
2589 case 'interactor':
2590 return this;
2591 case 'NaN':
2592 return NaN;
2593 case 'Infinity':
2594 return Infinity;
2595 case '-Infinity':
2596 return -Infinity;
2597 default:
2598 throw new Error('No object with special id:' + id);
2599 }
2600 }
2602 var ret = repl._jsObjects[id];
2603 if(ret === undefined) {
2604 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2605 }
2606 return ret;
2607 },
2609 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2610 if(typeof value !== 'object' && typeof value !== 'function') {
2611 throw new Error('_findOrAllocateObject called on non-object('
2612 + typeof(value) + '): '
2613 + value)
2614 }
2616 for(var id in repl._jsObjects) {
2617 id = Number(id);
2618 var obj = repl._jsObjects[id];
2619 if(obj === value) {
2620 return id;
2621 }
2622 }
2624 var id = ++repl._jsLastID;
2625 repl._jsObjects[id] = value;
2626 return id;
2627 },
2629 _fixupList: function _fixupList(repl, list) {
2630 for(var i = 0; i < list.length; ++i) {
2631 if(list[i] instanceof Array) {
2632 this._fixupList(repl, list[i]);
2633 } else if(typeof list[i] === 'object') {
2634 var obj = list[i];
2635 if(obj.funcall) {
2636 var parts = obj.funcall;
2637 this._fixupList(repl, parts);
2638 var [thisobj, func] = this._parseFunc(parts[0]);
2639 list[i] = func.apply(thisobj, parts.slice(1));
2640 } else if(obj.objid) {
2641 list[i] = this._lookupObject(repl, obj.objid);
2642 } else {
2643 throw new Error('Unknown object type: ' + obj.toSource());
2644 }
2645 }
2646 }
2647 },
2649 _parseFunc: function(func) {
2650 var thisobj = null;
2652 if(typeof func === 'string') {
2653 func = window[func];
2654 } else if(func instanceof Array) {
2655 if(func.length === 1 && typeof func[0] !== 'string') {
2656 func = func[0];
2657 } else {
2658 [thisobj, func] = this._parsePropDescriptor(func);
2659 func = thisobj[func];
2660 }
2661 }
2663 return [thisobj,func];
2664 },
2666 _encodeReturn: function(value, array_as_mv) {
2667 var ret;
2669 if(value === null) {
2670 ret = ['special', 'null'];
2671 } else if(value === true) {
2672 ret = ['special', 'true'];
2673 } else if(value === false) {
2674 ret = ['special', 'false'];
2675 } else if(value === undefined) {
2676 ret = ['special', 'undefined'];
2677 } else if(typeof value === 'number') {
2678 if(isNaN(value)) {
2679 ret = ['special', 'NaN'];
2680 } else if(value === Infinity) {
2681 ret = ['special', 'Infinity'];
2682 } else if(value === -Infinity) {
2683 ret = ['special', '-Infinity'];
2684 } else {
2685 ret = ['atom', value];
2686 }
2687 } else if(typeof value === 'string') {
2688 ret = ['atom', value];
2689 } else if(array_as_mv && value instanceof Array) {
2690 ret = ['array', value.map(this._encodeReturn, this)];
2691 } else {
2692 ret = ['objid', this._findOrAllocateObject(repl, value)];
2693 }
2695 return ret;
2696 },
2698 _handleInputLine: function _handleInputLine(repl, line) {
2699 var ret;
2700 var array_as_mv = false;
2702 try {
2703 if(line[0] === '*') {
2704 array_as_mv = true;
2705 line = line.substring(1);
2706 }
2707 var parts = eval(line);
2708 this._fixupList(repl, parts);
2709 var [thisobj, func] = this._parseFunc(parts[0]);
2710 ret = this._encodeReturn(
2711 func.apply(thisobj, parts.slice(1)),
2712 array_as_mv);
2713 } catch(x) {
2714 ret = ['error', x.toString() ];
2715 }
2717 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2718 repl.print(JSON.encode(ret));
2719 repl._prompt();
2720 },
2722 handleInput: function handleInput(repl, chunk) {
2723 this._input += chunk;
2724 var match, line;
2726 line = match[0];
2729 repl.popInteractor();
2730 repl._prompt();
2731 return;
2732 }
2734 this._input = this._input.substring(line.length);
2735 this._handleInputLine(repl, line);
2736 }
2737 }
2738 });
2739 })
2745 "Marshall the given value for JS.
2746 Strings and numbers are JSON-encoded. Lists (including nil) are
2747 made into JavaScript array literals and their contents encoded
2748 with `js--js-encode-value'."
2775 js--js-repl-prompt-regexp js-js-timeout
2777 ;; start matching against the beginning of the line in
2778 ;; order to catch a prompt that's only partially arrived
2781 ;; Presumably "inferior-moz-process" loads comint.
2791 ;; Do some initialization the first time we see a process
2797 ;; Send interactor definition
2803 js-js-timeout))
2805 ;; Sanity check
2811 ;; If js--js-repl-depth > 0, we *should* be seeing an
2812 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2813 ;; up with us.
2816 ;; Otherwise, tell Mozilla to enter the interactor mode
2822 js-js-timeout))
2836 js-js-timeout))))
2846 "Convert immediate js< and js! references to deferred ones."
2870 function))
2872 else
2873 collect item)))
2888 "Run FORMS with the Mozilla repl set up for js commands.
2889 Inside the lexical scope of `with-js', `js?', `js!',
2890 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2891 `js-create-instance', and `js-qi' are defined."
2902 function)
2910 function)
2942 props)
2944 ))
2950 "Whether to listify any Array returned by a Mozilla function.
2957 (`array
2959 (`objid
2961 js--js-references)
2966 js--js-references)))
2974 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2975 If function is a string, look it up as a property on the global
2976 object and use the global object for `this'.
2977 If FUNCTION is a list with one element, use that element as the
2978 function with the global object for `this', except that if that
2979 single element is a string, look it up on the global object.
2980 If FUNCTION is a list with more than one argument, use the list
2981 up to the last value as a property descriptor and the last
2982 argument as a function."
2989 ;; Actual funcall
2996 js-js-timeout)
2999 ;; Read the result
3006 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
3007 CONSTRUCTOR is a JS handle, a string, or a list of these things."
3010 constructor arguments))
3016 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
3019 arguments)))
3028 "Tell the repl about any objects we don't reference anymore.
3029 With argument, run even if no intervening GC has happened."
3040 ;; Don't bother running unless we've had an intervening
3041 ;; garbage collection; without a gc, nothing is deleted
3042 ;; from the weak hash table, so it's pointless telling
3043 ;; MozRepl about that references we still hold
3046 ;; Are we looking at a normal prompt? Make sure not to
3047 ;; interrupt the user if he's doing something
3055 of js--js-references
3056 collect x))
3063 num)))
3068 "Evaluate the JavaScript in JS and return JSON-decoded result."
3076 result)))
3079 "Enumerate all JavaScript contexts available.
3080 Each context is a list:
3081 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3082 (TITLE URL WINDOW) for windows
3084 All tabs of a given window are grouped together. The most recent
3085 window is first. Within each window, the tabs are returned
3086 left-to-right."
3091 "@mozilla.org/appshell/window-mediator;1"
3113 window)
3120 "browsers"
3121 x
3122 "contentDocument"
3126 "browsers"
3127 x
3128 "contentWindow"
3129 "location"
3132 "browsers"
3133 x)
3136 "tabContainer"
3137 "childNodes"
3139 x)
3141 gbrowser))))))
3148 "Read a Mozilla tab with prompt PROMPT.
3149 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
3150 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
3151 browser, respectively."
3153 ;; Prime IDO
3160 selected-tab prev-hitab)
3162 ;; Disambiguate names
3165 for tab in tabs
3183 ;; Hack to reduce the number of
3184 ;; round-trips to mozilla
3187 ;; Highlighting tab
3190 "style"
3192 cmds)
3194 ;; Highlight window proper
3197 "style"
3199 cmds)
3201 ;; Select tab, when appropriate
3205 cmds)))
3207 ;; Highlighting whole window
3211 "style"
3214 cmds)))
3217 ;; Unhighlighting tab
3220 cmds)
3222 cmds))
3224 ;; Unhighlighting window
3229 cmds)))
3235 ()
3241 ()
3242 ;; Fiddle with the match list a bit: if our first match
3243 ;; is a tabbrowser window, rotate the match list until
3244 ;; the active tab comes up
3250 "document"
3251 "documentElement"
3256 "gBrowser"
3259 for match in ido-matches
3264 and return t)))
3274 prompt
3276 nil t nil
3293 "Helper function for `js-eval-defun'.
3294 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3295 strings making up the class name and NAME is the name of the
3296 function part."
3315 "The current JavaScript context.
3316 This is a cons like the one returned from `js--read-tab'.
3320 "(function(func_info,func) {
3321 func_info.unshift('window');
3322 var obj = window;
3323 for(var i = 1; i < func_info.length - 1; ++i) {
3324 var next = obj[func_info[i]];
3325 if(typeof next !== 'object' && typeof next !== 'function') {
3326 next = obj.prototype && obj.prototype[func_info[i]];
3327 if(typeof next !== 'object' && typeof next !== 'function') {
3328 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3329 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3330 return;
3331 }
3333 func_info.splice(i+1, 0, 'prototype');
3334 ++i;
3335 }
3336 }
3338 obj[func_info[i]] = func;
3339 alert('Successfully updated '+func_info.join('.'));
3343 "Set the JavaScript context to CONTEXT.
3344 When called interactively, prompt for CONTEXT."
3349 "Return a valid JavaScript context.
3350 If one hasn't been set, or if it's stale, prompt for a new one."
3360 js--js-context))
3375 file)))
3388 "Update a Mozilla tab using the JavaScript defun at point."
3391 ;; This function works by generating a temporary file that contains
3392 ;; the function we'd like to insert. We then use the elisp-js bridge
3393 ;; to command mozilla to load this file by inserting a script tag
3394 ;; into the document we set. This way, debuggers and such will have
3395 ;; a way to find the source of the just-inserted function.
3396 ;;
3397 ;; We delete the temporary file if there's an error, but otherwise
3398 ;; we add an unload event listener on the Mozilla side to delete the
3399 ;; file.
3430 ;; (Re)register a Mozilla resource URL to point to the
3431 ;; temporary directory
3449 ;; Give Mozilla responsibility for deleting this file
3454 ;; Regular content
3458 ;; Chrome
3480 ))
3482 ;; temp-name is set to nil on success
3486 ;;; Main Function
3488 ;;;###autoload
3490 "Major mode for editing JavaScript."
3503 ;; Comments
3508 ;; Parse cache
3511 ;; Frameworks
3514 ;; Imenu
3518 ;; for filling, pretend we're cc-mode
3521 c-paragraph-separate "$"
3522 c-block-comment-prefix "* "
3523 c-line-comment-starter "//"
3533 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3534 ;; we call it instead? (Bug#6071)
3542 ;; Important to fontify the whole buffer syntactically! If we don't,
3543 ;; then we might have regular expression literals that aren't marked
3544 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3545 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3546 ;; When we attempt to find the error and scroll to the portion of
3547 ;; the buffer containing the problem, JIT-lock will apply the
3548 ;; correct syntax to the regular expression literal and the problem
3549 ;; will mysteriously disappear.
3550 ;; FIXME: We should instead do this fontification lazily by adding
3551 ;; calls to syntax-propertize wherever it's really needed.
3552 ;;(syntax-propertize (point-max))
3553 )
3555 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3561 ;;;###autoload
3567 ;; js.el ends here