Skip to content

Commit dd43119

Browse files
committed
Add new API function
Implemented 'jerry_is_array' and 'jerry_get_array_length' API functions. JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]
1 parent 4091444 commit dd43119

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed

jerry-core/jerry-api.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ jerry_string_t *jerry_create_string_sz (const jerry_char_t *, jerry_size_t);
185185
*/
186186
bool jerry_set_array_index_value (jerry_object_t *, jerry_length_t, jerry_value_t);
187187
bool jerry_get_array_index_value (jerry_object_t *, jerry_length_t, jerry_value_t *);
188+
uint32_t jerry_get_array_length (const jerry_object_t *);
188189

189190
/**
190191
* Functions of 'jerry_string_t'
@@ -196,6 +197,7 @@ jerry_size_t jerry_string_to_char_buffer (const jerry_string_t *, jerry_char_t *
196197
/**
197198
* General API functions of JS objects
198199
*/
200+
bool jerry_is_array (const jerry_object_t *);
199201
bool jerry_is_constructor (const jerry_object_t *);
200202
bool jerry_is_function (const jerry_object_t *);
201203
bool jerry_add_object_field (jerry_object_t *, const jerry_char_t *, jerry_size_t, const jerry_value_t, bool);

jerry-core/jerry.c

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -590,6 +590,41 @@ jerry_get_array_index_value (jerry_object_t *array_obj_p, /**< array object */
590590
return false;
591591
} /* jerry_get_array_index_value */
592592

593+
/**
594+
* Get length of an array object
595+
*
596+
* Note:
597+
* Returns 0, if the given parameter is not an array object or
598+
* cannot retrieve the length.
599+
*
600+
* @return length of the given array
601+
*/
602+
uint32_t
603+
jerry_get_array_length (const jerry_object_t *object_p)
604+
{
605+
jerry_assert_api_available ();
606+
607+
if (!jerry_is_array (object_p))
608+
{
609+
return 0;
610+
}
611+
612+
jerry_length_t length = 0;
613+
ecma_string_t *magic_string_length_p = ecma_get_magic_string (LIT_MAGIC_STRING_LENGTH);
614+
615+
ecma_value_t len_value = ecma_op_object_get ((jerry_object_t *) object_p, magic_string_length_p);
616+
ecma_deref_ecma_string (magic_string_length_p);
617+
618+
if (ecma_is_value_number (len_value))
619+
{
620+
length = ecma_number_to_uint32 (ecma_get_number_from_value (len_value));
621+
}
622+
623+
ecma_free_value (len_value);
624+
625+
return length;
626+
} /* jerry_get_array_length */
627+
593628
/**
594629
* Create an error object
595630
*
@@ -757,6 +792,20 @@ jerry_dispatch_object_free_callback (ecma_external_pointer_t freecb_p, /**< poin
757792
jerry_make_api_available ();
758793
} /* jerry_dispatch_object_free_callback */
759794

795+
/**
796+
* Check if the specified object is an array object.
797+
*
798+
* @return true - if the specified object is an array object,
799+
* false - otherwise.
800+
*/
801+
bool
802+
jerry_is_array (const jerry_object_t *object_p) /**< an object */
803+
{
804+
jerry_assert_api_available ();
805+
806+
return (ecma_get_object_type (object_p) == ECMA_OBJECT_TYPE_ARRAY);
807+
} /* jerry_is_array */
808+
760809
/**
761810
* Check if the specified object is a function object.
762811
*

tests/unit/test-api.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,8 @@ main (void)
583583

584584
// Test: Array Object API
585585
jerry_object_t *array_obj_p = jerry_create_array_object (10);
586+
JERRY_ASSERT (jerry_is_array (array_obj_p));
587+
JERRY_ASSERT (jerry_get_array_length (array_obj_p) == 10);
586588

587589
jerry_value_t v_in = jerry_create_number_value (10.5);
588590
jerry_set_array_index_value (array_obj_p, 5, v_in);

0 commit comments

Comments
 (0)