/* === This file is part of Calamares - <https://github.com/calamares> ===
 *
 *   Copyright 2013-2016, Teo Mrnjavac <teo@kde.org>
 *   Copyright 2018, Adriaan de Groot <groot@kde.org>
 *
 *   Calamares 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 3 of the License, or
 *   (at your option) any later version.
 *
 *   Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef UTILS_VARIANT_H
#define UTILS_VARIANT_H

#include "DllMacro.h"

#include <QString>
#include <QVariantMap>

namespace CalamaresUtils
{
    /**
     * Get a bool value from a mapping with a given key; returns the default
     * if no value is stored in the map.
     */
    DLLEXPORT bool getBool( const QVariantMap& map, const QString& key, bool d );

    /**
     * Get a string value from a mapping; returns empty QString if no value.
     */
    DLLEXPORT QString getString( const QVariantMap& map, const QString& key );

    /**
     * Get an integer value from a mapping; returns @p d if no value.
     */
    DLLEXPORT int getInteger( const QVariantMap& map, const QString& key, int d );

    /**
     * Get a double value from a mapping (integers are converted); returns @p d if no value.
     */
    DLLEXPORT double getDouble( const QVariantMap& map, const QString& key, double d );

    /**
     * Returns a sub-map (i.e. a nested map) from the given mapping with the
     * given key. @p success is set to true if the @p key exists
     * in @p map and converts to a map, false otherwise.
     *
     * Returns an empty map if there is no such key or it is not a map-value.
     * (e.g. if @p success is false).
     */
    DLLEXPORT QVariantMap getSubMap( const QVariantMap& map, const QString& key, bool& success );
}  // namespace

#endif