gre/objectbase.h

Go to the documentation of this file.

#ifndef  INC_GRE_OBJECTBASE_H
#define  INC_GRE_OBJECTBASE_H

#ifndef  INC_GRE_MSG_H
   #include <gre/msg.h>
#endif


#ifndef  GENERATING_DOXYGEN_OUTPUT
struct MICONSTRUCT;
#endif


namespace GRE {
//===================================================================================================================
class OBJECT {

   public:

      enum TYPE {
         TYPE_None =    0,
         TYPE_System =  0x01,
         TYPE_Layout =  0x02,
         TYPE_Group =   0x04,
         TYPE_Layer =   0x08,
         TYPE_View =    0x10,
         TYPE_All =     0xFF
         };

      typedef void (*CBFUNC)(const GRE::MSG*, void*);

      void AddRef (
         ) { ++m_RefCount; }

      static int AllocPrivIndex (
         );

      explicit OBJECT (
         OBJECT::TYPE type                      
         );

      virtual ~OBJECT (
         ) = 0;

      void CallbackAdd (
         CBFUNC cbfunc,                         
         void *cbdata,                          
         OBJECT::TYPE objtypes                  
         ) { m_CallbackList.Add(cbfunc,cbdata,objtypes); }

      void CallbackInvoke (
         GRE::MSG::ACTION action,
         GRE::VIEW *view = 0,
         ELEMTYPE elemtype = ELEMTYPE_Empty
         ) { GRE::MSG msg(action,this,view,elemtype); CallbackInvoke(msg); }
         
      void CallbackInvoke (
         GRE::MSG::ACTION action,
         ELEMTYPE elemtype
         ) { GRE::MSG msg(action,this,elemtype); CallbackInvoke(msg); }
         
      void CallbackInvoke (
         GRE::VIEW *view,
         GRE::MSG::ACTION action
         ) { GRE::MSG msg(action,this,view); CallbackInvoke(msg); }
         
      void CallbackInvoke (
         const GRE::MSG& msg
         );
      
      void CallbackRemove (
         CBFUNC cbfunc,                         
         void *cbdata,                          
         OBJECT::TYPE objtypes = TYPE_All       
         ) { m_CallbackList.Remove(cbfunc,cbdata,objtypes); }

      bool Destroy (
         bool NotifyParent = true               
         ) { return (v_Destroy(NotifyParent)); }

      bool DestroyRequested (
         ) const { return (m_DestroyRequested); }

      MICONSTRUCT* GetIcon (
         ) const { return (v_GetIcon()); }

      void *GetPrivPtr (
         int idx                                
         ) const { return (m_PrivData[idx]); }

      OBJECT::TYPE GetType (
         ) const { return (m_objtype); }

      const char* GetTypeName (
         ) const { return (v_GetTypeName()); }

      const char* GetTypeName (
         char *string                           
         ) const;

      bool IsBeingDestroyed (
         ) const { return (m_BeingDestroyed); }

      bool IsTemporary (
         ) const { return (m_IsTemporary); }

      void Release (
         );

      void SetPrivPtr (
         int idx,                               
         void *privptr                          
         ) { if (idx > 0 && idx < s_PrivDataCount) m_PrivData[idx] = privptr; }

   protected:

      bool CallbacksBeingInvoked (
         ) const { return (m_RefCount > 0 || m_CallbackList.BeingInvoked()); }

      void SetBeingDestroyed (
         ) { m_BeingDestroyed = true; }

      void SetDestroyRequest (
         ) { m_DestroyRequested = true; }

      void SetTemporary (
         ) { m_IsTemporary = true; }

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT

      // GRE::OBJECT::CBFUNCLIST
      class CBFUNCLIST {
         public:

            CBFUNCLIST (
               );

            ~CBFUNCLIST (
               );

            void Add (
               CBFUNC cbfunc,                   
               void *cbdata,                    
               OBJECT::TYPE objtypes            
               );

            bool BeingInvoked (
               ) const { return (m_callcount > 0); }

            void Invoke (
               const GRE::MSG& msg           
               );

            void Remove (
               CBFUNC cbfunc,                   
               void *cbdata,                    
               OBJECT::TYPE objtypes = TYPE_All 
               );

         private:
            // GRE::OBJECT::CBFUNCLIST::ITEM
            class ITEM {
               public:

                  ITEM (
                     CBFUNC cbfunc,
                     void *cbdata,
                     OBJECT::TYPE objtypes
                     );

                  CBFUNC m_cbfunc;
                  void *m_cbdata;
                  OBJECT::TYPE m_objtypes;
                  ITEM *m_next;
               };

            ITEM *m_first;
            UINT16 m_callcount;
            bool m_DidRemove;
         };

      static int s_PrivDataCount;            
      static int s_PrivDataAlloc;            

      const TYPE m_objtype;                  
      void **m_PrivData;                     
      CBFUNCLIST m_CallbackList;             
      bool m_DestroyRequested;               
      bool m_BeingDestroyed;                 
      bool m_IsTemporary;                    
      UINT32 m_RefCount;                     

      #endif // GENERATING_DOXYGEN_OUTPUT

      virtual bool v_Destroy (bool NotifyParent) = 0;
      virtual MICONSTRUCT* v_GetIcon () const = 0;
      virtual const char* v_GetTypeName () const = 0;
   };
#ifndef  GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(OBJECT::TYPE);
#endif

//===================================================================================================================
}  // End namespace GRE



#endif   // INC_GRE_OBJECTBASE_H

---