datatype.hpp

Go to the documentation of this file.

#pragma once
 
#include <algorithm>  // transform
#include <cassert>
#include <cstdint>
#include <iterator>  // prev
#include <type_traits>
#include <utility>  // move
#include <vector>
 
#include "open62541pp/common.hpp"  // TypeIndex
#include "open62541pp/config.hpp"
#include "open62541pp/detail/open62541/common.h"
#include "open62541pp/detail/traits.hpp"
#include "open62541pp/span.hpp"
#include "open62541pp/typeregistry.hpp"  // getDataType
#include "open62541pp/types.hpp"  // NodeId
#include "open62541pp/wrapper.hpp"
 
namespace opcua {
 
using DataTypeMember = UA_DataTypeMember;
 
/**
 * UA_DataType wrapper class.
 * @ingroup Wrapper
 */
class DataType : public Wrapper<UA_DataType> {
public:
    constexpr DataType() = default;
 
    explicit DataType(const UA_DataType& native);
    explicit DataType(UA_DataType&& native);
    explicit DataType(TypeIndex typeIndex);
 
    ~DataType();
 
    DataType(const DataType& other);
    DataType(DataType&& other) noexcept;
 
    DataType& operator=(const DataType& other);
    DataType& operator=(DataType&& other) noexcept;
 
    const char* typeName() const noexcept {
#ifdef UA_ENABLE_TYPEDESCRIPTION
        return handle()->typeName;
#else
        return nullptr;
#endif
    }
 
    /// @deprecated Use typeName() instead
    [[deprecated("use typeName() instead")]]
    const char* getTypeName() const noexcept {
        return typeName();
    }
 
    void setTypeName([[maybe_unused]] const char* typeName) noexcept {
#ifdef UA_ENABLE_TYPEDESCRIPTION
        handle()->typeName = typeName;
#endif
    }
 
    NodeId typeId() const noexcept {
        return NodeId(handle()->typeId);  // NOLINT
    }
 
    /// @deprecated Use typeId() instead
    [[deprecated("use typeId() instead")]]
    NodeId getTypeId() const noexcept {
        return typeId();
    }
 
    void setTypeId(NodeId typeId) {
        asWrapper<NodeId>(handle()->typeId) = std::move(typeId);
    }
 
    NodeId binaryEncodingId() const noexcept {
#if UAPP_OPEN62541_VER_GE(1, 2)
        return NodeId(handle()->binaryEncodingId);  // NOLINT
#else
        return NodeId(handle()->typeId.namespaceIndex, handle()->binaryEncodingId);  // NOLINT
#endif
    }
 
    /// @deprecated Use binaryEncodingId() instead
    [[deprecated("use binaryEncodingId() instead")]]
    NodeId getBinaryEncodingId() const noexcept {
        return binaryEncodingId();
    }
 
    void setBinaryEncodingId(NodeId binaryEncodingId) {
#if UAPP_OPEN62541_VER_GE(1, 2)
        asWrapper<NodeId>(handle()->binaryEncodingId) = std::move(binaryEncodingId);
#else
        handle()->binaryEncodingId = binaryEncodingId.identifier<uint32_t>();
#endif
    }
 
    uint16_t memSize() const noexcept {
        return handle()->memSize;
    }
 
    /// @deprecated Use memSize() instead
    [[deprecated("use memSize() instead")]]
    uint16_t getMemSize() const noexcept {
        return memSize();
    }
 
    void setMemSize(uint16_t memSize) noexcept {
        handle()->memSize = memSize;
    }
 
    uint8_t typeKind() const noexcept {
        return handle()->typeKind;
    }
 
    /// @deprecated Use typeKind() instead
    [[deprecated("use typeKind() instead")]]
    uint8_t getTypeKind() const noexcept {
        return typeKind();
    }
 
    void setTypeKind(uint8_t typeKind) noexcept {
        handle()->typeKind = typeKind;
    }
 
    bool pointerFree() const noexcept {
        return handle()->pointerFree;
    }
 
    /// @deprecated Use pointerFree() instead
    [[deprecated("use pointerFree() instead")]]
    bool getPointerFree() const noexcept {
        return pointerFree();
    }
 
    void setPointerFree(bool pointerFree) noexcept {
        handle()->pointerFree = pointerFree;
    }
 
    bool overlayable() const noexcept {
        return handle()->overlayable;
    }
 
    /// @deprecated Use overlayable() instead
    [[deprecated("use overlayable() instead")]]
    bool getOverlayable() const noexcept {
        return overlayable();
    }
 
    void setOverlayable(bool overlayable) noexcept {
        handle()->overlayable = overlayable;
    }
 
