GClassDefine.hh

Go to the documentation of this file.

//======================================================================
/*! \file GClassDefine.hh
 *
 *  File defining the macro to include in class definitions.
 */
//======================================================================

#ifndef G_CLASS_DEFINE_HH
#define G_CLASS_DEFINE_HH

#include <string>
#include <ctype.h>

//======================================================================
//  Some template functions for Objects description

/*! Template function returning the class name of a template class T.*/
template < class T > const char * G_StaticClassName ( )
  {
          // g++ returns a string with name length + name string
          //     the function just strips the leading digits
    size_t  pos = 0, i = 0;
    const char * impl_name = typeid(T).name();
    while ( i < strlen(impl_name) )
      { if ( isdigit(impl_name[i]) ) { pos++; } ++i; }
    return ( & impl_name[pos] );
    //return ( impl_name );
  }

//======================================================================

/*! Macro defining the real class name of an object (final derivation class).
 */
#define G_CLASS_NAME_FCT \
  inline virtual const char * ClassName ( ) const { return StaticClassName(); }

/*! Macro defining the static class name of an object (as it is used).
 */
#define G_STATIC_CLASS_NAME_FCT(T) \
  inline static const char * StaticClassName ( ) \
                              { return ( G_StaticClassName<T>( ) ); }

/*! Define a virtual copy function. The function calls the copy constructor,
 *  that must be defined.
 */
#define G_CLONE_FCT(T) \
  virtual T * Clone ( ) const { return ( new T(*this) ); }

/*! Define an pure virtual copy function for abstract classes.*/
#define G_CLONE_ABSTRACT_FCT(T) \
  virtual T * Clone ( ) const = 0;

/*! Define the template function to check if an object is instance of a given
 *  class.*/
#define G_TEMP_IS_INSTANCE_OF \
  template <class Q> bool IsInstanceOf ( ) const \
                            { return (dynamic_cast<const Q*>(this) != NULL); } \
  template <class Q> bool IsInstanceOf ( ) \
                            { return (dynamic_cast<Q*>(this) != NULL); }

/*! Macro defining basic object functions.
 *  \note 
 *  - the copy constructor of the class must be defined.
 */
#define GObject(T) \
  public: \
    G_TEMP_IS_INSTANCE_OF \
    G_CLONE_FCT(T) \
    G_CLASS_NAME_FCT \
    G_STATIC_CLASS_NAME_FCT(T)

/*! Macro defining basic object functions, to be used with abstract classes:
 *  the virtual copy function (Clone) is pure virtual.
 *  \note
 *  - the copy constructor of the class must be defined.
 */
#define GObjectV(T) \
  public: \
    G_TEMP_IS_INSTANCE_OF \
    G_CLONE_ABSTRACT_FCT(T) \
    G_CLASS_NAME_FCT \
    G_STATIC_CLASS_NAME_FCT(T)


//======================================================================
#endif