gzType.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzType.h
// Module       : gzBase
// Description  : Class definition of type info utilities
// Author       : Anders Modén      
// Product      : GizmoBase 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    GizmoBase is a platform abstraction utility layer for C++. It contains 
//          design patterns and C++ solutions for the advanced programmer.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980915  Created file    
//
//******************************************************************************
#ifndef __GZ_TYPE_H__
#define __GZ_TYPE_H__

#include "gzBasicTypes.h"

const gzULong GZ_TYPE_MAX_NAME_LEN=100;

#define GZ_DECLARE_TYPE_INTERFACE_EXPORT(exporter)  exporter static gzType s_type;\
                                                    exporter static gzType *getClassType() { return &s_type; }\
                                                    exporter virtual gzType *getType() const { return getClassType(); }

#define GZ_DECLARE_TYPE_INTERFACE   static gzType s_type;\
                                    static gzType *getClassType() { return &s_type; }\
                                    virtual gzType *getType() const { return getClassType(); }

#define GZ_DECLARE_TYPE_BASE(base,name) gzType base::s_type(0,name)

#define GZ_DECLARE_TYPE_CHILD(parent,child,name) gzType child::s_type(&parent::s_type,name)
        
//******************************************************************************
// Class    : gzType
//                                  
// Purpose  : Run Time Type Information 
//                                  
// Notes    : RTTI can be supported on various compilers but this provides a generic
//            interface.    
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980819  Created 
//                                  
//******************************************************************************
class  GZ_BASE_EXPORT gzType
{
public:
    gzType(gzType *parent, const char *name );
    gzType(const gzType &right );
    gzType &operator=(const gzType &right );
    virtual ~gzType();

    const char *getName() const;

    gzType *getParent() const;

    gzBool isDerivedFrom(gzType *ancestor) const;

    gzULong hash() const;

    inline gzBool operator==(const gzType &type)
    {
        return (m_name==type.m_name);
    }


private:

    gzType  *m_parent;
    char    *m_name; 
    gzBool  m_created;

};

typedef gzType * gzTypePtr;


//******************************************************************************
// Class    : gzTypeInterface
//                                  
// Purpose  : Interface functions for RTTI 
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980819  Created 
//                                  
//******************************************************************************
class GZ_BASE_EXPORT gzTypeInterface 
{
public:

    gzTypeInterface(){};

    virtual ~gzTypeInterface(){};

    inline gzBool   isExactType( gzType *type ) const 
    {
        if(getType()==type)
            return TRUE;
        else
            return FALSE;
    }

    gzBool          isOfType(gzType *type ) const;

    virtual gzType  *getType() const = 0;

    const char      *getTypeName() const;
};

//******************************************************************************
// Class    : gzDynamic_Cast<CastToClass>
//                                  
// Purpose  : Utility to do a checked dynamic cast 
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  011105  Created 
//                                  
//******************************************************************************
template<class T> T * gzDynamic_Cast(gzTypeInterface* pObject)
{
    if (pObject == NULL)
        return NULL;

    if ( pObject->isOfType( T::getClassType() ) )
        return (T *)pObject;

    return NULL;
}

//******************************************************************************
// Class    : gzDynamic_Instance_Cast<CastToClass>
//                                  
// Purpose  : Utility to do a checked dynamic cast of instance to pointer
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  011105  Created 
//                                  
//******************************************************************************
template<class T1 , class T2> T2 * gzDynamic_Instance_Cast(gzTypeInterface* pObject)
{
    if (pObject == NULL)
        return NULL;

    if ( pObject->isOfType( T1::getClassType() ) )
        return (T2 *)(*(T1 *)pObject);

    return NULL;
}


#endif

---