update on 5/3

* change api name
* no countdown of js_arg_cnt in iterator
* iterator var name: js_arg_iter_p

JerryScript-DCO-1.0-Signed-off-by: Zidong Jiang [email protected]

Author: jiangzidong

jerry-ext/args/arg-transform-functions.c

@@ -16,43 +16,59 @@
 #include "jerryscript-ext/args.h"
 #include "jerryscript.h"
 
+/**
+ * Pop the current JS argument from the iterator.
+ * It will change the index and js_arg_p value in the iterator.
+ *
+ * @return the current JS argument.
+ */
 jerry_value_t
-jerryx_arg_js_iterator_pop (jerryx_arg_js_iterator_t *js_args)
+jerryx_arg_js_iterator_pop (jerryx_arg_js_iterator_t *js_arg_iter_p) /**< the JS arg iterator */
 {
-  js_args->js_arg_idx++;
-  return js_args->js_arg_cnt-- > 0 ? *js_args->js_arg_p++ : jerry_create_undefined ();
+  return (js_arg_iter_p->js_arg_idx++ < js_arg_iter_p->js_arg_cnt ? *js_arg_iter_p->js_arg_p++
+                                                                  : jerry_create_undefined ());
 } /* jerryx_arg_js_iterator_pop */
 
+/**
+ * Get the current JS argument from the iterator.
+ *
+ * Note:
+ *     Unlike jerryx_arg_iterator_pop, it will not change index and
+ *     js_arg_p value in the iterator.
+ *
+ * @return the current JS argument.
+ */
 jerry_value_t
-jerryx_arg_js_iterator_peek (jerryx_arg_js_iterator_t *js_args)
+jerryx_arg_js_iterator_peek (jerryx_arg_js_iterator_t *js_arg_iter_p) /**< the JS arg iterator */
 {
-  return js_args->js_arg_cnt > 0 ? *js_args->js_arg_p : jerry_create_undefined ();
+  return (js_arg_iter_p->js_arg_idx < js_arg_iter_p->js_arg_cnt ? *js_arg_iter_p->js_arg_p
+                                                                : jerry_create_undefined ());
 } /* jerryx_arg_js_iterator_peek */
 
 /**
  * The common function to deal with optional arguments.
  */
 static jerry_value_t
