NeoMutt  2024-03-23-142-g2b2e76
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
atoi.c File Reference

Parse a number in a string. More...

#include "config.h"
#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include "atoi.h"
+ Include dependency graph for atoi.c:

Go to the source code of this file.

Functions

static const char * str_atol_clamp (const char *str, long *dst, long lmin, long lmax)
 Convert ASCII string to a long and clamp.
 
static const char * str_atoull_clamp (const char *str, unsigned long long *dst, unsigned long long ullmax)
 Convert ASCII string to an unsigned long long and clamp.
 
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_atoi (const char *str, int *dst)
 Convert ASCII string to an integer.
 
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_atous (const char *str, unsigned short *dst)
 Convert ASCII string to an unsigned short.
 
const char * mutt_str_atoull (const char *str, unsigned long long *dst)
 Convert ASCII string to an unsigned long long.
 

Detailed Description

Parse a number in a string.

Authors
  • Richard Russon
  • Pietro Cerutti

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.c.

Function Documentation

◆ str_atol_clamp()

static const char * str_atol_clamp ( const char *  str,
long *  dst,
long  lmin,
long  lmax 
)
static

Convert ASCII string to a long and clamp.

Parameters
[in]strString to read
[in]lminLower bound
[in]lmaxUpper bound
[out]dstStore the result
Return values
ptrendptr
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 54 of file atoi.c.

55{
56 if (dst)
57 {
58 *dst = 0;
59 }
60
61 if (!str || (*str == '\0'))
62 {
63 return NULL;
64 }
65
66 char *e = NULL;
67 errno = 0;
68 long res = strtol(str, &e, 10);
69 if ((e == str) || (((res == LONG_MIN) || (res == LONG_MAX)) && (errno == ERANGE)) ||
70 (res < lmin) || (res > lmax))
71 {
72 return NULL;
73 }
74
75 if (dst)
76 {
77 *dst = res;
78 }
79
80 return e;
81}
+ Here is the caller graph for this function:

◆ str_atoull_clamp()

static const char * str_atoull_clamp ( const char *  str,
unsigned long long *  dst,
unsigned long long  ullmax 
)
static

Convert ASCII string to an unsigned long long and clamp.

Parameters
[in]strString to read
[in]ullmaxUpper bound
[out]dstStore the result
Return values
ptrendptr
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 strtoull() wrapper with range checking. errno may be set on error, e.g. ERANGE

Definition at line 99 of file atoi.c.

101{
102 if (dst)
103 {
104 *dst = 0;
105 }
106
107 if (!str || (*str == '\0'))
108 {
109 return str;
110 }
111
112 char *e = NULL;
113 errno = 0;
114 unsigned long long res = strtoull(str, &e, 10);
115 if ((e == str) || ((res == ULLONG_MAX) && (errno == ERANGE)) || (res > ullmax))
116 {
117 return NULL;
118 }
119
120 if (dst)
121 {
122 *dst = res;
123 }
124
125 return e;
126}
+ 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]strString to read
[out]dstStore the result
Return values
ptrendptr
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.

144{
145 return str_atol_clamp(str, dst, LONG_MIN, LONG_MAX);
146}
static const char * str_atol_clamp(const char *str, long *dst, long lmin, long lmax)
Convert ASCII string to a long and clamp.
Definition: atoi.c:54
+ 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]strString to read
[out]dstStore the result
Return values
0Success
-1Error
-2Error, 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 161 of file atoi.c.

162{
163 long l;
164 const char *res = str_atol_clamp(str, &l, SHRT_MIN, SHRT_MAX);
165 if (dst)
166 {
167 *dst = res ? l : 0;
168 }
169 return res;
170}
+ Here is the call graph for this function:

◆ mutt_str_atoi()

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

Convert ASCII string to an integer.

Parameters
[in]strString to read
[out]dstStore the result
Return values
ptrendptr
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 188 of file atoi.c.

189{
190 long l;
191 const char *res = str_atol_clamp(str, &l, INT_MIN, INT_MAX);
192 if (dst)
193 {
194 *dst = res ? l : 0;
195 }
196 return res;
197}
+ Here is the call graph for this function:
+ Here is the caller 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]strString to read
[out]dstStore the result
Return values
ptrendptr
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 214 of file atoi.c.

215{
216 unsigned long long l;
217 const char *res = str_atoull_clamp(str, &l, UINT_MAX);
218 if (dst)
219 {
220 *dst = res ? l : 0;
221 }
222 return res;
223}
static const char * str_atoull_clamp(const char *str, unsigned long long *dst, unsigned long long ullmax)
Convert ASCII string to an unsigned long long and clamp.
Definition: atoi.c:99
+ 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]strString to read
[out]dstStore the result
Return values
ptrendptr
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 240 of file atoi.c.

241{
242 unsigned long long l;
243 const char *res = str_atoull_clamp(str, &l, ULONG_MAX);
244 if (dst)
245 {
246 *dst = res ? l : 0;
247 }
248 return res;
249}
+ 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]strString to read
[out]dstStore the result
Return values
ptrendptr
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 266 of file atoi.c.

267{
268 unsigned long long l;
269 const char *res = str_atoull_clamp(str, &l, USHRT_MAX);
270 if (dst)
271 {
272 *dst = res ? l : 0;
273 }
274 return res;
275}
+ 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]strString to read
[out]dstStore the result
Return values
ptrendptr
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 292 of file atoi.c.

293{
294 return str_atoull_clamp(str, dst, ULLONG_MAX);
295}
+ Here is the call graph for this function:
+ Here is the caller graph for this function: