juce::ZipFile Class Reference

Decodes a ZIP file from a stream. More...

#include <juce_ZipFile.h>

Collaboration diagram for juce::ZipFile:

Classes
class	Builder
	Used to create a new zip file. More...
struct	OpenStreamCounter
struct	ZipEntry
	Contains information about one of the entries in a ZipFile. More...

Public Types
enum	FollowSymlinks {   FollowSymlinks::no,   FollowSymlinks::yes }
enum	OverwriteFiles {   OverwriteFiles::no,   OverwriteFiles::yes }

Public Member Functions
	ZipFile (const File &file)
	Creates a ZipFile to read a specific file. More...
	ZipFile (InputSource *inputSource)
	Creates a ZipFile for an input source. More...
	ZipFile (InputStream &inputStream)
	Creates a ZipFile for a given stream. More...
	ZipFile (InputStream *inputStream, bool deleteStreamWhenDestroyed)
	Creates a ZipFile for a given stream. More...
	~ZipFile ()
	Destructor. More...
InputStream *	createStreamForEntry (const ZipEntry &entry)
	Creates a stream that can read from one of the zip file's entries. More...
InputStream *	createStreamForEntry (int index)
	Creates a stream that can read from one of the zip file's entries. More...
const ZipEntry *	getEntry (const String &fileName, bool ignoreCase=false) const noexcept
	Returns a structure that describes one of the entries in the zip file. More...
const ZipEntry *	getEntry (int index) const noexcept
	Returns a structure that describes one of the entries in the zip file. More...
int	getIndexOfFileName (const String &fileName, bool ignoreCase=false) const noexcept
	Returns the index of the first entry with a given filename. More...
int	getNumEntries () const noexcept
	Returns the number of items in the zip file. More...
void	sortEntriesByFilename ()
	Sorts the list of entries, based on the filename. More...
Result	uncompressEntry (int index, const File &targetDirectory, bool shouldOverwriteFiles=true)
	Uncompresses one of the entries from the zip file. More...
Result	uncompressEntry (int index, const File &targetDirectory, OverwriteFiles overwriteFiles, FollowSymlinks followSymlinks)
	Uncompresses one of the entries from the zip file. More...
Result	uncompressTo (const File &targetDirectory, bool shouldOverwriteFiles=true)
	Uncompresses all of the files in the zip file. More...

Private Member Functions
void	init ()

Private Attributes
OwnedArray< ZipEntryHolder >	entries
std::unique_ptr< InputSource >	inputSource
InputStream *	inputStream = nullptr
CriticalSection	lock
OpenStreamCounter	streamCounter
std::unique_ptr< InputStream >	streamToDelete

Detailed Description

Decodes a ZIP file from a stream.

This can enumerate the items in a ZIP file and can create suitable stream objects to read each one.

@tags{Core}

Member Enumeration Documentation

FollowSymlinks

enum juce::ZipFile::FollowSymlinks

strong

Enumerator
no
yes

OverwriteFiles

enum juce::ZipFile::OverwriteFiles

strong

Enumerator
no
yes

Constructor & Destructor Documentation

ZipFile() [1/4]

juce::ZipFile::ZipFile ( const File &  file )

explicit

Creates a ZipFile to read a specific file.

ZipFile() [2/4]

juce::ZipFile::ZipFile	(	InputStream *	inputStream,
		bool	deleteStreamWhenDestroyed
	)

Creates a ZipFile for a given stream.

Parameters

inputStream	the stream to read from
deleteStreamWhenDestroyed	if set to true, the object passed-in will be deleted when this ZipFile object is deleted

ZipFile() [3/4]

juce::ZipFile::ZipFile ( InputStream &  inputStream )

explicit

Creates a ZipFile for a given stream.

The stream will not be owned or deleted by this class - if you want the ZipFile to manage the stream's lifetime, use the other constructor.

ZipFile() [4/4]

juce::ZipFile::ZipFile ( InputSource *  inputSource )

explicit

Creates a ZipFile for an input source.

The inputSource object will be owned by the zip file, which will delete it later when not needed.

~ZipFile()

juce::ZipFile::~ZipFile

(

)

Destructor.

Member Function Documentation

createStreamForEntry() [1/2]

InputStream* juce::ZipFile::createStreamForEntry

(

const ZipEntry &

entry

)

Creates a stream that can read from one of the zip file's entries.

