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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since da680b4b was da680b4b, checked in by Jiri Svoboda <jiri@…>, 7 years ago

Don't automatically mount writable filesystems on ATA hard drives. Better be safe than sorry. (But no way to override yet.)

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