// Copyright (c) 2018-2025 Jean-Louis Leroy // Distributed under the Boost Software License, Version 1.0. // See accompanying file LICENSE_1_0.txt // or copy at http://www.boost.org/LICENSE_1_0.txt) #ifndef BOOST_OPENMETHOD_POLICY_VPTR_VECTOR_HPP #define BOOST_OPENMETHOD_POLICY_VPTR_VECTOR_HPP #include #include #include namespace boost::openmethod { namespace detail { template inline std::vector vptr_vector_vptrs; template inline std::vector vptr_vector_indirect_vptrs; } // namespace detail namespace policies { //! Stores v-table pointers in a vector. //! //! `vptr_vector` stores v-table pointers in a global vector. If `Registry` //! contains a @ref type_hash policy, it is used to convert `type_id`s to //! indices. Otherwise, `type_id`s are used directly as indices. //! //! If the registry contains the @ref indirect_vptr policy, stores pointers to //! pointers to v-tables in the vector. struct vptr_vector : vptr { public: //! A VptrFn metafunction. //! //! Keeps track of v-table pointers using a `std::vector`. //! //! If `Registry` contains a @ref type_hash policy, it is used to convert //! `type_id`s to indices; otherwise, `type_id`s are used as indices. //! //! If `Registry` contains the @ref indirect_vptr policy, stores pointers to //! pointers to v-tables in the map. //! //! @tparam Registry The registry containing this policy. template struct fn { using type_hash = typename Registry::template policy; static constexpr auto has_type_hash = !std::is_same_v; //! Stores the v-table pointers. //! //! If `Registry` contains a @ref type_hash policy, its `initialize` //! function is called. Its result determines the size of the vector. //! The v-table pointers are copied into the vector. //! //! @tparam Context An @ref InitializeContext. //! @tparam Options... Zero or more option types. //! @param ctx A Context object. //! @param options A tuple of option objects. template static auto initialize( const Context& ctx, const std::tuple& options) -> void { std::size_t size; (void)options; if constexpr (has_type_hash) { auto [_, max_value] = type_hash::initialize(ctx, options); size = max_value + 1; } else { size = 0; for (auto iter = ctx.classes_begin(); iter != ctx.classes_end(); ++iter) { for (auto type_iter = iter->type_id_begin(); type_iter != iter->type_id_end(); ++type_iter) { size = (std::max)(size, std::size_t(*type_iter)); } } ++size; } if constexpr (Registry::has_indirect_vptr) { detail::vptr_vector_indirect_vptrs.resize(size); } else { detail::vptr_vector_vptrs.resize(size); } for (auto iter = ctx.classes_begin(); iter != ctx.classes_end(); ++iter) { for (auto type_iter = iter->type_id_begin(); type_iter != iter->type_id_end(); ++type_iter) { std::size_t index; if constexpr (has_type_hash) { index = type_hash::hash(*type_iter); } else { index = std::size_t(*type_iter); } if constexpr (Registry::has_indirect_vptr) { detail::vptr_vector_indirect_vptrs[index] = &iter->vptr(); } else { detail::vptr_vector_vptrs[index] = iter->vptr(); } } } } //! Returns a *reference* to a v-table pointer for an object. //! //! Acquires the dynamic @ref type_id of `arg`, using the registry's //! @ref rtti policy. //! //! If the registry has a @ref type_hash policy, uses it to convert the //! type id to an index; otherwise, uses the type_id as the index. //! //! If the registry contains the @ref runtime_checks policy, verifies //! that the index falls within the limits of the vector. If it does //! not, and if the registry contains a @ref error_handler policy, calls //! its @ref error function with a @ref missing_class value, then //! terminates the program with @ref abort. //! //! @tparam Class A registered class. //! @param arg A reference to a const object of type `Class`. //! @return A reference to a the v-table pointer for `Class`. template static auto dynamic_vptr(const Class& arg) -> const vptr_type& { auto dynamic_type = Registry::rtti::dynamic_type(arg); std::size_t index; if constexpr (has_type_hash) { index = type_hash::hash(dynamic_type); } else { index = std::size_t(dynamic_type); if constexpr (Registry::has_runtime_checks) { std::size_t max_index = 0; if constexpr (Registry::has_indirect_vptr) { max_index = detail::vptr_vector_indirect_vptrs.size(); } else { max_index = detail::vptr_vector_vptrs.size(); } if (index >= max_index) { if constexpr (Registry::has_error_handler) { missing_class error; error.type = dynamic_type; Registry::error_handler::error(error); } abort(); } } } if constexpr (Registry::has_indirect_vptr) { return *detail::vptr_vector_indirect_vptrs[index]; } else { return detail::vptr_vector_vptrs[index]; } } //! Releases the memory allocated by `initialize`. //! //! @tparam Options... Zero or more option types, deduced from the function //! arguments. //! @param options Zero or more option objects. template static auto finalize(const std::tuple&) -> void { using namespace policies; if constexpr (Registry::has_indirect_vptr) { detail::vptr_vector_indirect_vptrs.clear(); } else { detail::vptr_vector_vptrs.clear(); } }; }; }; } // namespace policies } // namespace boost::openmethod #endif