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

Last change on this file since cd1e3fc0 was d7f7a4a, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 3 years ago

Replace some license headers with SPDX identifier

Headers are replaced using tools/transorm-copyright.sh only
when it can be matched verbatim with the license header used
throughout most of the codebase.
  • Property mode set to 100644
File size: 4.2 KB
Line 
1/*
2 * SPDX-FileCopyrightText: 2001-2004 Jakub Jermar
3 * SPDX-FileCopyrightText: 2005 Martin Decky
4 * SPDX-FileCopyrightText: 2011 Oleg Romanenko
5 *
6 * SPDX-License-Identifier: BSD-3-Clause
7 */
8
9/** @addtogroup libc
10 * @{
11 */
12/** @file
13 */
14
15#ifndef _LIBC_STR_H_
16#define _LIBC_STR_H_
17
18#include <errno.h>
19#include <stdbool.h>
20#include <stddef.h>
21#include <stdint.h>
22
23#include <mem.h>
24#include <_bits/decls.h>
25
26#ifndef __cplusplus
27
28/* Common Unicode characters */
29#define U_SPECIAL '?'
30
31/** No size limit constant */
32#define STR_NO_LIMIT ((size_t) -1)
33
34/** Maximum size of a string containing @c length characters */
35#define STR_BOUNDS(length) ((length) << 2)
36
37/**
38 * Maximum size of a buffer needed to a string converted from space-padded
39 * ASCII of size @a spa_size using spascii_to_str().
40 */
41#define SPASCII_STR_BUFSIZE(spa_size) ((spa_size) + 1)
42
43#endif
44
45__HELENOS_DECLS_BEGIN;
46
47extern char32_t str_decode(const char *str, size_t *offset, size_t sz);
48extern char32_t str_decode_reverse(const char *str, size_t *offset, size_t sz);
49extern errno_t chr_encode(char32_t ch, char *str, size_t *offset, size_t sz);
50
51extern size_t str_size(const char *str);
52extern size_t wstr_size(const char32_t *str);
53
54extern size_t str_nsize(const char *str, size_t max_size);
55extern size_t wstr_nsize(const char32_t *str, size_t max_size);
56
57extern size_t str_lsize(const char *str, size_t max_len);
58extern size_t wstr_lsize(const char32_t *str, size_t max_len);
59
60extern size_t str_length(const char *str);
61extern size_t wstr_length(const char32_t *wstr);
62
63extern size_t str_nlength(const char *str, size_t size);
64extern size_t wstr_nlength(const char32_t *str, size_t size);
65
66extern size_t chr_width(char32_t ch);
67extern size_t str_width(const char *str);
68
69extern bool ascii_check(char32_t ch);
70extern bool chr_check(char32_t ch);
71
72extern int str_cmp(const char *s1, const char *s2);
73extern int str_lcmp(const char *s1, const char *s2, size_t max_len);
74extern int str_casecmp(const char *s1, const char *s2);
75extern int str_lcasecmp(const char *s1, const char *s2, size_t max_len);
76
77extern bool str_test_prefix(const char *s, const char *p);
78extern const char *str_suffix(const char *s, size_t prefix_length);
79
80extern void str_cpy(char *dest, size_t size, const char *src);
81extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
82extern void str_append(char *dest, size_t size, const char *src);
83
84extern errno_t spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n);
85extern void wstr_to_str(char *dest, size_t size, const char32_t *src);
86extern char *wstr_to_astr(const char32_t *src);
87extern void str_to_wstr(char32_t *dest, size_t dlen, const char *src);
88extern char32_t *str_to_awstr(const char *src);
89extern errno_t utf16_to_str(char *dest, size_t size, const uint16_t *src);
90extern errno_t str_to_utf16(uint16_t *dest, size_t dlen, const char *src);
91extern size_t utf16_wsize(const uint16_t *ustr);
92
93extern char *str_chr(const char *str, char32_t ch);
94extern char *str_rchr(const char *str, char32_t ch);
95extern char *str_str(const char *hs, const char *n);
96
97extern void str_rtrim(char *str, char32_t ch);
98extern void str_ltrim(char *str, char32_t ch);
99
100extern bool wstr_linsert(char32_t *str, char32_t ch, size_t pos, size_t max_pos);
101extern bool wstr_remove(char32_t *str, size_t pos);
102
103extern char *str_dup(const char *src);
104extern char *str_ndup(const char *src, size_t n);
105
106extern char *str_tok(char *, const char *, char **);
107
108extern errno_t str_uint8_t(const char *, const char **, unsigned int, bool,
109 uint8_t *);
110extern errno_t str_uint16_t(const char *, const char **, unsigned int, bool,
111 uint16_t *);
112extern errno_t str_uint32_t(const char *, const char **, unsigned int, bool,
113 uint32_t *);
114extern errno_t str_uint64_t(const char *, const char **, unsigned int, bool,
115 uint64_t *);
116extern errno_t str_size_t(const char *, const char **, unsigned int, bool,
117 size_t *);
118extern errno_t str_int64_t(const char *, const char **, unsigned int, bool,
119 int64_t *);
120
121extern void order_suffix(const uint64_t, uint64_t *, char *);
122extern void bin_order_suffix(const uint64_t, uint64_t *, const char **, bool);
123
124/*
125 * TODO: Get rid of this.
126 */
127
128extern long int strtol(const char *, char **, int);
129extern unsigned long strtoul(const char *, char **, int);
130
131__HELENOS_DECLS_END;
132
133#endif
134
135/** @}
136 */
Note: See TracBrowser for help on using the repository browser.