wavelength 1.0.0
Loading...
Searching...
No Matches
BinStream.h
Go to the documentation of this file.
1#pragma once
2
3#include "utl/Str.h"
4
11class BinStream {
12public:
14 enum SeekType {
15 kSeekBegin = 0,
16 kSeekCurrent = 1,
17 kSeekEnd = 2,
18 };
19
26 BinStream(bool littleEndian);
27
33 virtual ~BinStream() {
34 }
35
42 virtual void Read(void *data, int bytes) = 0;
43
50 virtual void Write(const void *data, int bytes) = 0;
51
53 virtual void Flush() = 0;
54
61 virtual void Seek(int offset, SeekType type) = 0;
62
64 virtual int Tell() = 0;
65
67 virtual bool Eof() = 0;
68
70 virtual bool Fail() = 0;
71
77 virtual void NoOp(int) {
78 }
79
87 void ReadEndian(void *data, int bytes);
88
96 void WriteEndian(const void *data, int bytes);
97
105 BinStream &operator<<(const char *str);
106
115
123 void ReadString(char *buffer, int bufSize);
124
126 Write(&c, 1);
127 return *this;
128 }
129
130 BinStream &operator<<(unsigned char c) {
131 Write(&c, 1);
132 return *this;
133 }
134
136 WriteEndian(&s, sizeof(s));
137 return *this;
138 }
139
140 BinStream &operator<<(unsigned short s) {
141 WriteEndian(&s, sizeof(s));
142 return *this;
143 }
144
146 WriteEndian(&i, sizeof(i));
147 return *this;
148 }
149
150 BinStream &operator<<(unsigned int i) {
151 WriteEndian(&i, sizeof(i));
152 return *this;
153 }
154
156 WriteEndian(&f, sizeof(f));
157 return *this;
158 }
159
161 Read(&c, 1);
162 return *this;
163 }
164
165 BinStream &operator>>(unsigned char &c) {
166 Read(&c, 1);
167 return *this;
168 }
169
171 ReadEndian(&s, sizeof(s));
172 return *this;
173 }
174
175 BinStream &operator>>(unsigned short &s) {
176 ReadEndian(&s, sizeof(s));
177 return *this;
178 }
179
181 ReadEndian(&i, sizeof(i));
182 return *this;
183 }
184
185 BinStream &operator>>(unsigned int &i) {
186 ReadEndian(&i, sizeof(i));
187 return *this;
188 }
189
191 ReadEndian(&f, sizeof(f));
192 return *this;
193 }
194
195private:
196 bool mLittleEndian;
197};
198
BinStream & ReadTextString(BinStream &bs, String &str)
Read text a bank file stores.
Stream of raw bytes, the base of the memory, file, and network streams.
Definition binstream.h:22
void ReadEndian(void *pData, int nBytes)
Read a value of 2, 4, 8, or 16 bytes, reversing its bytes unless the stream is little endian.
virtual void NoOp(int)
Do nothing.
Definition BinStream.h:77
virtual void Read(void *pData, int nBytes)=0
Read bytes.
virtual bool Eof()=0
BinStream & operator<<(short s)
Definition BinStream.h:135
BinStream & operator<<(unsigned short s)
Definition BinStream.h:140
BinStream & operator<<(int i)
Definition BinStream.h:145
SeekType
Origins of Seek().
Definition binstream.h:25
@ kSeekEnd
Definition binstream.h:28
@ kSeekCurrent
Definition binstream.h:27
@ kSeekBegin
Definition binstream.h:26
void ReadEndian(void *data, int bytes)
Read a value, swapping its bytes into the host order.
BinStream & operator>>(char &c)
Definition BinStream.h:160
BinStream & operator>>(unsigned int &i)
Definition BinStream.h:185
BinStream & operator>>(int &i)
Definition BinStream.h:180
virtual void Seek(int offset, SeekType type)=0
Move the position.
BinStream & operator<<(const char *str)
Write text as its length followed by its characters, without a terminator.
virtual int Tell()=0
BinStream & operator<<(unsigned char c)
Definition BinStream.h:130
BinStream(bool littleEndian)
Set the byte order.
BinStream & operator>>(unsigned short &s)
Definition BinStream.h:175
virtual void Flush()=0
Write out buffered data.
BinStream & operator>>(String &str)
Read text written by operator<<(const char *).
virtual bool Fail()=0
virtual void Write(const void *data, int bytes)=0
Write bytes.
BinStream & operator>>(float &f)
Definition BinStream.h:190
BinStream(bool bLittleEndian)
Construct a stream.
Definition binstream.h:38
BinStream & operator<<(unsigned int i)
Definition BinStream.h:150
BinStream & operator>>(unsigned char &c)
Definition BinStream.h:165
virtual void Write(const void *pData, int nBytes)=0
Write bytes.
virtual ~BinStream()
Destroy the stream.
Definition BinStream.h:33
void WriteEndian(const void *data, int bytes)
Write a value, swapping its bytes into the stream order.
BinStream & operator<<(float f)
Definition BinStream.h:155
virtual void Read(void *data, int bytes)=0
Read bytes.
BinStream & operator>>(short &s)
Definition BinStream.h:170
void ReadString(char *buffer, int bufSize)
Read text written by operator<<(const char *) into a buffer, and terminate it.
void WriteEndian(const void *pData, int nBytes)
Write a value of 2, 4, 8, or 16 bytes, reversing its bytes unless the stream is little endian.
BinStream & operator<<(char c)
Definition BinStream.h:125
Growable text buffer that is also a PrnStream.
Definition string.h:19