string.c File Reference

#include "config.h"
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include "exit.h"
#include "logging.h"
#include "memory.h"
#include "message.h"
#include "string2.h"

Include dependency graph for string.c:

Go to the source code of this file.

Data Structures
struct	SysExits
	Lookup table of error messages. More...

Functions
const char *	mutt_str_sysexit (int err_num)
	Return a string matching an error code. More...
static size_t	startswith (const char *str, const char *prefix, bool match_case)
	Check whether a string starts with a prefix. More...
size_t	mutt_str_startswith (const char *str, const char *prefix)
	Check whether a string starts with a prefix. More...
size_t	mutt_istr_startswith (const char *str, const char *prefix)
	Check whether a string starts with a prefix, ignoring case. More...
int	mutt_str_atol (const char *str, long *dst)
	Convert ASCII string to a long. More...
int	mutt_str_atos (const char *str, short *dst)
	Convert ASCII string to a short. More...
int	mutt_str_atoi (const char *str, int *dst)
	Convert ASCII string to an integer. More...
int	mutt_str_atoui (const char *str, unsigned int *dst)
	Convert ASCII string to an unsigned integer. More...
int	mutt_str_atoul (const char *str, unsigned long *dst)
	Convert ASCII string to an unsigned long. More...
int	mutt_str_atoull (const char *str, unsigned long long *dst)
	Convert ASCII string to an unsigned long long. More...
char *	mutt_str_dup (const char *str)
	Copy a string, safely. More...
char *	mutt_str_cat (char *buf, size_t buflen, const char *s)
	Concatenate two strings. More...
char *	mutt_strn_cat (char *d, size_t l, const char *s, size_t sl)
	Concatenate two strings. More...
char *	mutt_str_replace (char **p, const char *s)
	Replace one string with another. More...
void	mutt_str_append_item (char **str, const char *item, char sep)
	Add string to another separated by sep. More...
void	mutt_str_adjust (char **ptr)
	Shrink-to-fit a string. More...
char *	mutt_str_lower (char *str)
	Convert all characters in the string to lowercase. More...
char *	mutt_strn_copy (char *dest, const char *src, size_t len, size_t dsize)
	Copy a sub-string into a buffer. More...
char *	mutt_strn_dup (const char *begin, size_t len)
	Duplicate a sub-string. More...
int	mutt_str_cmp (const char *a, const char *b)
	Compare two strings, safely. More...
int	mutt_istr_cmp (const char *a, const char *b)
	Compare two strings ignoring case, safely. More...
bool	mutt_strn_equal (const char *a, const char *b, size_t num)
	Check for equality of two strings (to a maximum), safely. More...
int	mutt_istrn_cmp (const char *a, const char *b, size_t num)
	Compare two strings ignoring case (to a maximum), safely. More...
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. More...
size_t	mutt_str_len (const char *a)
	Calculate the length of a string, safely. More...
int	mutt_str_coll (const char *a, const char *b)
	Collate two strings (compare using locale), safely. More...
const char *	mutt_istr_find (const char *haystack, const char *needle)
	Find first occurrence of string (ignoring case) More...
char *	mutt_str_skip_whitespace (const char *p)
	Find the first non-whitespace character in a string. More...
void	mutt_str_remove_trailing_ws (char *s)
	Trim trailing whitespace from a string. More...
size_t	mutt_str_copy (char *dest, const char *src, size_t dsize)
	Copy a string into a buffer (guaranteeing NUL-termination) More...
char *	mutt_str_skip_email_wsp (const char *s)
	Skip over whitespace as defined by RFC5322. More...
bool	mutt_str_is_email_wsp (char c)
	Is this a whitespace character (for an email header) More...
size_t	mutt_str_lws_len (const char *s, size_t n)
	Measure the linear-white-space at the beginning of a string. More...
size_t	mutt_str_lws_rlen (const char *s, size_t n)
	Measure the linear-white-space at the end of a string. More...
void	mutt_str_dequote_comment (char *str)
	Un-escape characters in an email address comment. More...
