Cthulhu  0.2.10
Cthulhu compiler collection
str.h
Go to the documentation of this file.
1 // SPDX-License-Identifier: LGPL-3.0-only
2 
3 #pragma once
4 
5 #include <ctu_std_api.h>
6 
7 #include "core/analyze.h"
8 #include "core/compiler.h"
9 #include "core/text.h"
10 
11 #include <stdarg.h>
12 #include <stdbool.h>
13 #include <stddef.h>
14 
15 CT_BEGIN_API
16 
17 typedef struct arena_t arena_t;
18 typedef struct vector_t vector_t;
19 typedef struct map_t map_t;
20 
25 
39 CT_STD_API size_t str_vsprintf(STA_WRITES(len) char *str, size_t len, IN_STRING const char *fmt, va_list args);
40 
54 STA_PRINTF(3, 4)
55 CT_STD_API size_t str_sprintf(STA_WRITES(len) char *str, size_t len, STA_FORMAT_STRING const char *fmt, ...);
56 
67 CT_NODISCARD STA_PRINTF(2, 3)
68 CT_STD_API text_t text_format(IN_NOTNULL arena_t *arena, STA_FORMAT_STRING const char *fmt, ...);
69 
80 CT_NODISCARD
81 CT_STD_API text_t text_vformat(IN_NOTNULL arena_t *arena, IN_STRING const char *fmt, va_list args);
82 
92 CT_NODISCARD STA_PRINTF(2, 3)
93 CT_STD_API char *str_format(IN_NOTNULL arena_t *arena, STA_FORMAT_STRING const char *fmt, ...);
94 
104 CT_NODISCARD
105 CT_STD_API char *str_vformat(IN_NOTNULL arena_t *arena, IN_STRING const char *fmt, va_list args);
106 
113 CT_NODISCARD CT_PUREFN
114 CT_STD_API bool str_startswith(IN_STRING const char *str, IN_STRING const char *prefix);
115 
122 CT_NODISCARD CT_PUREFN
123 CT_STD_API bool str_endswith(IN_STRING const char *str, IN_STRING const char *suffix);
124 
134 CT_NODISCARD CT_PUREFN
135 CT_STD_API bool str_endswithn(STA_READS(len) const char *str, size_t len, IN_STRING const char *suffix);
136 
146 CT_NODISCARD
147 CT_STD_API char *str_join(IN_STRING const char *sep, IN_NOTNULL const vector_t *parts, IN_NOTNULL arena_t *arena);
148 
158 CT_NODISCARD
159 CT_STD_API char *str_repeat(IN_STRING const char *str, size_t times, IN_NOTNULL arena_t *arena);
160 
169 CT_NODISCARD
170 CT_STD_API char *str_normalize(IN_STRING const char *str, IN_NOTNULL arena_t *arena);
171 
180 CT_NODISCARD
181 CT_STD_API char *str_normalizen(text_view_t text, IN_NOTNULL arena_t *arena);
182 
194 CT_STD_API size_t str_normalize_into(
195  STA_WRITES(len) char *dst,
196  size_t dstlen,
197  STA_READS(srclen) const char *src,
198  size_t srclen);
199 
211 CT_NODISCARD
212 CT_STD_API vector_t *str_split(IN_STRING const char *str, IN_STRING const char *sep, IN_NOTNULL arena_t *arena);
213 
222 CT_NODISCARD RET_NOTNULL
223 CT_STD_API const char *str_common_prefix(IN_NOTNULL const vector_t *args, IN_NOTNULL arena_t *arena);
224 
232 RET_INSPECT CT_PUREFN
233 CT_STD_API size_t str_rfind(IN_STRING const char *str, IN_STRING const char *sub);
234 
241 RET_INSPECT CT_PUREFN
242 CT_STD_API size_t str_find(IN_STRING const char *str, IN_STRING const char *sub);
243 
250 RET_INSPECT CT_PUREFN
251 CT_STD_API size_t str_rfind_any(IN_STRING const char *str, IN_STRING const char *letters);
252 
260 CT_NODISCARD CT_PUREFN
261 CT_STD_API bool char_is_any_of(char c, IN_STRING const char *chars);
262 
269 CT_NODISCARD CT_PUREFN
270 CT_STD_API bool str_contains(IN_STRING const char *str, IN_STRING const char *search);
271 
280 CT_NODISCARD
281 CT_STD_API char *str_replace(IN_STRING const char *str, IN_STRING const char *search, IN_STRING const char *repl, IN_NOTNULL arena_t *arena);
282 
288 CT_STD_API void str_replace_inplace(INOUT_NOTNULL text_t *text, IN_STRING const char *search, IN_STRING const char *repl);
289 
294 CT_STD_API void str_trim_back_inplace(INOUT_NOTNULL text_t *text, IN_STRING const char *chars);
295 
300 CT_STD_API void str_sort_inplace(STA_UPDATES(len) char *str, size_t len);
301 
309 CT_NODISCARD
310 CT_STD_API char *str_replace_many(IN_STRING const char *str, IN_NOTNULL const map_t *repl, IN_NOTNULL arena_t *arena);
311 
319 CT_NODISCARD CT_NOALIAS
320 CT_STD_API char *str_erase(STA_READS(len) char *str, size_t len, IN_STRING const char *letters);
321 
328 CT_NODISCARD
329 CT_STD_API char *str_basename(IN_STRING const char *path, IN_NOTNULL arena_t *arena);
330 
337 CT_NODISCARD
338 CT_STD_API char *str_filename(IN_STRING const char *path, IN_NOTNULL arena_t *arena);
339 
346 CT_NODISCARD
347 CT_STD_API char *str_noext(IN_STRING const char *path, IN_NOTNULL arena_t *arena);
348 
355 CT_NODISCARD
356 CT_STD_API char *str_ext(IN_STRING const char *path, IN_NOTNULL arena_t *arena);
357 
364 CT_NODISCARD
365 CT_STD_API char *str_directory(IN_STRING const char *path, IN_NOTNULL arena_t *arena);
366 
373 CT_NODISCARD
374 CT_STD_API char *str_upper(IN_STRING const char *str, IN_NOTNULL arena_t *arena);
375 
383 CT_NODISCARD
384 CT_STD_API char *str_lower(IN_STRING const char *str, IN_NOTNULL arena_t *arena);
385 
391 CT_NODISCARD CT_CONSTFN
392 CT_STD_API char str_tolower(char c);
393 
399 CT_NODISCARD CT_CONSTFN
400 CT_STD_API char str_toupper(char c);
401 
408 CT_NODISCARD
409 CT_STD_API bool text_view_equal(text_view_t lhs, text_view_t rhs);
410 
411 #define STR_WHITESPACE " \t\r\v\n\f"
412 
414 
415 CT_END_API
STA_WRITES
CT_NODISCARD STA_WRITES(size) void *dst
RET_NOTNULL
#define RET_NOTNULL
annotate the return value as not being null
CT_PUREFN
#define CT_PUREFN
mark a function as pure, always returns the same value for the same arguments
Definition: analyze.h:228
CT_NODISCARD
#define CT_NODISCARD
mark a function as returning a value that must be used
IN_NOTNULL
#define IN_NOTNULL
annotate a parameter as not being null
STA_FORMAT_STRING
#define STA_FORMAT_STRING
mark a function parameter as a printf format string
STA_READS
#define STA_READS(size)
annotate a parameter as reading expr elements
RET_INSPECT
#define RET_INSPECT
annotate the return value as needing to be inspected this is the same as CT_NODISCARD but implies tha...
CT_CONSTFN
#define CT_CONSTFN
mark a function as const, has no side effects and always returns the same value for the same argument...
Definition: analyze.h:227
INOUT_NOTNULL
#define INOUT_NOTNULL
Definition: analyze.h:101
IN_STRING
#define IN_STRING
annotate a parameter as being a null terminated string
CT_NOALIAS
#define CT_NOALIAS
mark a function as only modifying pointers passed to it the same as CT_CONSTFN but allowed to modify/...
Definition: analyze.h:226
STA_UPDATES
#define STA_UPDATES(size)
Definition: analyze.h:123
CT_BEGIN_API
#define CT_BEGIN_API
Definition: compiler.h:129
CT_END_API
#define CT_END_API
Definition: compiler.h:130
str_noext
CT_NODISCARD CT_STD_API char * str_noext(const char *path, arena_t *arena)
remove the last file extension from a path
Definition: str.c:156
str_rfind_any
CT_PUREFN CT_STD_API size_t str_rfind_any(const char *str, const char *letters)
find the first instance of a set of characters in a string
Definition: str.c:137
str_endswithn
CT_NODISCARD CT_PUREFN CT_STD_API bool str_endswithn(STA_READS(len) const char *str, size_t len, const char *suffix)
check if a string ends with a substring
str_replace
CT_NODISCARD CT_STD_API char * str_replace(const char *str, const char *search, const char *repl, arena_t *arena)
replace all instances of a substring in a string
Definition: str.c:616
str_replace_inplace
CT_STD_API void str_replace_inplace(INOUT_NOTNULL text_t *text, const char *search, const char *repl)
replace all instances of a substring in a string in place
text_view_equal
CT_NODISCARD CT_STD_API bool text_view_equal(text_view_t lhs, text_view_t rhs)
check if two strings are equal
Definition: str.c:992
str_endswith
CT_NODISCARD CT_PUREFN CT_STD_API bool str_endswith(const char *str, const char *suffix)
check if a string ends with a substring
Definition: str.c:242
str_find
CT_PUREFN CT_STD_API size_t str_find(const char *str, const char *sub)
find the first instance of a substring in a string
Definition: str.c:896
str_normalizen
CT_NODISCARD CT_STD_API char * str_normalizen(text_view_t text, arena_t *arena)
turn a string with length into a C string literal
Definition: str.c:524
str_sprintf
CT_STD_API size_t str_sprintf(STA_WRITES(len) char *str, size_t len, STA_FORMAT_STRING const char *fmt,...)
format a string with printf-like syntax
text_vformat
CT_NODISCARD STA_FORMAT_STRING const char CT_NODISCARD CT_STD_API text_t text_vformat(arena_t *arena, const char *fmt, va_list args)
format a string
Definition: str.c:56
str_sort_inplace
CT_STD_API void str_sort_inplace(STA_UPDATES(len) char *str, size_t len)
sort a strings contents in place
str_repeat
CT_NODISCARD CT_STD_API char * str_repeat(const char *str, size_t times, arena_t *arena)
repeat a string
Definition: str.c:336
str_upper
CT_NODISCARD CT_STD_API char * str_upper(const char *str, arena_t *arena)
uppercase an ascii string
Definition: str.c:934
str_normalize_into
CT_STD_API size_t str_normalize_into(STA_WRITES(len) char *dst, size_t dstlen, STA_READS(srclen) const char *src, size_t srclen)
normalize a string into a buffer
str_filename
CT_NODISCARD CT_STD_API char * str_filename(const char *path, arena_t *arena)
get the filename from a path
Definition: str.c:218
char_is_any_of
CT_NODISCARD CT_PUREFN CT_STD_API bool char_is_any_of(char c, const char *chars)
check if a character is any of a set of characters
Definition: str.c:121
str_ext
CT_NODISCARD CT_STD_API char * str_ext(const char *path, arena_t *arena)
get the last file extension from a path
Definition: str.c:173
str_split
CT_NODISCARD CT_STD_API vector_t * str_split(const char *str, const char *sep, arena_t *arena)
split a string into a vector by a separator
Definition: str.c:557
str_normalize
CT_NODISCARD CT_STD_API char * str_normalize(const char *str, arena_t *arena)
turn a string into a C string literal
Definition: str.c:485
str_join
CT_NODISCARD CT_STD_API char * str_join(const char *sep, const vector_t *parts, arena_t *arena)
join strings
Definition: str.c:274
fmt
CT_NODISCARD STA_FORMAT_STRING const char * fmt
Definition: str.h:68
str_trim_back_inplace
CT_STD_API void str_trim_back_inplace(INOUT_NOTNULL text_t *text, const char *chars)
trim chars from the back of a string in place
str_vsprintf
CT_STD_API size_t str_vsprintf(STA_WRITES(len) char *str, size_t len, const char *fmt, va_list args)
format a string with printf-like syntax
str_directory
CT_NODISCARD CT_STD_API char * str_directory(const char *path, arena_t *arena)
get the directory segment of a path
Definition: str.c:188
str_replace_many
CT_NODISCARD CT_STD_API char * str_replace_many(const char *str, const map_t *repl, arena_t *arena)
replace all instances of a each substring in a string with provided replacement
Definition: str.c:736
str_erase
CT_NODISCARD CT_NOALIAS CT_STD_API char * str_erase(STA_READS(len) char *str, size_t len, const char *letters)
remove all instances of letters from str
str_common_prefix
CT_NODISCARD CT_STD_API const char * str_common_prefix(const vector_t *args, arena_t *arena)
find the longest common prefix of a vector of paths
Definition: str.c:790
str_rfind
CT_PUREFN CT_STD_API size_t str_rfind(const char *str, const char *sub)
find the last instance of a substring in a string
Definition: str.c:884
str_lower
CT_NODISCARD CT_STD_API char * str_lower(const char *str, arena_t *arena)
lowercase an ascii string this allocates a new string in the provided arena
Definition: str.c:952
str_contains
CT_NODISCARD CT_PUREFN CT_STD_API bool str_contains(const char *str, const char *search)
check if a string contains a substring
Definition: str.c:607
STA_PRINTF
CT_NODISCARD STA_PRINTF(2, 3) CT_STD_API text_t text_format(arena_t *arena
format a string
str_basename
CT_NODISCARD CT_STD_API char * str_basename(const char *path, arena_t *arena)
get the filename from a path
Definition: str.c:203
str_vformat
CT_NODISCARD STA_FORMAT_STRING const char CT_NODISCARD CT_STD_API char * str_vformat(arena_t *arena, const char *fmt, va_list args)
format a string
Definition: str.c:110
str_tolower
CT_NODISCARD CT_CONSTFN CT_STD_API char str_tolower(char c)
get the lowercase version of a character
Definition: str.c:970
str_toupper
CT_NODISCARD CT_CONSTFN CT_STD_API char str_toupper(char c)
get the uppercase version of a character
Definition: str.c:981
str_startswith
CT_NODISCARD CT_PUREFN CT_STD_API bool str_startswith(const char *str, const char *prefix)
see if a string starts with a prefix
Definition: str.c:233
text_format
STA_DECL text_t text_format(arena_t *arena, const char *fmt,...)
Definition: str.c:81
str_format
STA_DECL char * str_format(arena_t *arena, const char *fmt,...)
Definition: str.c:97
arena_t
an allocator object
Definition: arena.h:86
map_t
an unordered hash map
Definition: map.h:38
map_t::arena
arena_t * arena
the arena this map allocates from
Definition: map.h:40
text_t
a range of text
Definition: text.h:14
text_view_t
a non-owning view of text
Definition: text.h:24
vector_t
a generic vector of pointers
Definition: vector.c:16