Files
pilotclient/src/blackmisc/variantmap.h

105 lines
3.8 KiB
C++

/* Copyright (C) 2015
* swift project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
* or distributed except according to the terms contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_VARIANTMAP_H
#define BLACKMISC_VARIANTMAP_H
#include "blackmisc/blackmiscexport.h"
#include "blackmisc/dictionary.h"
#include "blackmisc/variant.h"
#include <QJsonObject>
#include <QMap>
#include <QMetaType>
#include <QString>
#include <initializer_list>
#include <utility>
namespace BlackMisc
{
class CStatusMessageList;
/*!
* Map of { QString, CVariant } pairs.
*
* Using QMap as implementation type so keys are sorted.
*/
class BLACKMISC_EXPORT CVariantMap :
public CDictionary<QString, CVariant, QMap>,
public Mixin::MetaType<CVariantMap>
{
public:
BLACKMISC_DECLARE_USING_MIXIN_METATYPE(CVariantMap)
using CDictionary::CDictionary;
//! Default constructor.
CVariantMap() {}
//! Copy constructor.
CVariantMap(const CVariantMap &) = default;
//! Move constructor.
CVariantMap(CVariantMap &&other) noexcept : CDictionary(std::move(other)) {}
//! Copy assignment operator.
CVariantMap &operator =(const CVariantMap &other) { CDictionary::operator =(other); return *this; }
//! Move assignment operator.
CVariantMap &operator =(CVariantMap &&other) noexcept { CDictionary::operator =(std::move(other)); return *this; }
//! Destructor.
~CVariantMap() = default;
//! Insert values from this map into an existing JSON object.
QJsonObject &mergeToJson(QJsonObject &json) const;
//! \copydoc BlackMisc::CValueObject::toJson
QJsonObject toJson() const;
//! \copydoc BlackMisc::CValueObject::convertFromJson
void convertFromJson(const QJsonObject &json);
//! \copydoc BlackMisc::CValueObject::convertFromJson
//! Convert only keys present in list argument.
void convertFromJson(const QJsonObject &json, const QStringList &keys);
//! Call convertFromJson, catch any CJsonException that are thrown and return them as CStatusMessage.
CStatusMessageList convertFromJsonNoThrow(const QJsonObject &json, const CLogCategoryList &categories, const QString &prefix);
//! Call convertFromJson, catch any CJsonException that are thrown and return them as CStatusMessage.
CStatusMessageList convertFromJsonNoThrow(const QJsonObject &json, const QStringList &keys, const CLogCategoryList &categories, const QString &prefix);
//! Insert values from this map into an existing compact JSON object.
QJsonObject &mergeToMemoizedJson(QJsonObject &json) const;
//! To compact JSON format.
QJsonObject toMemoizedJson() const;
//! From compact JSON format.
void convertFromMemoizedJson(const QJsonObject &json);
//! From compact JSON format.
//! Convert only keys present in list argument.
void convertFromMemoizedJson(const QJsonObject &json, const QStringList &keys);
//! Call convertFromMemoizedJson, catch any CJsonException that are thrown and return them as CStatusMessage.
CStatusMessageList convertFromMemoizedJsonNoThrow(const QJsonObject &json, const CLogCategoryList &categories, const QString &prefix);
//! Call convertFromMemoizedJson, catch any CJsonException that are thrown and return them as CStatusMessage.
CStatusMessageList convertFromMemoizedJsonNoThrow(const QJsonObject &json, const QStringList &keys, const CLogCategoryList &categories, const QString &prefix);
};
}
Q_DECLARE_METATYPE(BlackMisc::CVariantMap)
#endif