2010-10-13 Yury Semikhatsky <yurys@chromium.org>
[WebKit-https.git] / WebCore / bindings / v8 / ScriptCallStack.h
1 /*
2  * Copyright (C) 2008, 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  * 
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef ScriptCallStack_h
32 #define ScriptCallStack_h
33
34 #include "ScriptCallFrame.h"
35 #include "ScriptState.h"
36 #include "ScriptValue.h"
37 #include <wtf/Noncopyable.h>
38 #include <wtf/RefPtr.h>
39
40 namespace v8 {
41     class Arguments;
42 }
43
44 namespace WebCore {
45
46 class InspectorArray;
47
48 class ScriptCallStack : public Noncopyable {
49 public:
50     static const int maxCallStackSizeToCapture;
51     static const v8::StackTrace::StackTraceOptions stackTraceOptions;
52
53     static PassOwnPtr<ScriptCallStack> create(const v8::Arguments&, unsigned skipArgumentCount = 0, int framCountLimit = 1);
54     static PassOwnPtr<ScriptCallStack> create(ScriptState*, v8::Handle<v8::StackTrace>);
55     ~ScriptCallStack();
56
57     // Returns false if there is no running JavaScript or if fetching the stack failed.
58     // Sets stackTrace to be an array of stack frame objects.
59     // A stack frame object looks like:
60     // {
61     //   scriptName: <file name for the associated script resource>
62     //   functionName: <name of the JavaScript function>
63     //   lineNumber: <1 based line number>
64     //   column: <1 based column offset on the line>
65     // }
66     static bool stackTrace(int frameLimit, const RefPtr<InspectorArray>& stackTrace);
67
68     const ScriptCallFrame& at(unsigned);
69     unsigned size();
70
71     ScriptState* state() const { return m_scriptState; }
72     ScriptState* globalState() const { return m_scriptState; }
73
74 private:
75     ScriptCallStack(ScriptState* scriptState, PassOwnPtr<ScriptCallFrame> topFrame, Vector<OwnPtr<ScriptCallFrame> >& scriptCallFrames);
76     ScriptCallStack(ScriptState* scriptState, v8::Handle<v8::StackTrace> stackTrace);
77
78     OwnPtr<ScriptCallFrame> m_topFrame;
79     ScriptState* m_scriptState;
80     Vector<OwnPtr<ScriptCallFrame> > m_scriptCallFrames;
81 };
82
83 } // namespace WebCore
84
85 #endif // ScriptCallStack_h