Cleanup: mark VA_NARGS_COUNT as public
[blender.git] / source / blender / blenlib / BLI_string_utils.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2017 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BLI_STRING_UTILS_H__
29 #define __BLI_STRING_UTILS_H__
30
31 /** \file BLI_string_utils.h
32  *  \ingroup bli
33  */
34
35 #include <stdarg.h>
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 #include "BLI_compiler_attrs.h"
42 #include "BLI_variadic_defines.h"
43
44 struct ListBase;
45
46 typedef bool (*UniquenameCheckCallback)(void *arg, const char *name);
47
48 size_t BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
49
50 void BLI_string_split_suffix(const char *string, char *r_body, char *r_suf, const size_t str_len);
51 void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, const size_t str_len);
52
53 /* Join strings, return newly allocated string. */
54 char *BLI_string_join_arrayN(
55         const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
56 char *BLI_string_join_array_by_sep_charN(
57         char sep, const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
58 char *BLI_string_join_array_by_sep_char_with_tableN(
59         char sep, char *table[], const char *strings[], uint strings_len) ATTR_NONNULL();
60 /* Take multiple arguments, pass as (array, length). */
61 #define BLI_string_joinN(...) \
62         BLI_string_join_arrayN( \
63         ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
64 #define BLI_string_join_by_sep_charN(sep, ...) \
65         BLI_string_join_array_by_sep_charN( \
66         sep, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
67 #define BLI_string_join_by_sep_char_with_tableN(sep, table, ...) \
68         BLI_string_join_array_by_sep_char_with_tableN( \
69         sep, table, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
70
71 void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool strip_number, const size_t name_len);
72
73 bool BLI_uniquename_cb(
74         UniquenameCheckCallback unique_check, void *arg, const char *defname, char delim, char *name, size_t name_len);
75 bool BLI_uniquename(
76         struct ListBase *list, void *vlink, const char *defname, char delim, int name_offs, size_t len);
77
78 #ifdef __cplusplus
79 }
80 #endif
81
82 #endif  /* __BLI_STRING_UTILS_H__ */