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
24  * \ingroup bli
25  */
26
27 #include <stdarg.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #include "BLI_compiler_attrs.h"
34 #include "BLI_utildefines_variadic.h"
35
36 struct ListBase;
37
38 typedef bool (*UniquenameCheckCallback)(void *arg, const char *name);
39
40 size_t BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
41
42 void BLI_string_split_suffix(const char *string, char *r_body, char *r_suf, const size_t str_len);
43 void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, const size_t str_len);
44
45 /* Join strings, return newly allocated string. */
46 char *BLI_string_join_arrayN(
47         const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
48 char *BLI_string_join_array_by_sep_charN(
49         char sep, const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
50 char *BLI_string_join_array_by_sep_char_with_tableN(
51         char sep, char *table[], const char *strings[], uint strings_len) ATTR_NONNULL();
52 /* Take multiple arguments, pass as (array, length). */
53 #define BLI_string_joinN(...) \
54         BLI_string_join_arrayN( \
55         ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
56 #define BLI_string_join_by_sep_charN(sep, ...) \
57         BLI_string_join_array_by_sep_charN( \
58         sep, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
59 #define BLI_string_join_by_sep_char_with_tableN(sep, table, ...) \
60         BLI_string_join_array_by_sep_char_with_tableN( \
61         sep, table, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
62
63 void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool strip_number, const size_t name_len);
64
65 bool BLI_uniquename_cb(
66         UniquenameCheckCallback unique_check, void *arg, const char *defname, char delim, char *name, size_t name_len);
67 bool BLI_uniquename(
68         struct ListBase *list, void *vlink, const char *defname, char delim, int name_offs, size_t len);
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74 #endif  /* __BLI_STRING_UTILS_H__ */