gzObject.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzObject.h
// Module       : gzBase
// Description  : Class definition of object management
// 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_OBJECT_H__
#define __GZ_OBJECT_H__

#include "gzMemory.h"
#include "gzTemplates.h"
#include "gzBase.h"
#include "gzSerialize.h"
#include "gzNotify.h"
#include "gzDynamic.h"
#include "gzHashUtils.h"

class gzObject; // Forward decl of attached data to an object

//******************************************************************************
// Class    : gzUserData
//                                  
// Purpose  : Basic holder of all user defined data. All objects inherits from
//            the gzObject class that has a set of UserData
//                                  
// Notes    : Default behaviour is to ref()/unref() on two virtual functions    
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class  gzUserData : public gzReference , public gzSerializeData
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_BASE_EXPORT);   // RTTI

    GZ_BASE_EXPORT virtual ~gzUserData(){};

    GZ_BASE_EXPORT virtual gzVoid onAttach( gzObject *object , const gzString &attribute ) { ref(); }

    GZ_BASE_EXPORT virtual gzVoid onDetach( gzObject *object , const gzString &attribute) { unref(); }

    GZ_BASE_EXPORT virtual gzReference* clone() const=0;

    GZ_BASE_EXPORT virtual gzBool isEqualTo(const gzUserData *data) const { return data==this; }

};

//******************************************************************************
// Class    : gzUserDataAttributeContainer
//                                  
// Purpose  : Basic holder of all user defined data. All objects inherits from
//            the gzObject class that has a set of UserData
//                                  
// Notes    : Default behaviour is to ref()/unref() on two virtual functions    
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class  gzUserDataAttributeContainer : public gzUserData , public gzDynamicTypeContainer
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_BASE_EXPORT);   // RTTI

    GZ_BASE_EXPORT virtual ~gzUserDataAttributeContainer();

    GZ_BASE_EXPORT virtual gzVoid onAttributeEvent( gzDynamicTypeEvent reason , const gzString &name);

    GZ_BASE_EXPORT virtual gzVoid onAttach( gzObject *object , const gzString &attribute); 

    GZ_BASE_EXPORT virtual gzVoid onDetach( gzObject *object , const gzString &attribute);

    GZ_BASE_EXPORT virtual gzReference* clone() const;

    GZ_BASE_EXPORT virtual gzBool isEqualTo(const gzUserData *data) const;

    GZ_BASE_EXPORT virtual gzVoid write(gzSerializeAdapter *adapter);

    GZ_BASE_EXPORT virtual gzVoid read(gzSerializeAdapter *adapter);

    GZ_BASE_EXPORT virtual gzVoid pushBack(gzSerializeAdapter *adapter);

    GZ_BASE_EXPORT virtual gzULong  getDataSize(gzSerializeAdapter *adapter=NULL) const;


private:

    gzList<gzObject>            m_attachements;
};

//******************************************************************************
// Class    : gzObjectDictionary
//                                  
// Purpose  : Private class that hold data for gzObject
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class  gzUserDataDictionary : public gzDict<gzString,gzUserData>
{
    virtual ~gzUserDataDictionary(){};

private:
    friend class gzObject;

    gzUserDataDictionary();
    
    gzObject *m_owner;

    virtual gzVoid onInsert(const gzString &key, gzUserData * value ) const { value->onAttach(m_owner,key);}

    virtual gzVoid onRemove(const gzString &key, gzUserData * value ) const { value->onDetach(m_owner,key);}
};


class gzObjectInvokeInterface : public gzReference , public gzDynamicInvokeInterface
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_BASE_EXPORT);   // typed interface

    GZ_BASE_EXPORT gzObjectInvokeInterface();
    GZ_BASE_EXPORT virtual ~gzObjectInvokeInterface();

    // ---------- Interface registration -------------------------------
    GZ_BASE_EXPORT static gzVoid registerInterface(gzType *type,gzObjectInvokeInterface *iface);
    GZ_BASE_EXPORT static gzVoid unRegisterInterface(gzType *ifacetype);

    // ---------- Dynamic method invokation ----------------------------

    GZ_BASE_EXPORT static gzDynamicType                 instanceInvokeMethod(gzReference *instance,const gzString &IIDS_method,GZ_DYNAMIC_ATTRIBUTE_LIST);
    GZ_BASE_EXPORT static gzDynamicType                 instanceInvokeMethod(gzReference *instance,gzULongLong IID_method,GZ_DYNAMIC_ATTRIBUTE_LIST);
    GZ_BASE_EXPORT static gzBool                        instanceSupportMethod(gzReference *instance,gzULongLong IID_method);
    GZ_BASE_EXPORT static gzULongLong                   instanceGetMethodIID(gzReference *instance,const gzString &IIDS_method);
    GZ_BASE_EXPORT static gzDynamicMethod               instanceGetDirectMethod(gzReference *instance,gzULongLong IID_method);
    GZ_BASE_EXPORT static gzString                      instanceGetDescription(gzReference *instance,gzULongLong IID_method);
    GZ_BASE_EXPORT static gzArray<gzDynamicMethodID>    instanceQueryAllMethodIID(gzReference *instance);

