]> git.saurik.com Git - wxWidgets.git/blob - src/common/stream.cpp
Implement CanRead
[wxWidgets.git] / src / common / stream.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: stream.cpp
3 // Purpose: wxStream base classes
4 // Author: Guilhem Lavaux
5 // Modified by:
6 // Created: 11/07/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Guilhem Lavaux
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifdef __GNUG__
13 #pragma implementation "stream.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif
22
23 #ifndef WX_PRECOMP
24 #include "wx/defs.h"
25 #endif
26
27 #if wxUSE_STREAMS
28
29 #include <ctype.h>
30 #include <wx/stream.h>
31 #include <wx/datstrm.h>
32 #include <wx/objstrm.h>
33
34 #define BUF_TEMP_SIZE 10000
35
36 // ----------------------------------------------------------------------------
37 // wxStreamBuffer
38 // ----------------------------------------------------------------------------
39
40 #define CHECK_ERROR(err) \
41 if (m_stream->m_lasterror == wxStream_NOERROR) \
42 m_stream->m_lasterror = err
43
44 wxStreamBuffer::wxStreamBuffer(wxStreamBase& stream, BufMode mode)
45 : m_buffer_start(NULL), m_buffer_end(NULL), m_buffer_pos(NULL),
46 m_buffer_size(0), m_fixed(TRUE), m_flushable(TRUE), m_stream(&stream),
47 m_mode(mode), m_destroybuf(FALSE), m_destroystream(FALSE)
48 {
49 }
50
51 wxStreamBuffer::wxStreamBuffer(BufMode mode)
52 : m_buffer_start(NULL), m_buffer_end(NULL), m_buffer_pos(NULL),
53 m_buffer_size(0), m_fixed(TRUE), m_flushable(FALSE), m_stream(NULL),
54 m_mode(mode), m_destroybuf(FALSE), m_destroystream(TRUE)
55 {
56 m_stream = new wxStreamBase();
57 }
58
59 wxStreamBuffer::wxStreamBuffer(const wxStreamBuffer& buffer)
60 {
61 m_buffer_start = buffer.m_buffer_start;
62 m_buffer_end = buffer.m_buffer_end;
63 m_buffer_pos = buffer.m_buffer_pos;
64 m_buffer_size = buffer.m_buffer_size;
65 m_fixed = buffer.m_fixed;
66 m_flushable = buffer.m_flushable;
67 m_stream = buffer.m_stream;
68 m_mode = buffer.m_mode;
69 m_destroybuf = FALSE;
70 m_destroystream = FALSE;
71 }
72
73 wxStreamBuffer::~wxStreamBuffer()
74 {
75 if (m_destroybuf)
76 wxDELETEA(m_buffer_start);
77 if (m_destroystream)
78 delete m_stream;
79 }
80
81 void wxStreamBuffer::SetBufferIO(char *buffer_start, char *buffer_end)
82 {
83 if (m_destroybuf)
84 wxDELETEA(m_buffer_start);
85 m_buffer_start = buffer_start;
86 m_buffer_end = buffer_end;
87
88 m_buffer_size = m_buffer_end-m_buffer_start;
89 m_destroybuf = FALSE;
90 ResetBuffer();
91 }
92
93 void wxStreamBuffer::SetBufferIO(size_t bufsize)
94 {
95 char *b_start;
96
97 if (m_destroybuf)
98 wxDELETEA(m_buffer_start);
99
100 if (!bufsize) {
101 m_buffer_start = NULL;
102 m_buffer_end = NULL;
103 m_buffer_pos = NULL;
104 m_buffer_size = 0;
105 return;
106 }
107
108 b_start = new char[bufsize];
109 SetBufferIO(b_start, b_start + bufsize);
110 m_destroybuf = TRUE;
111 }
112
113 void wxStreamBuffer::ResetBuffer()
114 {
115 m_stream->m_lasterror = wxStream_NOERROR;
116 m_stream->m_lastcount = 0;
117 if (m_mode == read)
118 m_buffer_pos = m_buffer_end;
119 else
120 m_buffer_pos = m_buffer_start;
121 }
122
123 bool wxStreamBuffer::FillBuffer()
124 {
125 size_t count;
126
127 count = m_stream->OnSysRead(m_buffer_start, m_buffer_size);
128 m_buffer_end = m_buffer_start+count;
129 m_buffer_pos = m_buffer_start;
130
131 if (count == 0)
132 return FALSE;
133 return TRUE;
134 }
135
136 bool wxStreamBuffer::FlushBuffer()
137 {
138 size_t count, current;
139
140 if (m_buffer_pos == m_buffer_start || !m_flushable)
141 return FALSE;
142
143 current = m_buffer_pos-m_buffer_start;
144 count = m_stream->OnSysWrite(m_buffer_start, current);
145 if (count != current)
146 return FALSE;
147 m_buffer_pos = m_buffer_start;
148
149 return TRUE;
150 }
151
152 void wxStreamBuffer::GetFromBuffer(void *buffer, size_t size)
153 {
154 size_t s_toget = m_buffer_end-m_buffer_pos;
155
156 if (size < s_toget)
157 s_toget = size;
158
159 memcpy(buffer, m_buffer_pos, s_toget);
160 m_buffer_pos += s_toget;
161 }
162
163 void wxStreamBuffer::PutToBuffer(const void *buffer, size_t size)
164 {
165 size_t s_toput = m_buffer_end-m_buffer_pos;
166
167 if (s_toput < size && !m_fixed) {
168 m_buffer_start = (char *)realloc(m_buffer_start, m_buffer_size+size);
169 // I round a bit
170 m_buffer_size += size;
171 m_buffer_end = m_buffer_start+m_buffer_size;
172 s_toput = size;
173 }
174 if (s_toput > size)
175 s_toput = size;
176 memcpy(m_buffer_pos, buffer, s_toput);
177 m_buffer_pos += s_toput;
178 }
179
180 void wxStreamBuffer::PutChar(char c)
181 {
182 wxASSERT(m_stream != NULL);
183
184 if (!m_buffer_size) {
185 m_stream->OnSysWrite(&c, 1);
186 return;
187 }
188
189 if (GetDataLeft() == 0 && !FlushBuffer()) {
190 CHECK_ERROR(wxStream_WRITE_ERR);
191 return;
192 }
193
194 PutToBuffer(&c, 1);
195 m_stream->m_lastcount = 1;
196 }
197
198 char wxStreamBuffer::GetChar()
199 {
200 char c;
201
202 wxASSERT(m_stream != NULL);
203
204 if (!m_buffer_size) {
205 m_stream->OnSysRead(&c, 1);
206 return c;
207 }
208
209 if (!GetDataLeft()) {
210 CHECK_ERROR(wxStream_READ_ERR);
211 return 0;
212 }
213
214 GetFromBuffer(&c, 1);
215
216 m_stream->m_lastcount = 1;
217 return c;
218 }
219
220 size_t wxStreamBuffer::Read(void *buffer, size_t size)
221 {
222 wxASSERT(m_stream != NULL);
223
224 if (m_mode == write)
225 return 0;
226
227 // ------------------
228 // Buffering disabled
229 // ------------------
230
231 m_stream->m_lasterror = wxStream_NOERROR;
232 if (!m_buffer_size)
233 return (m_stream->m_lastcount += m_stream->OnSysRead(buffer, size));
234
235 // -----------------
236 // Buffering enabled
237 // -----------------
238 size_t buf_left, orig_size = size;
239
240 while (size > 0) {
241 buf_left = GetDataLeft();
242
243 // First case: the requested buffer is larger than the stream buffer,
244 // we split it.
245 if (size > buf_left) {
246 GetFromBuffer(buffer, buf_left);
247 size -= buf_left;
248 buffer = (char *)buffer + buf_left; // ANSI C++ violation.
249
250 if (!FillBuffer()) {
251 CHECK_ERROR(wxStream_READ_ERR);
252 return (m_stream->m_lastcount = orig_size-size);
253 }
254 } else {
255
256 // Second case: we just copy from the stream buffer.
257 GetFromBuffer(buffer, size);
258 break;
259 }
260 }
261 return (m_stream->m_lastcount += orig_size);
262 }
263
264 size_t wxStreamBuffer::Read(wxStreamBuffer *s_buf)
265 {
266 char buf[BUF_TEMP_SIZE];
267 size_t s = 0, bytes_read = BUF_TEMP_SIZE;
268
269 if (m_mode == write)
270 return 0;
271
272 while (bytes_read != 0) {
273 bytes_read = Read(buf, bytes_read);
274 bytes_read = s_buf->Write(buf, bytes_read);
275 s += bytes_read;
276 }
277 return s;
278 }
279
280 size_t wxStreamBuffer::Write(const void *buffer, size_t size)
281 {
282 wxASSERT(m_stream != NULL);
283
284 if (m_mode == read)
285 return 0;
286
287 // ------------------
288 // Buffering disabled
289 // ------------------
290
291 m_stream->m_lasterror = wxStream_NOERROR;
292 if (!m_buffer_size)
293 return (m_stream->m_lastcount = m_stream->OnSysWrite(buffer, size));
294
295 // ------------------
296 // Buffering enabled
297 // ------------------
298
299 size_t buf_left, orig_size = size;
300
301 while (size > 0) {
302 buf_left = m_buffer_end - m_buffer_pos;
303
304 // First case: the buffer to write is larger than the stream buffer,
305 // we split it
306 if (size > buf_left) {
307 PutToBuffer(buffer, buf_left);
308 size -= buf_left;
309 buffer = (char *)buffer + buf_left; // ANSI C++ violation.
310
311 if (!FlushBuffer()) {
312 CHECK_ERROR(wxStream_WRITE_ERR);
313 return (m_stream->m_lastcount = orig_size-size);
314 }
315
316 m_buffer_pos = m_buffer_start;
317
318 } else {
319
320 // Second case: just copy it in the stream buffer.
321 PutToBuffer(buffer, size);
322 break;
323 }
324 }
325 return (m_stream->m_lastcount = orig_size);
326 }
327
328 size_t wxStreamBuffer::Write(wxStreamBuffer *sbuf)
329 {
330 char buf[BUF_TEMP_SIZE];
331 size_t s = 0, bytes_count = BUF_TEMP_SIZE, b_count2;
332 wxInputStream *in_stream;
333
334 if (m_mode == read)
335 return 0;
336
337 in_stream = (wxInputStream *)sbuf->Stream();
338
339 while (bytes_count == BUF_TEMP_SIZE) {
340 b_count2 = sbuf->Read(buf, bytes_count);
341 bytes_count = Write(buf, b_count2);
342 if (b_count2 > bytes_count)
343 in_stream->Ungetch(buf+bytes_count, b_count2-bytes_count);
344 s += bytes_count;
345 }
346 return s;
347 }
348
349 off_t wxStreamBuffer::Seek(off_t pos, wxSeekMode mode)
350 {
351 off_t ret_off, diff, last_access;
352
353 last_access = GetLastAccess();
354
355 if (!m_flushable) {
356 diff = pos + GetIntPosition();
357 if (diff < 0 || diff > last_access)
358 return wxInvalidOffset;
359 SetIntPosition(diff);
360 return diff;
361 }
362
363 switch (mode) {
364 case wxFromStart: {
365 // We'll try to compute an internal position later ...
366 ret_off = m_stream->OnSysSeek(pos, wxFromStart);
367 ResetBuffer();
368 return ret_off;
369 }
370 case wxFromCurrent: {
371 diff = pos + GetIntPosition();
372
373 if ( (diff > last_access) || (diff < 0) ) {
374 // We must take into account the fact that we have read something
375 // previously.
376 ret_off = m_stream->OnSysSeek(diff-last_access, wxFromCurrent);
377 ResetBuffer();
378 return ret_off;
379 } else {
380 SetIntPosition(diff);
381 return pos;
382 }
383 }
384 case wxFromEnd:
385 // Hard to compute: always seek to the requested position.
386 ret_off = m_stream->OnSysSeek(pos, wxFromEnd);
387 ResetBuffer();
388 return ret_off;
389 }
390 return wxInvalidOffset;
391 }
392
393 off_t wxStreamBuffer::Tell() const
394 {
395 off_t pos;
396
397 if (m_flushable) {
398 pos = m_stream->OnSysTell();
399 if (pos == wxInvalidOffset)
400 return wxInvalidOffset;
401 return pos - GetLastAccess() + GetIntPosition();
402 } else
403 return GetIntPosition();
404 }
405
406 size_t wxStreamBuffer::GetDataLeft()
407 {
408 if (m_buffer_end == m_buffer_pos && m_flushable)
409 FillBuffer();
410 return m_buffer_end-m_buffer_pos;
411 }
412
413 // ----------------------------------------------------------------------------
414 // wxStreamBase
415 // ----------------------------------------------------------------------------
416
417 wxStreamBase::wxStreamBase()
418 {
419 m_lasterror = wxStream_NOERROR;
420 m_lastcount = 0;
421 }
422
423 wxStreamBase::~wxStreamBase()
424 {
425 }
426
427 size_t wxStreamBase::OnSysRead(void *WXUNUSED(buffer), size_t WXUNUSED(size))
428 {
429 return 0;
430 }
431
432 size_t wxStreamBase::OnSysWrite(const void *WXUNUSED(buffer), size_t WXUNUSED(bufsize))
433 {
434 return 0;
435 }
436
437 off_t wxStreamBase::OnSysSeek(off_t WXUNUSED(seek), wxSeekMode WXUNUSED(mode))
438 {
439 return wxInvalidOffset;
440 }
441
442 off_t wxStreamBase::OnSysTell() const
443 {
444 return wxInvalidOffset;
445 }
446
447 // ----------------------------------------------------------------------------
448 // wxInputStream
449 // ----------------------------------------------------------------------------
450
451 wxInputStream::wxInputStream()
452 : wxStreamBase(),
453 m_wback(NULL), m_wbacksize(0), m_wbackcur(0)
454 {
455 }
456
457 wxInputStream::~wxInputStream()
458 {
459 if (m_wback)
460 free(m_wback);
461 }
462
463 char *wxInputStream::AllocSpaceWBack(size_t needed_size)
464 {
465 char *temp_b;
466
467 m_wbacksize += needed_size;
468
469 if (!m_wback)
470 temp_b = (char *)malloc(m_wbacksize);
471 else
472 temp_b = (char *)realloc(m_wback, m_wbacksize);
473
474 if (!temp_b)
475 return NULL;
476 m_wback = temp_b;
477
478 return (char *)(m_wback+(m_wbacksize-needed_size));
479 }
480
481 size_t wxInputStream::GetWBack(char *buf, size_t bsize)
482 {
483 size_t s_toget = m_wbacksize-m_wbackcur;
484
485 if (!m_wback)
486 return 0;
487
488 if (bsize < s_toget)
489 s_toget = bsize;
490
491 memcpy(buf, (m_wback+m_wbackcur), s_toget);
492
493 m_wbackcur += s_toget;
494 if (m_wbackcur == m_wbacksize) {
495 free(m_wback);
496 m_wback = (char *)NULL;
497 m_wbacksize = 0;
498 m_wbackcur = 0;
499 }
500
501 return s_toget;
502 }
503
504 size_t wxInputStream::Ungetch(const void *buf, size_t bufsize)
505 {
506 char *ptrback;
507
508 ptrback = AllocSpaceWBack(bufsize);
509 if (!ptrback)
510 return 0;
511
512 memcpy(ptrback, buf, bufsize);
513 return bufsize;
514 }
515
516 bool wxInputStream::Ungetch(char c)
517 {
518 char *ptrback;
519
520 ptrback = AllocSpaceWBack(1);
521 if (!ptrback)
522 return FALSE;
523
524 *ptrback = c;
525 return TRUE;
526 }
527
528 char wxInputStream::GetC()
529 {
530 char c;
531 Read(&c, 1);
532 return c;
533 }
534
535 wxInputStream& wxInputStream::Read(void *buffer, size_t size)
536 {
537 size_t retsize;
538 char *buf = (char *)buffer;
539
540 retsize = GetWBack(buf, size);
541 if (retsize == size) {
542 m_lastcount = size;
543 m_lasterror = wxStream_NOERROR;
544 return *this;
545 }
546 size -= retsize;
547 buf += retsize;
548
549 m_lastcount = OnSysRead(buf, size);
550 return *this;
551 }
552
553 char wxInputStream::Peek()
554 {
555 char c;
556
557 Read(&c, 1);
558 if (m_lasterror == wxStream_NOERROR) {
559 Ungetch(c);
560 return c;
561 }
562 return 0;
563 }
564
565 wxInputStream& wxInputStream::Read(wxOutputStream& stream_out)
566 {
567 char buf[BUF_TEMP_SIZE];
568 size_t bytes_read = BUF_TEMP_SIZE;
569
570 while (bytes_read == BUF_TEMP_SIZE) {
571 bytes_read = Read(buf, bytes_read).LastRead();
572 bytes_read = stream_out.Write(buf, bytes_read).LastWrite();
573 }
574 return *this;
575 }
576
577 off_t wxInputStream::SeekI(off_t pos, wxSeekMode mode)
578 {
579 return OnSysSeek(pos, mode);
580 }
581
582 off_t wxInputStream::TellI() const
583 {
584 return OnSysTell();
585 }
586
587 // --------------------
588 // Overloaded operators
589 // --------------------
590
591 #if wxUSE_SERIAL
592 wxInputStream& wxInputStream::operator>>(wxObject *& obj)
593 {
594 wxObjectInputStream obj_s(*this);
595 obj = obj_s.LoadObject();
596 return *this;
597 }
598 #endif
599
600
601 // ----------------------------------------------------------------------------
602 // wxOutputStream
603 // ----------------------------------------------------------------------------
604 wxOutputStream::wxOutputStream()
605 : wxStreamBase()
606 {
607 }
608
609 wxOutputStream::~wxOutputStream()
610 {
611 }
612
613 wxOutputStream& wxOutputStream::Write(const void *buffer, size_t size)
614 {
615 m_lastcount = OnSysWrite(buffer, size);
616 return *this;
617 }
618
619 wxOutputStream& wxOutputStream::Write(wxInputStream& stream_in)
620 {
621 stream_in.Read(*this);
622 return *this;
623 }
624
625 off_t wxOutputStream::TellO() const
626 {
627 return OnSysTell();
628 }
629
630 off_t wxOutputStream::SeekO(off_t pos, wxSeekMode mode)
631 {
632 return OnSysSeek(pos, mode);
633 }
634
635 void wxOutputStream::Sync()
636 {
637 }
638
639 #if wxUSE_SERIAL
640 wxOutputStream& wxOutputStream::operator<<(wxObject& obj)
641 {
642 wxObjectOutputStream obj_s(*this);
643 obj_s.SaveObject(obj);
644 return *this;
645 }
646 #endif
647
648 // ----------------------------------------------------------------------------
649 // wxFilterInputStream
650 // ----------------------------------------------------------------------------
651 wxFilterInputStream::wxFilterInputStream()
652 : wxInputStream()
653 {
654 }
655
656 wxFilterInputStream::wxFilterInputStream(wxInputStream& stream)
657 : wxInputStream()
658 {
659 m_parent_i_stream = &stream;
660 }
661
662 wxFilterInputStream::~wxFilterInputStream()
663 {
664 }
665
666 // ----------------------------------------------------------------------------
667 // wxFilterOutputStream
668 // ----------------------------------------------------------------------------
669 wxFilterOutputStream::wxFilterOutputStream()
670 : wxOutputStream()
671 {
672 }
673
674 wxFilterOutputStream::wxFilterOutputStream(wxOutputStream& stream)
675 : wxOutputStream()
676 {
677 m_parent_o_stream = &stream;
678 }
679
680 wxFilterOutputStream::~wxFilterOutputStream()
681 {
682 }
683
684 // ----------------------------------------------------------------------------
685 // wxBufferedInputStream
686 // ----------------------------------------------------------------------------
687 wxBufferedInputStream::wxBufferedInputStream(wxInputStream& s)
688 : wxFilterInputStream(s)
689 {
690 m_i_streambuf = new wxStreamBuffer(*this, wxStreamBuffer::read);
691 m_i_streambuf->SetBufferIO(1024);
692 }
693
694 wxBufferedInputStream::~wxBufferedInputStream()
695 {
696 delete m_i_streambuf;
697 }
698
699 wxInputStream& wxBufferedInputStream::Read(void *buffer, size_t size)
700 {
701 size_t retsize;
702 char *buf = (char *)buffer;
703
704 retsize = GetWBack(buf, size);
705 m_lastcount = retsize;
706 if (retsize == size) {
707 m_lasterror = wxStream_NOERROR;
708 return *this;
709 }
710 size -= retsize;
711 buf += retsize;
712
713 m_i_streambuf->Read(buf, size);
714
715 return *this;
716 }
717
718 off_t wxBufferedInputStream::SeekI(off_t pos, wxSeekMode mode)
719 {
720 return m_i_streambuf->Seek(pos, mode);
721 }
722
723 off_t wxBufferedInputStream::TellI() const
724 {
725 return m_i_streambuf->Tell();
726 }
727
728 size_t wxBufferedInputStream::OnSysRead(void *buffer, size_t bufsize)
729 {
730 return m_parent_i_stream->Read(buffer, bufsize).LastRead();
731 }
732
733 off_t wxBufferedInputStream::OnSysSeek(off_t seek, wxSeekMode mode)
734 {
735 return m_parent_i_stream->SeekI(seek, mode);
736 }
737
738 off_t wxBufferedInputStream::OnSysTell() const
739 {
740 return m_parent_i_stream->TellI();
741 }
742
743 // ----------------------------------------------------------------------------
744 // wxBufferedOutputStream
745 // ----------------------------------------------------------------------------
746
747 wxBufferedOutputStream::wxBufferedOutputStream(wxOutputStream& s)
748 : wxFilterOutputStream(s)
749 {
750 m_o_streambuf = new wxStreamBuffer(*this, wxStreamBuffer::write);
751 m_o_streambuf->SetBufferIO(1024);
752 }
753
754 wxBufferedOutputStream::~wxBufferedOutputStream()
755 {
756 delete m_o_streambuf;
757 }
758
759 wxOutputStream& wxBufferedOutputStream::Write(const void *buffer, size_t size)
760 {
761 m_lastcount = 0;
762 m_o_streambuf->Write(buffer, size);
763 return *this;
764 }
765
766 off_t wxBufferedOutputStream::SeekO(off_t pos, wxSeekMode mode)
767 {
768 return m_o_streambuf->Seek(pos, mode);
769 }
770
771 off_t wxBufferedOutputStream::TellO() const
772 {
773 return m_o_streambuf->Tell();
774 }
775
776 void wxBufferedOutputStream::Sync()
777 {
778 m_o_streambuf->FlushBuffer();
779 m_parent_o_stream->Sync();
780 }
781
782 size_t wxBufferedOutputStream::OnSysWrite(const void *buffer, size_t bufsize)
783 {
784 return m_parent_o_stream->Write(buffer, bufsize).LastWrite();
785 }
786
787 off_t wxBufferedOutputStream::OnSysSeek(off_t seek, wxSeekMode mode)
788 {
789 return m_parent_o_stream->SeekO(seek, mode);
790 }
791
792 off_t wxBufferedOutputStream::OnSysTell() const
793 {
794 return m_parent_o_stream->TellO();
795 }
796
797 // ----------------------------------------------------------------------------
798 // Some IOManip function
799 // ----------------------------------------------------------------------------
800
801 wxOutputStream& wxEndL(wxOutputStream& stream)
802 {
803 #ifdef __MSW__
804 return stream.Write("\r\n", 2);
805 #else
806 #ifdef __WXMAC__
807 return stream.Write("\r", 1);
808 #else
809 return stream.Write("\n", 1);
810 #endif
811 #endif
812 }
813
814 #endif
815 // wxUSE_STREAMS