Libraries/jerryscript/src/include/Jerryscript/Types.h
Go to the documentation of this file.
32 };
38 };
44 };
50 };
87 };
96 };
105 {
118 {
162 }
191 }
206 std::swap(this->value, value.value);
241 Value(const String& s) : value(jerry_create_string_sz(reinterpret_cast<const jerry_char_t*>(s.c_str()), s.length()))
278 {
324 {
491 }
541 ExternalFunction(jerry_external_handler_t handler) : Value(OwnedValue{jerry_create_external_function(handler)})
562 }
567 }
584 {
606 }
718 };
736 Error(ErrorType type) : Value(OwnedValue{jerry_create_error_sz(jerry_error_t(type), nullptr, 0)})
745 jerry_error_t(type), reinterpret_cast<const jerry_char_t*>(message.c_str()), message.length())})
746 {
770 }
797 ArgumentError(const String& functionName) : Error(ErrorType::Type, functionName + F(": Invalid arguments"))
823 }
846 {
863 {
878 item.mIndex += distance;
885 }
916 }
1015 {
Value setProperty(const Value &name, const Value &value)
Set a property value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:645
Iterator end()
end
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:940
unsigned index() const
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:825
Error(ErrorType type, const String &message)
Error with type and message.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:753
ArgumentError(const String &functionName)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:807
size_t readString(unsigned offset, char *buffer, size_t length) const
Get content from within a string value.
XX(jt, t)
XX(name, value)
String subString(unsigned offset, size_t length) const
Get content from within a string value.
bool isBoolean() const
A true/false value type.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:390
FunctionType
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:50
XX(jt, t)
Value call(const Object &thisValue, const Value &arg)
Call with one argument.
bool isNull() const
Is this a NULL value?
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:414
bool isEmpty() const
An empty Value contains nothing, i.e. no javascript type has been assigned. This gets interpreted as ...
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:374
bool isObject() const
Is this an Object type? If so, can cast to Object class.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:430
Error(ErrorType type)
Error with type only.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:746
Value runFunction(const String &name, Value &arg)
Call a specified JavaScript function with exactly one argument.
Value()
Construct An empty (unused) value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:170
IndexedItem & operator=(const Value &value)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:840
Value & reset(jerry_value_t value=jerry_value_t(Ecma::VALUE_EMPTY))
Reset contents of object to new value (default is unassigned)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:299
Value & operator=(const Value &value)
Assignment copy operator.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:278
bool registerFunction(const String &name, jerry_external_handler_t handler)
Register an external function so it may be called from javascript.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:707
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:863
IndexedItem operator*()
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:902
Definition: Libraries/jerryscript/src/include/Jerryscript/Context.h:123
ErrorType errorType() const
Get type of error.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:777
Iterator operator+=(size_t distance)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:885
bool removeProperty(const Value &name)
Remove a property.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:675
Iterator begin()
begin
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:934
Vector< Value > List
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:165
bool isDefined() const
Contains a javascript value, but contents undefined.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:382
Represents a Jerryscript value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:162
NamedItem & operator=(const Value &value)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:584
bool isFalse() const
Is this a Boolean type set to False?
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:398
bool isString() const
Is this a String?
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:422
bool operator!=(const Iterator &rhs) const
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:897
Object global()
Get global context.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:1024
Array objects have properties accessed by index.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:815
Value getProperty(unsigned index) const
Get a property value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:972
Callable getFunction(const String &name)
Retrieve the given property as a function.
~Value()
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:270
#define JERRY_ECMA_MAP(XX)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:63
String toString(Jerryscript::Type type)
bool unregisterFunction(const String &name)
Unregister an external function.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:718
Use to initialise Value object to a string given a native/raw jerryscript value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:104
Used by as() method.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:490
Iterator & operator++()
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:872
bool isTrue() const
Is this a Boolean type set to True?
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:406
bool hasProperty(const Value &name) const
Determine if a property exists.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:665
XX(jt, t)
Object representing an external function implementation.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:548
Iterator and operator[] access uses this wrapper class so items may be written or read.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:823
const String & name() const
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:569
Use to create Value containing javascript 'undefined'.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:113
Type type() const
Get value type.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:447
Use to create Value containing javascript 'null'.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:126
FunctionType functionType() const
Get specific type of callable object.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:1015
const jerry_value_t value
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:131
Use to initialise Value object by copying native/raw jerryscript value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:95
Undefined()
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:114
jerry_value_t value
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:105
bool operator==(const IndexedItem &rhs) const
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:846
Use to initialise Value object by taking ownership of native/raw jerryscript value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:86
Iterator(const Iterator &)=default
Value setProperty(unsigned index, const Value &value)
Set a property value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:983
ObjectType
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:44
XX(jt, t)
bool isArray() const
Can this object be accessed as an array? If so, can cast to Array type.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:356
jerry_value_t release()
Get raw/native value and release ownership.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:333
Object()
Default constructor creates a new, empty object.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:606
jerry_value_t value
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:87
#define F(string_literal)
Wrap a string literal stored in flash and access it using a String object.
Definition: WString.h:113
ExternalFunction(jerry_external_handler_t handler)
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:551
Error object class.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:733
Callable object represent functions.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:993
const jerry_value_t & get() const
const get()
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:316
Iterator and operator[] access uses this wrapper class so items may be written or read.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:567
Value getProperty(const Value &name) const
Get a property value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:655
XX(jt, t)
bool isCallable() const
Is this object a function? If so, can cast to Callable type.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:348
bool isNumber() const
Does this value contain a Number?
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:438
const jerry_value_t value
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:118
NamedItem operator[](const String &name)
operator[] uses NamedItem proxy object so value can be assigned or read
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:626
bool isError() const
Determine if value represents an error. If so, can cast to Error type.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:365
Array(size_t size)
Create a new, fixed-size array with the given number of elements.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:916
T as() const
Get value of object with specific type. e.g. value.as<int>().
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:531
size_t count() const
Get number of elements in the array.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:923
Value toString() const
Create a new string value from this value.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:460
jerry_value_t value
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:96
bool operator==(const Iterator &rhs) const
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:892
IndexedItem operator[](unsigned index)
operator[] uses IndexedItem proxy object so value can be assigned or read
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:954
const Value & v
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:491
Objects support named properties.
Definition: Libraries/jerryscript/src/include/Jerryscript/Types.h:559