Version: 3.1.1
wxArchiveInputStream Class Referenceabstract

#include <wx/archive.h>

+ Inheritance diagram for wxArchiveInputStream:

Detailed Description

This is an abstract base class which serves as a common interface to archive input streams such as wxZipInputStream.

wxArchiveInputStream::GetNextEntry returns an wxArchiveEntry object containing the meta-data for the next entry in the archive (and gives away ownership).

Reading from the wxArchiveInputStream then returns the entry's data. Eof() becomes true after an attempt has been made to read past the end of the entry's data.

When there are no more entries, GetNextEntry() returns NULL and sets Eof().

Library:  wxBase
Category:  Archive support, Streams
See also
Archive Formats, wxArchiveEntry, wxArchiveOutputStream

Public Member Functions

virtual bool CloseEntry ()=0
 Closes the current entry. More...
 
wxArchiveEntryGetNextEntry ()
 Closes the current entry if one is open, then reads the meta-data for the next entry and returns it in a wxArchiveEntry object, giving away ownership. More...
 
virtual bool OpenEntry (wxArchiveEntry &entry)=0
 Closes the current entry if one is open, then opens the entry specified by the wxArchiveEntry object. More...
 
- Public Member Functions inherited from wxFilterInputStream
 wxFilterInputStream (wxInputStream &stream)
 Initializes a "filter" stream. More...
 
 wxFilterInputStream (wxInputStream *stream)
 Initializes a "filter" stream. More...
 
- Public Member Functions inherited from wxInputStream
 wxInputStream ()
 Creates a dummy input stream. More...
 
virtual ~wxInputStream ()
 Destructor. More...
 
virtual bool CanRead () const
 Returns true if some data is available in the stream right now, so that calling Read() wouldn't block. More...
 
virtual bool Eof () const
 Returns true after an attempt has been made to read past the end of the stream. More...
 
int GetC ()
 Returns the first character in the input queue and removes it, blocking until it appears if necessary. More...
 
virtual size_t LastRead () const
 Returns the last number of bytes read. More...
 
virtual char Peek ()
 Returns the first character in the input queue without removing it. More...
 
virtual wxInputStreamRead (void *buffer, size_t size)
 Reads the specified amount of bytes and stores the data in buffer. More...
 
wxInputStreamRead (wxOutputStream &stream_out)
 Reads data from the input queue and stores it in the specified output stream. More...
 
bool ReadAll (void *buffer, size_t size)
 Reads exactly the specified number of bytes into the buffer. More...
 
virtual wxFileOffset SeekI (wxFileOffset pos, wxSeekMode mode=wxFromStart)
 Changes the stream current position. More...
 
virtual wxFileOffset TellI () const
 Returns the current stream position or wxInvalidOffset if it's not available (e.g. More...
 
size_t Ungetch (const void *buffer, size_t size)
 This function is only useful in read mode. More...
 
bool Ungetch (char c)
 This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function. More...
 
- Public Member Functions inherited from wxStreamBase
 wxStreamBase ()
 Creates a dummy stream object. More...
 
virtual ~wxStreamBase ()
 Destructor. More...
 
wxStreamError GetLastError () const
 This function returns the last error. More...
 
virtual wxFileOffset GetLength () const
 Returns the length of the stream in bytes. More...
 
virtual size_t GetSize () const
 This function returns the size of the stream. More...
 
virtual bool IsOk () const
 Returns true if no error occurred on the stream. More...
 
virtual bool IsSeekable () const
 Returns true if the stream supports seeking to arbitrary offsets. More...
 
void Reset (wxStreamError error=wxSTREAM_NO_ERROR)
 Resets the stream state. More...
 
bool operator! () const
 Returns the opposite of IsOk(). More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxInputStream
size_t OnSysRead (void *buffer, size_t bufsize)=0
 Internal function. More...
 
- Protected Member Functions inherited from wxStreamBase
virtual wxFileOffset OnSysSeek (wxFileOffset pos, wxSeekMode mode)
 Internal function. More...
 
virtual wxFileOffset OnSysTell () const
 Internal function. More...
 

Member Function Documentation

virtual bool wxArchiveInputStream::CloseEntry ( )
pure virtual

Closes the current entry.

On a non-seekable stream reads to the end of the current entry first.

Implemented in wxZipInputStream, and wxTarInputStream.

wxArchiveEntry* wxArchiveInputStream::GetNextEntry ( )

Closes the current entry if one is open, then reads the meta-data for the next entry and returns it in a wxArchiveEntry object, giving away ownership.

Reading this wxArchiveInputStream then returns the entry's data.

virtual bool wxArchiveInputStream::OpenEntry ( wxArchiveEntry entry)
pure virtual

Closes the current entry if one is open, then opens the entry specified by the wxArchiveEntry object.

entry must be from the same archive file that this wxArchiveInputStream is reading, and it must be reading it from a seekable stream.