| blob | cdc3ef1c2e0845244826150a729e89ebc226fb9d |
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
244 for style in js--class-styles
247 collect framework into available-frameworks
248 finally return available-frameworks)
254 "Regexp matching the start of a JavaScript function header.
260 "Regexp matching the start of a function entry in an associative array.
272 "Regexp matching a CPP macro definition, up to the opening parenthesis.
322 ;; js--pitem is the basic building block of the lexical
323 ;; database. When one refers to a real part of the buffer, the region
324 ;; of text to which it refers is split into a conceptual header and
325 ;; body. Consider the (very short) block described by a hypothetical
326 ;; js--pitem:
327 ;;
328 ;; function foo(a,b,c) { return 42; }
329 ;; ^ ^ ^
330 ;; | | |
331 ;; +- h-begin +- h-end +- b-end
332 ;;
333 ;; (Remember that these are buffer positions, and therefore point
334 ;; between characters, not at them. An arrow drawn to a character
335 ;; indicates the corresponding position is between that character and
336 ;; the one immediately preceding it.)
337 ;;
338 ;; The header is the region of text [h-begin, h-end], and is
339 ;; the text needed to unambiguously recognize the start of the
340 ;; construct. If the entire header is not present, the construct is
341 ;; not recognized at all. No other pitems may be nested inside the
342 ;; header.
343 ;;
344 ;; The body is the region [h-end, b-end]. It may contain nested
345 ;; js--pitem instances. The body of a pitem may be empty: in
346 ;; that case, b-end is equal to header-end.
347 ;;
348 ;; The three points obey the following relationship:
349 ;;
350 ;; h-begin < h-end <= b-end
351 ;;
352 ;; We put a text property in the buffer on the character *before*
353 ;; h-end, and if we see it, on the character *before* b-end.
354 ;;
355 ;; The text property for h-end, js--pstate, is actually a list
356 ;; of all js--pitem instances open after the marked character.
357 ;;
358 ;; The text property for b-end, js--pend, is simply the
359 ;; js--pitem that ends after the marked character. (Because
360 ;; pitems always end when the paren-depth drops below a critical
361 ;; value, and because we can only drop one level per character, only
362 ;; one pitem may end at a given character.)
363 ;;
364 ;; In the structure below, we only store h-begin and (sometimes)
365 ;; b-end. We can trivially and quickly find h-end by going to h-begin
366 ;; and searching for an js--pstate text property. Since no other
367 ;; js--pitem instances can be nested inside the header of a
368 ;; pitem, the location after the character with this text property
369 ;; must be h-end.
370 ;;
371 ;; js--pitem instances are never modified (with the exception
372 ;; of the b-end field). Instead, modified copies are added at
373 ;; subsequence parse points.
374 ;; (The exception for b-end and its caveats is described below.)
375 ;;
378 ;; IMPORTANT: Do not alter the position of fields within the list.
379 ;; Various bits of code depend on their positions, particularly
380 ;; anything that manipulates the list of children.
382 ;; List of children inside this pitem's body
385 ;; When we reach this paren depth after h-end, the pitem ends
388 ;; Symbol or class-style plist if this is a class
391 ;; See above
394 ;; List of strings giving the parts of the name of this pitem (e.g.,
395 ;; '("MyClass" "myMethod"), or t if this pitem is anonymous
398 ;; THIS FIELD IS MUTATED, and its value is shared by all copies of
399 ;; this pitem: when we copy-and-modify pitem instances, we share
400 ;; their tail structures, so all the copies actually have the same
401 ;; terminating cons cell. We modify that shared cons cell directly.
402 ;;
403 ;; The field value is either a number (buffer location) or nil if
404 ;; unknown.
405 ;;
406 ;; If the field's value is greater than `js--cache-end', the
407 ;; value is stale and must be treated as if it were nil. Conversely,
408 ;; if this field is nil, it is guaranteed that this pitem is open up
409 ;; to at least `js--cache-end'. (This property is handy when
410 ;; computing whether we're inside a given pitem.)
411 ;;
414 ;; The pitem we start parsing with.
417 :paren-depth most-negative-fixnum
420 ;;; User Customization
423 "Customization variables for JavaScript mode."
428 "Number of spaces for each indentation step in `js-mode'."
433 "Number of additional spaces for indenting continued expressions.
434 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'."
446 "Number of additional spaces for indenting expressions in square braces.
447 The value must be no less than minus `js-indent-level'."
453 "Number of additional spaces for indenting expressions in curly braces.
454 The value must be no less than minus `js-indent-level'."
460 "Whether to automatically indent when typing punctuation characters.
461 If non-nil, the characters {}();,: also indent the current line
462 in Javascript mode."
467 "Treat nested functions as top-level functions in `js-mode'.
468 This applies to function movement, marking, and so on."
473 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
478 "Frameworks recognized by `js-mode'.
479 To improve performance, you may turn off some frameworks you
480 seldom use, either globally or on a per-buffer basis."
483 js--available-frameworks))
488 "Whether `js-mode' should display tabs while selecting them.
489 This is useful only if the windowing system has a good mechanism
490 for preventing Firefox from stealing the keyboard focus."
495 "~/.emacs.d/js/js"
496 "Temporary directory used by `js-mode' to communicate with Mozilla.
497 This directory must be readable and writable by both Mozilla and Emacs."
502 "Reply timeout for executing commands in Mozilla via `js-mode'.
503 The value is given in seconds. Increase this value if you are
504 getting timeout messages."
508 ;;; KeyMap
524 keymap)
527 ;;; Syntax table and parsing
533 table)
564 "Helper function for `js--update-quick-match-re'.
565 If LIST contains any element that is not nil, return its non-nil
566 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
567 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
568 nil. If any element in LIST is itself a list, flatten that
569 element."
575 "Internal function used by `js-mode' for caching buffer constructs.
576 This updates `js--quick-match-re', based on the current set of
577 enabled frameworks."
582 ;; #define mumble
591 ;; var mumble = THING (
612 ;; mumble.prototypeTHING
620 ;; mumble.prototype = {
627 "Move over the next value of PROPNAME in the buffer.
628 If found, return that value and leave point after the character
629 having that value; otherwise, return nil and leave point at EOB."
640 next-value))
643 "Move over the previous value of PROPNAME in the buffer.
644 If found, return that value and leave point just before the
645 character that has that value, otherwise return nil and leave
646 point at BOB."
659 prev-value)))
672 "Helper function for `js--re-search-forward'."
674 str-terminator
703 "Search forward, ignoring strings, cpp macros, and comments.
704 This function invokes `re-search-forward', but treats the buffer
705 as if strings, cpp macros, and comments have been removed.
707 If invoked while inside a macro, it treats the contents of the
708 macro as normal text."
725 "Auxiliary function for `js--re-search-backward'."
727 str-terminator
758 "Search backward, ignoring strings, preprocessor macros, and comments.
760 This function invokes `re-search-backward' but treats the buffer
761 as if strings, preprocessor macros, and comments have been
762 removed.
764 If invoked while inside a macro, treat the macro as normal text."
768 "Move forward over a whole JavaScript expression.
769 This function doesn't move over expressions continued across
770 lines."
772 ;; non-continued case; simplistic, but good enough?
785 "Move forward over a JavaScript function declaration.
786 This puts point at the 'function' keyword.
788 If this is a syntactically-correct non-expression function,
789 return the name of the function, or t if the name could not be
790 determined. Otherwise, return nil."
803 name)))))
806 "Return the start of the JavaScript function prologue containing POS.
807 A function prologue is everything from start of the definition up
808 to and including the opening brace. POS defaults to point.
809 If POS is not in a function prologue, return nil."
836 "Helper function for `js-beginning-of-defun'.
837 Go to previous defun-beginning and return the parse state for it,
838 or nil if we went all the way back to bob and don't find
839 anything."
847 "Helper function for `js--beginning-of-defun-nested'.
848 If PSTATE represents a non-empty top-level defun, return the
849 top-most pitem. Otherwise, return nil."
852 with func-pitem
859 "Helper function for `js--beginning-of-defun'.
860 Return the pitem of the function we went to the beginning of."
862 ;; Look for the smallest function that encloses point...
867 and return pitem)
869 ;; ...and if that isn't found, look for the previous top-level
870 ;; defun
872 while pstate
875 and return it)))
878 "Helper function for `js-beginning-of-defun'."
884 "Value of `beginning-of-defun-function' for `js-mode'."
900 ;; If we're just past the end of a function, the user probably wants
901 ;; to go to the beginning of *that* function
915 "Flush the `js-mode' syntax cache after position BEG.
916 BEG defaults to `point-min', meaning to flush the entire cache."
922 ;; `(message ,@arguments)
923 )
932 ;; open-items must contain at least two items for this to
933 ;; work, but because we push a dummy item to start with,
934 ;; that assumption holds.
937 open-items)
940 "Helper function for `js--ensure-cache'.
941 Update parsing information up to point, referring to parse,
942 prev-parse-point, goal-point, and open-items bound lexically in
943 the body of `js--ensure-cache'."
950 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
951 ;; the given depth -- i.e., make sure we're deeper than the target
952 ;; depth.
956 prev-parse-point goal-point
958 nil parse))
960 ;; (let ((overlay (make-overlay prev-parse-point (point))))
961 ;; (overlay-put overlay 'face '(:background "red"))
962 ;; (unwind-protect
963 ;; (progn
964 ;; (js--debug "parsed: %S" parse)
965 ;; (sit-for 1))
966 ;; (delete-overlay overlay)))
982 "Split a JavaScript name into its dot-separated parts.
983 This also removes any prototype parts from the split name
995 "Guess the name of the JavaScript function at POSITION.
997 Return the name of the function, or nil if the name could not be
998 guessed.
1000 This function clobbers match data. If we find the preamble
1001 begins earlier than expected while guessing the function name,
1002 set `js--guess-function-name-start' to that position; otherwise,
1003 set that variable to nil."
1020 ;; Clear any endings that occur after point
1027 ;; Remove any cache properties after this point
1032 "Ensures brace cache is valid up to the character before LIMIT.
1033 LIMIT defaults to point."
1039 parse
1040 prev-parse-point
1041 name
1042 case-fold-search
1043 filtered-class-styles
1044 goal-point)
1046 ;; Figure out which class styles we need to look for
1050 js-enabled-frameworks)
1051 collect style))
1057 ;; Find last known good position
1073 ;; Make a placeholder for the top-level definition
1089 ;; Each of these conditions should return non-nil if
1090 ;; we should add a new item and leave point at the end
1091 ;; of the new item's header (h-end in the
1092 ;; js--pitem diagram). This point is the one
1093 ;; after the last character we need to unambiguously
1094 ;; detect this construct. If one of these evaluates to
1095 ;; nil, the location of the point is ignored.
1097 ;; In comment or string
1100 ;; Regular function declaration
1109 js--guess-function-name-start))
1116 :paren-depth orig-depth
1117 :h-begin orig-match-start
1120 name
1123 ;; Macro
1126 ;; Macros often contain unbalanced parentheses.
1127 ;; Make sure that h-end is at the textual end of
1128 ;; the macro no matter what the parenthesis say.
1134 :h-begin orig-match-start
1138 ;; "Prototype function" declaration
1145 :paren-depth orig-depth
1146 :h-begin orig-match-start
1152 ;; Class definition
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'."
1836 ;;; Type database and Imenu
1838 ;; We maintain a cache of semantic information, i.e., the classes and
1839 ;; functions we've encountered so far. In order to avoid having to
1840 ;; re-parse the buffer on every change, we cache the parse state at
1841 ;; each interesting point in the buffer. Each parse state is a
1842 ;; modified copy of the previous one, or in the case of the first
1843 ;; parse state, the empty state.
1844 ;;
1845 ;; The parse state itself is just a stack of js--pitem
1846 ;; instances. It starts off containing one element that is never
1847 ;; closed, that is initially js--initial-pitem.
1848 ;;
1856 name
1858 type
1862 "Helper function for `js--splice-into-items'.
1863 Return a new item that is the result of merging CHILD into
1864 ITEM. NAME-PARTS is a list of parts of the name of CHILD
1865 that we haven't consumed yet."
1870 ;; If the item we're merging into isn't a class, make it into one
1876 ;; Use the child's class-style if it's available
1878 js--dummy-class-style
1883 ;; Now we can merge either a function or a class into a class
1887 ;; if we have more name-parts to go before we get to the
1888 ;; bottom of the class hierarchy, call the merger
1889 ;; recursively
1895 ;; Not merging a class, but something else, so just prepend
1896 ;; it
1900 ;; Otherwise, merge the new child's items into those
1901 ;; of the new class
1907 "Last part of the name of PITEM, as a string or symbol."
1911 name)))
1914 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
1915 If a class doesn't exist in the tree, create it. Return
1916 the new items list. NAME-PARTS is a list of strings given
1917 the broken-down class name of the item to insert."
1921 new-items last-new-item new-cons)
1924 name-parts
1930 ;; If top-name isn't found in items, then we build a copy of items
1931 ;; and throw it away. But that's okay, since most of the time, we
1932 ;; *will* find an instance.
1936 ;; Okay, we found an entry with the right name. Splice
1937 ;; the merged item into the list...
1940 name-parts)
1947 ;; ...and terminate the loop
1948 nil)
1951 ;; Otherwise, copy the current cons and move onto the
1952 ;; text. This is tricky; we keep track of the tail of
1953 ;; the list that begins with new-items in
1954 ;; last-new-item.
1961 ;; Go to the next cell in items
1965 ;; Yay! We stopped because we found something, not because
1966 ;; we ran out of items to search. Just return the new
1967 ;; list.
1970 new-items)
1972 ;; We didn't find anything. If the child is a class and we don't
1973 ;; have any classes to drill down into, just push that class;
1974 ;; otherwise, make a fake class and carry on.
1977 ;; We have name-parts left to process. Make a fake
1978 ;; class for this particular part...
1980 ;; ...and recursively digest the rest of the name
1983 :type js--dummy-class-style
1986 ;; Otherwise, this is the only name we have, so stick
1987 ;; the item on the front of the list
1988 child)
1989 items))))
1992 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
1997 t))
1999 ;; This trick works because we know (based on our defstructs) that
2000 ;; the child list is always the first element, and so the second
2001 ;; element and beyond can be shared when we make our "copy".
2008 ;; Use slow path because we need class lookup
2014 ;; Use slow path because we need class merging. We know
2015 ;; name is a list here because down in
2016 ;; `js--ensure-cache', we made sure to only add
2017 ;; class entries with lists for :name
2022 ;; Fast path
2028 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2031 location))
2034 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2051 imenu-items))
2056 unknown-ctr))
2059 imenu-items))
2068 imenu-items))))
2072 imenu-items))
2075 "Return an imenu index for the current buffer."
2087 ;; Make sure everything is closed
2095 ;; Convert the new-finalized state into what imenu expects
2098 unknown-ctr))))))
2100 ;; Silence the compiler.
2111 symbols)
2112 else
2123 "Return a hash table of all JavaScript symbols.
2124 This searches all existing `js-mode' buffers. Each key is the
2125 name of a symbol (possibly disambiguated with <N>, where N > 1),
2126 and each value is a marker giving the location of that symbol."
2128 with imenu-use-markers = t
2129 for buffer being the buffers
2134 finally return symbols))
2140 "Helper function for `js-find-symbol'.
2141 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2142 one from `js--get-all-known-symbols', using prompt PROMPT and
2143 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2144 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2145 marker."
2151 prompt
2153 collect key)
2170 "Read a JavaScript symbol and jump to it.
2171 With a prefix argument, restrict symbols to those from the
2172 current buffer. Pushes a mark onto the tag ring just like
2173 `find-tag'."
2184 symbols "Jump to: "
2192 ;;; MozRepl integration
2202 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2203 On timeout, return nil. On success, return t with match data
2204 set. If START is non-nil, look for output starting from START.
2205 Otherwise, use the current value of `process-mark'."
2217 'js-moz-bad-rpc
2221 ;; Integer, mirrors the value we see in JS
2224 ;; Process to which this thing belongs
2245 ; */" Make Emacs happy
2246 "(function(repl) {
2247 repl.defineInteractor('js', {
2248 onStart: function onStart(repl) {
2249 if(!repl._jsObjects) {
2250 repl._jsObjects = {};
2251 repl._jsLastID = 0;
2252 repl._jsGC = this._jsGC;
2253 }
2254 this._input = '';
2255 },
2257 _jsGC: function _jsGC(ids_in_use) {
2258 var objects = this._jsObjects;
2259 var keys = [];
2260 var num_freed = 0;
2262 for(var pn in objects) {
2263 keys.push(Number(pn));
2264 }
2266 keys.sort(function(x, y) x - y);
2267 ids_in_use.sort(function(x, y) x - y);
2268 var i = 0;
2269 var j = 0;
2271 while(i < ids_in_use.length && j < keys.length) {
2272 var id = ids_in_use[i++];
2273 while(j < keys.length && keys[j] !== id) {
2274 var k_id = keys[j++];
2275 delete objects[k_id];
2276 ++num_freed;
2277 }
2278 ++j;
2279 }
2281 while(j < keys.length) {
2282 var k_id = keys[j++];
2283 delete objects[k_id];
2284 ++num_freed;
2285 }
2287 return num_freed;
2288 },
2290 _mkArray: function _mkArray() {
2291 var result = [];
2292 for(var i = 0; i < arguments.length; ++i) {
2293 result.push(arguments[i]);
2294 }
2295 return result;
2296 },
2298 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2299 if(typeof parts === 'string') {
2300 parts = [ parts ];
2301 }
2303 var obj = parts[0];
2304 var start = 1;
2306 if(typeof obj === 'string') {
2307 obj = window;
2308 start = 0;
2309 } else if(parts.length < 2) {
2310 throw new Error('expected at least 2 arguments');
2311 }
2313 for(var i = start; i < parts.length - 1; ++i) {
2314 obj = obj[parts[i]];
2315 }
2317 return [obj, parts[parts.length - 1]];
2318 },
2320 _getProp: function _getProp(/*...*/) {
2321 if(arguments.length === 0) {
2322 throw new Error('no arguments supplied to getprop');
2323 }
2325 if(arguments.length === 1 &&
2326 (typeof arguments[0]) !== 'string')
2327 {
2328 return arguments[0];
2329 }
2331 var [obj, propname] = this._parsePropDescriptor(arguments);
2332 return obj[propname];
2333 },
2335 _putProp: function _putProp(properties, value) {
2336 var [obj, propname] = this._parsePropDescriptor(properties);
2337 obj[propname] = value;
2338 },
2340 _delProp: function _delProp(propname) {
2341 var [obj, propname] = this._parsePropDescriptor(arguments);
2342 delete obj[propname];
2343 },
2345 _typeOf: function _typeOf(thing) {
2346 return typeof thing;
2347 },
2349 _callNew: function(constructor) {
2350 if(typeof constructor === 'string')
2351 {
2352 constructor = window[constructor];
2353 } else if(constructor.length === 1 &&
2354 typeof constructor[0] !== 'string')
2355 {
2356 constructor = constructor[0];
2357 } else {
2358 var [obj,propname] = this._parsePropDescriptor(constructor);
2359 constructor = obj[propname];
2360 }
2362 /* Hacky, but should be robust */
2363 var s = 'new constructor(';
2364 for(var i = 1; i < arguments.length; ++i) {
2365 if(i != 1) {
2366 s += ',';
2367 }
2369 s += 'arguments[' + i + ']';
2370 }
2372 s += ')';
2373 return eval(s);
2374 },
2376 _callEval: function(thisobj, js) {
2377 return eval.call(thisobj, js);
2378 },
2380 getPrompt: function getPrompt(repl) {
2381 return 'EVAL>'
2382 },
2384 _lookupObject: function _lookupObject(repl, id) {
2385 if(typeof id === 'string') {
2386 switch(id) {
2387 case 'global':
2388 return window;
2389 case 'nil':
2390 return null;
2391 case 't':
2392 return true;
2393 case 'false':
2394 return false;
2395 case 'undefined':
2396 return undefined;
2397 case 'repl':
2398 return repl;
2399 case 'interactor':
2400 return this;
2401 case 'NaN':
2402 return NaN;
2403 case 'Infinity':
2404 return Infinity;
2405 case '-Infinity':
2406 return -Infinity;
2407 default:
2408 throw new Error('No object with special id:' + id);
2409 }
2410 }
2412 var ret = repl._jsObjects[id];
2413 if(ret === undefined) {
2414 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2415 }
2416 return ret;
2417 },
2419 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2420 if(typeof value !== 'object' && typeof value !== 'function') {
2421 throw new Error('_findOrAllocateObject called on non-object('
2422 + typeof(value) + '): '
2423 + value)
2424 }
2426 for(var id in repl._jsObjects) {
2427 id = Number(id);
2428 var obj = repl._jsObjects[id];
2429 if(obj === value) {
2430 return id;
2431 }
2432 }
2434 var id = ++repl._jsLastID;
2435 repl._jsObjects[id] = value;
2436 return id;
2437 },
2439 _fixupList: function _fixupList(repl, list) {
2440 for(var i = 0; i < list.length; ++i) {
2441 if(list[i] instanceof Array) {
2442 this._fixupList(repl, list[i]);
2443 } else if(typeof list[i] === 'object') {
2444 var obj = list[i];
2445 if(obj.funcall) {
2446 var parts = obj.funcall;
2447 this._fixupList(repl, parts);
2448 var [thisobj, func] = this._parseFunc(parts[0]);
2449 list[i] = func.apply(thisobj, parts.slice(1));
2450 } else if(obj.objid) {
2451 list[i] = this._lookupObject(repl, obj.objid);
2452 } else {
2453 throw new Error('Unknown object type: ' + obj.toSource());
2454 }
2455 }
2456 }
2457 },
2459 _parseFunc: function(func) {
2460 var thisobj = null;
2462 if(typeof func === 'string') {
2463 func = window[func];
2464 } else if(func instanceof Array) {
2465 if(func.length === 1 && typeof func[0] !== 'string') {
2466 func = func[0];
2467 } else {
2468 [thisobj, func] = this._parsePropDescriptor(func);
2469 func = thisobj[func];
2470 }
2471 }
2473 return [thisobj,func];
2474 },
2476 _encodeReturn: function(value, array_as_mv) {
2477 var ret;
2479 if(value === null) {
2480 ret = ['special', 'null'];
2481 } else if(value === true) {
2482 ret = ['special', 'true'];
2483 } else if(value === false) {
2484 ret = ['special', 'false'];
2485 } else if(value === undefined) {
2486 ret = ['special', 'undefined'];
2487 } else if(typeof value === 'number') {
2488 if(isNaN(value)) {
2489 ret = ['special', 'NaN'];
2490 } else if(value === Infinity) {
2491 ret = ['special', 'Infinity'];
2492 } else if(value === -Infinity) {
2493 ret = ['special', '-Infinity'];
2494 } else {
2495 ret = ['atom', value];
2496 }
2497 } else if(typeof value === 'string') {
2498 ret = ['atom', value];
2499 } else if(array_as_mv && value instanceof Array) {
2500 ret = ['array', value.map(this._encodeReturn, this)];
2501 } else {
2502 ret = ['objid', this._findOrAllocateObject(repl, value)];
2503 }
2505 return ret;
2506 },
2508 _handleInputLine: function _handleInputLine(repl, line) {
2509 var ret;
2510 var array_as_mv = false;
2512 try {
2513 if(line[0] === '*') {
2514 array_as_mv = true;
2515 line = line.substring(1);
2516 }
2517 var parts = eval(line);
2518 this._fixupList(repl, parts);
2519 var [thisobj, func] = this._parseFunc(parts[0]);
2520 ret = this._encodeReturn(
2521 func.apply(thisobj, parts.slice(1)),
2522 array_as_mv);
2523 } catch(x) {
2524 ret = ['error', x.toString() ];
2525 }
2527 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2528 repl.print(JSON.encode(ret));
2529 repl._prompt();
2530 },
2532 handleInput: function handleInput(repl, chunk) {
2533 this._input += chunk;
2534 var match, line;
2536 line = match[0];
2539 repl.popInteractor();
2540 repl._prompt();
2541 return;
2542 }
2544 this._input = this._input.substring(line.length);
2545 this._handleInputLine(repl, line);
2546 }
2547 }
2548 });
2549 })
2555 "Marshall the given value for JS.
2556 Strings and numbers are JSON-encoded. Lists (including nil) are
2557 made into JavaScript array literals and their contents encoded
2558 with `js--js-encode-value'."
2585 js--js-repl-prompt-regexp js-js-timeout
2587 ;; start matching against the beginning of the line in
2588 ;; order to catch a prompt that's only partially arrived
2596 ;; Do some initialization the first time we see a process
2602 ;; Send interactor definition
2608 js-js-timeout))
2610 ;; Sanity check
2616 ;; If js--js-repl-depth > 0, we *should* be seeing an
2617 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2618 ;; up with us.
2621 ;; Otherwise, tell Mozilla to enter the interactor mode
2627 js-js-timeout))
2641 js-js-timeout))))
2651 "Convert immediate js< and js! references to deferred ones."
2675 function))
2677 else
2678 collect item)))
2693 "Run FORMS with the Mozilla repl set up for js commands.
2694 Inside the lexical scope of `with-js', `js?', `js!',
2695 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2696 `js-create-instance', and `js-qi' are defined."
2707 function)
2715 function)
2747 props)
2749 ))
2755 "Whether to listify any Array returned by a Mozilla function.
2766 js--js-references)
2771 js--js-references)))
2776 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2777 If function is a string, look it up as a property on the global
2778 object and use the global object for `this'.
2779 If FUNCTION is a list with one element, use that element as the
2780 function with the global object for `this', except that if that
2781 single element is a string, look it up on the global object.
2782 If FUNCTION is a list with more than one argument, use the list
2783 up to the last value as a property descriptor and the last
2784 argument as a function."
2791 ;; Actual funcall
2798 js-js-timeout)
2801 ;; Read the result
2808 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
2809 CONSTRUCTOR is a JS handle, a string, or a list of these things."
2812 constructor arguments))
2818 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
2821 arguments)))
2830 "Tell the repl about any objects we don't reference anymore.
2831 With argument, run even if no intervening GC has happened."
2842 ;; Don't bother running unless we've had an intervening
2843 ;; garbage collection; without a gc, nothing is deleted
2844 ;; from the weak hash table, so it's pointless telling
2845 ;; MozRepl about that references we still hold
2848 ;; Are we looking at a normal prompt? Make sure not to
2849 ;; interrupt the user if he's doing something
2857 of js--js-references
2858 collect x))
2865 num)))
2870 "Evaluate the JavaScript in JS and return JSON-decoded result."
2878 result)))
2881 "Enumerate all JavaScript contexts available.
2882 Each context is a list:
2883 (TITLE URL BROWSER TAB TABBROWSER) for content documents
2884 (TITLE URL WINDOW) for windows
2886 All tabs of a given window are grouped together. The most recent
2887 window is first. Within each window, the tabs are returned
2888 left-to-right."
2893 "@mozilla.org/appshell/window-mediator;1"
2915 window)
2922 "browsers"
2923 x
2924 "contentDocument"
2928 "browsers"
2929 x
2930 "contentWindow"
2931 "location"
2934 "browsers"
2935 x)
2938 "tabContainer"
2939 "childNodes"
2941 x)
2943 gbrowser))))))
2948 "Read a Mozilla tab with prompt PROMPT.
2949 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
2950 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
2951 browser, respectively."
2953 ;; Prime IDO
2960 selected-tab prev-hitab)
2962 ;; Disambiguate names
2964 for tab in tabs
2980 ;; Hack to reduce the number of
2981 ;; round-trips to mozilla
2984 ;; Highlighting tab
2987 "style"
2989 cmds)
2991 ;; Highlight window proper
2994 "style"
2996 cmds)
2998 ;; Select tab, when appropriate
3002 cmds)))
3004 ;; Highlighting whole window
3008 "style"
3011 cmds)))
3014 ;; Unhighlighting tab
3017 cmds)
3019 cmds))
3021 ;; Unhighlighting window
3026 cmds)))
3032 ()
3038 ()
3039 ;; Fiddle with the match list a bit: if our first match
3040 ;; is a tabbrowser window, rotate the match list until
3041 ;; the active tab comes up
3047 "document"
3048 "documentElement"
3053 "gBrowser"
3056 for match in ido-matches
3060 and return t)))
3070 prompt
3072 nil t nil
3090 "Helper function for `js-eval-defun'.
3091 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3092 strings making up the class name and NAME is the name of the
3093 function part."
3112 "The current JavaScript context.
3113 This is a cons like the one returned from `js--read-tab'.
3117 "(function(func_info,func) {
3118 func_info.unshift('window');
3119 var obj = window;
3120 for(var i = 1; i < func_info.length - 1; ++i) {
3121 var next = obj[func_info[i]];
3122 if(typeof next !== 'object' && typeof next !== 'function') {
3123 next = obj.prototype && obj.prototype[func_info[i]];
3124 if(typeof next !== 'object' && typeof next !== 'function') {
3125 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3126 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3127 return;
3128 }
3130 func_info.splice(i+1, 0, 'prototype');
3131 ++i;
3132 }
3133 }
3135 obj[func_info[i]] = func;
3136 alert('Successfully updated '+func_info.join('.'));
3140 "Set the JavaScript context to CONTEXT.
3141 When called interactively, prompt for CONTEXT."
3146 "Return a valid JavaScript context.
3147 If one hasn't been set, or if it's stale, prompt for a new one."
3156 js--js-context))
3170 file)))
3183 "Update a Mozilla tab using the JavaScript defun at point."
3186 ;; This function works by generating a temporary file that contains
3187 ;; the function we'd like to insert. We then use the elisp-js bridge
3188 ;; to command mozilla to load this file by inserting a script tag
3189 ;; into the document we set. This way, debuggers and such will have
3190 ;; a way to find the source of the just-inserted function.
3191 ;;
3192 ;; We delete the temporary file if there's an error, but otherwise
3193 ;; we add an unload event listener on the Mozilla side to delete the
3194 ;; file.
3225 ;; (Re)register a Mozilla resource URL to point to the
3226 ;; temporary directory
3244 ;; Give Mozilla responsibility for deleting this file
3249 ;; Regular content
3253 ;; Chrome
3275 ))
3277 ;; temp-name is set to nil on success
3281 ;;; Main Function
3283 ;;;###autoload
3285 "Major mode for editing JavaScript."
3305 ;; Comments
3311 ;; Parse cache
3314 ;; Frameworks
3317 ;; Imenu
3322 ;; for filling, pretend we're cc-mode
3324 c-paragraph-start "$"
3325 c-paragraph-separate "$"
3326 c-block-comment-prefix "* "
3327 c-line-comment-starter "//"
3337 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3338 ;; we call it instead? (Bug#6071)
3349 ;; Important to fontify the whole buffer syntactically! If we don't,
3350 ;; then we might have regular expression literals that aren't marked
3351 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3352 ;; etc. and produce maddening "unbalanced parenthesis" errors.
3353 ;; When we attempt to find the error and scroll to the portion of
3354 ;; the buffer containing the problem, JIT-lock will apply the
3355 ;; correct syntax to the regular expression literal and the problem
3356 ;; will mysteriously disappear.
3357 ;; FIXME: We should actually do this fontification lazily by adding
3358 ;; calls to syntax-propertize wherever it's really needed.
3361 ;;;###autoload
3370 ;; js.el ends here