| blob | 9ef482e218b1d612336c2bbdcc5b05f05632461e |
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
3 ;; Copyright (C) 2008-2014 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 iff point is in a function parameter list."
1316 "Return non-nil iff 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 iff 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)
1642 ;; A /.../ regexp.
1648 ;; Javascript allows immediate regular expression objects, written /.../.
1653 ;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
1654 ;; FIXME: Allow regexps after infix ops like + ...
1655 ;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
1656 ;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
1657 ;; point I think only * and / would be missing which could also be added,
1658 ;; but need care to avoid affecting the // and */ comment markers.
1663 ;; If the / is at the beginning of line, we have to check
1664 ;; the end of the previous text.
1675 ;;; Indentation
1693 "Return non-nil if point is on a JavaScript operator, other than a comma."
1703 "Return non-nil if the current line continues an expression."
1720 Otherwise, return nil. A braceless do-while statement spanning
1721 several lines requires that the start of the loop is indented to
1722 the same column as the current line."
1744 "Helper function for `js--proper-indentation'.
1745 Return the proper indentation of the current line if it starts
1746 the body of a control statement without braces; otherwise, return
1747 nil."
1775 "Helper function for `js--proper-indentation'.
1776 Return the proper indentation of the current line if it belongs to a declaration
1777 statement spanning multiple lines; otherwise, return nil."
1805 "Return non-nil if we think we're in an array comprehension.
1806 In particular, return the buffer position of the first `for' kwd."
1820 ;; To skip arbitrary expressions we need the parser,
1821 ;; so we'll just guess at it.
1824 ;; Not inside comment or string literal.
1830 ;; First continuation line.
1841 "Return the proper indentation for the current line."
1849 ;; Indent array comprehension continuation lines specially.
1851 beg)
1855 ;; At or after the first loop?
1861 ;; A single closing paren/bracket should be indented at the
1862 ;; same level as the opening statement. Same goes for
1863 ;; "case" and "default".
1877 in-switch-p)))
1883 js-expr-indent-offset))
1892 indent)))
1893 ;; If there is something following the opening
1894 ;; paren/bracket, everything else should be indented at
1895 ;; the same level.
1906 "Indent the current line as JavaScript."
1916 ;;; Filling
1920 ;; FIXME: Such redefinitions are bad style. We should try and use some other
1921 ;; way to get the same result.
1925 ad-do-it))
1930 ad-do-it))
1935 ad-do-it))
1938 "Fill the paragraph with `c-fill-paragraph'."
1944 ;;; Type database and Imenu
1946 ;; We maintain a cache of semantic information, i.e., the classes and
1947 ;; functions we've encountered so far. In order to avoid having to
1948 ;; re-parse the buffer on every change, we cache the parse state at
1949 ;; each interesting point in the buffer. Each parse state is a
1950 ;; modified copy of the previous one, or in the case of the first
1951 ;; parse state, the empty state.
1952 ;;
1953 ;; The parse state itself is just a stack of js--pitem
1954 ;; instances. It starts off containing one element that is never
1955 ;; closed, that is initially js--initial-pitem.
1956 ;;
1964 name
1966 type
1970 "Helper function for `js--splice-into-items'.
1971 Return a new item that is the result of merging CHILD into
1972 ITEM. NAME-PARTS is a list of parts of the name of CHILD
1973 that we haven't consumed yet."
1978 ;; If the item we're merging into isn't a class, make it into one
1984 ;; Use the child's class-style if it's available
1986 js--dummy-class-style
1991 ;; Now we can merge either a function or a class into a class
1995 ;; if we have more name-parts to go before we get to the
1996 ;; bottom of the class hierarchy, call the merger
1997 ;; recursively
2003 ;; Not merging a class, but something else, so just prepend
2004 ;; it
2008 ;; Otherwise, merge the new child's items into those
2009 ;; of the new class
2015 "Last part of the name of PITEM, as a string or symbol."
2019 name)))
2022 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
2023 If a class doesn't exist in the tree, create it. Return
2024 the new items list. NAME-PARTS is a list of strings given
2025 the broken-down class name of the item to insert."
2029 new-items last-new-item new-cons)
2032 name-parts
2038 ;; If top-name isn't found in items, then we build a copy of items
2039 ;; and throw it away. But that's okay, since most of the time, we
2040 ;; *will* find an instance.
2044 ;; Okay, we found an entry with the right name. Splice
2045 ;; the merged item into the list...
2048 name-parts)
2055 ;; ...and terminate the loop
2056 nil)
2059 ;; Otherwise, copy the current cons and move onto the
2060 ;; text. This is tricky; we keep track of the tail of
2061 ;; the list that begins with new-items in
2062 ;; last-new-item.
2069 ;; Go to the next cell in items
2073 ;; Yay! We stopped because we found something, not because
2074 ;; we ran out of items to search. Just return the new
2075 ;; list.
2078 new-items)
2080 ;; We didn't find anything. If the child is a class and we don't
2081 ;; have any classes to drill down into, just push that class;
2082 ;; otherwise, make a fake class and carry on.
2085 ;; We have name-parts left to process. Make a fake
2086 ;; class for this particular part...
2088 ;; ...and recursively digest the rest of the name
2091 :type js--dummy-class-style
2094 ;; Otherwise, this is the only name we have, so stick
2095 ;; the item on the front of the list
2096 child)
2097 items))))
2100 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2105 t))
2107 ;; This trick works because we know (based on our defstructs) that
2108 ;; the child list is always the first element, and so the second
2109 ;; element and beyond can be shared when we make our "copy".
2116 ;; Use slow path because we need class lookup
2122 ;; Use slow path because we need class merging. We know
2123 ;; name is a list here because down in
2124 ;; `js--ensure-cache', we made sure to only add
2125 ;; class entries with lists for :name
2130 ;; Fast path
2136 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2139 location))
2142 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2159 imenu-items))
2164 unknown-ctr))
2167 imenu-items))
2176 imenu-items))))
2180 imenu-items))
2183 "Return an imenu index for the current buffer."
2195 ;; Make sure everything is closed
2203 ;; Convert the new-finalized state into what imenu expects
2206 unknown-ctr))))))
2208 ;; Silence the compiler.
2219 symbols)
2220 else
2231 "Return a hash table of all JavaScript symbols.
2232 This searches all existing `js-mode' buffers. Each key is the
2233 name of a symbol (possibly disambiguated with <N>, where N > 1),
2234 and each value is a marker giving the location of that symbol."
2236 with imenu-use-markers = t
2237 for buffer being the buffers
2242 finally return symbols))
2248 "Helper function for `js-find-symbol'.
2249 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2250 one from `js--get-all-known-symbols', using prompt PROMPT and
2251 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2252 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2253 marker."
2259 prompt
2261 collect key)
2277 ;; etags loads ring.
2281 "Read a JavaScript symbol and jump to it.
2282 With a prefix argument, restrict symbols to those from the
2283 current buffer. Pushes a mark onto the tag ring just like
2284 `find-tag'."
2295 symbols "Jump to: "
2303 ;;; MozRepl integration
2310 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2311 On timeout, return nil. On success, return t with match data
2312 set. If START is non-nil, look for output starting from START.
2313 Otherwise, use the current value of `process-mark'."
2325 'js-moz-bad-rpc
2329 ;; Integer, mirrors the value we see in JS
2332 ;; Process to which this thing belongs
2353 ; */" Make Emacs happy
2354 "(function(repl) {
2355 repl.defineInteractor('js', {
2356 onStart: function onStart(repl) {
2357 if(!repl._jsObjects) {
2358 repl._jsObjects = {};
2359 repl._jsLastID = 0;
2360 repl._jsGC = this._jsGC;
2361 }
2362 this._input = '';
2363 },
2365 _jsGC: function _jsGC(ids_in_use) {
2366 var objects = this._jsObjects;
2367 var keys = [];
2368 var num_freed = 0;
2370 for(var pn in objects) {
2371 keys.push(Number(pn));
2372 }
2374 keys.sort(function(x, y) x - y);
2375 ids_in_use.sort(function(x, y) x - y);
2376 var i = 0;
2377 var j = 0;
2379 while(i < ids_in_use.length && j < keys.length) {
2380 var id = ids_in_use[i++];
2381 while(j < keys.length && keys[j] !== id) {
2382 var k_id = keys[j++];
2383 delete objects[k_id];
2384 ++num_freed;
2385 }
2386 ++j;
2387 }
2389 while(j < keys.length) {
2390 var k_id = keys[j++];
2391 delete objects[k_id];
2392 ++num_freed;
2393 }
2395 return num_freed;
2396 },
2398 _mkArray: function _mkArray() {
2399 var result = [];
2400 for(var i = 0; i < arguments.length; ++i) {
2401 result.push(arguments[i]);
2402 }
2403 return result;
2404 },
2406 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2407 if(typeof parts === 'string') {
2408 parts = [ parts ];
2409 }
2411 var obj = parts[0];
2412 var start = 1;
2414 if(typeof obj === 'string') {
2415 obj = window;
2416 start = 0;
2417 } else if(parts.length < 2) {
2418 throw new Error('expected at least 2 arguments');
2419 }
2421 for(var i = start; i < parts.length - 1; ++i) {
2422 obj = obj[parts[i]];
2423 }
2425 return [obj, parts[parts.length - 1]];
2426 },
2428 _getProp: function _getProp(/*...*/) {
2429 if(arguments.length === 0) {
2430 throw new Error('no arguments supplied to getprop');
2431 }
2433 if(arguments.length === 1 &&
2434 (typeof arguments[0]) !== 'string')
2435 {
2436 return arguments[0];
2437 }
2439 var [obj, propname] = this._parsePropDescriptor(arguments);
2440 return obj[propname];
2441 },
2443 _putProp: function _putProp(properties, value) {
2444 var [obj, propname] = this._parsePropDescriptor(properties);
2445 obj[propname] = value;
2446 },
2448 _delProp: function _delProp(propname) {
2449 var [obj, propname] = this._parsePropDescriptor(arguments);
2450 delete obj[propname];
2451 },
2453 _typeOf: function _typeOf(thing) {
2454 return typeof thing;
2455 },
2457 _callNew: function(constructor) {
2458 if(typeof constructor === 'string')
2459 {
2460 constructor = window[constructor];
2461 } else if(constructor.length === 1 &&
2462 typeof constructor[0] !== 'string')
2463 {
2464 constructor = constructor[0];
2465 } else {
2466 var [obj,propname] = this._parsePropDescriptor(constructor);
2467 constructor = obj[propname];
2468 }
2470 /* Hacky, but should be robust */
2471 var s = 'new constructor(';
2472 for(var i = 1; i < arguments.length; ++i) {
2473 if(i != 1) {
2474 s += ',';
2475 }
2477 s += 'arguments[' + i + ']';
2478 }
2480 s += ')';
2481 return eval(s);
2482 },
2484 _callEval: function(thisobj, js) {
2485 return eval.call(thisobj, js);
2486 },
2488 getPrompt: function getPrompt(repl) {
2489 return 'EVAL>'
2490 },
2492 _lookupObject: function _lookupObject(repl, id) {
2493 if(typeof id === 'string') {
2494 switch(id) {
2495 case 'global':
2496 return window;
2497 case 'nil':
2498 return null;
2499 case 't':
2500 return true;
2501 case 'false':
2502 return false;
2503 case 'undefined':
2504 return undefined;
2505 case 'repl':
2506 return repl;
2507 case 'interactor':
2508 return this;
2509 case 'NaN':
2510 return NaN;
2511 case 'Infinity':
2512 return Infinity;
2513 case '-Infinity':
2514 return -Infinity;
2515 default:
2516 throw new Error('No object with special id:' + id);
2517 }
2518 }
2520 var ret = repl._jsObjects[id];
2521 if(ret === undefined) {
2522 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2523 }
2524 return ret;
2525 },
2527 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2528 if(typeof value !== 'object' && typeof value !== 'function') {
2529 throw new Error('_findOrAllocateObject called on non-object('
2530 + typeof(value) + '): '
2531 + value)
2532 }
2534 for(var id in repl._jsObjects) {
2535 id = Number(id);
2536 var obj = repl._jsObjects[id];
2537 if(obj === value) {
2538 return id;
2539 }
2540 }
2542 var id = ++repl._jsLastID;
2543 repl._jsObjects[id] = value;
2544 return id;
2545 },
2547 _fixupList: function _fixupList(repl, list) {
2548 for(var i = 0; i < list.length; ++i) {
2549 if(list[i] instanceof Array) {
2550 this._fixupList(repl, list[i]);
2551 } else if(typeof list[i] === 'object') {
2552 var obj = list[i];
2553 if(obj.funcall) {
2554 var parts = obj.funcall;
2555 this._fixupList(repl, parts);
2556 var [thisobj, func] = this._parseFunc(parts[0]);
2557 list[i] = func.apply(thisobj, parts.slice(1));
2558 } else if(obj.objid) {
2559 list[i] = this._lookupObject(repl, obj.objid);
2560 } else {
2561 throw new Error('Unknown object type: ' + obj.toSource());
2562 }
2563 }
2564 }
2565 },
2567 _parseFunc: function(func) {
2568 var thisobj = null;
2570 if(typeof func === 'string') {
2571 func = window[func];
2572 } else if(func instanceof Array) {
2573 if(func.length === 1 && typeof func[0] !== 'string') {
2574 func = func[0];
2575 } else {
2576 [thisobj, func] = this._parsePropDescriptor(func);
2577 func = thisobj[func];
2578 }
2579 }
2581 return [thisobj,func];
2582 },
2584 _encodeReturn: function(value, array_as_mv) {
2585 var ret;
2587 if(value === null) {
2588 ret = ['special', 'null'];
2589 } else if(value === true) {
2590 ret = ['special', 'true'];
2591 } else if(value === false) {
2592 ret = ['special', 'false'];
2593 } else if(value === undefined) {
2594 ret = ['special', 'undefined'];
2595 } else if(typeof value === 'number') {
2596 if(isNaN(value)) {
2597 ret = ['special', 'NaN'];
2598 } else if(value === Infinity) {
2599 ret = ['special', 'Infinity'];
2600 } else if(value === -Infinity) {
2601 ret = ['special', '-Infinity'];
2602 } else {
2603 ret = ['atom', value];
2604 }
2605 } else if(typeof value === 'string') {
2606 ret = ['atom', value];
2607 } else if(array_as_mv && value instanceof Array) {
2608 ret = ['array', value.map(this._encodeReturn, this)];
2609 } else {
2610 ret = ['objid', this._findOrAllocateObject(repl, value)];
2611 }
2613 return ret;
2614 },
2616 _handleInputLine: function _handleInputLine(repl, line) {
2617 var ret;
2618 var array_as_mv = false;
2620 try {
2621 if(line[0] === '*') {
2622 array_as_mv = true;
2623 line = line.substring(1);
2624 }
2625 var parts = eval(line);
2626 this._fixupList(repl, parts);
2627 var [thisobj, func] = this._parseFunc(parts[0]);
2628 ret = this._encodeReturn(
2629 func.apply(thisobj, parts.slice(1)),
2630 array_as_mv);
2631 } catch(x) {
2632 ret = ['error', x.toString() ];
2633 }
2635 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2636 repl.print(JSON.encode(ret));
2637 repl._prompt();
2638 },
2640 handleInput: function handleInput(repl, chunk) {
2641 this._input += chunk;
2642 var match, line;
2644 line = match[0];
2647 repl.popInteractor();
2648 repl._prompt();
2649 return;
2650 }
2652 this._input = this._input.substring(line.length);
2653 this._handleInputLine(repl, line);
2654 }
2655 }
2656 });
2657 })
2663 "Marshall the given value for JS.
2664 Strings and numbers are JSON-encoded. Lists (including nil) are
2665 made into JavaScript array literals and their contents encoded
2666 with `js--js-encode-value'."
2693 js--js-repl-prompt-regexp js-js-timeout
2695 ;; start matching against the beginning of the line in
2696 ;; order to catch a prompt that's only partially arrived
2699 ;; Presumably "inferior-moz-process" loads comint.
2709 ;; Do some initialization the first time we see a process
2715 ;; Send interactor definition
2721 js-js-timeout))
2723 ;; Sanity check
2729 ;; If js--js-repl-depth > 0, we *should* be seeing an
2730 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2731 ;; up with us.
2734 ;; Otherwise, tell Mozilla to enter the interactor mode
2740 js-js-timeout))
2754 js-js-timeout))))
2762 ;; The somewhat complex code layout confuses the byte-compiler into
2763 ;; thinking this function "might not be defined at runtime".
2768 "Convert immediate js< and js! references to deferred ones."
2792 function))
2794 else
2795 collect item)))
2810 "Run FORMS with the Mozilla repl set up for js commands.
2811 Inside the lexical scope of `with-js', `js?', `js!',
2812 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2813 `js-create-instance', and `js-qi' are defined."
2824 function)
2832 function)
2864 props)
2866 ))
2872 "Whether to listify any Array returned by a Mozilla function.
2879 (`array
2881 (`objid
2883 js--js-references)
2888 js--js-references)))
2896 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2897 If function is a string, look it up as a property on the global
2898 object and use the global object for `this'.
2899 If FUNCTION is a list with one element, use that element as the
2900 function with the global object for `this', except that if that
2901 single element is a string, look it up on the global object.
2902 If FUNCTION is a list with more than one argument, use the list
2903 up to the last value as a property descriptor and the last
2904 argument as a function."
2911 ;; Actual funcall
2918 js-js-timeout)
2921 ;; Read the result
2928 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
2929 CONSTRUCTOR is a JS handle, a string, or a list of these things."
2932 constructor arguments))
2938 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
2941 arguments)))
2950 "Tell the repl about any objects we don't reference anymore.
2951 With argument, run even if no intervening GC has happened."
2962 ;; Don't bother running unless we've had an intervening
2963 ;; garbage collection; without a gc, nothing is deleted
2964 ;; from the weak hash table, so it's pointless telling
2965 ;; MozRepl about that references we still hold
2968 ;; Are we looking at a normal prompt? Make sure not to
2969 ;; interrupt the user if he's doing something
2977 of js--js-references
2978 collect x))
2985 num)))
2990 "Evaluate the JavaScript in JS and return JSON-decoded result."
2998 result)))
3001 "Enumerate all JavaScript contexts available.
3002 Each context is a list:
3003 (TITLE URL BROWSER TAB TABBROWSER) for content documents
3004 (TITLE URL WINDOW) for windows
3006 All tabs of a given window are grouped together. The most recent
3007 window is first. Within each window, the tabs are returned
3008 left-to-right."
3013 "@mozilla.org/appshell/window-mediator;1"
3035 window)
3042 "browsers"
3043 x
3044 "contentDocument"
3048 "browsers"
3049 x
3050 "contentWindow"
3051 "location"
3054 "browsers"
3055 x)
3058 "tabContainer"
3059 "childNodes"
3061 x)
3063 gbrowser))))))
3070 "Read a Mozilla tab with prompt PROMPT.
3071 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
3072 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
3073 browser, respectively."
3075 ;; Prime IDO
3082 selected-tab prev-hitab)
3084 ;; Disambiguate names
3087 for tab in tabs
3105 ;; Hack to reduce the number of
3106 ;; round-trips to mozilla
3109 ;; Highlighting tab
3112 "style"
3114 cmds)
3116 ;; Highlight window proper
3119 "style"
3121 cmds)
3123 ;; Select tab, when appropriate
3127 cmds)))
3129 ;; Highlighting whole window
3133 "style"
3136 cmds)))
3139 ;; Unhighlighting tab
3142 cmds)
3144 cmds))
3146 ;; Unhighlighting window
3151 cmds)))
3157 ()
3163 ()
3164 ;; Fiddle with the match list a bit: if our first match
3165 ;; is a tabbrowser window, rotate the match list until
3166 ;; the active tab comes up
3172 "document"
3173 "documentElement"
3178 "gBrowser"
3181 for match in ido-matches
3186 and return t)))
3196 prompt
3198 nil t nil
3215 "Helper function for `js-eval-defun'.
3216 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3217 strings making up the class name and NAME is the name of the
3218 function part."
3237 "The current JavaScript context.
3238 This is a cons like the one returned from `js--read-tab'.
3242 "(function(func_info,func) {
3243 func_info.unshift('window');
3244 var obj = window;
3245 for(var i = 1; i < func_info.length - 1; ++i) {
3246 var next = obj[func_info[i]];
3247 if(typeof next !== 'object' && typeof next !== 'function') {
3248 next = obj.prototype && obj.prototype[func_info[i]];
3249 if(typeof next !== 'object' && typeof next !== 'function') {
3250 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3251 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3252 return;
3253 }
3255 func_info.splice(i+1, 0, 'prototype');
3256 ++i;
3257 }
3258 }
3260 obj[func_info[i]] = func;
3261 alert('Successfully updated '+func_info.join('.'));
3265 "Set the JavaScript context to CONTEXT.
3266 When called interactively, prompt for CONTEXT."
3271 "Return a valid JavaScript context.
3272 If one hasn't been set, or if it's stale, prompt for a new one."
3282 js--js-context))
3297 file)))
3310 "Update a Mozilla tab using the JavaScript defun at point."
3313 ;; This function works by generating a temporary file that contains
3314 ;; the function we'd like to insert. We then use the elisp-js bridge
3315 ;; to command mozilla to load this file by inserting a script tag
3316 ;; into the document we set. This way, debuggers and such will have
3317 ;; a way to find the source of the just-inserted function.
3318 ;;
3319 ;; We delete the temporary file if there's an error, but otherwise
3320 ;; we add an unload event listener on the Mozilla side to delete the
3321 ;; file.
3352 ;; (Re)register a Mozilla resource URL to point to the
3353 ;; temporary directory
3371 ;; Give Mozilla responsibility for deleting this file
3376 ;; Regular content
3380 ;; Chrome
3402 ))
3404 ;; temp-name is set to nil on success
3408 ;;; Main Function
3410 ;;;###autoload
3412 "Major mode for editing JavaScript."
3425 ;; Comments
3430 ;; Parse cache
3433 ;; Frameworks
3436 ;; Imenu
3440 ;; for filling, pretend we're cc-mode
3442 c-paragraph-start "$"
3443 c-paragraph-separate "$"
3444 c-block-comment-prefix "* "
3445 c-line-comment-starter "//"
3455 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3456 ;; we call it instead? (Bug#6071)
3466 ;; Important to fontify the whole buffer syntactically! If we don't,
3467 ;; then we might have regular expression literals that aren't marked
3468 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3469 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3470 ;; When we attempt to find the error and scroll to the portion of
3471 ;; the buffer containing the problem, JIT-lock will apply the
3472 ;; correct syntax to the regular expression literal and the problem
3473 ;; will mysteriously disappear.
3474 ;; FIXME: We should actually do this fontification lazily by adding
3475 ;; calls to syntax-propertize wherever it's really needed.
3478 ;;;###autoload (defalias 'javascript-mode 'js-mode)
3486 ;; js.el ends here