    Span<const DataTypeMember> members() const noexcept {
        return {handle()->members, handle()->membersSize};
    }
 
    /// @deprecated Use members() instead
    [[deprecated("use members() instead")]]
    Span<const DataTypeMember> getMembers() const noexcept {
        return members();
    }
 
    void setMembers(Span<const DataTypeMember> members);
};
 
/// @relates DataType
inline bool operator==(const UA_DataType& lhs, const UA_DataType& rhs) noexcept {
    return lhs.typeId == rhs.typeId;
}
 
/// @relates DataType
inline bool operator!=(const UA_DataType& lhs, const UA_DataType& rhs) noexcept {
    return !(lhs == rhs);
}
 
/// @relates DataType
inline bool operator==(const UA_DataTypeMember& lhs, const UA_DataTypeMember& rhs) noexcept {
#if UAPP_OPEN62541_VER_GE(1, 3)
    if (lhs.memberType == nullptr || rhs.memberType == nullptr) {
        return false;
    }
    return (lhs.memberType == rhs.memberType) || (*lhs.memberType == *rhs.memberType);
#else
    return lhs.memberTypeIndex == rhs.memberTypeIndex;
#endif
}
 
/// @relates DataType
inline bool operator!=(const UA_DataTypeMember& lhs, const UA_DataTypeMember& rhs) noexcept {
    return !(lhs == rhs);
}
 
/* ------------------------------------------- Helper ------------------------------------------- */
 
namespace detail {
 
[[nodiscard]] UA_DataTypeMember createDataTypeMember(
    const char* memberName,
    const UA_DataType& memberType,
    uint8_t padding,
    bool isArray,
    bool isOptional
) noexcept;
 
[[nodiscard]] UA_DataType createDataType(
    const char* typeName,
    UA_NodeId typeId,
    UA_NodeId binaryEncodingId,
    uint16_t memSize,
    uint8_t typeKind,
    bool pointerFree,
    bool overlayable,
    uint32_t membersSize,
    DataTypeMember* members
) noexcept;
 
[[nodiscard]] UA_DataTypeArray createDataTypeArray(
    Span<const DataType> types, const UA_DataTypeArray* next = nullptr
) noexcept;
 
}  // namespace detail
 
/* --------------------------------------- DataTypeBuilder -------------------------------------- */
 
namespace detail {
 
template <auto memberPtr>
const UA_DataType& getMemberDataType() {
    using TMember = detail::MemberTypeT<decltype(memberPtr)>;
    return getDataType<std::remove_pointer_t<TMember>>();
}
 
// https://gist.github.com/graphitemaster/494f21190bb2c63c5516
template <typename T, typename TMember>
size_t offsetOfMember(TMember T::*member) {
    static T object{};
    return size_t(&(object.*member)) - size_t(&object);
}
 
struct TagDataTypeAny;
struct TagDataTypeEnum;
struct TagDataTypeStruct;
struct TagDataTypeUnion;
 
}  // namespace detail
 
/**
 * Builder to create DataType definitions of custom types.
 *
 * The attributes `memSize`, `padding`, `pointerFree`, `isArray` and `isOptional` are automatically
 * deduced from the types itself.
 */
template <typename T, typename Tag = detail::TagDataTypeAny, typename U = struct DeferT>
class DataTypeBuilder {
public:
    /**
     * Build a DataType definition for an enum.
     * @param typeName Human-readable type name
     * @param typeId NodeId of the type
     * @param binaryEncodingId NodeId of data type when encoded as binary
     */
    static auto createEnum(const char* typeName, NodeId typeId, NodeId binaryEncodingId);
 
    /**
     * Build a DataType definition for a structure.
     * A structure may have optional fields (pointers).
     * @param typeName Human-readable type name
     * @param typeId NodeId of the type
     * @param binaryEncodingId NodeId of data type when encoded as binary
     */
    static auto createStructure(const char* typeName, NodeId typeId, NodeId binaryEncodingId);
 
    /**
     * Build a DataType definition for an union.
     * Union type consist of a switch field and the actual union.
     * @param typeName Human-readable type name
     * @param typeId NodeId of the type
     * @param binaryEncodingId NodeId of data type when encoded as binary
     */
    static auto createUnion(const char* typeName, NodeId typeId, NodeId binaryEncodingId);
 
    /**
     * Add a structure field.
     * @tparam field Member pointer, e.g. `&S::value`
     * @param fieldName Human-readable field name
     * @param fieldType Member data type
     */
    template <auto U::*field>
    auto& addField(const char* fieldName, const UA_DataType& fieldType);
 
