Code/Engine/Foundation/IO/SerializationContext.h - dev - redgpu/ezEngine

Code/Engine/Foundation/IO/SerializationContext.h
44 строки3 KB
Jan Krassnigg
Remove circular includes in Basics.h (#1318)
04 июн 2024, 22:07
04 июн 2024, 22:07dab7d29

#pragma once

/// \brief Base class for serialization contexts. A serialization context can be used to add high level logic to serialization, e.g.
/// de-duplicating objects.
///
/// Typically a context is created before any serialization happens and can then be accessed anywhere through the GetContext method.
template <typename Derived>
class ezSerializationContext
{
  EZ_DISALLOW_COPY_AND_ASSIGN(ezSerializationContext);

public:
  ezSerializationContext() { Derived::SetContext(this); }
  ~ezSerializationContext() { Derived::SetContext(nullptr); }

  /// \brief Set the context as active which means it can be accessed via GetContext in serialization methods.
  ///
  /// It can be useful to manually set a context as active if a serialization process is spread across multiple scopes
  /// and other serialization can happen in between.
  void SetActive(bool bActive) { Derived::SetContext(bActive ? this : nullptr); }
};

/// \brief Declares the necessary functions to access a serialization context
#define EZ_DECLARE_SERIALIZATION_CONTEXT(type) \
public:                                        \
  static type* GetContext();                   \
                                               \
protected:                                     \
  friend class ezSerializationContext<type>;   \
  static void SetContext(ezSerializationContext* pContext);


/// \brief Implements the necessary functions to access a serialization context through GetContext.
#define EZ_IMPLEMENT_SERIALIZATION_CONTEXT(type)                                                                                        \
  thread_local type* EZ_PP_CONCAT(s_pActiveContext, type);                                                                              \
  type* type::GetContext()                                                                                                              \
  {                                                                                                                                     \
    return EZ_PP_CONCAT(s_pActiveContext, type);                                                                                        \
  }                                                                                                                                     \
  void type::SetContext(ezSerializationContext* pContext)                                                                               \
  {                                                                                                                                     \
    EZ_ASSERT_DEV(pContext == nullptr || EZ_PP_CONCAT(s_pActiveContext, type) == nullptr, "Only one context can be active at a time."); \
    EZ_PP_CONCAT(s_pActiveContext, type) = static_cast<type*>(pContext);                                                                \
  }