DynamicTypeBuilderFactory.hpp

// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEBUILDERFACTORY_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEBUILDERFACTORY_HPP
 
#include <functional>
#include <memory>
#include <string>
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/DynamicType.hpp>
#include <fastdds/dds/xtypes/dynamic_types/TypeDescriptor.hpp>
#include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
#include <fastdds/fastdds_dll.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
namespace xtypes {
class TypeObject;
} // namespace xtypes
 
class DynamicTypeBuilderFactory : public std::enable_shared_from_this<DynamicTypeBuilderFactory>
{
public:
 
    using _ref_type = typename traits<DynamicTypeBuilderFactory>::ref_type;

    FASTDDS_EXPORTED_API static traits<DynamicTypeBuilderFactory>::ref_type get_instance();

    FASTDDS_EXPORTED_API static ReturnCode_t delete_instance();

    FASTDDS_EXPORTED_API virtual traits<DynamicType>::ref_type get_primitive_type(
            TypeKind kind) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_type(
            traits<TypeDescriptor>::ref_type descriptor) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_type_copy(
            traits<DynamicType>::ref_type type) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_type_w_type_object(
            const xtypes::TypeObject& type_object) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_string_type(
            uint32_t bound) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_wstring_type(
            uint32_t bound) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_sequence_type(
            traits<DynamicType>::ref_type element_type,
            uint32_t bound) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_array_type(
            traits<DynamicType>::ref_type element_type,
            const BoundSeq& bound) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_map_type(
            traits<DynamicType>::ref_type key_element_type,
            traits<DynamicType>::ref_type element_type,
            uint32_t bound) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_bitmask_type(
            uint32_t bound) = 0;

    FASTDDS_EXPORTED_API virtual void set_preprocessor(
            const std::string& preprocessor) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_type_w_uri(
            const std::string& document_url,
            const std::string& type_name,
            const IncludePathSeq& include_paths) = 0;

    FASTDDS_EXPORTED_API virtual ReturnCode_t for_each_type_w_uri(
            const std::string& document_url,
            const IncludePathSeq& include_paths,
            std::function<bool(traits<DynamicTypeBuilder>::ref_type)> callback) = 0;

    FASTDDS_EXPORTED_API virtual traits<DynamicTypeBuilder>::ref_type create_type_w_document(
            const std::string& document,
            const std::string& type_name,
            const IncludePathSeq& include_paths) = 0;

    FASTDDS_EXPORTED_API virtual ReturnCode_t delete_type(
            traits<DynamicType>::ref_type& type) = 0;
 
protected:
 
    DynamicTypeBuilderFactory() = default;
 
    virtual ~DynamicTypeBuilderFactory() = default;
 
    traits<DynamicTypeBuilderFactory>::ref_type _this();
 
private:
 
    DynamicTypeBuilderFactory(
            const DynamicTypeBuilderFactory&) = delete;
 
    DynamicTypeBuilderFactory(
            DynamicTypeBuilderFactory&&) = delete;
 
    DynamicTypeBuilderFactory& operator =(
            const DynamicTypeBuilderFactory&) = delete;
 
    DynamicTypeBuilderFactory& operator =(
            DynamicTypeBuilderFactory&&) = delete;
 
};
 
} // namespace dds
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEBUILDERFACTORY_HPP