Update jerry API

 * Fix error handling (related issue: #1141)
 * Move output paramters to the end of the arguments lists
 * Inline small functions

JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]

Author: LaszloLango

jerry-core/jerry-api.h

@@ -96,9 +96,9 @@ typedef uint32_t jerry_value_t;
  */
 typedef bool (*jerry_external_handler_t) (const jerry_object_t *function_obj_p,
                                           const jerry_value_t this_val,
-                                          jerry_value_t *ret_val_p,
                                           const jerry_value_t args_p[],
-                                          const jerry_length_t args_count);
+                                          const jerry_length_t args_count,
+                                          jerry_value_t *ret_val_p);
 
 /**
  * Native free callback of an object
@@ -197,15 +197,15 @@ bool jerry_is_constructor (const jerry_object_t *);
 bool jerry_is_function (const jerry_object_t *);
 bool jerry_add_object_field (jerry_object_t *, const jerry_char_t *, jerry_size_t, const jerry_value_t, bool);
 bool jerry_delete_object_field (jerry_object_t *, const jerry_char_t *, jerry_size_t);
-bool jerry_get_object_field_value (jerry_object_t *, const jerry_char_t *, jerry_value_t *);
-bool jerry_get_object_field_value_sz (jerry_object_t *, const jerry_char_t *, jerry_size_t, jerry_value_t *);
+jerry_value_t jerry_get_object_field_value (jerry_object_t *, const jerry_char_t *);
+jerry_value_t jerry_get_object_field_value_sz (jerry_object_t *, const jerry_char_t *, jerry_size_t);
 bool jerry_set_object_field_value (jerry_object_t *, const jerry_char_t *, const jerry_value_t);
 bool jerry_set_object_field_value_sz (jerry_object_t *, const jerry_char_t *, jerry_size_t, const jerry_value_t);
 bool jerry_foreach_object_field (jerry_object_t *, jerry_object_field_foreach_t, void *);
 bool jerry_get_object_native_handle (jerry_object_t *, uintptr_t *);
 void jerry_set_object_native_handle (jerry_object_t *, uintptr_t, jerry_object_free_callback_t);
-bool jerry_construct_object (jerry_object_t *, jerry_value_t *, const jerry_value_t[], uint16_t);
-bool jerry_call_function (jerry_object_t *, jerry_object_t *, jerry_value_t *, const jerry_value_t[], uint16_t);
+bool jerry_construct_object (jerry_object_t *, const jerry_value_t[], uint16_t, jerry_value_t *);
+bool jerry_call_function (jerry_object_t *, jerry_object_t *, const jerry_value_t[], uint16_t, jerry_value_t *);
 
 /**
  * @}

jerry-core/jerry.c

@@ -124,10 +124,19 @@ jerry_make_api_unavailable (void)
   jerry_api_available = false;
 } /* jerry_make_api_unavailable */
 
