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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 8df5f20 was d066259, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 6 years ago

Synchronize str.c/str.h across boot/kernel/uspace

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