| blob | db8a52330c139066117b7f44d44441f9617635e1 |
1 ;;; js.el --- Major mode for editing JavaScript
3 ;; Copyright (C) 2008, 2009 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, oop, 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:
70 ;;; Constants
92 "Regexp matching the prefix of a cpp directive.
93 This includes the directive name, or nil in languages without
94 preprocessor support. The first submatch surrounds the directive
101 Group 1 is a (possibly-dotted) class name, group 2 is a method name,
110 ;; var NewClass = BaseClass.extend(
118 ;; var NewClass = Class.create()
134 ;; var NewClass = Class.create({
141 ;; Parent class name(s) (yes, multiple inheritance in JavaScript) are
142 ;; matched with dedicated font-lock matchers
170 :prototype t
176 :prototype t
192 :prototype t
198 :prototype t
209 :prototype t
223 "List of JavaScript class definition styles.
225 A class definition style is a plist with the following keys:
227 :name is a human-readable name of the class type
229 :class-decl is a regular expression giving the start of the
230 class. Its first group must match the name of its class. If there
231 is a parent class, the second group should match, and it should be
232 the name of the class.
234 If :prototype is present and non-nil, the parser will merge
235 declarations for this constructs with others at the same lexical
236 level that have the same name. Otherwise, multiple definitions
237 will create multiple top-level entries. Don't use :prototype
238 unnecessarily: it has an associated cost in performance.
240 If :strip-prototype is present and non-nil, then if the class
241 name as matched contains
246 for style in js--class-styles
249 collect framework into available-frameworks
250 finally return available-frameworks)
256 "Regexp matching the start of a JavaScript function header.
262 "Regexp matching the start of a function entry in an associative array.
274 "Regexp matching a CPP macro definition, up to the opening parenthesis.
324 ;; js--pitem is the basic building block of the lexical
325 ;; database. When one refers to a real part of the buffer, the region
326 ;; of text to which it refers is split into a conceptual header and
327 ;; body. Consider the (very short) block described by a hypothetical
328 ;; js--pitem:
329 ;;
330 ;; function foo(a,b,c) { return 42; }
331 ;; ^ ^ ^
332 ;; | | |
333 ;; +- h-begin +- h-end +- b-end
334 ;;
335 ;; (Remember that these are buffer positions, and therefore point
336 ;; between characters, not at them. An arrow drawn to a character
337 ;; indicates the corresponding position is between that character and
338 ;; the one immediately preceding it.)
339 ;;
340 ;; The header is the region of text [h-begin, h-end], and is
341 ;; the text needed to unambiguously recognize the start of the
342 ;; construct. If the entire header is not present, the construct is
343 ;; not recognized at all. No other pitems may be nested inside the
344 ;; header.
345 ;;
346 ;; The body is the region [h-end, b-end]. It may contain nested
347 ;; js--pitem instances. The body of a pitem may be empty: in
348 ;; that case, b-end is equal to header-end.
349 ;;
350 ;; The three points obey the following relationship:
351 ;;
352 ;; h-begin < h-end <= b-end
353 ;;
354 ;; We put a text property in the buffer on the character *before*
355 ;; h-end, and if we see it, on the character *before* b-end.
356 ;;
357 ;; The text property for h-end, js--pstate, is actually a list
358 ;; of all js--pitem instances open after the marked character.
359 ;;
360 ;; The text property for b-end, js--pend, is simply the
361 ;; js--pitem that ends after the marked character. (Because
362 ;; pitems always end when the paren-depth drops below a critical
363 ;; value, and because we can only drop one level per character, only
364 ;; one pitem may end at a given character.)
365 ;;
366 ;; In the structure below, we only store h-begin and (sometimes)
367 ;; b-end. We can trivially and quickly find h-end by going to h-begin
368 ;; and searching for an js--pstate text property. Since no other
369 ;; js--pitem instances can be nested inside the header of a
370 ;; pitem, the location after the character with this text property
371 ;; must be h-end.
372 ;;
373 ;; js--pitem instances are never modified (with the exception
374 ;; of the b-end field). Instead, modified copies are added at subseqnce parse points.
375 ;; (The exception for b-end and its caveats is described below.)
376 ;;
379 ;; IMPORTANT: Do not alter the position of fields within the list.
380 ;; Various bits of code depend on their positions, particularly
381 ;; anything that manipulates the list of children.
383 ;; List of children inside this pitem's body
386 ;; When we reach this paren depth after h-end, the pitem ends
389 ;; Symbol or class-style plist if this is a class
392 ;; See above
395 ;; List of strings giving the parts of the name of this pitem (e.g.,
396 ;; '("MyClass" "myMethod"), or t if this pitem is anonymous
399 ;; THIS FIELD IS MUTATED, and its value is shared by all copies of
400 ;; this pitem: when we copy-and-modify pitem instances, we share
401 ;; their tail structures, so all the copies actually have the same
402 ;; terminating cons cell. We modify that shared cons cell directly.
403 ;;
404 ;; The field value is either a number (buffer location) or nil if
405 ;; unknown.
406 ;;
407 ;; If the field's value is greater than `js--cache-end', the
408 ;; value is stale and must be treated as if it were nil. Conversely,
409 ;; if this field is nil, it is guaranteed that this pitem is open up
410 ;; to at least `js--cache-end'. (This property is handy when
411 ;; computing whether we're inside a given pitem.)
412 ;;
415 ;; The pitem we start parsing with.
418 :paren-depth most-negative-fixnum
421 ;;; User Customization
424 "Customization variables for JavaScript mode."
429 "Number of spaces for each indentation step in `js-mode'."
434 "Number of additional spaces used for indentation of continued expressions.
435 The value must be no less than minus `js-indent-level'."
440 "Treat nested functions as top-level functions in `js-mode'.
441 This applies to function movement, marking, and so on."
446 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
451 "Frameworks recognized by `js-mode'.
452 To improve performance, you may turn off some frameworks you
453 seldom use, either globally or on a per-buffer basis."
456 js--available-frameworks))
461 "Whether `js-mode' should display tabs while selecting them.
462 This is useful only if the windowing system has a good mechanism
463 for preventing Firefox from stealing the keyboard focus."
468 "~/.emacs.d/js/js"
469 "Temporary directory used by `js-mode' to communicate with Mozilla.
470 This directory must be readable and writable by both Mozilla and
471 Emacs."
476 "Reply timeout for executing commands in Mozilla via `js-mode'.
477 The value is given in seconds. Increase this value if you are
478 getting timeout messages."
482 ;;; KeyMap
498 keymap)
501 ;;; Syntax table and parsing
507 table)
538 "Helper function for `js--update-quick-match-re'.
539 If LIST contains any element that is not nil, return its non-nil
540 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
541 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
542 nil. If any element in LIST is itself a list, flatten that
543 element."
549 "Internal function used by `js-mode' for caching buffer constructs.
550 This updates `js--quick-match-re', based on the current set of
551 enabled frameworks."
556 ;; #define mumble
565 ;; var mumble = THING (
586 ;; mumble.prototypeTHING
594 ;; mumble.prototype = {
601 "Move over the next value of PROPNAME in the buffer.
602 If found, return that value and leave point after the character
603 having that value; otherwise, return nil and leave point at EOB."
614 next-value))
617 "Move over the previous value of PROPNAME in the buffer.
618 If found, return that value and leave point just before the
619 character that has that value, otherwise return nil and leave
620 point at BOB."
633 prev-value)))
646 "Helper function for `js--re-search-forward'."
648 str-terminator
677 "Search forward, ignoring strings, cpp macros, and comments.
678 This function invokes `re-search-forward', but treats the buffer
679 as if strings, cpp macros, and comments have been removed.
681 If invoked while inside a macro, it treats the contents of the
682 macro as normal text."
700 "Auxiliary function for `js--re-search-backward'."
702 str-terminator
733 "Search backward, ignoring strings, preprocessor macros, and comments.
735 This function invokes `re-search-backward' but treats the buffer
736 as if strings, preprocessor macros, and comments have been
737 removed.
739 If invoked while inside a macro, treat the macro as normal text."
756 "Move forward over a whole JavaScript expression.
757 This function doesn't move over expressions continued across
758 lines."
760 ;; non-continued case; simplistic, but good enough?
773 "Move forward over a JavaScript function declaration.
774 This puts point at the 'function' keyword.
776 If this is a syntactically-correct non-expression function,
777 return the name of the function, or t if the name could not be
778 determined. Otherwise, return nil."
791 name)))))
794 "Return the start of the JavaScript function prologue containing POS.
795 A function prologue is everything from start of the definition up
796 to and including the opening brace. POS defaults to point.
797 If POS is not in a function prologue, return nil."
824 "Helper function for `js-beginning-of-defun'.
825 Go to previous defun-beginning and return the parse state for it,
826 or nil if we went all the way back to bob and don't find
827 anything."
835 "Helper function for `js--beginning-of-defun-nested'.
836 If PSTATE represents a non-empty top-level defun, return the
837 top-most pitem. Otherwise, return nil."
840 with func-pitem
847 "Helper function for `js--beginning-of-defun'.
848 Return the pitem of the function we went to the beginning of."
850 ;; Look for the smallest function that encloses point...
855 and return pitem)
857 ;; ...and if that isn't found, look for the previous top-level
858 ;; defun
860 while pstate
863 and return it)))
866 "Helper function for `js-beginning-of-defun'."
872 "Value of `beginning-of-defun-function' for `js-mode'."
888 ;; If we're just past the end of a function, the user probably wants
889 ;; to go to the beginning of *that* function
903 "Flush the `js-mode' syntax cache after position BEG.
904 BEG defaults to `point-min', meaning to flush the entire cache."
910 ;; `(message ,@arguments)
911 )
920 ;; open-items must contain at least two items for this to
921 ;; work, but because we push a dummy item to start with,
922 ;; that assumption holds.
925 open-items)
928 "Helper function for `js--ensure-cache'.
929 Update parsing information up to point, referring to parse,
930 prev-parse-point, goal-point, and open-items bound lexically in
931 the body of `js--ensure-cache'."
938 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
939 ;; the given depth -- i.e., make sure we're deeper than the target
940 ;; depth.
944 prev-parse-point goal-point
946 nil parse))
948 ;; (let ((overlay (make-overlay prev-parse-point (point))))
949 ;; (overlay-put overlay 'face '(:background "red"))
950 ;; (unwind-protect
951 ;; (progn
952 ;; (js--debug "parsed: %S" parse)
953 ;; (sit-for 1))
954 ;; (delete-overlay overlay)))
970 "Split a JavaScript name into its dot-separated parts.
971 This also removes any prototype parts from the split name
983 "Guess the name of the JavaScript function at POSITION.
985 Return the name of the function, or nil if the name could not be
986 guessed.
988 This function clobbers match data. If we find the preamble
989 begins earlier than expected while guessing the function name,
990 set `js--guess-function-name-start' to that position; otherwise,
991 set that variable to nil."
1008 ;; Clear any endings that occur after point
1015 ;; Remove any cache properties after this point
1020 "Ensures brace cache is valid up to the character before LIMIT.
1021 LIMIT defaults to point."
1027 orig-match-start
1028 orig-match-end
1029 orig-depth
1030 parse
1031 prev-parse-point
1032 name
1033 case-fold-search
1034 filtered-class-styles
1035 new-item
1036 goal-point
1037 end-prop)
1039 ;; Figure out which class styles we need to look for
1043 js-enabled-frameworks)
1044 collect style))
1050 ;; Find last known good position
1066 ;; Make a placeholder for the top-level definition
1082 ;; Each of these conditions should return non-nil if
1083 ;; we should add a new item and leave point at the end
1084 ;; of the new item's header (h-end in the
1085 ;; js--pitem diagram). This point is the one
1086 ;; after the last character we need to unambiguously
1087 ;; detect this construct. If one of these evaluates to
1088 ;; nil, the location of the point is ignored.
1090 ;; In comment or string
1093 ;; Regular function declaration
1102 js--guess-function-name-start))
1109 :paren-depth orig-depth
1110 :h-begin orig-match-start
1113 name
1116 ;; Macro
1119 ;; Macros often contain unbalanced parentheses.
1120 ;; Make sure that h-end is at the textual end of
1121 ;; the macro no matter what the parenthesis say.
1127 :h-begin orig-match-start
1131 ;; "Prototype function" declaration
1138 :paren-depth orig-depth
1139 :h-begin orig-match-start
1145 ;; Class definition
1148 for class-style in filtered-class-styles
1154 and return
1156 :paren-depth orig-depth
1157 :h-begin orig-match-start
1158 :type class-style
1173 )))))
1176 "Helper function for `js-end-of-defun'."
1181 return t
1185 "Helper function for `js-end-of-defun'."
1194 found)
1197 ;; We're already inside a function; just go to its end.
1200 ;; Otherwise, go to the end of the next function...
1207 ;; ... or eob.
1211 "Value of `end-of-defun-function' for `js-mode'."
1223 ;; look for function backward. if we're inside it, go to that
1224 ;; function's end. otherwise, search for the next function's end and
1225 ;; go there
1229 ;; if we're doing nested functions, see whether we're in the
1230 ;; prologue. If we are, go to the end of the function; otherwise,
1231 ;; call js--end-of-defun-nested to do the real work
1252 t
1254 nil))))
1257 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1268 pos
1272 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1282 pos
1285 ;; Like (up-list -1), but only considers lists that end nearby"
1288 ;; Look at a very small region so our compuation time doesn't
1289 ;; explode in pathological cases.
1294 "Return non-nil iff point is in a function parameter list."
1305 "Return non-nil iff point is in a Dojo multiple-inheritance class block."
1327 ;;; Font Lock
1329 "Helper function for building `js--font-lock-keywords'.
1330 Create a byte-compiled function for matching a concatenation of
1331 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1342 "Move forward over a JavaScript destructuring spec.
1343 If FUNC is supplied, call it with no arguments before every
1344 variable name in the spec. Return true iff this was actually a
1345 spec. FUNC must preserve the match data."
1357 t)
1362 t))))
1365 t))
1379 t))
1384 t)))))
1387 t))))
1390 "Font-lock matcher for variable names in a variable declaration.
1391 This is a cc-mode-style matcher that *always* fails, from the
1392 point of view of font-lock. It applies highlighting directly with
1393 `font-lock-apply-highlight'."
1405 t))
1427 ;; Conditions to handle
1431 ;; Matcher always "fails"
1432 nil)
1435 `(
1436 ;; This goes before keywords-2 so it gets used preferentially
1437 ;; instead of the keywords in keywords-2. Don't use override
1438 ;; because that will override syntactic fontification too, which
1439 ;; will fontify commented-out directives as if they weren't
1440 ;; commented out.
1443 ,@js--font-lock-keywords-2
1448 ;; Highlights class being declared, in parts
1452 nil
1455 ;; Highlights parent class, in parts, if available
1472 ;; Highlights parent class
1476 ;; Dojo needs its own matcher to override the string highlighting
1478 'dojo
1485 ;; Match Dojo base classes. Of course Mojo has to be different
1486 ;; from everything else under the sun...
1488 'dojo
1497 ;; continued Dojo base-class list
1499 'dojo
1510 ;; variable declarations
1515 ;; class instantiation
1520 ;; instanceof
1525 ;; formal parameters
1529 js--name-start-re)
1535 ;; continued formal parameter list
1549 "Return whether point is inside the given pitem's header or body."
1559 "Parse the JavaScript program state at point.
1560 Return a list of `js--pitem' instances that apply to point, most
1561 specific first. In the worst case, the current toplevel instance
1562 will be returned."
1572 ;; Loop until we either hit a pitem at BOB or pitem ends after
1573 ;; point (or at point if we're at eob)
1580 pstate))))
1583 "Return the JavaScript syntactic context corresponding to PSTATE."
1586 type)
1592 "Return the JavaScript syntactic context at point.
1593 When called interatively, also display a message with that
1594 context."
1602 syntactic-context))
1605 "Font lock function used by `js-mode'.
1606 This performs fontification according to `js--class-styles'."
1614 js-enabled-frameworks)
1617 decl-re
1620 and return t)
1621 return t
1626 js--font-lock-keywords-2
1627 js--font-lock-keywords-3)
1630 ;; XXX: Javascript can continue a regexp literal across lines so long
1631 ;; as the newline is escaped with \. Account for that in the regexp
1632 ;; below.
1635 "Regexp matching a JavaScript regular expression literal.
1636 Match groups 1 and 2 are the characters forming the beginning and
1639 ;; we want to match regular expressions only at the beginning of
1640 ;; expressions
1643 "Syntactic font lock keywords matching regexps in JavaScript.
1646 ;;; Indentation
1661 "Return non-nil if point is on a JavaScript operator, other than a comma."
1671 "Return non-nil if the current line continues an expression."
1688 Otherwise, return nil. A braceless do-while statement spanning
1689 several lines requires that the start of the loop is indented to
1690 the same column as the current line."
1712 "Helper function for `js--proper-indentation'.
1713 Return the proper indentation of the current line if it starts
1714 the body of a control statement without braces; otherwise, return
1715 nil."
1739 "Return the proper indentation for the current line."
1762 js-expr-indent-offset))
1775 "Indent the current line as JavaScript."
1785 ;;; Filling
1788 "Fill the paragraph with `c-fill-paragraph'."
1802 ;;; Type database and Imenu
1804 ;; We maintain a cache of semantic information, i.e., the classes and
1805 ;; functions we've encountered so far. In order to avoid having to
1806 ;; re-parse the buffer on every change, we cache the parse state at
1807 ;; each interesting point in the buffer. Each parse state is a
1808 ;; modified copy of the previous one, or in the case of the first
1809 ;; parse state, the empty state.
1810 ;;
1811 ;; The parse state itself is just a stack of js--pitem
1812 ;; instances. It starts off containing one element that is never
1813 ;; closed, that is initially js--initial-pitem.
1814 ;;
1822 name
1824 type
1828 "Helper function for `js--splice-into-items'.
1829 Return a new item that is the result of merging CHILD into
1830 ITEM. NAME-PARTS is a list of parts of the name of CHILD
1831 that we haven't consumed yet."
1836 ;; If the item we're merging into isn't a class, make it into one
1842 ;; Use the child's class-style if it's available
1844 js--dummy-class-style
1849 ;; Now we can merge either a function or a class into a class
1853 ;; if we have more name-parts to go before we get to the
1854 ;; bottom of the class hierarchy, call the merger
1855 ;; recursively
1861 ;; Not merging a class, but something else, so just prepend
1862 ;; it
1866 ;; Otherwise, merge the new child's items into those
1867 ;; of the new class
1873 "Last part of the name of PITEM, as a string or symbol."
1877 name)))
1880 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
1881 If a class doesn't exist in the tree, create it. Return
1882 the new items list. NAME-PARTS is a list of strings given
1883 the broken-down class name of the item to insert."
1887 new-items last-new-item new-cons item)
1890 name-parts
1896 ;; If top-name isn't found in items, then we build a copy of items
1897 ;; and throw it away. But that's okay, since most of the time, we
1898 ;; *will* find an instance.
1902 ;; Okay, we found an entry with the right name. Splice
1903 ;; the merged item into the list...
1906 name-parts)
1913 ;; ...and terminate the loop
1914 nil)
1917 ;; Otherwise, copy the current cons and move onto the
1918 ;; text. This is tricky; we keep track of the tail of
1919 ;; the list that begins with new-items in
1920 ;; last-new-item.
1927 ;; Go to the next cell in items
1931 ;; Yay! We stopped because we found something, not because
1932 ;; we ran out of items to search. Just return the new
1933 ;; list.
1936 new-items)
1938 ;; We didn't find anything. If the child is a class and we don't
1939 ;; have any classes to drill down into, just push that class;
1940 ;; otherwise, make a fake class and carry on.
1943 ;; We have name-parts left to process. Make a fake
1944 ;; class for this particular part...
1946 ;; ...and recursively digest the rest of the name
1949 :type js--dummy-class-style
1952 ;; Otherwise, this is the only name we have, so stick
1953 ;; the item on the front of the list
1954 child)
1955 items))))
1958 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
1963 t))
1965 ;; This trick works because we know (based on our defstructs) that
1966 ;; the child list is always the first element, and so the second
1967 ;; element and beyond can be shared when we make our "copy".
1974 ;; Use slow path because we need class lookup
1980 ;; Use slow path because we need class merging. We know
1981 ;; name is a list here because down in
1982 ;; `js--ensure-cache', we made sure to only add
1983 ;; class entries with lists for :name
1988 ;; Fast path
1994 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
1997 location))
2000 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2017 imenu-items))
2022 unknown-ctr))
2025 imenu-items))
2034 imenu-items))))
2038 imenu-items))
2041 "Return an imenu index for the current buffer."
2053 ;; Make sure everything is closed
2061 ;; Convert the new-finalized state into what imenu expects
2064 unknown-ctr))))))
2066 ;; Silence the compiler.
2077 symbols)
2078 else
2089 "Return a hash table of all JavaScript symbols.
2090 This searches all existing `js-mode' buffers. Each key is the
2091 name of a symbol (possibly disambiguated with <N>, where N > 1),
2092 and each value is a marker giving the location of that symbol."
2094 with imenu-use-markers = t
2095 for buffer being the buffers
2100 finally return symbols))
2106 "Helper function for `js-find-symbol'.
2107 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2108 one from `js--get-all-known-symbols', using prompt PROMPT and
2109 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2110 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2111 marker."
2117 prompt
2119 collect key)
2134 "Read a JavaScript symbol and jump to it.
2135 With a prefix argument, restrict symbols to those from the
2136 current buffer. Pushes a mark onto the tag ring just like
2137 `find-tag'."
2147 symbols "Jump to: "
2155 ;;; MozRepl integration
2165 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2166 On timeout, return nil. On success, return t with match data
2167 set. If START is non-nil, look for output starting from START.
2168 Otherwise, use the current value of `process-mark'."
2180 'js-moz-bad-rpc
2184 ;; Integer, mirrors the value we see in JS
2187 ;; Process to which this thing belongs
2208 ; */" Make Emacs happy
2209 "(function(repl) {
2210 repl.defineInteractor('js', {
2211 onStart: function onStart(repl) {
2212 if(!repl._jsObjects) {
2213 repl._jsObjects = {};
2214 repl._jsLastID = 0;
2215 repl._jsGC = this._jsGC;
2216 }
2217 this._input = '';
2218 },
2220 _jsGC: function _jsGC(ids_in_use) {
2221 var objects = this._jsObjects;
2222 var keys = [];
2223 var num_freed = 0;
2225 for(var pn in objects) {
2226 keys.push(Number(pn));
2227 }
2229 keys.sort(function(x, y) x - y);
2230 ids_in_use.sort(function(x, y) x - y);
2231 var i = 0;
2232 var j = 0;
2234 while(i < ids_in_use.length && j < keys.length) {
2235 var id = ids_in_use[i++];
2236 while(j < keys.length && keys[j] !== id) {
2237 var k_id = keys[j++];
2238 delete objects[k_id];
2239 ++num_freed;
2240 }
2241 ++j;
2242 }
2244 while(j < keys.length) {
2245 var k_id = keys[j++];
2246 delete objects[k_id];
2247 ++num_freed;
2248 }
2250 return num_freed;
2251 },
2253 _mkArray: function _mkArray() {
2254 var result = [];
2255 for(var i = 0; i < arguments.length; ++i) {
2256 result.push(arguments[i]);
2257 }
2258 return result;
2259 },
2261 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2262 if(typeof parts === 'string') {
2263 parts = [ parts ];
2264 }
2266 var obj = parts[0];
2267 var start = 1;
2269 if(typeof obj === 'string') {
2270 obj = window;
2271 start = 0;
2272 } else if(parts.length < 2) {
2273 throw new Error('expected at least 2 arguments');
2274 }
2276 for(var i = start; i < parts.length - 1; ++i) {
2277 obj = obj[parts[i]];
2278 }
2280 return [obj, parts[parts.length - 1]];
2281 },
2283 _getProp: function _getProp(/*...*/) {
2284 if(arguments.length === 0) {
2285 throw new Error('no arguments supplied to getprop');
2286 }
2288 if(arguments.length === 1 &&
2289 (typeof arguments[0]) !== 'string')
2290 {
2291 return arguments[0];
2292 }
2294 var [obj, propname] = this._parsePropDescriptor(arguments);
2295 return obj[propname];
2296 },
2298 _putProp: function _putProp(properties, value) {
2299 var [obj, propname] = this._parsePropDescriptor(properties);
2300 obj[propname] = value;
2301 },
2303 _delProp: function _delProp(propname) {
2304 var [obj, propname] = this._parsePropDescriptor(arguments);
2305 delete obj[propname];
2306 },
2308 _typeOf: function _typeOf(thing) {
2309 return typeof thing;
2310 },
2312 _callNew: function(constructor) {
2313 if(typeof constructor === 'string')
2314 {
2315 constructor = window[constructor];
2316 } else if(constructor.length === 1 &&
2317 typeof constructor[0] !== 'string')
2318 {
2319 constructor = constructor[0];
2320 } else {
2321 var [obj,propname] = this._parsePropDescriptor(constructor);
2322 constructor = obj[propname];
2323 }
2325 /* Hacky, but should be robust */
2326 var s = 'new constructor(';
2327 for(var i = 1; i < arguments.length; ++i) {
2328 if(i != 1) {
2329 s += ',';
2330 }
2332 s += 'arguments[' + i + ']';
2333 }
2335 s += ')';
2336 return eval(s);
2337 },
2339 _callEval: function(thisobj, js) {
2340 return eval.call(thisobj, js);
2341 },
2343 getPrompt: function getPrompt(repl) {
2344 return 'EVAL>'
2345 },
2347 _lookupObject: function _lookupObject(repl, id) {
2348 if(typeof id === 'string') {
2349 switch(id) {
2350 case 'global':
2351 return window;
2352 case 'nil':
2353 return null;
2354 case 't':
2355 return true;
2356 case 'false':
2357 return false;
2358 case 'undefined':
2359 return undefined;
2360 case 'repl':
2361 return repl;
2362 case 'interactor':
2363 return this;
2364 case 'NaN':
2365 return NaN;
2366 case 'Infinity':
2367 return Infinity;
2368 case '-Infinity':
2369 return -Infinity;
2370 default:
2371 throw new Error('No object with special id:' + id);
2372 }
2373 }
2375 var ret = repl._jsObjects[id];
2376 if(ret === undefined) {
2377 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2378 }
2379 return ret;
2380 },
2382 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2383 if(typeof value !== 'object' && typeof value !== 'function') {
2384 throw new Error('_findOrAllocateObject called on non-object('
2385 + typeof(value) + '): '
2386 + value)
2387 }
2389 for(var id in repl._jsObjects) {
2390 id = Number(id);
2391 var obj = repl._jsObjects[id];
2392 if(obj === value) {
2393 return id;
2394 }
2395 }
2397 var id = ++repl._jsLastID;
2398 repl._jsObjects[id] = value;
2399 return id;
2400 },
2402 _fixupList: function _fixupList(repl, list) {
2403 for(var i = 0; i < list.length; ++i) {
2404 if(list[i] instanceof Array) {
2405 this._fixupList(repl, list[i]);
2406 } else if(typeof list[i] === 'object') {
2407 var obj = list[i];
2408 if(obj.funcall) {
2409 var parts = obj.funcall;
2410 this._fixupList(repl, parts);
2411 var [thisobj, func] = this._parseFunc(parts[0]);
2412 list[i] = func.apply(thisobj, parts.slice(1));
2413 } else if(obj.objid) {
2414 list[i] = this._lookupObject(repl, obj.objid);
2415 } else {
2416 throw new Error('Unknown object type: ' + obj.toSource());
2417 }
2418 }
2419 }
2420 },
2422 _parseFunc: function(func) {
2423 var thisobj = null;
2425 if(typeof func === 'string') {
2426 func = window[func];
2427 } else if(func instanceof Array) {
2428 if(func.length === 1 && typeof func[0] !== 'string') {
2429 func = func[0];
2430 } else {
2431 [thisobj, func] = this._parsePropDescriptor(func);
2432 func = thisobj[func];
2433 }
2434 }
2436 return [thisobj,func];
2437 },
2439 _encodeReturn: function(value, array_as_mv) {
2440 var ret;
2442 if(value === null) {
2443 ret = ['special', 'null'];
2444 } else if(value === true) {
2445 ret = ['special', 'true'];
2446 } else if(value === false) {
2447 ret = ['special', 'false'];
2448 } else if(value === undefined) {
2449 ret = ['special', 'undefined'];
2450 } else if(typeof value === 'number') {
2451 if(isNaN(value)) {
2452 ret = ['special', 'NaN'];
2453 } else if(value === Infinity) {
2454 ret = ['special', 'Infinity'];
2455 } else if(value === -Infinity) {
2456 ret = ['special', '-Infinity'];
2457 } else {
2458 ret = ['atom', value];
2459 }
2460 } else if(typeof value === 'string') {
2461 ret = ['atom', value];
2462 } else if(array_as_mv && value instanceof Array) {
2463 ret = ['array', value.map(this._encodeReturn, this)];
2464 } else {
2465 ret = ['objid', this._findOrAllocateObject(repl, value)];
2466 }
2468 return ret;
2469 },
2471 _handleInputLine: function _handleInputLine(repl, line) {
2472 var ret;
2473 var array_as_mv = false;
2475 try {
2476 if(line[0] === '*') {
2477 array_as_mv = true;
2478 line = line.substring(1);
2479 }
2480 var parts = eval(line);
2481 this._fixupList(repl, parts);
2482 var [thisobj, func] = this._parseFunc(parts[0]);
2483 ret = this._encodeReturn(
2484 func.apply(thisobj, parts.slice(1)),
2485 array_as_mv);
2486 } catch(x) {
2487 ret = ['error', x.toString() ];
2488 }
2490 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2491 repl.print(JSON.encode(ret));
2492 repl._prompt();
2493 },
2495 handleInput: function handleInput(repl, chunk) {
2496 this._input += chunk;
2497 var match, line;
2499 line = match[0];
2502 repl.popInteractor();
2503 repl._prompt();
2504 return;
2505 }
2507 this._input = this._input.substring(line.length);
2508 this._handleInputLine(repl, line);
2509 }
2510 }
2511 });
2512 })
2518 "Marshall the given value for JS.
2519 Strings and numbers are JSON-encoded. Lists (including nil) are
2520 made into JavaScript array literals and their contents encoded
2521 with `js--js-encode-value'."
2548 js--js-repl-prompt-regexp js-js-timeout
2550 ;; start matching against the beginning of the line in
2551 ;; order to catch a prompt that's only partially arrived
2559 ;; Do some initialization the first time we see a process
2565 ;; Send interactor definition
2571 js-js-timeout))
2573 ;; Sanity check
2579 ;; If js--js-repl-depth > 0, we *should* be seeing an
2580 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2581 ;; up with us.
2584 ;; Otherwise, tell Mozilla to enter the interactor mode
2590 js-js-timeout))
2604 js-js-timeout))))
2614 "Convert immediate js< and js! references to deferred ones."
2638 function))
2640 else
2641 collect item)))
2656 "Run FORMS with the Mozilla repl set up for js commands.
2657 Inside the lexical scope of `with-js', `js?', `js!',
2658 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2659 `js-create-instance', and `js-qi' are defined."
2670 function)
2678 function)
2710 props)
2712 ))
2718 "Whether to listify any Array returned by a Mozilla function.
2729 js--js-references)
2734 js--js-references)))
2739 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2740 If function is a string, look it up as a property on the global
2741 object and use the global object for `this'.
2742 If FUNCTION is a list with one element, use that element as the
2743 function with the global object for `this', except that if that
2744 single element is a string, look it up on the global object.
2745 If FUNCTION is a list with more than one argument, use the list
2746 up to the last value as a property descriptor and the last
2747 argument as a function."
2754 ;; Actual funcall
2761 js-js-timeout)
2764 ;; Read the result
2771 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
2772 CONSTRUCTOR is a JS handle, a string, or a list of these things."
2775 constructor arguments))
2781 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
2784 arguments)))
2793 "Tell the repl about any objects we don't reference anymore.
2794 With argument, run even if no intervening GC has happened."
2805 ;; Don't bother running unless we've had an intervening
2806 ;; garbage collection; without a gc, nothing is deleted
2807 ;; from the weak hash table, so it's pointless telling
2808 ;; MozRepl about that references we still hold
2811 ;; Are we looking at a normal prompt? Make sure not to
2812 ;; interrupt the user if he's doing something
2820 of js--js-references
2821 collect x))
2828 num)))
2833 "Evaluate the JavaScript in JS and return JSON-decoded result."
2841 result)))
2844 "Enumerate all JavaScript contexts available.
2845 Each context is a list:
2846 (TITLE URL BROWSER TAB TABBROWSER) for content documents
2847 (TITLE URL WINDOW) for windows
2849 All tabs of a given window are grouped together. The most recent
2850 window is first. Within each window, the tabs are returned
2851 left-to-right."
2856 "@mozilla.org/appshell/window-mediator;1"
2878 window)
2885 "browsers"
2886 x
2887 "contentDocument"
2891 "browsers"
2892 x
2893 "contentWindow"
2894 "location"
2897 "browsers"
2898 x)
2901 "tabContainer"
2902 "childNodes"
2904 x)
2906 gbrowser))))))
2911 "Read a Mozilla tab with prompt PROMPT.
2912 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
2913 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
2914 browser, respectively."
2916 ;; Prime IDO
2923 selected-tab prev-hitab)
2925 ;; Disambiguate names
2927 for tab in tabs
2943 ;; Hack to reduce the number of
2944 ;; round-trips to mozilla
2947 ;; Highlighting tab
2950 "style"
2952 cmds)
2954 ;; Highlight window proper
2957 "style"
2959 cmds)
2961 ;; Select tab, when appropriate
2965 cmds)))
2967 ;; Hilighting whole window
2971 "style"
2974 cmds)))
2977 ;; Unhighlighting tab
2980 cmds)
2982 cmds))
2984 ;; Unhighlighting window
2989 cmds)))
2995 ()
3001 ()
3002 ;; Fiddle with the match list a bit: if our first match
3003 ;; is a tabbrowser window, rotate the match list until
3004 ;; the active tab comes up
3010 "document"
3011 "documentElement"
3016 "gBrowser"
3020 for match in ido-matches
3024 and return t)))
3034 prompt
3036 nil t nil
3054 "Helper function for `js-eval-defun'.
3055 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3056 strings making up the class name and NAME is the name of the
3057 function part."
3076 "The current JavaScript context.
3077 This is a cons like the one returned from `js--read-tab'.
3081 "(function(func_info,func) {
3082 func_info.unshift('window');
3083 var obj = window;
3084 for(var i = 1; i < func_info.length - 1; ++i) {
3085 var next = obj[func_info[i]];
3086 if(typeof next !== 'object' && typeof next !== 'function') {
3087 next = obj.prototype && obj.prototype[func_info[i]];
3088 if(typeof next !== 'object' && typeof next !== 'function') {
3089 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3090 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3091 return;
3092 }
3094 func_info.splice(i+1, 0, 'prototype');
3095 ++i;
3096 }
3097 }
3099 obj[func_info[i]] = func;
3100 alert('Successfully updated '+func_info.join('.'));
3104 "Set the JavaScript context to CONTEXT.
3105 When called interactively, prompt for CONTEXT."
3110 "Return a valid JavaScript context.
3111 If one hasn't been set, or if it's stale, prompt for a new one."
3120 js--js-context))
3134 file)))
3147 "Update a Mozilla tab using the JavaScript defun at point."
3150 ;; This function works by generating a temporary file that contains
3151 ;; the function we'd like to insert. We then use the elisp-js bridge
3152 ;; to command mozilla to load this file by inserting a script tag
3153 ;; into the document we set. This way, debuggers and such will have
3154 ;; a way to find the source of the just-inserted function.
3155 ;;
3156 ;; We delete the temporary file if there's an error, but otherwise
3157 ;; we add an unload event listener on the Mozilla side to delete the
3158 ;; file.
3189 ;; (Re)register a Mozilla resource URL to point to the
3190 ;; temporary directory
3208 ;; Give Mozilla responsibility for deleting this file
3213 ;; Regular content
3217 ;; Chrome
3239 ))
3241 ;; temp-name is set to nil on success
3245 ;;; Main Function
3247 ;;;###autoload
3249 "Major mode for editing JavaScript.
3251 Key bindings:
3256 :syntax-table js-mode-syntax-table
3267 nil nil nil nil
3269 . js-font-lock-syntactic-keywords)))
3276 ;; Comments
3282 ;; Parse cache
3285 ;; Frameworks
3288 ;; Imenu
3296 ;; for filling, pretend we're cc-mode
3298 c-paragraph-start "$"
3299 c-paragraph-separate "$"
3300 c-block-comment-prefix "* "
3301 c-line-comment-starter "//"
3311 ;; Important to fontify the whole buffer syntactically! If we don't,
3312 ;; then we might have regular expression literals that aren't marked
3313 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3314 ;; etc. and and produce maddening "unbalanced parenthesis" errors.
3315 ;; When we attempt to find the error and scroll to the portion of
3316 ;; the buffer containing the problem, JIT-lock will apply the
3317 ;; correct syntax to the regular expresion literal and the problem
3318 ;; will mysteriously disappear.
3332 ;; arch-tag: 1a0d0409-e87f-4fc7-a58c-3731c66ddaac
3333 ;; js.el ends here