5#ifndef INCLUDE_V8_PRIMITIVE_H_
6#define INCLUDE_V8_PRIMITIVE_H_
22class ScopedExternalStringLock;
23class StringForwardingTable;
39#ifdef V8_ENABLE_CHECKS
42 return static_cast<Boolean*
>(data);
48 static void CheckCast(
v8::Data* that);
66#ifdef V8_ENABLE_CHECKS
73 static void CheckCast(
Data* obj);
91#ifdef V8_ENABLE_CHECKS
94 return static_cast<Name*
>(data);
98 static void CheckCast(
Data* that);
126 static constexpr int kMaxLength =
127 internal::kApiSystemPointerSize == 4 ? (1 << 28) - 16 : (1 << 29) - 24;
130 UNKNOWN_ENCODING = 0x1,
131 TWO_BYTE_ENCODING = 0x0,
132 ONE_BYTE_ENCODING = 0x8
170 kReplaceInvalidUtf8 = 2
189 uint16_t* buffer,
int flags = WriteFlags::kNone)
const;
191 uint8_t* buffer,
int flags = WriteFlags::kNone)
const;
214 int flags = WriteFlags::kNone,
215 size_t* processed_characters_return =
nullptr)
const;
271 return kDefaultMemoryEstimate;
273 static constexpr size_t kDefaultMemoryEstimate =
static_cast<size_t>(-1);
326 friend class internal::ExternalString;
328 friend class internal::StringForwardingTable;
329 friend class internal::ScopedExternalStringLock;
350 virtual const uint16_t*
data()
const = 0;
363 CheckCachedDataInvariants();
377 void CheckCachedDataInvariants()
const;
379 const uint16_t* cached_data_ =
nullptr;
405 virtual const char*
data()
const = 0;
416 CheckCachedDataInvariants();
430 void CheckCachedDataInvariants()
const;
432 const char* cached_data_ =
nullptr;
458#ifdef V8_ENABLE_CHECKS
461 return static_cast<String*
>(data);
475 Isolate* isolate,
const char (&literal)[N],
477 static_assert(N <= kMaxLength,
"String is too long");
478 return NewFromUtf8Literal(isolate, literal, type, N - 1);
484 Isolate* isolate,
const char* data,
485 NewStringType type = NewStringType::kNormal,
int length = -1);
490 Isolate* isolate,
const uint8_t* data,
491 NewStringType type = NewStringType::kNormal,
int length = -1);
496 Isolate* isolate,
const uint16_t* data,
497 NewStringType type = NewStringType::kNormal,
int length = -1);
601 size_t length()
const {
return length_; }
625 "Prefer using String::ValueView if you can, or string->Write to a "
626 "buffer if you cannot.")
629 uint16_t* operator*() {
return str_; }
631 uint32_t
length()
const {
return length_; }
668 uint32_t
length()
const {
return length_; }
676 void CheckOneByte(
bool is_one_byte)
const;
686 alignas(internal::Internals::
687 kDisallowGarbageCollectionAlign)
char no_gc_debug_scope_
688 [internal::Internals::kDisallowGarbageCollectionSize];
692 void VerifyExternalStringResourceBase(ExternalStringResourceBase* v,
693 Encoding encoding)
const;
694 void VerifyExternalStringResource(ExternalStringResource* val)
const;
695 ExternalStringResource* GetExternalStringResourceSlow()
const;
696 ExternalStringResourceBase* GetExternalStringResourceBaseSlow(
703 static void CheckCast(
v8::Data* that);
772#ifdef V8_ENABLE_CHECKS
775 return static_cast<Symbol*
>(data);
780 static void CheckCast(
Data* that);
790 static void CheckCast(
v8::Data* that);
800 template <
typename Int>
801 requires(std::is_integral<Int>::value && !std::is_same<Int, bool>::value &&
802 std::is_signed_v<Int> &&
sizeof(Int) <=
sizeof(int32_t))
804 return NewFromInt32(isolate, value);
806 template <
typename UInt>
807 requires(std::is_integral<UInt>::value &&
808 !std::is_same<UInt, bool>::value && std::is_unsigned_v<UInt> &&
809 sizeof(UInt) <=
sizeof(uint32_t))
811 return NewFromUint32(isolate, value);
814#ifdef V8_ENABLE_CHECKS
817 return static_cast<Number*
>(data);
824 static void CheckCast(
v8::Data* that);
836#ifdef V8_ENABLE_CHECKS
839 return static_cast<Integer*
>(data);
844 static void CheckCast(
v8::Data* that);
854#ifdef V8_ENABLE_CHECKS
857 return static_cast<Int32*
>(data);
862 static void CheckCast(
v8::Data* that);
872#ifdef V8_ENABLE_CHECKS
875 return static_cast<Uint32*
>(data);
880 static void CheckCast(
v8::Data* that);
898 int word_count,
const uint64_t* words);
929 void ToWordsArray(
int* sign_bit,
int* word_count, uint64_t* words)
const;
932#ifdef V8_ENABLE_CHECKS
935 return static_cast<BigInt*
>(data);
940 static void CheckCast(
v8::Data* that);
946 I::CheckInitialized(isolate);
947 S* slot = I::GetRootSlot(isolate, I::kEmptyStringRootIndex);
957 if (I::IsExternalTwoByteString(I::GetInstanceType(obj))) {
958 Isolate* isolate = I::GetCurrentIsolateForSandbox();
959 A value = I::ReadExternalPointerField<internal::kExternalStringResourceTag>(
960 isolate, obj, I::kStringResourceOffset);
963 result = GetExternalStringResourceSlow();
965#ifdef V8_ENABLE_CHECKS
966 VerifyExternalStringResource(result);
976 int type = I::GetInstanceType(obj) & I::kStringRepresentationAndEncodingMask;
977 *encoding_out =
static_cast<Encoding>(type & I::kStringEncodingMask);
979 if (type == I::kExternalOneByteRepresentationTag ||
980 type == I::kExternalTwoByteRepresentationTag) {
981 A value = I::ReadExternalPointerField<internal::kExternalStringResourceTag>(
982 isolate, obj, I::kStringResourceOffset);
985 resource = GetExternalStringResourceBaseSlow(encoding_out);
987#ifdef V8_ENABLE_CHECKS
988 VerifyExternalStringResourceBase(resource, *encoding_out);
998 int type = I::GetInstanceType(obj) & I::kStringRepresentationAndEncodingMask;
999 *encoding_out =
static_cast<Encoding>(type & I::kStringEncodingMask);
1001 if (type == I::kExternalOneByteRepresentationTag ||
1002 type == I::kExternalTwoByteRepresentationTag) {
1003 Isolate* isolate = I::GetCurrentIsolateForSandbox();
1004 A value = I::ReadExternalPointerField<internal::kExternalStringResourceTag>(
1005 isolate, obj, I::kStringResourceOffset);
1008 resource = GetExternalStringResourceBaseSlow(encoding_out);
1010#ifdef V8_ENABLE_CHECKS
1011 VerifyExternalStringResourceBase(resource, *encoding_out);
1021 I::CheckInitialized(isolate);
1022 S* slot = I::GetRootSlot(isolate, I::kUndefinedValueRootIndex);
1029 I::CheckInitialized(isolate);
1030 S* slot = I::GetRootSlot(isolate, I::kNullValueRootIndex);
1037 I::CheckInitialized(isolate);
1038 S* slot = I::GetRootSlot(isolate, I::kTrueValueRootIndex);
1045 I::CheckInitialized(isolate);
1046 S* slot = I::GetRootSlot(isolate, I::kFalseValueRootIndex);
1051 return value ?
True(isolate) :
False(isolate);
Definition: v8-primitive.h:886
uint64_t Uint64Value(bool *lossless=nullptr) const
static BigInt * Cast(v8::Data *data)
Definition: v8-primitive.h:931
static Local< BigInt > New(Isolate *isolate, int64_t value)
int64_t Int64Value(bool *lossless=nullptr) const
static MaybeLocal< BigInt > NewFromWords(Local< Context > context, int sign_bit, int word_count, const uint64_t *words)
static Local< BigInt > NewFromUnsigned(Isolate *isolate, uint64_t value)
void ToWordsArray(int *sign_bit, int *word_count, uint64_t *words) const
Definition: v8-primitive.h:35
static Local< Boolean > New(Isolate *isolate, bool value)
Definition: v8-primitive.h:1050
static Boolean * Cast(v8::Data *data)
Definition: v8-primitive.h:38
Definition: v8-primitive.h:717
virtual ~ExternalResourceVisitor()=default
virtual void VisitExternalString(Local< String > string)
Definition: v8-primitive.h:720
Definition: v8-primitive.h:850
static Int32 * Cast(v8::Data *data)
Definition: v8-primitive.h:853
Definition: v8-primitive.h:830
static Integer * Cast(v8::Data *data)
Definition: v8-primitive.h:835
static Local< Integer > New(Isolate *isolate, int32_t value)
static Local< Integer > NewFromUnsigned(Isolate *isolate, uint32_t value)
Definition: v8-isolate.h:290
Definition: v8-local-handle.h:366
Definition: v8-local-handle.h:734
Definition: v8-primitive.h:79
static Name * Cast(Data *data)
Definition: v8-primitive.h:90
Definition: v8-primitive.h:796
static Local< Number > New(Isolate *isolate, double value)
static Local< Number > New(Isolate *isolate, Int value)
Definition: v8-primitive.h:803
static Local< Number > New(Isolate *isolate, UInt value)
Definition: v8-primitive.h:810
static Number * Cast(v8::Data *data)
Definition: v8-primitive.h:813
Definition: v8-primitive.h:787
Definition: v8-primitive.h:58
static Local< PrimitiveArray > New(Isolate *isolate, int length)
Local< Primitive > Get(Isolate *isolate, int index)
static PrimitiveArray * Cast(Data *data)
Definition: v8-primitive.h:65
void Set(Isolate *isolate, int index, Local< Primitive > item)
Definition: v8-primitive.h:29
Definition: v8-primitive.h:393
const char * cached_data() const
Definition: v8-primitive.h:415
ExternalOneByteStringResource()=default
~ExternalOneByteStringResource() override=default
virtual size_t length() const =0
virtual const char * data() const =0
Definition: v8-primitive.h:275
virtual void RecordSharedMemoryUsage(const void *location, size_t size)=0
Definition: v8-primitive.h:243
void operator=(const ExternalStringResourceBase &)=delete
virtual void Unaccount(Isolate *isolate)
Definition: v8-primitive.h:259
ExternalStringResourceBase(const ExternalStringResourceBase &)=delete
virtual ~ExternalStringResourceBase()=default
virtual void Unlock() const
Definition: v8-primitive.h:323
virtual void EstimateSharedMemoryUsage(SharedMemoryUsageRecorder *recorder) const
Definition: v8-primitive.h:289
virtual bool IsCacheable() const
Definition: v8-primitive.h:252
ExternalStringResourceBase()=default
virtual void Lock() const
Definition: v8-primitive.h:318
virtual size_t EstimateMemoryUsage() const
Definition: v8-primitive.h:270
virtual void Dispose()
Definition: v8-primitive.h:305
Definition: v8-primitive.h:338
virtual const uint16_t * data() const =0
ExternalStringResource()=default
const uint16_t * cached_data() const
Definition: v8-primitive.h:362
virtual size_t length() const =0
~ExternalStringResource() override=default
Definition: v8-primitive.h:595
char * operator*()
Definition: v8-primitive.h:599
Utf8Value(Isolate *isolate, Local< v8::Value > obj)
Utf8Value(const Utf8Value &)=delete
const char * operator*() const
Definition: v8-primitive.h:600
void operator=(const Utf8Value &)=delete
size_t length() const
Definition: v8-primitive.h:601
Definition: v8-primitive.h:652
bool is_one_byte() const
Definition: v8-primitive.h:669
const uint16_t * data16_
Definition: v8-primitive.h:681
void operator=(const ValueView &)=delete
const uint8_t * data8() const
Definition: v8-primitive.h:656
uint32_t length() const
Definition: v8-primitive.h:668
ValueView(const ValueView &)=delete
const uint16_t * data16() const
Definition: v8-primitive.h:662
ValueView(Isolate *isolate, Local< v8::String > str)
const uint8_t * data8_
Definition: v8-primitive.h:680
Definition: v8-primitive.h:622
const uint16_t * operator*() const
Definition: v8-primitive.h:630
uint32_t length() const
Definition: v8-primitive.h:631
Value(const Value &)=delete
void operator=(const Value &)=delete
Definition: v8-primitive.h:124
size_t Utf8LengthV2(Isolate *isolate) const
bool IsExternalTwoByte() const
static Local< String > Concat(Isolate *isolate, Local< String > left, Local< String > right)
bool IsExternalOneByte() const
bool ContainsOnlyOneByte() const
ExternalStringResourceBase * GetExternalStringResourceBase(v8::Isolate *isolate, Encoding *encoding_out) const
Definition: v8-primitive.h:971
Encoding
Definition: v8-primitive.h:129
void WriteOneByteV2(Isolate *isolate, uint32_t offset, uint32_t length, uint8_t *buffer, int flags=WriteFlags::kNone) const
Local< String > InternalizeString(Isolate *isolate)
static MaybeLocal< String > NewFromUtf8(Isolate *isolate, const char *data, NewStringType type=NewStringType::kNormal, int length=-1)
void WriteV2(Isolate *isolate, uint32_t offset, uint32_t length, uint16_t *buffer, int flags=WriteFlags::kNone) const
const ExternalOneByteStringResource * GetExternalOneByteStringResource() const
size_t WriteUtf8V2(Isolate *isolate, char *buffer, size_t capacity, int flags=WriteFlags::kNone, size_t *processed_characters_return=nullptr) const
static MaybeLocal< String > NewExternalTwoByte(Isolate *isolate, ExternalStringResource *resource)
static String * Cast(v8::Data *data)
Definition: v8-primitive.h:457
static Local< String > Empty(Isolate *isolate)
Definition: v8-primitive.h:943
static MaybeLocal< String > NewFromTwoByte(Isolate *isolate, const uint16_t *data, NewStringType type=NewStringType::kNormal, int length=-1)
static Local< String > NewFromUtf8Literal(Isolate *isolate, const char(&literal)[N], NewStringType type=NewStringType::kNormal)
Definition: v8-primitive.h:474
ExternalStringResource * GetExternalStringResource() const
Definition: v8-primitive.h:951
Definition: v8-primitive.h:726
static Local< Symbol > GetDispose(Isolate *isolate)
static Local< Symbol > GetMatch(Isolate *isolate)
static Local< Symbol > GetIterator(Isolate *isolate)
static Symbol * Cast(Data *data)
Definition: v8-primitive.h:771
static Local< Symbol > ForApi(Isolate *isolate, Local< String > description)
static Local< Symbol > GetSearch(Isolate *isolate)
static Local< Symbol > GetToPrimitive(Isolate *isolate)
static Local< Symbol > GetAsyncIterator(Isolate *isolate)
static Local< Symbol > GetIsConcatSpreadable(Isolate *isolate)
static Local< Symbol > New(Isolate *isolate, Local< String > description=Local< String >())
static Local< Symbol > GetReplace(Isolate *isolate)
static Local< Symbol > GetAsyncDispose(Isolate *isolate)
static Local< Symbol > GetToStringTag(Isolate *isolate)
static Local< Symbol > GetSplit(Isolate *isolate)
static Local< Symbol > GetUnscopables(Isolate *isolate)
static Local< Symbol > For(Isolate *isolate, Local< String > description)
Local< Value > Description(Isolate *isolate) const
static Local< Symbol > GetHasInstance(Isolate *isolate)
Definition: v8-primitive.h:868
static Uint32 * Cast(v8::Data *data)
Definition: v8-primitive.h:871
Definition: v8-value.h:32
Definition: v8-internal.h:878
static Address ValueAsAddress(const T *value)
Definition: v8-internal.h:1723
uintptr_t Address
Definition: v8-internal.h:38
Definition: libplatform.h:15
Local< Primitive > Null(Isolate *isolate)
Definition: v8-primitive.h:1026
Local< Primitive > Undefined(Isolate *isolate)
Definition: v8-primitive.h:1018
Local< Boolean > False(Isolate *isolate)
Definition: v8-primitive.h:1042
Local< Boolean > True(Isolate *isolate)
Definition: v8-primitive.h:1034
NewStringType
Definition: v8-primitive.h:107
Definition: v8-primitive.h:160
#define V8_EXPORT
Definition: v8config.h:855
#define V8_INLINE
Definition: v8config.h:508
#define V8_DEPRECATE_SOON(message)
Definition: v8config.h:622
#define V8_WARN_UNUSED_RESULT
Definition: v8config.h:679