[lttng-tools.git] / src / common / string-utils / string-utils.hpp

/*
 * Copyright (C) 2017 Philippe Proulx <pproulx@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef _STRING_UTILS_H
#define _STRING_UTILS_H

#include <common/dynamic-array.hpp>
#include <common/macros.hpp>

#include <stdbool.h>

void strutils_normalize_star_glob_pattern(char *pattern);

bool strutils_is_star_glob_pattern(const char *pattern);

bool strutils_is_star_at_the_end_only_glob_pattern(const char *pattern);

char *strutils_unescape_string(const char *input, char only_char);

int strutils_split(const char *input,
		   char delim,
		   bool escape_delim,
		   struct lttng_dynamic_pointer_array *out_strings);

void strutils_free_null_terminated_array_of_strings(char **array);

size_t strutils_array_of_strings_len(char *const *array);

/*
 * Append `append` to the malloc-end string `str`.
 *
 * On success, `str` is free'd (if not NULL) and assigned a new malloc-ed
 * string.  On failure, `str` is not modified.
 *
 * Return 0 on success, -ENOMEM on failure.
 */
C_LINKAGE int strutils_append_str(char **str, const char *append);

/*
 * Like `strutils_append_str`, but the appended string is formatted using
 * `fmt` and the following arguments.
 */
C_LINKAGE ATTR_FORMAT_PRINTF(2, 3) int strutils_appendf(char **s, const char *fmt, ...);

#endif /* _STRING_UTILS_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2017 Philippe Proulx <pproulx@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef _STRING_UTILS_H
	9	#define _STRING_UTILS_H
	10
	11	#include <common/dynamic-array.hpp>
	12	#include <common/macros.hpp>
	13
	14	#include <stdbool.h>
	15
	16	void strutils_normalize_star_glob_pattern(char *pattern);
	17
	18	bool strutils_is_star_glob_pattern(const char *pattern);
	19
	20	bool strutils_is_star_at_the_end_only_glob_pattern(const char *pattern);
	21
	22	char strutils_unescape_string(const char input, char only_char);
	23
	24	int strutils_split(const char *input,
	25	char delim,
	26	bool escape_delim,
	27	struct lttng_dynamic_pointer_array *out_strings);
	28
	29	void strutils_free_null_terminated_array_of_strings(char **array);
	30
	31	size_t strutils_array_of_strings_len(char const array);
	32
	33	/*
	34	* Append `append` to the malloc-end string `str`.
	35	*
	36	* On success, `str` is free'd (if not NULL) and assigned a new malloc-ed
	37	* string. On failure, `str` is not modified.
	38	*
	39	* Return 0 on success, -ENOMEM on failure.
	40	*/
	41	C_LINKAGE int strutils_append_str(char *str, const char append);
	42
	43	/*
	44	* Like `strutils_append_str`, but the appended string is formatted using
	45	* `fmt` and the following arguments.
	46	*/
	47	C_LINKAGE ATTR_FORMAT_PRINTF(2, 3) int strutils_appendf(char *s, const char fmt, ...);
	48
	49	#endif /* _STRING_UTILS_H */