cXObjPack.h

Go to the documentation of this file.

//
//
 
#ifndef _INC_cXObjPack_H
#define _INC_cXObjPack_H
#ifndef NO_PRAGMA_ONCE
#pragma once
#endif
 
#include "../XObject/cXObjMgr.h"        // cXObjTypeDef
#include "../XObject/cXObjDef.h"
#include "GrayCore/include/cFileDir.h"  // cFileStatus
 
namespace GrayLib
{
        class cXObjEventSink;
        class cXObjPackChild;
        class cXObjPackFactory;
 
        enum CXOBJFILE_CHANGE_TYPE
        {
                CXOBJFILE_CHANGE_Same,
                CXOBJFILE_CHANGE_First, 
                CXOBJFILE_CHANGE_Changed,
        };
 
        class GRAYLIB_LINK cXObjPack : public cXObjDef
        {
 
                typedef cXObjDef SUPER_t;
                CHEAPOBJECT_IMPL;
 
        public:
                static const ATOMCHAR_t k_szSymNamePrefix[];    
                static const XOBJTID_t k_XObjTypeId = MAKEFOURCC('P', 'a', 'k', 'g');   // cXObjTypeDef for all file packages.
                static cXObjTypeDef sm_XObjTypeDef;             // for k_XObjTypeId
 
                // Last time it was closed. What did the file params look like ?
                cFileStatus m_Attr;     
                cStringF m_sFilePath;   
                bool m_bDisabled;               
                cXObjPackFactory* m_pFactory;   
 
        protected:
                // List of all my cXObjDef children ? if any.
                // These must be reloaded or deleted if the file changes.
                cArrayRef<cXObjDef> m_aLinkedChildren;  
 
        private:
                void Init();
 
        protected:
                cXObjPack(cStringF sFilePath, cXObjPackFactory* pFactory);
 
        public:
                virtual ~cXObjPack();
 
                virtual cStringF get_FilePath() const 
                {
                        return m_sFilePath;
                }
                virtual cString get_Description() const override
                {
                        return m_sFilePath;
                }
                STDMETHOD_(XOBJTID_t, get_XObjTypeId)() const override
                {
                        return k_XObjTypeId;
                }
 
                static cStringA GRAYCALL MakeSymNameFromPath(const FILECHAR_t* pszFilePath);
 
                HRESULT CheckForChange();       
 
                virtual HRESULT DisposeThis() override;
                virtual void UnloadXObject() override;
 
                virtual HRESULT LoadXObjPack(IXObject* pRoot = nullptr)
                {
                        UNREFERENCED_PARAMETER(pRoot);
                        return S_FALSE;
                }
 
                // used inside LoadXObjPack() to register each child object.
                HRESULT RegisterChildDef(cXObjDef* pChildDef);
                bool UnregisterChildDef(cXObjDef* pChildDef);
 
                // call a method by name in the file. File type dictates the exact format of the call.
                virtual HRESULT InvokeMethodInt(cXObjPackChild* pEventSink, const ATOMCHAR_t* pszMethod, const cVariant& vArgs, cVariant& vValRet);
        };
 
        typedef cRefPtr<cXObjPack> cXObjPackPtr;
 
        class GRAYLIB_LINK cXObjPackFactory
        {
        public:
                const FILECHAR_t* m_pszFileExt; 
        public:
                // overload this for the file types we might see.
                cXObjPackFactory(const FILECHAR_t* pszExt)
                        : m_pszFileExt(pszExt)
                {
                        ASSERT(pszExt != nullptr);
                }
                virtual ~cXObjPackFactory()
                {
                }
 
                bool IsFileExt(const FILECHAR_t* pszExt) const
                {
                        ASSERT(m_pszFileExt != nullptr);
                        ASSERT(pszExt != nullptr);
                        // pszExt = cFilePath::GetFileNameExt(pszExt);
                        return(!StrT::CmpI(m_pszFileExt, pszExt));
                }
 
                // First pass is just to enumerate the file. Create a tracking object for it.
                // The cXObjPack parent class handles more specific loading.
                virtual cXObjPackPtr CreateXObjFile(const FILECHAR_t* pszFilePath) = 0;
        };
}
 
#ifdef GRAY_DLL // force implementation/instantiate for DLL/SO.
namespace Gray
{
        template class GRAYLIB_LINK cArrayRef<GrayLib::cXObjDef>;
        template class GRAYLIB_LINK cRefPtr<GrayLib::cXObjPack>;
        template class GRAYLIB_LINK cArrayPtr<GrayLib::cXObjPackFactory>;
}
#endif
 
#endif // cXObjPack