summaryrefslogtreecommitdiff
path: root/lib/common/BufferedWriteStream.cpp
blob: 8fbabe9b09819a81d288babc46b301cd7f2cfb97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
// --------------------------------------------------------------------------
//
// File
//		Name:    BufferedWriteStream.cpp
//		Purpose: Buffering write-only wrapper around IOStreams
//		Created: 2010/09/13
//
// --------------------------------------------------------------------------

#include "Box.h"
#include "BufferedWriteStream.h"
#include "CommonException.h"

#include <string.h>

#include "MemLeakFindOn.h"

// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::BufferedWriteStream(const char *, int, int)
//		Purpose: Constructor, set up buffer
//		Created: 2007/01/16
//
// --------------------------------------------------------------------------
BufferedWriteStream::BufferedWriteStream(IOStream& rSink)
: mrSink(rSink), mBufferPosition(0)
{ }


// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::Read(void *, int)
//		Purpose: Reads bytes from the file - throws exception
//		Created: 2007/01/16
//
// --------------------------------------------------------------------------
int BufferedWriteStream::Read(void *pBuffer, int NBytes, int Timeout)
{
	THROW_EXCEPTION(CommonException, NotSupported);
}


// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::BytesLeftToRead()
//		Purpose: Returns number of bytes to read (may not be most efficient function ever)
//		Created: 2007/01/16
//
// --------------------------------------------------------------------------
IOStream::pos_type BufferedWriteStream::BytesLeftToRead()
{
	THROW_EXCEPTION(CommonException, NotSupported);
}


// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::Write(void *, int)
//		Purpose: Writes bytes to the underlying stream (not supported)
//		Created: 2003/07/31
//
// --------------------------------------------------------------------------
void BufferedWriteStream::Write(const void *pBuffer, int NBytes, int Timeout)
{
	int numBytesRemain = NBytes;

	do
	{
		int maxWritable = sizeof(mBuffer) - mBufferPosition;
		int numBytesToWrite = (numBytesRemain < maxWritable) ?
			numBytesRemain : maxWritable;

		if(numBytesToWrite > 0)
		{
			memcpy(mBuffer + mBufferPosition, pBuffer,
				numBytesToWrite);
			mBufferPosition += numBytesToWrite;
			pBuffer = ((const char *)pBuffer) + numBytesToWrite;
			numBytesRemain -= numBytesToWrite;
		}

		if(numBytesRemain > 0)
		{
			Flush();
		}
	}
	while(numBytesRemain > 0);
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::GetPosition()
//		Purpose: Get position in stream
//		Created: 2003/08/21
//
// --------------------------------------------------------------------------
IOStream::pos_type BufferedWriteStream::GetPosition() const
{
	return mrSink.GetPosition() + mBufferPosition;
}


// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::Seek(pos_type, int)
//		Purpose: Seeks within file, as lseek, invalidate buffer
//		Created: 2003/07/31
//
// --------------------------------------------------------------------------
void BufferedWriteStream::Seek(IOStream::pos_type Offset, int SeekType)
{
	// Always flush the buffer before seeking
	Flush();

	mrSink.Seek(Offset, SeekType);
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::Flush();
//		Purpose: Write out current buffer contents and invalidate
//		Created: 2010/09/13
//
// --------------------------------------------------------------------------
void BufferedWriteStream::Flush(int Timeout)
{
	if(mBufferPosition > 0)
	{
		mrSink.Write(mBuffer, mBufferPosition);
	}

	mBufferPosition = 0;
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::Close()
//		Purpose: Closes the underlying stream (not needed)
//		Created: 2003/07/31
//
// --------------------------------------------------------------------------
void BufferedWriteStream::Close()
{
	Flush();
	mrSink.Close();
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::StreamDataLeft()
//		Purpose: Any data left to write?
//		Created: 2003/08/02
//
// --------------------------------------------------------------------------
bool BufferedWriteStream::StreamDataLeft()
{
	THROW_EXCEPTION(CommonException, NotSupported);
}

// --------------------------------------------------------------------------
//
// Function
//		Name:    BufferedWriteStream::StreamClosed()
//		Purpose: Is the stream closed?
//		Created: 2003/08/02
//
// --------------------------------------------------------------------------
bool BufferedWriteStream::StreamClosed()
{
	return mrSink.StreamClosed();
}