typeInfo.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2025 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
InNamespace
    Foam
 
Description
    Basic run-time type information using word as the type's name.
    Used to enhance the standard RTTI to cover I/O.
 
    The user can get the type's type name using the type info access function
    \code
        type()
    \endcode
 
    The reference type cast template function:
    \code
        refCast<T>(r)
    \endcode
 
    wraps dynamic_cast to handle the bad_cast exception and generate a
    FatalError.
 
    The isA function:
    \code
        isA<T>(r)
    \endcode
 
    returns true if r is of type T or derived from type T.
 
\*---------------------------------------------------------------------------*/
 
#ifndef typeInfo_H
#define typeInfo_H
 
#include "error.H"
#include "className.H"
#include "nullObject.H"
#include <type_traits>
#include <typeinfo>
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
// Declarations (for use in header files)
 
//- Declare a ClassNameNoDebug() with extra virtual type info
#define TypeNameNoDebug(TypeNameString)                                        \
    ClassNameNoDebug(TypeNameString);                                          \
    virtual const word& type() const { return typeName; }                      \
    template<class Name>                                                       \
    word typedName(Name name) const { return (type() + ':') + name; }
 
//- Declare a ClassName() with extra virtual type info
#define TypeName(TypeNameString)                                               \
    ClassName(TypeNameString);                                                 \
    virtual const word& type() const { return typeName; }                      \
    template<class Name>                                                       \
    word typedName(Name name) const { return (type() + ':') + name; }
 
//- Declare a FunctionName() with extra virtual type info
#define FunctionTypeName(TypeNameString)                                       \
    FunctionName(TypeNameString);                                              \
    virtual const word& type() const { return typeName; }                      \
    template<class Name>                                                       \
    word typedName(Name name) const { return (type() + ':') + name; }
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
 
//- Reference type cast template function,
//  wraps dynamic_cast to handle bad_cast exception and generate a FatalError.
template<class To, class From>
inline To& dynamicCast(From& r)
{
    try
    {
        return dynamic_cast<To&>(r);
    }
    catch (const std::bad_cast&)
    {
        FatalErrorInFunction
            << "Attempt to cast type " << typeid(r).name()
            << " to type " << typeid(To).name()
            << abort(FatalError);
 
        return dynamic_cast<To&>(r);
    }
}
 
 
//- Reference type cast template function,
//  wraps dynamic_cast to handle bad_cast exception and generate a null
//  reference.
template<class To, class From>
inline To& dynamicCastNull(From& r)
{
    if (isNull(r))
    {
        return NullObjectNonConstRef<To>();
    }
 
    try
    {
        return dynamic_cast<To&>(r);
    }
    catch (const std::bad_cast&)
    {
        return NullObjectNonConstRef<To>();
    }
}
 
 
//- Reference type cast template function.
//  As per dynamicCast, but handles type names via the virtual type() method.
template<class To, class From>
inline To& refCast(From& r)
{
    try
    {
        return dynamic_cast<To&>(r);
    }
    catch (const std::bad_cast&)
    {
        FatalErrorInFunction
            << "Attempt to cast type " << r.type()
            << " to type " << To::typeName
            << abort(FatalError);
 
        return dynamic_cast<To&>(r);
    }
}
 
 
//- Reference type cast template function,
//  As dynamicCastNull.
template<class To, class From>
inline To& refCastNull(From& r)
{
    return dynamicCastNull<To, From>(r);
}
 
 
//- Check the typeid
template<class TestType, class Type>
inline bool isType(const Type& t)
{
    return typeid(t) == typeid(TestType);
}
 
 
//- Check if a dynamic_cast to typeid is possible
template<class TestType, class Type>
inline bool isA(const Type& t)
{
    const Type* tPtr = &t;
    return dynamic_cast<const TestType*>(tPtr);
}
 
 
//- Return the name of the object within the given type
//  as <typeName>:<name>
template<class TypeName, class Name>
inline word typedName(Name name)
{
    return (TypeName::typeName + ':') + name;
}
 
 
//- Determine whether a type is a reference
template<class Type>
constexpr bool isRef = std::is_reference<Type>::value;
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //