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#pragma once
30
31#include "CallFrame.h"
32#include "DebuggerPrimitives.h"
33#include "ShadowChicken.h"
34#include "Strong.h"
35#include <wtf/NakedPtr.h>
36#include <wtf/RefCounted.h>
37#include <wtf/text/TextPosition.h>
38
39namespace JSC {
40
41class DebuggerScope;
42class Exception;
43
44class DebuggerCallFrame : public RefCounted<DebuggerCallFrame> {
45public:
46 enum Type { ProgramType, FunctionType };
47
48 static Ref<DebuggerCallFrame> create(VM&, CallFrame*);
49
50 JS_EXPORT_PRIVATE RefPtr<DebuggerCallFrame> callerFrame();
51 JSGlobalObject* globalObject();
52 JS_EXPORT_PRIVATE SourceID sourceID() const;
53
54 // line and column are in base 0 e.g. the first line is line 0.
55 int line() const { return m_position.m_line.zeroBasedInt(); }
56 int column() const { return m_position.m_column.zeroBasedInt(); }
57 JS_EXPORT_PRIVATE const TextPosition& position() const { return m_position; }
58
59 JS_EXPORT_PRIVATE JSGlobalObject* deprecatedVMEntryGlobalObject() const;
60 JS_EXPORT_PRIVATE DebuggerScope* scope();
61 JS_EXPORT_PRIVATE String functionName() const;
62 JS_EXPORT_PRIVATE Type type() const;
63 JS_EXPORT_PRIVATE JSValue thisValue(VM&) const;
64 JSValue evaluateWithScopeExtension(const String&, JSObject* scopeExtensionObject, NakedPtr<Exception>&);
65
66 bool isValid() const { return !!m_validMachineFrame || isTailDeleted(); }
67 JS_EXPORT_PRIVATE void invalidate();
68
69 // The following are only public for the Debugger's use only. They will be
70 // made private soon. Other clients should not use these.
71
72 JS_EXPORT_PRIVATE TextPosition currentPosition(VM&);
73 JS_EXPORT_PRIVATE static TextPosition positionForCallFrame(VM&, CallFrame*);
74 JS_EXPORT_PRIVATE static SourceID sourceIDForCallFrame(CallFrame*);
75
76 bool isTailDeleted() const { return m_shadowChickenFrame.isTailDeleted; }
77
78private:
79 DebuggerCallFrame(VM&, CallFrame*, const ShadowChicken::Frame&);
80
81 CallFrame* m_validMachineFrame;
82 RefPtr<DebuggerCallFrame> m_caller;
83 TextPosition m_position;
84 // The DebuggerPausedScope is responsible for calling invalidate() which,
85 // in turn, will clear this strong ref.
86 Strong<DebuggerScope> m_scope;
87 ShadowChicken::Frame m_shadowChickenFrame;
88};
89
90} // namespace JSC
91