blob: f94d7b7f95b9b4cb7d15ec088c1b1294302f83c3 [file] [log] [blame]
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.stacktrace</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Namespace webdriver.stacktrace</h1><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l22">code &raquo;</a></header><section></section><section><h2>Classes</h2><div class="type-summary"><table><tbody><tr><td><dl><dt><a href="class_webdriver_stacktrace_Frame.html">webdriver.stacktrace.Frame</a><dd>Class representing one stack frame.<dt><a href="class_webdriver_stacktrace_Snapshot.html">webdriver.stacktrace.Snapshot</a><dd>Stores a snapshot of the stack trace at the time this instance was created.</dl></table></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="static-functions"><h2>Global Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l587">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.format">webdriver.stacktrace.format</a> <span class="args">( error )</span> &rArr; <code class="type">!(<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a>|goog.testing.JsUnitException)</code></span></div><p>Formats an error's stack trace.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>error: <code class="type">!(<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a>|goog.testing.JsUnitException)</code><dd>The error to format.</dl><tr><th>Returns<tr><td><dl>The formatted error.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l645">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.get">webdriver.stacktrace.get</a> <span class="args">( )</span> &rArr; <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></code></span></div><p>Gets the native stack trace if available otherwise follows the call chain.
The generated trace will exclude all frames up to and including the call to
this function.</summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>The frames of the stack trace.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l569">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.getStack_">webdriver.stacktrace.getStack_</a> <span class="args">( error )</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Get an error's stack trace with the error string trimmed.
V8 prepends the string representation of an error to its stack trace.
This function trims the string so that the stack trace can be parsed
consistently with the other JS engines.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>error: <code class="type">(<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a>|goog.testing.JsUnitException)</code><dd>The error.</dl><tr><th>Returns<tr><td><dl>The stack trace string.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l544">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.parseLongFirefoxFrame_">webdriver.stacktrace.parseLongFirefoxFrame_</a> <span class="args">( frameStr )</span> &rArr; <code class="type">!<a href="class_webdriver_stacktrace_Frame.html">webdriver.stacktrace.Frame</a></code></span></div><p>Parses a long firefox stack frame.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>frameStr: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The stack frame as string.</dl><tr><th>Returns<tr><td><dl>Stack frame object.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l497">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.parseStackFrame_">webdriver.stacktrace.parseStackFrame_</a> <span class="args">( frameStr )</span> &rArr; <code class="type"><a href="class_webdriver_stacktrace_Frame.html">webdriver.stacktrace.Frame</a></code></span></div><p>Parses one stack frame.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>frameStr: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The stack frame as string.</dl><tr><th>Returns<tr><td><dl>Stack frame object or null if the
parsing failed.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l614">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.parse_">webdriver.stacktrace.parse_</a> <span class="args">( stack )</span> &rArr; <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></code></span></div><p>Parses an Error object's stack trace.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>stack: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The stack trace.</dl><tr><th>Returns<tr><td><dl>Stack frames. The
unrecognized frames will be nulled out.</dl></table></div></details></div></div></section><section id="static-properties"><h2>Global Properties</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l463">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.ANONYMOUS_CLOSURE_FRAME_">webdriver.stacktrace.ANONYMOUS_CLOSURE_FRAME_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Representation of an anonymous frame in a stack trace generated by
<code class="type"><a class="unresolved-link">goog.testing.stacktrace</a></code>.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l174">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.ANONYMOUS_FRAME_">webdriver.stacktrace.ANONYMOUS_FRAME_</a> : <code class="type">!<a href="class_webdriver_stacktrace_Frame.html">webdriver.stacktrace.Frame</a></code></span></div><p>Constant for an anonymous frame.</summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l87">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.BROWSER_SUPPORTED">webdriver.stacktrace.BROWSER_SUPPORTED</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Whether the current browser supports stack traces.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l77">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.CAN_CAPTURE_STACK_TRACE_">webdriver.stacktrace.CAN_CAPTURE_STACK_TRACE_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Whether the current environment supports the Error.captureStackTrace
function (as of 10/17/2012, only V8).</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l434">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.CHAKRA_FUNCTION_CALL_PATTERN_">webdriver.stacktrace.CHAKRA_FUNCTION_CALL_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for function call in a Chakra (IE) stack trace. This
expression allows for identifiers like 'Anonymous function', 'eval code',
and 'Global code'.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l443">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.CHAKRA_STACK_FRAME_REGEXP_">webdriver.stacktrace.CHAKRA_STACK_FRAME_REGEXP_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/RegExp">RegExp</a></code></span></div><p>Regular expression for parsing on stack frame in Chakra (IE).</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l472">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.CLOSURE_FUNCTION_CALL_PATTERN_">webdriver.stacktrace.CLOSURE_FUNCTION_CALL_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Pattern for a function call in a Closure stack trace. Creates three optional
submatches: the context, function name, and alias.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l484">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.CLOSURE_STACK_FRAME_REGEXP_">webdriver.stacktrace.CLOSURE_STACK_FRAME_REGEXP_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/RegExp">RegExp</a></code></span></div><p>Regular expression for parsing a stack frame generated by Closure's
<code class="type"><a class="unresolved-link">goog.testing.stacktrace</a></code>.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l266">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.CONTEXT_PATTERN_">webdriver.stacktrace.CONTEXT_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Pattern for a matching the type on a fully-qualified name. Forms an
optional sub-match on the type. For example, in "foo.bar.baz", will match on
"foo.bar".</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l378">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.FIREFOX_FUNCTION_CALL_PATTERN_">webdriver.stacktrace.FIREFOX_FUNCTION_CALL_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for function call in the Firefox stack trace.
Creates a submatch for the function name.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l368">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.FIREFOX_FUNCTION_NAME_PATTERN_">webdriver.stacktrace.FIREFOX_FUNCTION_NAME_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for function names in the Firefox stack trace.
Firefox has extended identifiers to deal with inner functions and anonymous
functions: https://bugzilla.mozilla.org/show_bug.cgi?id=433529#c9</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l388">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.FIREFOX_STACK_FRAME_REGEXP_">webdriver.stacktrace.FIREFOX_STACK_FRAME_REGEXP_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/RegExp">RegExp</a></code></span></div><p>Regular expression for parsing one stack frame in Firefox.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l256">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.IDENTIFIER_PATTERN_">webdriver.stacktrace.IDENTIFIER_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for JavaScript identifiers. We don't support Unicode
identifiers defined in ECMAScript v3.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l247">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.MAX_FIREFOX_FRAMESTRING_LENGTH_">webdriver.stacktrace.MAX_FIREFOX_FRAMESTRING_LENGTH_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></span></div><p>Maximum length of a string that can be matched with a RegExp on
Firefox 3x. Exceeding this approximate length will cause string.match
to exceed Firefox's stack quota. This situation can be encountered
when goog.globalEval is invoked with a long argument; such as
when loading a module.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l399">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.OPERA_ANONYMOUS_FUNCTION_NAME_PATTERN_">webdriver.stacktrace.OPERA_ANONYMOUS_FUNCTION_NAME_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for an anonymous function call in an Opera stack frame.
Creates 2 (optional) submatches: the context object and function name.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l411">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.OPERA_FUNCTION_CALL_PATTERN_">webdriver.stacktrace.OPERA_FUNCTION_CALL_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for a function call in an Opera stack frame.
Creates 3 (optional) submatches: the function name (if not anonymous),
the aliased context object and the function name (if anonymous).</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l422">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.OPERA_STACK_FRAME_REGEXP_">webdriver.stacktrace.OPERA_STACK_FRAME_REGEXP_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/RegExp">RegExp</a></code></span></div><p>Regular expression for parsing on stack frame in Opera 11.68+</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l278">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.QUALIFIED_NAME_PATTERN_">webdriver.stacktrace.QUALIFIED_NAME_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Pattern for matching a fully qualified name. Will create two sub-matches:
the type (optional), and the name. For example, in "foo.bar.baz", will
match on ["foo.bar", "baz"].</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l454">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.UNKNOWN_CLOSURE_FRAME_">webdriver.stacktrace.UNKNOWN_CLOSURE_FRAME_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Placeholder for an unparsable frame in a stack trace generated by
<code class="type"><a class="unresolved-link">goog.testing.stacktrace</a></code>.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l335">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.URL_PATTERN_">webdriver.stacktrace.URL_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for an URL + position inside the file.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l288">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.V8_ALIAS_PATTERN_">webdriver.stacktrace.V8_ALIAS_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for function name alias in the V8 stack trace.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l310">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.V8_CONTEXT_PATTERN_">webdriver.stacktrace.V8_CONTEXT_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for the context of a function call in V8. Creates two
submatches, only one of which will ever match: either the namespace
identifier (with optional "new" keyword in the case of a constructor call),
or just the "new " phrase for a top level constructor call.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l324">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.V8_FUNCTION_CALL_PATTERN_">webdriver.stacktrace.V8_FUNCTION_CALL_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for function call in the V8 stack trace.
Creates 3 submatches with context object (optional), function name and
function alias (optional).</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l298">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.V8_FUNCTION_NAME_PATTERN_">webdriver.stacktrace.V8_FUNCTION_NAME_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for function names and constructor calls in the V8 stack
trace.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l348">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.V8_LOCATION_PATTERN_">webdriver.stacktrace.V8_LOCATION_PATTERN_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>RegExp pattern for a location string in a V8 stack frame. Creates two
submatches for the location, one for enclosed in parentheticals and on
where the location appears alone (which will only occur if the location is
the only information in the frame).</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/stacktrace.js.src.html#l356">code &raquo;</a><span class="member"><a name="webdriver.stacktrace.V8_STACK_FRAME_REGEXP_">webdriver.stacktrace.V8_STACK_FRAME_REGEXP_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/RegExp">RegExp</a></code></span></div><p>Regular expression for parsing one stack frame in V8.</summary></details></div></div></section></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="types.js"></script><script src="dossier.js"></script>