bool	mutt_str_equal (const char *a, const char *b)
	Compare two strings. More...
bool	mutt_istr_equal (const char *a, const char *b)
	Compare two strings, ignoring case. More...
const char *	mutt_str_next_word (const char *s)
	Find the next word in a string. More...
const char *	mutt_strn_rfind (const char *haystack, size_t haystack_length, const char *needle)
	Find last instance of a substring. More...
bool	mutt_str_is_ascii (const char *str, size_t len)
	Is a string ASCII (7-bit)? More...
const char *	mutt_str_find_word (const char *src)
	Find the end of a word (non-space) More...
const char *	mutt_str_getenv (const char *name)
	Get an environment variable. More...
bool	mutt_str_inline_replace (char *buf, size_t buflen, size_t xlen, const char *rstr)
	Replace the beginning of a string. More...
int	mutt_istr_remall (char *str, const char *target)
	Remove all occurrences of substring, ignoring case. More...
int	mutt_str_asprintf (char **strp, const char *fmt,...)

Variables
static const struct SysExits	sysexits []

Detailed Description

String manipulation functions

Authors

• Richard Russon
• Pietro Cerutti

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file string.c.

Function Documentation

mutt_str_sysexit()

const char* mutt_str_sysexit

(

int

err_num

)

Return a string matching an error code.

Parameters

err_num

Error code, e.g. EX_NOPERM

Return values

ptr	string representing the error code

Definition at line 112 of file string.c.

{
  for (size_t i = 0; i < mutt_array_size(sysexits); i++)
  {
    if (err_num == sysexits[i].err_num)
      return sysexits[i].err_str;
  }
 
  return NULL;
}

Here is the caller graph for this function:

startswith()

static size_t startswith ( const char *  str, const char *  prefix, bool  match_case  )

static

Check whether a string starts with a prefix.

Parameters

str	String to check
prefix	Prefix to match
match_case	True if case needs to match

Return values

num	Length of prefix if str starts with prefix
0	if str does not start with prefix

Definition at line 131 of file string.c.

{
  if (!str || (str[0] == '\0') || !prefix || (prefix[0] == '\0'))
  {
    return 0;
  }
 
  const char *saved_prefix = prefix;
  for (; *str && *prefix; str++, prefix++)
  {
    if (*str == *prefix)
      continue;
 
    if (!match_case && tolower(*str) == tolower(*prefix))
      continue;
 
    return 0;
  }
 
  return (*prefix == '\0') ? (prefix - saved_prefix) : 0;
}

Here is the caller graph for this function:

mutt_str_startswith()

size_t mutt_str_startswith	(	const char *	str,
		const char *	prefix
	)

Check whether a string starts with a prefix.

Parameters

str	String to check
prefix	Prefix to match

Return values

num	Length of prefix if str starts with prefix
0	if str does not start with prefix

Definition at line 160 of file string.c.

{
  return startswith(str, prefix, true);
}

Here is the call graph for this function:

mutt_istr_startswith()

size_t mutt_istr_startswith	(	const char *	str,
		const char *	prefix
	)

Check whether a string starts with a prefix, ignoring case.

Parameters

str	String to check
prefix	Prefix to match

Return values

num	Length of prefix if str starts with prefix
0	if str does not start with prefix

Definition at line 172 of file string.c.

{
  return startswith(str, prefix, false);
}

Here is the call graph for this function:

mutt_str_atol()

int mutt_str_atol	(	const char *	str,
		long *	dst
	)

Convert ASCII string to a long.

Parameters

[in]	str	String to read
[out]	dst	Store the result

Return values

0	Success
-1	Error
-2	Overflow

This is a strtol() wrapper with range checking. errno may be set on error, e.g. ERANGE

Definition at line 188 of file string.c.

