Blender  V3.3
BLI_string_utils.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later
2  * Copyright 2017 Blender Foundation. All rights reserved. */
3 
4 #pragma once
5 
10 #include <stdarg.h>
11 
12 #include "BLI_compiler_attrs.h"
13 #include "BLI_utildefines.h"
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 struct ListBase;
20 
21 typedef bool (*UniquenameCheckCallback)(void *arg, const char *name);
22 
37 size_t BLI_split_name_num(char *left, int *nr, const char *name, char delim);
38 bool BLI_string_is_decimal(const char *string) ATTR_NONNULL();
39 
44 void BLI_string_split_suffix(const char *string, char *r_body, char *r_suf, size_t str_len);
48 void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, size_t str_len);
49 
53 char *BLI_string_join_array(char *result,
54  size_t result_len,
55  const char *strings[],
56  uint strings_len) ATTR_NONNULL();
61  size_t result_len,
62  char sep,
63  const char *strings[],
64  uint strings_len) ATTR_NONNULL();
65 
69 char *BLI_string_join_arrayN(const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT
70  ATTR_NONNULL();
75  const char *strings[],
82  char *table[],
83  const char *strings[],
84  uint strings_len) ATTR_NONNULL();
88 #define BLI_string_join(result, result_len, ...) \
89  BLI_string_join_array( \
90  result, result_len, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
91 #define BLI_string_joinN(...) \
92  BLI_string_join_arrayN(((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
93 #define BLI_string_join_by_sep_charN(sep, ...) \
94  BLI_string_join_array_by_sep_charN( \
95  sep, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
96 #define BLI_string_join_by_sep_char_with_tableN(sep, table, ...) \
97  BLI_string_join_array_by_sep_char_with_tableN( \
98  sep, table, ((const char *[]){__VA_ARGS__}), VA_NARGS_COUNT(__VA_ARGS__))
99 
111 size_t BLI_string_flip_side_name(char *r_name,
112  const char *from_name,
113  bool strip_number,
114  size_t name_len);
115 
129  void *arg,
130  const char *defname,
131  char delim,
132  char *name,
133  size_t name_len);
145 bool BLI_uniquename(struct ListBase *list,
146  void *vlink,
147  const char *defname,
148  char delim,
149  int name_offset,
150  size_t name_len);
151 
152 #ifdef __cplusplus
153 }
154 #endif
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_NONNULL(...)
void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, size_t str_len)
Definition: string_utils.c:93
char * BLI_string_join_array(char *result, size_t result_len, const char *strings[], uint strings_len) ATTR_NONNULL()
Definition: string_utils.c:347
char * BLI_string_join_array_by_sep_char_with_tableN(char sep, char *table[], const char *strings[], uint strings_len) ATTR_NONNULL()
Definition: string_utils.c:424
bool BLI_uniquename_cb(UniquenameCheckCallback unique_check, void *arg, const char *defname, char delim, char *name, size_t name_len)
Definition: string_utils.c:233
bool BLI_string_is_decimal(const char *string) ATTR_NONNULL()
Definition: string_utils.c:55
char * BLI_string_join_array_by_sep_charN(char sep, const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
Definition: string_utils.c:400
void BLI_string_split_suffix(const char *string, char *r_body, char *r_suf, size_t str_len)
Definition: string_utils.c:75
char * BLI_string_join_arrayN(const char *strings[], uint strings_len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
Definition: string_utils.c:384
bool BLI_uniquename(struct ListBase *list, void *vlink, const char *defname, char delim, int name_offset, size_t name_len)
Definition: string_utils.c:309
bool(* UniquenameCheckCallback)(void *arg, const char *name)
char * BLI_string_join_array_by_sep_char(char *result, size_t result_len, char sep, const char *strings[], uint strings_len) ATTR_NONNULL()
Definition: string_utils.c:364
size_t BLI_split_name_num(char *left, int *nr, const char *name, char delim)
Definition: string_utils.c:25
size_t BLI_string_flip_side_name(char *r_name, const char *from_name, bool strip_number, size_t name_len)
Definition: string_utils.c:112
unsigned int uint
Definition: BLI_sys_types.h:67
static int left