juce_ZipFile.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_ZIPFILE_H_INCLUDED
#define JUCE_ZIPFILE_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  ZipFile
{
public:
    explicit ZipFile (const File& file);
 
    //==============================================================================
    ZipFile (InputStream* inputStream, bool deleteStreamWhenDestroyed);
 
    explicit ZipFile (InputStream& inputStream);
 
    explicit ZipFile (InputSource* inputSource);
 
    ~ZipFile();
 
    //==============================================================================
    struct ZipEntry
    {
        String filename;
 
        unsigned int uncompressedSize;
 
        Time fileTime;
    };
 
    //==============================================================================
    int getNumEntries() const noexcept;
 
    const ZipEntry* getEntry (int index) const noexcept;
 
    int getIndexOfFileName (const String& fileName) const noexcept;
 
    const ZipEntry* getEntry (const String& fileName) const noexcept;
 
    void sortEntriesByFilename();
 
    //==============================================================================
    InputStream* createStreamForEntry (int index);
 
    InputStream* createStreamForEntry (const ZipEntry& entry);
 
    //==============================================================================
    Result uncompressTo (const File& targetDirectory,
                         bool shouldOverwriteFiles = true);
 
    Result uncompressEntry (int index,
                            const File& targetDirectory,
                            bool shouldOverwriteFiles = true);
 
 
    //==============================================================================
    class Builder
    {
    public:
        Builder();
        ~Builder();
 
        void addFile (const File& fileToAdd, int compressionLevel,
                      const String& storedPathName = String());
 
        void addEntry (InputStream* streamToRead, int compressionLevel,
                       const String& storedPathName, Time fileModificationTime);
 
        bool writeToStream (OutputStream& target, double* progress) const;
 
        //==============================================================================
    private:
        class Item;
        friend struct ContainerDeletePolicy<Item>;
        OwnedArray<Item> items;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Builder)
    };
 
private:
    //==============================================================================
    class ZipInputStream;
    class ZipEntryHolder;
    friend class ZipInputStream;
    friend class ZipEntryHolder;
 
    OwnedArray<ZipEntryHolder> entries;
    CriticalSection lock;
    InputStream* inputStream;
    ScopedPointer<InputStream> streamToDelete;
    ScopedPointer<InputSource> inputSource;
 
   #if JUCE_DEBUG
    struct OpenStreamCounter
    {
        OpenStreamCounter() : numOpenStreams (0) {}
        ~OpenStreamCounter();
 
        int numOpenStreams;
    };
 
    OpenStreamCounter streamCounter;
   #endif
 
    void init();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ZipFile)
};
 
#endif   // JUCE_ZIPFILE_H_INCLUDED