logos-protocol/cpp/logos_types.h

#ifndef LOGOS_TYPES_H
#define LOGOS_TYPES_H

#include <QDataStream>
#include <QVariant>
#include <stdexcept>

#include "logos_shared_api.h"

class LogosResultException : public std::runtime_error
{
public:
    using std::runtime_error::runtime_error;
};

struct LogosResult
{
    bool success;
    // Error message if success is false
    // Value can be retrieved like this:
    //
    // LogosResult result = someMethod();
    // if (result.success) {
    //     QString someValue = result.getValue<QString>();
    //     // OR
    //     QString someValue = result.getString();
    // }
    QVariant value;

    // LogosResult result = someMethod();
    // if (!result.success) {
    //     QString error = result.getError();
    // }
    QVariant error;

    template<typename T = QString>
    T getError() const
    {
        if (success) {
            throw LogosResultException("Attempted to get error from a successful LogosResult");
        }
        return error.value<T>();
    }

    template<typename T>
    T getValue() const
    {
        if (!success) {
            throw LogosResultException("Attempted to get value from a failed LogosResult: "
                                       + error.toString().toStdString());
        }
        return value.value<T>();
    }

    template<typename T>
    T getValue(const QString &key, T defaultValue = T()) const
    {
        const QVariantMap &map = getValue<QVariantMap>();
        if (!map.contains(key)) {
            return defaultValue;
        }
        return qvariant_cast<T>(map.value(key));
    }

    template<typename T>
    T getValue(int index, const QString &key, T defaultValue = T()) const
    {
        const QVariantList &list = getValue<QVariantList>();

        if (index < 0 || index >= list.size()) {
            return defaultValue;
        }

        return qvariant_cast<T>(list[index].toMap().value(key, defaultValue));
    }

    QString getString() const { return getValue<QString>(); }

    QString getString(const QString &key, const QString &defaultValue = "") const
    {
        return getValue<QString>(key, defaultValue);
    }

    QString getString(int index, const QString &key, const QString &defaultValue = "") const
    {
        return getValue<QString>(index, key, defaultValue);
    }

    bool getBool() const { return getValue<bool>(); }

    bool getBool(const QString &key) const { return getValue<bool>(key); }

    bool getBool(int index, const QString &key) const { return getValue<bool>(index, key); }

    int getInt() const { return getValue<int>(); }

    int getInt(const QString &key, int defaultValue = 0) const
    {
        return getValue<int>(key, defaultValue);
    }

    int getInt(int index, const QString &key, int defaultValue = 0) const
    {
        return getValue<int>(index, key, defaultValue);
    }

    QVariantList getList() const { return getValue<QVariantList>(); }

    QVariantList getList(const QString &key, const QVariantList &defaultValue = QVariantList()) const
    {
        return getValue<QVariantList>(key, defaultValue);
    }

    QVariantList getList(int index,
                         const QString &key,
                         const QVariantList &defaultValue = QVariantList()) const
    {
        return getValue<QVariantList>(index, key, defaultValue);
    }

    QVariantMap getMap() const { return getValue<QVariantMap>(); }

    QVariantMap getMap(const QString &key, const QVariantMap &defaultValue = QVariantMap()) const
    {
        return getValue<QVariantMap>(key, defaultValue);
    }

    QVariantMap getMap(int index,
                       const QString &key,
                       const QVariantMap &defaultValue = QVariantMap()) const
    {
        return getValue<QVariantMap>(index, key, defaultValue);
    }
};

// Provide (de)serialisation for being use as Remote Object.
//
// LOGOS_SHARED_API not because these hold state, but because they are the only
// out-of-line symbols in logos_types.cpp.obj: leaving them un-imported lets ld
// pull that object into a Windows consumer, and archive pull-in is transitive.
// The single-provider rule is per object file, not per class — see
// logos_shared_api.h.
LOGOS_SHARED_API QDataStream &operator<<(QDataStream &out, const LogosResult &result);
LOGOS_SHARED_API QDataStream &operator>>(QDataStream &in, LogosResult &result);

#endif