-jerryx_arg_transform_optional (jerryx_arg_js_iterator_t *js_args, /**< available JS args */
+jerryx_arg_transform_optional (jerryx_arg_js_iterator_t *js_arg_iter_p, /**< available JS args */
                                const jerryx_arg_t *c_arg_p, /**< native arg */
                                jerryx_arg_transform_func_t func) /**< the core transform function */
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_peek (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_peek (js_arg_iter_p);
 
   if (jerry_value_is_undefined (js_arg))
   {
     return js_arg;
   }
 
-  return func (js_args, c_arg_p);
+  return func (js_arg_iter_p, c_arg_p);
 } /* jerryx_arg_transform_optional */
 
 /**
  * Tranform a JS argument to a double. Type coercion is not allowed.
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_number_strict)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   if (!jerry_value_is_number (js_arg))
   {
@@ -71,7 +87,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_number_strict)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_number)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   jerry_value_t to_number = jerry_value_to_number (js_arg);
 
@@ -95,7 +111,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_number)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_boolean_strict)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   if (!jerry_value_is_boolean (js_arg))
   {
@@ -114,7 +130,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_boolean_strict)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_boolean)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   bool to_boolean = jerry_value_to_boolean (js_arg);
 
@@ -126,6 +142,9 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_boolean)
 
 /**
  * The common routine for string tranformor.
+ *
+ * @return jerry undefined: the validator passes,
+ *         jerry error: the validator fails.
  */
 static jerry_value_t
 jerryx_arg_string_common_routine (jerry_value_t js_arg, /**< JS arg */
@@ -149,7 +168,7 @@ jerryx_arg_string_common_routine (jerry_value_t js_arg, /**< JS arg */
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_string_strict)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   if (!jerry_value_is_string (js_arg))
   {
@@ -165,7 +184,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_string_strict)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_string)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   jerry_value_t to_string = jerry_value_to_string (js_arg);
 
@@ -188,7 +207,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_string)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_function)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   if (!jerry_value_is_function (js_arg))
   {
@@ -208,7 +227,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_function)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_native_pointer)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
 
   if (!jerry_value_is_object (js_arg))
   {
@@ -237,7 +256,7 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_native_pointer)
 #define JERRYX_ARG_TRANSFORM_OPTIONAL(type) \
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_ ## type ## _optional) \
 { \
-  return jerryx_arg_transform_optional (js_args, c_arg_p, jerryx_arg_transform_ ## type); \
+  return jerryx_arg_transform_optional (js_arg_iter_p, c_arg_p, jerryx_arg_transform_ ## type); \
 }
 
 JERRYX_ARG_TRANSFORM_OPTIONAL (number)
@@ -254,7 +273,7 @@ JERRYX_ARG_TRANSFORM_OPTIONAL (native_pointer)
  */
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_ignore)
 {
-  (void) js_args; /* unused */
+  (void) js_arg_iter_p; /* unused */
   (void) c_arg_p; /* unused */
 
   return jerry_create_undefined ();

jerry-ext/args/args.c

@@ -18,10 +18,13 @@
 
 /**
  * Validate the JS arguments and assign them to the native arguments.
+ *
+ * @return jerry undefined: the validator passes,
+ *         jerry error: the validator fails.
  */
 jerry_value_t
 jerryx_arg_transform_args (const jerry_value_t *js_arg_p, /**< points to the js argument */
-                           jerry_length_t js_arg_cnt, /**< the count of the js arguments */
+                           const jerry_length_t js_arg_cnt, /**< the count of the js arguments */
                            const jerryx_arg_t *c_arg_p, /**< points to the jerryx_arg_t */
                            jerry_length_t c_arg_cnt) /**< the count of the native argument */
 {
@@ -45,17 +48,20 @@ jerryx_arg_transform_args (const jerry_value_t *js_arg_p, /**< points to the js
 /**
  * Validate the this value and the JS arguments,
  * and assign them to the native arguments.
+ *
+ * @return jerry undefined: the validator passes,
+ *         jerry error: the validator fails.
  */
 jerry_value_t
-jerryx_arg_transform_all (const jerry_value_t this_val, /**< the this_val for the external function */
-                          const jerry_value_t *js_arg_p, /**< points to the js argument */
-                          jerry_length_t js_arg_cnt, /**< the count of the js arguments */
-                          const jerryx_arg_t *c_arg_p, /**< points to the jerryx_arg_t */
-                          jerry_length_t c_arg_cnt) /**< the count of the native argument */
+jerryx_arg_transform_args_with_this (const jerry_value_t this_val, /**< the this_val for the external function */
+                                     const jerry_value_t *js_arg_p, /**< points to the js argument */
+                                     const jerry_length_t js_arg_cnt, /**< the count of the js arguments */
+                                     const jerryx_arg_t *c_arg_p, /**< points to the jerryx_arg_t */
+                                     jerry_length_t c_arg_cnt) /**< the count of the native argument */
 {
   if (c_arg_cnt == 0)
   {
-    return 0;
+    return jerry_create_undefined ();
   }
 
   jerryx_arg_js_iterator_t iterator =
@@ -75,4 +81,4 @@ jerryx_arg_transform_all (const jerry_value_t this_val, /**< the this_val for th
   }
 
   return jerryx_arg_transform_args (js_arg_p, js_arg_cnt, c_arg_p + 1, c_arg_cnt - 1);
-} /* jerryx_arg_transform_all */
+} /* jerryx_arg_transform_args_with_this */

jerry-ext/include/jerryscript-ext/args.h

@@ -29,17 +29,20 @@ extern "C"
 
 typedef struct jerryx_arg_t jerryx_arg_t;
 
+/**
+ * The iterator structor for JS arguments.
+ */
 typedef struct
 {
-  const jerry_value_t *js_arg_p;
-  jerry_length_t js_arg_cnt;
-  jerry_length_t js_arg_idx;
+  const jerry_value_t *js_arg_p; /**< the JS arguments */
+  const jerry_length_t js_arg_cnt; /**< the total num of JS arguments */
+  jerry_length_t js_arg_idx; /**< current index of JS argument */
 } jerryx_arg_js_iterator_t;
 
 /**
  * Signature of the transform function.
  */
-typedef jerry_value_t (*jerryx_arg_transform_func_t) (jerryx_arg_js_iterator_t *js_args, /**< available JS args */
+typedef jerry_value_t (*jerryx_arg_transform_func_t) (jerryx_arg_js_iterator_t *js_arg_iter_p, /**< available JS args */
                                                       const jerryx_arg_t *c_arg_p); /**< native arg */
 
 /**
@@ -48,7 +51,7 @@ typedef jerry_value_t (*jerryx_arg_transform_func_t) (jerryx_arg_js_iterator_t *
  * @param NAME name of the function.
  */
 #define JERRYX_ARG_TRANSFORM_FUNC(NAME) \
-jerry_value_t NAME (jerryx_arg_js_iterator_t *js_args, \
+jerry_value_t NAME (jerryx_arg_js_iterator_t *js_arg_iter_p, \
                     const jerryx_arg_t *c_arg_p)
 
 
@@ -63,14 +66,14 @@ struct jerryx_arg_t
   uintptr_t extra_info; /**< extra infomation for arg transform */
 };
 
-jerry_value_t jerryx_arg_transform_all (const jerry_value_t this_val,
-                                        const jerry_value_t *js_arg_p,
-                                        jerry_length_t js_arg_cnt,
-                                        const jerryx_arg_t *c_arg_p,
-                                        jerry_length_t c_arg_cnt);
+jerry_value_t jerryx_arg_transform_args_with_this (const jerry_value_t this_val,
+                                                   const jerry_value_t *js_arg_p,
+                                                   const jerry_length_t js_arg_cnt,
+                                                   const jerryx_arg_t *c_arg_p,
+                                                   jerry_length_t c_arg_cnt);
 
 jerry_value_t jerryx_arg_transform_args (const jerry_value_t *js_arg_p,
-                                         jerry_length_t js_arg_cnt,
+                                         const jerry_length_t js_arg_cnt,
                                          const jerryx_arg_t *c_arg_p,
                                          jerry_length_t c_arg_cnt);
 
@@ -109,8 +112,8 @@ static inline jerryx_arg_t
 jerryx_arg_custom (void *dest, uintptr_t extra_info, jerryx_arg_transform_func_t func);
 
 /* Helper functions for transform functions. */
-jerry_value_t jerryx_arg_js_iterator_pop (jerryx_arg_js_iterator_t *js_args);
-jerry_value_t jerryx_arg_js_iterator_peek (jerryx_arg_js_iterator_t *js_args);
+jerry_value_t jerryx_arg_js_iterator_pop (jerryx_arg_js_iterator_t *js_arg_iter_p);
+jerry_value_t jerryx_arg_js_iterator_peek (jerryx_arg_js_iterator_t *js_arg_iter_p);
 
 #include "args.impl.h"
 

jerry-ext/include/jerryscript-ext/args.impl.h

@@ -31,8 +31,6 @@ JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_string_optional);
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_string);
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_function);
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_function_optional);
-// JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_constructor);
-// JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_constructor_optional);
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_native_pointer);
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_native_pointer_optional);
 JERRYX_ARG_TRANSFORM_FUNC (jerryx_arg_transform_ignore);

