Web Inspector: Provide $exception in the console for the thrown exception value
[WebKit-https.git] / Source / JavaScriptCore / debugger / DebuggerScope.h
1 /*
2  * Copyright (C) 2008-2009, 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DebuggerScope_h
27 #define DebuggerScope_h
28
29 #include "JSObject.h"
30
31 namespace JSC {
32
33 class DebuggerCallFrame;
34 class JSScope;
35
36 class DebuggerScope : public JSNonFinalObject {
37 public:
38     typedef JSNonFinalObject Base;
39
40     static DebuggerScope* create(VM& vm, JSScope* scope)
41     {
42         DebuggerScope* debuggerScope = new (NotNull, allocateCell<DebuggerScope>(vm.heap)) DebuggerScope(vm, scope);
43         debuggerScope->finishCreation(vm);
44         return debuggerScope;
45     }
46
47     static void visitChildren(JSCell*, SlotVisitor&);
48     static String className(const JSObject*);
49     static bool getOwnPropertySlot(JSObject*, ExecState*, PropertyName, PropertySlot&);
50     static void put(JSCell*, ExecState*, PropertyName, JSValue, PutPropertySlot&);
51     static bool deleteProperty(JSCell*, ExecState*, PropertyName);
52     static void getOwnPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
53     static bool defineOwnProperty(JSObject*, ExecState*, PropertyName, const PropertyDescriptor&, bool shouldThrow);
54
55     DECLARE_EXPORT_INFO;
56
57     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject) 
58     {
59         return Structure::create(vm, globalObject, jsNull(), TypeInfo(ObjectType, StructureFlags), info()); 
60     }
61
62     class iterator {
63     public:
64         iterator(DebuggerScope* node)
65             : m_node(node)
66         {
67         }
68
69         DebuggerScope* get() { return m_node; }
70         iterator& operator++() { m_node = m_node->next(); return *this; }
71         // postfix ++ intentionally omitted
72
73         bool operator==(const iterator& other) const { return m_node == other.m_node; }
74         bool operator!=(const iterator& other) const { return m_node != other.m_node; }
75
76     private:
77         DebuggerScope* m_node;
78     };
79
80     iterator begin();
81     iterator end();
82     DebuggerScope* next();
83
84     void invalidateChain();
85     bool isValid() const { return !!m_scope; }
86
87     bool isCatchScope() const;
88     bool isFunctionNameScope() const;
89     bool isWithScope() const;
90     bool isGlobalScope() const;
91     bool isFunctionOrEvalScope() const;
92
93     JSValue caughtValue() const;
94
95 private:
96     JS_EXPORT_PRIVATE DebuggerScope(VM&, JSScope*);
97     JS_EXPORT_PRIVATE void finishCreation(VM&);
98
99     JSScope* jsScope() const { return m_scope.get(); }
100
101     static const unsigned StructureFlags = OverridesGetOwnPropertySlot | OverridesGetPropertyNames | JSObject::StructureFlags;
102
103     WriteBarrier<JSScope> m_scope;
104     WriteBarrier<DebuggerScope> m_next;
105
106     friend class DebuggerCallFrame;
107 };
108
109 inline DebuggerScope::iterator DebuggerScope::begin()
110 {
111     return iterator(this); 
112 }
113
114 inline DebuggerScope::iterator DebuggerScope::end()
115
116     return iterator(0); 
117 }
118
119 } // namespace JSC
120
121 #endif // DebuggerScope_h