[mirror_frr.git] / lib / frrstr.h

/*
 * 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 <regex.h>
#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);

/*
 * Prefix match for string.
 *
 * str
 *    string to check for prefix match
 *
 * prefix
 *    prefix to look for
 *
 * Returns:
 *   true str starts with prefix, false otherwise
 */
bool begins_with(const char *str, const char *prefix);

/*
 * 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);

#ifdef __cplusplus
}
#endif

#endif /* _FRRSTR_H_ */
Commit	Line	Data
fe011935 QY	1	/*
	2	* FRR string processing utilities.
	3	* Copyright (C) 2018 Cumulus Networks, Inc.
	4	* Quentin Young
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the Free
	8	* Software Foundation; either version 2 of the License, or (at your option)
	9	* any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful, but WITHOUT
	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	14	* more details.
	15	*
	16	* You should have received a copy of the GNU General Public License along
	17	* with this program; see the file COPYING; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef _FRRSTR_H_
	22	#define _FRRSTR_H_
	23
	24	#include <sys/types.h>
	25	#include <regex.h>
2cddf2ff	26	#include <stdbool.h>
fe011935 QY	27
	28	#include "vector.h"
	29
5e244469 RW	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
fe011935 QY	34	/*
	35	* Tokenizes a string, storing tokens in a vector. Whitespace is ignored.
	36	* Delimiter characters are not included.
	37	*
	38	* string
	39	* The string to split
	40	*
	41	* delimiter
	42	* Delimiter string, as used in strsep()
	43	*
	44	* Returns:
	45	* The split string. Each token is allocated with MTYPE_TMP.
	46	*/
	47	void frrstr_split(const char string, const char delimiter, char ***result,
	48	int *argc);
	49	vector frrstr_split_vec(const char string, const char delimiter);
	50
	51	/*
	52	* Concatenate string array into a single string.
	53	*
	54	* argv
	55	* array of string pointers to concatenate
	56	*
	57	* argc
	58	* array length
	59	*
	60	* join
	61	* string to insert between each part, or NULL for nothing
	62	*
	63	* Returns:
	64	* the joined string, allocated with MTYPE_TMP
	65	*/
	66	char frrstr_join(const char parts, int argc, const char join);
	67	char frrstr_join_vec(vector v, const char join);
	68
	69	/*
	70	* Filter string vector.
	71	* Removes lines that do not contain a match for the provided regex.
	72	*
	73	* v
	74	* The vector to filter.
	75	*
	76	* filter
	77	* Regex to filter with.
	78	*/
	79	void frrstr_filter_vec(vector v, regex_t *filter);
	80
	81	/*
	82	* Free allocated string vector.
	83	* Assumes each item is allocated with MTYPE_TMP.
	84	*
	85	* v
	86	* the vector to free
	87	*/
	88	void frrstr_strvec_free(vector v);
	89
2cddf2ff QY	90	/*
	91	* Prefix match for string.
	92	*
	93	* str
	94	* string to check for prefix match
	95	*
	96	* prefix
	97	* prefix to look for
	98	*
	99	* Returns:
	100	* true str starts with prefix, false otherwise
	101	*/
	102	bool begins_with(const char str, const char prefix);
fe011935	103
5d5ba018	104	/*
	105	* Check the string only contains digit characters.
	106	*
	107	* str
	108	* string to check for digits
	109	*
	110	* Returns:
	111	* 1 str only contains digit characters, 0 otherwise
	112	*/
	113	int all_digit(const char *str);
	114
5e244469 RW	115	#ifdef __cplusplus
	116	}
	117	#endif
	118
fe011935	119	#endif /* _FRRSTR_H_ */