aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIstvan Miklos <imiklos2@inf.u-szeged.hu>2018-05-03 08:24:05 +0200
committerLászló Langó <llango.u-szeged@partner.samsung.com>2018-05-03 08:24:05 +0200
commitba2e49caaa6703dec7a83fb0b8586a91fac060eb (patch)
tree7074d9524022ecf38f9d949056a0a5701be6a44b /docs
parentd672d1e71cba94232fedffc93ca314b8ae1f130d (diff)
Rename the jerry_value_has_error_flag function. (#2290)
Rename the function to represent it's real functionality. JerryScript-DCO-1.0-Signed-off-by: Istvan Miklos imiklos2@inf.u-szeged.hu
Diffstat (limited to 'docs')
-rw-r--r--docs/02.API-REFERENCE.md100
-rw-r--r--docs/03.API-EXAMPLE.md6
-rw-r--r--docs/06.REFERENCE-COUNTING.md4
-rw-r--r--docs/07.DEBUGGER.md2
-rw-r--r--docs/09.EXT-REFERENCE-ARG.md6
-rw-r--r--docs/10.EXT-REFERENCE-HANDLER.md2
6 files changed, 59 insertions, 61 deletions
diff --git a/docs/02.API-REFERENCE.md b/docs/02.API-REFERENCE.md
index 6607bf4a..7905e30b 100644
--- a/docs/02.API-REFERENCE.md
+++ b/docs/02.API-REFERENCE.md
@@ -947,7 +947,7 @@ main (void)
/* Setup Global scope code */
jerry_value_t parsed_code = jerry_parse (NULL, 0, script, script_size, JERRY_PARSE_NO_OPTS);
- if (!jerry_value_has_error_flag (parsed_code))
+ if (!jerry_value_is_error (parsed_code))
{
/* Execute the parsed source code in the Global scope */
jerry_value_t ret_value = jerry_run (parsed_code);
@@ -1244,6 +1244,44 @@ jerry_value_is_constructor (const jerry_value_t value)
- [jerry_release_value](#jerry_release_value)
+## jerry_value_is_error
+
+**Summary**
+
+Returns whether the given `jerry_value_t` is error value.
+
+**Prototype**
+
+```c
+bool
+jerry_value_is_error (const jerry_value_t value);
+```
+
+- `value` - api value
+- return value
+ - true, if the given `jerry_value_t` is error value.
+ - false, otherwise
+
+**Example**
+
+```c
+{
+ jerry_value_t value;
+ ... // create or acquire value
+
+ if (jerry_value_is_error (value))
+ {
+ ...
+ }
+
+ jerry_release_value (value);
+}
+```
+
+**See also**
+
+- [jerry_value_t](#jerry_value_t)
+- [jerry_value_has_abort_flag](#jerry_value_has_abort_flag)
## jerry_value_is_function
@@ -1641,7 +1679,7 @@ If a non-error object is used as the input for the function the method
will return `JERRY_ERROR_NONE` indicating that the value was not
an Error object. However it is still possible that the value contains
error semantics. To correctly detect if a value have error use the
-[jerry_value_has_error_flag](#jerry_value_has_error_flag) method.
+[jerry_value_is_error](#jerry_value_is_error) method.
**Prototype**
@@ -1672,47 +1710,7 @@ jerry_get_error_type (const jerry_value_t value);
**See also**
- [jerry_create_error](#jerry_create_error)
-- [jerry_value_has_error_flag](#jerry_value_has_error_flag)
-
-## jerry_value_has_error_flag
-
-**Summary**
-
-Returns whether the given `jerry_value_t` has the error flag set.
-
-**Prototype**
-
-```c
-bool
-jerry_value_has_error_flag (const jerry_value_t value);
-```
-
-- `value` - api value
-- return value
- - true, if the given `jerry_value_t` has the error flag set
- - false, otherwise
-
-**Example**
-
-```c
-{
- jerry_value_t value;
- ... // create or acquire value
-
- if (jerry_value_has_error_flag (value))
- {
- ...
- }
-
- jerry_release_value (value);
-}
-```
-
-**See also**
-
-- [jerry_value_t](#jerry_value_t)
-- [jerry_value_has_abort_flag](#jerry_value_has_abort_flag)
-
+- [jerry_value_is_error](#jerry_value_is_error)
## jerry_value_has_abort_flag
@@ -1751,7 +1749,7 @@ jerry_value_has_abort_flag (const jerry_value_t value);
**See also**
- [jerry_value_t](#jerry_value_t)
-- [jerry_value_has_error_flag](#jerry_value_has_error_flag)
+- [jerry_value_is_error](#jerry_value_is_error)
## jerry_value_clear_error_flag
@@ -2647,7 +2645,7 @@ jerry_resolve_or_reject_promise (jerry_value_t promise,
argument,
is_resolve);
- if (jerry_value_has_error_flag (is_ok))
+ if (jerry_value_is_error (is_ok))
{
// handle the error.
}
@@ -2661,7 +2659,7 @@ jerry_resolve_or_reject_promise (jerry_value_t promise,
**See also**
- [jerry_release_value](#jerry_release_value)
-- [jerry_value_has_error_flag](#jerry_value_has_error_flag)
+- [jerry_value_is_error](#jerry_value_is_error)
# Acquire and release API values
@@ -2935,7 +2933,7 @@ jerry_create_error (jerry_error_t error_type,
**See also**
-- [jerry_value_has_error_flag](#jerry_value_has_error_flag)
+- [jerry_value_is_error](#jerry_value_is_error)
- [jerry_value_clear_error_flag](#jerry_value_clear_error_flag)
- [jerry_value_set_error_flag](#jerry_value_set_error_flag)
@@ -4174,7 +4172,7 @@ jerry_call_function (const jerry_value_t func_obj_val,
jerry_value_t this_val = jerry_create_undefined ();
jerry_value_t ret_val = jerry_call_function (val, this_val, NULL, 0);
- if (!jerry_value_has_error_flag (ret_val))
+ if (!jerry_value_is_error (ret_val))
{
... // handle return value
}
@@ -4229,7 +4227,7 @@ jerry_construct_object (const jerry_value_t func_obj_val,
{
jerry_value_t ret_val = jerry_construct_object (val, NULL, 0);
- if (!jerry_value_has_error_flag (ret_val))
+ if (!jerry_value_is_error (ret_val))
{
... // handle return value
}
@@ -4700,7 +4698,7 @@ find_my_object(const jerry_value_t candidate,
{
find_my_object_info_t *info_p = (find_my_object_info_t *) user_data_p;
jerry_value_t has_property = jerry_object_has_property (candidate, info_p->property_name);
- bool keep_searching = (jerry_value_has_error_flag (has_property) || !jerry_get_boolean_value ());
+ bool keep_searching = (jerry_value_is_error (has_property) || !jerry_get_boolean_value ());
if (!keep_searching)
{
/* We found it, so we acquire the value and record it. */
@@ -5885,4 +5883,4 @@ jerry_value_t jerry_json_stringfy (const jerry_value_t object_to_stringify)
jerry_release_value (value);
jerry_release_value (stringified);
}
-``` \ No newline at end of file
+```
diff --git a/docs/03.API-EXAMPLE.md b/docs/03.API-EXAMPLE.md
index fc691a00..45a63d68 100644
--- a/docs/03.API-EXAMPLE.md
+++ b/docs/03.API-EXAMPLE.md
@@ -57,7 +57,7 @@ main (void)
/* Setup Global scope code */
jerry_value_t parsed_code = jerry_parse (NULL, 0, script, script_size, JERRY_PARSE_NO_OPTS);
- if (!jerry_value_has_error_flag (parsed_code))
+ if (!jerry_value_is_error (parsed_code))
{
/* Execute the parsed source code in the Global scope */
jerry_value_t ret_value = jerry_run (parsed_code);
@@ -325,7 +325,7 @@ main (void)
false);
/* If command evaluated successfully, print value, returned by eval */
- if (jerry_value_has_error_flag (ret_val))
+ if (jerry_value_is_error (ret_val))
{
/* Evaluated JS code thrown an exception
* and didn't handle it with try-catch-finally */
@@ -462,7 +462,7 @@ add_handler (const jerry_value_t func_value, /**< function object */
jerry_value_t prop_name = jerry_create_string ((const jerry_char_t *) "x");
jerry_value_t x_val = jerry_get_property (this_val, prop_name);
- if (!jerry_value_has_error_flag (x_val))
+ if (!jerry_value_is_error (x_val))
{
/* Convert Jerry API values to double */
double x = jerry_get_number_value (x_val);
diff --git a/docs/06.REFERENCE-COUNTING.md b/docs/06.REFERENCE-COUNTING.md
index 5758adc0..629e4e67 100644
--- a/docs/06.REFERENCE-COUNTING.md
+++ b/docs/06.REFERENCE-COUNTING.md
@@ -61,7 +61,7 @@ behaviour through property getting and setting.
* prop_value contains a live reference to an error object.
* This reference must be released as well. */
- if (jerry_value_has_error_flag (prop_value))
+ if (jerry_value_is_error (prop_value))
{
/* Errors can be handled here. */
}
@@ -93,7 +93,7 @@ behaviour through property getting and setting.
/* The reference stored in the 'result' variable is live whether
* the operation is successful or not, and must also be freed. */
- if (jerry_value_has_error_flag (result))
+ if (jerry_value_is_error (result))
{
/* Errors can be handled here. */
}
diff --git a/docs/07.DEBUGGER.md b/docs/07.DEBUGGER.md
index 84653f2f..879504ac 100644
--- a/docs/07.DEBUGGER.md
+++ b/docs/07.DEBUGGER.md
@@ -305,7 +305,7 @@ wait_for_source_callback (const jerry_char_t *resource_name_p, /**< resource nam
source_size,
JERRY_PARSE_NO_OPTS);
- if (!jerry_value_has_error_flag (ret_val))
+ if (!jerry_value_is_error (ret_val))
{
jerry_value_t func_val = ret_val;
ret_val = jerry_run (func_val);
diff --git a/docs/09.EXT-REFERENCE-ARG.md b/docs/09.EXT-REFERENCE-ARG.md
index 715dc04b..c6065615 100644
--- a/docs/09.EXT-REFERENCE-ARG.md
+++ b/docs/09.EXT-REFERENCE-ARG.md
@@ -244,7 +244,7 @@ my_external_handler (const jerry_value_t function_obj,
mapping,
4);
- if (jerry_value_has_error_flag (rv))
+ if (jerry_value_is_error (rv))
{
/* Handle error. */
return rv;
@@ -640,7 +640,7 @@ my_external_handler (const jerry_value_t function_obj,
mapping,
1);
- if (jerry_value_has_error_flag (rv))
+ if (jerry_value_is_error (rv))
{
/* Handle error. */
return rv;
@@ -731,7 +731,7 @@ my_external_handler (const jerry_value_t function_obj,
mapping,
1);
- if (jerry_value_has_error_flag (rv))
+ if (jerry_value_is_error (rv))
{
/* Handle error. */
return rv;
diff --git a/docs/10.EXT-REFERENCE-HANDLER.md b/docs/10.EXT-REFERENCE-HANDLER.md
index 431ab8be..5a80375e 100644
--- a/docs/10.EXT-REFERENCE-HANDLER.md
+++ b/docs/10.EXT-REFERENCE-HANDLER.md
@@ -136,7 +136,7 @@ register_common_functions (void)
{
jerry_value_t ret = jerry_create_undefined ();
- for (int i = 0; common_functions[i].name_p != NULL && !jerry_value_has_error_flag (ret); i++)
+ for (int i = 0; common_functions[i].name_p != NULL && !jerry_value_is_error (ret); i++)
{
ret = jerryx_handler_register_global ((const jerry_char_t *) common_functions[i].name_p,
common_functions[i].handler_p);