interest.h

Go to the documentation of this file.

// === interest.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_INTEREST_H
#define SEN_CORE_OBJ_INTEREST_H
 
// sen
#include "sen/core/base/compiler_macros.h"
#include "sen/core/base/strong_type.h"
#include "sen/core/lang/vm.h"
#include "sen/core/meta/class_type.h"
#include "sen/core/meta/type.h"
#include "sen/core/meta/type_registry.h"
 
// std
#include <memory>
#include <mutex>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <variant>
 
namespace sen
{


SEN_STRONG_TYPE(InterestId, uint32_t)
 
template <>
struct ShouldBePassedByValue<InterestId>: std::true_type
{
};

using TypeCondition = std::variant<std::monostate, ConstTypeHandle<ClassType>, std::string>;

struct BusSpec
{
  std::string sessionName;
  std::string busName;
};

[[nodiscard]] std::string asString(const BusSpec& spec);

using BusCondition = std::optional<BusSpec>;

[[nodiscard]] std::string_view extractQualifiedTypeName(const TypeCondition& condition);

struct VarInfo
{
  const Property* property = nullptr;
  std::vector<uint16_t> fieldIndexes;
};

using VarInfoList = std::vector<VarInfo>;

class Interest: public std::enable_shared_from_this<Interest>
{
public:
  SEN_NOCOPY_NOMOVE(Interest)
  SEN_PRIVATE_TAG
 
public:
  [[nodiscard]] static std::shared_ptr<Interest> make(std::string_view query, const CustomTypeRegistry& typeRegistry);
 
  ~Interest() = default;
 
public:
  [[nodiscard]] const TypeCondition& getTypeCondition() const noexcept;

  [[nodiscard]] InterestId getId() const noexcept;

  [[nodiscard]] const lang::Chunk& getQueryCode() const noexcept;

  [[nodiscard]] const std::string& getQueryString() const noexcept;

  [[nodiscard]] const BusCondition& getBusCondition() const noexcept;

  [[nodiscard]] const VarInfoList& getOrComputeVarInfoList(const ClassType* classType) const;
 
public:
  [[nodiscard]] bool operator==(const Interest& other) const noexcept;
  [[nodiscard]] bool operator!=(const Interest& other) const noexcept;
 
public:
  Interest(std::string_view query, const CustomTypeRegistry& typeRegistry, Private notUsable);
 
private:
  std::string queryString_;
  BusCondition busCondition_;
  TypeCondition type_;
  lang::Chunk code_;
  InterestId id_;
  mutable std::mutex varInfoListMutex_;
 
  // An interest with no type condition sees every class on the bus, and a VarInfo holds field
  // positions taken from one of them. An empty optional marks a class the query cannot resolve.
  mutable std::unordered_map<MemberHash, std::optional<VarInfoList>> varInfoLists_;
};

 
}  // namespace sen
 
SEN_STRONG_TYPE_HASHABLE(sen::InterestId)
 
#endif  // SEN_CORE_OBJ_INTEREST_H