ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenlib / BLI_string_utils.h
index bb19ed574bb81b21188eaaba913818fade4015d5..9740629276d8cc99e9fe6edc36a327376da71fc4 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is Copyright (C) 2017 by the Blender Foundation.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): none yet.
- *
- * ***** END GPL LICENSE BLOCK *****
  */
 
 #ifndef __BLI_STRING_UTILS_H__
 #define __BLI_STRING_UTILS_H__
 
-/** \file BLI_string_utils.h
- *  \ingroup bli
+/** \file
+ * \ingroup bli
  */
 
 #include <stdarg.h>
@@ -39,6 +31,7 @@ extern "C" {
 #endif
 
 #include "BLI_compiler_attrs.h"
+#include "BLI_utildefines_variadic.h"
 
 struct ListBase;
 
@@ -49,15 +42,46 @@ size_t BLI_split_name_num(char *left, int *nr, const char *name, const char deli
 void BLI_string_split_suffix(const char *string, char *r_body, char *r_suf, const size_t str_len);
 void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, const size_t str_len);
 
-void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool strip_number, const size_t name_len);
+/* Join strings, return newly allocated string. */
+char *BLI_string_join_arrayN(const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT
+    ATTR_NONNULL();
+char *BLI_string_join_array_by_sep_charN(char sep,
+                                         const char *strings[],
+                                         uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
+char *BLI_string_join_array_by_sep_char_with_tableN(char sep,
+                                                    char *table[],
+                                                    const char *strings[],
+                                                    uint strings_len) ATTR_NONNULL();
+/* Take multiple arguments, pass as (array, length). */
+#define BLI_string_joinN(...) \
+  BLI_string_join_arrayN(((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
+#define BLI_string_join_by_sep_charN(sep, ...) \
+  BLI_string_join_array_by_sep_charN( \
+      sep, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
+#define BLI_string_join_by_sep_char_with_tableN(sep, table, ...) \
+  BLI_string_join_array_by_sep_char_with_tableN( \
+      sep, table, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
+
+void BLI_string_flip_side_name(char *r_name,
+                               const char *from_name,
+                               const bool strip_number,
+                               const size_t name_len);
 
-bool BLI_uniquename_cb(
-        UniquenameCheckCallback unique_check, void *arg, const char *defname, char delim, char *name, size_t name_len);
-bool BLI_uniquename(
-        struct ListBase *list, void *vlink, const char *defname, char delim, int name_offs, size_t len);
+bool BLI_uniquename_cb(UniquenameCheckCallback unique_check,
+                       void *arg,
+                       const char *defname,
+                       char delim,
+                       char *name,
+                       size_t name_len);
+bool BLI_uniquename(struct ListBase *list,
+                    void *vlink,
+                    const char *defname,
+                    char delim,
+                    int name_offs,
+                    size_t len);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif  /* __BLI_STRING_UTILS_H__ */
+#endif /* __BLI_STRING_UTILS_H__ */