object.h

Go to the documentation of this file.

// === object.h ========================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_CORE_OBJ_OBJECT_H
#define SEN_CORE_OBJ_OBJECT_H
 
// sen
#include "sen/core/base/compiler_macros.h"
#include "sen/core/base/strong_type.h"
#include "sen/core/base/timestamp.h"
#include "sen/core/io/input_stream.h"
#include "sen/core/io/output_stream.h"
#include "sen/core/meta/event.h"
#include "sen/core/meta/method.h"
#include "sen/core/meta/property.h"
#include "sen/core/meta/type.h"
#include "sen/core/meta/var.h"
#include "sen/core/obj/callback.h"
#include "sen/core/obj/connection_guard.h"
 
// std
#include <cstdint>
#include <memory>
#include <string_view>
 
namespace sen
{
class NativeObject;
}  // namespace sen
 
namespace sen::impl
{
class ProxyObject;
template <typename... T>
class EventBuffer;
void writeAllPropertiesToStream(const Object* instance, OutputStream& out);
}  // namespace sen::impl
 
namespace sen
{


enum class Emit
{
  now,       
  onCommit,  
};
 
SEN_STRONG_TYPE(ConnId, uint32_t)
 
template <>
struct ShouldBePassedByValue<ConnId>: std::true_type
{
};

SEN_STRONG_TYPE(ObjectId, uint32_t)
 
template <>
struct ShouldBePassedByValue<ObjectId>: std::true_type
{
};
 
// Forward declarations
class ClassType;

class SEN_EXPORT Object: public std::enable_shared_from_this<Object>
{
  SEN_NOCOPY_NOMOVE(Object)
 
public:
  Object() = default;
  virtual ~Object() = default;
 
public:
  [[nodiscard]] virtual const std::string& getName() const noexcept = 0;

  [[nodiscard]] virtual ObjectId getId() const noexcept = 0;

  // [[nodiscard]] virtual const ClassType* getClass() const noexcept = 0;
  [[nodiscard]] virtual ConstTypeHandle<ClassType> getClass() const noexcept = 0;

  [[nodiscard]] virtual NativeObject* asNativeObject() noexcept { return nullptr; }

  [[nodiscard]] virtual const NativeObject* asNativeObject() const noexcept { return nullptr; }

  [[nodiscard]] virtual impl::ProxyObject* asProxyObject() noexcept { return nullptr; }

  [[nodiscard]] virtual const impl::ProxyObject* asProxyObject() const noexcept { return nullptr; }

  [[nodiscard]] virtual const std::string& getLocalName() const noexcept = 0;

  [[nodiscard]] virtual TimeStamp getLastCommitTime() const noexcept = 0;
 
public:  // Reflection-based interface (do not use for real-time applications)
  [[nodiscard]] virtual Var getPropertyUntyped(const Property* prop) const = 0;

  virtual void invokeUntyped(const Method* method, const VarList& args, MethodCallback<Var>&& onDone = {}) = 0;

  [[nodiscard]] virtual ConnectionGuard onPropertyChangedUntyped(const Property* prop,
                                                                 EventCallback<VarList>&& callback) = 0;

  [[nodiscard]] virtual ConnectionGuard onEventUntyped(const Event* ev, EventCallback<VarList>&& callback) = 0;

  virtual void invokeAllPropertyCallbacks() = 0;
 
protected:
  friend class ConnectionGuard;
  virtual void senImplRemoveTypedConnection(ConnId id) = 0;
  virtual void senImplRemoveUntypedConnection(ConnId id, MemberHash memberHash) = 0;
 
protected:
  template <typename... T>
  friend class impl::EventBuffer;
 
  virtual void senImplEventEmitted(MemberHash id, std::function<VarList()>&& argsGetter, const EventInfo& info) = 0;

  [[nodiscard]] ObjectId senImplMakeId(std::string_view objectName) const;

  [[nodiscard]] ConnectionGuard senImplMakeConnectionGuard(ConnId id, MemberHash member, bool typed);

  static void senImplValidateName(std::string_view name);

  [[nodiscard]] static std::string senImplComputeLocalName(std::string_view name, std::string_view prefix);
 
protected:
  friend void impl::writeAllPropertiesToStream(const Object* instance, OutputStream& out);

  virtual void senImplWriteAllPropertiesToStream(OutputStream& out) const = 0;

  virtual void senImplWriteStaticPropertiesToStream(OutputStream& out) const = 0;

  virtual void senImplWriteDynamicPropertiesToStream(OutputStream& out) const = 0;
};

 
}  // namespace sen
 
SEN_STRONG_TYPE_HASHABLE(::sen::ConnId)
SEN_STRONG_TYPE_HASHABLE(::sen::ObjectId)
 
#endif  // SEN_CORE_OBJ_OBJECT_H