keyvaluecollection.h

/****************************************************************************
 * Copyright (c) 2014, Joel Kivelä, Erkki Koskenkorva, Oskari Leppäaho,
 * Mika Lehtinen and Petri Partanen.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the copyright holders nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
****************************************************************************/
#ifndef KEYVALUECOLLECTION_H
#define KEYVALUECOLLECTION_H

#include <algorithm>
#include <array>
#include <cassert>
#include <clocale>
#include <map>
#include <string>

#include <QColor>
#include <QDebug>
#include <QString>

namespace cavapa_gui
{
class KeyValueCollection
{
protected:
    std::map<std::string, std::string> keyValueMap;

public:
    using const_iterator = std::map<std::string, std::string>::const_iterator;

    const_iterator begin() const;

    const_iterator end() const;

    std::string get(const std::string& name) const;

    bool getBool(const std::string& name) const;

    QColor getColor(const std::string& name) const;

    QString getQString(const std::string& name) const;

    double getDouble(const std::string& name) const;

    int getInt(const std::string& name) const;

    template<typename ValueType, int N>
    std::array<ValueType, N> getValues(const std::string& name) const
    {
        static_assert(std::is_same<ValueType, double>::value
                      || std::is_same<ValueType, int>::value,
                      "Invalid template type argument for getValues");
        static_assert(N > 0, "Invalid template integer argument for getValues");

        //Make sure the decimal separator is dot and not comma!
        setlocale(LC_NUMERIC, "C");
        
        std::array<ValueType, N> values;
        QStringList parts = getQString(name).split(';');
        if (parts.size() != N)
        {
            parts = getQString(name).split(',');
            if (parts.size() != N)
            {
                parts.clear();
                for (int i = 0; i < N; ++i)
                {
                    parts.append("0");
                }
            }
        }
        assert(parts.size() == N);
        for (int i = 0; i < N; i++)
        {
            std::string current = parts.at(i).toStdString();
            try
            {
                if (std::is_same<ValueType, int>::value)
                {
                    values[i] = std::stoi(current);
                }
                else if (std::is_same<ValueType, double>::value)
                {
                    values[i] = std::stod(current);
                }
            }
            catch (const std::invalid_argument&)
            {
                qDebug() << "The key"
                         << QString::fromStdString(name)
                         << "was not convertible to numeric value:"
                         << QString::fromStdString(current)
                         << "(setting to 0)";
                values[i] = 0;
            }
            catch (const std::out_of_range&)
            {
                qDebug() << "The key"
                         << QString::fromStdString(name)
                         << "was out of range:"
                         << QString::fromStdString(current)
                         << "(setting to 0)";
                values[i] = 0;
            }
        }
        return values;
    }

    void set(const std::string& name, const std::string& value);

    void setBool(const std::string& name, bool value);

    void setColor(const std::string& name, const QColor& value);

    void setInt(const std::string& name, int value);

    template<typename... T>
    void setValues(const std::string& name, T... values)
    {
        auto vals = {values...};
        std::string str;
        std::string separator;
        for (auto v : vals)
        {
            std::string piece = std::to_string(v);

            //std::to_string uses a comma instead of dot even though
            //std::stod requires dot, so we convert the comma to dot here.
            std::replace(piece.begin(), piece.end(), ',', '.');

            str += separator + piece;
            separator = ";";
        }
        set(name, str);
    }

    void setQString(const std::string& name, const QString& value);

    bool trySet(const std::string& name, const std::string& value);
};
} //namespace cavapa_gui

#endif // KEYVALUECOLLECTION_H