odrbefore renaming registry.hpp

Author: jll63

doc/modules/ROOT/nav.adoc

@@ -12,5 +12,6 @@
 ** xref:custom_rtti.adoc[Custom RTTI]
 ** xref:dynamic_loading.adoc[Dynamic Loading]
 * Reference
+** xref:headers.adoc[Headers]
 ** xref:macros.adoc[Macros]
-** xref:reference:boost/openmethod.adoc[boost::openmethod]
+** xref:reference:boost/openmethod.adoc[Namespace boost::openmethod]

doc/modules/ROOT/pages/BOOST_OPENMETHOD_DEFAULT_REGISTRY.adoc

@@ -27,3 +27,6 @@ follows:
 1. Include headers under `boost/openmethod/policies/` as needed.
 2. Create a REGISTRY class, and set `BOOST_OPENMETHOD_DEFAULT_REGISTRY`.
 3. Include `<boost/openmethod/core.hpp>`.
+
+Use this feature with caution, as it can easily lead to ODR violations if
+different translation units define different default registries.

doc/modules/ROOT/pages/headers.adoc

@@ -1,39 +1,46 @@
 [#headers]
-= xref:macros.adoc[Headers]
-:mrdocs:
-
-[cols=2]
-|===
-| Name
-| Description
-| boost/openmethod.hpp
-| bla
-| boost/openmethod/macros.hpp
-| bla
-| boost/openmethod/core.hpp
-| bla
-| boost/openmethod/registry.hpp
-| bla
-| boost/openmethod/default_registry.hpp
-| bla
-| boost/openmethod/policies/default_error_handler.hpp
-| bla
-| boost/openmethod/policies/fast_perfect_hash.hpp
-| bla
-| boost/openmethod/policies/std_rtti.hpp
-| bla
-| boost/openmethod/policies/static_rtti.hpp
-| bla
-| boost/openmethod/policies/stderr_output.hpp
-| bla
-| boost/openmethod/policies/throw_error_handler.hpp
-| bla
-| boost/openmethod/policies/vptr_map.hpp
-| bla
-| boost/openmethod/policies/vptr_vector.hpp
-| bla
-| boost/openmethod/interop/std_shared_ptr.hpp
-| bla
-| boost/openmethod/interop/std_unique_ptr.hpp
-| bla
-|===
+= xref:headers.adoc[Headers]
+:toc:
+
+### boost/openmethod.hpp
+
+Convenience header. Includes `core.hpp` and `macros.hpp`. This is the header
+that most users should use.
+
+### boost/openmethod/core.hpp
+
+Defines all the core constructs of the library: `method`, `virtual_ptr`,
+`use_classes`, `virtual_traits`, etc. Does not define any public macros apart
+from `BOOST_OPENMETHOD_DEFAULT_REGISTRY`. Users with a severe allergy to macros
+should use this header.
+
+### boost/openmethod/macros.hpp
+
+Defines all the public macros of the library, such as `BOOST_OPENMETHOD`,
+`BOOST_OPENMETHOD_CLASSES`, etc. This header includes `core.hpp`.
+
+### boost/openmethod/registry.hpp
+
+Defines `registry` and stock policies.
+
+### boost/openmethod/default_registry.hpp
+
+### boost/openmethod/policies/default_error_handler.hpp
+
+### boost/openmethod/policies/fast_perfect_hash.hpp
+
+### boost/openmethod/policies/std_rtti.hpp
+
+### boost/openmethod/policies/static_rtti.hpp
+
+### boost/openmethod/policies/stderr_output.hpp
+
+### boost/openmethod/policies/throw_error_handler.hpp
+
+### boost/openmethod/policies/vptr_map.hpp
+
+### boost/openmethod/policies/vptr_vector.hpp
+
+### boost/openmethod/interop/std_shared_ptr.hpp
+
+### boost/openmethod/interop/std_unique_ptr.hpp

include/boost/openmethod/core.hpp

@@ -507,7 +507,7 @@ constexpr bool has_vptr_fn = std::is_same_v<
 
 template<class Registry, class ArgType>
 decltype(auto) acquire_vptr(const ArgType& arg) {
-    Registry::check_initialized();
+    Registry::require_initialized();
 
     if constexpr (detail::has_vptr_fn<ArgType, Registry>) {
         return boost_openmethod_vptr(arg, static_cast<Registry*>(nullptr));
@@ -2407,7 +2407,7 @@ BOOST_FORCEINLINE
         const ArgType&... args) const {
     using namespace detail;
 
-    Registry::check_initialized();
+    Registry::require_initialized();
 
     void (*pf)();
 

include/boost/openmethod/registry.hpp

@@ -81,7 +81,9 @@ struct odr_violation : openmethod_error {
     //! @param stream The stream to write to.
     template<class Registry, class Stream>
     auto write(Stream& stream) const -> void {
-        stream << "conflicting definitions of default_registry";
+        stream << "conflicting definitions of ";
+        Registry::rtti::type_name(
+            Registry::rtti::template static_type<Registry>(), stream);
     }
 };
 
@@ -818,25 +820,25 @@ class registry : detail::registry_base {
     inline static std::vector<detail::word> dispatch_data;
     inline static bool initialized;
 
-  protected:
     template<class... Options>
     struct compiler;
 
   public:
+    //! The type of this registry.
     using registry_type = registry;
 
     template<typename, class...>
     friend struct detail::initialize_aux;
 
-    //! Checks if the registry is initialized.
+    //! Check that the registry is initialized.
     //!
-    //! Checks if `initialize` has been called for this registry, and report an
+    //! Check if `initialize` has been called for this registry, and report an
     //! error if not.
     //!
     //! @par Errors
     //!
     //! @li @ref not_initialized: The registry is not initialized.
-    static void check_initialized();
+    static void require_initialized();
 
     //! Releases the resources held by the registry.
     //!
@@ -858,7 +860,7 @@ class registry : detail::registry_base {
     template<class Class>
     inline static vptr_type static_vptr;
 
-    //! The list of policies selected in a registry.
+    //! List of policies selected in a registry.
     //!
     //! `policy_list` is a Boost.Mp11 list containing the policies passed to the
     //! @ref registry clas template.
@@ -938,7 +940,7 @@ class registry : detail::registry_base {
 };
 
 template<class... Policies>
-inline void registry<Policies...>::check_initialized() {
+inline void registry<Policies...>::require_initialized() {
     if constexpr (registry::has_runtime_checks) {
         if (!initialized) {
             if constexpr (registry::has_error_handler) {

test/test_runtime_errors.cpp

@@ -87,7 +87,7 @@ BOOST_AUTO_TEST_CASE(no_initialization) {
         }
     } else {
         try {
-            registry::check_initialized();
+            registry::require_initialized();
         } catch (not_initialized&) {
             BOOST_TEST_FAIL("should have not thrown in release variant");
         }