ecstasy::rtti::TypeRegistry Class Reference

Type registry class to store types in cross-platform way. More...

#include <TypeRegistry.hpp>

Collaboration diagram for ecstasy::rtti::TypeRegistry:

Public Types
using	Predicate = std::function< bool(const std::pair< const std::size_t, std::unique_ptr< AType > > &)>
	Predicate type for custom type search.
using	OptionalATypeReference = std::optional< std::reference_wrapper< AType > >
	Alias to an optional reference to a type (to be less verbose).

Public Member Functions
template<typename T >
AType &	registerType (std::string_view name)
	Register a type in the registry.
template<is_comparable_with_atype T>
bool	has (const T &target) const noexcept
	Check if a type is registered.
bool	has (size_t name_hash) const noexcept
	Check if a type is registered from its hash.
template<typename T >
bool	has () const noexcept
	Check if a type is registered.
OptionalATypeReference	findIf (const Predicate &p) const noexcept
	Calls std::find_if on the types map using the given predicate.
AType &	getIf (const Predicate &p) const
	Get a reference to the AType instance matching the predicate.
template<is_comparable_with_atype T>
OptionalATypeReference	find (const T &target) const noexcept
	Search for a registered type.
OptionalATypeReference	find (std::size_t name_hash) const noexcept
	Search for a registered type from its hash.
template<typename T >
OptionalATypeReference	find () const noexcept
	Search for a registered type.
template<is_comparable_with_atype T>
AType &	get (const T &target) const
	Get a reference to the AType instance matching the target.
AType &	get (std::size_t name_hash) const
	Get a reference to the AType instance from its name hash.
template<typename T >
AType &	get () const
	Get a reference to the AType instance matching the target.

Static Public Member Functions
static TypeRegistry &	getInstance () noexcept
	Get the Instance object.

Private Member Functions
	TypeRegistry () noexcept=default
	Construct a new Type Registry instance.
	~TypeRegistry () noexcept=default
	Destroy the Type Registry instance.

Private Attributes
std::unordered_map< std::size_t, std::unique_ptr< AType > >	_types
	Map of types indexed by their (cross-platform) hash code.

Detailed Description

Type registry class to store types in cross-platform way.

Note

The class is a singleton and should be accessed through the getInstance() method.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 54 of file TypeRegistry.hpp.

Member Typedef Documentation

OptionalATypeReference

using ecstasy::rtti::TypeRegistry::OptionalATypeReference = std::optional<std::reference_wrapper<AType> >

Alias to an optional reference to a type (to be less verbose).

Definition at line 59 of file TypeRegistry.hpp.

Predicate

using ecstasy::rtti::TypeRegistry::Predicate = std::function<bool(const std::pair<const std::size_t, std::unique_ptr<AType> > &)>

Predicate type for custom type search.

Definition at line 57 of file TypeRegistry.hpp.

Constructor & Destructor Documentation

TypeRegistry()

ecstasy::rtti::TypeRegistry::TypeRegistry ( )

privatedefaultnoexcept

Construct a new Type Registry instance.

Note

The constructor is private to prevent instantiation.

~TypeRegistry()

ecstasy::rtti::TypeRegistry::~TypeRegistry ( )

privatedefaultnoexcept

Destroy the Type Registry instance.

Note

The destructor is private to prevent deletion.

Member Function Documentation

find() [1/3]

template<typename T >

OptionalATypeReference ecstasy::rtti::TypeRegistry::find ( ) const

inlinenoexcept

Search for a registered type.

Template Parameters

T	Type to search.

Returns

OptionalATypeReference Optional reference to the type if found, std::nullopt otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 216 of file TypeRegistry.hpp.

        {
            return find<std::type_info>(typeid(T));
        }

find() [2/3]

template<is_comparable_with_atype T>

OptionalATypeReference ecstasy::rtti::TypeRegistry::find ( const T &  target ) const

inlinenoexcept

Search for a registered type.

Note

This method call std::find on the internal types map.

Template Parameters

T	Type to check. It must be equality comparable with AType.

Parameters

[in]

target

Value to compare the types with.

Returns

OptionalATypeReference& Optional reference to the type if found, std::nullopt otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 182 of file TypeRegistry.hpp.

        {
            auto result = std::find_if(_types.begin(), _types.end(), [&target](const auto &pair) {
                return *pair.second == target;
            });
 
            if (result == _types.end())
                return std::nullopt;
            return std::ref(*result->second);
        }

find() [3/3]

TypeRegistry::OptionalATypeReference ecstasy::rtti::TypeRegistry::find ( std::size_t  name_hash ) const

noexcept

Search for a registered type from its hash.

Parameters

[in]

name_hash

Hash of the type name.

Returns

OptionalATypeReference Optional reference to the type if found, std::nullopt otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-31)

Definition at line 49 of file TypeRegistry.cpp.

    {
        if (_types.contains(name_hash))
            return std::ref(*(_types.at(name_hash)));
        return std::nullopt;
    }

