| blob | 519e5aef2bc1a56715dd5e6b3d7ea86ef0a9dda0 |
1 ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
3 ;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
5 ;; Author: Karl Landstrom <karl.landstrom@brgeight.se>
6 ;; Daniel Colascione <dan.colascione@gmail.com>
7 ;; Maintainer: Daniel Colascione <dan.colascione@gmail.com>
8 ;; Version: 9
9 ;; Date: 2009-07-25
10 ;; Keywords: languages, javascript
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary
29 ;; This is based on Karl Landstrom's barebones javascript-mode. This
30 ;; is much more robust and works with cc-mode's comment filling
31 ;; (mostly).
32 ;;
33 ;; The main features of this JavaScript mode are syntactic
34 ;; highlighting (enabled with `font-lock-mode' or
35 ;; `global-font-lock-mode'), automatic indentation and filling of
36 ;; comments, C preprocessor fontification, and MozRepl integration.
37 ;;
38 ;; General Remarks:
39 ;;
40 ;; XXX: This mode assumes that block comments are not nested inside block
41 ;; XXX: comments
42 ;;
43 ;; Exported names start with "js-"; private names start with
44 ;; "js--".
46 ;;; Code:
68 ;;; Constants
90 "Regexp matching the prefix of a cpp directive.
91 This includes the directive name, or nil in languages without
92 preprocessor support. The first submatch surrounds the directive
99 Group 1 is a (possibly-dotted) class name, group 2 is a method name,
108 ;; var NewClass = BaseClass.extend(
116 ;; var NewClass = Class.create()
132 ;; var NewClass = Class.create({
139 ;; Parent class name(s) (yes, multiple inheritance in JavaScript) are
140 ;; matched with dedicated font-lock matchers
168 :prototype t
174 :prototype t
190 :prototype t
196 :prototype t
207 :prototype t
221 "List of JavaScript class definition styles.
223 A class definition style is a plist with the following keys:
225 :name is a human-readable name of the class type
227 :class-decl is a regular expression giving the start of the
228 class. Its first group must match the name of its class. If there
229 is a parent class, the second group should match, and it should be
230 the name of the class.
232 If :prototype is present and non-nil, the parser will merge
233 declarations for this constructs with others at the same lexical
234 level that have the same name. Otherwise, multiple definitions
235 will create multiple top-level entries. Don't use :prototype
236 unnecessarily: it has an associated cost in performance.
238 If :strip-prototype is present and non-nil, then if the class
239 name as matched contains
246 collect framework into available-frameworks
247 finally return available-frameworks)
253 "Regexp matching the start of a JavaScript function header.
259 "Regexp matching the start of a function entry in an associative array.
271 "Regexp matching a CPP macro definition, up to the opening parenthesis.
321 ;; js--pitem is the basic building block of the lexical
322 ;; database. When one refers to a real part of the buffer, the region
323 ;; of text to which it refers is split into a conceptual header and
324 ;; body. Consider the (very short) block described by a hypothetical
325 ;; js--pitem:
326 ;;
327 ;; function foo(a,b,c) { return 42; }
328 ;; ^ ^ ^
329 ;; | | |
330 ;; +- h-begin +- h-end +- b-end
331 ;;
332 ;; (Remember that these are buffer positions, and therefore point
333 ;; between characters, not at them. An arrow drawn to a character
334 ;; indicates the corresponding position is between that character and
335 ;; the one immediately preceding it.)
336 ;;
337 ;; The header is the region of text [h-begin, h-end], and is
338 ;; the text needed to unambiguously recognize the start of the
339 ;; construct. If the entire header is not present, the construct is
340 ;; not recognized at all. No other pitems may be nested inside the
341 ;; header.
342 ;;
343 ;; The body is the region [h-end, b-end]. It may contain nested
344 ;; js--pitem instances. The body of a pitem may be empty: in
345 ;; that case, b-end is equal to header-end.
346 ;;
347 ;; The three points obey the following relationship:
348 ;;
349 ;; h-begin < h-end <= b-end
350 ;;
351 ;; We put a text property in the buffer on the character *before*
352 ;; h-end, and if we see it, on the character *before* b-end.
353 ;;
354 ;; The text property for h-end, js--pstate, is actually a list
355 ;; of all js--pitem instances open after the marked character.
356 ;;
357 ;; The text property for b-end, js--pend, is simply the
358 ;; js--pitem that ends after the marked character. (Because
359 ;; pitems always end when the paren-depth drops below a critical
360 ;; value, and because we can only drop one level per character, only
361 ;; one pitem may end at a given character.)
362 ;;
363 ;; In the structure below, we only store h-begin and (sometimes)
364 ;; b-end. We can trivially and quickly find h-end by going to h-begin
365 ;; and searching for an js--pstate text property. Since no other
366 ;; js--pitem instances can be nested inside the header of a
367 ;; pitem, the location after the character with this text property
368 ;; must be h-end.
369 ;;
370 ;; js--pitem instances are never modified (with the exception
371 ;; of the b-end field). Instead, modified copies are added at
372 ;; subsequence parse points.
373 ;; (The exception for b-end and its caveats is described below.)
374 ;;
377 ;; IMPORTANT: Do not alter the position of fields within the list.
378 ;; Various bits of code depend on their positions, particularly
379 ;; anything that manipulates the list of children.
381 ;; List of children inside this pitem's body
384 ;; When we reach this paren depth after h-end, the pitem ends
387 ;; Symbol or class-style plist if this is a class
390 ;; See above
393 ;; List of strings giving the parts of the name of this pitem (e.g.,
394 ;; '("MyClass" "myMethod"), or t if this pitem is anonymous
397 ;; THIS FIELD IS MUTATED, and its value is shared by all copies of
398 ;; this pitem: when we copy-and-modify pitem instances, we share
399 ;; their tail structures, so all the copies actually have the same
400 ;; terminating cons cell. We modify that shared cons cell directly.
401 ;;
402 ;; The field value is either a number (buffer location) or nil if
403 ;; unknown.
404 ;;
405 ;; If the field's value is greater than `js--cache-end', the
406 ;; value is stale and must be treated as if it were nil. Conversely,
407 ;; if this field is nil, it is guaranteed that this pitem is open up
408 ;; to at least `js--cache-end'. (This property is handy when
409 ;; computing whether we're inside a given pitem.)
410 ;;
413 ;; The pitem we start parsing with.
416 :paren-depth most-negative-fixnum
419 ;;; User Customization
422 "Customization variables for JavaScript mode."
427 "Number of spaces for each indentation step in `js-mode'."
432 "Number of additional spaces for indenting continued expressions.
433 The value must be no less than minus `js-indent-level'."
438 "Number of additional spaces for indenting expressions in parentheses.
439 The value must be no less than minus `js-indent-level'."
445 "Number of additional spaces for indenting expressions in square braces.
446 The value must be no less than minus `js-indent-level'."
452 "Number of additional spaces for indenting expressions in curly braces.
453 The value must be no less than minus `js-indent-level'."
459 "Whether to automatically indent when typing punctuation characters.
460 If non-nil, the characters {}();,: also indent the current line
461 in Javascript mode."
466 "Treat nested functions as top-level functions in `js-mode'.
467 This applies to function movement, marking, and so on."
472 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
477 "Frameworks recognized by `js-mode'.
478 To improve performance, you may turn off some frameworks you
479 seldom use, either globally or on a per-buffer basis."
482 js--available-frameworks))
487 "Whether `js-mode' should display tabs while selecting them.
488 This is useful only if the windowing system has a good mechanism
489 for preventing Firefox from stealing the keyboard focus."
494 "~/.emacs.d/js/js"
495 "Temporary directory used by `js-mode' to communicate with Mozilla.
496 This directory must be readable and writable by both Mozilla and Emacs."
501 "Reply timeout for executing commands in Mozilla via `js-mode'.
502 The value is given in seconds. Increase this value if you are
503 getting timeout messages."
507 ;;; KeyMap
523 keymap)
526 ;;; Syntax table and parsing
532 table)
563 "Helper function for `js--update-quick-match-re'.
564 If LIST contains any element that is not nil, return its non-nil
565 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
566 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
567 nil. If any element in LIST is itself a list, flatten that
568 element."
574 "Internal function used by `js-mode' for caching buffer constructs.
575 This updates `js--quick-match-re', based on the current set of
576 enabled frameworks."
581 ;; #define mumble
590 ;; var mumble = THING (
611 ;; mumble.prototypeTHING
619 ;; mumble.prototype = {
626 "Move over the next value of PROPNAME in the buffer.
627 If found, return that value and leave point after the character
628 having that value; otherwise, return nil and leave point at EOB."
639 next-value))
642 "Move over the previous value of PROPNAME in the buffer.
643 If found, return that value and leave point just before the
644 character that has that value, otherwise return nil and leave
645 point at BOB."
658 prev-value)))
671 "Helper function for `js--re-search-forward'."
673 str-terminator
702 "Search forward, ignoring strings, cpp macros, and comments.
703 This function invokes `re-search-forward', but treats the buffer
704 as if strings, cpp macros, and comments have been removed.
706 If invoked while inside a macro, it treats the contents of the
707 macro as normal text."
724 "Auxiliary function for `js--re-search-backward'."
726 str-terminator
757 "Search backward, ignoring strings, preprocessor macros, and comments.
759 This function invokes `re-search-backward' but treats the buffer
760 as if strings, preprocessor macros, and comments have been
761 removed.
763 If invoked while inside a macro, treat the macro as normal text."
767 "Move forward over a whole JavaScript expression.
768 This function doesn't move over expressions continued across
769 lines."
771 ;; non-continued case; simplistic, but good enough?
784 "Move forward over a JavaScript function declaration.
785 This puts point at the 'function' keyword.
787 If this is a syntactically-correct non-expression function,
788 return the name of the function, or t if the name could not be
789 determined. Otherwise, return nil."
802 name)))))
805 "Return the start of the JavaScript function prologue containing POS.
806 A function prologue is everything from start of the definition up
807 to and including the opening brace. POS defaults to point.
808 If POS is not in a function prologue, return nil."
835 "Helper function for `js-beginning-of-defun'.
836 Go to previous defun-beginning and return the parse state for it,
837 or nil if we went all the way back to bob and don't find
838 anything."
846 "Helper function for `js--beginning-of-defun-nested'.
847 If PSTATE represents a non-empty top-level defun, return the
848 top-most pitem. Otherwise, return nil."
851 with func-pitem
858 "Helper function for `js--beginning-of-defun'.
859 Return the pitem of the function we went to the beginning of."
861 ;; Look for the smallest function that encloses point...
866 and return pitem)
868 ;; ...and if that isn't found, look for the previous top-level
869 ;; defun
871 while pstate
874 and return it)))
877 "Helper function for `js-beginning-of-defun'."
883 "Value of `beginning-of-defun-function' for `js-mode'."
899 ;; If we're just past the end of a function, the user probably wants
900 ;; to go to the beginning of *that* function
914 "Flush the `js-mode' syntax cache after position BEG.
915 BEG defaults to `point-min', meaning to flush the entire cache."
921 ;; `(message ,@arguments)
922 )
931 ;; open-items must contain at least two items for this to
932 ;; work, but because we push a dummy item to start with,
933 ;; that assumption holds.
936 open-items)
939 "Helper function for `js--ensure-cache'.
940 Update parsing information up to point, referring to parse,
941 prev-parse-point, goal-point, and open-items bound lexically in
942 the body of `js--ensure-cache'."
949 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
950 ;; the given depth -- i.e., make sure we're deeper than the target
951 ;; depth.
955 prev-parse-point goal-point
957 nil parse))
959 ;; (let ((overlay (make-overlay prev-parse-point (point))))
960 ;; (overlay-put overlay 'face '(:background "red"))
961 ;; (unwind-protect
962 ;; (progn
963 ;; (js--debug "parsed: %S" parse)
964 ;; (sit-for 1))
965 ;; (delete-overlay overlay)))
981 "Split a JavaScript name into its dot-separated parts.
982 This also removes any prototype parts from the split name
994 "Guess the name of the JavaScript function at POSITION.
996 Return the name of the function, or nil if the name could not be
997 guessed.
999 This function clobbers match data. If we find the preamble
1000 begins earlier than expected while guessing the function name,
1001 set `js--guess-function-name-start' to that position; otherwise,
1002 set that variable to nil."
1019 ;; Clear any endings that occur after point
1026 ;; Remove any cache properties after this point
1031 "Ensures brace cache is valid up to the character before LIMIT.
1032 LIMIT defaults to point."
1038 parse
1039 prev-parse-point
1040 name
1041 case-fold-search
1042 filtered-class-styles
1043 goal-point)
1045 ;; Figure out which class styles we need to look for
1049 js-enabled-frameworks)
1050 collect style))
1056 ;; Find last known good position
1072 ;; Make a placeholder for the top-level definition
1088 ;; Each of these conditions should return non-nil if
1089 ;; we should add a new item and leave point at the end
1090 ;; of the new item's header (h-end in the
1091 ;; js--pitem diagram). This point is the one
1092 ;; after the last character we need to unambiguously
1093 ;; detect this construct. If one of these evaluates to
1094 ;; nil, the location of the point is ignored.
1096 ;; In comment or string
1099 ;; Regular function declaration
1108 js--guess-function-name-start))
1115 :paren-depth orig-depth
1116 :h-begin orig-match-start
1119 name
1122 ;; Macro
1125 ;; Macros often contain unbalanced parentheses.
1126 ;; Make sure that h-end is at the textual end of
1127 ;; the macro no matter what the parenthesis say.
1133 :h-begin orig-match-start
1137 ;; "Prototype function" declaration
1144 :paren-depth orig-depth
1145 :h-begin orig-match-start
1151 ;; Class definition
1153 with syntactic-context =
1155 for class-style in filtered-class-styles
1161 and return
1163 :paren-depth orig-depth
1164 :h-begin orig-match-start
1165 :type class-style
1180 )))))
1183 "Helper function for `js-end-of-defun'."
1188 return t
1192 "Helper function for `js-end-of-defun'."
1201 found)
1204 ;; We're already inside a function; just go to its end.
1207 ;; Otherwise, go to the end of the next function...
1214 ;; ... or eob.
1218 "Value of `end-of-defun-function' for `js-mode'."
1229 ;; look for function backward. if we're inside it, go to that
1230 ;; function's end. otherwise, search for the next function's end and
1231 ;; go there
1235 ;; if we're doing nested functions, see whether we're in the
1236 ;; prologue. If we are, go to the end of the function; otherwise,
1237 ;; call js--end-of-defun-nested to do the real work
1258 t
1260 nil))))
1263 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1274 pos
1278 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1288 pos
1291 ;; Like (up-list -1), but only considers lists that end nearby"
1294 ;; Look at a very small region so our computation time doesn't
1295 ;; explode in pathological cases.
1300 "Return non-nil iff point is in a function parameter list."
1311 "Return non-nil iff point is in a Dojo multiple-inheritance class block."
1333 ;;; Font Lock
1335 "Helper function for building `js--font-lock-keywords'.
1336 Create a byte-compiled function for matching a concatenation of
1337 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1348 "Move forward over a JavaScript destructuring spec.
1349 If FUNC is supplied, call it with no arguments before every
1350 variable name in the spec. Return true iff this was actually a
1351 spec. FUNC must preserve the match data."
1363 t)
1368 t))))
1371 t))
1385 t))
1390 t)))))
1393 t))))
1396 "Font-lock matcher for variable names in a variable declaration.
1397 This is a cc-mode-style matcher that *always* fails, from the
1398 point of view of font-lock. It applies highlighting directly with
1399 `font-lock-apply-highlight'."
1411 t))
1433 ;; Conditions to handle
1437 ;; Matcher always "fails"
1438 nil)
1441 `(
1442 ;; This goes before keywords-2 so it gets used preferentially
1443 ;; instead of the keywords in keywords-2. Don't use override
1444 ;; because that will override syntactic fontification too, which
1445 ;; will fontify commented-out directives as if they weren't
1446 ;; commented out.
1449 ,@js--font-lock-keywords-2
1454 ;; Highlights class being declared, in parts
1458 nil
1461 ;; Highlights parent class, in parts, if available
1478 ;; Highlights parent class
1482 ;; Dojo needs its own matcher to override the string highlighting
1484 'dojo
1491 ;; Match Dojo base classes. Of course Mojo has to be different
1492 ;; from everything else under the sun...
1494 'dojo
1503 ;; continued Dojo base-class list
1505 'dojo
1516 ;; variable declarations
1521 ;; class instantiation
1526 ;; instanceof
1531 ;; formal parameters
1535 js--name-start-re)
1541 ;; continued formal parameter list
1555 "Return whether point is inside the given pitem's header or body."
1565 "Parse the JavaScript program state at point.
1566 Return a list of `js--pitem' instances that apply to point, most
1567 specific first. In the worst case, the current toplevel instance
1568 will be returned."
1577 ;; Loop until we either hit a pitem at BOB or pitem ends after
1578 ;; point (or at point if we're at eob)
1585 pstate))))
1588 "Return the JavaScript syntactic context corresponding to PSTATE."
1591 type)
1597 "Return the JavaScript syntactic context at point.
1598 When called interactively, also display a message with that
1599 context."
1607 syntactic-context))
1610 "Font lock function used by `js-mode'.
1611 This performs fontification according to `js--class-styles'."
1619 js-enabled-frameworks)
1622 decl-re
1625 and return t)
1626 return t
1631 js--font-lock-keywords-2
1632 js--font-lock-keywords-3)
1637 ;; A /.../ regexp.
1643 ;; Javascript allows immediate regular expression objects, written /.../.
1648 ;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
1649 ;; FIXME: Allow regexps after infix ops like + ...
1650 ;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
1651 ;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
1652 ;; point I think only * and / would be missing which could also be added,
1653 ;; but need care to avoid affecting the // and */ comment markers.
1658 ;; If the / is at the beginning of line, we have to check
1659 ;; the end of the previous text.
1670 ;;; Indentation
1685 "Return non-nil if point is on a JavaScript operator, other than a comma."
1695 "Return non-nil if the current line continues an expression."
1712 Otherwise, return nil. A braceless do-while statement spanning
1713 several lines requires that the start of the loop is indented to
1714 the same column as the current line."
1736 "Helper function for `js--proper-indentation'.
1737 Return the proper indentation of the current line if it starts
1738 the body of a control statement without braces; otherwise, return
1739 nil."
1763 "Return the proper indentation for the current line."
1773 ;; A single closing paren/bracket should be indented at the
1774 ;; same level as the opening statement. Same goes for
1775 ;; "case" and "default".
1789 js-expr-indent-offset))
1796 ;; If there is something following the opening
1797 ;; paren/bracket, everything else should be indented at
1798 ;; the same level.
1809 "Indent the current line as JavaScript."
1819 ;;; Filling
1822 "Fill the paragraph with `c-fill-paragraph'."
1824 ;; FIXME: Such redefinitions are bad style. We should try and use some other
1825 ;; way to get the same result.
1838 ;;; Type database and Imenu
1840 ;; We maintain a cache of semantic information, i.e., the classes and
1841 ;; functions we've encountered so far. In order to avoid having to
1842 ;; re-parse the buffer on every change, we cache the parse state at
1843 ;; each interesting point in the buffer. Each parse state is a
1844 ;; modified copy of the previous one, or in the case of the first
1845 ;; parse state, the empty state.
1846 ;;
1847 ;; The parse state itself is just a stack of js--pitem
1848 ;; instances. It starts off containing one element that is never
1849 ;; closed, that is initially js--initial-pitem.
1850 ;;
1858 name
1860 type
1864 "Helper function for `js--splice-into-items'.
1865 Return a new item that is the result of merging CHILD into
1866 ITEM. NAME-PARTS is a list of parts of the name of CHILD
1867 that we haven't consumed yet."
1872 ;; If the item we're merging into isn't a class, make it into one
1878 ;; Use the child's class-style if it's available
1880 js--dummy-class-style
1885 ;; Now we can merge either a function or a class into a class
1889 ;; if we have more name-parts to go before we get to the
1890 ;; bottom of the class hierarchy, call the merger
1891 ;; recursively
1897 ;; Not merging a class, but something else, so just prepend
1898 ;; it
1902 ;; Otherwise, merge the new child's items into those
1903 ;; of the new class
1909 "Last part of the name of PITEM, as a string or symbol."
1913 name)))
1916 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
1917 If a class doesn't exist in the tree, create it. Return
1918 the new items list. NAME-PARTS is a list of strings given
1919 the broken-down class name of the item to insert."
1923 new-items last-new-item new-cons)
1926 name-parts
1932 ;; If top-name isn't found in items, then we build a copy of items
1933 ;; and throw it away. But that's okay, since most of the time, we
1934 ;; *will* find an instance.
1938 ;; Okay, we found an entry with the right name. Splice
1939 ;; the merged item into the list...
1942 name-parts)
1949 ;; ...and terminate the loop
1950 nil)
1953 ;; Otherwise, copy the current cons and move onto the
1954 ;; text. This is tricky; we keep track of the tail of
1955 ;; the list that begins with new-items in
1956 ;; last-new-item.
1963 ;; Go to the next cell in items
1967 ;; Yay! We stopped because we found something, not because
1968 ;; we ran out of items to search. Just return the new
1969 ;; list.
1972 new-items)
1974 ;; We didn't find anything. If the child is a class and we don't
1975 ;; have any classes to drill down into, just push that class;
1976 ;; otherwise, make a fake class and carry on.
1979 ;; We have name-parts left to process. Make a fake
1980 ;; class for this particular part...
1982 ;; ...and recursively digest the rest of the name
1985 :type js--dummy-class-style
1988 ;; Otherwise, this is the only name we have, so stick
1989 ;; the item on the front of the list
1990 child)
1991 items))))
1994 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
1999 t))
2001 ;; This trick works because we know (based on our defstructs) that
2002 ;; the child list is always the first element, and so the second
2003 ;; element and beyond can be shared when we make our "copy".
2010 ;; Use slow path because we need class lookup
2016 ;; Use slow path because we need class merging. We know
2017 ;; name is a list here because down in
2018 ;; `js--ensure-cache', we made sure to only add
2019 ;; class entries with lists for :name
2024 ;; Fast path
2030 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2033 location))
2036 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2053 imenu-items))
2058 unknown-ctr))
2061 imenu-items))
2070 imenu-items))))
2074 imenu-items))
2077 "Return an imenu index for the current buffer."
2089 ;; Make sure everything is closed
2097 ;; Convert the new-finalized state into what imenu expects
2100 unknown-ctr))))))
2102 ;; Silence the compiler.
2113 symbols)
2114 else
2125 "Return a hash table of all JavaScript symbols.
2126 This searches all existing `js-mode' buffers. Each key is the
2127 name of a symbol (possibly disambiguated with <N>, where N > 1),
2128 and each value is a marker giving the location of that symbol."
2130 with imenu-use-markers = t
2131 for buffer being the buffers
2136 finally return symbols))
2142 "Helper function for `js-find-symbol'.
2143 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2144 one from `js--get-all-known-symbols', using prompt PROMPT and
2145 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2146 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2147 marker."
2153 prompt
2155 collect key)
2172 "Read a JavaScript symbol and jump to it.
2173 With a prefix argument, restrict symbols to those from the
2174 current buffer. Pushes a mark onto the tag ring just like
2175 `find-tag'."
2186 symbols "Jump to: "
2194 ;;; MozRepl integration
2204 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2205 On timeout, return nil. On success, return t with match data
2206 set. If START is non-nil, look for output starting from START.
2207 Otherwise, use the current value of `process-mark'."
2219 'js-moz-bad-rpc
2223 ;; Integer, mirrors the value we see in JS
2226 ;; Process to which this thing belongs
2247 ; */" Make Emacs happy
2248 "(function(repl) {
2249 repl.defineInteractor('js', {
2250 onStart: function onStart(repl) {
2251 if(!repl._jsObjects) {
2252 repl._jsObjects = {};
2253 repl._jsLastID = 0;
2254 repl._jsGC = this._jsGC;
2255 }
2256 this._input = '';
2257 },
2259 _jsGC: function _jsGC(ids_in_use) {
2260 var objects = this._jsObjects;
2261 var keys = [];
2262 var num_freed = 0;
2264 for(var pn in objects) {
2265 keys.push(Number(pn));
2266 }
2268 keys.sort(function(x, y) x - y);
2269 ids_in_use.sort(function(x, y) x - y);
2270 var i = 0;
2271 var j = 0;
2273 while(i < ids_in_use.length && j < keys.length) {
2274 var id = ids_in_use[i++];
2275 while(j < keys.length && keys[j] !== id) {
2276 var k_id = keys[j++];
2277 delete objects[k_id];
2278 ++num_freed;
2279 }
2280 ++j;
2281 }
2283 while(j < keys.length) {
2284 var k_id = keys[j++];
2285 delete objects[k_id];
2286 ++num_freed;
2287 }
2289 return num_freed;
2290 },
2292 _mkArray: function _mkArray() {
2293 var result = [];
2294 for(var i = 0; i < arguments.length; ++i) {
2295 result.push(arguments[i]);
2296 }
2297 return result;
2298 },
2300 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2301 if(typeof parts === 'string') {
2302 parts = [ parts ];
2303 }
2305 var obj = parts[0];
2306 var start = 1;
2308 if(typeof obj === 'string') {
2309 obj = window;
2310 start = 0;
2311 } else if(parts.length < 2) {
2312 throw new Error('expected at least 2 arguments');
2313 }
2315 for(var i = start; i < parts.length - 1; ++i) {
2316 obj = obj[parts[i]];
2317 }
2319 return [obj, parts[parts.length - 1]];
2320 },
2322 _getProp: function _getProp(/*...*/) {
2323 if(arguments.length === 0) {
2324 throw new Error('no arguments supplied to getprop');
2325 }
2327 if(arguments.length === 1 &&
2328 (typeof arguments[0]) !== 'string')
2329 {
2330 return arguments[0];
2331 }
2333 var [obj, propname] = this._parsePropDescriptor(arguments);
2334 return obj[propname];
2335 },
2337 _putProp: function _putProp(properties, value) {
2338 var [obj, propname] = this._parsePropDescriptor(properties);
2339 obj[propname] = value;
2340 },
2342 _delProp: function _delProp(propname) {
2343 var [obj, propname] = this._parsePropDescriptor(arguments);
2344 delete obj[propname];
2345 },
2347 _typeOf: function _typeOf(thing) {
2348 return typeof thing;
2349 },
2351 _callNew: function(constructor) {
2352 if(typeof constructor === 'string')
2353 {
2354 constructor = window[constructor];
2355 } else if(constructor.length === 1 &&
2356 typeof constructor[0] !== 'string')
2357 {
2358 constructor = constructor[0];
2359 } else {
2360 var [obj,propname] = this._parsePropDescriptor(constructor);
2361 constructor = obj[propname];
2362 }
2364 /* Hacky, but should be robust */
2365 var s = 'new constructor(';
2366 for(var i = 1; i < arguments.length; ++i) {
2367 if(i != 1) {
2368 s += ',';
2369 }
2371 s += 'arguments[' + i + ']';
2372 }
2374 s += ')';
2375 return eval(s);
2376 },
2378 _callEval: function(thisobj, js) {
2379 return eval.call(thisobj, js);
2380 },
2382 getPrompt: function getPrompt(repl) {
2383 return 'EVAL>'
2384 },
2386 _lookupObject: function _lookupObject(repl, id) {
2387 if(typeof id === 'string') {
2388 switch(id) {
2389 case 'global':
2390 return window;
2391 case 'nil':
2392 return null;
2393 case 't':
2394 return true;
2395 case 'false':
2396 return false;
2397 case 'undefined':
2398 return undefined;
2399 case 'repl':
2400 return repl;
2401 case 'interactor':
2402 return this;
2403 case 'NaN':
2404 return NaN;
2405 case 'Infinity':
2406 return Infinity;
2407 case '-Infinity':
2408 return -Infinity;
2409 default:
2410 throw new Error('No object with special id:' + id);
2411 }
2412 }
2414 var ret = repl._jsObjects[id];
2415 if(ret === undefined) {
2416 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2417 }
2418 return ret;
2419 },
2421 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2422 if(typeof value !== 'object' && typeof value !== 'function') {
2423 throw new Error('_findOrAllocateObject called on non-object('
2424 + typeof(value) + '): '
2425 + value)
2426 }
2428 for(var id in repl._jsObjects) {
2429 id = Number(id);
2430 var obj = repl._jsObjects[id];
2431 if(obj === value) {
2432 return id;
2433 }
2434 }
2436 var id = ++repl._jsLastID;
2437 repl._jsObjects[id] = value;
2438 return id;
2439 },
2441 _fixupList: function _fixupList(repl, list) {
2442 for(var i = 0; i < list.length; ++i) {
2443 if(list[i] instanceof Array) {
2444 this._fixupList(repl, list[i]);
2445 } else if(typeof list[i] === 'object') {
2446 var obj = list[i];
2447 if(obj.funcall) {
2448 var parts = obj.funcall;
2449 this._fixupList(repl, parts);
2450 var [thisobj, func] = this._parseFunc(parts[0]);
2451 list[i] = func.apply(thisobj, parts.slice(1));
2452 } else if(obj.objid) {
2453 list[i] = this._lookupObject(repl, obj.objid);
2454 } else {
2455 throw new Error('Unknown object type: ' + obj.toSource());
2456 }
2457 }
2458 }
2459 },
2461 _parseFunc: function(func) {
2462 var thisobj = null;
2464 if(typeof func === 'string') {
2465 func = window[func];
2466 } else if(func instanceof Array) {
2467 if(func.length === 1 && typeof func[0] !== 'string') {
2468 func = func[0];
2469 } else {
2470 [thisobj, func] = this._parsePropDescriptor(func);
2471 func = thisobj[func];
2472 }
2473 }
2475 return [thisobj,func];
2476 },
2478 _encodeReturn: function(value, array_as_mv) {
2479 var ret;
2481 if(value === null) {
2482 ret = ['special', 'null'];
2483 } else if(value === true) {
2484 ret = ['special', 'true'];
2485 } else if(value === false) {
2486 ret = ['special', 'false'];
2487 } else if(value === undefined) {
2488 ret = ['special', 'undefined'];
2489 } else if(typeof value === 'number') {
2490 if(isNaN(value)) {
2491 ret = ['special', 'NaN'];
2492 } else if(value === Infinity) {
2493 ret = ['special', 'Infinity'];
2494 } else if(value === -Infinity) {
2495 ret = ['special', '-Infinity'];
2496 } else {
2497 ret = ['atom', value];
2498 }
2499 } else if(typeof value === 'string') {
2500 ret = ['atom', value];
2501 } else if(array_as_mv && value instanceof Array) {
2502 ret = ['array', value.map(this._encodeReturn, this)];
2503 } else {
2504 ret = ['objid', this._findOrAllocateObject(repl, value)];
2505 }
2507 return ret;
2508 },
2510 _handleInputLine: function _handleInputLine(repl, line) {
2511 var ret;
2512 var array_as_mv = false;
2514 try {
2515 if(line[0] === '*') {
2516 array_as_mv = true;
2517 line = line.substring(1);
2518 }
2519 var parts = eval(line);
2520 this._fixupList(repl, parts);
2521 var [thisobj, func] = this._parseFunc(parts[0]);
2522 ret = this._encodeReturn(
2523 func.apply(thisobj, parts.slice(1)),
2524 array_as_mv);
2525 } catch(x) {
2526 ret = ['error', x.toString() ];
2527 }
2529 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2530 repl.print(JSON.encode(ret));
2531 repl._prompt();
2532 },
2534 handleInput: function handleInput(repl, chunk) {
2535 this._input += chunk;
2536 var match, line;
2538 line = match[0];
2541 repl.popInteractor();
2542 repl._prompt();
2543 return;
2544 }
2546 this._input = this._input.substring(line.length);
2547 this._handleInputLine(repl, line);
2548 }
2549 }
2550 });
2551 })
2557 "Marshall the given value for JS.
2558 Strings and numbers are JSON-encoded. Lists (including nil) are
2559 made into JavaScript array literals and their contents encoded
2560 with `js--js-encode-value'."
2587 js--js-repl-prompt-regexp js-js-timeout
2589 ;; start matching against the beginning of the line in
2590 ;; order to catch a prompt that's only partially arrived
2598 ;; Do some initialization the first time we see a process
2604 ;; Send interactor definition
2610 js-js-timeout))
2612 ;; Sanity check
2618 ;; If js--js-repl-depth > 0, we *should* be seeing an
2619 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2620 ;; up with us.
2623 ;; Otherwise, tell Mozilla to enter the interactor mode
2629 js-js-timeout))
2643 js-js-timeout))))
2653 "Convert immediate js< and js! references to deferred ones."
2677 function))
2679 else
2680 collect item)))
2695 "Run FORMS with the Mozilla repl set up for js commands.
2696 Inside the lexical scope of `with-js', `js?', `js!',
2697 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2698 `js-create-instance', and `js-qi' are defined."
2709 function)
2717 function)
2749 props)
2751 ))
2757 "Whether to listify any Array returned by a Mozilla function.
2764 (`array
2766 (`objid
2768 js--js-references)
2773 js--js-references)))
2779 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2780 If function is a string, look it up as a property on the global
2781 object and use the global object for `this'.
2782 If FUNCTION is a list with one element, use that element as the
2783 function with the global object for `this', except that if that
2784 single element is a string, look it up on the global object.
2785 If FUNCTION is a list with more than one argument, use the list
2786 up to the last value as a property descriptor and the last
2787 argument as a function."
2794 ;; Actual funcall
2801 js-js-timeout)
2804 ;; Read the result
2811 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
2812 CONSTRUCTOR is a JS handle, a string, or a list of these things."
2815 constructor arguments))
2821 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
2824 arguments)))
2833 "Tell the repl about any objects we don't reference anymore.
2834 With argument, run even if no intervening GC has happened."
2845 ;; Don't bother running unless we've had an intervening
2846 ;; garbage collection; without a gc, nothing is deleted
2847 ;; from the weak hash table, so it's pointless telling
2848 ;; MozRepl about that references we still hold
2851 ;; Are we looking at a normal prompt? Make sure not to
2852 ;; interrupt the user if he's doing something
2860 of js--js-references
2861 collect x))
2868 num)))
2873 "Evaluate the JavaScript in JS and return JSON-decoded result."
2881 result)))
2884 "Enumerate all JavaScript contexts available.
2885 Each context is a list:
2886 (TITLE URL BROWSER TAB TABBROWSER) for content documents
2887 (TITLE URL WINDOW) for windows
2889 All tabs of a given window are grouped together. The most recent
2890 window is first. Within each window, the tabs are returned
2891 left-to-right."
2896 "@mozilla.org/appshell/window-mediator;1"
2918 window)
2925 "browsers"
2926 x
2927 "contentDocument"
2931 "browsers"
2932 x
2933 "contentWindow"
2934 "location"
2937 "browsers"
2938 x)
2941 "tabContainer"
2942 "childNodes"
2944 x)
2946 gbrowser))))))
2951 "Read a Mozilla tab with prompt PROMPT.
2952 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
2953 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
2954 browser, respectively."
2956 ;; Prime IDO
2963 selected-tab prev-hitab)
2965 ;; Disambiguate names
2968 for tab in tabs
2986 ;; Hack to reduce the number of
2987 ;; round-trips to mozilla
2990 ;; Highlighting tab
2993 "style"
2995 cmds)
2997 ;; Highlight window proper
3000 "style"
3002 cmds)
3004 ;; Select tab, when appropriate
3008 cmds)))
3010 ;; Highlighting whole window
3014 "style"
3017 cmds)))
3020 ;; Unhighlighting tab
3023 cmds)
3025 cmds))
3027 ;; Unhighlighting window
3032 cmds)))
3038 ()
3044 ()
3045 ;; Fiddle with the match list a bit: if our first match
3046 ;; is a tabbrowser window, rotate the match list until
3047 ;; the active tab comes up
3053 "document"
3054 "documentElement"
3059 "gBrowser"
3062 for match in ido-matches
3067 and return t)))
3077 prompt
3079 nil t nil
3096 "Helper function for `js-eval-defun'.
3097 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3098 strings making up the class name and NAME is the name of the
3099 function part."
3118 "The current JavaScript context.
3119 This is a cons like the one returned from `js--read-tab'.
3123 "(function(func_info,func) {
3124 func_info.unshift('window');
3125 var obj = window;
3126 for(var i = 1; i < func_info.length - 1; ++i) {
3127 var next = obj[func_info[i]];
3128 if(typeof next !== 'object' && typeof next !== 'function') {
3129 next = obj.prototype && obj.prototype[func_info[i]];
3130 if(typeof next !== 'object' && typeof next !== 'function') {
3131 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3132 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3133 return;
3134 }
3136 func_info.splice(i+1, 0, 'prototype');
3137 ++i;
3138 }
3139 }
3141 obj[func_info[i]] = func;
3142 alert('Successfully updated '+func_info.join('.'));
3146 "Set the JavaScript context to CONTEXT.
3147 When called interactively, prompt for CONTEXT."
3152 "Return a valid JavaScript context.
3153 If one hasn't been set, or if it's stale, prompt for a new one."
3163 js--js-context))
3178 file)))
3191 "Update a Mozilla tab using the JavaScript defun at point."
3194 ;; This function works by generating a temporary file that contains
3195 ;; the function we'd like to insert. We then use the elisp-js bridge
3196 ;; to command mozilla to load this file by inserting a script tag
3197 ;; into the document we set. This way, debuggers and such will have
3198 ;; a way to find the source of the just-inserted function.
3199 ;;
3200 ;; We delete the temporary file if there's an error, but otherwise
3201 ;; we add an unload event listener on the Mozilla side to delete the
3202 ;; file.
3233 ;; (Re)register a Mozilla resource URL to point to the
3234 ;; temporary directory
3252 ;; Give Mozilla responsibility for deleting this file
3257 ;; Regular content
3261 ;; Chrome
3283 ))
3285 ;; temp-name is set to nil on success
3289 ;;; Main Function
3291 ;;;###autoload
3293 "Major mode for editing JavaScript."
3313 ;; Comments
3319 ;; Parse cache
3322 ;; Frameworks
3325 ;; Imenu
3330 ;; for filling, pretend we're cc-mode
3332 c-paragraph-start "$"
3333 c-paragraph-separate "$"
3334 c-block-comment-prefix "* "
3335 c-line-comment-starter "//"
3345 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3346 ;; we call it instead? (Bug#6071)
3357 ;; Important to fontify the whole buffer syntactically! If we don't,
3358 ;; then we might have regular expression literals that aren't marked
3359 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3360 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3361 ;; When we attempt to find the error and scroll to the portion of
3362 ;; the buffer containing the problem, JIT-lock will apply the
3363 ;; correct syntax to the regular expression literal and the problem
3364 ;; will mysteriously disappear.
3365 ;; FIXME: We should actually do this fontification lazily by adding
3366 ;; calls to syntax-propertize wherever it's really needed.
3369 ;;;###autoload
3378 ;; js.el ends here