X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ba0b7b323817e44903ba5ee199d17bbb166ed3d5..db06cdc08cee40c72854d6a883cf017c2bcc670e:/src/common/stream.cpp?ds=inline diff --git a/src/common/stream.cpp b/src/common/stream.cpp index a65c6154d8..1a03caa346 100644 --- a/src/common/stream.cpp +++ b/src/common/stream.cpp @@ -7,7 +7,7 @@ // Created: 11/07/98 // RCS-ID: $Id$ // Copyright: (c) Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -18,27 +18,23 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "stream.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_STREAMS + +#include "wx/stream.h" + #ifndef WX_PRECOMP - #include "wx/defs.h" + #include "wx/log.h" #endif -#if wxUSE_STREAMS - #include -#include "wx/stream.h" #include "wx/datstrm.h" -#include "wx/objstrm.h" #include "wx/textfile.h" // ---------------------------------------------------------------------------- @@ -46,7 +42,7 @@ // ---------------------------------------------------------------------------- // the temporary buffer size used when copying from stream to stream -#define BUF_TEMP_SIZE 10000 +#define BUF_TEMP_SIZE 4096 // ============================================================================ // implementation @@ -58,7 +54,7 @@ void wxStreamBuffer::SetError(wxStreamError err) { - if ( m_stream->m_lasterror == wxStream_NOERROR ) + if ( m_stream && m_stream->m_lasterror == wxSTREAM_NO_ERROR ) m_stream->m_lasterror = err; } @@ -67,79 +63,67 @@ void wxStreamBuffer::InitBuffer() m_buffer_start = m_buffer_end = m_buffer_pos = NULL; - m_buffer_size = 0; - // there is nothing to destroy anyhow - m_destroybuf = FALSE; + // if we are going to allocate the buffer, we should free it later as well + m_destroybuf = true; } void wxStreamBuffer::Init() { InitBuffer(); - m_fixed = TRUE; + m_fixed = true; } -wxStreamBuffer::wxStreamBuffer(wxStreamBase& stream, BufMode mode) +void wxStreamBuffer::InitWithStream(wxStreamBase& stream, BufMode mode) { Init(); m_stream = &stream; m_mode = mode; - m_flushable = TRUE; - m_destroystream = FALSE; + m_flushable = true; } wxStreamBuffer::wxStreamBuffer(BufMode mode) { Init(); - wxASSERT_MSG(mode != read_write, wxT("you have to use the other ctor for read_write mode") ); - if ( mode == read ) - m_stream = new wxInputStream; - else if ( mode == write) - m_stream = new wxOutputStream; - else - m_stream = NULL; - + m_stream = NULL; m_mode = mode; - m_flushable = FALSE; - m_destroystream = TRUE; + m_flushable = false; } wxStreamBuffer::wxStreamBuffer(const wxStreamBuffer& buffer) { - // doing this has big chances to lead to a crashwhen the source buffer is + // doing this has big chances to lead to a crash when the source buffer is // destroyed (otherwise assume the caller knows what he does) - wxASSERT_MSG( !buffer.m_destroybuf && !buffer.m_destroystream, - _T("it's a bad idea to copy this buffer") ); + wxASSERT_MSG( !buffer.m_destroybuf, + wxT("it's a bad idea to copy this buffer") ); m_buffer_start = buffer.m_buffer_start; m_buffer_end = buffer.m_buffer_end; m_buffer_pos = buffer.m_buffer_pos; - m_buffer_size = buffer.m_buffer_size; m_fixed = buffer.m_fixed; m_flushable = buffer.m_flushable; m_stream = buffer.m_stream; m_mode = buffer.m_mode; - m_destroybuf = FALSE; - m_destroystream = FALSE; + m_destroybuf = false; } void wxStreamBuffer::FreeBuffer() { if ( m_destroybuf ) + { free(m_buffer_start); + m_buffer_start = NULL; + } } wxStreamBuffer::~wxStreamBuffer() { FreeBuffer(); - - if ( m_destroystream ) - delete m_stream; } wxInputStream *wxStreamBuffer::GetInputStream() const @@ -170,8 +154,6 @@ void wxStreamBuffer::SetBufferIO(void *start, m_buffer_start = (char *)start; m_buffer_end = m_buffer_start + len; - m_buffer_size = len; - // if we own it, we free it m_destroybuf = takeOwnership; @@ -180,29 +162,51 @@ void wxStreamBuffer::SetBufferIO(void *start, void wxStreamBuffer::SetBufferIO(size_t bufsize) { - // start by freeing the old buffer - FreeBuffer(); - if ( bufsize ) { - SetBufferIO(malloc(bufsize), bufsize, TRUE /* take ownership */); + // this will free the old buffer and allocate the new one + SetBufferIO(malloc(bufsize), bufsize, true /* take ownership */); } else // no buffer size => no buffer { + // still free the old one + FreeBuffer(); InitBuffer(); } } void wxStreamBuffer::ResetBuffer() { - wxCHECK_RET( m_stream, _T("should have a stream in wxStreamBuffer") ); + if ( m_stream ) + { + m_stream->Reset(); + m_stream->m_lastcount = 0; + } - m_stream->m_lasterror = wxStream_NOERROR; - m_stream->m_lastcount = 0; - if (m_mode == read && m_flushable) - m_buffer_pos = m_buffer_end; - else - m_buffer_pos = m_buffer_start; + m_buffer_pos = m_mode == read && m_flushable + ? m_buffer_end + : m_buffer_start; +} + +void wxStreamBuffer::Truncate() +{ + size_t new_size = m_buffer_pos - m_buffer_start; + if ( m_buffer_pos == m_buffer_end ) + return; + + if ( !new_size ) + { + FreeBuffer(); + InitBuffer(); + return; + } + + char *new_start = (char *)realloc(m_buffer_start, new_size); + wxCHECK_RET( new_size, wxT("shrinking buffer shouldn't fail") ); + + m_buffer_start = new_start; + m_buffer_end = m_buffer_start + new_size; + m_buffer_pos = m_buffer_end; } // fill the buffer with as much data as possible (only for read buffers) @@ -210,39 +214,41 @@ bool wxStreamBuffer::FillBuffer() { wxInputStream *inStream = GetInputStream(); - wxCHECK_MSG( inStream, FALSE, _T("should have a stream in wxStreamBuffer") ); + // It's legal to have no stream, so we don't complain about it just return false + if ( !inStream ) + return false; - size_t count = inStream->OnSysRead(m_buffer_start, m_buffer_size); + size_t count = inStream->OnSysRead(GetBufferStart(), GetBufferSize()); if ( !count ) - return FALSE; + return false; m_buffer_end = m_buffer_start + count; m_buffer_pos = m_buffer_start; - return TRUE; + return true; } // write the buffer contents to the stream (only for write buffers) bool wxStreamBuffer::FlushBuffer() { - wxCHECK_MSG( m_flushable, FALSE, _T("can't flush this buffer") ); + wxCHECK_MSG( m_flushable, false, wxT("can't flush this buffer") ); // FIXME: what is this check for? (VZ) if ( m_buffer_pos == m_buffer_start ) - return FALSE; + return false; wxOutputStream *outStream = GetOutputStream(); - wxCHECK_MSG( outStream, FALSE, _T("should have a stream in wxStreamBuffer") ); + wxCHECK_MSG( outStream, false, wxT("should have a stream in wxStreamBuffer") ); size_t current = m_buffer_pos - m_buffer_start; size_t count = outStream->OnSysWrite(m_buffer_start, current); if ( count != current ) - return FALSE; + return false; m_buffer_pos = m_buffer_start; - return TRUE; + return true; } size_t wxStreamBuffer::GetDataLeft() @@ -271,6 +277,7 @@ void wxStreamBuffer::GetFromBuffer(void *buffer, size_t size) void wxStreamBuffer::PutToBuffer(const void *buffer, size_t size) { size_t left = GetBytesLeft(); + if ( size > left ) { if ( m_fixed ) @@ -281,24 +288,26 @@ void wxStreamBuffer::PutToBuffer(const void *buffer, size_t size) else // !m_fixed { // realloc the buffer to have enough space for the data - size_t delta = m_buffer_pos - m_buffer_start; - - char *startOld = m_buffer_start; - m_buffer_size += size; - m_buffer_start = (char *)realloc(m_buffer_start, m_buffer_size); - if ( !m_buffer_start ) + if ( m_buffer_pos + size > m_buffer_end ) { - // don't leak memory if realloc() failed - m_buffer_start = startOld; - m_buffer_size -= size; + size_t delta = m_buffer_pos - m_buffer_start; + size_t new_size = delta + size; - // what else can we do? - return; - } + char *startOld = m_buffer_start; + m_buffer_start = (char *)realloc(m_buffer_start, new_size); + if ( !m_buffer_start ) + { + // don't leak memory if realloc() failed + m_buffer_start = startOld; + + // what else can we do? + return; + } - // adjust the pointers invalidated by realloc() - m_buffer_pos = m_buffer_start + delta; - m_buffer_end = m_buffer_start + m_buffer_size; + // adjust the pointers invalidated by realloc() + m_buffer_pos = m_buffer_start + delta; + m_buffer_end = m_buffer_start + new_size; + } // else: the buffer is big enough } } @@ -310,12 +319,12 @@ void wxStreamBuffer::PutChar(char c) { wxOutputStream *outStream = GetOutputStream(); - wxCHECK_RET( outStream, _T("should have a stream in wxStreamBuffer") ); + wxCHECK_RET( outStream, wxT("should have a stream in wxStreamBuffer") ); // if we don't have buffer at all, just forward this call to the stream, if ( !HasBuffer() ) { - outStream->OnSysWrite(&c, 1); + outStream->OnSysWrite(&c, sizeof(c)); } else { @@ -323,11 +332,11 @@ void wxStreamBuffer::PutChar(char c) if ( !GetDataLeft() && !FlushBuffer() ) { // we don't - SetError(wxStream_WRITE_ERR); + SetError(wxSTREAM_WRITE_ERROR); } else { - PutToBuffer(&c, 1); + PutToBuffer(&c, sizeof(c)); m_stream->m_lastcount = 1; } } @@ -336,16 +345,16 @@ void wxStreamBuffer::PutChar(char c) char wxStreamBuffer::Peek() { wxCHECK_MSG( m_stream && HasBuffer(), 0, - _T("should have the stream and the buffer in wxStreamBuffer") ); + wxT("should have the stream and the buffer in wxStreamBuffer") ); if ( !GetDataLeft() ) { - SetError(wxStream_READ_ERR); + SetError(wxSTREAM_READ_ERROR); return 0; } char c; - GetFromBuffer(&c, 1); + GetFromBuffer(&c, sizeof(c)); m_buffer_pos--; return c; @@ -355,23 +364,23 @@ char wxStreamBuffer::GetChar() { wxInputStream *inStream = GetInputStream(); - wxCHECK_MSG( inStream, 0, _T("should have a stream in wxStreamBuffer") ); + wxCHECK_MSG( inStream, 0, wxT("should have a stream in wxStreamBuffer") ); char c; if ( !HasBuffer() ) { - inStream->OnSysRead(&c, 1); + inStream->OnSysRead(&c, sizeof(c)); } else { if ( !GetDataLeft() ) { - SetError(wxStream_READ_ERR); + SetError(wxSTREAM_READ_ERROR); c = 0; } else { - GetFromBuffer(&c, 1); + GetFromBuffer(&c, sizeof(c)); m_stream->m_lastcount = 1; } } @@ -381,16 +390,23 @@ char wxStreamBuffer::GetChar() size_t wxStreamBuffer::Read(void *buffer, size_t size) { - wxInputStream *inStream = GetInputStream(); + wxASSERT_MSG( buffer, wxT("Warning: Null pointer is about to be used") ); - wxCHECK_MSG( inStream, 0, _T("should have a stream in wxStreamBuffer") ); + /* Clear buffer first */ + memset(buffer, 0x00, size); // lasterror is reset before all new IO calls - m_stream->m_lasterror = wxStream_NOERROR; + if ( m_stream ) + m_stream->Reset(); + size_t readBytes; if ( !HasBuffer() ) { - m_stream->m_lastcount = inStream->OnSysRead(buffer, size); + wxInputStream *inStream = GetInputStream(); + + wxCHECK_MSG( inStream, 0, wxT("should have a stream in wxStreamBuffer") ); + + readBytes = inStream->OnSysRead(buffer, size); } else // we have a buffer, use it { @@ -410,7 +426,7 @@ size_t wxStreamBuffer::Read(void *buffer, size_t size) if ( !FillBuffer() ) { - SetError(wxStream_EOF); + SetError(wxSTREAM_EOF); break; } } @@ -421,16 +437,19 @@ size_t wxStreamBuffer::Read(void *buffer, size_t size) } } - m_stream->m_lastcount = orig_size - size; + readBytes = orig_size - size; } - return m_stream->m_lastcount; + if ( m_stream ) + m_stream->m_lastcount = readBytes; + + return readBytes; } // this should really be called "Copy()" size_t wxStreamBuffer::Read(wxStreamBuffer *dbuf) { - wxCHECK_MSG( m_mode != write, 0, _T("can't read from this buffer") ); + wxCHECK_MSG( m_mode != write, 0, wxT("can't read from this buffer") ); char buf[BUF_TEMP_SIZE]; size_t nRead, @@ -438,7 +457,7 @@ size_t wxStreamBuffer::Read(wxStreamBuffer *dbuf) do { - nRead = Read(dbuf, WXSIZEOF(buf)); + nRead = Read(buf, WXSIZEOF(buf)); if ( nRead ) { nRead = dbuf->Write(buf, nRead); @@ -452,17 +471,24 @@ size_t wxStreamBuffer::Read(wxStreamBuffer *dbuf) size_t wxStreamBuffer::Write(const void *buffer, size_t size) { - wxOutputStream *outStream = GetOutputStream(); + wxASSERT_MSG( buffer, wxT("Warning: Null pointer is about to be send") ); - wxCHECK_MSG( outStream, 0, _T("should have a stream in wxStreamBuffer") ); + if (m_stream) + { + // lasterror is reset before all new IO calls + m_stream->Reset(); + } - // lasterror is reset before all new IO calls - m_stream->m_lasterror = wxStream_NOERROR; + size_t ret; if ( !HasBuffer() && m_fixed ) { + wxOutputStream *outStream = GetOutputStream(); + + wxCHECK_MSG( outStream, 0, wxT("should have a stream in wxStreamBuffer") ); + // no buffer, just forward the call to the stream - m_stream->m_lastcount = outStream->OnSysWrite(buffer, size); + ret = outStream->OnSysWrite(buffer, size); } else // we [may] have a buffer, use it { @@ -480,6 +506,7 @@ size_t wxStreamBuffer::Write(const void *buffer, size_t size) // // FIXME: fine, but if it fails we should (re)try writing it by // chunks as this will (hopefully) always work (VZ) + if ( size > left && m_fixed ) { PutToBuffer(buffer, left); @@ -488,7 +515,7 @@ size_t wxStreamBuffer::Write(const void *buffer, size_t size) if ( !FlushBuffer() ) { - SetError(wxStream_WRITE_ERR); + SetError(wxSTREAM_WRITE_ERROR); break; } @@ -502,16 +529,22 @@ size_t wxStreamBuffer::Write(const void *buffer, size_t size) } } - m_stream->m_lastcount = orig_size - size; + ret = orig_size - size; + } + + if (m_stream) + { + // i am not entirely sure what we do this for + m_stream->m_lastcount = ret; } - return m_stream->m_lastcount; + return ret; } size_t wxStreamBuffer::Write(wxStreamBuffer *sbuf) { - wxCHECK_MSG( m_mode != read, 0, _T("can't write to this buffer") ); - wxCHECK_MSG( sbuf->m_mode != write, 0, _T("can't read from that buffer") ); + wxCHECK_MSG( m_mode != read, 0, wxT("can't write to this buffer") ); + wxCHECK_MSG( sbuf->m_mode != write, 0, wxT("can't read from that buffer") ); char buf[BUF_TEMP_SIZE]; size_t nWrite, @@ -543,11 +576,11 @@ size_t wxStreamBuffer::Write(wxStreamBuffer *sbuf) return total; } -off_t wxStreamBuffer::Seek(off_t pos, wxSeekMode mode) +wxFileOffset wxStreamBuffer::Seek(wxFileOffset pos, wxSeekMode mode) { - off_t ret_off, diff; + wxFileOffset ret_off, diff; - off_t last_access = GetLastAccess(); + wxFileOffset last_access = GetLastAccess(); if ( !m_flushable ) { @@ -566,13 +599,15 @@ off_t wxStreamBuffer::Seek(off_t pos, wxSeekMode mode) break; default: - wxFAIL_MSG( _T("invalid seek mode") ); + wxFAIL_MSG( wxT("invalid seek mode") ); return wxInvalidOffset; } if (diff < 0 || diff > last_access) return wxInvalidOffset; - SetIntPosition(diff); + size_t int_diff = wx_truncate_cast(size_t, diff); + wxCHECK_MSG( (wxFileOffset)int_diff == diff, wxInvalidOffset, wxT("huge file not supported") ); + SetIntPosition(int_diff); return diff; } @@ -597,8 +632,10 @@ off_t wxStreamBuffer::Seek(off_t pos, wxSeekMode mode) } else { - SetIntPosition(diff); - return pos; + size_t int_diff = wx_truncate_cast(size_t, diff); + wxCHECK_MSG( (wxFileOffset)int_diff == diff, wxInvalidOffset, wxT("huge file not supported") ); + SetIntPosition(int_diff); + return diff; } case wxFromEnd: @@ -611,11 +648,21 @@ off_t wxStreamBuffer::Seek(off_t pos, wxSeekMode mode) return wxInvalidOffset; } -off_t wxStreamBuffer::Tell() const +wxFileOffset wxStreamBuffer::Tell() const { - off_t pos = m_stream->OnSysTell(); - if ( pos == wxInvalidOffset ) - return wxInvalidOffset; + wxFileOffset pos; + + // ask the stream for position if we have a real one + if ( m_stream ) + { + pos = m_stream->OnSysTell(); + if ( pos == wxInvalidOffset ) + return wxInvalidOffset; + } + else // no associated stream + { + pos = 0; + } pos += GetIntPosition(); @@ -629,9 +676,11 @@ off_t wxStreamBuffer::Tell() const // wxStreamBase // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxStreamBase, wxObject) + wxStreamBase::wxStreamBase() { - m_lasterror = wxStream_NOERROR; + m_lasterror = wxSTREAM_NO_ERROR; m_lastcount = 0; } @@ -639,12 +688,24 @@ wxStreamBase::~wxStreamBase() { } -off_t wxStreamBase::OnSysSeek(off_t WXUNUSED(seek), wxSeekMode WXUNUSED(mode)) +size_t wxStreamBase::GetSize() const +{ + wxFileOffset length = GetLength(); + if ( length == (wxFileOffset)wxInvalidOffset ) + return 0; + + const size_t len = wx_truncate_cast(size_t, length); + wxASSERT_MSG( len == length + size_t(0), wxT("large files not supported") ); + + return len; +} + +wxFileOffset wxStreamBase::OnSysSeek(wxFileOffset WXUNUSED(seek), wxSeekMode WXUNUSED(mode)) { return wxInvalidOffset; } -off_t wxStreamBase::OnSysTell() const +wxFileOffset wxStreamBase::OnSysTell() const { return wxInvalidOffset; } @@ -653,6 +714,8 @@ off_t wxStreamBase::OnSysTell() const // wxInputStream // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxInputStream, wxStreamBase) + wxInputStream::wxInputStream() { m_wback = NULL; @@ -665,31 +728,19 @@ wxInputStream::~wxInputStream() free(m_wback); } -size_t wxInputStream::OnSysRead(void * WXUNUSED(buffer), - size_t WXUNUSED(bufsize)) +bool wxInputStream::CanRead() const { - return 0; + // we don't know if there is anything to read or not and by default we + // prefer to be optimistic and try to read data unless we know for sure + // there is no more of it + return m_lasterror != wxSTREAM_EOF; } bool wxInputStream::Eof() const { - wxInputStream *self = wxConstCast(this, wxInputStream); - - char c; - self->Read(&c, 1); - - // some streams can know that they're at EOF before actually trying to - // read beyond the end of stream (e.g. files) while others have no way of - // knowing it, so to provide the same behaviour in all cases we only - // return TRUE from here if the character really couldn't be read - if ( !self->LastRead() && GetLastError() == wxSTREAM_EOF ) - { - return TRUE; - } - - self->Ungetch(c); - - return FALSE; + // the only way the base class can know we're at EOF is when we'd already + // tried to read beyond it in which case last error is set accordingly + return GetLastError() == wxSTREAM_EOF; } char *wxInputStream::AllocSpaceWBack(size_t needed_size) @@ -703,14 +754,14 @@ char *wxInputStream::AllocSpaceWBack(size_t needed_size) if (!temp_b) return NULL; - /* copy previous data (and free old buffer) if needed */ + // copy previous data (and free old buffer) if needed if (m_wback) { memmove(temp_b + needed_size, m_wback + m_wbackcur, toget); free(m_wback); } - /* done */ + // done m_wback = temp_b; m_wbackcur = 0; m_wbacksize = needed_size + toget; @@ -718,78 +769,119 @@ char *wxInputStream::AllocSpaceWBack(size_t needed_size) return m_wback; } -size_t wxInputStream::GetWBack(void *buf, size_t bsize) +size_t wxInputStream::GetWBack(void *buf, size_t size) { - size_t toget = m_wbacksize-m_wbackcur; + wxASSERT_MSG( buf, wxT("Warning: Null pointer is about to be used") ); + + /* Clear buffer first */ + memset(buf, 0x00, size); if (!m_wback) return 0; - if (bsize < toget) - toget = bsize; + // how many bytes do we have in the buffer? + size_t toget = m_wbacksize - m_wbackcur; + + if ( size < toget ) + { + // we won't read everything + toget = size; + } - memcpy(buf, (m_wback+m_wbackcur), toget); + // copy the data from the cache + memcpy(buf, m_wback + m_wbackcur, toget); m_wbackcur += toget; - if (m_wbackcur == m_wbacksize) + if ( m_wbackcur == m_wbacksize ) { + // TODO: should we really free it here all the time? maybe keep it? free(m_wback); m_wback = NULL; m_wbacksize = 0; m_wbackcur = 0; } + // return the number of bytes copied return toget; } size_t wxInputStream::Ungetch(const void *buf, size_t bufsize) { + wxASSERT_MSG( buf, wxT("Warning: Null pointer is about to be used in Ungetch()") ); + + if ( m_lasterror != wxSTREAM_NO_ERROR && m_lasterror != wxSTREAM_EOF ) + { + // can't operate on this stream until the error is cleared + return 0; + } + char *ptrback = AllocSpaceWBack(bufsize); if (!ptrback) return 0; + // Eof() shouldn't return true any longer + if ( m_lasterror == wxSTREAM_EOF ) + m_lasterror = wxSTREAM_NO_ERROR; + memcpy(ptrback, buf, bufsize); return bufsize; } bool wxInputStream::Ungetch(char c) { - void *ptrback = AllocSpaceWBack(1); - if (!ptrback) - return FALSE; - - *(char *)ptrback = c; - return TRUE; + return Ungetch(&c, sizeof(c)) != 0; } -char wxInputStream::GetC() +int wxInputStream::GetC() { - char c; - Read(&c, 1); - return c; + unsigned char c; + Read(&c, sizeof(c)); + return LastRead() ? c : wxEOF; } wxInputStream& wxInputStream::Read(void *buf, size_t size) { - size_t retsize = GetWBack(buf, size); - if (retsize == size) + wxASSERT_MSG( buf, wxT("Warning: Null pointer is about to be read") ); + + char *p = (char *)buf; + m_lastcount = 0; + + size_t read = GetWBack(buf, size); + for ( ;; ) { - m_lastcount = size; - m_lasterror = wxStream_NOERROR; - return *this; + size -= read; + m_lastcount += read; + p += read; + + if ( !size ) + { + // we read the requested amount of data + break; + } + + if ( p != buf && !CanRead() ) + { + // we have already read something and we would block in OnSysRead() + // now: don't do it but return immediately + break; + } + + read = OnSysRead(p, size); + if ( !read ) + { + // no more data available + break; + } } - size -= retsize; - buf = (char *)buf + retsize; - m_lastcount = OnSysRead(buf, size) + retsize; return *this; } char wxInputStream::Peek() { char c; - Read(&c, 1); - if (m_lasterror == wxStream_NOERROR) + Read(&c, sizeof(c)); + if (m_lasterror == wxSTREAM_NO_ERROR) { Ungetch(c); return c; @@ -800,36 +892,86 @@ char wxInputStream::Peek() wxInputStream& wxInputStream::Read(wxOutputStream& stream_out) { + size_t lastcount = 0; char buf[BUF_TEMP_SIZE]; - size_t bytes_read = BUF_TEMP_SIZE; - while (bytes_read == BUF_TEMP_SIZE) + for ( ;; ) { - bytes_read = Read(buf, bytes_read).LastRead(); - bytes_read = stream_out.Write(buf, bytes_read).LastWrite(); + size_t bytes_read = Read(buf, WXSIZEOF(buf)).LastRead(); + if ( !bytes_read ) + break; + + if ( stream_out.Write(buf, bytes_read).LastWrite() != bytes_read ) + break; + + lastcount += bytes_read; } + + m_lastcount = lastcount; + return *this; } -off_t wxInputStream::SeekI(off_t pos, wxSeekMode mode) +wxFileOffset wxInputStream::SeekI(wxFileOffset pos, wxSeekMode mode) { - /* Should be check and improve, just to remove a slight bug ! - I don't know whether it should be put as well in wxFileInputStream::OnSysSeek ? */ + // RR: This code is duplicated in wxBufferedInputStream. This is + // not really a good design, but buffered stream are different + // from all others in that they handle two stream-related objects: + // the stream buffer and parent stream. + + // I don't know whether it should be put as well in wxFileInputStream::OnSysSeek if (m_lasterror==wxSTREAM_EOF) - m_lasterror=wxSTREAM_NOERROR; + m_lasterror=wxSTREAM_NO_ERROR; + + // avoid unnecessary seek operations (optimization) + wxFileOffset currentPos = TellI(), size = GetLength(); + if ((mode == wxFromStart && currentPos == pos) || + (mode == wxFromCurrent && pos == 0) || + (mode == wxFromEnd && size != wxInvalidOffset && currentPos == size-pos)) + return currentPos; - /* A call to SeekI() will automatically invalidate any previous call - to Ungetch(), otherwise it would be possible to SeekI() to one + if (!IsSeekable() && mode == wxFromCurrent && pos > 0) + { + // rather than seeking, we can just read data and discard it; + // this allows to forward-seek also non-seekable streams! + char buf[BUF_TEMP_SIZE]; + size_t bytes_read; + + // read chunks of BUF_TEMP_SIZE bytes until we reach the new position + for ( ; pos >= BUF_TEMP_SIZE; pos -= bytes_read) + { + bytes_read = Read(buf, WXSIZEOF(buf)).LastRead(); + if ( m_lasterror != wxSTREAM_NO_ERROR ) + return wxInvalidOffset; + + wxASSERT(bytes_read == WXSIZEOF(buf)); + } + + // read the last 'pos' bytes + bytes_read = Read(buf, (size_t)pos).LastRead(); + if ( m_lasterror != wxSTREAM_NO_ERROR ) + return wxInvalidOffset; + + wxASSERT(bytes_read == (size_t)pos); + + // we should now have seeked to the right position... + return TellI(); + } + + /* RR: A call to SeekI() will automatically invalidate any previous + call to Ungetch(), otherwise it would be possible to SeekI() to one position, unread some bytes there, SeekI() to another position and the data would be corrupted. GRG: Could add code here to try to navigate within the wback buffer if possible, but is it really needed? It would only work when seeking in wxFromCurrent mode, else it would invalidate - anyway... - */ + anyway... */ + if (m_wback) { + wxLogDebug( wxT("Seeking in stream which has data written back to it.") ); + free(m_wback); m_wback = NULL; m_wbacksize = 0; @@ -839,10 +981,9 @@ off_t wxInputStream::SeekI(off_t pos, wxSeekMode mode) return OnSysSeek(pos, mode); } -off_t wxInputStream::TellI() const +wxFileOffset wxInputStream::TellI() const { - /* GRG: Changed to make it compatible with the wback buffer */ - off_t pos = OnSysTell(); + wxFileOffset pos = OnSysTell(); if (pos != wxInvalidOffset) pos -= (m_wbacksize - m_wbackcur); @@ -850,24 +991,13 @@ off_t wxInputStream::TellI() const return pos; } -// -------------------- -// Overloaded operators -// -------------------- - -#if wxUSE_SERIAL -wxInputStream& wxInputStream::operator>>(wxObject *& obj) -{ - wxObjectInputStream obj_s(*this); - obj = obj_s.LoadObject(); - return *this; -} -#endif // wxUSE_SERIAL - // ---------------------------------------------------------------------------- // wxOutputStream // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxOutputStream, wxStreamBase) + wxOutputStream::wxOutputStream() { } @@ -884,7 +1014,7 @@ size_t wxOutputStream::OnSysWrite(const void * WXUNUSED(buffer), void wxOutputStream::PutC(char c) { - Write(&c, 1); + Write(&c, sizeof(c)); } wxOutputStream& wxOutputStream::Write(const void *buffer, size_t size) @@ -899,12 +1029,12 @@ wxOutputStream& wxOutputStream::Write(wxInputStream& stream_in) return *this; } -off_t wxOutputStream::TellO() const +wxFileOffset wxOutputStream::TellO() const { return OnSysTell(); } -off_t wxOutputStream::SeekO(off_t pos, wxSeekMode mode) +wxFileOffset wxOutputStream::SeekO(wxFileOffset pos, wxSeekMode mode) { return OnSysSeek(pos, mode); } @@ -913,25 +1043,19 @@ void wxOutputStream::Sync() { } -#if wxUSE_SERIAL -wxOutputStream& wxOutputStream::operator<<(wxObject& obj) -{ - wxObjectOutputStream obj_s(*this); - obj_s.SaveObject(obj); - return *this; -} -#endif // wxUSE_SERIAL // ---------------------------------------------------------------------------- // wxCountingOutputStream // ---------------------------------------------------------------------------- +IMPLEMENT_DYNAMIC_CLASS(wxCountingOutputStream, wxOutputStream) + wxCountingOutputStream::wxCountingOutputStream () { m_currentPos = 0; } -size_t wxCountingOutputStream::GetSize() const +wxFileOffset wxCountingOutputStream::GetLength() const { return m_lastcount; } @@ -946,34 +1070,40 @@ size_t wxCountingOutputStream::OnSysWrite(const void *WXUNUSED(buffer), return m_currentPos; } -off_t wxCountingOutputStream::OnSysSeek(off_t pos, wxSeekMode mode) +wxFileOffset wxCountingOutputStream::OnSysSeek(wxFileOffset pos, wxSeekMode mode) { + ssize_t new_pos = wx_truncate_cast(ssize_t, pos); + switch ( mode ) { case wxFromStart: - m_currentPos = pos; + wxCHECK_MSG( (wxFileOffset)new_pos == pos, wxInvalidOffset, wxT("huge position not supported") ); break; case wxFromEnd: - m_currentPos = m_lastcount + pos; + new_pos = m_lastcount + new_pos; + wxCHECK_MSG( (wxFileOffset)new_pos == (wxFileOffset)(m_lastcount + pos), wxInvalidOffset, wxT("huge position not supported") ); break; case wxFromCurrent: - m_currentPos += pos; + new_pos = m_currentPos + new_pos; + wxCHECK_MSG( (wxFileOffset)new_pos == (wxFileOffset)(m_currentPos + pos), wxInvalidOffset, wxT("huge position not supported") ); break; default: - wxFAIL_MSG( _T("invalid seek mode") ); + wxFAIL_MSG( wxT("invalid seek mode") ); return wxInvalidOffset; } + m_currentPos = new_pos; + if (m_currentPos > m_lastcount) m_lastcount = m_currentPos; return m_currentPos; } -off_t wxCountingOutputStream::OnSysTell() const +wxFileOffset wxCountingOutputStream::OnSysTell() const { return m_currentPos; } @@ -982,62 +1112,165 @@ off_t wxCountingOutputStream::OnSysTell() const // wxFilterInputStream // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxFilterInputStream, wxInputStream) + wxFilterInputStream::wxFilterInputStream() + : m_parent_i_stream(NULL), + m_owns(false) { - m_parent_i_stream = NULL; } wxFilterInputStream::wxFilterInputStream(wxInputStream& stream) + : m_parent_i_stream(&stream), + m_owns(false) +{ +} + +wxFilterInputStream::wxFilterInputStream(wxInputStream *stream) + : m_parent_i_stream(stream), + m_owns(true) { - m_parent_i_stream = &stream; } wxFilterInputStream::~wxFilterInputStream() { + if (m_owns) + delete m_parent_i_stream; } // ---------------------------------------------------------------------------- // wxFilterOutputStream // ---------------------------------------------------------------------------- +IMPLEMENT_ABSTRACT_CLASS(wxFilterOutputStream, wxOutputStream) + wxFilterOutputStream::wxFilterOutputStream() + : m_parent_o_stream(NULL), + m_owns(false) { - m_parent_o_stream = NULL; } wxFilterOutputStream::wxFilterOutputStream(wxOutputStream& stream) + : m_parent_o_stream(&stream), + m_owns(false) +{ +} + +wxFilterOutputStream::wxFilterOutputStream(wxOutputStream *stream) + : m_parent_o_stream(stream), + m_owns(true) +{ +} + +bool wxFilterOutputStream::Close() { - m_parent_o_stream = &stream; + if (m_parent_o_stream && m_owns) + return m_parent_o_stream->Close(); + else + return true; } wxFilterOutputStream::~wxFilterOutputStream() { + if (m_owns) + delete m_parent_o_stream; } // ---------------------------------------------------------------------------- -// wxBufferedInputStream +// wxFilterClassFactoryBase // ---------------------------------------------------------------------------- -wxBufferedInputStream::wxBufferedInputStream(wxInputStream& s, - wxStreamBuffer *buffer) - : wxFilterInputStream(s) +IMPLEMENT_ABSTRACT_CLASS(wxFilterClassFactoryBase, wxObject) + +wxString wxFilterClassFactoryBase::PopExtension(const wxString& location) const { - if ( buffer ) + return location.substr(0, FindExtension(location)); +} + +wxString::size_type wxFilterClassFactoryBase::FindExtension( + const wxString& location) const +{ + for (const wxChar *const *p = GetProtocols(wxSTREAM_FILEEXT); *p; p++) { - // use the buffer provided by the user - m_i_streambuf = buffer; + if ( location.EndsWith(*p) ) + return location.length() - wxStrlen(*p); } - else // create a default buffer + + return wxString::npos; +} + +bool wxFilterClassFactoryBase::CanHandle(const wxString& protocol, + wxStreamProtocolType type) const +{ + if (type == wxSTREAM_FILEEXT) + return FindExtension(protocol) != wxString::npos; + else + for (const wxChar *const *p = GetProtocols(type); *p; p++) + if (protocol == *p) + return true; + + return false; +} + +// ---------------------------------------------------------------------------- +// wxFilterClassFactory +// ---------------------------------------------------------------------------- + +IMPLEMENT_ABSTRACT_CLASS(wxFilterClassFactory, wxFilterClassFactoryBase) + +wxFilterClassFactory *wxFilterClassFactory::sm_first = NULL; + +void wxFilterClassFactory::Remove() +{ + if (m_next != this) { - m_i_streambuf = new wxStreamBuffer(*this, wxStreamBuffer::read); + wxFilterClassFactory **pp = &sm_first; + + while (*pp != this) + pp = &(*pp)->m_next; + + *pp = m_next; - m_i_streambuf->SetBufferIO(1024); + m_next = this; } } +// ---------------------------------------------------------------------------- +// wxBufferedInputStream +// ---------------------------------------------------------------------------- + +namespace +{ + +// helper function used for initializing the buffer used by +// wxBufferedInput/OutputStream: it simply returns the provided buffer if it's +// not NULL or creates a buffer of the given size otherwise +template +wxStreamBuffer * +CreateBufferIfNeeded(T& stream, wxStreamBuffer *buffer, size_t bufsize = 1024) +{ + return buffer ? buffer : new wxStreamBuffer(bufsize, stream); +} + +} // anonymous namespace + +wxBufferedInputStream::wxBufferedInputStream(wxInputStream& stream, + wxStreamBuffer *buffer) + : wxFilterInputStream(stream) +{ + m_i_streambuf = CreateBufferIfNeeded(*this, buffer); +} + +wxBufferedInputStream::wxBufferedInputStream(wxInputStream& stream, + size_t bufsize) + : wxFilterInputStream(stream) +{ + m_i_streambuf = CreateBufferIfNeeded(*this, NULL, bufsize); +} + wxBufferedInputStream::~wxBufferedInputStream() { - m_parent_i_stream->SeekI(-(off_t)m_i_streambuf->GetBytesLeft(), + m_parent_i_stream->SeekI(-(wxFileOffset)m_i_streambuf->GetBytesLeft(), wxFromCurrent); delete m_i_streambuf; @@ -1050,31 +1283,61 @@ char wxBufferedInputStream::Peek() wxInputStream& wxBufferedInputStream::Read(void *buf, size_t size) { - size_t retsize; + // reset the error flag + Reset(); - retsize = GetWBack(buf, size); - m_lastcount = retsize; - if ( retsize == size ) + // first read from the already cached data + m_lastcount = GetWBack(buf, size); + + // do we have to read anything more? + if ( m_lastcount < size ) { - m_lasterror = wxStream_NOERROR; - return *this; - } - size -= retsize; - buf = (char *)buf + retsize; + size -= m_lastcount; + buf = (char *)buf + m_lastcount; - m_i_streambuf->Read(buf, size); + // the call to wxStreamBuffer::Read() below may reset our m_lastcount + // (but it also may not do it if the buffer is associated to another + // existing stream and wasn't created by us), so save it + size_t countOld = m_lastcount; + + // the new count of the bytes read is the count of bytes read this time + m_lastcount = m_i_streambuf->Read(buf, size); + + // plus those we had read before + m_lastcount += countOld; + } return *this; } -off_t wxBufferedInputStream::SeekI(off_t pos, wxSeekMode mode) +wxFileOffset wxBufferedInputStream::SeekI(wxFileOffset pos, wxSeekMode mode) { + // RR: Look at wxInputStream for comments. + + if (m_lasterror==wxSTREAM_EOF) + Reset(); + + if (m_wback) + { + wxLogDebug( wxT("Seeking in stream which has data written back to it.") ); + + free(m_wback); + m_wback = NULL; + m_wbacksize = 0; + m_wbackcur = 0; + } + return m_i_streambuf->Seek(pos, mode); } -off_t wxBufferedInputStream::TellI() const +wxFileOffset wxBufferedInputStream::TellI() const { - return m_i_streambuf->Tell(); + wxFileOffset pos = m_i_streambuf->Tell(); + + if (pos != wxInvalidOffset) + pos -= (m_wbacksize - m_wbackcur); + + return pos; } size_t wxBufferedInputStream::OnSysRead(void *buffer, size_t bufsize) @@ -1082,19 +1345,19 @@ size_t wxBufferedInputStream::OnSysRead(void *buffer, size_t bufsize) return m_parent_i_stream->Read(buffer, bufsize).LastRead(); } -off_t wxBufferedInputStream::OnSysSeek(off_t seek, wxSeekMode mode) +wxFileOffset wxBufferedInputStream::OnSysSeek(wxFileOffset seek, wxSeekMode mode) { return m_parent_i_stream->SeekI(seek, mode); } -off_t wxBufferedInputStream::OnSysTell() const +wxFileOffset wxBufferedInputStream::OnSysTell() const { return m_parent_i_stream->TellI(); } void wxBufferedInputStream::SetInputStreamBuffer(wxStreamBuffer *buffer) { - wxCHECK_RET( buffer, _T("wxBufferedInputStream needs buffer") ); + wxCHECK_RET( buffer, wxT("wxBufferedInputStream needs buffer") ); delete m_i_streambuf; m_i_streambuf = buffer; @@ -1104,20 +1367,18 @@ void wxBufferedInputStream::SetInputStreamBuffer(wxStreamBuffer *buffer) // wxBufferedOutputStream // ---------------------------------------------------------------------------- -wxBufferedOutputStream::wxBufferedOutputStream(wxOutputStream& s, +wxBufferedOutputStream::wxBufferedOutputStream(wxOutputStream& stream, wxStreamBuffer *buffer) - : wxFilterOutputStream(s) + : wxFilterOutputStream(stream) { - if ( buffer ) - { - m_o_streambuf = buffer; - } - else // create a default one - { - m_o_streambuf = new wxStreamBuffer(*this, wxStreamBuffer::write); + m_o_streambuf = CreateBufferIfNeeded(*this, buffer); +} - m_o_streambuf->SetBufferIO(1024); - } +wxBufferedOutputStream::wxBufferedOutputStream(wxOutputStream& stream, + size_t bufsize) + : wxFilterOutputStream(stream) +{ + m_o_streambuf = CreateBufferIfNeeded(*this, NULL, bufsize); } wxBufferedOutputStream::~wxBufferedOutputStream() @@ -1126,6 +1387,13 @@ wxBufferedOutputStream::~wxBufferedOutputStream() delete m_o_streambuf; } +bool wxBufferedOutputStream::Close() +{ + Sync(); + return IsOk(); +} + + wxOutputStream& wxBufferedOutputStream::Write(const void *buffer, size_t size) { m_lastcount = 0; @@ -1133,13 +1401,13 @@ wxOutputStream& wxBufferedOutputStream::Write(const void *buffer, size_t size) return *this; } -off_t wxBufferedOutputStream::SeekO(off_t pos, wxSeekMode mode) +wxFileOffset wxBufferedOutputStream::SeekO(wxFileOffset pos, wxSeekMode mode) { Sync(); return m_o_streambuf->Seek(pos, mode); } -off_t wxBufferedOutputStream::TellO() const +wxFileOffset wxBufferedOutputStream::TellO() const { return m_o_streambuf->Tell(); } @@ -1155,24 +1423,24 @@ size_t wxBufferedOutputStream::OnSysWrite(const void *buffer, size_t bufsize) return m_parent_o_stream->Write(buffer, bufsize).LastWrite(); } -off_t wxBufferedOutputStream::OnSysSeek(off_t seek, wxSeekMode mode) +wxFileOffset wxBufferedOutputStream::OnSysSeek(wxFileOffset seek, wxSeekMode mode) { return m_parent_o_stream->SeekO(seek, mode); } -off_t wxBufferedOutputStream::OnSysTell() const +wxFileOffset wxBufferedOutputStream::OnSysTell() const { return m_parent_o_stream->TellO(); } -size_t wxBufferedOutputStream::GetSize() const +wxFileOffset wxBufferedOutputStream::GetLength() const { - return m_parent_o_stream->GetSize() + m_o_streambuf->GetIntPosition(); + return m_parent_o_stream->GetLength() + m_o_streambuf->GetIntPosition(); } void wxBufferedOutputStream::SetOutputStreamBuffer(wxStreamBuffer *buffer) { - wxCHECK_RET( buffer, _T("wxBufferedOutputStream needs buffer") ); + wxCHECK_RET( buffer, wxT("wxBufferedOutputStream needs buffer") ); delete m_o_streambuf; m_o_streambuf = buffer; @@ -1189,5 +1457,4 @@ wxOutputStream& wxEndL(wxOutputStream& stream) return stream.Write(eol, wxStrlen(eol)); } -#endif - // wxUSE_STREAMS +#endif // wxUSE_STREAMS