tests/unit-ext/test-ext-args.c

@@ -106,11 +106,11 @@ test_validator1_handler (const jerry_value_t func_obj_val __attribute__((unused)
     jerryx_arg_function (&arg4, JERRYX_ARG_OPTIONAL)
   };
 
-  jerry_value_t is_ok = jerryx_arg_transform_all (this_val,
-                                                  args_p,
-                                                  args_cnt,
-                                                  mapping,
-                                                  5);
+  jerry_value_t is_ok = jerryx_arg_transform_args_with_this (this_val,
+                                                             args_p,
+                                                             args_cnt,
+                                                             mapping,
+                                                             5);
 
 
 
@@ -150,7 +150,7 @@ test_validator1_handler (const jerry_value_t func_obj_val __attribute__((unused)
 static
 JERRYX_ARG_TRANSFORM_FUNC (my_custom_transform)
 {
-  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_args);
+  jerry_value_t js_arg = jerryx_arg_js_iterator_pop (js_arg_iter_p);
   jerry_value_t to_number = jerry_value_to_number (js_arg);
 
   if (jerry_value_has_error_flag (to_number))
@@ -194,11 +194,11 @@ test_validator2_handler (const jerry_value_t func_obj_val __attribute__((unused)
     jerryx_arg_custom (NULL, 5, my_custom_transform)
   };
 
-  jerry_value_t is_ok = jerryx_arg_transform_all (this_val,
-                                                  args_p,
-                                                  args_cnt,
-                                                  mapping,
-                                                  2);
+  jerry_value_t is_ok = jerryx_arg_transform_args_with_this (this_val,
+                                                             args_p,
+                                                             args_cnt,
+                                                             mapping,
+                                                             2);