NeoMutt  2024-02-01-35-geee02f
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
string2.h
Go to the documentation of this file.
1
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 <ctype.h>
32#include <stdbool.h>
33#include <stdio.h>
34
35#define STR_COMMAND 8192
36
37#define NONULL(x) ((x) ? (x) : "")
38
39/* Exit values */
40#define S_ERR 127
41#define S_BKG 126
42
43/* this macro must check for (*ch == 0) since isspace(0) has unreliable behavior
44 * on some systems */
45#define SKIPWS(ch) \
46 while (*(ch) && isspace((unsigned char) *(ch))) \
47 ch++;
48
49#define terminate_string(str, strlen, buflen) \
50 (str)[MIN((strlen), (buflen))] = '\0'
51
52#define terminate_buffer(str, strlen) \
53 terminate_string(str, strlen, sizeof(str) - 1)
54
55void mutt_str_adjust(char **ptr);
56int mutt_str_asprintf(char **strp, const char *fmt, ...)
57 __attribute__((__format__(__printf__, 2, 3)));
58int mutt_str_coll(const char *a, const char *b);
59const char *mutt_str_find_word(const char *src);
60const char *mutt_str_getenv(const char *name);
61void mutt_str_hyphenate(char *buf, size_t buflen, const char *str);
62bool mutt_str_is_ascii(const char *str, size_t len);
63size_t mutt_str_len(const char *a);
64char * mutt_str_lower(char *str);
65size_t mutt_str_lws_len(const char *s, size_t n);
66void mutt_str_remove_trailing_ws(char *s);
67char * mutt_str_replace(char **p, const char *s);
68char * mutt_str_sep(char **stringp, const char *delim);
69char * mutt_str_skip_email_wsp(const char *s);
70char * mutt_str_skip_whitespace(const char *p);
71const char *mutt_str_sysexit(int e);
72char * mutt_str_upper(char *str);
73
74/* case-sensitive flavours */
75char * mutt_str_cat(char *buf, size_t buflen, const char *s);
76int mutt_str_cmp(const char *a, const char *b);
77size_t mutt_str_copy(char *dest, const char *src, size_t dsize);
78char * mutt_str_dup(const char *str);
79bool mutt_str_equal(const char *a, const char *b);
80size_t mutt_str_startswith(const char *str, const char *prefix);
81
82/* case-sensitive, length-bound flavours */
83char * mutt_strn_cat(char *dest, size_t l, const char *s, size_t sl);
84char * mutt_strn_copy(char *dest, const char *src, size_t len, size_t dsize);
85char * mutt_strn_dup(const char *begin, size_t l);
86bool mutt_strn_equal(const char *a, const char *b, size_t num);
87
88/* case-insensitive flavours */
89int mutt_istr_cmp(const char *a, const char *b);
90bool mutt_istr_equal(const char *a, const char *b);
91const char *mutt_istr_find(const char *haystack, const char *needle);
92int mutt_istr_remall(char *str, const char *target);
93size_t mutt_istr_startswith(const char *str, const char *prefix);
94
95/* case-insensitive, length-bound flavours */
96int mutt_istrn_cmp(const char *a, const char *b, size_t num);
97bool mutt_istrn_equal(const char *a, const char *b, size_t num);
98const char *mutt_istrn_rfind(const char *haystack, size_t haystack_length, const char *needle);
99
105static inline bool mutt_str_is_email_wsp(char c)
106{
107 return (c == ' ') || (c == '\t') || (c == '\r') || (c == '\n');
108}
109
110#endif /* MUTT_MUTT_STRING2_H */
const char * mutt_str_sysexit(int e)
Return a string matching an error code.
Definition: string.c:169
int mutt_str_cmp(const char *a, const char *b)
Compare two strings, safely.
Definition: string.c:448
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:488
void mutt_str_remove_trailing_ws(char *s)
Trim trailing whitespace from a string.
Definition: string.c:614
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:721
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
int mutt_str_asprintf(char **strp, const char *fmt,...) __attribute__((__format__(__printf__
char * mutt_str_upper(char *str)
Convert all characters in the string to uppercase.
Definition: string.c:385
char * mutt_str_lower(char *str)
Convert all characters in the string to lowercase.
Definition: string.c:362
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition: string.c:657
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:518
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:677
bool mutt_str_is_ascii(const char *str, size_t len)
Is a string ASCII (7-bit)?
Definition: string.c:732
int mutt_istr_cmp(const char *a, const char *b)
Compare two strings ignoring case, safely.
Definition: string.c:461
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:709
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:474
char * mutt_strn_dup(const char *begin, size_t l)
Duplicate a sub-string.
Definition: string.c:429
int int mutt_str_coll(const char *a, const char *b)
Collate two strings (compare using locale), safely.
Definition: string.c:558
char * mutt_strn_cat(char *dest, size_t l, const char *s, size_t sl)
Concatenate two strings.
Definition: string.c:297
const char * mutt_str_find_word(const char *src)
Find the end of a word (non-space)
Definition: string.c:755
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:409
int mutt_istr_remall(char *str, const char *target)
Remove all occurrences of substring, ignoring case.
Definition: string.c:794
const char * mutt_str_getenv(const char *name)
Get an environment variable.
Definition: string.c:775
const char * mutt_istr_find(const char *haystack, const char *needle)
Find first occurrence of string (ignoring case)
Definition: string.c:570
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:230
void mutt_str_hyphenate(char *buf, size_t buflen, const char *str)
Hyphenate a snake-case string.
Definition: string.c:898
char * mutt_str_skip_whitespace(const char *p)
Find the first non-whitespace character in a string.
Definition: string.c:600
void mutt_str_adjust(char **ptr)
Shrink-to-fit a string.
Definition: string.c:348
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:545
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:630
static bool mutt_str_is_email_wsp(char c)
Is this a whitespace character (for an email header)
Definition: string2.h:105
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:242
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:502
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:329
char * mutt_str_sep(char **stringp, const char *delim)
Find first occurrence of any of delim characters in *stringp.
Definition: string.c:186
char * mutt_str_cat(char *buf, size_t buflen, const char *s)
Concatenate two strings.
Definition: string.c:268