private:

    static gzRefDict<gzType,gzObjectInvokeInterface>        s_interfaces;
};

//******************************************************************************
// Class    : gzObject
//                                  
// Purpose  : Base class for all Gizmo objects. 
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  980912  Created 
//                                  
//******************************************************************************
class  gzObject : public gzUserData 
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_BASE_EXPORT);   // typed interface
    
    GZ_BASE_EXPORT gzObject();
    GZ_BASE_EXPORT gzObject( const gzObject &copy);
    GZ_BASE_EXPORT gzObject &operator=(const gzObject &copy);

    GZ_BASE_EXPORT virtual ~gzObject();

    //---------------------- custom user data ----------------------------------
    GZ_BASE_EXPORT gzVoid       addUserData(    const gzString &name , gzUserData *data);
    GZ_BASE_EXPORT gzUserData * getUserData(    const gzString &name , gzUserData *parent=NULL);
    GZ_BASE_EXPORT gzBool       existUserData(  const gzString &name , gzUserData *data = NULL);
    GZ_BASE_EXPORT gzBool       removeUserData( const gzString &name , gzUserData *data = NULL);
    GZ_BASE_EXPORT gzVoid       removeAllUserData();
    GZ_BASE_EXPORT gzBool       hasUserData();
    GZ_BASE_EXPORT gzBool       hasSameUserData(const gzObject *object);

    GZ_BASE_EXPORT gzUserDataDictionary *   getUserDataDictionary();


    //---------------------- Attribute data ------------------------------------

    GZ_BASE_EXPORT gzVoid           setAttribute(const gzString &userdata , const gzString &name , const gzDynamicType &attribute);
    GZ_BASE_EXPORT gzDynamicType    getAttribute(const gzString &userdata ,const gzString &name) const;
    GZ_BASE_EXPORT gzBool           hasAttribute(const gzString &userdata ,const gzString &name);
    GZ_BASE_EXPORT gzBool           removeAttribute(const gzString &userdata ,const gzString &name);
    GZ_BASE_EXPORT gzVoid           removeAllAttributes(const gzString &userdata );
    GZ_BASE_EXPORT gzULong          getNumberOfAttributes(const gzString &userdata) const;

    GZ_BASE_EXPORT virtual gzVoid onUserDataAttributeEvent( gzUserData *data , gzDynamicTypeEvent reason , const gzString &name) {};

    // ---------- Clone interface ---------------------------------------
    GZ_BASE_EXPORT virtual gzReference* clone() const;

    // ---------- Factory management ------------------------------------

    GZ_BASE_EXPORT static gzULong registerFactoryObject(gzObject *object);
    GZ_BASE_EXPORT static gzVoid unregisterFactory(gzULong id);
    GZ_BASE_EXPORT static gzVoid unregisterAllFactories();
    GZ_BASE_EXPORT static gzObject *createFactoryObject(gzULong id);

    // ---------- Serializing -------------------------------------------

    GZ_BASE_EXPORT virtual gzVoid   write(gzSerializeAdapter *adapter);
    GZ_BASE_EXPORT virtual gzVoid   read(gzSerializeAdapter *adapter);
    GZ_BASE_EXPORT virtual gzULong  getDataSize(gzSerializeAdapter *adapter=NULL) const;
    
    // ---------- Serialize Utils ---------------------------------------

    GZ_BASE_EXPORT static   gzVoid      writeObject(gzObject *object, gzSerializeAdapter *adapter, gzULong totlen=0,const gzString &banner=GZ_EMPTY_STRING);
    GZ_BASE_EXPORT static   gzObject *  readObject(gzSerializeAdapter *adapter, gzULong totlen=0,const gzString &banner=GZ_EMPTY_STRING);
    GZ_BASE_EXPORT static   gzULong     getChunkSize(gzObject *object,gzSerializeAdapter *adapter);


    // ---------- Dynamic method invokation ----------------------------

    GZ_BASE_EXPORT gzDynamicType                invokeMethod(const gzString &IIDS_method,GZ_DYNAMIC_ATTRIBUTE_LIST);
    GZ_BASE_EXPORT gzDynamicType                invokeMethod(gzULongLong IID_method,GZ_DYNAMIC_ATTRIBUTE_LIST);
    GZ_BASE_EXPORT gzBool                       supportMethod(gzULongLong IID_method);
    GZ_BASE_EXPORT gzULongLong                  getMethodIID(const gzString &IIDS_method);
    GZ_BASE_EXPORT gzDynamicMethod              getDirectMethod(gzULongLong IID_method);
    GZ_BASE_EXPORT gzString                     getDescription(gzULongLong IID_method); 
    GZ_BASE_EXPORT gzArray<gzDynamicMethodID>   queryAllMethodIID();


private:

    GZ_BASE_EXPORT virtual gzVoid   pushBack(gzSerializeAdapter *adapter);  

    gzUserDataDictionary    *m_userData;

    static gzRefDict< gzValueCompareInterface ,gzObject>    s_objectFactory;

    static gzMemCheck<gzMutex>                              s_factoryLocker;
};


#endif

---