Speed up JSGlobalObject initialization by making some properties lazy
[WebKit-https.git] / Source / JavaScriptCore / debugger / DebuggerScope.h
1 /*
2  * Copyright (C) 2008-2009, 2014, 2016 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     static const unsigned StructureFlags = Base::StructureFlags | OverridesGetOwnPropertySlot | OverridesGetPropertyNames;
40
41     JS_EXPORT_PRIVATE static DebuggerScope* create(VM& vm, JSScope* scope);
42
43     static void visitChildren(JSCell*, SlotVisitor&);
44     static String className(const JSObject*);
45     static bool getOwnPropertySlot(JSObject*, ExecState*, PropertyName, PropertySlot&);
46     static bool put(JSCell*, ExecState*, PropertyName, JSValue, PutPropertySlot&);
47     static bool deleteProperty(JSCell*, ExecState*, PropertyName);
48     static void getOwnPropertyNames(JSObject*, ExecState*, PropertyNameArray&, EnumerationMode);
49     static bool defineOwnProperty(JSObject*, ExecState*, PropertyName, const PropertyDescriptor&, bool shouldThrow);
50
51     DECLARE_EXPORT_INFO;
52
53     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject) 
54     {
55         return Structure::create(vm, globalObject, jsNull(), TypeInfo(ObjectType, StructureFlags), info()); 
56     }
57
58     class iterator {
59     public:
60         iterator(DebuggerScope* node)
61             : m_node(node)
62         {
63         }
64
65         DebuggerScope* get() { return m_node; }
66         iterator& operator++() { m_node = m_node->next(); return *this; }
67         // postfix ++ intentionally omitted
68
69         bool operator==(const iterator& other) const { return m_node == other.m_node; }
70         bool operator!=(const iterator& other) const { return m_node != other.m_node; }
71
72     private:
73         DebuggerScope* m_node;
74     };
75
76     iterator begin();
77     iterator end();
78     DebuggerScope* next();
79
80     void invalidateChain();
81     bool isValid() const { return !!m_scope; }
82
83     bool isCatchScope() const;
84     bool isFunctionNameScope() const;
85     bool isWithScope() const;
86     bool isGlobalScope() const;
87     bool isClosureScope() const;
88     bool isGlobalLexicalEnvironment() const;
89     bool isNestedLexicalScope() const;
90
91     JSValue caughtValue(ExecState*) const;
92
93 private:
94     DebuggerScope(VM&, Structure*, JSScope*);
95     void finishCreation(VM&);
96
97     JSScope* jsScope() const { return m_scope.get(); }
98
99     WriteBarrier<JSScope> m_scope;
100     WriteBarrier<DebuggerScope> m_next;
101
102     friend class DebuggerCallFrame;
103 };
104
105 inline DebuggerScope::iterator DebuggerScope::begin()
106 {
107     return iterator(this); 
108 }
109
110 inline DebuggerScope::iterator DebuggerScope::end()
111
112     return iterator(0); 
113 }
114
115 } // namespace JSC
116
117 #endif // DebuggerScope_h