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