The stream that is returned must be deleted by the caller (and a nullptr might be returned if a stream can't be opened for some reason).

The stream must not be used after the ZipFile object that created has been deleted.

Note that if the ZipFile was created with a user-supplied InputStream object, then all the streams which are created by this method will by trying to share the same source stream, so cannot be safely used on multiple threads! (But if you create the ZipFile from a File or InputSource, then it is safe to do this).

createStreamForEntry() [2/2]

InputStream* juce::ZipFile::createStreamForEntry

(

int

index

)

Creates a stream that can read from one of the zip file's entries.

The stream that is returned must be deleted by the caller (and a nullptr might be returned if a stream can't be opened for some reason).

The stream must not be used after the ZipFile object that created has been deleted.

Note that if the ZipFile was created with a user-supplied InputStream object, then all the streams which are created by this method will by trying to share the same source stream, so cannot be safely used on multiple threads! (But if you create the ZipFile from a File or InputSource, then it is safe to do this).

getEntry() [1/2]

const ZipEntry* juce::ZipFile::getEntry ( const String &  fileName, bool  ignoreCase = false  ) const

noexcept

Returns a structure that describes one of the entries in the zip file.

This uses a case-sensitive comparison to look for a filename in the list of entries. It might return 0 if no match is found.

See also

ZipFile::ZipEntry

getEntry() [2/2]

const ZipEntry* juce::ZipFile::getEntry ( int  index ) const

noexcept

Returns a structure that describes one of the entries in the zip file.

This may return a nullptr if the index is out of range.

See also

ZipFile::ZipEntry

getIndexOfFileName()

int juce::ZipFile::getIndexOfFileName ( const String &  fileName, bool  ignoreCase = false  ) const

noexcept

Returns the index of the first entry with a given filename.

This uses a case-sensitive comparison to look for a filename in the list of entries. It might return -1 if no match is found.

See also

ZipFile::ZipEntry

getNumEntries()

int juce::ZipFile::getNumEntries ( ) const

noexcept

Returns the number of items in the zip file.

init()

void juce::ZipFile::init ( )

private

sortEntriesByFilename()

void juce::ZipFile::sortEntriesByFilename

(

)

Sorts the list of entries, based on the filename.

uncompressEntry() [1/2]

Result juce::ZipFile::uncompressEntry	(	int	index,
		const File &	targetDirectory,
		bool	shouldOverwriteFiles = true
	)

Uncompresses one of the entries from the zip file.

This will expand the entry and write it in a target directory. The entry's path is used to determine which subfolder of the target should contain the new file.

Parameters

index	the index of the entry to uncompress - this must be a valid index between 0 and (getNumEntries() - 1).
targetDirectory	the root folder to uncompress into
shouldOverwriteFiles	whether to overwrite existing files with similarly-named ones

Returns

success if all the files are successfully unzipped

uncompressEntry() [2/2]

Result juce::ZipFile::uncompressEntry	(	int	index,
		const File &	targetDirectory,
		OverwriteFiles	overwriteFiles,
		FollowSymlinks	followSymlinks
	)

Uncompresses one of the entries from the zip file.

This will expand the entry and write it in a target directory. The entry's path is used to determine which subfolder of the target should contain the new file.

Parameters

index	the index of the entry to uncompress - this must be a valid index between 0 and (getNumEntries() - 1).
targetDirectory	the root folder to uncompress into
overwriteFiles	whether to overwrite existing files with similarly-named ones
followSymlinks	whether to follow symlinks inside the target directory

Returns

success if all the files are successfully unzipped

uncompressTo()

Result juce::ZipFile::uncompressTo	(	const File &	targetDirectory,
		bool	shouldOverwriteFiles = true
	)

Uncompresses all of the files in the zip file.

This will expand all the entries into a target directory. The relative paths of the entries are used.

Parameters

targetDirectory	the root folder to uncompress to
shouldOverwriteFiles	whether to overwrite existing files with similarly-named ones

Returns

success if the file is successfully unzipped

Member Data Documentation

entries

OwnedArray<ZipEntryHolder> juce::ZipFile::entries

private

inputSource

std::unique_ptr<InputSource> juce::ZipFile::inputSource

private

inputStream

InputStream* juce::ZipFile::inputStream = nullptr

private

lock

CriticalSection juce::ZipFile::lock

private

streamCounter

OpenStreamCounter juce::ZipFile::streamCounter

private

streamToDelete

std::unique_ptr<InputStream> juce::ZipFile::streamToDelete

private

---

The documentation for this class was generated from the following file:

• juce_ZipFile.h