ToolsExtraInfoMessage.h

//
// Copyright 2016 - 2025 (C). Alex Robenko. All rights reserved.
//
 
// This file 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.
//
// This program 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, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
#include "cc_tools_qt/ToolsMessageBase.h"
#include "cc_tools_qt/ToolsProtMsgInterface.h"
#include "cc_tools_qt/version.h"
 
#include "comms/field/String.h"
 
#include <QtCore/QString>
#include <QtCore/QJsonObject>
#include <QtCore/QJsonDocument>
#include <QtCore/QByteArray>
 
#include <cassert>
#include <tuple>
 
namespace cc_tools_qt
{
 
namespace details
{
 
template <typename TFieldBase>
class ToolsExtraInfoMessageData : public
    comms::field::String<
        TFieldBase,
        comms::option::def::HasName
    >
{
    using Base =
        comms::field::String<
            TFieldBase,
            comms::option::def::HasName
        >;
public:
    static const char* name()
    {
        return "";
    }
 
    bool valid() const
    {
        auto& val = Base::value();
        if (val.empty()) {
            return true;
        }
 
        auto doc = QJsonDocument::fromJson(QByteArray(val.c_str(), static_cast<int>(val.size())));
        return doc.isObject();
    }
};
 
template <typename TMsgBase, typename...>
class ToolsExtraInfoMessageImpl : public
    comms::MessageBase<
        TMsgBase,
        comms::option::NoIdImpl,
        comms::option::FieldsImpl<std::tuple<ToolsExtraInfoMessageData<typename TMsgBase::Field>>>,
        comms::option::MsgType<ToolsExtraInfoMessageImpl<TMsgBase>>
    >
{
 
};
 
}  // namespace details
 
template<typename TBase>
class ToolsExtraInfoMessage : public
    cc_tools_qt::ToolsMessageBase<
        TBase,
        details::ToolsExtraInfoMessageImpl,
        ToolsExtraInfoMessage<TBase>
    >
{
    using Base =
        cc_tools_qt::ToolsMessageBase<
            TBase,
            details::ToolsExtraInfoMessageImpl,
            ToolsExtraInfoMessage<TBase>
        >;
public:
    using FieldsList = typename Base::FieldsList;
 
    virtual ~ToolsExtraInfoMessage() noexcept = default;
 
protected:
    virtual const char* nameImpl() const override
    {
        static const char* Str = "Generic Extra Info Message";
        return Str;
    }
 
    virtual void resetImpl() override
    {
        [[maybe_unused]] static constexpr bool Must_not_be_called = false;
        assert(Must_not_be_called);
    }
 
    virtual bool assignImpl([[maybe_unused]] const cc_tools_qt::ToolsMessage& other) override
    {
        [[maybe_unused]] static constexpr bool Must_not_be_called = false;
        assert(Must_not_be_called);
        return false;
    }
 
    virtual FieldsList transportFieldsImpl() override
    {
        return FieldsList();
    }
 
    virtual FieldsList payloadFieldsImpl() override
    {
        auto fields = Base::payloadFieldsImpl();
        for (auto& f : fields) {
            f->forceHiddenSerialization();
        }
        return fields;
    }
 
private:
};
 
}  // namespace cc_tools_qt