////////////////////////////////////////////////////////////////////////
// Copyright (C) 1997-2007 Igor Kholodov, Bristol Community College
// mailto:Igor.Kholodov@bristolcc.edu
// http://www.c-jump.com/CIS60/CIS60syllabus.htm
////////////////////////////////////////////////////////////////////////

/**@file string_format.h
 * @brief To and from string conversions.
 *
 */

// string_format.h

#ifndef _STRING_FORMAT_H_INCLUDED_
#define _STRING_FORMAT_H_INCLUDED_

#include <sstream>
#include <string>

/**Converts C++ floating-point type to string.
*
* @par @c SourceT
*        Template parameter specifying floating-point type.
*
* @par @c FormatT
*        Template parameter specifying STL stream manipulator, usually
*        a function pointer: std::ios_base& ( *ios_base_ ) ( std::ios_base& ).
*
* @param source_
*        constant reference to C++ object representing
*        floating-point input variable to convert to STL string.
*
* @param precision_
*        an integer specifying desired precision.
*
* @param ios_base_
*        STL stream manipulator, such as 
*        std::showpoint  (always show floating point)
*        std::scientific (e.g. 1.234568e+003)
*        std::fixed      (no exponent field)
*        etc.
*
* @return
*        std::string that contains result of the conversion.
*
*/
template< typename SourceT, typename FormatT >
std::string type2string( SourceT const& source_, FormatT* ios_base_, int precision_ )
{
    std::basic_stringstream< char > stream_;
    stream_.precision( precision_ );
    stream_ << ios_base_ << source_;
    return stream_.str();
}

/**Converts C++ type to string.
*
* @par @c SourceT
*        Template parameter specifying input variable type.
*
* @par @c FormatT
*        Template parameter specifying STL stream manipulator, usually
*        a function pointer: std::ios_base& ( *ios_base_ ) ( std::ios_base& ).
*
* @param source_
*        constant reference to C++ object representing
*        input variable to convert to STL string.
*
* @param ios_base_
*        STL stream manipulator, such as 
*        std::dec (base ten)
*        std::hex (hexidecimal, base 16)
*        std::oct (octal, base 8)
*        etc.
*
* @return
*        std::string that contains result od the conversion.
*
*/
template< typename SourceT, typename FormatT >
std::string type2string( SourceT const& source_, FormatT* ios_base_ )
{
    std::basic_stringstream< char > stream_;
    stream_ << ios_base_ << source_;
    return stream_.str();
}

/**Converts C++ type to string.
*
* @par @c SourceT
*        Template parameter specifying input variable type.
*
* @param source_
*        constant reference to C++ object representing
*        input variable to convert to STL string.
*
* @return
*        std::string that contains result od the conversion.
*
*/
template< typename SourceT >
std::string type2string( SourceT const& source_ )
{
    std::basic_stringstream< char > stream_;
    stream_ << source_;
    return stream_.str();
}

/**Converts STL string to C++ type.
*
* @par @c TargetT
*        Template parameter specifying output variable type.
*
* @par @c FormatT
*        Template parameter specifying STL stream manipulator, usually
*        a function pointer: std::ios_base& ( *ios_base_ ) ( std::ios_base& ).
*
* @param source_
*        Input string with textual representation of the
*        source value, such as 1234.56789, true, 0xFF, etc.
*
* @param target_
*        reference to C++ object representing
*        output variable to receive the result of conversion.
*
* @param ios_base_
*        STL stream manipulator, such as 
*        std::dec (base ten)
*        std::hex (hexidecimal, base 16)
*        std::oct (octal, base 8)
*        etc.
*
* @remarks
*        If conversion fails, target_ may receive a garbage value,
*        which should be discarded.
*
* @return
*        Boolean result of the conversion, true if successful,
*        false otherwise.
*
*/
template< typename TargetT, typename FormatT >
bool string2type(
          std::string const& source_, 
          TargetT& target_, 
          FormatT* ios_base_
          )
{
    std::istringstream iss( source_ );
    return !( iss >> ios_base_ >> target_ ).fail();
}

/**Converts STL string to C++ type.
*
* @par @c TargetT
*        Template parameter specifying output variable type.
*
* @param source_
*        Input string with textual representation of the
*        input value, such as 12345.
*
* @param target_
*        reference to C++ object representing
*        output variable to receive the result of conversion.
*
* @remarks
*        If conversion fails, target_ may receive a garbage value,
*        which should be discarded.
*
* @return
*        Boolean result of the conversion, true if successful,
*        false otherwise.
*
*/
template< typename TargetT >
bool string2type(
          std::string const& source_, 
          TargetT& target_
          )
{
    std::istringstream iss( source_ );
    return !( iss >> target_ ).fail();
}

#endif // _STRING_FORMAT_H_INCLUDED_