| blob | ba70bb8eccebf7b10c8a124e15e0136ca55f7051 |
1 ;;; js.el --- Major mode for editing JavaScript
3 ;; Copyright (C) 2008, 2009, 2010 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:
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 for indenting continued expressions.
435 The value must be no less than minus `js-indent-level'."
440 "Number of additional spaces for indenting expressions in parentheses.
441 The value must be no less than minus `js-indent-level'."
447 "Number of additional spaces for indenting expressions in square braces.
448 The value must be no less than minus `js-indent-level'."
454 "Number of additional spaces for indenting expressions in curly braces.
455 The value must be no less than minus `js-indent-level'."
461 "Whether to automatically indent when typing punctuation characters.
462 If non-nil, the characters {}();,: also indent the current line
463 in Javascript mode."
468 "Treat nested functions as top-level functions in `js-mode'.
469 This applies to function movement, marking, and so on."
474 "Lineup function for `cc-mode-style', for C comments in `js-mode'."
479 "Frameworks recognized by `js-mode'.
480 To improve performance, you may turn off some frameworks you
481 seldom use, either globally or on a per-buffer basis."
484 js--available-frameworks))
489 "Whether `js-mode' should display tabs while selecting them.
490 This is useful only if the windowing system has a good mechanism
491 for preventing Firefox from stealing the keyboard focus."
496 "~/.emacs.d/js/js"
497 "Temporary directory used by `js-mode' to communicate with Mozilla.
498 This directory must be readable and writable by both Mozilla and Emacs."
503 "Reply timeout for executing commands in Mozilla via `js-mode'.
504 The value is given in seconds. Increase this value if you are
505 getting timeout messages."
509 ;;; KeyMap
528 keymap)
532 "Run the command bound to KEY, and indent if necessary.
533 Indentation does not take place if point is in a string or
534 comment."
539 js-auto-indent-flag)
546 ;;; Syntax table and parsing
552 table)
583 "Helper function for `js--update-quick-match-re'.
584 If LIST contains any element that is not nil, return its non-nil
585 elements, separated by SEPARATOR, prefixed by PREFIX, and ended
586 with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
587 nil. If any element in LIST is itself a list, flatten that
588 element."
594 "Internal function used by `js-mode' for caching buffer constructs.
595 This updates `js--quick-match-re', based on the current set of
596 enabled frameworks."
601 ;; #define mumble
610 ;; var mumble = THING (
631 ;; mumble.prototypeTHING
639 ;; mumble.prototype = {
646 "Move over the next value of PROPNAME in the buffer.
647 If found, return that value and leave point after the character
648 having that value; otherwise, return nil and leave point at EOB."
659 next-value))
662 "Move over the previous value of PROPNAME in the buffer.
663 If found, return that value and leave point just before the
664 character that has that value, otherwise return nil and leave
665 point at BOB."
678 prev-value)))
691 "Helper function for `js--re-search-forward'."
693 str-terminator
722 "Search forward, ignoring strings, cpp macros, and comments.
723 This function invokes `re-search-forward', but treats the buffer
724 as if strings, cpp macros, and comments have been removed.
726 If invoked while inside a macro, it treats the contents of the
727 macro as normal text."
744 "Auxiliary function for `js--re-search-backward'."
746 str-terminator
777 "Search backward, ignoring strings, preprocessor macros, and comments.
779 This function invokes `re-search-backward' but treats the buffer
780 as if strings, preprocessor macros, and comments have been
781 removed.
783 If invoked while inside a macro, treat the macro as normal text."
787 "Move forward over a whole JavaScript expression.
788 This function doesn't move over expressions continued across
789 lines."
791 ;; non-continued case; simplistic, but good enough?
804 "Move forward over a JavaScript function declaration.
805 This puts point at the 'function' keyword.
807 If this is a syntactically-correct non-expression function,
808 return the name of the function, or t if the name could not be
809 determined. Otherwise, return nil."
822 name)))))
825 "Return the start of the JavaScript function prologue containing POS.
826 A function prologue is everything from start of the definition up
827 to and including the opening brace. POS defaults to point.
828 If POS is not in a function prologue, return nil."
855 "Helper function for `js-beginning-of-defun'.
856 Go to previous defun-beginning and return the parse state for it,
857 or nil if we went all the way back to bob and don't find
858 anything."
866 "Helper function for `js--beginning-of-defun-nested'.
867 If PSTATE represents a non-empty top-level defun, return the
868 top-most pitem. Otherwise, return nil."
871 with func-pitem
878 "Helper function for `js--beginning-of-defun'.
879 Return the pitem of the function we went to the beginning of."
881 ;; Look for the smallest function that encloses point...
886 and return pitem)
888 ;; ...and if that isn't found, look for the previous top-level
889 ;; defun
891 while pstate
894 and return it)))
897 "Helper function for `js-beginning-of-defun'."
903 "Value of `beginning-of-defun-function' for `js-mode'."
919 ;; If we're just past the end of a function, the user probably wants
920 ;; to go to the beginning of *that* function
934 "Flush the `js-mode' syntax cache after position BEG.
935 BEG defaults to `point-min', meaning to flush the entire cache."
941 ;; `(message ,@arguments)
942 )
951 ;; open-items must contain at least two items for this to
952 ;; work, but because we push a dummy item to start with,
953 ;; that assumption holds.
956 open-items)
959 "Helper function for `js--ensure-cache'.
960 Update parsing information up to point, referring to parse,
961 prev-parse-point, goal-point, and open-items bound lexically in
962 the body of `js--ensure-cache'."
969 ;; Make sure parse-partial-sexp doesn't stop because we *entered*
970 ;; the given depth -- i.e., make sure we're deeper than the target
971 ;; depth.
975 prev-parse-point goal-point
977 nil parse))
979 ;; (let ((overlay (make-overlay prev-parse-point (point))))
980 ;; (overlay-put overlay 'face '(:background "red"))
981 ;; (unwind-protect
982 ;; (progn
983 ;; (js--debug "parsed: %S" parse)
984 ;; (sit-for 1))
985 ;; (delete-overlay overlay)))
1001 "Split a JavaScript name into its dot-separated parts.
1002 This also removes any prototype parts from the split name
1014 "Guess the name of the JavaScript function at POSITION.
1016 Return the name of the function, or nil if the name could not be
1017 guessed.
1019 This function clobbers match data. If we find the preamble
1020 begins earlier than expected while guessing the function name,
1021 set `js--guess-function-name-start' to that position; otherwise,
1022 set that variable to nil."
1039 ;; Clear any endings that occur after point
1046 ;; Remove any cache properties after this point
1051 "Ensures brace cache is valid up to the character before LIMIT.
1052 LIMIT defaults to point."
1058 orig-match-start
1059 orig-match-end
1060 orig-depth
1061 parse
1062 prev-parse-point
1063 name
1064 case-fold-search
1065 filtered-class-styles
1066 new-item
1067 goal-point
1068 end-prop)
1070 ;; Figure out which class styles we need to look for
1074 js-enabled-frameworks)
1075 collect style))
1081 ;; Find last known good position
1097 ;; Make a placeholder for the top-level definition
1113 ;; Each of these conditions should return non-nil if
1114 ;; we should add a new item and leave point at the end
1115 ;; of the new item's header (h-end in the
1116 ;; js--pitem diagram). This point is the one
1117 ;; after the last character we need to unambiguously
1118 ;; detect this construct. If one of these evaluates to
1119 ;; nil, the location of the point is ignored.
1121 ;; In comment or string
1124 ;; Regular function declaration
1133 js--guess-function-name-start))
1140 :paren-depth orig-depth
1141 :h-begin orig-match-start
1144 name
1147 ;; Macro
1150 ;; Macros often contain unbalanced parentheses.
1151 ;; Make sure that h-end is at the textual end of
1152 ;; the macro no matter what the parenthesis say.
1158 :h-begin orig-match-start
1162 ;; "Prototype function" declaration
1169 :paren-depth orig-depth
1170 :h-begin orig-match-start
1176 ;; Class definition
1179 for class-style in filtered-class-styles
1185 and return
1187 :paren-depth orig-depth
1188 :h-begin orig-match-start
1189 :type class-style
1204 )))))
1207 "Helper function for `js-end-of-defun'."
1212 return t
1216 "Helper function for `js-end-of-defun'."
1225 found)
1228 ;; We're already inside a function; just go to its end.
1231 ;; Otherwise, go to the end of the next function...
1238 ;; ... or eob.
1242 "Value of `end-of-defun-function' for `js-mode'."
1253 ;; look for function backward. if we're inside it, go to that
1254 ;; function's end. otherwise, search for the next function's end and
1255 ;; go there
1259 ;; if we're doing nested functions, see whether we're in the
1260 ;; prologue. If we are, go to the end of the function; otherwise,
1261 ;; call js--end-of-defun-nested to do the real work
1282 t
1284 nil))))
1287 "Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
1298 pos
1302 "Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
1312 pos
1315 ;; Like (up-list -1), but only considers lists that end nearby"
1318 ;; Look at a very small region so our compuation time doesn't
1319 ;; explode in pathological cases.
1324 "Return non-nil iff point is in a function parameter list."
1335 "Return non-nil iff point is in a Dojo multiple-inheritance class block."
1357 ;;; Font Lock
1359 "Helper function for building `js--font-lock-keywords'.
1360 Create a byte-compiled function for matching a concatenation of
1361 REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
1372 "Move forward over a JavaScript destructuring spec.
1373 If FUNC is supplied, call it with no arguments before every
1374 variable name in the spec. Return true iff this was actually a
1375 spec. FUNC must preserve the match data."
1387 t)
1392 t))))
1395 t))
1409 t))
1414 t)))))
1417 t))))
1420 "Font-lock matcher for variable names in a variable declaration.
1421 This is a cc-mode-style matcher that *always* fails, from the
1422 point of view of font-lock. It applies highlighting directly with
1423 `font-lock-apply-highlight'."
1435 t))
1457 ;; Conditions to handle
1461 ;; Matcher always "fails"
1462 nil)
1465 `(
1466 ;; This goes before keywords-2 so it gets used preferentially
1467 ;; instead of the keywords in keywords-2. Don't use override
1468 ;; because that will override syntactic fontification too, which
1469 ;; will fontify commented-out directives as if they weren't
1470 ;; commented out.
1473 ,@js--font-lock-keywords-2
1478 ;; Highlights class being declared, in parts
1482 nil
1485 ;; Highlights parent class, in parts, if available
1502 ;; Highlights parent class
1506 ;; Dojo needs its own matcher to override the string highlighting
1508 'dojo
1515 ;; Match Dojo base classes. Of course Mojo has to be different
1516 ;; from everything else under the sun...
1518 'dojo
1527 ;; continued Dojo base-class list
1529 'dojo
1540 ;; variable declarations
1545 ;; class instantiation
1550 ;; instanceof
1555 ;; formal parameters
1559 js--name-start-re)
1565 ;; continued formal parameter list
1579 "Return whether point is inside the given pitem's header or body."
1589 "Parse the JavaScript program state at point.
1590 Return a list of `js--pitem' instances that apply to point, most
1591 specific first. In the worst case, the current toplevel instance
1592 will be returned."
1602 ;; Loop until we either hit a pitem at BOB or pitem ends after
1603 ;; point (or at point if we're at eob)
1610 pstate))))
1613 "Return the JavaScript syntactic context corresponding to PSTATE."
1616 type)
1622 "Return the JavaScript syntactic context at point.
1623 When called interatively, also display a message with that
1624 context."
1632 syntactic-context))
1635 "Font lock function used by `js-mode'.
1636 This performs fontification according to `js--class-styles'."
1644 js-enabled-frameworks)
1647 decl-re
1650 and return t)
1651 return t
1656 js--font-lock-keywords-2
1657 js--font-lock-keywords-3)
1660 ;; XXX: Javascript can continue a regexp literal across lines so long
1661 ;; as the newline is escaped with \. Account for that in the regexp
1662 ;; below.
1666 "Regexp matching a JavaScript regular expression literal.
1667 Match groups 1 and 2 are the characters forming the beginning and
1673 ;; We want to match regular expressions only at the beginning of
1674 ;; expressions.
1677 ;;; Indentation
1692 "Return non-nil if point is on a JavaScript operator, other than a comma."
1702 "Return non-nil if the current line continues an expression."
1719 Otherwise, return nil. A braceless do-while statement spanning
1720 several lines requires that the start of the loop is indented to
1721 the same column as the current line."
1743 "Helper function for `js--proper-indentation'.
1744 Return the proper indentation of the current line if it starts
1745 the body of a control statement without braces; otherwise, return
1746 nil."
1770 "Return the proper indentation for the current line."
1780 ;; A single closing paren/bracket should be indented at the
1781 ;; same level as the opening statement. Same goes for
1782 ;; "case" and "default".
1796 js-expr-indent-offset))
1803 ;; If there is something following the opening
1804 ;; paren/bracket, everything else should be indented at
1805 ;; the same level.
1816 "Indent the current line as JavaScript."
1826 ;;; Filling
1829 "Fill the paragraph with `c-fill-paragraph'."
1843 ;;; Type database and Imenu
1845 ;; We maintain a cache of semantic information, i.e., the classes and
1846 ;; functions we've encountered so far. In order to avoid having to
1847 ;; re-parse the buffer on every change, we cache the parse state at
1848 ;; each interesting point in the buffer. Each parse state is a
1849 ;; modified copy of the previous one, or in the case of the first
1850 ;; parse state, the empty state.
1851 ;;
1852 ;; The parse state itself is just a stack of js--pitem
1853 ;; instances. It starts off containing one element that is never
1854 ;; closed, that is initially js--initial-pitem.
1855 ;;
1863 name
1865 type
1869 "Helper function for `js--splice-into-items'.
1870 Return a new item that is the result of merging CHILD into
1871 ITEM. NAME-PARTS is a list of parts of the name of CHILD
1872 that we haven't consumed yet."
1877 ;; If the item we're merging into isn't a class, make it into one
1883 ;; Use the child's class-style if it's available
1885 js--dummy-class-style
1890 ;; Now we can merge either a function or a class into a class
1894 ;; if we have more name-parts to go before we get to the
1895 ;; bottom of the class hierarchy, call the merger
1896 ;; recursively
1902 ;; Not merging a class, but something else, so just prepend
1903 ;; it
1907 ;; Otherwise, merge the new child's items into those
1908 ;; of the new class
1914 "Last part of the name of PITEM, as a string or symbol."
1918 name)))
1921 "Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
1922 If a class doesn't exist in the tree, create it. Return
1923 the new items list. NAME-PARTS is a list of strings given
1924 the broken-down class name of the item to insert."
1928 new-items last-new-item new-cons item)
1931 name-parts
1937 ;; If top-name isn't found in items, then we build a copy of items
1938 ;; and throw it away. But that's okay, since most of the time, we
1939 ;; *will* find an instance.
1943 ;; Okay, we found an entry with the right name. Splice
1944 ;; the merged item into the list...
1947 name-parts)
1954 ;; ...and terminate the loop
1955 nil)
1958 ;; Otherwise, copy the current cons and move onto the
1959 ;; text. This is tricky; we keep track of the tail of
1960 ;; the list that begins with new-items in
1961 ;; last-new-item.
1968 ;; Go to the next cell in items
1972 ;; Yay! We stopped because we found something, not because
1973 ;; we ran out of items to search. Just return the new
1974 ;; list.
1977 new-items)
1979 ;; We didn't find anything. If the child is a class and we don't
1980 ;; have any classes to drill down into, just push that class;
1981 ;; otherwise, make a fake class and carry on.
1984 ;; We have name-parts left to process. Make a fake
1985 ;; class for this particular part...
1987 ;; ...and recursively digest the rest of the name
1990 :type js--dummy-class-style
1993 ;; Otherwise, this is the only name we have, so stick
1994 ;; the item on the front of the list
1995 child)
1996 items))))
1999 "Copy `js--pitem' PITEM, and push CHILD onto its list of children."
2004 t))
2006 ;; This trick works because we know (based on our defstructs) that
2007 ;; the child list is always the first element, and so the second
2008 ;; element and beyond can be shared when we make our "copy".
2015 ;; Use slow path because we need class lookup
2021 ;; Use slow path because we need class merging. We know
2022 ;; name is a list here because down in
2023 ;; `js--ensure-cache', we made sure to only add
2024 ;; class entries with lists for :name
2029 ;; Fast path
2035 "Return a marker for LOCATION if `imenu-use-markers' is non-nil."
2038 location))
2041 "Convert PITEMS, a list of `js--pitem' structures, to imenu format."
2058 imenu-items))
2063 unknown-ctr))
2066 imenu-items))
2075 imenu-items))))
2079 imenu-items))
2082 "Return an imenu index for the current buffer."
2094 ;; Make sure everything is closed
2102 ;; Convert the new-finalized state into what imenu expects
2105 unknown-ctr))))))
2107 ;; Silence the compiler.
2118 symbols)
2119 else
2130 "Return a hash table of all JavaScript symbols.
2131 This searches all existing `js-mode' buffers. Each key is the
2132 name of a symbol (possibly disambiguated with <N>, where N > 1),
2133 and each value is a marker giving the location of that symbol."
2135 with imenu-use-markers = t
2136 for buffer being the buffers
2141 finally return symbols))
2147 "Helper function for `js-find-symbol'.
2148 Read a symbol from SYMBOLS-TABLE, which is a hash table like the
2149 one from `js--get-all-known-symbols', using prompt PROMPT and
2150 initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
2151 . LOCATION), where SYMBOL-NAME is a string and LOCATION is a
2152 marker."
2158 prompt
2160 collect key)
2175 "Read a JavaScript symbol and jump to it.
2176 With a prefix argument, restrict symbols to those from the
2177 current buffer. Pushes a mark onto the tag ring just like
2178 `find-tag'."
2188 symbols "Jump to: "
2196 ;;; MozRepl integration
2206 "Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
2207 On timeout, return nil. On success, return t with match data
2208 set. If START is non-nil, look for output starting from START.
2209 Otherwise, use the current value of `process-mark'."
2221 'js-moz-bad-rpc
2225 ;; Integer, mirrors the value we see in JS
2228 ;; Process to which this thing belongs
2249 ; */" Make Emacs happy
2250 "(function(repl) {
2251 repl.defineInteractor('js', {
2252 onStart: function onStart(repl) {
2253 if(!repl._jsObjects) {
2254 repl._jsObjects = {};
2255 repl._jsLastID = 0;
2256 repl._jsGC = this._jsGC;
2257 }
2258 this._input = '';
2259 },
2261 _jsGC: function _jsGC(ids_in_use) {
2262 var objects = this._jsObjects;
2263 var keys = [];
2264 var num_freed = 0;
2266 for(var pn in objects) {
2267 keys.push(Number(pn));
2268 }
2270 keys.sort(function(x, y) x - y);
2271 ids_in_use.sort(function(x, y) x - y);
2272 var i = 0;
2273 var j = 0;
2275 while(i < ids_in_use.length && j < keys.length) {
2276 var id = ids_in_use[i++];
2277 while(j < keys.length && keys[j] !== id) {
2278 var k_id = keys[j++];
2279 delete objects[k_id];
2280 ++num_freed;
2281 }
2282 ++j;
2283 }
2285 while(j < keys.length) {
2286 var k_id = keys[j++];
2287 delete objects[k_id];
2288 ++num_freed;
2289 }
2291 return num_freed;
2292 },
2294 _mkArray: function _mkArray() {
2295 var result = [];
2296 for(var i = 0; i < arguments.length; ++i) {
2297 result.push(arguments[i]);
2298 }
2299 return result;
2300 },
2302 _parsePropDescriptor: function _parsePropDescriptor(parts) {
2303 if(typeof parts === 'string') {
2304 parts = [ parts ];
2305 }
2307 var obj = parts[0];
2308 var start = 1;
2310 if(typeof obj === 'string') {
2311 obj = window;
2312 start = 0;
2313 } else if(parts.length < 2) {
2314 throw new Error('expected at least 2 arguments');
2315 }
2317 for(var i = start; i < parts.length - 1; ++i) {
2318 obj = obj[parts[i]];
2319 }
2321 return [obj, parts[parts.length - 1]];
2322 },
2324 _getProp: function _getProp(/*...*/) {
2325 if(arguments.length === 0) {
2326 throw new Error('no arguments supplied to getprop');
2327 }
2329 if(arguments.length === 1 &&
2330 (typeof arguments[0]) !== 'string')
2331 {
2332 return arguments[0];
2333 }
2335 var [obj, propname] = this._parsePropDescriptor(arguments);
2336 return obj[propname];
2337 },
2339 _putProp: function _putProp(properties, value) {
2340 var [obj, propname] = this._parsePropDescriptor(properties);
2341 obj[propname] = value;
2342 },
2344 _delProp: function _delProp(propname) {
2345 var [obj, propname] = this._parsePropDescriptor(arguments);
2346 delete obj[propname];
2347 },
2349 _typeOf: function _typeOf(thing) {
2350 return typeof thing;
2351 },
2353 _callNew: function(constructor) {
2354 if(typeof constructor === 'string')
2355 {
2356 constructor = window[constructor];
2357 } else if(constructor.length === 1 &&
2358 typeof constructor[0] !== 'string')
2359 {
2360 constructor = constructor[0];
2361 } else {
2362 var [obj,propname] = this._parsePropDescriptor(constructor);
2363 constructor = obj[propname];
2364 }
2366 /* Hacky, but should be robust */
2367 var s = 'new constructor(';
2368 for(var i = 1; i < arguments.length; ++i) {
2369 if(i != 1) {
2370 s += ',';
2371 }
2373 s += 'arguments[' + i + ']';
2374 }
2376 s += ')';
2377 return eval(s);
2378 },
2380 _callEval: function(thisobj, js) {
2381 return eval.call(thisobj, js);
2382 },
2384 getPrompt: function getPrompt(repl) {
2385 return 'EVAL>'
2386 },
2388 _lookupObject: function _lookupObject(repl, id) {
2389 if(typeof id === 'string') {
2390 switch(id) {
2391 case 'global':
2392 return window;
2393 case 'nil':
2394 return null;
2395 case 't':
2396 return true;
2397 case 'false':
2398 return false;
2399 case 'undefined':
2400 return undefined;
2401 case 'repl':
2402 return repl;
2403 case 'interactor':
2404 return this;
2405 case 'NaN':
2406 return NaN;
2407 case 'Infinity':
2408 return Infinity;
2409 case '-Infinity':
2410 return -Infinity;
2411 default:
2412 throw new Error('No object with special id:' + id);
2413 }
2414 }
2416 var ret = repl._jsObjects[id];
2417 if(ret === undefined) {
2418 throw new Error('No object with id:' + id + '(' + typeof id + ')');
2419 }
2420 return ret;
2421 },
2423 _findOrAllocateObject: function _findOrAllocateObject(repl, value) {
2424 if(typeof value !== 'object' && typeof value !== 'function') {
2425 throw new Error('_findOrAllocateObject called on non-object('
2426 + typeof(value) + '): '
2427 + value)
2428 }
2430 for(var id in repl._jsObjects) {
2431 id = Number(id);
2432 var obj = repl._jsObjects[id];
2433 if(obj === value) {
2434 return id;
2435 }
2436 }
2438 var id = ++repl._jsLastID;
2439 repl._jsObjects[id] = value;
2440 return id;
2441 },
2443 _fixupList: function _fixupList(repl, list) {
2444 for(var i = 0; i < list.length; ++i) {
2445 if(list[i] instanceof Array) {
2446 this._fixupList(repl, list[i]);
2447 } else if(typeof list[i] === 'object') {
2448 var obj = list[i];
2449 if(obj.funcall) {
2450 var parts = obj.funcall;
2451 this._fixupList(repl, parts);
2452 var [thisobj, func] = this._parseFunc(parts[0]);
2453 list[i] = func.apply(thisobj, parts.slice(1));
2454 } else if(obj.objid) {
2455 list[i] = this._lookupObject(repl, obj.objid);
2456 } else {
2457 throw new Error('Unknown object type: ' + obj.toSource());
2458 }
2459 }
2460 }
2461 },
2463 _parseFunc: function(func) {
2464 var thisobj = null;
2466 if(typeof func === 'string') {
2467 func = window[func];
2468 } else if(func instanceof Array) {
2469 if(func.length === 1 && typeof func[0] !== 'string') {
2470 func = func[0];
2471 } else {
2472 [thisobj, func] = this._parsePropDescriptor(func);
2473 func = thisobj[func];
2474 }
2475 }
2477 return [thisobj,func];
2478 },
2480 _encodeReturn: function(value, array_as_mv) {
2481 var ret;
2483 if(value === null) {
2484 ret = ['special', 'null'];
2485 } else if(value === true) {
2486 ret = ['special', 'true'];
2487 } else if(value === false) {
2488 ret = ['special', 'false'];
2489 } else if(value === undefined) {
2490 ret = ['special', 'undefined'];
2491 } else if(typeof value === 'number') {
2492 if(isNaN(value)) {
2493 ret = ['special', 'NaN'];
2494 } else if(value === Infinity) {
2495 ret = ['special', 'Infinity'];
2496 } else if(value === -Infinity) {
2497 ret = ['special', '-Infinity'];
2498 } else {
2499 ret = ['atom', value];
2500 }
2501 } else if(typeof value === 'string') {
2502 ret = ['atom', value];
2503 } else if(array_as_mv && value instanceof Array) {
2504 ret = ['array', value.map(this._encodeReturn, this)];
2505 } else {
2506 ret = ['objid', this._findOrAllocateObject(repl, value)];
2507 }
2509 return ret;
2510 },
2512 _handleInputLine: function _handleInputLine(repl, line) {
2513 var ret;
2514 var array_as_mv = false;
2516 try {
2517 if(line[0] === '*') {
2518 array_as_mv = true;
2519 line = line.substring(1);
2520 }
2521 var parts = eval(line);
2522 this._fixupList(repl, parts);
2523 var [thisobj, func] = this._parseFunc(parts[0]);
2524 ret = this._encodeReturn(
2525 func.apply(thisobj, parts.slice(1)),
2526 array_as_mv);
2527 } catch(x) {
2528 ret = ['error', x.toString() ];
2529 }
2531 var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
2532 repl.print(JSON.encode(ret));
2533 repl._prompt();
2534 },
2536 handleInput: function handleInput(repl, chunk) {
2537 this._input += chunk;
2538 var match, line;
2540 line = match[0];
2543 repl.popInteractor();
2544 repl._prompt();
2545 return;
2546 }
2548 this._input = this._input.substring(line.length);
2549 this._handleInputLine(repl, line);
2550 }
2551 }
2552 });
2553 })
2559 "Marshall the given value for JS.
2560 Strings and numbers are JSON-encoded. Lists (including nil) are
2561 made into JavaScript array literals and their contents encoded
2562 with `js--js-encode-value'."
2589 js--js-repl-prompt-regexp js-js-timeout
2591 ;; start matching against the beginning of the line in
2592 ;; order to catch a prompt that's only partially arrived
2600 ;; Do some initialization the first time we see a process
2606 ;; Send interactor definition
2612 js-js-timeout))
2614 ;; Sanity check
2620 ;; If js--js-repl-depth > 0, we *should* be seeing an
2621 ;; EVAL> prompt. If we don't, give Mozilla a chance to catch
2622 ;; up with us.
2625 ;; Otherwise, tell Mozilla to enter the interactor mode
2631 js-js-timeout))
2645 js-js-timeout))))
2655 "Convert immediate js< and js! references to deferred ones."
2679 function))
2681 else
2682 collect item)))
2697 "Run FORMS with the Mozilla repl set up for js commands.
2698 Inside the lexical scope of `with-js', `js?', `js!',
2699 `js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
2700 `js-create-instance', and `js-qi' are defined."
2711 function)
2719 function)
2751 props)
2753 ))
2759 "Whether to listify any Array returned by a Mozilla function.
2770 js--js-references)
2775 js--js-references)))
2780 "Call the Mozilla function FUNCTION with arguments ARGUMENTS.
2781 If function is a string, look it up as a property on the global
2782 object and use the global object for `this'.
2783 If FUNCTION is a list with one element, use that element as the
2784 function with the global object for `this', except that if that
2785 single element is a string, look it up on the global object.
2786 If FUNCTION is a list with more than one argument, use the list
2787 up to the last value as a property descriptor and the last
2788 argument as a function."
2795 ;; Actual funcall
2802 js-js-timeout)
2805 ;; Read the result
2812 "Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
2813 CONSTRUCTOR is a JS handle, a string, or a list of these things."
2816 constructor arguments))
2822 "Return a Lisp array resulting from evaluating each of ARGUMENTS."
2825 arguments)))
2834 "Tell the repl about any objects we don't reference anymore.
2835 With argument, run even if no intervening GC has happened."
2846 ;; Don't bother running unless we've had an intervening
2847 ;; garbage collection; without a gc, nothing is deleted
2848 ;; from the weak hash table, so it's pointless telling
2849 ;; MozRepl about that references we still hold
2852 ;; Are we looking at a normal prompt? Make sure not to
2853 ;; interrupt the user if he's doing something
2861 of js--js-references
2862 collect x))
2869 num)))
2874 "Evaluate the JavaScript in JS and return JSON-decoded result."
2882 result)))
2885 "Enumerate all JavaScript contexts available.
2886 Each context is a list:
2887 (TITLE URL BROWSER TAB TABBROWSER) for content documents
2888 (TITLE URL WINDOW) for windows
2890 All tabs of a given window are grouped together. The most recent
2891 window is first. Within each window, the tabs are returned
2892 left-to-right."
2897 "@mozilla.org/appshell/window-mediator;1"
2919 window)
2926 "browsers"
2927 x
2928 "contentDocument"
2932 "browsers"
2933 x
2934 "contentWindow"
2935 "location"
2938 "browsers"
2939 x)
2942 "tabContainer"
2943 "childNodes"
2945 x)
2947 gbrowser))))))
2952 "Read a Mozilla tab with prompt PROMPT.
2953 Return a cons of (TYPE . OBJECT). TYPE is either 'window or
2954 'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
2955 browser, respectively."
2957 ;; Prime IDO
2964 selected-tab prev-hitab)
2966 ;; Disambiguate names
2968 for tab in tabs
2984 ;; Hack to reduce the number of
2985 ;; round-trips to mozilla
2988 ;; Highlighting tab
2991 "style"
2993 cmds)
2995 ;; Highlight window proper
2998 "style"
3000 cmds)
3002 ;; Select tab, when appropriate
3006 cmds)))
3008 ;; Hilighting whole window
3012 "style"
3015 cmds)))
3018 ;; Unhighlighting tab
3021 cmds)
3023 cmds))
3025 ;; Unhighlighting window
3030 cmds)))
3036 ()
3042 ()
3043 ;; Fiddle with the match list a bit: if our first match
3044 ;; is a tabbrowser window, rotate the match list until
3045 ;; the active tab comes up
3051 "document"
3052 "documentElement"
3057 "gBrowser"
3061 for match in ido-matches
3065 and return t)))
3075 prompt
3077 nil t nil
3095 "Helper function for `js-eval-defun'.
3096 Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
3097 strings making up the class name and NAME is the name of the
3098 function part."
3117 "The current JavaScript context.
3118 This is a cons like the one returned from `js--read-tab'.
3122 "(function(func_info,func) {
3123 func_info.unshift('window');
3124 var obj = window;
3125 for(var i = 1; i < func_info.length - 1; ++i) {
3126 var next = obj[func_info[i]];
3127 if(typeof next !== 'object' && typeof next !== 'function') {
3128 next = obj.prototype && obj.prototype[func_info[i]];
3129 if(typeof next !== 'object' && typeof next !== 'function') {
3130 alert('Could not find ' + func_info.slice(0, i+1).join('.') +
3131 ' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
3132 return;
3133 }
3135 func_info.splice(i+1, 0, 'prototype');
3136 ++i;
3137 }
3138 }
3140 obj[func_info[i]] = func;
3141 alert('Successfully updated '+func_info.join('.'));
3145 "Set the JavaScript context to CONTEXT.
3146 When called interactively, prompt for CONTEXT."
3151 "Return a valid JavaScript context.
3152 If one hasn't been set, or if it's stale, prompt for a new one."
3161 js--js-context))
3175 file)))
3188 "Update a Mozilla tab using the JavaScript defun at point."
3191 ;; This function works by generating a temporary file that contains
3192 ;; the function we'd like to insert. We then use the elisp-js bridge
3193 ;; to command mozilla to load this file by inserting a script tag
3194 ;; into the document we set. This way, debuggers and such will have
3195 ;; a way to find the source of the just-inserted function.
3196 ;;
3197 ;; We delete the temporary file if there's an error, but otherwise
3198 ;; we add an unload event listener on the Mozilla side to delete the
3199 ;; file.
3230 ;; (Re)register a Mozilla resource URL to point to the
3231 ;; temporary directory
3249 ;; Give Mozilla responsibility for deleting this file
3254 ;; Regular content
3258 ;; Chrome
3280 ))
3282 ;; temp-name is set to nil on success
3286 ;;; Main Function
3288 ;;;###autoload
3290 "Major mode for editing JavaScript.
3292 Key bindings:
3297 :syntax-table js-mode-syntax-table
3309 js-syntax-propertize-function)
3316 ;; Comments
3322 ;; Parse cache
3325 ;; Frameworks
3328 ;; Imenu
3336 ;; for filling, pretend we're cc-mode
3338 c-paragraph-start "$"
3339 c-paragraph-separate "$"
3340 c-block-comment-prefix "* "
3341 c-line-comment-starter "//"
3346 ;; FIXME: These are normally set by `c-basic-common-init'. Should
3347 ;; we call it instead? (Bug#6071)
3358 ;; Important to fontify the whole buffer syntactically! If we don't,
3359 ;; then we might have regular expression literals that aren't marked
3360 ;; as strings, which will screw up parse-partial-sexp, scan-lists,
3361 ;; etc. and and produce maddening "unbalanced parenthesis" errors.
3362 ;; When we attempt to find the error and scroll to the portion of
3363 ;; the buffer containing the problem, JIT-lock will apply the
3364 ;; correct syntax to the regular expresion literal and the problem
3365 ;; will mysteriously disappear.
3371 ;;;###autoload
3380 ;; arch-tag: 1a0d0409-e87f-4fc7-a58c-3731c66ddaac
3381 ;; js.el ends here