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

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

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.
  • Property mode set to 100644
File size: 5.2 KB
RevLine 
[7ad3c2f]1/*
[df4ed85]2 * Copyright (c) 2005 Martin Decky
[c4bbca8]3 * Copyright (c) 2011 Oleg Romanenko
[7ad3c2f]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
[fadd381]30/** @addtogroup libc
[b2951e2]31 * @{
32 */
33/** @file
34 */
35
[19f857a]36#ifndef LIBC_STR_H_
37#define LIBC_STR_H_
[7ad3c2f]38
[36f0738]39#include <errno.h>
[e64c4b2]40#include <mem.h>
[8d2dd7f2]41#include <stddef.h>
42#include <stdint.h>
[3e6a98c5]43#include <stdbool.h>
[171f9a1]44
[d4a3ee5]45#define U_SPECIAL '?'
[171f9a1]46
[54a6ff6]47/** No size limit constant */
[f2b8cdc]48#define STR_NO_LIMIT ((size_t) -1)
49
[54a6ff6]50/** Maximum size of a string containing @c length characters */
[92fd52d7]51#define STR_BOUNDS(length) ((length) << 2)
[f2b8cdc]52
[dcb74c0a]53/**
54 * Maximum size of a buffer needed to a string converted from space-padded
55 * ASCII of size @a spa_size using spascii_to_str().
56 */
57#define SPASCII_STR_BUFSIZE(spa_size) ((spa_size) + 1)
58
[171f9a1]59extern wchar_t str_decode(const char *str, size_t *offset, size_t sz);
[568693b]60extern wchar_t str_decode_reverse(const char *str, size_t *offset, size_t sz);
[b7fd2a0]61extern errno_t chr_encode(const wchar_t ch, char *str, size_t *offset, size_t sz);
[171f9a1]62
[f2b8cdc]63extern size_t str_size(const char *str);
64extern size_t wstr_size(const wchar_t *str);
65
[560d79f]66extern size_t str_nsize(const char *str, size_t max_size);
67extern size_t wstr_nsize(const wchar_t *str, size_t max_size);
68
[d4a3ee5]69extern size_t str_lsize(const char *str, size_t max_len);
70extern size_t wstr_lsize(const wchar_t *str, size_t max_len);
[f2b8cdc]71
[d4a3ee5]72extern size_t str_length(const char *str);
73extern size_t wstr_length(const wchar_t *wstr);
[f2b8cdc]74
[d4a3ee5]75extern size_t str_nlength(const char *str, size_t size);
76extern size_t wstr_nlength(const wchar_t *str, size_t size);
[f2b8cdc]77
[be2a38ad]78extern size_t chr_width(wchar_t ch);
79extern size_t str_width(const char *str);
80
[f2b8cdc]81extern bool ascii_check(wchar_t ch);
82extern bool chr_check(wchar_t ch);
83
84extern int str_cmp(const char *s1, const char *s2);
[d4a3ee5]85extern int str_lcmp(const char *s1, const char *s2, size_t max_len);
[8227d63]86extern int str_casecmp(const char *s1, const char *s2);
87extern int str_lcasecmp(const char *s1, const char *s2, size_t max_len);
[f2b8cdc]88
[dce39b4]89extern bool str_test_prefix(const char *s, const char *p);
90
[6eb2e96]91extern void str_cpy(char *dest, size_t size, const char *src);
92extern void str_ncpy(char *dest, size_t size, const char *src, size_t n);
[4482bc7]93extern void str_append(char *dest, size_t size, const char *src);
[6eb2e96]94
[b7fd2a0]95extern errno_t spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n);
[81e9cb3]96extern void wstr_to_str(char *dest, size_t size, const wchar_t *src);
[b67c7d64]97extern char *wstr_to_astr(const wchar_t *src);
[81e9cb3]98extern void str_to_wstr(wchar_t *dest, size_t dlen, const char *src);
[22cf42d9]99extern wchar_t *str_to_awstr(const char *src);
[b7fd2a0]100extern errno_t utf16_to_str(char *dest, size_t size, const uint16_t *src);
101extern errno_t str_to_utf16(uint16_t *dest, size_t dlen, const char *src);
[b2906c0]102extern size_t utf16_wsize(const uint16_t *ustr);
[f2b8cdc]103
[dd2cfa7]104extern char *str_chr(const char *str, wchar_t ch);
105extern char *str_rchr(const char *str, wchar_t ch);
[f2b8cdc]106
[1737bfb]107extern void str_rtrim(char *str, wchar_t ch);
108extern void str_ltrim(char *str, wchar_t ch);
109
[d4a3ee5]110extern bool wstr_linsert(wchar_t *str, wchar_t ch, size_t pos, size_t max_pos);
111extern bool wstr_remove(wchar_t *str, size_t pos);
[f2b8cdc]112
[095003a8]113extern char *str_dup(const char *);
[fc6dd18]114extern char *str_ndup(const char *, size_t max_size);
[095003a8]115
[ee3f6f6]116extern char *str_tok(char *, const char *, char **);
117
[b7fd2a0]118extern errno_t str_uint8_t(const char *, const char **, unsigned int, bool,
[b49d872]119 uint8_t *);
[b7fd2a0]120extern errno_t str_uint16_t(const char *, const char **, unsigned int, bool,
[b49d872]121 uint16_t *);
[b7fd2a0]122extern errno_t str_uint32_t(const char *, const char **, unsigned int, bool,
[b49d872]123 uint32_t *);
[b7fd2a0]124extern errno_t str_uint64_t(const char *, const char **, unsigned int, bool,
[b49d872]125 uint64_t *);
[b7fd2a0]126extern errno_t str_size_t(const char *, const char **, unsigned int, bool,
[b49d872]127 size_t *);
[d47279b]128
[933cadf]129extern void order_suffix(const uint64_t, uint64_t *, char *);
130extern void bin_order_suffix(const uint64_t, uint64_t *, const char **, bool);
[e535eeb]131
[f2b8cdc]132/*
133 * TODO: Get rid of this.
134 */
[c9857c6]135
[1526594c]136extern long int strtol(const char *, char **, int);
137extern unsigned long strtoul(const char *, char **, int);
[c9857c6]138
[7ad3c2f]139#endif
[b2951e2]140
[fadd381]141/** @}
[b2951e2]142 */
Note: See TracBrowser for help on using the repository browser.