argpar: sync with upstream - adjust to iterator API

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

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

#ifndef _STRING_UTILS_H
#define _STRING_UTILS_H

#include <stdbool.h>
#include <common/macros.h>
#include <common/dynamic-array.h>

LTTNG_HIDDEN
void strutils_normalize_star_glob_pattern(char *pattern);

LTTNG_HIDDEN
bool strutils_is_star_glob_pattern(const char *pattern);

LTTNG_HIDDEN
bool strutils_is_star_at_the_end_only_glob_pattern(const char *pattern);

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

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

LTTNG_HIDDEN
void strutils_free_null_terminated_array_of_strings(char **array);

LTTNG_HIDDEN
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.
 */
LTTNG_HIDDEN
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.
 */
LTTNG_HIDDEN
int strutils_appendf(char **s, const char *fmt, ...);

#endif /* _STRING_UTILS_H */