{
  if (dst)
    *dst = 0;
 
  if (!str || (*str == '\0')) /* no input: 0 */
    return 0;
 
  char *e = NULL;
  errno = 0;
 
  long res = strtol(str, &e, 10);
  if (dst)
    *dst = res;
  if (((res == LONG_MIN) || (res == LONG_MAX)) && (errno == ERANGE))
    return -2;
  if (e && (*e != '\0'))
    return -1;
  return 0;
}

Here is the caller graph for this function:

mutt_str_atos()

int mutt_str_atos	(	const char *	str,
		short *	dst
	)

Convert ASCII string to a short.

Parameters

[in]	str	String to read
[out]	dst	Store the result

Return values

0	Success
-1	Error
-2	Error, overflow

This is a strtol() wrapper with range checking. If dst is NULL, the string will be tested only (without conversion).

errno may be set on error, e.g. ERANGE

Definition at line 222 of file string.c.

{
  if (dst)
    *dst = 0;
 
  long res = 0;
  int rc = mutt_str_atol(str, &res);
  if (rc < 0)
    return rc;
  if ((res < SHRT_MIN) || (res > SHRT_MAX))
    return -2;
 
  if (dst)
    *dst = (short) res;
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atoi()

int mutt_str_atoi	(	const char *	str,
		int *	dst
	)

Convert ASCII string to an integer.

Parameters

[in]	str	String to read
[out]	dst	Store the result

Return values

0	Success
-1	Error
-2	Error, overflow

This is a strtol() wrapper with range checking. If dst is NULL, the string will be tested only (without conversion). errno may be set on error, e.g. ERANGE

Definition at line 252 of file string.c.

{
  if (dst)
    *dst = 0;
 
  long res = 0;
  int rc = mutt_str_atol(str, &res);
  if (rc < 0)
    return rc;
  if ((res < INT_MIN) || (res > INT_MAX))
    return -2;
 
  if (dst)
    *dst = (int) res;
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atoui()

int mutt_str_atoui	(	const char *	str,
		unsigned int *	dst
	)

Convert ASCII string to an unsigned integer.

Parameters

[in]	str	String to read
[out]	dst	Store the result

Return values

1	Successful conversion, with trailing characters
0	Successful conversion
-1	Invalid input
-2	Input out of range

Note

This function's return value differs from the other functions. They return -1 if there is input beyond the number.

Definition at line 282 of file string.c.

{
  if (dst)
    *dst = 0;
 
  unsigned long res = 0;
  int rc = mutt_str_atoul(str, &res);
  if (rc < 0)
    return rc;
  if (res > UINT_MAX)
    return -2;
 
  if (dst)
    *dst = (unsigned int) res;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atoul()

int mutt_str_atoul	(	const char *	str,
		unsigned long *	dst
	)

Convert ASCII string to an unsigned long.

Parameters

[in]	str	String to read
[out]	dst	Store the result

Return values

1	Successful conversion, with trailing characters
0	Successful conversion
-1	Invalid input

Note

This function's return value differs from the other functions. They return -1 if there is input beyond the number.

Definition at line 311 of file string.c.

{
  if (dst)
    *dst = 0;
 
  if (!str || (*str == '\0')) /* no input: 0 */
    return 0;
 
  char *e = NULL;
  errno = 0;
 
  unsigned long res = strtoul(str, &e, 10);
  if (dst)
    *dst = res;
  if ((res == ULONG_MAX) && (errno == ERANGE))
    return -1;
  if (e && (*e != '\0'))
    return 1;
  return 0;
}

Here is the caller graph for this function:

mutt_str_atoull()

int mutt_str_atoull	(	const char *	str,
		unsigned long long *	dst
	)

Convert ASCII string to an unsigned long long.

Parameters

[in]	str	String to read
[out]	dst	Store the result

Return values

1	Successful conversion, with trailing characters
0	Successful conversion
-1	Invalid input

Note

This function's return value differs from the other functions. They return -1 if there is input beyond the number.

Definition at line 343 of file string.c.

{
  if (dst)
    *dst = 0;
 
  if (!str || (*str == '\0')) /* no input: 0 */
    return 0;
 
  char *e = NULL;
  errno = 0;
 
  unsigned long long res = strtoull(str, &e, 10);
  if (dst)
    *dst = res;
  if ((res == ULLONG_MAX) && (errno == ERANGE))
    return -1;
  if (e && (*e != '\0'))
    return 1;
  return 0;
}

Here is the caller graph for this function:

mutt_str_dup()

char* mutt_str_dup

(

const char *

str

)

Copy a string, safely.

Parameters

str	String to copy

Return values

ptr	Copy of the string
NULL	if str was NULL or empty

Definition at line 370 of file string.c.

{
  if (!str || (*str == '\0'))
    return NULL;
 
  return strdup(str);
}

mutt_str_cat()

char* mutt_str_cat	(	char *	buf,
		size_t	buflen,
		const char *	s
	)

Concatenate two strings.

Parameters

buf	Buffer containing source string
buflen	Length of buffer
s	String to add

Return values

ptr	Start of the buffer

Definition at line 385 of file string.c.

{
  if (!buf || (buflen == 0) || !s)
    return buf;
 
  char *p = buf;
 
  buflen--; /* Space for the trailing '\0'. */
 
  for (; (*buf != '\0') && buflen; buflen--)
    buf++;
  for (; *s && buflen; buflen--)
    *buf++ = *s++;
 
  *buf = '\0';
 
  return p;
}

Here is the caller graph for this function:

mutt_strn_cat()

char* mutt_strn_cat	(	char *	d,
		size_t	l,
		const char *	s,
		size_t	sl
	)

Concatenate two strings.

Parameters

d	Buffer containing source string
l	Length of buffer
s	String to add
sl	Maximum amount of string to add

Return values

ptr	Start of joined string

Add a string to a maximum of sl bytes.

Definition at line 414 of file string.c.

{
  if (!d || (l == 0) || !s)
    return d;
 
  char *p = d;
 
  l--; /* Space for the trailing '\0'. */
 
  for (; *d && l; l--)
    d++;
  for (; *s && l && sl; l--, sl--)
    *d++ = *s++;
 
  *d = '\0';
 
  return p;
}

Here is the caller graph for this function:

mutt_str_replace()

char* mutt_str_replace	(	char **	p,
		const char *	s
	)

Replace one string with another.

Parameters

[out]	p	String to replace
[in]	s	New string

Return values

ptr	Replaced string

This function free()s the original string, strdup()s the new string and overwrites the pointer to the first string.

This function alters the pointer of the caller.

Note

Free *p afterwards to handle the case that *p and s reference the same memory

Definition at line 446 of file string.c.

{
  if (!p)
    return NULL;
  const char *tmp = *p;
  *p = mutt_str_dup(s);
  FREE(&tmp);
  return *p;
}

Here is the call graph for this function:

mutt_str_append_item()

void mutt_str_append_item	(	char **	str,
		const char *	item,
		char	sep
	)

Add string to another separated by sep.

Parameters

[out]	str	String appended
[in]	item	String to append
[in]	sep	separator between string item

Append a string to another, separating them by sep if needed.

This function alters the pointer of the caller.

Definition at line 466 of file string.c.

{
  if (!str || !item)
    return;
 
  size_t sz = mutt_str_len(item);
  size_t ssz = mutt_str_len(*str);
 
  mutt_mem_realloc(str, ssz + (((ssz > 0) && (sep != '\0')) ? 1 : 0) + sz + 1);
  char *p = *str + ssz;
  if ((ssz > 0) && (sep != '\0'))
    *p++ = sep;
  memcpy(p, item, sz + 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_adjust()

void mutt_str_adjust

(

char **

ptr

)

Shrink-to-fit a string.

Parameters

[out]

ptr

String to alter

Take a string which is allocated on the heap, find its length and reallocate the memory to be exactly the right size.

This function alters the pointer of the caller.

Definition at line 490 of file string.c.

{
  if (!ptr || !*ptr)
    return;
  mutt_mem_realloc(ptr, strlen(*ptr) + 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_lower()

char* mutt_str_lower

(

char *

str

)

Convert all characters in the string to lowercase.

Parameters

str	String to lowercase

Return values

ptr	Lowercase string

The string is transformed in place.

Definition at line 504 of file string.c.

{
  if (!str)
    return NULL;
 
  char *p = str;
 
  while (*p)
  {
    *p = tolower((unsigned char) *p);
    p++;
  }
 
  return str;
}

Here is the caller graph for this function:

mutt_strn_copy()

char* mutt_strn_copy	(	char *	dest,
		const char *	src,
		size_t	len,
		size_t	dsize
	)

Copy a sub-string into a buffer.

Parameters

dest	Buffer for the result
src	Start of the string to copy
len	Length of the string to copy
dsize	Destination buffer size

Return values

ptr	Destination buffer

Definition at line 528 of file string.c.

{
  if (!src || !dest || (len == 0) || (dsize == 0))
    return dest;
 
  if (len > (dsize - 1))
    len = dsize - 1;
  memcpy(dest, src, len);
  dest[len] = '\0';
  return dest;
}

Here is the caller graph for this function:

mutt_strn_dup()

char* mutt_strn_dup	(	const char *	begin,
		size_t	len
	)

Duplicate a sub-string.

Parameters

begin	Start of the string to copy
len	Length of string to copy

Return values

ptr	New string

The caller must free the returned string.

Definition at line 548 of file string.c.

{
  if (!begin)
    return NULL;
 
  char *p = mutt_mem_malloc(len + 1);
  memcpy(p, begin, len);
  p[len] = '\0';
  return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_cmp()

int mutt_str_cmp	(	const char *	a,
		const char *	b
	)

Compare two strings, safely.

Parameters

a	First string to compare
b	Second string to compare

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 567 of file string.c.

{
  return strcmp(NONULL(a), NONULL(b));
}

Here is the caller graph for this function:

mutt_istr_cmp()

int mutt_istr_cmp	(	const char *	a,
		const char *	b
	)

Compare two strings ignoring case, safely.

Parameters

a	First string to compare
b	Second string to compare

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 580 of file string.c.

{
  return strcasecmp(NONULL(a), NONULL(b));
}

Here is the caller graph for this function:

mutt_strn_equal()

bool mutt_strn_equal	(	const char *	a,
		const char *	b,
		size_t	num
	)

Check for equality of two strings (to a maximum), safely.

Parameters

a	First string to compare
b	Second string to compare
num	Maximum number of bytes to compare

Return values

true	First num chars of both strings are equal
false	First num chars of both strings not equal

Definition at line 593 of file string.c.

{
  return strncmp(NONULL(a), NONULL(b), num) == 0;
}

Here is the caller graph for this function:

mutt_istrn_cmp()

int mutt_istrn_cmp	(	const char *	a,
		const char *	b,
		size_t	num
	)

Compare two strings ignoring case (to a maximum), safely.

Parameters

a	First string to compare
b	Second string to compare
num	Maximum number of bytes to compare

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 607 of file string.c.

{
  return strncasecmp(NONULL(a), NONULL(b), num);
}

Here is the caller graph for this function:

mutt_istrn_equal()

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.

Parameters

a	First string to compare
b	Second string to compare
num	Maximum number of bytes to compare

Return values

-1	a precedes b
true	First num chars of both strings are equal, ignoring case
false	First num chars of both strings not equal, ignoring case

Definition at line 621 of file string.c.

{
  return strncasecmp(NONULL(a), NONULL(b), num) == 0;
}

Here is the caller graph for this function:

mutt_str_len()

size_t mutt_str_len

(

const char *

a

)

Calculate the length of a string, safely.

Parameters

a	String to measure

Return values

num	Length in bytes

Definition at line 631 of file string.c.

{
  return a ? strlen(a) : 0;
}

mutt_str_coll()

int mutt_str_coll	(	const char *	a,
		const char *	b
	)

Collate two strings (compare using locale), safely.

Parameters

a	First string to compare
b	Second string to compare

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 644 of file string.c.

{
  return strcoll(NONULL(a), NONULL(b));
}

Here is the caller graph for this function:

mutt_istr_find()

const char* mutt_istr_find	(	const char *	haystack,
		const char *	needle
	)

Find first occurrence of string (ignoring case)

Parameters

haystack	String to search through
needle	String to find

Return values

ptr	First match of the search string
NULL	No match, or an error

Definition at line 656 of file string.c.

{
  if (!haystack)
    return NULL;
  if (!needle)
    return haystack;
 
  const char *p = NULL, *q = NULL;
 
  while (*(p = haystack))
  {
    for (q = needle;
         *p && *q && (tolower((unsigned char) *p) == tolower((unsigned char) *q));
         p++, q++)
    {
    }
    if ((*q == '\0'))
      return haystack;
    haystack++;
  }
  return NULL;
}

Here is the caller graph for this function:

mutt_str_skip_whitespace()

char* mutt_str_skip_whitespace

(

const char *

p

)

Find the first non-whitespace character in a string.

Parameters

p	String to search

Return values

ptr	First non-whitespace character Terminating NUL character, if the string was entirely whitespace

Definition at line 686 of file string.c.

{
  if (!p)
    return NULL;
  SKIPWS(p);
  return (char *) p;
}

Here is the caller graph for this function:

mutt_str_remove_trailing_ws()

void mutt_str_remove_trailing_ws

(

char *

s

)

Trim trailing whitespace from a string.

Parameters

s	String to trim

The string is modified in place.

Definition at line 700 of file string.c.

{
  if (!s)
    return;
 
  for (char *p = s + mutt_str_len(s) - 1; (p >= s) && IS_SPACE(*p); p--)
    *p = '\0';
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_copy()

size_t mutt_str_copy	(	char *	dest,
		const char *	src,
		size_t	dsize
	)

Copy a string into a buffer (guaranteeing NUL-termination)

Parameters

dest	Buffer for the result
src	String to copy
dsize	Destination buffer size

Return values

num	Destination string length

Definition at line 716 of file string.c.

{
  if (!dest || (dsize == 0))
    return 0;
  if (!src)
  {
    dest[0] = '\0';
    return 0;
  }
 
  char *dest0 = dest;
  while ((--dsize > 0) && (*src != '\0'))
    *dest++ = *src++;
 
  *dest = '\0';
  return dest - dest0;
}

mutt_str_skip_email_wsp()

char* mutt_str_skip_email_wsp

(

const char *

s

)

Skip over whitespace as defined by RFC5322.

Parameters

s	String to search

Return values

ptr	First non-whitespace character Terminating NUL character, if the string was entirely whitespace

This is used primarily for parsing header fields.

Definition at line 743 of file string.c.

{
  if (!s)
    return NULL;
 
  for (; mutt_str_is_email_wsp(*s); s++)
    ; // Do nothing
 
  return (char *) s;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_is_email_wsp()

bool mutt_str_is_email_wsp

(

char

c

)

Is this a whitespace character (for an email header)

Parameters

c	Character to test

Return values

true	It is whitespcae

Definition at line 759 of file string.c.

{
  return c && strchr(" \t\r\n", c);
}

Here is the caller graph for this function:

mutt_str_lws_len()

size_t mutt_str_lws_len	(	const char *	s,
		size_t	n
	)

Measure the linear-white-space at the beginning of a string.

Parameters

s	String to check
n	Maximum number of characters to check

Return values

num	Count of whitespace characters

Count the number of whitespace characters at the beginning of a string. They can be <space>, <tab>, <cr> or <lf>.

Definition at line 773 of file string.c.

{
  if (!s)
    return 0;
 
  const char *p = s;
  size_t len = n;
 
  if (n == 0)
    return 0;
 
  for (; p < (s + n); p++)
  {
    if (!strchr(" \t\r\n", *p))
    {
      len = p - s;
      break;
    }
  }
 
  if ((len != 0) && strchr("\r\n", *(p - 1))) /* LWS doesn't end with CRLF */
    len = 0;
  return len;
}

Here is the caller graph for this function:

mutt_str_lws_rlen()

size_t mutt_str_lws_rlen	(	const char *	s,
		size_t	n
	)

Measure the linear-white-space at the end of a string.

Parameters

s	String to check
n	Maximum number of characters to check

Return values

num	Count of whitespace characters

Count the number of whitespace characters at the end of a string. They can be <space>, <tab>, <cr> or <lf>.

Definition at line 807 of file string.c.

{
  if (!s)
    return 0;
 
  const char *p = s + n - 1;
  size_t len = n;
 
  if (n == 0)
    return 0;
 
  if (strchr("\r\n", *p)) /* LWS doesn't end with CRLF */
    return 0;
 
  for (; p >= s; p--)
  {
    if (!strchr(" \t\r\n", *p))
    {
      len = s + n - 1 - p;
      break;
    }
  }
 
  return len;
}

mutt_str_dequote_comment()

void mutt_str_dequote_comment

(

char *

str

)

Un-escape characters in an email address comment.

Parameters

str	String to be un-escaped

Note

The string is changed in-place

Definition at line 839 of file string.c.

{
  if (!str)
    return;
 
  char *w = str;
 
  for (; *str; str++)
  {
    if (*str == '\\')
    {
      if (!*++str)
        break; /* error? */
      *w++ = *str;
    }
    else if (*str != '\"')
    {
      if (w != str)
        *w = *str;
      w++;
    }
  }
  *w = '\0';
}

Here is the caller graph for this function:

mutt_str_equal()

bool mutt_str_equal	(	const char *	a,
		const char *	b
	)

Compare two strings.

Parameters

a	First string
b	Second string

Return values

true	The strings are equal
false	The strings are not equal

Definition at line 871 of file string.c.

{
  return (a == b) || (mutt_str_cmp(a, b) == 0);
}

Here is the call graph for this function:

mutt_istr_equal()

bool mutt_istr_equal	(	const char *	a,
		const char *	b
	)

Compare two strings, ignoring case.

Parameters

a	First string
b	Second string

Return values

true	The strings are equal
false	The strings are not equal

Definition at line 883 of file string.c.

{
  return (a == b) || (mutt_istr_cmp(a, b) == 0);
}

Here is the call graph for this function:

mutt_str_next_word()

const char* mutt_str_next_word

(

const char *

s

)

Find the next word in a string.

Parameters

s	String to examine

Return values

ptr

Next word

If the s is pointing to a word (non-space) is is skipped over. Then, any whitespace is skipped over.

Note

What is/isn't a word is determined by isspace()

Definition at line 898 of file string.c.

{
  if (!s)
    return NULL;
 
  while (*s && !IS_SPACE(*s))
    s++;
  SKIPWS(s);
  return s;
}

mutt_strn_rfind()

const char* mutt_strn_rfind	(	const char *	haystack,
		size_t	haystack_length,
		const char *	needle
	)

Find last instance of a substring.

Parameters

haystack	String to search through
haystack_length	Length of the string
needle	String to find

Return values

NULL	String not found
ptr	Location of string

Return the last instance of needle in the haystack, or NULL. Like strstr(), only backwards, and for a limited haystack length.

Definition at line 920 of file string.c.

{
  if (!haystack || (haystack_length == 0) || !needle)
    return NULL;
 
  int needle_length = strlen(needle);
  const char *haystack_end = haystack + haystack_length - needle_length;
 
  for (const char *p = haystack_end; p >= haystack; --p)
  {
    for (size_t i = 0; i < needle_length; i++)
    {
      if (p[i] != needle[i])
        goto next;
    }
    return p;
 
  next:;
  }
  return NULL;
}

Here is the caller graph for this function:

mutt_str_is_ascii()

bool mutt_str_is_ascii	(	const char *	str,
		size_t	len
	)

Is a string ASCII (7-bit)?

Parameters

str	String to examine
len	Length of string to examine

Return values

true	There are no 8-bit chars

Definition at line 948 of file string.c.

{
  if (!str)
    return true;
 
  for (; (*str != '\0') && (len > 0); str++, len--)
    if ((*str & 0x80) != 0)
      return false;
 
  return true;
}

Here is the caller graph for this function:

mutt_str_find_word()

const char* mutt_str_find_word

(

const char *

src

)

Find the end of a word (non-space)

Parameters

src	String to search

Return values

ptr	End of the word

Skip to the end of the current word. Skip past any whitespace characters.

Note

If there aren't any more words, this will return a pointer to the final NUL character.

Definition at line 971 of file string.c.

{
  if (!src)
    return NULL;
 
  while (*src && strchr(" \t\n", *src))
    src++;
  while (*src && !strchr(" \t\n", *src))
    src++;
  return src;
}

Here is the caller graph for this function:

mutt_str_getenv()

const char* mutt_str_getenv

(

const char *

name

)

Get an environment variable.

Parameters

name	Environment variable to get

Return values

ptr	Value of variable
NULL	Variable isn't set, or is empty

Warning

The caller must not free the returned pointer.

Definition at line 991 of file string.c.

{
  if (!name)
    return NULL;
 
  const char *val = getenv(name);
  if (val && (val[0] != '\0'))
    return val;
 
  return NULL;
}

Here is the caller graph for this function:

mutt_str_inline_replace()

bool mutt_str_inline_replace	(	char *	buf,
		size_t	buflen,
		size_t	xlen,
		const char *	rstr
	)

Replace the beginning of a string.

Parameters

buf	Buffer to modify
buflen	Length of buffer
xlen	Length of string to overwrite
rstr	Replacement string

Return values

true

Success

String (XX<OOOOOO>......, 16, 2, RRRR) becomes RRRR<OOOOOO>....

Definition at line 1013 of file string.c.

{
  if (!buf || !rstr || (xlen >= buflen))
    return false;
 
  size_t slen = mutt_str_len(buf + xlen);
  size_t rlen = mutt_str_len(rstr);
 
  if ((slen + rlen) >= buflen)
    return false;
 
  memmove(buf + rlen, buf + xlen, slen + 1);
  memmove(buf, rstr, rlen);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_istr_remall()

int mutt_istr_remall	(	char *	str,
		const char *	target
	)

Remove all occurrences of substring, ignoring case.

Parameters

str	String containing the substring
target	Target substring for removal

Return values

0	String contained substring and substring was removed successfully
1	String did not contain substring

Definition at line 1037 of file string.c.

{
  int rc = 1;
  if (!str || !target)
    return rc;
 
  // Look through an ensure all instances of the substring are gone.
  while ((str = (char *) strcasestr(str, target)))
  {
    size_t target_len = mutt_str_len(target);
    memmove(str, str + target_len, 1 + strlen(str + target_len));
    rc = 0; // If we got here, then a substring existed and has been removed.
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_asprintf()

int mutt_str_asprintf	(	char **	strp,
		const char *	fmt,
			...
	)

Definition at line 1095 of file string.c.

{
  if (!strp || !fmt)
    return -1;
 
  int rlen = 256;
 
  *strp = mutt_mem_malloc(rlen);
  while (true)
  {
    va_list ap;
    va_start(ap, fmt);
    const int n = vsnprintf(*strp, rlen, fmt, ap);
    va_end(ap);
    if (n < 0)
    {
      FREE(strp);
      return n;
    }
 
    if (n < rlen)
    {
      /* reduce space to just that which was used.  note that 'n' does not
       * include the terminal nul char.  */
      if (n == 0) /* convention is to use NULL for zero-length strings. */
        FREE(strp);
      else if (n != rlen - 1)
        mutt_mem_realloc(strp, n + 1);
      return n;
    }
    /* increase size and try again */
    rlen = n + 1;
    mutt_mem_realloc(strp, rlen);
  }
  /* not reached */
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

sysexits

const struct SysExits sysexits[]

static

Definition at line 58 of file string.c.