1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef LABWC_STRING_HELPERS_H
#define LABWC_STRING_HELPERS_H
#include <stdbool.h>
/**
* string_null_or_empty() - Check if string is NULL or empty
* @s: string to check
*/
bool string_null_or_empty(const char *s);
/**
* str_space_only - Check if the string only contains white-space characters
* @s: string to check
*/
bool str_space_only(const char *s);
/**
* string_strip - strip white space left and right
* Note: this function does a left skip, so the returning pointer cannot be
* used to free any allocated memory
*/
char *string_strip(char *s);
/**
* string_truncate_at_pattern - remove pattern and everything after it
* @buf: pointer to buffer
* @pattern: string to remove
*/
void string_truncate_at_pattern(char *buf, const char *pattern);
/**
* strdup_printf - allocate and write to buffer in printf format
* @fmt: printf-style format.
*
* Similar to the standard C sprintf() function but safer as it calculates the
* maximum space required and allocates memory to hold the output.
* The user must free the returned string.
* Returns NULL on error.
*/
char *strdup_printf(const char *fmt, ...);
/**
* str_join - format and join an array of strings with a separator
* @parts: NULL-terminated array of string parts to be joined
* @fmt: printf-style format string applied to each part
* @sep: separator inserted between parts when joining
*
* A new string is allocated to hold the joined result. The user must free the
* returned string. Returns NULL on error.
*
* Each part of the array is converted via the equivalent of sprintf(output,
* fmt, part), so fmt should include a single "%s" format specification. If fmt
* is NULL, a default "%s" will be used to copy each part verbatim.
*
* The separator is arbitrary. When the separator is NULL, a single space will
* be used.
*/
char *str_join(const char *const parts[], const char *fmt, const char *sep);
/**
* str_endswith - indicate whether a string ends with a given suffix
* @string: string to test
* @suffix: suffix to expect in string
*
* If suffix is "" or NULL, this method always returns true; otherwise, this
* method returns true if and only if the full suffix exists at the end of the
* string.
*/
bool str_endswith(const char *const string, const char *const suffix);
/**
* str_endswith_ignore_case - indicate whether a string ends with a given suffix
* @string: string to test
* @suffix: suffix to expect in string
*
* If suffix is "" or NULL, this method always returns true; otherwise, this
* method returns true if and only if the full suffix exists at the end of the
* string.
*/
bool str_endswith_ignore_case(const char *const string, const char *const suffix);
/**
* str_starts_with - indicate whether a string starts with a given character
* @string: string to test
* @needle: character to expect in string
* @ignore_chars: characters to ignore at start such as space and "\t"
*/
bool str_starts_with(const char *s, char needle, const char *ignore_chars);
/**
* str_equal - indicate whether two strings are identical
* @a: first string to compare
* @b: second string to compare
*
* If both strings are NULL, returns true.
*/
bool str_equal(const char *a, const char *b);
#endif /* LABWC_STRING_HELPERS_H */
|
