123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526 |
- // Copyright 2021 the V8 project authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #ifndef INCLUDE_V8_VALUE_H_
- #define INCLUDE_V8_VALUE_H_
- #include "v8-data.h" // NOLINT(build/include_directory)
- #include "v8-internal.h" // NOLINT(build/include_directory)
- #include "v8-local-handle.h" // NOLINT(build/include_directory)
- #include "v8-maybe.h" // NOLINT(build/include_directory)
- #include "v8config.h" // NOLINT(build/include_directory)
- /**
- * The v8 JavaScript engine.
- */
- namespace v8 {
- class BigInt;
- class Int32;
- class Integer;
- class Number;
- class Object;
- class String;
- class Uint32;
- /**
- * The superclass of all JavaScript values and objects.
- */
- class V8_EXPORT Value : public Data {
- public:
- /**
- * Returns true if this value is the undefined value. See ECMA-262
- * 4.3.10.
- *
- * This is equivalent to `value === undefined` in JS.
- */
- V8_INLINE bool IsUndefined() const;
- /**
- * Returns true if this value is the null value. See ECMA-262
- * 4.3.11.
- *
- * This is equivalent to `value === null` in JS.
- */
- V8_INLINE bool IsNull() const;
- /**
- * Returns true if this value is either the null or the undefined value.
- * See ECMA-262
- * 4.3.11. and 4.3.12
- *
- * This is equivalent to `value == null` in JS.
- */
- V8_INLINE bool IsNullOrUndefined() const;
- /**
- * Returns true if this value is true.
- *
- * This is not the same as `BooleanValue()`. The latter performs a
- * conversion to boolean, i.e. the result of `Boolean(value)` in JS, whereas
- * this checks `value === true`.
- */
- bool IsTrue() const;
- /**
- * Returns true if this value is false.
- *
- * This is not the same as `!BooleanValue()`. The latter performs a
- * conversion to boolean, i.e. the result of `!Boolean(value)` in JS, whereas
- * this checks `value === false`.
- */
- bool IsFalse() const;
- /**
- * Returns true if this value is a symbol or a string.
- *
- * This is equivalent to
- * `typeof value === 'string' || typeof value === 'symbol'` in JS.
- */
- bool IsName() const;
- /**
- * Returns true if this value is an instance of the String type.
- * See ECMA-262 8.4.
- *
- * This is equivalent to `typeof value === 'string'` in JS.
- */
- V8_INLINE bool IsString() const;
- /**
- * Returns true if this value is a symbol.
- *
- * This is equivalent to `typeof value === 'symbol'` in JS.
- */
- bool IsSymbol() const;
- /**
- * Returns true if this value is a function.
- *
- * This is equivalent to `typeof value === 'function'` in JS.
- */
- bool IsFunction() const;
- /**
- * Returns true if this value is an array. Note that it will return false for
- * an Proxy for an array.
- */
- bool IsArray() const;
- /**
- * Returns true if this value is an object.
- */
- bool IsObject() const;
- /**
- * Returns true if this value is a bigint.
- *
- * This is equivalent to `typeof value === 'bigint'` in JS.
- */
- bool IsBigInt() const;
- /**
- * Returns true if this value is boolean.
- *
- * This is equivalent to `typeof value === 'boolean'` in JS.
- */
- bool IsBoolean() const;
- /**
- * Returns true if this value is a number.
- *
- * This is equivalent to `typeof value === 'number'` in JS.
- */
- bool IsNumber() const;
- /**
- * Returns true if this value is an `External` object.
- */
- bool IsExternal() const;
- /**
- * Returns true if this value is a 32-bit signed integer.
- */
- bool IsInt32() const;
- /**
- * Returns true if this value is a 32-bit unsigned integer.
- */
- bool IsUint32() const;
- /**
- * Returns true if this value is a Date.
- */
- bool IsDate() const;
- /**
- * Returns true if this value is an Arguments object.
- */
- bool IsArgumentsObject() const;
- /**
- * Returns true if this value is a BigInt object.
- */
- bool IsBigIntObject() const;
- /**
- * Returns true if this value is a Boolean object.
- */
- bool IsBooleanObject() const;
- /**
- * Returns true if this value is a Number object.
- */
- bool IsNumberObject() const;
- /**
- * Returns true if this value is a String object.
- */
- bool IsStringObject() const;
- /**
- * Returns true if this value is a Symbol object.
- */
- bool IsSymbolObject() const;
- /**
- * Returns true if this value is a NativeError.
- */
- bool IsNativeError() const;
- /**
- * Returns true if this value is a RegExp.
- */
- bool IsRegExp() const;
- /**
- * Returns true if this value is an async function.
- */
- bool IsAsyncFunction() const;
- /**
- * Returns true if this value is a Generator function.
- */
- bool IsGeneratorFunction() const;
- /**
- * Returns true if this value is a Generator object (iterator).
- */
- bool IsGeneratorObject() const;
- /**
- * Returns true if this value is a Promise.
- */
- bool IsPromise() const;
- /**
- * Returns true if this value is a Map.
- */
- bool IsMap() const;
- /**
- * Returns true if this value is a Set.
- */
- bool IsSet() const;
- /**
- * Returns true if this value is a Map Iterator.
- */
- bool IsMapIterator() const;
- /**
- * Returns true if this value is a Set Iterator.
- */
- bool IsSetIterator() const;
- /**
- * Returns true if this value is a WeakMap.
- */
- bool IsWeakMap() const;
- /**
- * Returns true if this value is a WeakSet.
- */
- bool IsWeakSet() const;
- /**
- * Returns true if this value is an ArrayBuffer.
- */
- bool IsArrayBuffer() const;
- /**
- * Returns true if this value is an ArrayBufferView.
- */
- bool IsArrayBufferView() const;
- /**
- * Returns true if this value is one of TypedArrays.
- */
- bool IsTypedArray() const;
- /**
- * Returns true if this value is an Uint8Array.
- */
- bool IsUint8Array() const;
- /**
- * Returns true if this value is an Uint8ClampedArray.
- */
- bool IsUint8ClampedArray() const;
- /**
- * Returns true if this value is an Int8Array.
- */
- bool IsInt8Array() const;
- /**
- * Returns true if this value is an Uint16Array.
- */
- bool IsUint16Array() const;
- /**
- * Returns true if this value is an Int16Array.
- */
- bool IsInt16Array() const;
- /**
- * Returns true if this value is an Uint32Array.
- */
- bool IsUint32Array() const;
- /**
- * Returns true if this value is an Int32Array.
- */
- bool IsInt32Array() const;
- /**
- * Returns true if this value is a Float32Array.
- */
- bool IsFloat32Array() const;
- /**
- * Returns true if this value is a Float64Array.
- */
- bool IsFloat64Array() const;
- /**
- * Returns true if this value is a BigInt64Array.
- */
- bool IsBigInt64Array() const;
- /**
- * Returns true if this value is a BigUint64Array.
- */
- bool IsBigUint64Array() const;
- /**
- * Returns true if this value is a DataView.
- */
- bool IsDataView() const;
- /**
- * Returns true if this value is a SharedArrayBuffer.
- */
- bool IsSharedArrayBuffer() const;
- /**
- * Returns true if this value is a JavaScript Proxy.
- */
- bool IsProxy() const;
- /**
- * Returns true if this value is a WasmMemoryObject.
- */
- bool IsWasmMemoryObject() const;
- /**
- * Returns true if this value is a WasmModuleObject.
- */
- bool IsWasmModuleObject() const;
- /**
- * Returns true if the value is a Module Namespace Object.
- */
- bool IsModuleNamespaceObject() const;
- /**
- * Perform the equivalent of `BigInt(value)` in JS.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<BigInt> ToBigInt(
- Local<Context> context) const;
- /**
- * Perform the equivalent of `Number(value)` in JS.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<Number> ToNumber(
- Local<Context> context) const;
- /**
- * Perform the equivalent of `String(value)` in JS.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<String> ToString(
- Local<Context> context) const;
- /**
- * Provide a string representation of this value usable for debugging.
- * This operation has no observable side effects and will succeed
- * unless e.g. execution is being terminated.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<String> ToDetailString(
- Local<Context> context) const;
- /**
- * Perform the equivalent of `Object(value)` in JS.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<Object> ToObject(
- Local<Context> context) const;
- /**
- * Perform the equivalent of `Number(value)` in JS and convert the result
- * to an integer. Negative values are rounded up, positive values are rounded
- * down. NaN is converted to 0. Infinite values yield undefined results.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<Integer> ToInteger(
- Local<Context> context) const;
- /**
- * Perform the equivalent of `Number(value)` in JS and convert the result
- * to an unsigned 32-bit integer by performing the steps in
- * https://tc39.es/ecma262/#sec-touint32.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<Uint32> ToUint32(
- Local<Context> context) const;
- /**
- * Perform the equivalent of `Number(value)` in JS and convert the result
- * to a signed 32-bit integer by performing the steps in
- * https://tc39.es/ecma262/#sec-toint32.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<Int32> ToInt32(Local<Context> context) const;
- /**
- * Perform the equivalent of `Boolean(value)` in JS. This can never fail.
- */
- Local<Boolean> ToBoolean(Isolate* isolate) const;
- /**
- * Attempts to convert a string to an array index.
- * Returns an empty handle if the conversion fails.
- */
- V8_WARN_UNUSED_RESULT MaybeLocal<Uint32> ToArrayIndex(
- Local<Context> context) const;
- /** Returns the equivalent of `ToBoolean()->Value()`. */
- bool BooleanValue(Isolate* isolate) const;
- /** Returns the equivalent of `ToNumber()->Value()`. */
- V8_WARN_UNUSED_RESULT Maybe<double> NumberValue(Local<Context> context) const;
- /** Returns the equivalent of `ToInteger()->Value()`. */
- V8_WARN_UNUSED_RESULT Maybe<int64_t> IntegerValue(
- Local<Context> context) const;
- /** Returns the equivalent of `ToUint32()->Value()`. */
- V8_WARN_UNUSED_RESULT Maybe<uint32_t> Uint32Value(
- Local<Context> context) const;
- /** Returns the equivalent of `ToInt32()->Value()`. */
- V8_WARN_UNUSED_RESULT Maybe<int32_t> Int32Value(Local<Context> context) const;
- /** JS == */
- V8_WARN_UNUSED_RESULT Maybe<bool> Equals(Local<Context> context,
- Local<Value> that) const;
- bool StrictEquals(Local<Value> that) const;
- bool SameValue(Local<Value> that) const;
- template <class T>
- V8_INLINE static Value* Cast(T* value) {
- return static_cast<Value*>(value);
- }
- Local<String> TypeOf(Isolate*);
- Maybe<bool> InstanceOf(Local<Context> context, Local<Object> object);
- private:
- V8_INLINE bool QuickIsUndefined() const;
- V8_INLINE bool QuickIsNull() const;
- V8_INLINE bool QuickIsNullOrUndefined() const;
- V8_INLINE bool QuickIsString() const;
- bool FullIsUndefined() const;
- bool FullIsNull() const;
- bool FullIsString() const;
- static void CheckCast(Data* that);
- };
- template <>
- V8_INLINE Value* Value::Cast(Data* value) {
- #ifdef V8_ENABLE_CHECKS
- CheckCast(value);
- #endif
- return static_cast<Value*>(value);
- }
- bool Value::IsUndefined() const {
- #ifdef V8_ENABLE_CHECKS
- return FullIsUndefined();
- #else
- return QuickIsUndefined();
- #endif
- }
- bool Value::QuickIsUndefined() const {
- using A = internal::Address;
- using I = internal::Internals;
- A obj = *reinterpret_cast<const A*>(this);
- if (!I::HasHeapObjectTag(obj)) return false;
- if (I::GetInstanceType(obj) != I::kOddballType) return false;
- return (I::GetOddballKind(obj) == I::kUndefinedOddballKind);
- }
- bool Value::IsNull() const {
- #ifdef V8_ENABLE_CHECKS
- return FullIsNull();
- #else
- return QuickIsNull();
- #endif
- }
- bool Value::QuickIsNull() const {
- using A = internal::Address;
- using I = internal::Internals;
- A obj = *reinterpret_cast<const A*>(this);
- if (!I::HasHeapObjectTag(obj)) return false;
- if (I::GetInstanceType(obj) != I::kOddballType) return false;
- return (I::GetOddballKind(obj) == I::kNullOddballKind);
- }
- bool Value::IsNullOrUndefined() const {
- #ifdef V8_ENABLE_CHECKS
- return FullIsNull() || FullIsUndefined();
- #else
- return QuickIsNullOrUndefined();
- #endif
- }
- bool Value::QuickIsNullOrUndefined() const {
- using A = internal::Address;
- using I = internal::Internals;
- A obj = *reinterpret_cast<const A*>(this);
- if (!I::HasHeapObjectTag(obj)) return false;
- if (I::GetInstanceType(obj) != I::kOddballType) return false;
- int kind = I::GetOddballKind(obj);
- return kind == I::kNullOddballKind || kind == I::kUndefinedOddballKind;
- }
- bool Value::IsString() const {
- #ifdef V8_ENABLE_CHECKS
- return FullIsString();
- #else
- return QuickIsString();
- #endif
- }
- bool Value::QuickIsString() const {
- using A = internal::Address;
- using I = internal::Internals;
- A obj = *reinterpret_cast<const A*>(this);
- if (!I::HasHeapObjectTag(obj)) return false;
- return (I::GetInstanceType(obj) < I::kFirstNonstringType);
- }
- } // namespace v8
- #endif // INCLUDE_V8_VALUE_H_
|