diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2009-07-23 14:32:34 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2009-07-23 14:32:34 +0000 |
commit | 48751ab095bbbb23489c2e3243f57571cbfa9153 (patch) | |
tree | 7a15647c01c3acdb2d1c61142bb13616ad03a2aa /cpukit/libmisc/stringto/stringto.h | |
parent | 2009-07-23 Santosh G Vattam <vattam.santosh@gmail.com> (diff) | |
download | rtems-48751ab095bbbb23489c2e3243f57571cbfa9153.tar.bz2 |
2009-07-23 Joel Sherrill <joel.sherrill@oarcorp.com>
* libmisc/Makefile.am, libmisc/shell/main_chmod.c,
libmisc/shell/main_mdump.c, libmisc/shell/main_medit.c,
libmisc/shell/main_mfill.c, libmisc/shell/main_mmove.c,
libmisc/shell/main_msdosfmt.c, libmisc/shell/main_mwdump.c,
libmisc/shell/main_sleep.c, libmisc/shell/main_umask.c,
libmisc/shell/shell_script.c, libmisc/stringto/stringto.h,
libmisc/stringto/stringto_template.h: Convert return type from bool
to rtems_status_code and add rtems_string_to_pointer. Perform
associated clean up and changes for return type change.
* libmisc/stringto/stringtopointer.c: New file.
Diffstat (limited to 'cpukit/libmisc/stringto/stringto.h')
-rw-r--r-- | cpukit/libmisc/stringto/stringto.h | 78 |
1 files changed, 54 insertions, 24 deletions
diff --git a/cpukit/libmisc/stringto/stringto.h b/cpukit/libmisc/stringto/stringto.h index 2e7fe151c6..e0ba24416c 100644 --- a/cpukit/libmisc/stringto/stringto.h +++ b/cpukit/libmisc/stringto/stringto.h @@ -12,6 +12,28 @@ #ifndef __STRING_TO_A_TYPE_h__ #define __STRING_TO_A_TYPE_h__ +#include <rtems.h> + +/** + * @brief Convert String to Pointer (with validation) + * + * This method converts a string to a pointer (void *) with + * basic numeric validation. + * + * @param[in] s is the string to convert + * @param[in] n points to the variable to place the converted output in + * @param[in] endptr is used to keep track of the position in the string + * + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. + */ +rtems_status_code rtems_string_to_pointer( + const char *s, + void **n, + char **endptr +); + /** * @brief Convert String to Unsigned Character (with validation) * @@ -23,10 +45,11 @@ * @param[in] endptr is used to keep track of the position in the string * @param[in] base is the expected base of the number * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_unsigned_char( +rtems_status_code rtems_string_to_unsigned_char( const char *s, unsigned char *n, char **endptr, @@ -43,10 +66,11 @@ bool rtems_string_to_unsigned_char( * @param[in] endptr is used to keep track of the position in the string * @param[in] base is the expected base of the number * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_int( +rtems_status_code rtems_string_to_int( const char *s, int *n, char **endptr, @@ -64,10 +88,11 @@ bool rtems_string_to_int( * @param[in] endptr is used to keep track of the position in the string * @param[in] base is the expected base of the number * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_long( +rtems_status_code rtems_string_to_long( const char *s, long *n, char **endptr, @@ -85,10 +110,11 @@ bool rtems_string_to_long( * @param[in] endptr is used to keep track of the position in the string * @param[in] base is the expected base of the number * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_unsigned_long( +rtems_status_code rtems_string_to_unsigned_long( const char *s, unsigned long *n, char **endptr, @@ -106,10 +132,11 @@ bool rtems_string_to_unsigned_long( * @param[in] endptr is used to keep track of the position in the string * @param[in] base is the expected base of the number * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_long_long( +rtems_status_code rtems_string_to_long_long( const char *s, long long *n, char **endptr, @@ -127,10 +154,11 @@ bool rtems_string_to_long_long( * @param[in] endptr is used to keep track of the position in the string * @param[in] base is the expected base of the number * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_unsigned_long_long( +rtems_status_code rtems_string_to_unsigned_long_long( const char *s, unsigned long long *n, char **endptr, @@ -146,10 +174,11 @@ bool rtems_string_to_unsigned_long_long( * @param[in] n points to the variable to place the converted output in * @param[in] endptr is used to keep track of the position in the string * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_float( +rtems_status_code rtems_string_to_float( const char *s, float *n, char **endptr @@ -164,10 +193,11 @@ bool rtems_string_to_float( * @param[in] n points to the variable to place the converted output in * @param[in] endptr is used to keep track of the position in the string * - * @return This method returns true on successful conversion and *n is - * filled in. + * @return This method returns RTEMS_SUCCESSFUL on successful conversion + * and *n is filled in. Otherwise, the status indicates the + * source of the error. */ -bool rtems_string_to_double( +rtems_status_code rtems_string_to_double( const char *s, double *n, char **endptr |