blob: 2e9052016220f0961d9960a2c8bf66302d0d7b05 [file] [log] [blame]
/*
* Copyright (C) 2008-2021 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "DebuggerLocation.h"
#include "JSObject.h"
namespace JSC {
class DebuggerCallFrame;
class JSScope;
class DebuggerScope final : public JSNonFinalObject {
public:
using Base = JSNonFinalObject;
static constexpr unsigned StructureFlags = Base::StructureFlags | OverridesGetOwnPropertySlot | OverridesGetOwnPropertyNames | OverridesPut;
template<typename CellType, SubspaceAccess mode>
static IsoSubspace* subspaceFor(VM& vm)
{
return vm.debuggerScopeSpace<mode>();
}
JS_EXPORT_PRIVATE static DebuggerScope* create(VM& vm, JSScope* scope);
DECLARE_VISIT_CHILDREN;
static bool getOwnPropertySlot(JSObject*, JSGlobalObject*, PropertyName, PropertySlot&);
static bool put(JSCell*, JSGlobalObject*, PropertyName, JSValue, PutPropertySlot&);
static bool deleteProperty(JSCell*, JSGlobalObject*, PropertyName, DeletePropertySlot&);
static void getOwnPropertyNames(JSObject*, JSGlobalObject*, PropertyNameArray&, DontEnumPropertiesMode);
static bool defineOwnProperty(JSObject*, JSGlobalObject*, PropertyName, const PropertyDescriptor&, bool shouldThrow);
DECLARE_EXPORT_INFO;
static Structure* createStructure(VM& vm, JSGlobalObject* globalObject)
{
return Structure::create(vm, globalObject, jsNull(), TypeInfo(ObjectType, StructureFlags), info());
}
class iterator {
public:
iterator(DebuggerScope* node)
: m_node(node)
{
}
DebuggerScope* get() { return m_node; }
iterator& operator++() { m_node = m_node->next(); return *this; }
// postfix ++ intentionally omitted
bool operator==(const iterator& other) const { return m_node == other.m_node; }
bool operator!=(const iterator& other) const { return m_node != other.m_node; }
private:
DebuggerScope* m_node;
};
iterator begin();
iterator end();
DebuggerScope* next();
void invalidateChain();
bool isValid() const { return !!m_scope; }
bool isCatchScope() const;
bool isFunctionNameScope() const;
bool isWithScope() const;
bool isGlobalScope() const;
bool isClosureScope() const;
bool isGlobalLexicalEnvironment() const;
bool isNestedLexicalScope() const;
String name() const;
DebuggerLocation location() const;
JSValue caughtValue(JSGlobalObject*) const;
private:
DebuggerScope(VM&, Structure*, JSScope*);
void finishCreation(VM&);
JSScope* jsScope() const { return m_scope.get(); }
WriteBarrier<JSScope> m_scope;
WriteBarrier<DebuggerScope> m_next;
friend class DebuggerCallFrame;
};
inline DebuggerScope::iterator DebuggerScope::begin()
{
return iterator(this);
}
inline DebuggerScope::iterator DebuggerScope::end()
{
return iterator(nullptr);
}
} // namespace JSC