Address.hpp

#pragma once
#include <score/model/path/ObjectPath.hpp>
#include <score/serialization/DataStreamFwd.hpp>
#include <score/tools/std/Optional.hpp>
 
#include <ossia/detail/destination_index.hpp>
#include <ossia/detail/optional.hpp>
 
#include <QString>
#include <QStringList>
 
#include <score_lib_state_export.h>
 
#include <memory>
#include <verdigris>
namespace ossia
{
struct destination_qualifiers;
struct unit_t;
}
namespace score
{
struct DocumentContext;
}
class DataStreamReader;
class DataStreamWriter;
 
namespace State
{
struct SCORE_LIB_STATE_EXPORT Anchor
{
  ObjectPath target;
  QString member;
 
  QObject* resolve(const score::DocumentContext& ctx) const noexcept;
};
 
SCORE_LIB_STATE_EXPORT void
readAnchor(DataStreamReader& r, const std::shared_ptr<const Anchor>& a);
SCORE_LIB_STATE_EXPORT void
writeAnchor(DataStreamWriter& w, std::shared_ptr<const Anchor>& a);
 
struct SCORE_LIB_STATE_EXPORT DestinationQualifiers
{
  W_GADGET(DestinationQualifiers)
public:
  DestinationQualifiers() noexcept;
  DestinationQualifiers(const DestinationQualifiers& other);
  DestinationQualifiers(DestinationQualifiers&& other) noexcept;
  DestinationQualifiers& operator=(const DestinationQualifiers& other);
  DestinationQualifiers& operator=(DestinationQualifiers&& other) noexcept;
  ~DestinationQualifiers();
 
  DestinationQualifiers(const ossia::destination_qualifiers&);
  DestinationQualifiers& operator=(const ossia::destination_qualifiers&);
 
  operator const ossia::destination_qualifiers&() const noexcept;
  operator ossia::destination_qualifiers&() noexcept;
 
  bool operator==(const State::DestinationQualifiers& other) const noexcept;
  bool operator!=(const State::DestinationQualifiers& other) const noexcept;
 
  const ossia::destination_qualifiers& get() const noexcept;
  ossia::destination_qualifiers& get() noexcept;
 
private:
  std::unique_ptr<ossia::destination_qualifiers> qualifiers;
};
struct SCORE_LIB_STATE_EXPORT Address
{
  Address() noexcept;
  Address(const Address& other) noexcept;
  Address(Address&&) noexcept;
  Address& operator=(const Address& other) noexcept;
  Address& operator=(Address&& other) noexcept;
  Address(QString d, QStringList p) noexcept;
 
  // Data
  QString device; // No device means that this is the invisible root node.
 
  QStringList path; // Note : path is empty if address is root: "device:/"
  // In terms of Device::Node, this means that the node is the device node.
 
  std::shared_ptr<const Anchor> anchor;
 
  bool anchored() const noexcept { return bool(anchor); }
 
  // Check that the given string is a valid address
  // Note: a "maybe" concept would help here.
  static bool validateString(const QString& str);
  static bool validateFragment(const QString& s);
 
  // Make an address from a valid address string
  static std::optional<Address> fromString(const QString& str);
 
  QString toString() const;
 
  QString toString_unsafe() const;
 
  QString toShortString() const;
 
  bool isSet() const noexcept;
 
  bool operator==(const Address& a) const;
  bool operator!=(const Address& a) const;
};
 
using AccessorVector = ossia::destination_index;
SCORE_LIB_STATE_EXPORT
QString toString(const ossia::destination_qualifiers& d);
 
struct SCORE_LIB_STATE_EXPORT AddressAccessor
{
  AddressAccessor() noexcept;
  AddressAccessor(const AddressAccessor& other) noexcept;
  AddressAccessor(AddressAccessor&& other) noexcept;
  AddressAccessor& operator=(const AddressAccessor& other) noexcept;
  AddressAccessor& operator=(AddressAccessor&& other) noexcept;
 
  explicit AddressAccessor(State::Address a) noexcept;
  AddressAccessor(State::Address a, const AccessorVector& v) noexcept;
  AddressAccessor(
      State::Address a, const AccessorVector& v, const ossia::unit_t&) noexcept;
 
  AddressAccessor& operator=(const Address& a);
  AddressAccessor& operator=(Address&& a);
 
  State::Address address;
  DestinationQualifiers qualifiers;
 
  // Utility
  QString toString_unsafe() const;
  QString toString() const;
  QString toShortString() const;
 
  bool isSet() const noexcept;
 
  bool operator==(const AddressAccessor& other) const;
  bool operator!=(const AddressAccessor& a) const;
};
 
struct SCORE_LIB_STATE_EXPORT AddressAccessorHead
{
  QString name;
  DestinationQualifiers qualifiers;
 
  QString toString() const;
};
 
SCORE_LIB_STATE_EXPORT
bool addressIsChildOf(
    const State::Address& root, const State::Address& maybe_child) noexcept;
 
SCORE_LIB_STATE_EXPORT
State::Address replaceAddressPart(
    const State::Address& old, const State::Address& replacement) noexcept;
 
SCORE_LIB_STATE_EXPORT
State::AddressAccessor replaceAddressPart(
    const State::AddressAccessor& old, const State::Address& replacement) noexcept;
 
SCORE_LIB_STATE_EXPORT
void rerootAddress(
    State::Address& current, const State::Address& oldRoot,
    const State::Address& newRoot);
 
SCORE_LIB_STATE_EXPORT std::optional<State::Address> parseAddress(const QString& str);
SCORE_LIB_STATE_EXPORT std::optional<State::AddressAccessor>
parseAddressAccessor(const QString& str);
 
SCORE_LIB_STATE_EXPORT QDebug operator<<(QDebug d, const State::Address& a);
SCORE_LIB_STATE_EXPORT QDebug operator<<(QDebug d, const DestinationQualifiers& a);
SCORE_LIB_STATE_EXPORT QDebug operator<<(QDebug d, const State::AccessorVector& a);
SCORE_LIB_STATE_EXPORT QDebug operator<<(QDebug d, const State::AddressAccessorHead& a);
SCORE_LIB_STATE_EXPORT QDebug operator<<(QDebug d, const State::AddressAccessor& a);
SCORE_LIB_STATE_EXPORT QStringList stringList(const State::Address& addr);
}
 
namespace std
{
template <>
struct SCORE_LIB_STATE_EXPORT hash<State::Address>
{
  std::size_t operator()(const State::Address& k) const;
};
 
template <>
struct SCORE_LIB_STATE_EXPORT hash<State::AddressAccessor>
{
  std::size_t operator()(const State::AddressAccessor& k) const;
};
}
 
SCORE_SERIALIZE_DATASTREAM_DECLARE(SCORE_LIB_STATE_EXPORT, State::DestinationQualifiers)
SCORE_SERIALIZE_DATASTREAM_DECLARE(SCORE_LIB_STATE_EXPORT, State::Address)
SCORE_SERIALIZE_DATASTREAM_DECLARE(SCORE_LIB_STATE_EXPORT, State::AddressAccessor)
 
Q_DECLARE_METATYPE(State::DestinationQualifiers)
Q_DECLARE_METATYPE(State::Address)
Q_DECLARE_METATYPE(State::AddressAccessor)
 
W_REGISTER_ARGTYPE(State::DestinationQualifiers)
W_REGISTER_ARGTYPE(State::Address)
W_REGISTER_ARGTYPE(State::AddressAccessor)