Exheredludis/paludis/util/destringify.hh

/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006 Stephen Bennett
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis 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., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_DESTRINGIFY_HH
#define PALUDIS_GUARD_PALUDIS_DESTRINGIFY_HH 1

#include <paludis/util/exception.hh>
#include <sstream>
#include <string>

/** \file
 * Destringify functions.
 *
 * \ingroup g_strings
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    /**
     * Default exception type thrown by destringify when it fails.
     *
     * \ingroup g_strings
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE DestringifyError :
        public Exception
    {
        public:
            ///\name Basic operations
            ///\{

            DestringifyError(const std::string & str) noexcept;

            ///\}
    };

    /**
     * For internal use by destringify.
     *
     * \ingroup g_strings
     */
    namespace destringify_internals
    {
        /**
         * Basic destringifier.
         *
         * \ingroup g_strings
         */
        template <typename Type_, typename Exception_>
        struct Destringifier
        {
            /**
             * Do the destringification.
             */
            static Type_ do_destringify(const std::string & s)
            {
                std::istringstream ss(s);
                Type_ t;
                ss >> t;
                if (! ss.eof() || ss.fail())
                    throw Exception_(s);
                return t;
            }
        };

        /**
         * Specialised destringify for std::string.
         *
         * \ingroup g_strings
         */
        template <typename Exception_>
        struct Destringifier<std::string, Exception_>
        {
            /**
             * Do the destringification.
             */
            static std::string do_destringify(const std::string & s)
            {
                return s;
            }
        };

        /**
         * Specialised destringify for bool.
         *
         * \ingroup g_strings
         */
        template <typename Exception_>
        struct Destringifier<bool, Exception_>
        {
            /**
             * Do the destringification.
             */
            static bool do_destringify(const std::string & s)
            {
                /* Don't use boolalpha on std::istringstream here, since it's way too difficult
                 * to test for errors and eof. See gcc bug 37958. */
                if (s == "true")
                    return true;
                else if (s == "false")
                    return false;
                else
                    return Destringifier<int, Exception_>::do_destringify(s) > 0;
            }
        };

        /**
         * Specialised destringify for char.
         *
         * \ingroup g_strings
         */
        template <typename Exception_>
        struct Destringifier<char, Exception_>
        {
            /**
             * Do the destringification.
             */
            static char do_destringify(const std::string & s)
            {
                if (s.length() == 1)
                    return s[0];
                else
                    throw Exception_(s);
            }
        };
    }

    /**
     * Extract a value of some type from a string.
     *
     * \ingroup g_strings
     */
    template <typename Type_, typename Exception_ = DestringifyError>
    Type_ destringify(const std::string & s)
    {
        if (s == "")
            throw Exception_("");

        return destringify_internals::Destringifier<Type_, Exception_>::do_destringify(s);
    }
}

#endif