blob: 89b5aee4d72313b86483d003e30a4c1c094d7c38 [file] [log] [blame]
/*
* Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
* Copyright (C) 2001 Peter Kelly (pmk@post.com)
* Copyright (C) 2003-2021 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include "ConstructData.h"
#include "JSCast.h"
#include <wtf/CompactPtr.h>
#include <wtf/PtrTag.h>
#if HAVE(36BIT_ADDRESS)
#define CLASS_INFO_ALIGNMENT alignas(16)
#else
#define CLASS_INFO_ALIGNMENT
#endif
namespace WTF {
class PrintStream;
};
namespace JSC {
class HeapAnalyzer;
class JSArrayBufferView;
class Snippet;
struct HashTable;
#define METHOD_TABLE_ENTRY(method) \
WTF_VTBL_FUNCPTR_PTRAUTH_STR("MethodTable." #method) method
struct MethodTable {
using DestroyFunctionPtr = void (*)(JSCell*);
DestroyFunctionPtr METHOD_TABLE_ENTRY(destroy);
using GetCallDataFunctionPtr = CallData (*)(JSCell*);
GetCallDataFunctionPtr METHOD_TABLE_ENTRY(getCallData);
using GetConstructDataFunctionPtr = CallData (*)(JSCell*);
GetConstructDataFunctionPtr METHOD_TABLE_ENTRY(getConstructData);
using PutFunctionPtr = bool (*)(JSCell*, JSGlobalObject*, PropertyName propertyName, JSValue, PutPropertySlot&);
PutFunctionPtr METHOD_TABLE_ENTRY(put);
using PutByIndexFunctionPtr = bool (*)(JSCell*, JSGlobalObject*, unsigned propertyName, JSValue, bool shouldThrow);
PutByIndexFunctionPtr METHOD_TABLE_ENTRY(putByIndex);
using DeletePropertyFunctionPtr = bool (*)(JSCell*, JSGlobalObject*, PropertyName, DeletePropertySlot&);
DeletePropertyFunctionPtr METHOD_TABLE_ENTRY(deleteProperty);
using DeletePropertyByIndexFunctionPtr = bool (*)(JSCell*, JSGlobalObject*, unsigned);
DeletePropertyByIndexFunctionPtr METHOD_TABLE_ENTRY(deletePropertyByIndex);
using GetOwnPropertySlotFunctionPtr = bool (*)(JSObject*, JSGlobalObject*, PropertyName, PropertySlot&);
GetOwnPropertySlotFunctionPtr METHOD_TABLE_ENTRY(getOwnPropertySlot);
using GetOwnPropertySlotByIndexFunctionPtr = bool (*)(JSObject*, JSGlobalObject*, unsigned, PropertySlot&);
GetOwnPropertySlotByIndexFunctionPtr METHOD_TABLE_ENTRY(getOwnPropertySlotByIndex);
using ToThisFunctionPtr = JSValue (*)(JSCell*, JSGlobalObject*, ECMAMode);
ToThisFunctionPtr METHOD_TABLE_ENTRY(toThis);
using GetOwnPropertyNamesFunctionPtr = void (*)(JSObject*, JSGlobalObject*, PropertyNameArray&, DontEnumPropertiesMode);
GetOwnPropertyNamesFunctionPtr METHOD_TABLE_ENTRY(getOwnPropertyNames);
GetOwnPropertyNamesFunctionPtr METHOD_TABLE_ENTRY(getOwnSpecialPropertyNames);
using CustomHasInstanceFunctionPtr = bool (*)(JSObject*, JSGlobalObject*, JSValue);
CustomHasInstanceFunctionPtr METHOD_TABLE_ENTRY(customHasInstance);
using DefineOwnPropertyFunctionPtr = bool (*)(JSObject*, JSGlobalObject*, PropertyName, const PropertyDescriptor&, bool);
DefineOwnPropertyFunctionPtr METHOD_TABLE_ENTRY(defineOwnProperty);
using PreventExtensionsFunctionPtr = bool (*)(JSObject*, JSGlobalObject*);
PreventExtensionsFunctionPtr METHOD_TABLE_ENTRY(preventExtensions);
using IsExtensibleFunctionPtr = bool (*)(JSObject*, JSGlobalObject*);
IsExtensibleFunctionPtr METHOD_TABLE_ENTRY(isExtensible);
using SetPrototypeFunctionPtr = bool (*)(JSObject*, JSGlobalObject*, JSValue, bool shouldThrowIfCantSet);
SetPrototypeFunctionPtr METHOD_TABLE_ENTRY(setPrototype);
using GetPrototypeFunctionPtr = JSValue (*)(JSObject*, JSGlobalObject*);
GetPrototypeFunctionPtr METHOD_TABLE_ENTRY(getPrototype);
using DumpToStreamFunctionPtr = void (*)(const JSCell*, PrintStream&);
DumpToStreamFunctionPtr METHOD_TABLE_ENTRY(dumpToStream);
using AnalyzeHeapFunctionPtr = void (*)(JSCell*, HeapAnalyzer&);
AnalyzeHeapFunctionPtr METHOD_TABLE_ENTRY(analyzeHeap);
using EstimatedSizeFunctionPtr = size_t (*)(JSCell*, VM&);
EstimatedSizeFunctionPtr METHOD_TABLE_ENTRY(estimatedSize);
using VisitChildrenFunctionPtr = void (*)(JSCell*, SlotVisitor&);
VisitChildrenFunctionPtr METHOD_TABLE_ENTRY(visitChildrenWithSlotVisitor);
using VisitChildrenWithAbstractSlotVisitorPtr = void (*)(JSCell*, AbstractSlotVisitor&);
VisitChildrenWithAbstractSlotVisitorPtr METHOD_TABLE_ENTRY(visitChildrenWithAbstractSlotVisitor);
ALWAYS_INLINE void visitChildren(JSCell* cell, SlotVisitor& visitor) const { visitChildrenWithSlotVisitor(cell, visitor); }
ALWAYS_INLINE void visitChildren(JSCell* cell, AbstractSlotVisitor& visitor) const { visitChildrenWithAbstractSlotVisitor(cell, visitor); }
using VisitOutputConstraintsPtr = void (*)(JSCell*, SlotVisitor&);
VisitOutputConstraintsPtr METHOD_TABLE_ENTRY(visitOutputConstraintsWithSlotVisitor);
using VisitOutputConstraintsWithAbstractSlotVisitorPtr = void (*)(JSCell*, AbstractSlotVisitor&);
VisitOutputConstraintsWithAbstractSlotVisitorPtr METHOD_TABLE_ENTRY(visitOutputConstraintsWithAbstractSlotVisitor);
ALWAYS_INLINE void visitOutputConstraints(JSCell* cell, SlotVisitor& visitor) const { visitOutputConstraintsWithSlotVisitor(cell, visitor); }
ALWAYS_INLINE void visitOutputConstraints(JSCell* cell, AbstractSlotVisitor& visitor) const { visitOutputConstraintsWithAbstractSlotVisitor(cell, visitor); }
};
#define CREATE_MEMBER_CHECKER(member) \
template <typename T> \
struct MemberCheck##member { \
struct Fallback { \
void member(...); \
}; \
struct Derived : T, Fallback { }; \
template <typename U, U> struct Check; \
typedef char Yes[2]; \
typedef char No[1]; \
template <typename U> \
static No &func(Check<void (Fallback::*)(...), &U::member>*); \
template <typename U> \
static Yes &func(...); \
enum { has = sizeof(func<Derived>(0)) == sizeof(Yes) }; \
}
#define HAS_MEMBER_NAMED(klass, name) (MemberCheck##name<klass>::has)
#define CREATE_METHOD_TABLE(ClassName) \
JSCastingHelpers::InheritsTraits<ClassName>::typeRange, \
{ \
&ClassName::destroy, \
&ClassName::getCallData, \
&ClassName::getConstructData, \
&ClassName::put, \
&ClassName::putByIndex, \
&ClassName::deleteProperty, \
&ClassName::deletePropertyByIndex, \
&ClassName::getOwnPropertySlot, \
&ClassName::getOwnPropertySlotByIndex, \
&ClassName::toThis, \
&ClassName::getOwnPropertyNames, \
&ClassName::getOwnSpecialPropertyNames, \
&ClassName::customHasInstance, \
&ClassName::defineOwnProperty, \
&ClassName::preventExtensions, \
&ClassName::isExtensible, \
&ClassName::setPrototype, \
&ClassName::getPrototype, \
&ClassName::dumpToStream, \
&ClassName::analyzeHeap, \
&ClassName::estimatedSize, \
&ClassName::visitChildren, \
&ClassName::visitChildren, \
&ClassName::visitOutputConstraints, \
&ClassName::visitOutputConstraints, \
}, \
ClassName::TypedArrayStorageType, \
sizeof(ClassName),
struct CLASS_INFO_ALIGNMENT ClassInfo {
using CheckJSCastSnippetFunctionPtr = Ref<Snippet> (*)(void);
// A string denoting the class name. Example: "Window".
ASCIILiteral className;
// Pointer to the class information of the base class.
// nullptrif there is none.
const ClassInfo* parentClass;
const HashTable* staticPropHashTable;
CheckJSCastSnippetFunctionPtr checkSubClassSnippet;
const std::optional<JSTypeRange> inheritsJSTypeRange; // This is range of JSTypes for doing inheritance checking. Has the form: [firstJSType, lastJSType] (inclusive).
MethodTable methodTable;
const TypedArrayType typedArrayStorageType;
const unsigned staticClassSize;
static ptrdiff_t offsetOfParentClass()
{
return OBJECT_OFFSETOF(ClassInfo, parentClass);
}
bool isSubClassOf(const ClassInfo* other) const
{
for (const ClassInfo* ci = this; ci; ci = ci->parentClass) {
if (ci == other)
return true;
}
return false;
}
JS_EXPORT_PRIVATE void dump(PrintStream&) const;
JS_EXPORT_PRIVATE bool hasStaticSetterOrReadonlyProperties() const;
};
} // namespace JSC