source: mainline/uspace/lib/c/include/str.h@ dd7df1c

ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since dd7df1c was 28a5ebd, checked in by Martin Decky <martin@…>, 5 years ago

Use char32_t instead of wchat_t to represent UTF-32 strings

The intention of the native HelenOS string API has been always to
support Unicode in the UTF-8 and UTF-32 encodings as the sole character
representations and ignore the obsolete mess of older single-byte and
multibyte character encodings. Before C11, the wchar_t type has been
slightly misused for the purpose of the UTF-32 strings. The newer
char32_t type is obviously a much more suitable option. The standard
defines char32_t as uint_least32_t, thus we can take the liberty to fix
it to uint32_t.

To maintain compatilibity with the C Standard, the putwchar(wchar_t)
functions has been replaced by our custom putuchar(char32_t) functions
where appropriate.
  • Property mode set to 100644
File size: 5.6 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
48#ifndef __cplusplus
49
50/* Common Unicode characters */
51#define U_SPECIAL '?'
52
53/** No size limit constant */
54#define STR_NO_LIMIT ((size_t) -1)
55
56/** Maximum size of a string containing @c length characters */
57#define STR_BOUNDS(length) ((length) << 2)
58
59/**
60 * Maximum size of a buffer needed to a string converted from space-padded
61 * ASCII of size @a spa_size using spascii_to_str().
62 */
63#define SPASCII_STR_BUFSIZE(spa_size) ((spa_size) + 1)
64
65#endif
66
67__HELENOS_DECLS_BEGIN;
68
69extern char32_t str_decode(const char *str, size_t *offset, size_t sz);
70extern char32_t str_decode_reverse(const char *str, size_t *offset, size_t sz);
71extern errno_t chr_encode(char32_t ch, char *str, size_t *offset, size_t sz);
72
73extern size_t str_size(const char *str);
74extern size_t wstr_size(const char32_t *str);
75
76extern size_t str_nsize(const char *str, size_t max_size);
77extern size_t wstr_nsize(const char32_t *str, size_t max_size);
78
79extern size_t str_lsize(const char *str, size_t max_len);
80extern size_t wstr_lsize(const char32_t *str, size_t max_len);
81
82extern size_t str_length(const char *str);
83extern size_t wstr_length(const char32_t *wstr);
84
85extern size_t str_nlength(const char *str, size_t size);
86extern size_t wstr_nlength(const char32_t *str, size_t size);
87
88extern size_t chr_width(char32_t ch);
89extern size_t str_width(const char *str);
90
91extern bool ascii_check(char32_t ch);
92extern bool chr_check(char32_t ch);
93
94extern int str_cmp(const char *s1, const char *s2);
95extern int str_lcmp(const char *s1, const char *s2, size_t max_len);
96extern int str_casecmp(const char *s1, const char *s2);
97extern int str_lcasecmp(const char *s1, const char *s2, size_t max_len);
98
99extern bool str_test_prefix(const char *s, const char *p);
100extern const char *str_suffix(const char *s, size_t prefix_length);
101
102extern void str_cpy(char *dest, size_t size, const char *src);
103extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
104extern void str_append(char *dest, size_t size, const char *src);
105
106extern errno_t spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n);
107extern void wstr_to_str(char *dest, size_t size, const char32_t *src);
108extern char *wstr_to_astr(const char32_t *src);
109extern void str_to_wstr(char32_t *dest, size_t dlen, const char *src);
110extern char32_t *str_to_awstr(const char *src);
111extern errno_t utf16_to_str(char *dest, size_t size, const uint16_t *src);
112extern errno_t str_to_utf16(uint16_t *dest, size_t dlen, const char *src);
113extern size_t utf16_wsize(const uint16_t *ustr);
114
115extern char *str_chr(const char *str, char32_t ch);
116extern char *str_rchr(const char *str, char32_t ch);
117extern char *str_str(const char *hs, const char *n);
118
119extern void str_rtrim(char *str, char32_t ch);
120extern void str_ltrim(char *str, char32_t ch);
121
122extern bool wstr_linsert(char32_t *str, char32_t ch, size_t pos, size_t max_pos);
123extern bool wstr_remove(char32_t *str, size_t pos);
124
125extern char *str_dup(const char *src);
126extern char *str_ndup(const char *src, size_t n);
127
128extern char *str_tok(char *, const char *, char **);
129
130extern errno_t str_uint8_t(const char *, const char **, unsigned int, bool,
131 uint8_t *);
132extern errno_t str_uint16_t(const char *, const char **, unsigned int, bool,
133 uint16_t *);
134extern errno_t str_uint32_t(const char *, const char **, unsigned int, bool,
135 uint32_t *);
136extern errno_t str_uint64_t(const char *, const char **, unsigned int, bool,
137 uint64_t *);
138extern errno_t str_size_t(const char *, const char **, unsigned int, bool,
139 size_t *);
140extern errno_t str_int64_t(const char *, const char **, unsigned int, bool,
141 int64_t *);
142
143extern void order_suffix(const uint64_t, uint64_t *, char *);
144extern void bin_order_suffix(const uint64_t, uint64_t *, const char **, bool);
145
146/*
147 * TODO: Get rid of this.
148 */
149
150extern long int strtol(const char *, char **, int);
151extern unsigned long strtoul(const char *, char **, int);
152
153__HELENOS_DECLS_END;
154
155#endif
156
157/** @}
158 */
Note: See TracBrowser for help on using the repository browser.