Message.h

Go to the documentation of this file.

// File: Message.h
// Description: The base class of all messages. All derived messages should hold information, this class exists
//               so we can polymorphically pass around messages
// Author(s): Ori Balashov (ori.balashov@digipen.edu)
// 2025 / 10 / 24
// (C) Digipen 2025
//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
#pragma once
#include <memory>
#include "System/json.h"
 
namespace sys
{
class Json;
}
 
using Stream = sys::Json;
 
 
#define MSG_CLONE(MessageClass) auto clone() const -> std::unique_ptr<Message> override \
{ \
    return std::make_unique<MessageClass>(*this); \
}
 
// Note: This implementation is inspired by Ravi Richards' (Man O' Ware) Message class, although no code has been copied
 
struct Message
{
 
    Message()                                            = default;
    Message(const Message& other)                        = default;
    Message(Message&& other) noexcept                    = default;
    auto operator=(const Message& other) -> Message&     = default;
    auto operator=(Message&& other) noexcept -> Message& = default;
    virtual ~Message()                                   = default;
 
    auto virtual clone() const -> std::unique_ptr<Message>
    {
        return std::make_unique<Message>(*this);
    }
 
    virtual auto load(Stream& stream) -> void;
    virtual auto save(Stream& stream) const -> void;
 

    template <typename T>
    auto convertMessageTo() const -> const T*
    {
        return dynamic_cast<const T*>(this);
    }
 
    // Holds no data
};