kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-21 01:01:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "core/conversions: Added string to unsigned integer and long conversions"

Browse Source
This commit is contained in:
Jenkins2
2017-05-22 04:59:49 -05:00
committed by Gerrit Code Review
parent b5570de7b4 51375686f7
commit 5fffb96736
3 changed files with 275 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
include/asterisk/conversions.h Normal file
View File

@@ -0,0 +1,62 @@
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2017, Digium, Inc.
*
* Kevin Harwell <kharwell@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
* \brief Conversion utility functions
*/
#ifndef _ASTERISK_CONVERSIONS_H
#define _ASTERISK_CONVERSIONS_H
/*!
* \brief Convert the given string to an unsigned integer
*
* This function will return failure for the following reasons:
*
* The given string to convert is NULL
* The given string to convert is empty.
* The given string to convert is negative (starts with a '-')
* The given string to convert contains non numeric values
* Once converted the number is out of range (greater than UINT_MAX)
*
* \param str The string to convert
* \param res [out] The converted value
*
* \returns -1 if it fails to convert, 0 on success
*/
int ast_str_to_uint(const char *str, unsigned int *res);
/*!
* \brief Convert the given string to an unsigned long
*
* This function will return failure for the following reasons:
*
* The given string to convert is NULL
* The given string to convert is empty.
* The given string to convert is negative (starts with a '-')
* The given string to convert contains non numeric values
* Once converted the number is out of range (greater than ULONG_MAX)
*
* \param str The string to convert
* \param res [out] The converted value
*
* \returns -1 if it fails to convert, 0 on success
*/
int ast_str_to_ulong(const char *str, unsigned long *res);
#endif /* _ASTERISK_CONVERSIONS_H */

77
main/conversions.c Normal file
View File

@@ -0,0 +1,77 @@
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2017, Digium, Inc.
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief Conversion utility functions
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <stdlib.h>
#include "asterisk/conversions.h"
static int str_is_negative(const char *str)
{
/* Ignore any preceding white space */
while (isspace(*str) && *++str);
return *str == '-';
}
int ast_str_to_uint(const char *str, unsigned int *res)
{
unsigned long val;
if (ast_str_to_ulong(str, &val) || val > UINT_MAX) {
return -1;
}
*res = val;
return 0;
}
int ast_str_to_ulong(const char *str, unsigned long *res)
{
char *end;
unsigned long val;
if (!str || str_is_negative(str)) {
return -1;
}
errno = 0;
val = strtoul(str, &end, 0);
/*
* If str equals end then no digits were found. If end is not pointing to
* a null character then the string contained some numbers that could be
* converted, but some characters that could not, which we'll consider
* invalid.
*/
if ((str == end || *end != '\0' || (errno == ERANGE && val == ULONG_MAX))) {
return -1;
}
*res = val;
return 0;
}

136
tests/test_conversions.c Normal file
View File

@@ -0,0 +1,136 @@
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2017, Digium, Inc.
*
* Kevin Harwell <kharwell@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*!
* \file
* \brief Conversions Unit Tests
*
* \author Kevin Harwell <kharwell@digium.com>
*
*/
/*** MODULEINFO
<depend>TEST_FRAMEWORK</depend>
<support_level>core</support_level>
***/
#include "asterisk.h"
#include "asterisk/test.h"
#include "asterisk/module.h"
#include "asterisk/conversions.h"
#define CATEGORY "/main/conversions/"
AST_TEST_DEFINE(str_to_uint)
{
const char *invalid = "abc";
const char *invalid_partial = "7abc";
const char *negative = "-7";
const char *negative_spaces = " -7";
const char *out_of_range = "9999999999";
const char *spaces = " ";
const char *valid = "7";
const char *valid_spaces = " 7";
unsigned int val;
char str[64];
switch (cmd) {
case TEST_INIT:
info->name = __func__;
info->category = CATEGORY;
info->summary = "convert a string to an unsigned integer";
info->description = info->summary;
return AST_TEST_NOT_RUN;
case TEST_EXECUTE:
break;
}
ast_test_validate(test, ast_str_to_uint(NULL, &val));
ast_test_validate(test, ast_str_to_uint(invalid, &val));
ast_test_validate(test, ast_str_to_uint(invalid_partial, &val));
ast_test_validate(test, ast_str_to_uint(negative, &val));
ast_test_validate(test, ast_str_to_uint(negative_spaces, &val));
ast_test_validate(test, ast_str_to_uint(out_of_range, &val));
ast_test_validate(test, ast_str_to_uint(spaces, &val));
ast_test_validate(test, !ast_str_to_uint(valid, &val));
ast_test_validate(test, !ast_str_to_uint(valid_spaces, &val));
ast_test_validate(test, snprintf(str, sizeof(str), "%u", UINT_MAX) > 0);
ast_test_validate(test, !ast_str_to_uint(str, &val));
ast_test_validate(test, val == UINT_MAX);
return AST_TEST_PASS;
}
AST_TEST_DEFINE(str_to_ulong)
{
const char *invalid = "abc";
const char *invalid_partial = "7abc";
const char *negative = "-7";
const char *negative_spaces = " -7";
const char *out_of_range = "99999999999999999999";
const char *spaces = " ";
const char *valid = "7";
const char *valid_spaces = " 7";
unsigned long val;
char str[64];
switch (cmd) {
case TEST_INIT:
info->name = __func__;
info->category = CATEGORY;
info->summary = "convert a string to an unsigned long";
info->description = info->summary;
return AST_TEST_NOT_RUN;
case TEST_EXECUTE:
break;
}
ast_test_validate(test, ast_str_to_ulong(NULL, &val));
ast_test_validate(test, ast_str_to_ulong(invalid, &val));
ast_test_validate(test, ast_str_to_ulong(invalid_partial, &val));
ast_test_validate(test, ast_str_to_ulong(negative, &val));
ast_test_validate(test, ast_str_to_ulong(negative_spaces, &val));
ast_test_validate(test, ast_str_to_ulong(out_of_range, &val));
ast_test_validate(test, ast_str_to_ulong(spaces, &val));
ast_test_validate(test, !ast_str_to_ulong(valid, &val));
ast_test_validate(test, !ast_str_to_ulong(valid_spaces, &val));
ast_test_validate(test, snprintf(str, sizeof(str), "%lu", ULONG_MAX) > 0);
ast_test_validate(test, !ast_str_to_ulong(str, &val));
ast_test_validate(test, val == ULONG_MAX);
return AST_TEST_PASS;
}
static int load_module(void)
{
AST_TEST_REGISTER(str_to_uint);
AST_TEST_REGISTER(str_to_ulong);
return AST_MODULE_LOAD_SUCCESS;
}
static int unload_module(void)
{
AST_TEST_UNREGISTER(str_to_uint);
AST_TEST_UNREGISTER(str_to_ulong);
return 0;
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "URI test module");