| blob | de6a33988a483dd7ab6486917897979690697271 |
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."
512 ;;; KeyMap
528 keymap)
531 ;;; Syntax table and parsing
537 table)
568 "Helper function for `js--update-quick-match-re'.
569 If LIST contains any element that is not nil, return its non-nil
570 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
571 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
572 nil. If any element in LIST is itself a list, flatten that
573 element."
579 "Internal function used by `js-mode' for caching buffer constructs.
580 This updates `js--quick-match-re', based on the current set of
581 enabled frameworks."
586 ;; #define mumble
595 ;; var mumble = THING (
616 ;; mumble.prototypeTHING
624 ;; mumble.prototype = {
631 "Move over the next value of PROPNAME in the buffer.
632 If found, return that value and leave point after the character
633 having that value; otherwise, return nil and leave point at EOB."
644 next-value))
647 "Move over the previous value of PROPNAME in the buffer.
648 If found, return that value and leave point just before the
649 character that has that value, otherwise return nil and leave
650 point at BOB."
663 prev-value)))
676 "Helper function for `js--re-search-forward'."
678 str-terminator
707 "Search forward, ignoring strings, cpp macros, and comments.
708 This function invokes `re-search-forward', but treats the buffer
709 as if strings, cpp macros, and comments have been removed.
711 If invoked while inside a macro, it treats the contents of the
712 macro as normal text."
729 "Auxiliary function for `js--re-search-backward'."
731 str-terminator
762 "Search backward, ignoring strings, preprocessor macros, and comments.
764 This function invokes `re-search-backward' but treats the buffer
765 as if strings, preprocessor macros, and comments have been
766 removed.
768 If invoked while inside a macro, treat the macro as normal text."
772 "Move forward over a whole JavaScript expression.
773 This function doesn't move over expressions continued across
774 lines."
776 ;; non-continued case; simplistic, but good enough?
789 "Move forward over a JavaScript function declaration.
790 This puts point at the 'function' keyword.
792 If this is a syntactically-correct non-expression function,
793 return the name of the function, or t if the name could not be
794 determined. Otherwise, return nil."
807 name)))))
810 "Return the start of the JavaScript function prologue containing POS.
811 A function prologue is everything from start of the definition up
812 to and including the opening brace. POS defaults to point.
813 If POS is not in a function prologue, return nil."
840 "Helper function for `js-beginning-of-defun'.
841 Go to previous defun-beginning and return the parse state for it,
842 or nil if we went all the way back to bob and don't find
843 anything."
851 "Helper function for `js--beginning-of-defun-nested'.
852 If PSTATE represents a non-empty top-level defun, return the
853 top-most pitem. Otherwise, return nil."
856 with func-pitem
863 "Helper function for `js--beginning-of-defun'.
864 Return the pitem of the function we went to the beginning of."
866 ;; Look for the smallest function that encloses point...
871 and return pitem)
873 ;; ...and if that isn't found, look for the previous top-level
874 ;; defun
876 while pstate
879 and return it)))
882 "Helper function for `js-beginning-of-defun'."
888 "Value of `beginning-of-defun-function' for `js-mode'."
904 ;; If we're just past the end of a function, the user probably wants
905 ;; to go to the beginning of *that* function
919 "Flush the `js-mode' syntax cache after position BEG.
920 BEG defaults to `point-min', meaning to flush the entire cache."
926 ;; `(message ,@arguments)
927 )
936 ;; open-items must contain at least two items for this to
937 ;; work, but because we push a dummy item to start with,
938 ;; that assumption holds.
941 open-items)
944 "Helper function for `js--ensure-cache'.
945 Update parsing information up to point, referring to parse,
946 prev-parse-point, goal-point, and open-items bound lexically in
947 the body of `js--ensure-cache'."
954 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
955 ;; the given depth -- i.e., make sure we're deeper than the target
956 ;; depth.
960 prev-parse-point goal-point
962 nil parse))
964 ;; (let ((overlay (make-overlay prev-parse-point (point))))
965 ;; (overlay-put overlay 'face '(:background "red"))
966 ;; (unwind-protect
967 ;; (progn
968 ;; (js--debug "parsed: %S" parse)
969 ;; (sit-for 1))
970 ;; (delete-overlay overlay)))
986 "Split a JavaScript name into its dot-separated parts.
987 This also removes any prototype parts from the split name
999 "Guess the name of the JavaScript function at POSITION.
1001 Return the name of the function, or nil if the name could not be
1002 guessed.
1004 This function clobbers match data. If we find the preamble
1005 begins earlier than expected while guessing the function name,
1006 set `js--guess-function-name-start' to that position; otherwise,
1007 set that variable to nil."
1024 ;; Clear any endings that occur after point
1031 ;; Remove any cache properties after this point
1036 "Ensures brace cache is valid up to the character before LIMIT.
1037 LIMIT defaults to point."
1043 parse
1044 prev-parse-point
1045 name
1046 case-fold-search
1047 filtered-class-styles
1048 goal-point)
1050 ;; Figure out which class styles we need to look for
1054 js-enabled-frameworks)
1055 collect style))
1061 ;; Find last known good position
1077 ;; Make a placeholder for the top-level definition
1093 ;; Each of these conditions should return non-nil if
1094 ;; we should add a new item and leave point at the end
1095 ;; of the new item's header (h-end in the
1096 ;; js--pitem diagram). This point is the one
1097 ;; after the last character we need to unambiguously
1098 ;; detect this construct. If one of these evaluates to
1099 ;; nil, the location of the point is ignored.
1101 ;; In comment or string
1104 ;; Regular function declaration
1113 js--guess-function-name-start))
1120 :paren-depth orig-depth
1121 :h-begin orig-match-start
1124 name
1127 ;; Macro
1130 ;; Macros often contain unbalanced parentheses.
1131 ;; Make sure that h-end is at the textual end of
1132 ;; the macro no matter what the parenthesis say.
1138 :h-begin orig-match-start
1142 ;; "Prototype function" declaration
1149 :paren-depth orig-depth
1150 :h-begin orig-match-start
1156 ;; Class definition
1158 with syntactic-context =
1160 for class-style in filtered-class-styles
1166 and return
1168 :paren-depth orig-depth
1169 :h-begin orig-match-start
1170 :type class-style
1185 )))))
1188 "Helper function for `js-end-of-defun'."
1193 return t
1197 "Helper function for `js-end-of-defun'."
1206 found)
1209 ;; We're already inside a function; just go to its end.
1212 ;; Otherwise, go to the end of the next function...
1219 ;; ... or eob.
1223 "Value of `end-of-defun-function' for `js-mode'."
1234 ;; look for function backward. if we're inside it, go to that
1235 ;; function's end. otherwise, search for the next function's end and
1236 ;; go there
1240 ;; if we're doing nested functions, see whether we're in the
1241 ;; prologue. If we are, go to the end of the function; otherwise,
1242 ;; call js--end-of-defun-nested to do the real work
1263 t
1265 nil))))
1268 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1279 pos
1283 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1293 pos
1296 ;; Like (up-list -1), but only considers lists that end nearby"
1299 ;; Look at a very small region so our computation time doesn't
1300 ;; explode in pathological cases.
1305 "Return non-nil if point is in a function parameter list."
1316 "Return non-nil if point is in a Dojo multiple-inheritance class block."
1338 ;;; Font Lock
1340 "Helper function for building `js--font-lock-keywords'.
1341 Create a byte-compiled function for matching a concatenation of
1342 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1353 "Move forward over a JavaScript destructuring spec.
1354 If FUNC is supplied, call it with no arguments before every
1355 variable name in the spec. Return true if this was actually a
1356 spec. FUNC must preserve the match data."
1368 t)
1373 t))))
1376 t))
1390 t))
1395 t)))))
1398 t))))
1401 "Font-lock matcher for variable names in a variable declaration.
1402 This is a cc-mode-style matcher that *always* fails, from the
1403 point of view of font-lock. It applies highlighting directly with
1404 `font-lock-apply-highlight'."
1416 t))
1438 ;; Conditions to handle
1442 ;; Matcher always "fails"
1443 nil)
1446 `(
1447 ;; This goes before keywords-2 so it gets used preferentially
1448 ;; instead of the keywords in keywords-2. Don't use override
1449 ;; because that will override syntactic fontification too, which
1450 ;; will fontify commented-out directives as if they weren't
1451 ;; commented out.
1454 ,@js--font-lock-keywords-2
1459 ;; Highlights class being declared, in parts
1463 nil
1466 ;; Highlights parent class, in parts, if available
1483 ;; Highlights parent class
1487 ;; Dojo needs its own matcher to override the string highlighting
1489 'dojo
1496 ;; Match Dojo base classes. Of course Mojo has to be different
1497 ;; from everything else under the sun...
1499 'dojo
1508 ;; continued Dojo base-class list
1510 'dojo
1521 ;; variable declarations
1526 ;; class instantiation
1531 ;; instanceof
1536 ;; formal parameters
1540 js--name-start-re)
1546 ;; continued formal parameter list
1560 "Return whether point is inside the given pitem's header or body."
1570 "Parse the JavaScript program state at point.
1571 Return a list of `js--pitem' instances that apply to point, most
1572 specific first. In the worst case, the current toplevel instance
1573 will be returned."
1582 ;; Loop until we either hit a pitem at BOB or pitem ends after
1583 ;; point (or at point if we're at eob)
1590 pstate))))
1593 "Return the JavaScript syntactic context corresponding to PSTATE."
1596 type)
1602 "Return the JavaScript syntactic context at point.
1603 When called interactively, also display a message with that
1604 context."
1612 syntactic-context))
1615 "Font lock function used by `js-mode'.
1616 This performs fontification according to `js--class-styles'."
1624 js-enabled-frameworks)
1627 decl-re
1630 and return t)
1631 return t
1636 js--font-lock-keywords-2
1637 js--font-lock-keywords-3)
1645 st))
1650 ;; A /.../ regexp.
1655 js--syntax-propertize-regexp-syntax-table
1658 ;; A / within a character class is not the end of a regexp.
1659 t
1662 nil))))))
1665 ;; Javascript allows immediate regular expression objects, written /.../.
1670 ;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
1671 ;; FIXME: Allow regexps after infix ops like + ...
1672 ;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
1673 ;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
1674 ;; point I think only * and / would be missing which could also be added,
1675 ;; but need care to avoid affecting the // and */ comment markers.
1680 ;; If the / is at the beginning of line, we have to check
1681 ;; the end of the previous text.
1692 ;;; Indentation
1710 "Return non-nil if point is on a JavaScript operator, other than a comma."
1720 "Return non-nil if the current line continues an expression."
1737 Otherwise, return nil. A braceless do-while statement spanning
1738 several lines requires that the start of the loop is indented to
1739 the same column as the current line."
1761 "Helper function for `js--proper-indentation'.
1762 Return the proper indentation of the current line if it starts
1763 the body of a control statement without braces; otherwise, return
1764 nil."
1792 "Helper function for `js--proper-indentation'.
1793 Return the proper indentation of the current line if it belongs to a declaration
1794 statement spanning multiple lines; otherwise, return nil."
1822 "Return non-nil if we think we're in an array comprehension.
1823 In particular, return the buffer position of the first `for' kwd."
1837 ;; To skip arbitrary expressions we need the parser,
1838 ;; so we'll just guess at it.
1841 ;; Not inside comment or string literal.
1847 ;; First continuation line.
1858 "Return the proper indentation for the current line."
1866 ;; Indent array comprehension continuation lines specially.
1868 beg)
1872 ;; At or after the first loop?
1878 ;; A single closing paren/bracket should be indented at the
1879 ;; same level as the opening statement. Same goes for
1880 ;; "case" and "default".
1894 in-switch-p)))
1900 js-expr-indent-offset))
1909 indent)))
1910 ;; If there is something following the opening
1911 ;; paren/bracket, everything else should be indented at
1912 ;; the same level.
1923 "Indent the current line as JavaScript."
1931 ;;; Filling
1935 ;; FIXME: Such redefinitions are bad style. We should try and use some other
1936 ;; way to get the same result.
1940 ad-do-it))
1945 ad-do-it))
1950 ad-do-it))
1953 "Fill the paragraph with `c-fill-paragraph'."
1959 ;;; Type database and Imenu
1961 ;; We maintain a cache of semantic information, i.e., the classes and
1962 ;; functions we've encountered so far. In order to avoid having to
1963 ;; re-parse the buffer on every change, we cache the parse state at
1964 ;; each interesting point in the buffer. Each parse state is a
1965 ;; modified copy of the previous one, or in the case of the first
1966 ;; parse state, the empty state.
1967 ;;
1968 ;; The parse state itself is just a stack of js--pitem
1969 ;; instances. It starts off containing one element that is never
1970 ;; closed, that is initially js--initial-pitem.
1971 ;;
1979 name
1981 type
1985 "Helper function for `js--splice-into-items'.
1986 Return a new item that is the result of merging CHILD into
1987 ITEM. NAME-PARTS is a list of parts of the name of CHILD
1988 that we haven't consumed yet."
1993 ;; If the item we're merging into isn't a class, make it into one
1999 ;; Use the child's class-style if it's available
2001 js--dummy-class-style
2006 ;; Now we can merge either a function or a class into a class
2010 ;; if we have more name-parts to go before we get to the
2011 ;; bottom of the class hierarchy, call the merger
2012 ;; recursively
2018 ;; Not merging a class, but something else, so just prepend
2019 ;; it
2023 ;; Otherwise, merge the new child's items into those
2024 ;; of the new class
2030 "Last part of the name of PITEM, as a string or symbol."
2034 name)))
2037 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2038 If a class doesn't exist in the tree, create it. Return
2039 the new items list. NAME-PARTS is a list of strings given
2040 the broken-down class name of the item to insert."
2044 new-items last-new-item new-cons)
2047 name-parts
2053 ;; If top-name isn't found in items, then we build a copy of items
2054 ;; and throw it away. But that's okay, since most of the time, we
2055 ;; *will* find an instance.
2059 ;; Okay, we found an entry with the right name. Splice
2060 ;; the merged item into the list...
2063 name-parts)
2070 ;; ...and terminate the loop
2071 nil)
2074 ;; Otherwise, copy the current cons and move onto the
2075 ;; text. This is tricky; we keep track of the tail of
2076 ;; the list that begins with new-items in
2077 ;; last-new-item.
2084 ;; Go to the next cell in items
2088 ;; Yay! We stopped because we found something, not because
2089 ;; we ran out of items to search. Just return the new
2090 ;; list.
2093 new-items)
2095 ;; We didn't find anything. If the child is a class and we don't
2096 ;; have any classes to drill down into, just push that class;
2097 ;; otherwise, make a fake class and carry on.
2100 ;; We have name-parts left to process. Make a fake
2101 ;; class for this particular part...
2103 ;; ...and recursively digest the rest of the name
2106 :type js--dummy-class-style
2109 ;; Otherwise, this is the only name we have, so stick
2110 ;; the item on the front of the list
2111 child)
2112 items))))
2115 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2120 t))
2122 ;; This trick works because we know (based on our defstructs) that
2123 ;; the child list is always the first element, and so the second
2124 ;; element and beyond can be shared when we make our "copy".
2131 ;; Use slow path because we need class lookup
2137 ;; Use slow path because we need class merging. We know
2138 ;; name is a list here because down in
2139 ;; `js--ensure-cache', we made sure to only add
2140 ;; class entries with lists for :name
2145 ;; Fast path
2151 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2154 location))
2157 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2174 imenu-items))
2179 unknown-ctr))
2182 imenu-items))
2191 imenu-items))))
2195 imenu-items))
2198 "Return an imenu index for the current buffer."
2210 ;; Make sure everything is closed
2218 ;; Convert the new-finalized state into what imenu expects
2221 unknown-ctr))))))
2223 ;; Silence the compiler.
2234 symbols)
2235 else
2246 "Return a hash table of all JavaScript symbols.
2247 This searches all existing `js-mode' buffers. Each key is the
2248 name of a symbol (possibly disambiguated with <N>, where N > 1),
2249 and each value is a marker giving the location of that symbol."
2251 with imenu-use-markers = t
2252 for buffer being the buffers
2257 finally return symbols))
2263 "Helper function for `js-find-symbol'.
2264 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2265 one from `js--get-all-known-symbols', using prompt PROMPT and
2266 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2267 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2268 marker."
2274 prompt
2276 collect key)
2292 ;; etags loads ring.
2296 "Read a JavaScript symbol and jump to it.
2297 With a prefix argument, restrict symbols to those from the
2298 current buffer. Pushes a mark onto the tag ring just like
2299 `find-tag'."
2310 symbols "Jump to: "
2318 ;;; MozRepl integration
2325 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2326 On timeout, return nil. On success, return t with match data
2327 set. If START is non-nil, look for output starting from START.
2328 Otherwise, use the current value of `process-mark'."
2340 'js-moz-bad-rpc
2344 ;; Integer, mirrors the value we see in JS
2347 ;; Process to which this thing belongs
2368 ; */" Make Emacs happy
2369 "(function(repl) {
2370 repl.defineInteractor('js', {
2371 onStart: function onStart(repl) {
2372 if(!repl._jsObjects) {
2373 repl._jsObjects = {};
2374 repl._jsLastID = 0;
2375 repl._jsGC = this._jsGC;
2376 }
2377 this._input = '';
2378 },
2380 _jsGC: function _jsGC(ids_in_use) {
2381 var objects = this._jsObjects;
2382 var keys = [];
2383 var num_freed = 0;
2385 for(var pn in objects) {
2386 keys.push(Number(pn));
2387 }
2389 keys.sort(function(x, y) x - y);
2390 ids_in_use.sort(function(x, y) x - y);
2391 var i = 0;
2392 var j = 0;
2394 while(i < ids_in_use.length && j < keys.length) {
2395 var id = ids_in_use[i++];
2396 while(j < keys.length && keys[j] !== id) {
2397 var k_id = keys[j++];
2398 delete objects[k_id];
2399 ++num_freed;
2400 }
2401 ++j;
2402 }
2404 while(j < keys.length) {
2405 var k_id = keys[j++];
2406 delete objects[k_id];
2407 ++num_freed;
2408 }
2410 return num_freed;
2411 },
2413 _mkArray: function _mkArray() {
2414 var result = [];
2415 for(var i = 0; i < arguments.length; ++i) {
2416 result.push(arguments[i]);
2417 }
2418 return result;
2419 },
2421 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2422 if(typeof parts === 'string') {
2423 parts = [ parts ];
2424 }
2426 var obj = parts[0];
2427 var start = 1;
2429 if(typeof obj === 'string') {
2430 obj = window;
2431 start = 0;
2432 } else if(parts.length < 2) {
2433 throw new Error('expected at least 2 arguments');
2434 }
2436 for(var i = start; i < parts.length - 1; ++i) {
2437 obj = obj[parts[i]];
2438 }
2440 return [obj, parts[parts.length - 1]];
2441 },
2443 _getProp: function _getProp(/*...*/) {
2444 if(arguments.length === 0) {
2445 throw new Error('no arguments supplied to getprop');
2446 }
2448 if(arguments.length === 1 &&
2449 (typeof arguments[0]) !== 'string')
2450 {
2451 return arguments[0];
2452 }
2454 var [obj, propname] = this._parsePropDescriptor(arguments);
2455 return obj[propname];
2456 },
2458 _putProp: function _putProp(properties, value) {
2459 var [obj, propname] = this._parsePropDescriptor(properties);
2460 obj[propname] = value;
2461 },
2463 _delProp: function _delProp(propname) {
2464 var [obj, propname] = this._parsePropDescriptor(arguments);
2465 delete obj[propname];
2466 },
2468 _typeOf: function _typeOf(thing) {
2469 return typeof thing;
2470 },
2472 _callNew: function(constructor) {
2473 if(typeof constructor === 'string')
2474 {
2475 constructor = window[constructor];
2476 } else if(constructor.length === 1 &&
2477 typeof constructor[0] !== 'string')
2478 {
2479 constructor = constructor[0];
2480 } else {
2481 var [obj,propname] = this._parsePropDescriptor(constructor);
2482 constructor = obj[propname];
2483 }
2485 /* Hacky, but should be robust */
2486 var s = 'new constructor(';
2487 for(var i = 1; i < arguments.length; ++i) {
2488 if(i != 1) {
2489 s += ',';
2490 }
2492 s += 'arguments[' + i + ']';
2493 }
2495 s += ')';
2496 return eval(s);
2497 },
2499 _callEval: function(thisobj, js) {
2500 return eval.call(thisobj, js);
2501 },
2503 getPrompt: function getPrompt(repl) {
2504 return 'EVAL>'
2505 },
2507 _lookupObject: function _lookupObject(repl, id) {
2508 if(typeof id === 'string') {
2509 switch(id) {
2510 case 'global':
2511 return window;
2512 case 'nil':
2513 return null;
2514 case 't':
2515 return true;
2516 case 'false':
2517 return false;
2518 case 'undefined':
2519 return undefined;
2520 case 'repl':
2521 return repl;
2522 case 'interactor':
2523 return this;
2524 case 'NaN':
2525 return NaN;
2526 case 'Infinity':
2527 return Infinity;
2528 case '-Infinity':
2529 return -Infinity;
2530 default:
2531 throw new Error('No object with special id:' + id);
2532 }
2533 }
2535 var ret = repl._jsObjects[id];
2536 if(ret === undefined) {
2537 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2538 }
2539 return ret;
2540 },
2542 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2543 if(typeof value !== 'object' && typeof value !== 'function') {
2544 throw new Error('_findOrAllocateObject called on non-object('
2545 + typeof(value) + '): '
2546 + value)
2547 }
2549 for(var id in repl._jsObjects) {
2550 id = Number(id);
2551 var obj = repl._jsObjects[id];
2552 if(obj === value) {
2553 return id;
2554 }
2555 }
2557 var id = ++repl._jsLastID;
2558 repl._jsObjects[id] = value;
2559 return id;
2560 },
2562 _fixupList: function _fixupList(repl, list) {
2563 for(var i = 0; i < list.length; ++i) {
2564 if(list[i] instanceof Array) {
2565 this._fixupList(repl, list[i]);
2566 } else if(typeof list[i] === 'object') {
2567 var obj = list[i];
2568 if(obj.funcall) {
2569 var parts = obj.funcall;
2570 this._fixupList(repl, parts);
2571 var [thisobj, func] = this._parseFunc(parts[0]);
2572 list[i] = func.apply(thisobj, parts.slice(1));
2573 } else if(obj.objid) {
2574 list[i] = this._lookupObject(repl, obj.objid);
2575 } else {
2576 throw new Error('Unknown object type: ' + obj.toSource());
2577 }
2578 }
2579 }
2580 },
2582 _parseFunc: function(func) {
2583 var thisobj = null;
2585 if(typeof func === 'string') {
2586 func = window[func];
2587 } else if(func instanceof Array) {
2588 if(func.length === 1 && typeof func[0] !== 'string') {
2589 func = func[0];
2590 } else {
2591 [thisobj, func] = this._parsePropDescriptor(func);
2592 func = thisobj[func];
2593 }
2594 }
2596 return [thisobj,func];
2597 },
2599 _encodeReturn: function(value, array_as_mv) {
2600 var ret;
2602 if(value === null) {
2603 ret = ['special', 'null'];
2604 } else if(value === true) {
2605 ret = ['special', 'true'];
2606 } else if(value === false) {
2607 ret = ['special', 'false'];
2608 } else if(value === undefined) {
2609 ret = ['special', 'undefined'];
2610 } else if(typeof value === 'number') {
2611 if(isNaN(value)) {
2612 ret = ['special', 'NaN'];
2613 } else if(value === Infinity) {
2614 ret = ['special', 'Infinity'];
2615 } else if(value === -Infinity) {
2616 ret = ['special', '-Infinity'];
2617 } else {
2618 ret = ['atom', value];
2619 }
2620 } else if(typeof value === 'string') {
2621 ret = ['atom', value];
2622 } else if(array_as_mv && value instanceof Array) {
2623 ret = ['array', value.map(this._encodeReturn, this)];
2624 } else {
2625 ret = ['objid', this._findOrAllocateObject(repl, value)];
2626 }
2628 return ret;
2629 },
2631 _handleInputLine: function _handleInputLine(repl, line) {
2632 var ret;
2633 var array_as_mv = false;
2635 try {
2636 if(line[0] === '*') {
2637 array_as_mv = true;
2638 line = line.substring(1);
2639 }
2640 var parts = eval(line);
2641 this._fixupList(repl, parts);
2642 var [thisobj, func] = this._parseFunc(parts[0]);
2643 ret = this._encodeReturn(
2644 func.apply(thisobj, parts.slice(1)),
2645 array_as_mv);
2646 } catch(x) {
2647 ret = ['error', x.toString() ];
2648 }
2650 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2651 repl.print(JSON.encode(ret));
2652 repl._prompt();
2653 },
2655 handleInput: function handleInput(repl, chunk) {
2656 this._input += chunk;
2657 var match, line;
2659 line = match[0];
2662 repl.popInteractor();
2663 repl._prompt();
2664 return;
2665 }
2667 this._input = this._input.substring(line.length);
2668 this._handleInputLine(repl, line);
2669 }
2670 }
2671 });
2672 })
2678 "Marshall the given value for JS.
2679 Strings and numbers are JSON-encoded. Lists (including nil) are
2680 made into JavaScript array literals and their contents encoded
2681 with `js--js-encode-value'."
2708 js--js-repl-prompt-regexp js-js-timeout
2710 ;; start matching against the beginning of the line in
2711 ;; order to catch a prompt that's only partially arrived
2714 ;; Presumably "inferior-moz-process" loads comint.
2724 ;; Do some initialization the first time we see a process
2730 ;; Send interactor definition
2736 js-js-timeout))
2738 ;; Sanity check
2744 ;; If js--js-repl-depth > 0, we *should* be seeing an
2745 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2746 ;; up with us.
2749 ;; Otherwise, tell Mozilla to enter the interactor mode
2755 js-js-timeout))
2769 js-js-timeout))))
2777 ;; The somewhat complex code layout confuses the byte-compiler into
2778 ;; thinking this function "might not be defined at runtime".
2783 "Convert immediate js< and js! references to deferred ones."
2807 function))
2809 else
2810 collect item)))
2825 "Run FORMS with the Mozilla repl set up for js commands.
2826 Inside the lexical scope of `with-js', `js?', `js!',
2827 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2828 `js-create-instance', and `js-qi' are defined."
2839 function)
2847 function)
2879 props)
2881 ))
2887 "Whether to listify any Array returned by a Mozilla function.
2894 (`array
2896 (`objid
2898 js--js-references)
2903 js--js-references)))
2911 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2912 If function is a string, look it up as a property on the global
2913 object and use the global object for `this'.
2914 If FUNCTION is a list with one element, use that element as the
2915 function with the global object for `this', except that if that
2916 single element is a string, look it up on the global object.
2917 If FUNCTION is a list with more than one argument, use the list
2918 up to the last value as a property descriptor and the last
2919 argument as a function."
2926 ;; Actual funcall
2933 js-js-timeout)
2936 ;; Read the result
2943 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
2944 CONSTRUCTOR is a JS handle, a string, or a list of these things."
2947 constructor arguments))
2953 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
2956 arguments)))
2965 "Tell the repl about any objects we don't reference anymore.
2966 With argument, run even if no intervening GC has happened."
2977 ;; Don't bother running unless we've had an intervening
2978 ;; garbage collection; without a gc, nothing is deleted
2979 ;; from the weak hash table, so it's pointless telling
2980 ;; MozRepl about that references we still hold
2983 ;; Are we looking at a normal prompt? Make sure not to
2984 ;; interrupt the user if he's doing something
2992 of js--js-references
2993 collect x))
3000 num)))
3005 "Evaluate the JavaScript in JS and return JSON-decoded result."
3013 result)))
3016 "Enumerate all JavaScript contexts available.
3017 Each context is a list:
3018 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3019 (TITLE URL WINDOW) for windows
3021 All tabs of a given window are grouped together. The most recent
3022 window is first. Within each window, the tabs are returned
3023 left-to-right."
3028 "@mozilla.org/appshell/window-mediator;1"
3050 window)
3057 "browsers"
3058 x
3059 "contentDocument"
3063 "browsers"
3064 x
3065 "contentWindow"
3066 "location"
3069 "browsers"
3070 x)
3073 "tabContainer"
3074 "childNodes"
3076 x)
3078 gbrowser))))))
3085 "Read a Mozilla tab with prompt PROMPT.
3086 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
3087 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
3088 browser, respectively."
3090 ;; Prime IDO
3097 selected-tab prev-hitab)
3099 ;; Disambiguate names
3102 for tab in tabs
3120 ;; Hack to reduce the number of
3121 ;; round-trips to mozilla
3124 ;; Highlighting tab
3127 "style"
3129 cmds)
3131 ;; Highlight window proper
3134 "style"
3136 cmds)
3138 ;; Select tab, when appropriate
3142 cmds)))
3144 ;; Highlighting whole window
3148 "style"
3151 cmds)))
3154 ;; Unhighlighting tab
3157 cmds)
3159 cmds))
3161 ;; Unhighlighting window
3166 cmds)))
3172 ()
3178 ()
3179 ;; Fiddle with the match list a bit: if our first match
3180 ;; is a tabbrowser window, rotate the match list until
3181 ;; the active tab comes up
3187 "document"
3188 "documentElement"
3193 "gBrowser"
3196 for match in ido-matches
3201 and return t)))
3211 prompt
3213 nil t nil
3230 "Helper function for `js-eval-defun'.
3231 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3232 strings making up the class name and NAME is the name of the
3233 function part."
3252 "The current JavaScript context.
3253 This is a cons like the one returned from `js--read-tab'.
3257 "(function(func_info,func) {
3258 func_info.unshift('window');
3259 var obj = window;
3260 for(var i = 1; i < func_info.length - 1; ++i) {
3261 var next = obj[func_info[i]];
3262 if(typeof next !== 'object' && typeof next !== 'function') {
3263 next = obj.prototype && obj.prototype[func_info[i]];
3264 if(typeof next !== 'object' && typeof next !== 'function') {
3265 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3266 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3267 return;
3268 }
3270 func_info.splice(i+1, 0, 'prototype');
3271 ++i;
3272 }
3273 }
3275 obj[func_info[i]] = func;
3276 alert('Successfully updated '+func_info.join('.'));
3280 "Set the JavaScript context to CONTEXT.
3281 When called interactively, prompt for CONTEXT."
3286 "Return a valid JavaScript context.
3287 If one hasn't been set, or if it's stale, prompt for a new one."
3297 js--js-context))
3312 file)))
3325 "Update a Mozilla tab using the JavaScript defun at point."
3328 ;; This function works by generating a temporary file that contains
3329 ;; the function we'd like to insert. We then use the elisp-js bridge
3330 ;; to command mozilla to load this file by inserting a script tag
3331 ;; into the document we set. This way, debuggers and such will have
3332 ;; a way to find the source of the just-inserted function.
3333 ;;
3334 ;; We delete the temporary file if there's an error, but otherwise
3335 ;; we add an unload event listener on the Mozilla side to delete the
3336 ;; file.
3367 ;; (Re)register a Mozilla resource URL to point to the
3368 ;; temporary directory
3386 ;; Give Mozilla responsibility for deleting this file
3391 ;; Regular content
3395 ;; Chrome
3417 ))
3419 ;; temp-name is set to nil on success
3423 ;;; Main Function
3425 ;;;###autoload
3427 "Major mode for editing JavaScript."
3440 ;; Comments
3445 ;; Parse cache
3448 ;; Frameworks
3451 ;; Imenu
3455 ;; for filling, pretend we're cc-mode
3457 c-paragraph-start "$"
3458 c-paragraph-separate "$"
3459 c-block-comment-prefix "* "
3460 c-line-comment-starter "//"
3470 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3471 ;; we call it instead? (Bug#6071)
3481 ;; Important to fontify the whole buffer syntactically! If we don't,
3482 ;; then we might have regular expression literals that aren't marked
3483 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3484 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3485 ;; When we attempt to find the error and scroll to the portion of
3486 ;; the buffer containing the problem, JIT-lock will apply the
3487 ;; correct syntax to the regular expression literal and the problem
3488 ;; will mysteriously disappear.
3489 ;; FIXME: We should actually do this fontification lazily by adding
3490 ;; calls to syntax-propertize wherever it's really needed.
3493 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3499 ;;;###autoload
3505 ;; js.el ends here