findIf()

TypeRegistry::OptionalATypeReference ecstasy::rtti::TypeRegistry::findIf ( const Predicate &  p ) const

noexcept

Calls std::find_if on the types map using the given predicate.

Parameters

[in]

p

Predicate to use for the search.

Returns

OptionalATypeReference Optional reference to the type if found, std::nullopt otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 31 of file TypeRegistry.cpp.

    {
        auto result = std::find_if(_types.begin(), _types.end(), p);
 
        if (result == _types.end())
            return std::nullopt;
        return std::ref(*result->second);
    }

get() [1/3]

template<typename T >

AType & ecstasy::rtti::TypeRegistry::get ( ) const

inline

Get a reference to the AType instance matching the target.

Template Parameters

T	Type to search.

Returns

AType& Reference to the type.

Exceptions

std::out_of_range

If the type is not found.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 272 of file TypeRegistry.hpp.

        {
            return get<std::type_info>(typeid(T));
        }

get() [2/3]

template<is_comparable_with_atype T>

AType & ecstasy::rtti::TypeRegistry::get ( const T &  target ) const

inline

Get a reference to the AType instance matching the target.

Template Parameters

T	Type to check. It must be equality comparable with AType.

Parameters

[in]

target

Value to compare the types with.

Returns

AType& Reference to the type.

Exceptions

std::out_of_range

If the type is not found.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 236 of file TypeRegistry.hpp.

        {
            auto result = find(target);
 
            if (result.has_value())
                return result.value();
            throw std::out_of_range("Type not found.");
        }

get() [3/3]

AType & ecstasy::rtti::TypeRegistry::get

(

std::size_t

name_hash

)

const

Get a reference to the AType instance from its name hash.

Parameters

[in]

name_hash

Hash of the type name.

Returns

AType& Reference to the type.

Exceptions

std::out_of_range

If the type is not found.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-31)

Definition at line 56 of file TypeRegistry.cpp.

    {
        return *(_types.at(name_hash));
    }

getIf()

AType & ecstasy::rtti::TypeRegistry::getIf

(

const Predicate &

p

)

const

Get a reference to the AType instance matching the predicate.

Parameters

[in]

p

Predicate to use for the search.

Returns

AType& Reference to the type.

Exceptions

std::out_of_range

If the type is not found.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 40 of file TypeRegistry.cpp.

    {
        auto result = findIf(p);
 
        if (result.has_value())
            return result.value();
        throw std::out_of_range("Type not found.");
    }

getInstance()

TypeRegistry & ecstasy::rtti::TypeRegistry::getInstance ( )

staticnoexcept

Get the Instance object.

Returns

TypeRegistry& The instance of the TypeRegistry.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 17 of file TypeRegistry.cpp.

    {
        static TypeRegistry instance;
 
        return instance;
    }

has() [1/3]

template<typename T >

bool ecstasy::rtti::TypeRegistry::has ( ) const

inlinenoexcept

Check if a type is registered.

Template Parameters

T	Type to check.

Returns

bool True if the type is registered, false otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 136 of file TypeRegistry.hpp.

        {
            return has<std::type_info>(typeid(T));
        }

has() [2/3]

template<is_comparable_with_atype T>

bool ecstasy::rtti::TypeRegistry::has ( const T &  target ) const

inlinenoexcept

Check if a type is registered.

This calls find() and checks if the result is not std::nullopt.

Template Parameters

T	Type to check.

Parameters

[in]

target

Type to check.

Returns

bool True if the type is registered, false otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 108 of file TypeRegistry.hpp.

        {
            return find(target).has_value();
        }

has() [3/3]

bool ecstasy::rtti::TypeRegistry::has ( size_t  name_hash ) const

noexcept

Check if a type is registered from its hash.

Parameters

[in]

name_hash

Hash of the type name.

Returns

bool True if the type is registered, false otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-31)

registerType()

template<typename T >

AType & ecstasy::rtti::TypeRegistry::registerType ( std::string_view  name )

inline

Register a type in the registry.

Template Parameters

T	Type to register.

Parameters

[in]

name

Name of the type.

Returns

bool True if the type was successfully registered, false if it was already registered.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-10-24)

Definition at line 84 of file TypeRegistry.hpp.

        {
            size_t hash = std::hash<std::string_view>{}(name);
            OptionalATypeReference type = find(hash);
 
            if (type.has_value())
                return type.value();
            else
                return *_types.emplace(hash, std::make_unique<Type<T>>(name)).first->second;
        }

Member Data Documentation

_types

std::unordered_map<std::size_t, std::unique_ptr<AType> > ecstasy::rtti::TypeRegistry::_types

private

Map of types indexed by their (cross-platform) hash code.

Definition at line 279 of file TypeRegistry.hpp.

---

The documentation for this class was generated from the following files:

• src/ecstasy/rtti/TypeRegistry.hpp
• src/ecstasy/rtti/TypeRegistry.cpp