source: mainline/common/include/str.h@ 45adeeb

Last change on this file since 45adeeb was 45adeeb, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 2 months ago

Expose restartable version of str_decode() as str_decode_r()
  • Property mode set to 100644
File size: 6.2 KB
Line 
1/*
2 * Copyright (c) 2001-2004 Jakub Jermar
3 * Copyright (c) 2005 Martin Decky
4 * Copyright (c) 2011 Oleg Romanenko
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * - Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * - The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31/** @addtogroup libc
32 * @{
33 */
34/** @file
35 */
36
37#ifndef _LIBC_STR_H_
38#define _LIBC_STR_H_
39
40#include <errno.h>
41#include <stdbool.h>
42#include <stddef.h>
43#include <stdint.h>
44
45#include <mem.h>
46#include <_bits/decls.h>
47#include <_bits/mbstate_t.h>
48#include <_bits/uchar.h>
49
50#ifndef __cplusplus
51
52/* Common Unicode characters */
53#define U_SPECIAL '?'
54
55#define U_LEFT_ARROW 0x2190
56#define U_UP_ARROW 0x2191
57#define U_RIGHT_ARROW 0x2192
58#define U_DOWN_ARROW 0x2193
59
60#define U_PAGE_UP 0x21de
61#define U_PAGE_DOWN 0x21df
62
63#define U_HOME_ARROW 0x21f1
64#define U_END_ARROW 0x21f2
65
66#define U_NULL 0x2400
67#define U_ESCAPE 0x241b
68#define U_DELETE 0x2421
69
70#define U_CURSOR 0x2588
71
72/** No size limit constant */
73#define STR_NO_LIMIT ((size_t) -1)
74
75/** Maximum size of a string containing @c length characters */
76#define STR_BOUNDS(length) ((length) << 2)
77
78/**
79 * Maximum size of a buffer needed to a string converted from space-padded
80 * ASCII of size @a spa_size using spascii_to_str().
81 */
82#define SPASCII_STR_BUFSIZE(spa_size) ((spa_size) + 1)
83
84#endif
85
86__HELENOS_DECLS_BEGIN;
87
88extern char32_t str_decode(const char *str, size_t *offset, size_t sz);
89extern char32_t str_decode_r(const char *str, size_t *offset, size_t sz,
90 char32_t replacement, mbstate_t *mbstate);
91extern char32_t str_decode_reverse(const char *str, size_t *offset, size_t sz);
92extern errno_t chr_encode(char32_t ch, char *str, size_t *offset, size_t sz);
93
94extern size_t str_size(const char *str);
95extern size_t wstr_size(const char32_t *str);
96
97extern size_t str_nsize(const char *str, size_t max_size);
98extern size_t wstr_nsize(const char32_t *str, size_t max_size);
99
100extern size_t str_lsize(const char *str, size_t max_len);
101extern size_t wstr_lsize(const char32_t *str, size_t max_len);
102
103extern size_t str_length(const char *str);
104extern size_t wstr_length(const char32_t *wstr);
105
106extern size_t str_nlength(const char *str, size_t size);
107extern size_t wstr_nlength(const char32_t *str, size_t size);
108
109extern size_t chr_width(char32_t ch);
110extern size_t str_width(const char *str);
111
112extern bool ascii_check(char32_t ch);
113extern bool chr_check(char32_t ch);
114
115extern int str_cmp(const char *s1, const char *s2);
116extern int str_lcmp(const char *s1, const char *s2, size_t max_len);
117extern int str_casecmp(const char *s1, const char *s2);
118extern int str_lcasecmp(const char *s1, const char *s2, size_t max_len);
119
120extern bool str_test_prefix(const char *s, const char *p);
121extern const char *str_suffix(const char *s, size_t prefix_length);
122
123extern void str_cpy(char *dest, size_t size, const char *src);
124extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
125extern void str_append(char *dest, size_t size, const char *src);
126
127extern errno_t spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n);
128extern void wstr_to_str(char *dest, size_t size, const char32_t *src);
129extern char *wstr_to_astr(const char32_t *src);
130extern void str_to_wstr(char32_t *dest, size_t dlen, const char *src);
131extern char32_t *str_to_awstr(const char *src);
132extern errno_t utf16_to_str(char *dest, size_t size, const uint16_t *src);
133extern errno_t str_to_utf16(uint16_t *dest, size_t dlen, const char *src);
134extern size_t utf16_wsize(const uint16_t *ustr);
135
136extern char *str_chr(const char *str, char32_t ch);
137extern char *str_rchr(const char *str, char32_t ch);
138extern char *str_str(const char *hs, const char *n);
139
140extern void str_rtrim(char *str, char32_t ch);
141extern void str_ltrim(char *str, char32_t ch);
142
143extern bool wstr_linsert(char32_t *str, char32_t ch, size_t pos, size_t max_pos);
144extern bool wstr_remove(char32_t *str, size_t pos);
145
146extern char *str_dup(const char *src);
147extern char *str_ndup(const char *src, size_t n);
148
149extern char *str_tok(char *, const char *, char **);
150
151extern errno_t str_uint8_t(const char *, const char **, unsigned int, bool,
152 uint8_t *);
153extern errno_t str_uint16_t(const char *, const char **, unsigned int, bool,
154 uint16_t *);
155extern errno_t str_uint32_t(const char *, const char **, unsigned int, bool,
156 uint32_t *);
157extern errno_t str_uint64_t(const char *, const char **, unsigned int, bool,
158 uint64_t *);
159extern errno_t str_size_t(const char *, const char **, unsigned int, bool,
160 size_t *);
161extern errno_t str_int64_t(const char *, const char **, unsigned int, bool,
162 int64_t *);
163
164extern void order_suffix(const uint64_t, uint64_t *, char *);
165extern void bin_order_suffix(const uint64_t, uint64_t *, const char **, bool);
166
167extern size_t str_sanitize(char *str, size_t n, uint8_t replacement);
168
169/*
170 * TODO: Get rid of this.
171 */
172
173extern long int strtol(const char *, char **, int);
174extern unsigned long strtoul(const char *, char **, int);
175
176__HELENOS_DECLS_END;
177
178#endif
179
180/** @}
181 */
Note: See TracBrowser for help on using the repository browser.