1/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26#ifndef MICROPY_INCLUDED_PY_OBJSTR_H
27#define MICROPY_INCLUDED_PY_OBJSTR_H
28
29#include "py/obj.h"
30
31typedef struct _mp_obj_str_t {
32 mp_obj_base_t base;
33 mp_uint_t hash;
34 // len == number of bytes used in data, alloc = len + 1 because (at the moment) we also append a null byte
35 size_t len;
36 const byte *data;
37} mp_obj_str_t;
38
39#define MP_DEFINE_STR_OBJ(obj_name, str) mp_obj_str_t obj_name = {{&mp_type_str}, 0, sizeof(str) - 1, (const byte *)str}
40
41// use this macro to extract the string hash
42// warning: the hash can be 0, meaning invalid, and must then be explicitly computed from the data
43#define GET_STR_HASH(str_obj_in, str_hash) \
44 mp_uint_t str_hash; if (mp_obj_is_qstr(str_obj_in)) \
45 { str_hash = qstr_hash(MP_OBJ_QSTR_VALUE(str_obj_in)); } else { str_hash = ((mp_obj_str_t *)MP_OBJ_TO_PTR(str_obj_in))->hash; }
46
47// use this macro to extract the string length
48#define GET_STR_LEN(str_obj_in, str_len) \
49 size_t str_len; if (mp_obj_is_qstr(str_obj_in)) \
50 { str_len = qstr_len(MP_OBJ_QSTR_VALUE(str_obj_in)); } else { str_len = ((mp_obj_str_t *)MP_OBJ_TO_PTR(str_obj_in))->len; }
51
52// use this macro to extract the string data and length
53#if MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_C || MICROPY_OBJ_REPR == MICROPY_OBJ_REPR_D
54const byte *mp_obj_str_get_data_no_check(mp_obj_t self_in, size_t *len);
55#define GET_STR_DATA_LEN(str_obj_in, str_data, str_len) \
56 size_t str_len; const byte *str_data = mp_obj_str_get_data_no_check(str_obj_in, &str_len);
57#else
58#define GET_STR_DATA_LEN(str_obj_in, str_data, str_len) \
59 const byte *str_data; size_t str_len; if (mp_obj_is_qstr(str_obj_in)) \
60 { str_data = qstr_data(MP_OBJ_QSTR_VALUE(str_obj_in), &str_len); } \
61 else { str_len = ((mp_obj_str_t *)MP_OBJ_TO_PTR(str_obj_in))->len; str_data = ((mp_obj_str_t *)MP_OBJ_TO_PTR(str_obj_in))->data; }
62#endif
63
64mp_obj_t mp_obj_str_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args);
65void mp_str_print_json(const mp_print_t *print, const byte *str_data, size_t str_len);
66mp_obj_t mp_obj_str_format(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs);
67mp_obj_t mp_obj_str_split(size_t n_args, const mp_obj_t *args);
68mp_obj_t mp_obj_new_str_copy(const mp_obj_type_t *type, const byte *data, size_t len);
69mp_obj_t mp_obj_new_str_of_type(const mp_obj_type_t *type, const byte *data, size_t len);
70
71mp_obj_t mp_obj_str_binary_op(mp_binary_op_t op, mp_obj_t lhs_in, mp_obj_t rhs_in);
72mp_int_t mp_obj_str_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags);
73
74const byte *str_index_to_ptr(const mp_obj_type_t *type, const byte *self_data, size_t self_len,
75 mp_obj_t index, bool is_slice);
76const byte *find_subbytes(const byte *haystack, size_t hlen, const byte *needle, size_t nlen, int direction);
77
78MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_encode_obj);
79MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_find_obj);
80MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_rfind_obj);
81MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_index_obj);
82MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_rindex_obj);
83MP_DECLARE_CONST_FUN_OBJ_2(str_join_obj);
84MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_split_obj);
85MP_DECLARE_CONST_FUN_OBJ_KW(str_splitlines_obj);
86MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_rsplit_obj);
87MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_startswith_obj);
88MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_endswith_obj);
89MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_strip_obj);
90MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_lstrip_obj);
91MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_rstrip_obj);
92MP_DECLARE_CONST_FUN_OBJ_KW(str_format_obj);
93MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_replace_obj);
94MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(str_count_obj);
95MP_DECLARE_CONST_FUN_OBJ_2(str_partition_obj);
96MP_DECLARE_CONST_FUN_OBJ_2(str_rpartition_obj);
97MP_DECLARE_CONST_FUN_OBJ_2(str_center_obj);
98MP_DECLARE_CONST_FUN_OBJ_1(str_lower_obj);
99MP_DECLARE_CONST_FUN_OBJ_1(str_upper_obj);
100MP_DECLARE_CONST_FUN_OBJ_1(str_isspace_obj);
101MP_DECLARE_CONST_FUN_OBJ_1(str_isalpha_obj);
102MP_DECLARE_CONST_FUN_OBJ_1(str_isdigit_obj);
103MP_DECLARE_CONST_FUN_OBJ_1(str_isupper_obj);
104MP_DECLARE_CONST_FUN_OBJ_1(str_islower_obj);
105MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(bytes_decode_obj);
106
107#endif // MICROPY_INCLUDED_PY_OBJSTR_H
108