atoi.h File Reference

Parse a number in a string. More...

#include <stdbool.h>

Include dependency graph for atoi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	make_str_ato_wrappers(flavour, type)

Functions
const char *	mutt_str_atoi (const char *str, int *dst)
	Convert ASCII string to an integer.
const char *	mutt_str_atol (const char *str, long *dst)
	Convert ASCII string to a long.
const char *	mutt_str_atos (const char *str, short *dst)
	Convert ASCII string to a short.
const char *	mutt_str_atoui (const char *str, unsigned int *dst)
	Convert ASCII string to an unsigned integer.
const char *	mutt_str_atoul (const char *str, unsigned long *dst)
	Convert ASCII string to an unsigned long.
const char *	mutt_str_atoull (const char *str, unsigned long long *dst)
	Convert ASCII string to an unsigned long long.
const char *	mutt_str_atous (const char *str, unsigned short *dst)
	Convert ASCII string to an unsigned short.
	make_str_ato_wrappers (i, int) make_str_ato_wrappers(l
long	make_str_ato_wrappers (s, short) make_str_ato_wrappers(ui
long unsigned int	make_str_ato_wrappers (ul, unsigned long) make_str_ato_wrappers(ull

Detailed Description

Parse a number in a string.

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 atoi.h.

Macro Definition Documentation

make_str_ato_wrappers

#define make_str_ato_wrappers	(		flavour,
			type
	)

Value:

  static inline bool mutt_str_ato ## flavour ## _full(const char *src, type *dst) \
  { \
    const char * end = mutt_str_ato ## flavour(src, dst); \
    return end && !*end; \
  } \

Definition at line 37 of file atoi.h.

Function Documentation

mutt_str_atoi()

const char * 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

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

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 192 of file atoi.c.

{
  long l = 0;
  const char *res = str_atol_clamp(str, &l, INT_MIN, INT_MAX);
  if (dst)
  {
    *dst = res ? l : 0;
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atol()

const char * 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

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

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

Definition at line 143 of file atoi.c.

{
  return str_atol_clamp(str, dst, LONG_MIN, LONG_MAX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atos()

const char * 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

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

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 165 of file atoi.c.

{
  long l = 0;
  const char *res = str_atol_clamp(str, &l, SHRT_MIN, SHRT_MAX);
  if (dst)
  {
    *dst = res ? l : 0;
  }
  return res;
}

Here is the call graph for this function:

mutt_str_atoui()

const char * 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

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

Note

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

Definition at line 218 of file atoi.c.

{
  unsigned long long l = 0;
  const char *res = str_atoull_clamp(str, &l, UINT_MAX);
  if (dst)
  {
    *dst = res ? l : 0;
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atoul()

const char * 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

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

Note

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

Definition at line 244 of file atoi.c.

{
  unsigned long long l = 0;
  const char *res = str_atoull_clamp(str, &l, ULONG_MAX);
  if (dst)
  {
    *dst = res ? l : 0;
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atoull()

const char * 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

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

Note

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

Definition at line 296 of file atoi.c.

{
  return str_atoull_clamp(str, dst, ULLONG_MAX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_str_atous()

const char * mutt_str_atous	(	const char *	str,
		unsigned short *	dst
	)

Convert ASCII string to an unsigned short.

Parameters

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

Return values

ptr

endptr

Condition	Description
endptr == NULL	No conversion happened, or overflow
endptr[0] == '\0'	str was fully converted
endptr[0] != '\0'	endptr points to first non converted char in str

Note

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

Definition at line 270 of file atoi.c.

{
  unsigned long long l = 0;
  const char *res = str_atoull_clamp(str, &l, USHRT_MAX);
  if (dst)
  {
    *dst = res ? l : 0;
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

make_str_ato_wrappers() [1/3]

make_str_ato_wrappers	(	i	,
		int
	)

make_str_ato_wrappers() [2/3]

long make_str_ato_wrappers	(	s	,
		short
	)

make_str_ato_wrappers() [3/3]

long unsigned int make_str_ato_wrappers	(	ul	,
		unsigned long
	)