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 "CallFrame.h"
33#include "DebuggerPrimitives.h"
34#include <wtf/PassRefPtr.h>
35#include <wtf/RefCounted.h>
36#include <wtf/text/TextPosition.h>
37
38namespace JSC {
39
40class DebuggerCallFrame : public RefCounted<DebuggerCallFrame> {
41public:
42    enum Type { ProgramType, FunctionType };
43
44    static PassRefPtr<DebuggerCallFrame> create(CallFrame* callFrame)
45    {
46        return adoptRef(new DebuggerCallFrame(callFrame));
47    }
48
49    JS_EXPORT_PRIVATE explicit DebuggerCallFrame(CallFrame*);
50
51    JS_EXPORT_PRIVATE PassRefPtr<DebuggerCallFrame> callerFrame();
52    ExecState* exec() const { return m_callFrame; }
53    JS_EXPORT_PRIVATE SourceID sourceID() const;
54
55    // line and column are in base 0 e.g. the first line is line 0.
56    int line() const { return m_position.m_line.zeroBasedInt(); }
57    int column() const { return m_position.m_column.zeroBasedInt(); }
58    JS_EXPORT_PRIVATE const TextPosition& position() const { return m_position; }
59
60    JS_EXPORT_PRIVATE JSGlobalObject* vmEntryGlobalObject() const;
61    JS_EXPORT_PRIVATE JSScope* scope() const;
62    JS_EXPORT_PRIVATE String functionName() const;
63    JS_EXPORT_PRIVATE Type type() const;
64    JS_EXPORT_PRIVATE JSValue thisValue() const;
65    JSValue evaluate(const String&, JSValue& exception);
66
67    bool isValid() const { return !!m_callFrame; }
68    JS_EXPORT_PRIVATE void invalidate();
69
70    // The following are only public for the Debugger's use only. They will be
71    // made private soon. Other clients should not use these.
72
73    JS_EXPORT_PRIVATE static TextPosition positionForCallFrame(CallFrame*);
74    JS_EXPORT_PRIVATE static SourceID sourceIDForCallFrame(CallFrame*);
75    static JSValue thisValueForCallFrame(CallFrame*);
76
77private:
78    CallFrame* m_callFrame;
79    RefPtr<DebuggerCallFrame> m_caller;
80    TextPosition m_position;
81};
82
83} // namespace JSC
84
85#endif // DebuggerCallFrame_h
86