mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
9860d66a56
Related to #4186. Some notable changes: - The term 'Error' now strictly refers to native Error objects defined in the ECMA standard, which are ordinary objects. All other uses of 'error' or 'error reference' where the term refers to a thrown value is now called 'exception'. - Simplified the naming scheme of many String API functions. These functions will now also take an 'encoding' argument to specify the desired encoding in which to operate. - Removed the substring-copy-to-buffer functions. These functions behaved awkwardly, as they use character index to specify the start/end positions, and were mostly used incorrectly with byte offsets instead. The functionality can still be replicated with other functions if necessary. - String-to-buffer functions will no longer fail if the buffer is not sufficiently large, the string will instead be cropped. - Fixed the usage of the '_sz' prefix in many API functions. The term 'sz' means zero-terminated string in hungarian notation, this was used incorrectly in many cases. - Renamed most of the public API functions to have shorter, more on-point names, rather than the often too long descriptive names. Functions are now also grouped by the type of value they operate on, where this makes sense. JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai dbatyai@inf.u-szeged.hu
151 lines
6.8 KiB
C
151 lines
6.8 KiB
C
/* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef LIT_STRINGS_H
|
|
#define LIT_STRINGS_H
|
|
|
|
#include "jrt.h"
|
|
#include "lit-globals.h"
|
|
|
|
/**
|
|
* Null character (used in few cases as utf-8 string end marker)
|
|
*/
|
|
#define LIT_BYTE_NULL (0)
|
|
|
|
/**
|
|
* For the formal definition of Unicode transformation formats (UTF) see Section 3.9, Unicode Encoding Forms in The
|
|
* Unicode Standard (http://www.unicode.org/versions/Unicode3.0.0/ch03.pdf#G7404).
|
|
*/
|
|
#define LIT_UNICODE_CODE_POINT_NULL (0x0)
|
|
#define LIT_UNICODE_CODE_POINT_MAX (0x10FFFF)
|
|
|
|
#define LIT_UTF16_CODE_UNIT_MAX (0xFFFF)
|
|
#define LIT_UTF16_FIRST_SURROGATE_CODE_POINT (0x10000)
|
|
#define LIT_UTF16_LOW_SURROGATE_MARKER (0xDC00)
|
|
#define LIT_UTF16_HIGH_SURROGATE_MARKER (0xD800)
|
|
#define LIT_UTF16_HIGH_SURROGATE_MIN (0xD800)
|
|
#define LIT_UTF16_HIGH_SURROGATE_MAX (0xDBFF)
|
|
#define LIT_UTF16_LOW_SURROGATE_MIN (0xDC00)
|
|
#define LIT_UTF16_LOW_SURROGATE_MAX (0xDFFF)
|
|
#define LIT_UTF16_BITS_IN_SURROGATE (10)
|
|
#define LIT_UTF16_LAST_10_BITS_MASK (0x3FF)
|
|
|
|
#define LIT_UTF8_1_BYTE_MARKER (0x00)
|
|
#define LIT_UTF8_2_BYTE_MARKER (0xC0)
|
|
#define LIT_UTF8_3_BYTE_MARKER (0xE0)
|
|
#define LIT_UTF8_4_BYTE_MARKER (0xF0)
|
|
#define LIT_UTF8_EXTRA_BYTE_MARKER (0x80)
|
|
|
|
#define LIT_UTF8_1_BYTE_MASK (0x80)
|
|
#define LIT_UTF8_2_BYTE_MASK (0xE0)
|
|
#define LIT_UTF8_3_BYTE_MASK (0xF0)
|
|
#define LIT_UTF8_4_BYTE_MASK (0xF8)
|
|
#define LIT_UTF8_EXTRA_BYTE_MASK (0xC0)
|
|
|
|
#define LIT_UTF8_LAST_7_BITS_MASK (0x7F)
|
|
#define LIT_UTF8_LAST_6_BITS_MASK (0x3F)
|
|
#define LIT_UTF8_LAST_5_BITS_MASK (0x1F)
|
|
#define LIT_UTF8_LAST_4_BITS_MASK (0x0F)
|
|
#define LIT_UTF8_LAST_3_BITS_MASK (0x07)
|
|
#define LIT_UTF8_LAST_2_BITS_MASK (0x03)
|
|
#define LIT_UTF8_LAST_1_BIT_MASK (0x01)
|
|
|
|
#define LIT_UTF8_BITS_IN_EXTRA_BYTES (6)
|
|
|
|
#define LIT_UTF8_1_BYTE_CODE_POINT_MAX (0x7F)
|
|
#define LIT_UTF8_2_BYTE_CODE_POINT_MIN (0x80)
|
|
#define LIT_UTF8_2_BYTE_CODE_POINT_MAX (0x7FF)
|
|
#define LIT_UTF8_3_BYTE_CODE_POINT_MIN (0x800)
|
|
#define LIT_UTF8_3_BYTE_CODE_POINT_MAX (LIT_UTF16_CODE_UNIT_MAX)
|
|
#define LIT_UTF8_4_BYTE_CODE_POINT_MIN (0x10000)
|
|
#define LIT_UTF8_4_BYTE_CODE_POINT_MAX (LIT_UNICODE_CODE_POINT_MAX)
|
|
|
|
/**
|
|
* Differnce between byte count needed to represent code point greater than 0xFFFF
|
|
* in common UTF-8 (4 bytes required) and CESU-8 (6 bytes required)
|
|
*/
|
|
#define LIT_UTF8_CESU8_SURROGATE_SIZE_DIF (2 * LIT_UTF8_MAX_BYTES_IN_CODE_UNIT - LIT_UTF8_MAX_BYTES_IN_CODE_POINT)
|
|
|
|
/**
|
|
* Byte values >= LIT_UTF8_FIRST_BYTE_MAX are not allowed in internal strings
|
|
*/
|
|
#define LIT_UTF8_FIRST_BYTE_MAX (0xF8)
|
|
|
|
/* validation */
|
|
bool lit_is_valid_utf8_string (const lit_utf8_byte_t *utf8_buf_p, lit_utf8_size_t buf_size, bool strict);
|
|
bool lit_is_valid_cesu8_string (const lit_utf8_byte_t *cesu8_buf_p, lit_utf8_size_t buf_size);
|
|
|
|
/* checks */
|
|
bool lit_is_code_point_utf16_low_surrogate (lit_code_point_t code_point);
|
|
bool lit_is_code_point_utf16_high_surrogate (lit_code_point_t code_point);
|
|
|
|
/* size */
|
|
lit_utf8_size_t lit_zt_utf8_string_size (const lit_utf8_byte_t *utf8_str_p);
|
|
lit_utf8_size_t lit_get_utf8_size_of_cesu8_string (const lit_utf8_byte_t *cesu8_buf_p, lit_utf8_size_t cesu8_buf_size);
|
|
|
|
/* length */
|
|
lit_utf8_size_t lit_utf8_string_length (const lit_utf8_byte_t *utf8_buf_p, lit_utf8_size_t utf8_buf_size);
|
|
lit_utf8_size_t lit_get_utf8_length_of_cesu8_string (const lit_utf8_byte_t *cesu8_buf_p,
|
|
lit_utf8_size_t cesu8_buf_size);
|
|
|
|
/* hash */
|
|
lit_string_hash_t lit_utf8_string_calc_hash (const lit_utf8_byte_t *utf8_buf_p, lit_utf8_size_t utf8_buf_size);
|
|
lit_string_hash_t lit_utf8_string_hash_combine (lit_string_hash_t hash_basis,
|
|
const lit_utf8_byte_t *utf8_buf_p,
|
|
lit_utf8_size_t utf8_buf_size);
|
|
|
|
/* code unit access */
|
|
ecma_char_t lit_utf8_string_code_unit_at (const lit_utf8_byte_t *utf8_buf_p,
|
|
lit_utf8_size_t utf8_buf_size,
|
|
lit_utf8_size_t code_unit_offset);
|
|
lit_utf8_size_t lit_get_unicode_char_size_by_utf8_first_byte (const lit_utf8_byte_t first_byte);
|
|
|
|
/* conversion */
|
|
lit_utf8_size_t lit_code_unit_to_utf8 (ecma_char_t code_unit, lit_utf8_byte_t *buf_p);
|
|
lit_utf8_size_t lit_code_point_to_utf8 (lit_code_point_t code_point, lit_utf8_byte_t *buf);
|
|
lit_utf8_size_t lit_code_point_to_cesu8 (lit_code_point_t code_point, lit_utf8_byte_t *buf);
|
|
lit_utf8_size_t lit_convert_cesu8_string_to_utf8_string (const lit_utf8_byte_t *cesu8_string_p,
|
|
lit_utf8_size_t cesu8_size,
|
|
lit_utf8_byte_t *utf8_string_p,
|
|
lit_utf8_size_t utf8_size);
|
|
lit_code_point_t lit_convert_surrogate_pair_to_code_point (ecma_char_t high_surrogate, ecma_char_t low_surrogate);
|
|
|
|
bool lit_compare_utf8_strings_relational (const lit_utf8_byte_t *string1_p,
|
|
lit_utf8_size_t string1_size,
|
|
const lit_utf8_byte_t *string2_p,
|
|
lit_utf8_size_t string2_size);
|
|
|
|
uint8_t lit_utf16_encode_code_point (lit_code_point_t cp, ecma_char_t *cu_p);
|
|
|
|
/* read code point from buffer */
|
|
lit_utf8_size_t
|
|
lit_read_code_point_from_utf8 (const lit_utf8_byte_t *buf_p, lit_utf8_size_t buf_size, lit_code_point_t *code_point);
|
|
|
|
lit_utf8_size_t lit_read_code_unit_from_cesu8 (const lit_utf8_byte_t *buf_p, ecma_char_t *code_unit);
|
|
lit_utf8_size_t lit_read_code_point_from_cesu8 (const lit_utf8_byte_t *buf_p,
|
|
const lit_utf8_byte_t *buf_end_p,
|
|
lit_code_point_t *code_point);
|
|
|
|
lit_utf8_size_t lit_read_prev_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, ecma_char_t *code_point);
|
|
|
|
ecma_char_t lit_cesu8_read_next (const lit_utf8_byte_t **buf_p);
|
|
ecma_char_t lit_cesu8_read_prev (const lit_utf8_byte_t **buf_p);
|
|
ecma_char_t lit_cesu8_peek_next (const lit_utf8_byte_t *buf_p);
|
|
ecma_char_t lit_cesu8_peek_prev (const lit_utf8_byte_t *buf_p);
|
|
void lit_utf8_incr (const lit_utf8_byte_t **buf_p);
|
|
void lit_utf8_decr (const lit_utf8_byte_t **buf_p);
|
|
|
|
#endif /* !LIT_STRINGS_H */
|