    /**
     * Add a structure field (derive DataType from `field`).
     * @overload
     */
    template <auto U::*field>
    auto& addField(const char* fieldName) {
        return addField<field>(fieldName, detail::getMemberDataType<field>());
    }
 
    /**
     * Add a structure array field.
     * Arrays must consists of two fields: its size (of type `size_t`) and the pointer to the data.
     * No padding allowed between the size field and the array field.
     * @tparam fieldSize Member pointer to the size field, e.g. `&S::length`
     * @tparam fieldArray Member pointer to the array field, e.g. `&S::data`
     * @param fieldName Human-readable field name
     * @param fieldType Member data type
     */
    template <auto U::*fieldSize, auto U::*fieldArray>
    auto& addField(const char* fieldName, const UA_DataType& fieldType);
 
    /**
     * Add a structure array field (derive DataType from `fieldArray`).
     * @overload
     */
    template <auto U::*fieldSize, auto U::*fieldArray>
    auto& addField(const char* fieldName) {
        return addField<fieldSize, fieldArray>(fieldName, detail::getMemberDataType<fieldArray>());
    }
 
    /**
     * Add a union field.
     * @tparam memberUnion Member pointer to the union, e.g. `&S::Uni`
     * @tparam TField Type of the union field
     * @param fieldName Human-readable field name
     * @param fieldType Data type of the union field
     */
    template <auto U::*memberUnion, typename TField>
    auto& addUnionField(const char* fieldName, const UA_DataType& fieldType);
 
    /**
     * Add a union field (derive DataType from `TField`).
     * @overload
     */
    template <auto U::*memberUnion, typename TField>
    auto& addUnionField(const char* fieldName) {
        return addUnionField<memberUnion, TField>(fieldName, getDataType<TField>());
    }
 
    /**
     * Create the actual DataType.
     */
    [[nodiscard]] DataType build();
 
private:
    template <typename, typename, typename>
    friend class DataTypeBuilder;
 
    explicit DataTypeBuilder(DataType dataType)
        : dataType_(std::move(dataType)) {}
 
    struct Field {
        size_t memSize;
        size_t offset;
        DataTypeMember dataTypeMember;
    };
 