+/**
+ * Returns whether the given jerry_value_t is error.
+ */
+inline bool __attr_always_inline___
+jerry_value_is_error (const jerry_value_t value) /**< api value */
+{
+  return ECMA_IS_VALUE_ERROR (value);
+} /* jerry_value_is_error */
+
 /**
  * Returns whether the given jerry_value_t is null.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_null (const jerry_value_t value) /**< api value */
 {
   return ecma_is_value_null (value);
@@ -136,7 +145,7 @@ jerry_value_is_null (const jerry_value_t value) /**< api value */
 /**
  * Returns whether the given jerry_value_t is undefined.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_undefined (const jerry_value_t value) /**< api value */
 {
   return ecma_is_value_undefined (value);
@@ -145,7 +154,7 @@ jerry_value_is_undefined (const jerry_value_t value) /**< api value */
 /**
  * Returns whether the given jerry_value_t has boolean type.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_boolean (const jerry_value_t value) /**< api value */
 {
   return ecma_is_value_boolean (value);
@@ -157,7 +166,7 @@ jerry_value_is_boolean (const jerry_value_t value) /**< api value */
  * More specifically, returns true if the type is JERRY_DATA_TYPE_FLOAT32,
  * JERRY_DATA_TYPE_FLOAT64 or JERRY_DATA_TYPE_UINT32, false otherwise.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_number (const jerry_value_t value) /**< api value */
 {
   return ecma_is_value_number (value);
@@ -166,7 +175,7 @@ jerry_value_is_number (const jerry_value_t value) /**< api value */
 /**
  * Returns whether the given jerry_value_t is string.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_string (const jerry_value_t value) /**< api value */
 {
   return ecma_is_value_string (value);
@@ -175,7 +184,7 @@ jerry_value_is_string (const jerry_value_t value) /**< api value */
 /**
  * Returns whether the given jerry_value_t is object.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_object (const jerry_value_t value) /**< api value */
 {
   return ecma_is_value_object (value);
@@ -184,7 +193,7 @@ jerry_value_is_object (const jerry_value_t value) /**< api value */
 /**
  * Returns whether the given jerry_value_t is a function object.
  */
-bool
+inline bool __attr_always_inline___
 jerry_value_is_function (const jerry_value_t value) /**< api value */
 {
   return ecma_op_is_callable (value);
@@ -310,10 +319,10 @@ jerry_create_string_value (jerry_string_t *str_p) /**< jerry_string_t from which
  *
  * @return completion code
  */
-inline static jerry_completion_code_t __attr_always_inline___
-jerry_convert_eval_completion_to_retval (jerry_value_t *retval_p, /**< [out] api value */
-                                         ecma_value_t completion) /**< completion of 'eval'-mode
+static inline jerry_completion_code_t __attr_always_inline___
+jerry_convert_eval_completion_to_retval (ecma_value_t completion, /**< completion of 'eval'-mode
                                                                    *   code execution */
+                                         jerry_value_t *retval_p) /**< [out] api value */
 {
   *retval_p = completion;
 
@@ -715,9 +724,9 @@ jerry_dispatch_external_function (ecma_object_t *function_object_p, /**< externa
 
   bool is_successful = ((jerry_external_handler_t) handler_p) (function_object_p,
                                                                this_arg_value,
-                                                               &ret_value,
                                                                arguments_list_p,
-                                                               arguments_list_len);
+                                                               arguments_list_len,
+                                                               &ret_value);
 
   if (!is_successful)
   {
@@ -877,14 +886,13 @@ jerry_delete_object_field (jerry_object_t *object_p, /**< object to delete field
  *                - there is field with specified name in the object;
  *         false - otherwise.
  */
-bool jerry_get_object_field_value (jerry_object_t *object_p, /**< object */
-                                   const jerry_char_t *field_name_p, /**< field name */
-                                   jerry_value_t *field_value_p) /**< [out] field value */
+jerry_value_t
+jerry_get_object_field_value (jerry_object_t *object_p, /**< object */
+                              const jerry_char_t *field_name_p) /**< field name */
 {
   return jerry_get_object_field_value_sz (object_p,
                                           field_name_p,
-                                          lit_zt_utf8_string_size (field_name_p),
-                                          field_value_p);
+                                          lit_zt_utf8_string_size (field_name_p));
 } /* jerry_get_object_field_value */
 
 /**
@@ -946,35 +954,29 @@ jerry_foreach_object_field (jerry_object_t *object_p, /**< object */
  *      if value was retrieved successfully, it should be freed
  *      with jerry_release_value just when it becomes unnecessary.
  *
- * @return true, if field value was retrieved successfully, i.e. upon the call:
- *                - there is field with specified name in the object;
- *         false - otherwise.
+ * @return ecma value
  */
-bool
+jerry_value_t
 jerry_get_object_field_value_sz (jerry_object_t *object_p, /**< object */
                                  const jerry_char_t *field_name_p, /**< name of the field */
-                                 jerry_size_t field_name_size, /**< size of field name in bytes */
-                                 jerry_value_t *field_value_p) /**< [out] field value, if retrieved successfully */
+                                 jerry_size_t field_name_size) /**< size of field name in bytes */
 {
   jerry_assert_api_available ();
 
   ecma_string_t *field_name_str_p = ecma_new_ecma_string_from_utf8 ((lit_utf8_byte_t *) field_name_p,
                                                                     (lit_utf8_size_t) field_name_size);
 
-  *field_value_p = ecma_op_object_get (object_p, field_name_str_p);
+  ecma_value_t field_value = ecma_op_object_get (object_p, field_name_str_p);
 
   ecma_deref_ecma_string (field_name_str_p);
 
-  return (!ECMA_IS_VALUE_ERROR (*field_value_p)
-          && !ecma_is_value_undefined (*field_value_p));
+  return field_value;
 } /* jerry_get_object_field_value_sz */
 
 /**
  * Set value of field in the specified object
  *
- * @return true, if field value was set successfully, i.e. upon the call:
- *                - field value is writable;
- *         false - otherwise.
+ * @return ecma value
  */
 bool
 jerry_set_object_field_value (jerry_object_t *object_p, /**< object */
@@ -1112,12 +1114,12 @@ jerry_invoke_function (bool is_invoke_as_constructor, /**< true - invoke functio
                                                     *            if function is invoked as constructor;
                                                     *            in case of simple function call set 'this'
                                                     *            binding to the global object) */
-                       jerry_value_t *retval_p, /**< pointer to place for function's
-                                                 *   return value / thrown exception value
-                                                 *   or NULL (to ignore the values) */
                        const jerry_value_t args_p[], /**< function's call arguments
                                                       *   (NULL if arguments number is zero) */
-                       jerry_length_t args_count) /**< number of the arguments */
+                       jerry_length_t args_count, /**< number of the arguments */
+                       jerry_value_t *retval_p) /**< pointer to place for function's
+                                                 *   return value / thrown exception value
+                                                 *   or NULL (to ignore the values) */
 {
   JERRY_ASSERT (args_count == 0 || args_p != NULL);
   JERRY_STATIC_ASSERT (sizeof (args_count) == sizeof (ecma_length_t),
@@ -1173,13 +1175,14 @@ jerry_invoke_function (bool is_invoke_as_constructor, /**< true - invoke functio
 
 /**
  * Construct new TypeError object
+ *
+ * @return TypeError object value
  */
-static void
-jerry_construct_type_error (jerry_value_t *retval_p) /**< [out] value with constructed
-                                                      *         TypeError object */
+static inline jerry_value_t __attr_always_inline___
+jerry_construct_type_error (void)
 {
   ecma_object_t *type_error_obj_p = ecma_new_standard_error (ECMA_ERROR_TYPE);
-  *retval_p = ecma_make_object_value (type_error_obj_p);
+  return ecma_make_object_value (type_error_obj_p);
 } /* jerry_construct_type_error */
 
 /**
@@ -1200,24 +1203,24 @@ bool
 jerry_call_function (jerry_object_t *function_object_p, /**< function object to call */
                      jerry_object_t *this_arg_p, /**< object for 'this' binding
                                                   *   or NULL (set 'this' binding to the global object) */
-                     jerry_value_t *retval_p, /**< pointer to place for function's
-                                               *   return value / thrown exception value
-                                               *   or NULL (to ignore the values) */
                      const jerry_value_t args_p[], /**< function's call arguments
                                                     *   (NULL if arguments number is zero) */
-                     uint16_t args_count) /**< number of the arguments */
+                     uint16_t args_count, /**< number of the arguments */
+                     jerry_value_t *retval_p) /**< [out] pointer to place for function's
+                                               *   return value / thrown exception value
+                                               *   or NULL (to ignore the values) */
 {
   jerry_assert_api_available ();
 
   if (jerry_is_function (function_object_p))
   {
-    return jerry_invoke_function (false, function_object_p, this_arg_p, retval_p, args_p, args_count);
+    return jerry_invoke_function (false, function_object_p, this_arg_p, args_p, args_count, retval_p);
   }
   else
   {
     if (retval_p != NULL)
     {
-      jerry_construct_type_error (retval_p);
+      *retval_p = jerry_construct_type_error ();
     }
 
     return false;
@@ -1240,24 +1243,24 @@ jerry_call_function (jerry_object_t *function_object_p, /**< function object to
  */
 bool
 jerry_construct_object (jerry_object_t *function_object_p, /**< function object to call */
-                        jerry_value_t *retval_p, /**< pointer to place for function's
-                                                  *   return value / thrown exception value
-                                                  *   or NULL (to ignore the values) */
                         const jerry_value_t args_p[], /**< function's call arguments
                                                        *   (NULL if arguments number is zero) */
-                        uint16_t args_count) /**< number of the arguments */
+                        uint16_t args_count, /**< number of the arguments */
+                        jerry_value_t *retval_p) /**< [out] pointer to place for function's
+                                                  *   return value / thrown exception value
+                                                  *   or NULL (to ignore the values) */
 {
   jerry_assert_api_available ();
 
   if (jerry_is_constructor (function_object_p))
   {
-    return jerry_invoke_function (true, function_object_p, NULL, retval_p, args_p, args_count);
+    return jerry_invoke_function (true, function_object_p, NULL, args_p, args_count, retval_p);
   }
   else
   {
     if (retval_p != NULL)
     {
-      jerry_construct_type_error (retval_p);
+      *retval_p = jerry_construct_type_error ();
     }
 
     return false;
@@ -1306,7 +1309,7 @@ jerry_eval (const jerry_char_t *source_p, /**< source code */
                                                        is_direct,
                                                        is_strict);
 
-  status = jerry_convert_eval_completion_to_retval (retval_p, completion);
+  status = jerry_convert_eval_completion_to_retval (completion, retval_p);
 
   return status;
 } /* jerry_eval */
@@ -2086,7 +2089,7 @@ jerry_exec_snapshot (const void *snapshot_p, /**< snapshot */
     /* vm should be already initialized */
     ecma_value_t completion = vm_run_eval (bytecode_p, false);
 
-    ret_code = jerry_convert_eval_completion_to_retval (retval_p, completion);
+    ret_code = jerry_convert_eval_completion_to_retval (completion, retval_p);
 
     ecma_free_value (completion);
   }

main-unix.c

@@ -74,9 +74,9 @@ read_file (const char *file_name,
 static bool
 assert_handler (const jerry_object_t *function_obj_p __attribute__((unused)), /**< function object */
                 const jerry_value_t this_p __attribute__((unused)), /**< this arg */
-                jerry_value_t *ret_val_p __attribute__((unused)), /**< return argument */
                 const jerry_value_t args_p[], /**< function arguments */
-                const jerry_length_t args_cnt) /**< number of function arguments */
+                const jerry_length_t args_cnt, /**< number of function arguments */
+                jerry_value_t *ret_val_p __attribute__((unused))) /**< return argument */
 {
   if (args_cnt == 1
       && jerry_value_is_boolean (args_p[0])
@@ -417,9 +417,10 @@ main (int argc,
     bool is_done = false;
 
     jerry_object_t *global_obj_p = jerry_get_global ();
-    jerry_value_t print_function;
+    jerry_value_t print_function = jerry_get_object_field_value (global_obj_p,
+                                                                 (jerry_char_t *) "print");
 
-    if (!jerry_get_object_field_value (global_obj_p, (jerry_char_t *) "print", &print_function))
+    if (jerry_value_is_error (print_function))
     {
       return JERRY_STANDALONE_EXIT_CODE_FAIL;
     }
@@ -464,9 +465,9 @@ main (int argc,
         jerry_value_t ret_val_print;
         if (jerry_call_function (jerry_get_object_value (print_function),
                                  NULL,
-                                 &ret_val_print,
                                  args,
-                                 1))
+                                 1,
+                                 &ret_val_print))
         {
           jerry_release_value (ret_val_print);
         }