1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/* str_util.h
* String utility definitions
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __STR_UTIL_H__
#define __STR_UTIL_H__
#include <wireshark.h>
#include <wsutil/wmem/wmem.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** Convert all upper-case ASCII letters to their ASCII lower-case
* equivalents, in place, with a simple non-locale-dependent
* ASCII mapping (A-Z -> a-z).
* All other characters are left unchanged, as the mapping to
* lower case may be locale-dependent.
*
* The string is assumed to be in a character encoding, such as
* an ISO 8859 or other EUC encoding, or UTF-8, in which all
* bytes in the range 0x00 through 0x7F are ASCII characters and
* non-ASCII characters are constructed from one or more bytes in
* the range 0x80 through 0xFF.
*
* @param str The string to be lower-cased.
* @return ptr to the string
*/
WS_DLL_PUBLIC
gchar *ascii_strdown_inplace(gchar *str);
/** Convert all lower-case ASCII letters to their ASCII upper-case
* equivalents, in place, with a simple non-locale-dependent
* ASCII mapping (a-z -> A-Z).
* All other characters are left unchanged, as the mapping to
* lower case may be locale-dependent.
*
* The string is assumed to be in a character encoding, such as
* an ISO 8859 or other EUC encoding, or UTF-8, in which all
* bytes in the range 0x00 through 0x7F are ASCII characters and
* non-ASCII characters are constructed from one or more bytes in
* the range 0x80 through 0xFF.
*
* @param str The string to be upper-cased.
* @return ptr to the string
*/
WS_DLL_PUBLIC
gchar *ascii_strup_inplace(gchar *str);
/** Check if an entire string consists of printable characters
*
* @param str The string to be checked
* @return TRUE if the entire string is printable, otherwise FALSE
*/
WS_DLL_PUBLIC
gboolean isprint_string(const gchar *str);
/** Check if an entire UTF-8 string consists of printable characters
*
* @param str The string to be checked
* @param length The number of bytes to validate
* @return TRUE if the entire string is printable, otherwise FALSE
*/
WS_DLL_PUBLIC
gboolean isprint_utf8_string(const gchar *str, guint length);
/** Check if an entire string consists of digits
*
* @param str The string to be checked
* @return TRUE if the entire string is digits, otherwise FALSE
*/
WS_DLL_PUBLIC
gboolean isdigit_string(const guchar *str);
/**
* Return the first occurrence of needle in haystack.
*
* @param haystack The data to search
* @param haystack_len The length of the search data
* @param needle The string to look for
* @param needle_len The length of the search string
* @return A pointer to the first occurrence of "needle" in
* "haystack". If "needle" isn't found or is NULL, or if
* "needle_len" is 0, NULL is returned.
*/
WS_DLL_PUBLIC
const guint8 *ws_memmem(const void *haystack, size_t haystack_len,
const void *needle, size_t needle_len);
/** Finds the first occurrence of string 'needle' in string 'haystack'.
* The matching is done in a case insensitive manner.
*
* @param haystack The string possibly containing the substring
* @param needle The substring to be searched
* @return A pointer into 'haystack' where 'needle' is first found.
* Otherwise it returns NULL.
*/
WS_DLL_PUBLIC
const char *ws_strcasestr(const char *haystack, const char *needle);
WS_DLL_PUBLIC
char *ws_escape_string(wmem_allocator_t *alloc, const char *string, bool add_quotes);
WS_DLL_PUBLIC
int ws_xton(char ch);
typedef enum {
format_size_unit_none = 0, /**< No unit will be appended. You must supply your own. */
format_size_unit_bytes = 1, /**< "bytes" for un-prefixed sizes, "B" otherwise. */
format_size_unit_bits = 2, /**< "bits" for un-prefixed sizes, "b" otherwise. */
format_size_unit_bits_s = 3, /**< "bits/s" for un-prefixed sizes, "bps" otherwise. */
format_size_unit_bytes_s = 4, /**< "bytes/s" for un-prefixed sizes, "Bps" otherwise. */
format_size_unit_packets = 5, /**< "packets" */
format_size_unit_packets_s = 6, /**< "packets/s" */
format_size_prefix_si = 0 << 8, /**< SI (power of 1000) prefixes will be used. */
format_size_prefix_iec = 1 << 8 /**< IEC (power of 1024) prefixes will be used. */
/* XXX format_size_prefix_default_for_this_particular_os ? */
} format_size_flags_e;
/** Given a size, return its value in a human-readable format
*
* Prefixes up to "T/Ti" (tera, tebi) are currently supported.
*
* @param size The size value
* @param flags Flags to control the output (unit of measurement,
* SI vs IEC, etc). Unit and prefix flags may be ORed together.
* @return A newly-allocated string representing the value.
*/
WS_DLL_PUBLIC
gchar *format_size_wmem(wmem_allocator_t *allocator, gint64 size, format_size_flags_e flags);
#define format_size(size, flags) format_size_wmem(NULL, size, flags)
WS_DLL_PUBLIC
gchar printable_char_or_period(gchar c);
/* To pass one of two strings, singular or plural */
#define plurality(d,s,p) ((d) == 1 ? (s) : (p))
#define true_or_false(val) ((val) ? "TRUE" : "FALSE")
#define string_or_null(val) ((val) ? (val) : "[NULL]")
#ifdef __cplusplus
}
/* Should we just have separate unit and prefix enums instead? */
extern format_size_flags_e operator|(format_size_flags_e lhs, format_size_flags_e rhs);
#endif /* __cplusplus */
#endif /* __STR_UTIL_H__ */
|
