Cleanup: comment line length (blenlib)
[blender.git] / source / blender / blenlib / BLI_string.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) 2001-2002 by NaN Holding BV.
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_H__
29 #define __BLI_STRING_H__
30
31 /** \file BLI_string.h
32  *  \ingroup bli
33  */
34
35 #include <stdarg.h>
36 #include <inttypes.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 #include "BLI_compiler_attrs.h"
43
44 char *BLI_strdupn(const char *str, const size_t len) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
45
46 char *BLI_strdup(const char *str) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL() ATTR_MALLOC;
47
48 char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL() ATTR_MALLOC;
49
50 char *BLI_strncpy(char *__restrict dst, const char *__restrict src, const size_t maxncpy) ATTR_NONNULL();
51
52 char *BLI_strncpy_ensure_pad(char *__restrict dst, const char *__restrict src, const char pad, size_t maxncpy) ATTR_NONNULL();
53
54 size_t BLI_strncpy_rlen(char *__restrict dst, const char *__restrict src, const size_t maxncpy) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
55
56 size_t BLI_strcpy_rlen(char *__restrict dst, const char *__restrict src) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
57
58 char *BLI_str_quoted_substrN(const char *__restrict str, const char *__restrict prefix) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL() ATTR_MALLOC;
59
60 char *BLI_str_replaceN(const char *__restrict str, const char *__restrict substr_old, const char *__restrict substr_new) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL() ATTR_MALLOC;
61
62 void BLI_str_replace_char(char *string, char src, char dst) ATTR_NONNULL();
63
64 size_t BLI_snprintf(char *__restrict dst, size_t maxncpy, const char *__restrict format, ...) ATTR_NONNULL(1, 3) ATTR_PRINTF_FORMAT(3, 4);
65 size_t BLI_snprintf_rlen(char *__restrict dst, size_t maxncpy, const char *__restrict format, ...) ATTR_NONNULL(1, 3) ATTR_PRINTF_FORMAT(3, 4);
66
67 size_t BLI_vsnprintf(char *__restrict dst, size_t maxncpy, const char *__restrict format, va_list arg) ATTR_PRINTF_FORMAT(3, 0);
68 size_t BLI_vsnprintf_rlen(char *__restrict buffer, size_t maxncpy, const char *__restrict format, va_list arg) ATTR_PRINTF_FORMAT(3, 0);
69
70 char *BLI_sprintfN(const char *__restrict format, ...) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1) ATTR_MALLOC ATTR_PRINTF_FORMAT(1, 2);
71
72 size_t BLI_strescape(char *__restrict dst, const char *__restrict src, const size_t maxncpy) ATTR_NONNULL();
73
74 size_t BLI_str_format_int_grouped(char dst[16], int num) ATTR_NONNULL();
75 size_t BLI_str_format_uint64_grouped(char dst[16], uint64_t num) ATTR_NONNULL();
76 void   BLI_str_format_byte_unit(char dst[15], long long int size, const bool base_10) ATTR_NONNULL();
77
78 int BLI_strcaseeq(const char *a, const char *b) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
79 char *BLI_strcasestr(const char *s, const char *find) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
80 char *BLI_strncasestr(const char *s, const char *find, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
81 int BLI_strcasecmp(const char *s1, const char *s2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
82 int BLI_strncasecmp(const char *s1, const char *s2, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
83 int BLI_natstrcmp(const char *s1, const char *s2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
84 int BLI_strcmp_ignore_pad(const char *str1, const char *str2, const char pad) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
85
86 size_t BLI_strnlen(const char *str, const size_t maxlen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
87
88 void BLI_str_tolower_ascii(char *str, const size_t len) ATTR_NONNULL();
89 void BLI_str_toupper_ascii(char *str, const size_t len) ATTR_NONNULL();
90 void BLI_str_rstrip(char *str) ATTR_NONNULL();
91 int BLI_str_rstrip_float_zero(char *str, const char pad) ATTR_NONNULL();
92
93 int BLI_str_index_in_array_n(const char *__restrict str, const char **__restrict str_array, const int str_array_len) ATTR_NONNULL();
94 int BLI_str_index_in_array(const char *__restrict str, const char **__restrict str_array) ATTR_NONNULL();
95
96 bool BLI_str_endswith(const char *__restrict str, const char *__restrict end) ATTR_NONNULL();
97 bool BLI_strn_endswith(const char *__restrict str, const char *__restrict end, size_t length) ATTR_NONNULL();
98
99 size_t BLI_str_partition(const char *str, const char delim[], const char **sep, const char **suf) ATTR_NONNULL();
100 size_t BLI_str_rpartition(const char *str, const char delim[], const char **sep, const char **suf) ATTR_NONNULL();
101 size_t BLI_str_partition_ex(
102         const char *str, const char *end, const char delim[], const char **sep, const char **suf, const bool from_right)
103         ATTR_NONNULL(1, 3, 4, 5);
104
105 int BLI_string_find_split_words(
106         const char *str, const size_t len,
107         const char delim, int r_words[][2], int words_max)
108         ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
109
110 /** \name String Copy/Format Macros
111  * Avoid repeating destination with `sizeof(..)`.
112  * \note `ARRAY_SIZE` allows pointers on some platforms.
113  * \{ */
114 #define STRNCPY(dst, src) \
115     BLI_strncpy(dst, src, ARRAY_SIZE(dst))
116 #define STRNCPY_RLEN(dst, src) \
117     BLI_strncpy_rlen(dst, src, ARRAY_SIZE(dst))
118 #define SNPRINTF(dst, format, ...) \
119     BLI_snprintf(dst, ARRAY_SIZE(dst), format, __VA_ARGS__)
120 #define SNPRINTF_RLEN(dst, format, ...) \
121     BLI_snprintf_rlen(dst, ARRAY_SIZE(dst), format, __VA_ARGS__)
122 /** \} */
123
124 #ifdef __cplusplus
125 }
126 #endif
127
128 #endif  /* __BLI_STRING_H__ */