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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
* FRR string processing utilities.
* Copyright (C) 2018 Cumulus Networks, Inc.
* Quentin Young
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; see the file COPYING; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _FRRSTR_H_
#define _FRRSTR_H_
#include <sys/types.h>
#include <sys/types.h>
#ifdef HAVE_LIBPCRE2_POSIX
#ifndef _FRR_PCRE2_POSIX
#define _FRR_PCRE2_POSIX
#include <pcre2posix.h>
#endif /* _FRR_PCRE2_POSIX */
#elif defined(HAVE_LIBPCREPOSIX)
#include <pcreposix.h>
#else
#include <regex.h>
#endif /* HAVE_LIBPCRE2_POSIX */
#include <stdbool.h>
#include "vector.h"
#ifdef __cplusplus
extern "C" {
#endif
/*
* Tokenizes a string, storing tokens in a vector. Whitespace is ignored.
* Delimiter characters are not included.
*
* string
* The string to split
*
* delimiter
* Delimiter string, as used in strsep()
*
* Returns:
* The split string. Each token is allocated with MTYPE_TMP.
*/
void frrstr_split(const char *string, const char *delimiter, char ***result,
int *argc);
vector frrstr_split_vec(const char *string, const char *delimiter);
/*
* Concatenate string array into a single string.
*
* argv
* array of string pointers to concatenate
*
* argc
* array length
*
* join
* string to insert between each part, or NULL for nothing
*
* Returns:
* the joined string, allocated with MTYPE_TMP
*/
char *frrstr_join(const char **parts, int argc, const char *join);
char *frrstr_join_vec(vector v, const char *join);
/*
* Filter string vector.
* Removes lines that do not contain a match for the provided regex.
*
* v
* The vector to filter.
*
* filter
* Regex to filter with.
*/
void frrstr_filter_vec(vector v, regex_t *filter);
/*
* Free allocated string vector.
* Assumes each item is allocated with MTYPE_TMP.
*
* v
* the vector to free
*/
void frrstr_strvec_free(vector v);
/*
* Given a string, replaces all occurrences of a substring with a different
* string. The result is a new string. The original string is not modified.
*
* If 'replace' is longer than 'find', this function performs N+1 allocations,
* where N is the number of times 'find' occurs in 'str'. If 'replace' is equal
* in length or shorter than 'find', only 1 allocation is performed.
*
* str
* String to perform replacement on.
*
* find
* Substring to replace.
*
* replace
* String to replace 'find' with.
*
* Returns:
* A new string, allocated with MTYPE_TMP, that is the result of performing
* the replacement on 'str'. This must be freed by the caller.
*/
char *frrstr_replace(const char *str, const char *find, const char *replace);
/*
* Prefix match for string.
*
* str
* string to check for prefix match
*
* prefix
* prefix to look for
*
* Returns:
* true if str starts with prefix, false otherwise
*/
bool frrstr_startswith(const char *str, const char *prefix);
/*
* Suffix match for string.
*
* str
* string to check for suffix match
*
* suffix
* suffix to look for
*
* Returns:
* true if str ends with suffix, false otherwise
*/
bool frrstr_endswith(const char *str, const char *suffix);
/*
* Check the string only contains digit characters.
*
* str
* string to check for digits
*
* Returns:
* 1 str only contains digit characters, 0 otherwise
*/
int all_digit(const char *str);
/*
* Copy the hexadecimal representation of the string to a buffer.
*
* buff
* Buffer to copy result into with size of at least (2 * num) + 1.
*
* bufsiz
* Size of destination buffer.
*
* str
* String to represent as hexadecimal.
*
* num
* Number of characters to copy.
*
* Returns:
* Pointer to buffer containing resulting hexadecimal representation.
*/
char *frrstr_hex(char *buff, size_t bufsiz, const uint8_t *str, size_t num);
#ifdef __cplusplus
}
#endif
#endif /* _FRRSTR_H_ */
|
