/******************************************************************************** * * * This file is part of IfcOpenShell. * * * * IfcOpenShell is free software: you can redistribute it and/or modify * * it under the terms of the Lesser GNU General Public License as published by * * the Free Software Foundation, either version 3.0 of the License, or * * (at your option) any later version. * * * * IfcOpenShell is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * Lesser GNU General Public License for more details. * * * * You should have received a copy of the Lesser GNU General Public License * * along with this program. If not, see . * * * ********************************************************************************/ #ifndef InstanceData_H #define InstanceData_H #include "express.h" #include "ArgumentType.h" #include "variantarray.h" #include "IfcSchema.h" #include "storage.h" #ifdef IFOPSH_WITH_ROCKSDB #pragma push_macro("Handle") #undef Handle #include #pragma pop_macro("Handle") #endif #include #include class IFC_PARSE_API EnumerationReference { private: const IfcParse::enumeration_type* enumeration_; size_t index_; public: EnumerationReference(const IfcParse::enumeration_type* enumeration = nullptr, size_t index = 0) : enumeration_(enumeration) , index_(index) {} const char* value() const { return enumeration_->lookup_enum_value(index_); } size_t index() const { return index_; } const IfcParse::enumeration_type* enumeration() const { return enumeration_; } }; class IFC_PARSE_API Blank {}; class IFC_PARSE_API Derived {}; class IFC_PARSE_API empty_aggregate_t {}; class IFC_PARSE_API empty_aggregate_of_aggregate_t {}; template struct parameter_pack { static constexpr size_t size = sizeof...(Args); }; typedef parameter_pack < // A null argument, it will always serialize to $ Blank, // @todo Derived is not really necessary anymore, just serialize correctly based on schema // A derived argument, it will always serialize to * Derived, // An integer argument, e.g. 123 // SCALARS: int, // A boolean argument, it will serialize to either .T. or .F. bool, // A logical argument, it will serialize to either .T. or .F. or .U. boost::logic::tribool, // A floating point argument, e.g. 12.3 double, // A character string argument, e.g. 'IfcOpenShell' std::string, // A binary argument, e.g. "092A" -> 100100101010 boost::dynamic_bitset<>, // An enumeration argument, e.g. .USERDEFINED. // To initialize the argument a string representation // has to be explicitly passed of the enumeration value // which is stored internally as an integer. The argument // itself does not keep track of what schema enumeration // type is represented. EnumerationReference, // An entity instance argument. It will either serialize to // e.g. #123 or datatype identifier for simple types, e.g. // IFCREAL(12.3) express::Base, // AGGREGATES: empty_aggregate_t, // An aggregate of integers, e.g. (1,2,3) std::vector, // An aggregate of floats, e.g. (12.3,4.) std::vector, // An aggregate of strings, e.g. ('Ifc','Open','Shell') std::vector, // An aggregate of binaries, e.g. ("23B", "092A") -> (111011, 100100101010) std::vector>, // An aggregate of entity instances. It will either serialize to // e.g. (#1,#2,#3) or datatype identifier for simple types, // e.g. (IFCREAL(1.2),IFCINTEGER(3.)) std::vector, // AGGREGATES OF AGGREGATES: empty_aggregate_of_aggregate_t, // An aggregate of an aggregate of ints. E.g. ((1, 2), (3)) std::vector>, // An aggregate of an aggregate of floats. E.g. ((1., 2.3), (4.)) std::vector>, // An aggregate of an aggregate of entities. E.g. ((#1, #2), (#3)) std::vector>> type_variant_parameter_pack; template struct pack_to_variant_array; template struct pack_to_variant_array> { using type = VariantArray; }; using in_memory_attribute_storage = pack_to_variant_array::type; template struct TypeEncoder_t; template struct TypeEncoder_t> { template static char encode_type() { return 'A' + ::impl::TypeIndex_v; } }; using TypeEncoder = TypeEncoder_t; class IFC_PARSE_API MutableAttributeValue { public: uint32_t name_; uint8_t index_; }; namespace IfcParse { namespace impl { class IFC_PARSE_API rocks_db_file_storage; } } #ifdef IFOPSH_WITH_ROCKSDB namespace impl { // Trait to detect contiguous containers (vector / string) template struct is_contiguous_container : std::false_type {}; template struct is_contiguous_container> : std::true_type {}; template struct is_contiguous_container> : std::true_type {}; template ::value && !is_contiguous_container::value, int>::type = 0> bool serialize(std::string& val, const T& t) { auto s = sizeof(typename T::value_type) * t.size(); val.resize(s + 1); val[0] = TypeEncoder::encode_type(); memcpy(val.data() + 1, t.data(), s); return true; } template ::value&& is_contiguous_container::value, int>::type = 0> bool serialize(std::string& val, const T& t) { val = std::string(1, TypeEncoder::encode_type()); for (auto& tt : t) { std::string v2; serialize(v2, tt); std::string len(sizeof(size_t), 0); size_t s = v2.size() - 1; memcpy(len.data(), &s, sizeof(size_t)); // @todo horribly inefficient // @todo strip off type label? val += len + v2.substr(1); } return true; } template || std::is_floating_point_v, int>::type = 0> bool serialize(std::string& val, const T& t) { val.resize(sizeof(T) + 1); val[0] = TypeEncoder::encode_type(); memcpy(val.data() + 1, &t, sizeof(T)); return true; } bool serialize(std::string& val, const Blank& t); bool serialize(std::string& val, const Derived& t); bool serialize(std::string& val, const empty_aggregate_t& t); bool serialize(std::string& val, const empty_aggregate_of_aggregate_t& t); bool serialize(std::string& val, const boost::logic::tribool& t); bool serialize(std::string& val, const boost::dynamic_bitset<>& t); bool serialize(std::string& val, const express::Base& t); bool serialize(std::string& val, const EnumerationReference& v); bool serialize(std::string& val, const std::vector& t); bool serialize(std::string& val, const std::vector>& t); template ::value && !is_contiguous_container::value, int>::type = 0> bool deserialize(IfcParse::impl::rocks_db_file_storage*, const std::string& val, T& t, bool prefixed = true) { if (prefixed && val[0] != TypeEncoder::encode_type()) { return false; } auto s = (val.size() - (prefixed ? 1 : 0)) / sizeof(typename T::value_type); t.resize(s); memcpy(t.data(), val.data() + (prefixed ? 1 : 0), s * sizeof(typename T::value_type)); return true; } template ::value && is_contiguous_container::value, int>::type = 0> bool deserialize(IfcParse::impl::rocks_db_file_storage* storage, const std::string& val, T& t) { // @todo auto ptr = val.data(); if (*ptr != TypeEncoder::encode_type()) { return false; } ptr++; t.clear(); while (ptr < val.data() + val.size()) { size_t s; memcpy(&s, ptr, sizeof(size_t)); // @todo view ptr += sizeof(size_t); std::string part(ptr, s); t.emplace_back(); deserialize(storage, part, t.back(), false); ptr += s; } return true; } template || std::is_floating_point_v, int>::type = 0> bool deserialize(IfcParse::impl::rocks_db_file_storage*, const std::string& val, T & t) { if (val[0] != TypeEncoder::encode_type()) { return false; } memcpy(&t, val.data() + 1, sizeof(T)); return true; } bool deserialize(IfcParse::impl::rocks_db_file_storage*, const std::string& val, boost::logic::tribool& t); bool deserialize(IfcParse::impl::rocks_db_file_storage*, const std::string& val, boost::dynamic_bitset<>& t); bool deserialize(IfcParse::impl::rocks_db_file_storage*, const std::string& val, std::vector& t); bool deserialize(IfcParse::impl::rocks_db_file_storage*, const std::string& val, std::vector>& t); } #endif // short lived class IFC_PARSE_API AttributeValue { uint8_t index_; uint8_t storage_model_ = 0; const IfcParse::declaration* entity_or_type_ = 0; size_t instance_name_; public: union pointer_type { const in_memory_attribute_storage* storage_ptr; IfcParse::impl::rocks_db_file_storage* db_ptr; pointer_type(IfcParse::impl::rocks_db_file_storage* db) : db_ptr(db) {} pointer_type(const in_memory_attribute_storage* ims) : storage_ptr(ims) {} }; private: pointer_type array_; public: AttributeValue() : index_(0) , storage_model_(0) , array_((const in_memory_attribute_storage*)nullptr) {} AttributeValue(const in_memory_attribute_storage* arr, uint8_t index) : index_(index) , storage_model_(0) , array_(arr) {} AttributeValue(IfcParse::impl::rocks_db_file_storage* db, size_t instance_name, const IfcParse::declaration* entity_or_type, uint8_t index) : index_(index) , storage_model_(1) , entity_or_type_(entity_or_type) , instance_name_(instance_name) , array_(db) {} operator int() const; operator bool() const; operator boost::logic::tribool() const; operator double() const; operator std::string() const; operator boost::dynamic_bitset<>() const; operator express::Base() const; operator std::vector() const; operator std::vector() const; operator std::vector() const; operator std::vector>() const; operator std::vector() const; operator std::vector>() const; operator std::vector>() const; operator std::vector>() const; operator EnumerationReference() const; bool isNull() const; unsigned int size() const; IfcUtil::ArgumentType type() const; template auto apply_visitor(Visitor&& visitor) const { switch (type()) { case IfcUtil::Argument_DERIVED: return visitor(Derived{}); case IfcUtil::Argument_INT: return visitor((int)*this); case IfcUtil::Argument_BOOL: return visitor((bool)*this); case IfcUtil::Argument_LOGICAL: { boost::logic::tribool tb = *this; return visitor(tb); } case IfcUtil::Argument_DOUBLE: return visitor((double)*this); case IfcUtil::Argument_STRING: return visitor((std::string)*this); case IfcUtil::Argument_BINARY: return visitor((boost::dynamic_bitset<>)*this); case IfcUtil::Argument_ENUMERATION: return visitor((EnumerationReference)*this); case IfcUtil::Argument_ENTITY_INSTANCE: return visitor((express::Base) * this); case IfcUtil::Argument_AGGREGATE_OF_INT: return visitor((std::vector)*this); case IfcUtil::Argument_AGGREGATE_OF_DOUBLE: return visitor((std::vector)*this); case IfcUtil::Argument_AGGREGATE_OF_STRING: return visitor((std::vector)*this); case IfcUtil::Argument_AGGREGATE_OF_BINARY: return visitor((std::vector>)*this); case IfcUtil::Argument_AGGREGATE_OF_ENTITY_INSTANCE: return visitor((std::vector)*this); case IfcUtil::Argument_AGGREGATE_OF_AGGREGATE_OF_INT: return visitor((std::vector>)*this); case IfcUtil::Argument_AGGREGATE_OF_AGGREGATE_OF_DOUBLE: return visitor((std::vector>)*this); case IfcUtil::Argument_AGGREGATE_OF_AGGREGATE_OF_ENTITY_INSTANCE: return visitor((std::vector>)*this); case IfcUtil::Argument_EMPTY_AGGREGATE: return visitor(empty_aggregate_t{}); case IfcUtil::Argument_AGGREGATE_OF_EMPTY_AGGREGATE: return visitor(empty_aggregate_of_aggregate_t{}); default: return visitor(Blank{}); } } }; struct IFC_PARSE_API rocks_db_attribute_storage { public: #ifdef IFOPSH_WITH_ROCKSDB // @todo void* is obviously very ugly here template IFC_PARSE_API void set(void* storage, const IfcParse::declaration*, std::size_t identity, std::size_t index, const T& value); template IFC_PARSE_API bool has(void* storage, const IfcParse::declaration* decl, std::size_t identity, std::size_t index) const; template auto apply_visitor(void* storage, const IfcParse::declaration* decl, std::size_t identity, std::size_t index, Visitor&& visitor) const { // @todo do we need visitation on all data/storage/attribute levels? AttributeValue((IfcParse::impl::rocks_db_file_storage*)storage, identity, decl, (uint8_t) index).apply_visitor(std::forward(visitor)); } #endif }; class IFC_PARSE_API InstanceData { protected: static std::atomic_uint32_t counter_; IfcParse::IfcFile* file_; // @todo this could also be a 2-byte index, because we can get the schema from the file. But it wouldn't save space due to alignment const IfcParse::declaration* declaration_; uint32_t identity_; uint32_t id_; template T* get_storage_of_type() const { return std::visit([this](auto& m) -> T* { if constexpr (std::is_same_v, T>) { return &m; } return nullptr; }, file()->storage_); } public: // Since rocks_db_attribute_storage has no members this is not a variant but in_memory*, where nullptr means a rocks_db_attribute_storage is constructed on the fly given the context from instance data. in_memory_attribute_storage* storage_; const IfcParse::declaration* declaration() const { return declaration_; } IfcParse::IfcFile* file() const { return file_; } uint32_t identity() const { return identity_; } uint32_t id() const { return id_; } InstanceData(IfcParse::IfcFile* file, const IfcParse::declaration* declaration, uint32_t id, in_memory_attribute_storage&& storage) : file_(file), declaration_(declaration), identity_(counter_++), id_(id), storage_(new in_memory_attribute_storage(std::move(storage))) {} InstanceData(IfcParse::IfcFile* file, const IfcParse::declaration* declaration, uint32_t id, rocks_db_attribute_storage&&) : file_(file), declaration_(declaration), identity_(counter_++), id_(id), storage_(nullptr) {} /* // now that there are referenced as shared_ptr there is no move constructor anymore InstanceData(InstanceData&& other) noexcept : file_(other.file_), id_(other.id_), declaration_(other.declaration_), storage_(std::exchange(other.storage_, nullptr)) {} */ // No copy-constructor/-assignment anymore because we need the instance for storage model context InstanceData(const InstanceData&) = delete; InstanceData& operator=(const InstanceData&) = delete; InstanceData& operator=(InstanceData&&) = delete; InstanceData(InstanceData&& other) noexcept = delete; /* // same InstanceData& operator=(InstanceData&& other) noexcept { if (this != &other) { delete storage_; storage_ = std::exchange(other.storage_, nullptr); } return *this; } */ ~InstanceData() { delete storage_; } AttributeValue get_attribute_value(size_t index) const; template void set_attribute_value(std::size_t index, T&& value) { if (storage_) { storage_->set(index, value); } #ifdef IFOPSH_WITH_ROCKSDB else { rocks_db_attribute_storage{}.set(get_storage_of_type(), declaration_, identity_, index, value); } #endif } template bool has_attribute_value(std::size_t index) const { if (storage_) { return storage_->has(index); } #ifdef IFOPSH_WITH_ROCKSDB else { return rocks_db_attribute_storage{}.has(get_storage_of_type(), declaration_, identity_, index); } #endif } template auto apply_visitor(Visitor&& visitor, std::size_t index) const { if (storage_) { return storage_->apply_visitor(std::forward(visitor), index); } #ifdef IFOPSH_WITH_ROCKSDB else { return rocks_db_attribute_storage{}.apply_visitor(get_storage_of_type(), declaration_, identity_, index, std::forward(visitor)); } #endif } void toString(std::ostream&, bool upper = false) const; }; #endif