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