    DataType dataType_;
    std::vector<Field> fields_;
};
 
/* --------------------------------------- Implementation --------------------------------------- */
 
template <typename T, typename Tag, typename U>
auto DataTypeBuilder<T, Tag, U>::createEnum(
    const char* typeName, NodeId typeId, NodeId binaryEncodingId
) {
    static_assert(std::is_enum_v<T>, "T must be an enum");
    DataType dt;
    dt.setTypeName(typeName);
    dt.setTypeId(std::move(typeId));
    dt.setBinaryEncodingId(std::move(binaryEncodingId));
    dt.setMemSize(sizeof(T));  // enums must be 32 bit!
    dt.setTypeKind(UA_DATATYPEKIND_ENUM);
    dt.setPointerFree(true);
    dt.setOverlayable(false);
    return DataTypeBuilder<T, detail::TagDataTypeEnum>(dt);
}
 
template <typename T, typename Tag, typename U>
auto DataTypeBuilder<T, Tag, U>::createStructure(
    const char* typeName, NodeId typeId, NodeId binaryEncodingId
) {
    static_assert(std::is_class_v<T>, "T must be a struct or class");
    DataType dt;
    dt.setTypeName(typeName);
    dt.setTypeId(std::move(typeId));
    dt.setBinaryEncodingId(std::move(binaryEncodingId));
    dt.setMemSize(sizeof(T));
    dt.setTypeKind(UA_DATATYPEKIND_STRUCTURE);
    dt.setPointerFree(true);
    dt.setOverlayable(false);
    return DataTypeBuilder<T, detail::TagDataTypeStruct, T>(dt);
}
 
template <typename T, typename Tag, typename U>
auto DataTypeBuilder<T, Tag, U>::createUnion(
    const char* typeName, NodeId typeId, NodeId binaryEncodingId
) {
    static_assert(std::is_class_v<T>, "T must be a struct or class");
    DataType dt;
    dt.setTypeName(typeName);
    dt.setTypeId(std::move(typeId));
    dt.setBinaryEncodingId(std::move(binaryEncodingId));
    dt.setMemSize(sizeof(T));
    dt.setTypeKind(UA_DATATYPEKIND_UNION);
    dt.setPointerFree(true);
    dt.setOverlayable(false);
    return DataTypeBuilder<T, detail::TagDataTypeUnion, T>(dt);
}
 
template <typename T, typename Tag, typename U>
template <auto U::*field>
auto& DataTypeBuilder<T, Tag, U>::addField(const char* fieldName, const UA_DataType& fieldType) {
    using TMember = detail::MemberTypeT<decltype(field)>;
    static_assert(
        std::is_same_v<Tag, detail::TagDataTypeStruct>,
        "Built type must be a struct or class to add members"
    );
    assert(sizeof(std::remove_pointer_t<TMember>) == fieldType.memSize);
    if (std::is_pointer_v<TMember>) {
        dataType_.setTypeKind(UA_DATATYPEKIND_OPTSTRUCT);
    }
    if (std::is_pointer_v<TMember> || !fieldType.pointerFree) {
        dataType_.setPointerFree(false);
    }
    fields_.push_back({
        sizeof(TMember),
        detail::offsetOfMember(field),
        detail::createDataTypeMember(
            fieldName,
            fieldType,
            {},  // calculate padding between members later
            false,
            std::is_pointer_v<TMember>
        ),
    });
    return *this;
}
 
template <typename T, typename Tag, typename U>
template <auto U::*fieldSize, auto U::*fieldArray>
auto& DataTypeBuilder<T, Tag, U>::addField(const char* fieldName, const UA_DataType& fieldType) {
    using TSize = detail::MemberTypeT<decltype(fieldSize)>;
    using TArray = detail::MemberTypeT<decltype(fieldArray)>;
    static_assert(
        std::is_same_v<Tag, detail::TagDataTypeStruct>,
        "Built type must be a struct or class to add members"
    );
    static_assert(std::is_integral_v<TSize>, "TSize must be an integral type");
    static_assert(std::is_pointer_v<TArray>, "TArray must be a pointer");
    assert(
        detail::offsetOfMember(fieldArray) == detail::offsetOfMember(fieldSize) + sizeof(TSize) &&
        "No padding between members size and array allowed"
    );
    assert(sizeof(std::remove_pointer_t<TArray>) == fieldType.memSize);
    dataType_.setPointerFree(false);
    fields_.push_back({
        sizeof(TSize) + sizeof(TArray),
        detail::offsetOfMember(fieldSize),  // offset/padding related to size field
        detail::createDataTypeMember(
            fieldName,
            fieldType,
            {},  // calculate padding between members later
            true,
            false
        ),
    });
    return *this;
}
 
template <typename T, typename Tag, typename U>
template <auto U::*memberUnion, typename TField>
auto& DataTypeBuilder<T, Tag, U>::addUnionField(
    const char* fieldName, const UA_DataType& fieldType
) {
    using TUnion = detail::MemberTypeT<decltype(memberUnion)>;
    static_assert(
        std::is_same_v<Tag, detail::TagDataTypeUnion>,
        "Built type must be a union to add union fields"
    );
    static_assert(std::is_union_v<TUnion>, "TUnion must be a union");
    static_assert(sizeof(TField) <= sizeof(TUnion), "TField exceeds size of union");
    const auto offset = detail::offsetOfMember(memberUnion);
    assert(offset > 0 && "A union type must consist of a switch field and a union");
    assert(sizeof(std::remove_pointer_t<TField>) == fieldType.memSize);
    if (std::is_pointer_v<TField> || !fieldType.pointerFree) {
        dataType_.setPointerFree(false);
    }
    fields_.push_back({
        sizeof(TField),
        offset,
        detail::createDataTypeMember(
            fieldName,
            fieldType,
            static_cast<uint8_t>(offset),  // padding = offset of each field
            false,
            std::is_pointer_v<TField>
        ),
    });
    return *this;
}
 
template <typename T, typename Tag, typename U>
[[nodiscard]] DataType DataTypeBuilder<T, Tag, U>::build() {
    static_assert(!std::is_same_v<Tag, detail::TagDataTypeAny>);
    // sort members by offset
    std::sort(fields_.begin(), fields_.end(), [](const auto& lhs, const auto& rhs) {
        return lhs.offset < rhs.offset;
    });
    // calculate padding of struct members
    if constexpr (std::is_same_v<Tag, detail::TagDataTypeStruct>) {
        for (auto it = fields_.begin(); it < fields_.end(); ++it) {
            if (it == fields_.begin()) {
                it->dataTypeMember.padding = static_cast<uint8_t>(it->offset);
            } else {
                it->dataTypeMember.padding = static_cast<uint8_t>(
                    it->offset - (std::prev(it)->offset + std::prev(it)->memSize)
                );
            }
        }
    }
    // generate and set members array
    std::vector<DataTypeMember> dataTypeMembers(fields_.size());
    std::transform(fields_.cbegin(), fields_.cend(), dataTypeMembers.begin(), [](auto&& m) {
        return m.dataTypeMember;
    });
    dataType_.setMembers(dataTypeMembers);
    return dataType_;
}
 
}  // namespace opcua