mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
d31eb3c4cb
1. jerry_api_create_array_object : create array object of given size 2. jerry_api_set_array_index_value : set value at given index 3. jerry_api_get_array_index_value : get value at given index JerryScript-DCO-1.0-Signed-off-by: chunseok lee chunseok.lee@samsung.com
264 lines
8.9 KiB
C
264 lines
8.9 KiB
C
/* Copyright 2015 Samsung Electronics Co., Ltd.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef JERRY_API_H
|
|
#define JERRY_API_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <sys/types.h>
|
|
|
|
#ifdef __cplusplus
|
|
# define EXTERN_C "C"
|
|
#else /* !__cplusplus */
|
|
# define EXTERN_C
|
|
#endif /* !__cplusplus */
|
|
|
|
/** \addtogroup jerry Jerry engine interface
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Jerry completion codes
|
|
*/
|
|
typedef enum
|
|
{
|
|
JERRY_COMPLETION_CODE_OK = 0, /**< successful completion */
|
|
JERRY_COMPLETION_CODE_UNHANDLED_EXCEPTION = 1, /**< exception occured and it was not handled */
|
|
} jerry_completion_code_t;
|
|
|
|
/**
|
|
* Jerry API data types
|
|
*/
|
|
typedef enum
|
|
{
|
|
JERRY_API_DATA_TYPE_VOID, /**< no return value */
|
|
JERRY_API_DATA_TYPE_UNDEFINED, /**< undefined */
|
|
JERRY_API_DATA_TYPE_NULL, /**< null */
|
|
JERRY_API_DATA_TYPE_BOOLEAN, /**< bool */
|
|
JERRY_API_DATA_TYPE_FLOAT32, /**< 32-bit float */
|
|
JERRY_API_DATA_TYPE_FLOAT64, /**< 64-bit float */
|
|
JERRY_API_DATA_TYPE_UINT32, /**< number converted to 32-bit unsigned integer */
|
|
JERRY_API_DATA_TYPE_STRING, /**< string */
|
|
JERRY_API_DATA_TYPE_OBJECT /**< object */
|
|
} jerry_api_data_type_t;
|
|
|
|
/**
|
|
* Jerry API Error object types
|
|
*/
|
|
typedef enum
|
|
{
|
|
JERRY_API_ERROR_COMMON, /**< Error */
|
|
JERRY_API_ERROR_EVAL, /**< EvalError */
|
|
JERRY_API_ERROR_RANGE, /**< RangeError */
|
|
JERRY_API_ERROR_REFERENCE, /**< ReferenceError */
|
|
JERRY_API_ERROR_SYNTAX, /**< SyntaxError */
|
|
JERRY_API_ERROR_TYPE, /**< TypeError */
|
|
JERRY_API_ERROR_URI /**< URIError */
|
|
} jerry_api_error_t;
|
|
|
|
/**
|
|
* Jerry's char value
|
|
*/
|
|
typedef uint8_t jerry_api_char_t;
|
|
|
|
/**
|
|
* Pointer to an array of character values
|
|
*/
|
|
typedef jerry_api_char_t* jerry_api_char_ptr_t;
|
|
|
|
/**
|
|
* Jerry's size
|
|
*/
|
|
typedef uint32_t jerry_api_size_t;
|
|
|
|
/**
|
|
* Jerry's length
|
|
*/
|
|
typedef uint32_t jerry_api_length_t;
|
|
|
|
/**
|
|
* Jerry's string value
|
|
*/
|
|
typedef struct ecma_string_t jerry_api_string_t;
|
|
|
|
/**
|
|
* Jerry's object value
|
|
*/
|
|
typedef struct ecma_object_t jerry_api_object_t;
|
|
|
|
/**
|
|
* Description of an extension function's argument
|
|
*/
|
|
typedef struct jerry_api_value_t
|
|
{
|
|
jerry_api_data_type_t type; /**< argument data type */
|
|
|
|
union
|
|
{
|
|
bool v_bool; /**< boolean */
|
|
|
|
float v_float32; /**< 32-bit float */
|
|
double v_float64; /**< 64-bit float */
|
|
|
|
uint32_t v_uint32; /**< number converted 32-bit unsigned integer */
|
|
|
|
union
|
|
{
|
|
jerry_api_string_t *v_string; /**< pointer to a JS string */
|
|
jerry_api_object_t *v_object; /**< pointer to a JS object */
|
|
};
|
|
};
|
|
} jerry_api_value_t;
|
|
|
|
/**
|
|
* Jerry external function handler type
|
|
*/
|
|
typedef bool (*jerry_external_handler_t) (const jerry_api_object_t *function_obj_p,
|
|
const jerry_api_value_t *this_p,
|
|
jerry_api_value_t *ret_val_p,
|
|
const jerry_api_value_t args_p[],
|
|
const jerry_api_length_t args_count);
|
|
|
|
/**
|
|
* An object's native free callback
|
|
*/
|
|
typedef void (*jerry_object_free_callback_t) (const uintptr_t native_p);
|
|
|
|
extern EXTERN_C ssize_t
|
|
jerry_api_string_to_char_buffer (const jerry_api_string_t *string_p,
|
|
jerry_api_char_t *buffer_p,
|
|
ssize_t buffer_size);
|
|
extern EXTERN_C
|
|
jerry_api_string_t* jerry_api_acquire_string (jerry_api_string_t *string_p);
|
|
extern EXTERN_C
|
|
void jerry_api_release_string (jerry_api_string_t *string_p);
|
|
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_acquire_object (jerry_api_object_t *object_p);
|
|
extern EXTERN_C
|
|
void jerry_api_release_object (jerry_api_object_t *object_p);
|
|
|
|
extern EXTERN_C
|
|
void jerry_api_release_value (jerry_api_value_t *value_p);
|
|
|
|
extern EXTERN_C
|
|
jerry_api_string_t *jerry_api_create_string (const jerry_api_char_t *v);
|
|
extern EXTERN_C
|
|
jerry_api_string_t *jerry_api_create_string_sz (const jerry_api_char_t *, jerry_api_size_t);
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_create_object (void);
|
|
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_create_array_object (jerry_api_size_t);
|
|
extern EXTERN_C
|
|
bool jerry_api_set_array_index_value (jerry_api_object_t *array_obj_p,
|
|
jerry_api_length_t index,
|
|
jerry_api_value_t *value_p);
|
|
extern EXTERN_C
|
|
bool jerry_api_get_array_index_value (jerry_api_object_t *array_obj_p,
|
|
jerry_api_length_t index,
|
|
jerry_api_value_t *value_p);
|
|
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_create_error (jerry_api_error_t error_type,
|
|
const jerry_api_char_t *message_p);
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_create_error_sz (jerry_api_error_t error_type,
|
|
const jerry_api_char_t *message_p,
|
|
jerry_api_size_t message_size);
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_create_external_function (jerry_external_handler_t handler_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_is_function (const jerry_api_object_t *object_p);
|
|
extern EXTERN_C
|
|
bool jerry_api_is_constructor (const jerry_api_object_t *object_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_add_object_field (jerry_api_object_t *object_p,
|
|
const jerry_api_char_t *field_name_p,
|
|
jerry_api_size_t field_name_size,
|
|
const jerry_api_value_t *field_value_p,
|
|
bool is_writable);
|
|
extern EXTERN_C
|
|
bool jerry_api_delete_object_field (jerry_api_object_t *object_p,
|
|
const jerry_api_char_t *field_name_p,
|
|
jerry_api_size_t field_name_size);
|
|
extern EXTERN_C
|
|
bool jerry_api_get_object_field_value (jerry_api_object_t *object_p,
|
|
const jerry_api_char_t *field_name_p,
|
|
jerry_api_value_t *field_value_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_get_object_field_value_sz (jerry_api_object_t *object_p,
|
|
const jerry_api_char_t *field_name_p,
|
|
jerry_api_size_t field_name_size,
|
|
jerry_api_value_t *field_value_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_set_object_field_value (jerry_api_object_t *object_p,
|
|
const jerry_api_char_t *field_name_p,
|
|
const jerry_api_value_t *field_value_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_set_object_field_value_sz (jerry_api_object_t *object_p,
|
|
const jerry_api_char_t *field_name_p,
|
|
jerry_api_size_t field_name_size,
|
|
const jerry_api_value_t *field_value_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_get_object_native_handle (jerry_api_object_t *object_p, uintptr_t* out_handle_p);
|
|
|
|
extern EXTERN_C
|
|
void jerry_api_set_object_native_handle (jerry_api_object_t *object_p,
|
|
uintptr_t handle,
|
|
jerry_object_free_callback_t freecb_p);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_call_function (jerry_api_object_t *function_object_p,
|
|
jerry_api_object_t *this_arg_p,
|
|
jerry_api_value_t *retval_p,
|
|
const jerry_api_value_t args_p[],
|
|
uint16_t args_count);
|
|
|
|
extern EXTERN_C
|
|
bool jerry_api_construct_object (jerry_api_object_t *function_object_p,
|
|
jerry_api_value_t *retval_p,
|
|
const jerry_api_value_t args_p[],
|
|
uint16_t args_count);
|
|
|
|
extern EXTERN_C
|
|
jerry_completion_code_t jerry_api_eval (const jerry_api_char_t *source_p,
|
|
size_t source_size,
|
|
bool is_direct,
|
|
bool is_strict,
|
|
jerry_api_value_t *retval_p);
|
|
|
|
extern EXTERN_C
|
|
jerry_api_object_t* jerry_api_get_global (void);
|
|
|
|
extern EXTERN_C
|
|
void jerry_register_external_magic_strings (const jerry_api_char_ptr_t* ex_str_items,
|
|
uint32_t count,
|
|
const jerry_api_length_t* str_lengths);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* !JERRY_API_H */
|