1d6b279a78dd888a0d5aefa44b655af1419e094b
[WebKit-https.git] / Source / JavaScriptCore / debugger / DebuggerCallFrame.h
1 /*
2  * Copyright (C) 2008, 2013, 2014 Apple 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
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28  
29 #ifndef DebuggerCallFrame_h
30 #define DebuggerCallFrame_h
31
32 #include "DebuggerPrimitives.h"
33 #include "Strong.h"
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/text/TextPosition.h>
37
38 namespace JSC {
39
40 class DebuggerScope;
41 class ExecState;
42 typedef ExecState CallFrame;
43
44 class DebuggerCallFrame : public RefCounted<DebuggerCallFrame> {
45 public:
46     enum Type { ProgramType, FunctionType };
47
48     static PassRefPtr<DebuggerCallFrame> create(CallFrame* callFrame)
49     {
50         return adoptRef(new DebuggerCallFrame(callFrame));
51     }
52
53     JS_EXPORT_PRIVATE explicit DebuggerCallFrame(CallFrame*);
54
55     JS_EXPORT_PRIVATE PassRefPtr<DebuggerCallFrame> callerFrame();
56     ExecState* exec() const { return m_callFrame; }
57     JS_EXPORT_PRIVATE SourceID sourceID() const;
58
59     // line and column are in base 0 e.g. the first line is line 0.
60     int line() const { return m_position.m_line.zeroBasedInt(); }
61     int column() const { return m_position.m_column.zeroBasedInt(); }
62     JS_EXPORT_PRIVATE const TextPosition& position() const { return m_position; }
63
64     JS_EXPORT_PRIVATE JSGlobalObject* vmEntryGlobalObject() const;
65     JS_EXPORT_PRIVATE DebuggerScope* scope();
66     JS_EXPORT_PRIVATE String functionName() const;
67     JS_EXPORT_PRIVATE Type type() const;
68     JS_EXPORT_PRIVATE JSValue thisValue() const;
69     JSValue evaluate(const String&, JSValue& exception);
70
71     bool isValid() const { return !!m_callFrame; }
72     JS_EXPORT_PRIVATE void invalidate();
73
74     // The following are only public for the Debugger's use only. They will be
75     // made private soon. Other clients should not use these.
76
77     JS_EXPORT_PRIVATE static TextPosition positionForCallFrame(CallFrame*);
78     JS_EXPORT_PRIVATE static SourceID sourceIDForCallFrame(CallFrame*);
79     static JSValue thisValueForCallFrame(CallFrame*);
80
81 private:
82     CallFrame* m_callFrame;
83     RefPtr<DebuggerCallFrame> m_caller;
84     TextPosition m_position;
85     // The DebuggerPausedScope is responsible for calling invalidate() which,
86     // in turn, will clear this strong ref.
87     Strong<DebuggerScope> m_scope;
88 };
89
90 } // namespace JSC
91
92 #endif // DebuggerCallFrame_h