class CCL::ArchiveHandler

Overview

Helper class to load/save objects from/to a structured storage. More…

#include <archivehandler.h>

class ArchiveHandler: public CCL::Object
{
public:
    // classes

    class ArrayStream;
    class ArrayTask;
    class ArrayTocItem;

    // fields

    StringID saveType = nullptr);
     progress;

    // methods

    DECLARE_CLASS_ABSTRACT (ArchiveHandler, Object);
    PROPERTY_MUTABLE_CSTRING (saveType, SaveType);
    Progress PROPERTY_SHARED_AUTO (IPackageFile, sourcePackage, SourcePackage);
    IFileSystem& getFileSystem ();
    IStream* openStream (StringRef path, int mode);

    bool loadItem (
        StringRef path,
        Archive::ObjectID name,
        Object& item,
        int xmlFlags = 0
    );

    bool loadStream (StringRef path, IStorable& item);
    IStream* copyData (StringRef path);

    bool addSaveTask (
        StringRef path,
        ArchiveSaveTask* task,
        int* attributes = nullptr
    );

    bool addSaveTask (
        StringRef path,
        IStorable& item,
        StringID debugName = nullptr,
        int* attributes = nullptr
    );

    bool addSaveTask (StringRef path, IStream& data, int* attributes = nullptr);

    bool addSaveTask (
        StringRef path,
        Archive::ObjectID name,
        Object& item,
        int xmlFlags = 0
    );

    bool addCopyTask (
        IPackageFile* sourcePackage,
        StringRef path,
        StringRef destPath = nullptr
    );

    int addArrayItemTask (StringRef path, ArchiveSaveTask* task);
    IStream* openArrayItem (StringRef path, int index);
    static ArchiveHandler* getHandler (const Storage& storage);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();

Detailed Documentation

Helper class to load/save objects from/to a structured storage.

Methods

IFileSystem& getFileSystem ()

Get file system.

IStream* openStream (StringRef path, int mode)

Open stream from archive.

bool loadItem (
    StringRef path,
    Archive::ObjectID name,
    Object& item,
    int xmlFlags = 0
)

Load object state from XML stream.

bool loadStream (StringRef path, IStorable& item)

Load external object state.

IStream* copyData (StringRef path)

Copy data to memory stream.

bool addSaveTask (
    StringRef path,
    ArchiveSaveTask* task,
    int* attributes = nullptr
)

Add archive task in save mode (takes ownership!).

bool addSaveTask (
    StringRef path,
    IStorable& item,
    StringID debugName = nullptr,
    int* attributes = nullptr
)

Add task using IStorable (shared!).

bool addSaveTask (StringRef path, IStream& data, int* attributes = nullptr)

Add task using IStream (shared!).

bool addSaveTask (
    StringRef path,
    Archive::ObjectID name,
    Object& item,
    int xmlFlags = 0
)

Add task using Object (shared!), will result in XML.

bool addCopyTask (
    IPackageFile* sourcePackage,
    StringRef path,
    StringRef destPath = nullptr
)

Add task copying an item from another package.

int addArrayItemTask (StringRef path, ArchiveSaveTask* task)

Add task as array element in save mode (takes ownership!).

Returns index in array.

IStream* openArrayItem (StringRef path, int index)

Open array element stream from archive.

static ArchiveHandler* getHandler (const Storage& storage)

Get handler associated with storage object.