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

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

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