forked from Imagelibrary/rtems
21242c252a
* include/rtems/bspIo.h, include/rtems/concat.h, include/rtems/endian.h, include/rtems/fs.h, include/rtems/irq.h, include/rtems/pci.h, include/rtems/userenv.h, libblock/include/rtems/flashdisk.h, libblock/include/rtems/nvdisk-sram.h, libblock/include/rtems/nvdisk.h, libcsupport/include/clockdrv.h, libcsupport/include/console.h, libcsupport/include/iosupp.h, libcsupport/include/spurious.h, libcsupport/include/motorola/mc68230.h, libcsupport/include/rtems/assoc.h, libcsupport/include/rtems/error.h, libcsupport/include/rtems/framebuffer.h, libcsupport/include/rtems/gxx_wrappers.h, libcsupport/include/rtems/libcsupport.h, libcsupport/include/rtems/libio_.h, libcsupport/include/rtems/malloc.h, libcsupport/include/rtems/termiostypes.h, libcsupport/include/sys/statvfs.h, libcsupport/include/sys/termios.h, libcsupport/include/sys/utsname.h, libcsupport/include/zilog/z8036.h, libcsupport/include/zilog/z8530.h, libcsupport/include/zilog/z8536.h, libfs/src/imfs/imfs.h, libfs/src/pipe/pipe.h, libmisc/capture/capture-cli.h, libmisc/capture/capture.h, libmisc/cpuuse/cpuuse.h, libmisc/devnull/devnull.h, libmisc/devnull/devzero.h, libmisc/dumpbuf/dumpbuf.h, libmisc/fb/fb.h, libmisc/fb/mw_uid.h, libmisc/mouse/mouse_parser.h, libmisc/shell/shellconfig.h, libmisc/stringto/stringto.h, libmisc/untar/untar.h, libnetworking/memory.h, posix/include/aio.h, posix/include/mqueue.h, posix/include/semaphore.h, posix/include/rtems/posix/aio_misc.h, posix/include/rtems/posix/barrier.h, posix/include/rtems/posix/cond.h, posix/include/rtems/posix/config.h, posix/include/rtems/posix/key.h, posix/include/rtems/posix/mqueue.h, posix/include/rtems/posix/mutex.h, posix/include/rtems/posix/posixapi.h, posix/include/rtems/posix/priority.h, posix/include/rtems/posix/psignal.h, posix/include/rtems/posix/pthread.h, posix/include/rtems/posix/ptimer.h, posix/include/rtems/posix/rwlock.h, posix/include/rtems/posix/semaphore.h, posix/include/rtems/posix/sigset.h, posix/include/rtems/posix/spinlock.h, posix/include/rtems/posix/threadsup.h, posix/include/rtems/posix/time.h, posix/include/rtems/posix/timer.h, posix/inline/rtems/posix/barrier.inl, posix/inline/rtems/posix/cond.inl, posix/inline/rtems/posix/mqueue.inl, posix/inline/rtems/posix/mutex.inl, posix/inline/rtems/posix/priority.inl, posix/inline/rtems/posix/pthread.inl, posix/inline/rtems/posix/rwlock.inl, posix/inline/rtems/posix/semaphore.inl, posix/inline/rtems/posix/spinlock.inl, posix/inline/rtems/posix/timer.inl, rtems/mainpage.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/timer.h, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/timer.inl, rtems/src/semtranslatereturncode.c, sapi/include/rtems/config.h, sapi/include/rtems/fatal.h, sapi/include/rtems/mptables.h, score/include/rtems/score/object.h, score/include/rtems/score/priority.h, score/inline/rtems/score/object.inl, score/inline/rtems/score/priority.inl: Add @file Doxygen directives and descriptions to files which originated with RTEMS. This improves the file list page generated by Doxygen.
253 lines
7.8 KiB
C
253 lines
7.8 KiB
C
/**
|
|
* @file rtems/stringto.h
|
|
*
|
|
* This file defines the interface to a set of string conversion helpers.
|
|
*/
|
|
|
|
/*
|
|
* COPYRIGHT (c) 2009-2011.
|
|
* On-Line Applications Research Corporation (OAR).
|
|
*
|
|
* The license and distribution terms for this file may be
|
|
* found in the file LICENSE in this distribution or at
|
|
* http://www.rtems.com/license/LICENSE.
|
|
*
|
|
* $Id$
|
|
*/
|
|
|
|
#ifndef _RTEMS_STRINGTO_H
|
|
#define _RTEMS_STRINGTO_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)
|
|
*
|
|
* This method converts a string to an unsigned character with
|
|
* range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_unsigned_char(
|
|
const char *s,
|
|
unsigned char *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Int (with validation)
|
|
*
|
|
* This method converts a string to an int with range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_int(
|
|
const char *s,
|
|
int *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Unsigned Int (with validation)
|
|
*
|
|
* This method converts a string to an unsigned int with range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_unsigned_int(
|
|
const char *s,
|
|
unsigned int *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Long (with validation)
|
|
*
|
|
* This method converts a string to a long with
|
|
* range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_long(
|
|
const char *s,
|
|
long *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Unsigned Long (with validation)
|
|
*
|
|
* This method converts a string to an unsigned long with
|
|
* range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_unsigned_long(
|
|
const char *s,
|
|
unsigned long *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Long Long (with validation)
|
|
*
|
|
* This method converts a string to a long long with
|
|
* range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_long_long(
|
|
const char *s,
|
|
long long *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Unsigned Long Long (with validation)
|
|
*
|
|
* This method converts a string to an unsigned character with
|
|
* range 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
|
|
* @param[in] base is the expected base of the number
|
|
*
|
|
* @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_unsigned_long_long(
|
|
const char *s,
|
|
unsigned long long *n,
|
|
char **endptr,
|
|
int base
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Float (with validation)
|
|
*
|
|
* This method converts a string to a float with range 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_float(
|
|
const char *s,
|
|
float *n,
|
|
char **endptr
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to Double (with validation)
|
|
*
|
|
* This method converts a string to a double with range 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_double(
|
|
const char *s,
|
|
double *n,
|
|
char **endptr
|
|
);
|
|
|
|
/**
|
|
* @brief Convert String to long double (with validation)
|
|
*
|
|
* This method converts a string to a long double with range 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_long_double(
|
|
const char *s,
|
|
long double *n,
|
|
char **endptr
|
|
);
|
|
|
|
#endif
|