NeoMutt  2025-09-05-43-g177ed6
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
string2.h
Go to the documentation of this file.
1
23
24/* @note This file is called string2.h so that other files can safely
25 * #include <string.h>
26 */
27
28#ifndef MUTT_MUTT_STRING2_H
29#define MUTT_MUTT_STRING2_H
30
31#include <stdbool.h>
32#include <stdio.h>
33#include "array.h"
34#include "memory.h"
35
37ARRAY_HEAD(StringArray, const char *);
38
39void string_array_clear(struct StringArray *arr);
40
41#define STR_COMMAND 8192
42
43#define NONULL(x) ((x) ? (x) : "")
44
45/* Exit values */
46#define S_ERR 127
47#define S_BKG 126
48
49/* this macro must check for (*ch == 0) since isspace(0) has unreliable behavior
50 * on some systems */
51#define SKIPWS(ch) \
52 while (*(ch) && mutt_isspace(*(ch))) \
53 ch++;
54
55#define terminate_string(str, strlen, buflen) \
56 (str)[MIN((strlen), (buflen))] = '\0'
57
58#define terminate_buffer(str, strlen) \
59 terminate_string(str, strlen, sizeof(str) - 1)
60
61void mutt_str_adjust(char **ptr);
62int mutt_str_asprintf(char **strp, const char *fmt, ...)
63 __attribute__((__format__(__printf__, 2, 3)));
64int mutt_str_coll(const char *a, const char *b);
65const char *mutt_str_find_word(const char *src);
66const char *mutt_str_getenv(const char *name);
67void mutt_str_hyphenate(char *buf, size_t buflen, const char *str);
68bool mutt_str_is_ascii(const char *str, size_t len);
69size_t mutt_str_len(const char *a);
70char * mutt_str_lower(char *str);
71size_t mutt_str_lws_len(const char *s, size_t n);
72void mutt_str_remove_trailing_ws(char *s);
73char * mutt_str_replace(char **p, const char *s);
74char * mutt_str_sep(char **stringp, const char *delim);
75char * mutt_str_skip_email_wsp(const char *s);
76char * mutt_str_skip_whitespace(const char *p);
77const char *mutt_str_sysexit(int e);
78char * mutt_str_upper(char *str);
79
80/* case-sensitive flavours */
81int mutt_str_cmp(const char *a, const char *b);
82size_t mutt_str_copy(char *dest, const char *src, size_t dsize);
83char * mutt_str_dup(const char *str);
84bool mutt_str_equal(const char *a, const char *b);
85size_t mutt_str_startswith(const char *str, const char *prefix);
86
87/* case-sensitive, length-bound flavours */
88char * mutt_strn_copy(char *dest, const char *src, size_t len, size_t dsize);
89char * mutt_strn_dup(const char *begin, size_t l);
90bool mutt_strn_equal(const char *a, const char *b, size_t num);
91
92/* case-insensitive flavours */
93int mutt_istr_cmp(const char *a, const char *b);
94bool mutt_istr_equal(const char *a, const char *b);
95const char *mutt_istr_find(const char *haystack, const char *needle);
96int mutt_istr_remall(char *str, const char *target);
97size_t mutt_istr_startswith(const char *str, const char *prefix);
98int mutt_str_inbox_cmp(const char *a, const char *b);
99
100/* case-insensitive, length-bound flavours */
101int mutt_istrn_cmp(const char *a, const char *b, size_t num);
102bool mutt_istrn_equal(const char *a, const char *b, size_t num);
103const char *mutt_istrn_rfind(const char *haystack, size_t haystack_length, const char *needle);
104
110static inline bool mutt_str_is_email_wsp(char c)
111{
112 return (c == ' ') || (c == '\t') || (c == '\r') || (c == '\n');
113}
114
115#endif /* MUTT_MUTT_STRING2_H */
Linear Array data structure.
#define ARRAY_HEAD(name, type)
Define a named struct for arrays of elements of a certain type.
Definition array.h:47
int mutt_str_inbox_cmp(const char *a, const char *b)
Do two folders share the same path and one is an inbox -.
Definition string.c:887
Memory management wrappers.
char * mutt_strn_dup(const char *begin, size_t len)
Duplicate a sub-string.
Definition string.c:382
int mutt_str_cmp(const char *a, const char *b)
Compare two strings, safely.
Definition string.c:401
int mutt_istrn_cmp(const char *a, const char *b, size_t num)
Compare two strings ignoring case (to a maximum), safely.
Definition string.c:441
void mutt_str_remove_trailing_ws(char *s)
Trim trailing whitespace from a string.
Definition string.c:565
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition string.c:672
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:255
char * mutt_str_upper(char *str)
Convert all characters in the string to uppercase.
Definition string.c:338
char * mutt_str_lower(char *str)
Convert all characters in the string to lowercase.
Definition string.c:315
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition string.c:608
const char * mutt_istrn_rfind(const char *haystack, size_t haystack_length, const char *needle)
Find last instance of a substring, ignoring case.
Definition string.c:471
size_t mutt_str_lws_len(const char *s, size_t n)
Measure the linear-white-space at the beginning of a string.
Definition string.c:628
bool mutt_str_is_ascii(const char *str, size_t len)
Is a string ASCII (7-bit)?
Definition string.c:683
int mutt_istr_cmp(const char *a, const char *b)
Compare two strings ignoring case, safely.
Definition string.c:414
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:660
bool mutt_strn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings (to a maximum), safely.
Definition string.c:427
const char * mutt_str_find_word(const char *src)
Find the end of a word (non-space)
Definition string.c:706
char * mutt_strn_copy(char *dest, const char *src, size_t len, size_t dsize)
Copy a sub-string into a buffer.
Definition string.c:362
int mutt_istr_remall(char *str, const char *target)
Remove all occurrences of substring, ignoring case.
Definition string.c:745
const char * mutt_str_getenv(const char *name)
Get an environment variable.
Definition string.c:726
const char * mutt_istr_find(const char *haystack, const char *needle)
Find first occurrence of string (ignoring case)
Definition string.c:523
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition string.c:232
void mutt_str_hyphenate(char *buf, size_t buflen, const char *str)
Hyphenate a snake-case string.
Definition string.c:849
char * mutt_str_skip_whitespace(const char *p)
Find the first non-whitespace character in a string.
Definition string.c:551
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition string.c:498
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition string.c:581
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition string.c:244
bool mutt_istrn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings ignoring case (to a maximum), safely.
Definition string.c:455
const char * mutt_str_sysexit(int err_num)
Return a string matching an error code.
Definition string.c:171
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition string.c:282
int mutt_str_coll(const char *a, const char *b)
Collate two strings (compare using locale), safely.
Definition string.c:511
char * mutt_str_sep(char **stringp, const char *delim)
Find first occurrence of any of delim characters in *stringp.
Definition string.c:188
int mutt_str_asprintf(char **strp, const char *fmt,...) __attribute__((__format__(__printf__
void mutt_str_adjust(char **ptr)
Shrink-to-fit a string.
Definition string.c:301
void string_array_clear(struct StringArray *arr)
Free all memory of a StringArray.
Definition string.c:931
static bool mutt_str_is_email_wsp(char c)
Is this a whitespace character (for an email header)
Definition string2.h:110