path: root/cpukit/libmisc/stringto/stringto_template.h

/*
 *  COPYRIGHT (c) 2009.
 *  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$
 */

#include <errno.h>
#include <stdlib.h>
#include <limits.h>
#include <stdbool.h>

#include <rtems/stringto.h>

/*
 *  If we are doing floating point conversion, then we need math.h
 */
#if defined(STRING_TO_FLOAT)
  #include <math.h>
#endif

#include <rtems.h>

/*
 * This file is designed to be included multiple times to instantiate
 * it and should NOT be protected against multiple inclusions.
 */

#if defined(STRING_TO_POINTER)
  #define STRING_TO_INTEGER
#endif

#if !defined(STRING_TO_FLOAT) && !defined(STRING_TO_INTEGER)
  #error "Neither STRING_TO_FLOAT nor STRING_TO_INTEGER defined"
#endif

#if defined(STRING_TO_FLOAT) && defined(STRING_TO_INTEGER)
  #error "Both STRING_TO_FLOAT nor STRING_TO_INTEGER defined"
#endif

#ifndef STRING_TO_TYPE
  #error "STRING_TO_TYPE not defined"
#endif

#ifndef STRING_TO_NAME
  #error "STRING_TO_NAME not defined"
#endif

#ifndef STRING_TO_METHOD
  #error "STRING_TO_METHOD not defined"
#endif

#ifndef STRING_TO_MAX
  #error "STRING_TO_MAX not defined"
#endif

#undef ZERO
#ifdef STRING_TO_FLOAT
  #define ZERO 0.0
#elif defined(STRING_TO_INTEGER)
  #define ZERO 0
#endif

#if !defined(STRING_TO_INPUT_TYPE)
  #define STRING_TO_INPUT_TYPE STRING_TO_TYPE
#endif

rtems_status_code STRING_TO_NAME (
  const char      *s,
  STRING_TO_TYPE  *n,
  char           **endptr
  #if defined(STRING_TO_INTEGER) && !defined(STRING_TO_POINTER)
    ,
    int              base
  #endif
)
{
  STRING_TO_INPUT_TYPE  result;
  char                 *end;

  if ( !n )
    return RTEMS_INVALID_ADDRESS;

  errno = 0;
  *n    = 0;

  #ifdef STRING_TO_FLOAT
    result = STRING_TO_METHOD( s, &end );
  #elif defined(STRING_TO_POINTER)
    result = STRING_TO_METHOD( s, &end, 16 );
  #elif defined(STRING_TO_INTEGER)
    result = STRING_TO_METHOD( s, &end, base );
  #endif

  /* If the user wants the end pointer back, then return it. */
  if ( endptr )
    *endptr = end;

  /* nothing was converted */
  if ( end == s )
    return RTEMS_NOT_DEFINED;

  /*
   * In theory, we should check this but newlib never returns anything
   * but range errors.  So this is unreachable code based upon the newlib
   * implementation of strXXX methods as of 1 December 2009. --joel
   */
  #if 0
  /* there was a conversion error */
  if ( (result == ZERO) && errno )
    return RTEMS_INVALID_NUMBER;
  #endif

  #ifdef STRING_TO_MAX
    /* there was an overflow */
    if ( (result == STRING_TO_MAX) && (errno == ERANGE))
      return RTEMS_INVALID_NUMBER;
  #endif

  #ifdef STRING_TO_MIN
    /* there was an underflow */
    if ( (result == STRING_TO_MIN) && (errno == ERANGE))
      return RTEMS_INVALID_NUMBER;
  #endif

  #if defined(STRING_TO_POINTER)
    *n = (STRING_TO_TYPE) (uintptr_t)result;
  #else
    *n = (STRING_TO_TYPE) result;
  #endif
  return RTEMS_SUCCESSFUL;
}