diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 09:53:30 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 09:53:30 +0000 |
commit | 2c7cac91ed6e7db0f6937923d2b57f97dbdbc337 (patch) | |
tree | c05dc0f8e6aa3accc84e3e5cffc933ed94941383 /lib/frrstr.h | |
parent | Initial commit. (diff) | |
download | frr-upstream.tar.xz frr-upstream.zip |
Adding upstream version 8.4.4.upstream/8.4.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/frrstr.h')
-rw-r--r-- | lib/frrstr.h | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/lib/frrstr.h b/lib/frrstr.h new file mode 100644 index 0000000..d52d6a4 --- /dev/null +++ b/lib/frrstr.h @@ -0,0 +1,181 @@ +/* + * 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_LIBPCREPOSIX +#include <pcreposix.h> +#else +#include <regex.h> +#endif /* HAVE_LIBPCREPOSIX */ +#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_ */ |