---

ZipArchive.h

Go to the documentation of this file.

#ifndef CLASSLIB_ARCHIVE_H
# define CLASSLIB_ARCHIVE_H

//<<<<<< INCLUDES                                                       >>>>>>

# include "classlib/zip/ZConstants.h"
# include "classlib/iobase/IOBuffer.h"
# include <vector>
# include <string>

namespace lat {
//<<<<<< PUBLIC DEFINES                                                 >>>>>>
//<<<<<< PUBLIC CONSTANTS                                               >>>>>>
//<<<<<< PUBLIC TYPES                                                   >>>>>>

class Storage;
class Filename;
class ZipMember;
class InputStream;
class OutputStream;
class MemoryStorage;

//<<<<<< PUBLIC VARIABLES                                               >>>>>>
//<<<<<< PUBLIC FUNCTIONS                                               >>>>>>
//<<<<<< CLASS DECLARATIONS                                             >>>>>>

class ZipArchive : public ZConstants
{
public:
    typedef std::vector<ZipMember *>::const_iterator Iterator;

    // FIXME: file can be an inmemory file, e.g. compiled-in string!
    ZipArchive (Storage *file);
    ZipArchive (Filename name, unsigned mode);
    virtual ~ZipArchive (void);

    // FIXME: version made, required
    std::string         comment (void) const;
    void                comment (const std::string &text);

    size_t              size (void) const;
    Iterator            begin (void) const;
    Iterator            end (void) const;
    Iterator            find (Filename name) const; // FIXME: case?
    ZipMember *         member (Filename name) const;  // FIXME: case?

    // FIXME: (CheckedInputStream ->) InflaterInputSream -> bounded
    // FileStorageInputStream
    InputStream *       input (ZipMember *member);
    OutputStream *      output (ZipMember *member);
    Storage *           openStored (ZipMember *member);

    // NB: on file close, finish writing last file, write out
    // zip member headers again, write out end header.
    void                flush (void);
    void                close (void);

    // Other operations
    bool                verify (void);

protected:
    virtual Storage *   openStored (Storage *master,
                                    IOOffset position,
                                    IOOffset length);

private:
    class MemberByName;
    class ZInput;
    class SInput;
    class ZOutput;
    class SOutput;
    friend class ZInput;
    friend class SInput;
    friend class ZOutput;
    friend class SOutput;

    void                openArchive (void);
    IOOffset            findEndHeader (void);
    void                readEndHeader (IOOffset pos);
    void                readDirectory (void);
    ZipMember *         readMember (void);

    void                closeArchive (void);
    void                writeDirectory (void);
    
    bool                verifyMember (void);
    void                updateMember (ZipMember *member);

    Storage             *m_file;        //< The archive
    Method              m_method;       //< Default compression method
    unsigned            m_level;        //< Default compression level
    std::string         m_comment;      //< Archive comment
    IOOffset            m_prefixSize;   //< Size of the archive prefix (SFX)
    IOOffset            m_dirPos;       //< Central directory position
    IOOffset            m_dirSize;      //< Central directory size
    IOOffset            m_dirOffset;    //< Central directory offset (from
                                        //  the beginning of the archive,
                                        //  which could be multi-file)
    unsigned            m_mode;         
    std::vector<ZipMember *> m_members; //< Members in this archive
    OutputStream        *m_current;     //< Stream for current member output

    // undefined, no semantics
    ZipArchive (const ZipArchive &);
    const ZipArchive &operator= (const ZipArchive &);
};

//<<<<<< INLINE PUBLIC FUNCTIONS                                        >>>>>>
//<<<<<< INLINE MEMBER FUNCTIONS                                        >>>>>>

} // namespace lat
#endif // CLASSLIB_ARCHIVE_H

---