Skip to content

Commit 7de7c21

Browse files
author
kisbg
authored
Implement asInteger, asUint32 and asInt32 jerry api methods (#4325)
JerryScript-DCO-1.0-Signed-off-by: bence gabor kis [email protected]
1 parent 5d916fb commit 7de7c21

File tree

4 files changed

+304
-0
lines changed

4 files changed

+304
-0
lines changed

docs/02.API-REFERENCE.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3777,6 +3777,92 @@ jerry_value_to_bigint (const jerry_value_t value);
37773777
- [jerry_value_is_bigint](#jerry_value_is_bigint)
37783778
- [jerry_get_bigint_digits](#jerry_get_bigint_digits)
37793779

3780+
## jerry_value_as_integer
3781+
3782+
**Summary**
3783+
3784+
Convert any number to integer number. Returns 0 if value is not number.
3785+
Based on ECMA 262 v11 7.1.5
3786+
3787+
**Prototype**
3788+
3789+
```c
3790+
double
3791+
jerry_value_as_integer (const jerry_value_t value);
3792+
```
3793+
3794+
- `value` - api value
3795+
- return
3796+
- 0, if value is not a number
3797+
- integer representation of the number, otherwise
3798+
3799+
**Example**
3800+
3801+
```c
3802+
{
3803+
jerry_value_t number_val = jerry_create_number (123321);
3804+
double number = jerry_value_as_integer (number_val);
3805+
jerry_release_value (number_val);
3806+
}
3807+
```
3808+
3809+
## jerry_value_as_int32
3810+
3811+
**Summary**
3812+
3813+
Convert any number to int32 number. Returns 0 if value is not number.
3814+
Based on ECMA 262 v11 7.1.6
3815+
3816+
**Prototype**
3817+
3818+
```c
3819+
int32_t
3820+
jerry_value_as_int32 (const jerry_value_t value);
3821+
```
3822+
3823+
- `value` - api value
3824+
- return
3825+
- 0, if value is not a number
3826+
- int32 representation of the number, otherwise
3827+
3828+
**Example**
3829+
3830+
```c
3831+
{
3832+
jerry_value_t number_val = jerry_create_number (123321);
3833+
int32_t number = jerry_value_as_int32 (number_val);
3834+
jerry_release_value (number_val);
3835+
}
3836+
```
3837+
3838+
## jerry_value_as_uint32
3839+
3840+
**Summary**
3841+
3842+
Convert any number to uint32 number. Returns 0 if value is not number.
3843+
Based on ECMA 262 v11 7.1.7
3844+
3845+
**Prototype**
3846+
3847+
```c
3848+
uint32_t
3849+
jerry_value_as_uint32 (const jerry_value_t value);
3850+
```
3851+
3852+
- `value` - api value
3853+
- return
3854+
- 0, if value is not a number
3855+
- uint32 representation of the number, otherwise
3856+
3857+
**Example**
3858+
3859+
```c
3860+
{
3861+
jerry_value_t number_val = jerry_create_number (123321);
3862+
uint32_t number = jerry_value_as_uint32 (number_val);
3863+
jerry_release_value (number_val);
3864+
}
3865+
```
37803866

37813867
# Functions for promise objects
37823868

jerry-core/api/jerry.c

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
*/
1515

1616
#include <stdio.h>
17+
#include <math.h>
1718

1819
#include "debugger.h"
1920
#include "ecma-alloc.h"
@@ -1722,6 +1723,83 @@ jerry_value_to_bigint (const jerry_value_t value) /**< input value */
17221723
#endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
17231724
} /* jerry_value_to_bigint */
17241725

1726+
/**
1727+
* Convert any number to integer number.
1728+
*
1729+
* Note:
1730+
* For non-number values 0 is returned.
1731+
*
1732+
* @return integer representation of the number.
1733+
*/
1734+
double
1735+
jerry_value_as_integer (const jerry_value_t value) /**< input value */
1736+
{
1737+
jerry_assert_api_available ();
1738+
1739+
if (!ecma_is_value_number (value))
1740+
{
1741+
return 0;
1742+
}
1743+
1744+
double number = ecma_get_number_from_value (value);
1745+
1746+
if (ecma_number_is_nan (number))
1747+
{
1748+
return ECMA_NUMBER_ZERO;
1749+
}
1750+
1751+
if (ecma_number_is_zero (number) || ecma_number_is_infinity (number))
1752+
{
1753+
return number;
1754+
}
1755+
1756+
ecma_number_t floor_fabs = (ecma_number_t) floor (fabs (number));
1757+
1758+
return ecma_number_is_negative (number) ? -floor_fabs : floor_fabs;
1759+
} /* jerry_value_as_integer */
1760+
1761+
/**
1762+
* Convert any number to int32 number.
1763+
*
1764+
* Note:
1765+
* For non-number values 0 is returned.
1766+
*
1767+
* @return int32 representation of the number.
1768+
*/
1769+
int32_t
1770+
jerry_value_as_int32 (const jerry_value_t value) /**< input value */
1771+
{
1772+
jerry_assert_api_available ();
1773+
1774+
if (!ecma_is_value_number (value))
1775+
{
1776+
return 0;
1777+
}
1778+
1779+
return ecma_number_to_int32 (ecma_get_number_from_value (value));
1780+
} /* jerry_value_as_int32 */
1781+
1782+
/**
1783+
* Convert any number to uint32 number.
1784+
*
1785+
* Note:
1786+
* For non-number values 0 is returned.
1787+
*
1788+
* @return uint32 representation of the number.
1789+
*/
1790+
uint32_t
1791+
jerry_value_as_uint32 (const jerry_value_t value) /**< input value */
1792+
{
1793+
jerry_assert_api_available ();
1794+
1795+
if (!ecma_is_value_number (value))
1796+
{
1797+
return 0;
1798+
}
1799+
1800+
return ecma_number_to_uint32 (ecma_get_number_from_value (value));
1801+
} /* jerry_value_as_uint32 */
1802+
17251803
/**
17261804
* Acquire specified Jerry API value.
17271805
*

jerry-core/include/jerryscript-core.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,9 @@ jerry_value_t jerry_value_to_object (const jerry_value_t value);
557557
jerry_value_t jerry_value_to_primitive (const jerry_value_t value);
558558
jerry_value_t jerry_value_to_string (const jerry_value_t value);
559559
jerry_value_t jerry_value_to_bigint (const jerry_value_t value);
560+
double jerry_value_as_integer (const jerry_value_t value);
561+
int32_t jerry_value_as_int32 (const jerry_value_t value);
562+
uint32_t jerry_value_as_uint32 (const jerry_value_t value);
560563

561564
/**
562565
* Acquire types with reference counter (increase the references).
Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
/* Copyright JS Foundation and other contributors, http://js.foundation
2+
*
3+
* Licensed under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License.
5+
* You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software
10+
* distributed under the License is distributed on an "AS IS" BASIS
11+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
* See the License for the specific language governing permissions and
13+
* limitations under the License.
14+
*/
15+
16+
#include "ecma-globals.h"
17+
#include "ecma-helpers.h"
18+
19+
#include "test-common.h"
20+
21+
// basic toUint32 tester method
22+
static void
23+
test_to_uint32 (double input, uint32_t test_number)
24+
{
25+
jerry_value_t number_val = jerry_create_number (input);
26+
uint32_t uint_number = jerry_value_as_uint32 (number_val);
27+
TEST_ASSERT (uint_number == test_number);
28+
jerry_release_value (number_val);
29+
} /* test_to_uint32 */
30+
31+
// basic toInt32 tester method
32+
static void
33+
test_to_int32 (double input, int32_t test_number)
34+
{
35+
jerry_value_t number_val = jerry_create_number (input);
36+
int32_t int_number = jerry_value_as_int32 (number_val);
37+
TEST_ASSERT (int_number == test_number);
38+
jerry_release_value (number_val);
39+
} /* test_to_int32 */
40+
41+
// basic toInteger tester method
42+
static void
43+
test_to_interger (double input, double test_number)
44+
{
45+
jerry_value_t number_val = jerry_create_number (input);
46+
double double_number = jerry_value_as_integer (number_val);
47+
TEST_ASSERT (double_number == test_number);
48+
jerry_release_value (number_val);
49+
} /* test_to_interger */
50+
51+
int
52+
main (void)
53+
{
54+
TEST_INIT ();
55+
56+
jerry_init (JERRY_INIT_EMPTY);
57+
58+
// few toUint32 test-cases
59+
test_to_uint32 (1.0, 1);
60+
test_to_uint32 (0.0, 0);
61+
test_to_uint32 (NAN, 0);
62+
test_to_uint32 (-NAN, 0);
63+
test_to_uint32 (INFINITY, 0);
64+
test_to_uint32 (-INFINITY, 0);
65+
test_to_uint32 (0.1, 0);
66+
test_to_uint32 (-0.1, 0);
67+
test_to_uint32 (1.1, 1);
68+
test_to_uint32 (-1.1, 4294967295);
69+
test_to_uint32 (4294967295, 4294967295);
70+
test_to_uint32 (-4294967295, 1);
71+
test_to_uint32 (4294967296, 0);
72+
test_to_uint32 (-4294967296, 0);
73+
test_to_uint32 (4294967297, 1);
74+
test_to_uint32 (-4294967297, 4294967295);
75+
76+
// few toint32 test-cases
77+
test_to_int32 (1.0, 1);
78+
test_to_int32 (0.0, 0);
79+
test_to_int32 (NAN, 0);
80+
test_to_int32 (-NAN, 0);
81+
test_to_int32 (INFINITY, 0);
82+
test_to_int32 (-INFINITY, 0);
83+
test_to_int32 (0.1, 0);
84+
test_to_int32 (-0.1, 0);
85+
test_to_int32 (1.1, 1);
86+
test_to_int32 (-1.1, -1);
87+
test_to_int32 (4294967295, -1);
88+
test_to_int32 (-4294967295, 1);
89+
test_to_int32 (4294967296, 0);
90+
test_to_int32 (-4294967296, 0);
91+
test_to_int32 (4294967297, 1);
92+
test_to_int32 (-4294967297, -1);
93+
test_to_int32 (2147483648, -2147483648);
94+
test_to_int32 (-2147483648, -2147483648);
95+
test_to_int32 (2147483647, 2147483647);
96+
test_to_int32 (-2147483647, -2147483647);
97+
test_to_int32 (-2147483649, 2147483647);
98+
test_to_int32 (2147483649, -2147483647);
99+
100+
// few toInteger test-cases
101+
test_to_interger (1.0, 1.0);
102+
test_to_interger (0.0, 0.0);
103+
test_to_interger (NAN, 0);
104+
test_to_interger (-NAN, 0);
105+
test_to_interger (INFINITY, INFINITY);
106+
test_to_interger (-INFINITY, -INFINITY);
107+
test_to_interger (0.1, 0);
108+
test_to_interger (-0.1, -0);
109+
test_to_interger (1.1, 1);
110+
test_to_interger (-1.1, -1);
111+
test_to_interger (4294967295, 4294967295);
112+
test_to_interger (-4294967295, -4294967295);
113+
test_to_interger (4294967295, 4294967295);
114+
test_to_interger (-4294967296, -4294967296);
115+
test_to_interger (4294967297, 4294967297);
116+
test_to_interger (-4294967297, -4294967297);
117+
118+
// few test-cases which return with error
119+
jerry_value_t error_val = jerry_create_error (JERRY_ERROR_TYPE, (const jerry_char_t *) "error");
120+
double number = jerry_value_as_integer (error_val);
121+
jerry_release_value (error_val);
122+
TEST_ASSERT (number == 0);
123+
124+
error_val = jerry_create_symbol (error_val);
125+
number = jerry_value_as_integer (error_val);
126+
TEST_ASSERT (number == 0);
127+
jerry_release_value (error_val);
128+
129+
error_val = jerry_eval ((const jerry_char_t *) "({ valueOf() { throw new TypeError('foo')}})",
130+
44, JERRY_PARSE_NO_OPTS);
131+
number = jerry_value_as_integer (error_val);
132+
TEST_ASSERT (number == 0);
133+
jerry_release_value (error_val);
134+
135+
jerry_cleanup ();
136+
return 0;
137+
} /* main */

0 commit comments

Comments
 (0)