source: code/branches/FICN/src/misc/Convert.h @ 721

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

/*!
    @file Convert.h
    @brief Definition and Implementation of the Convert class.
*/

#ifndef _Convert_H__
#define _Convert_H__

#include <string>
#include <sstream>

//! The Convert class has some static member functions to convert strings to values and values to strings.
class Convert
{
  public:
    /**
        @brief Converts a value of any type to a string.
        @param output The string to write the result in
        @param input The variable to convert
        @return True if the conversion succeded

        @example
        float f = 3.14;
        std::string output;
        bool success = Convert::ToString(output, f);
    */
    template <typename T>
    static bool Convert::ToString(std::string& output, T input)
    {
        std::ostringstream oss;
        if (oss << input)
        {
            output = oss.str();
            return true;
        }

        return false;
    }

    /**
        @brief Converts a value of any type to a string and assigns a defaultvalue if the conversion fails.
        @param output The string to write the result in
        @param input The variable to convert
        @param fallbackString The assigned string if the conversion fails.
        @return True if the conversion succeeded

        @example
        float f = 3.14;
        std::string output;
        bool success = Convert::ToString(output, f, "0.000000");
    */
    template <typename T>
    static bool Convert::ToString(std::string& output, T input, const std::string& fallbackString)
    {
        if (Convert::ToString(output, input))
            return true;

        output = fallbackString;
        return false;
    }

    /**
        @brief Converts a string to a value of any type.
        @param output The variable to assign the result to
        @param input The string to convert
        @return True if the conversion succeeded

        @example
        std::string input = "3.14";
        float f;
        bool success = string2Number(f, input);
    */
    template <typename T>
    static bool Convert::FromString(T& output, const std::string& input)
    {
        std::istringstream iss(input);
        if (iss >> output)
            return true;

        return false;
    }

    /**
        @brief Converts a string to a value of any type.
        @param output The variable to assign the result to
        @param input The string to convert
        @param fallbackValue The assigned value if the conversion fails
        @return True if the conversion succeeded

        @example
        std::string input = "3.14";
        float f;
        bool success = string2Number(f, input, 0.000000);
    */
    template <typename T>
    static bool Convert::FromString(T& output, const std::string& input, T fallbackValue)
    {
        if (Convert::FromString(output, input))
            return true;

        output = fallbackValue;
        return false;
    }
};

#endif /* _Convert_H__ */