source: mainline/common/include/str.h@ ae787807

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

Test, fix and extend string sanitization
  • Property mode set to 100644
File size: 6.0 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/uchar.h>
48
49#ifndef __cplusplus
50
51/* Common Unicode characters */
52#define U_SPECIAL '?'
53
54#define U_LEFT_ARROW 0x2190
55#define U_UP_ARROW 0x2191
56#define U_RIGHT_ARROW 0x2192
57#define U_DOWN_ARROW 0x2193
58
59#define U_PAGE_UP 0x21de
60#define U_PAGE_DOWN 0x21df
61
62#define U_HOME_ARROW 0x21f1
63#define U_END_ARROW 0x21f2
64
65#define U_NULL 0x2400
66#define U_ESCAPE 0x241b
67#define U_DELETE 0x2421
68
69#define U_CURSOR 0x2588
70
71/** No size limit constant */
72#define STR_NO_LIMIT ((size_t) -1)
73
74/** Maximum size of a string containing @c length characters */
75#define STR_BOUNDS(length) ((length) << 2)
76
77/**
78 * Maximum size of a buffer needed to a string converted from space-padded
79 * ASCII of size @a spa_size using spascii_to_str().
80 */
81#define SPASCII_STR_BUFSIZE(spa_size) ((spa_size) + 1)
82
83#endif
84
85__HELENOS_DECLS_BEGIN;
86
87extern char32_t str_decode(const char *str, size_t *offset, size_t sz);
88extern char32_t str_decode_reverse(const char *str, size_t *offset, size_t sz);
89extern errno_t chr_encode(char32_t ch, char *str, size_t *offset, size_t sz);
90
91extern size_t str_size(const char *str);
92extern size_t wstr_size(const char32_t *str);
93
94extern size_t str_nsize(const char *str, size_t max_size);
95extern size_t wstr_nsize(const char32_t *str, size_t max_size);
96
97extern size_t str_lsize(const char *str, size_t max_len);
98extern size_t wstr_lsize(const char32_t *str, size_t max_len);
99
100extern size_t str_length(const char *str);
101extern size_t wstr_length(const char32_t *wstr);
102
103extern size_t str_nlength(const char *str, size_t size);
104extern size_t wstr_nlength(const char32_t *str, size_t size);
105
106extern size_t chr_width(char32_t ch);
107extern size_t str_width(const char *str);
108
109extern bool ascii_check(char32_t ch);
110extern bool chr_check(char32_t ch);
111
112extern int str_cmp(const char *s1, const char *s2);
113extern int str_lcmp(const char *s1, const char *s2, size_t max_len);
114extern int str_casecmp(const char *s1, const char *s2);
115extern int str_lcasecmp(const char *s1, const char *s2, size_t max_len);
116
117extern bool str_test_prefix(const char *s, const char *p);
118extern const char *str_suffix(const char *s, size_t prefix_length);
119
120extern void str_cpy(char *dest, size_t size, const char *src);
121extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
122extern void str_append(char *dest, size_t size, const char *src);
123
124extern errno_t spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n);
125extern void wstr_to_str(char *dest, size_t size, const char32_t *src);
126extern char *wstr_to_astr(const char32_t *src);
127extern void str_to_wstr(char32_t *dest, size_t dlen, const char *src);
128extern char32_t *str_to_awstr(const char *src);
129extern errno_t utf16_to_str(char *dest, size_t size, const uint16_t *src);
130extern errno_t str_to_utf16(uint16_t *dest, size_t dlen, const char *src);
131extern size_t utf16_wsize(const uint16_t *ustr);
132
133extern char *str_chr(const char *str, char32_t ch);
134extern char *str_rchr(const char *str, char32_t ch);
135extern char *str_str(const char *hs, const char *n);
136
137extern void str_rtrim(char *str, char32_t ch);
138extern void str_ltrim(char *str, char32_t ch);
139
140extern bool wstr_linsert(char32_t *str, char32_t ch, size_t pos, size_t max_pos);
141extern bool wstr_remove(char32_t *str, size_t pos);
142
143extern char *str_dup(const char *src);
144extern char *str_ndup(const char *src, size_t n);
145
146extern char *str_tok(char *, const char *, char **);
147
148extern errno_t str_uint8_t(const char *, const char **, unsigned int, bool,
149 uint8_t *);
150extern errno_t str_uint16_t(const char *, const char **, unsigned int, bool,
151 uint16_t *);
152extern errno_t str_uint32_t(const char *, const char **, unsigned int, bool,
153 uint32_t *);
154extern errno_t str_uint64_t(const char *, const char **, unsigned int, bool,
155 uint64_t *);
156extern errno_t str_size_t(const char *, const char **, unsigned int, bool,
157 size_t *);
158extern errno_t str_int64_t(const char *, const char **, unsigned int, bool,
159 int64_t *);
160
161extern void order_suffix(const uint64_t, uint64_t *, char *);
162extern void bin_order_suffix(const uint64_t, uint64_t *, const char **, bool);
163
164extern size_t str_sanitize(char *str, size_t n, uint8_t replacement);
165
166/*
167 * TODO: Get rid of this.
168 */
169
170extern long int strtol(const char *, char **, int);
171extern unsigned long strtoul(const char *, char **, int);
172
173__HELENOS_DECLS_END;
174
175#endif
176
177/** @}
178 */
Note: See TracBrowser for help on using the repository browser.