mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
9860d66a56
Related to #4186. Some notable changes: - The term 'Error' now strictly refers to native Error objects defined in the ECMA standard, which are ordinary objects. All other uses of 'error' or 'error reference' where the term refers to a thrown value is now called 'exception'. - Simplified the naming scheme of many String API functions. These functions will now also take an 'encoding' argument to specify the desired encoding in which to operate. - Removed the substring-copy-to-buffer functions. These functions behaved awkwardly, as they use character index to specify the start/end positions, and were mostly used incorrectly with byte offsets instead. The functionality can still be replicated with other functions if necessary. - String-to-buffer functions will no longer fail if the buffer is not sufficiently large, the string will instead be cropped. - Fixed the usage of the '_sz' prefix in many API functions. The term 'sz' means zero-terminated string in hungarian notation, this was used incorrectly in many cases. - Renamed most of the public API functions to have shorter, more on-point names, rather than the often too long descriptive names. Functions are now also grouped by the type of value they operate on, where this makes sense. JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai dbatyai@inf.u-szeged.hu
120 lines
4.6 KiB
C
120 lines
4.6 KiB
C
/* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* 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 JERRYX_HANDLER_H
|
|
#define JERRYX_HANDLER_H
|
|
|
|
#include "jerryscript.h"
|
|
|
|
JERRY_C_API_BEGIN
|
|
|
|
/*
|
|
* Handler registration helper
|
|
*/
|
|
|
|
jerry_value_t jerryx_handler_register_global (const char *name_p, jerry_external_handler_t handler_p);
|
|
|
|
/*
|
|
* Common external function handlers
|
|
*/
|
|
|
|
jerry_value_t jerryx_handler_assert_fatal (const jerry_call_info_t *call_info_p,
|
|
const jerry_value_t args_p[],
|
|
const jerry_length_t args_cnt);
|
|
jerry_value_t jerryx_handler_assert_throw (const jerry_call_info_t *call_info_p,
|
|
const jerry_value_t args_p[],
|
|
const jerry_length_t args_cnt);
|
|
jerry_value_t jerryx_handler_assert (const jerry_call_info_t *call_info_p,
|
|
const jerry_value_t args_p[],
|
|
const jerry_length_t args_cnt);
|
|
jerry_value_t
|
|
jerryx_handler_gc (const jerry_call_info_t *call_info_p, const jerry_value_t args_p[], const jerry_length_t args_cnt);
|
|
jerry_value_t jerryx_handler_print (const jerry_call_info_t *call_info_p,
|
|
const jerry_value_t args_p[],
|
|
const jerry_length_t args_cnt);
|
|
jerry_value_t jerryx_handler_source_name (const jerry_call_info_t *call_info_p,
|
|
const jerry_value_t args_p[],
|
|
const jerry_length_t args_cnt);
|
|
|
|
/**
|
|
* Struct used by the `jerryx_set_functions` method to
|
|
* register multiple methods for a given object.
|
|
*/
|
|
typedef struct
|
|
{
|
|
const char *name; /**< name of the property to add */
|
|
jerry_value_t value; /**< value of the property */
|
|
} jerryx_property_entry;
|
|
|
|
#define JERRYX_PROPERTY_NUMBER(NAME, NUMBER) \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NAME, jerry_number (NUMBER) \
|
|
}
|
|
#define JERRYX_PROPERTY_STRING(NAME, STR, SIZE) \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NAME, jerry_string ((const jerry_char_t *) STR, SIZE, JERRY_ENCODING_UTF8) \
|
|
}
|
|
#define JERRYX_PROPERTY_STRING_SZ(NAME, STR) \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NAME, jerry_string_sz (STR) \
|
|
}
|
|
#define JERRYX_PROPERTY_BOOLEAN(NAME, VALUE) \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NAME, jerry_boolean (VALUE) \
|
|
}
|
|
#define JERRYX_PROPERTY_FUNCTION(NAME, FUNC) \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NAME, jerry_function_external (FUNC) \
|
|
}
|
|
#define JERRYX_PROPERTY_UNDEFINED(NAME) \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NAME, jerry_undefined () \
|
|
}
|
|
#define JERRYX_PROPERTY_LIST_END() \
|
|
(jerryx_property_entry) \
|
|
{ \
|
|
NULL, 0 \
|
|
}
|
|
|
|
/**
|
|
* Stores the result of property register operation.
|
|
*/
|
|
typedef struct
|
|
{
|
|
jerry_value_t result; /**< result of property registration (undefined or error object) */
|
|
uint32_t registered; /**< number of successfully registered methods */
|
|
} jerryx_register_result;
|
|
|
|
jerryx_register_result jerryx_set_properties (const jerry_value_t target_object, const jerryx_property_entry entries[]);
|
|
|
|
void jerryx_release_property_entry (const jerryx_property_entry entries[],
|
|
const jerryx_register_result register_result);
|
|
|
|
jerry_value_t jerryx_set_property_str (const jerry_value_t target_object, const char *name, const jerry_value_t value);
|
|
|
|
jerry_value_t jerryx_get_property_str (const jerry_value_t target_object, const char *name);
|
|
|
|
bool jerryx_has_property_str (const jerry_value_t target_object, const char *name);
|
|
|
|
JERRY_C_API_END
|
|
|
|
#endif /* !JERRYX_HANDLER_H */
|