wavelength 1.0.0
Loading...
Searching...
No Matches
binstream.h
Go to the documentation of this file.
1#pragma once
2
3#include <list>
4#include <memory>
5#include <vector>
6
7#include "math/rand.h"
8#include "os/string.h"
9
22class BinStream {
23public:
30
38 explicit BinStream(bool bLittleEndian) : mLittleEndian(bLittleEndian) {
39 }
40
41#ifdef VIDEO_STANDARD_PAL
47 virtual ~BinStream();
48
58 void Read(void *pData, int nBytes);
59
69 void Write(const void *pData, int nBytes);
70
78 void Seek(int nOffset, SeekType eFrom);
79
85 void EnableReadEncryption();
86
92 void DisableEncryption();
93
94#else
100 virtual ~BinStream() {
101 }
102
109 virtual void Read(void *pData, int nBytes) = 0;
110
117 virtual void Write(const void *pData, int nBytes) = 0;
118#endif
119
121 virtual void Flush() = 0;
122
123#ifndef VIDEO_STANDARD_PAL
130 virtual void Seek(int nOffset, SeekType eFrom) = 0;
131#endif
132
138 virtual int Tell() = 0;
139
145 virtual bool Eof() = 0;
146
152 virtual bool Fail() = 0;
153
163 virtual void Mark(const char *pszMark) {
164 (void)pszMark;
165 }
166
177 void ReadString(char *pszBuffer, int nSize);
178
186 void ReadString(String &text);
187
196 BinStream &WriteString(const char *pszText);
197
206 void ReadEndian(void *pData, int nBytes);
207
217 void WriteEndian(const void *pData, int nBytes);
218
219protected:
220#ifdef VIDEO_STANDARD_PAL
227 virtual void ReadImpl(void *pData, int nBytes) = 0;
228
235 virtual void WriteImpl(const void *pData, int nBytes) = 0;
236
243 virtual void SeekImpl(int nOffset, SeekType eFrom) = 0;
244#endif
245
246private:
247 int mLittleEndian;
248#ifdef VIDEO_STANDARD_PAL
249 std::unique_ptr<Rand> mCrypto;
250#endif
251};
252
266
309template <typename T>
310BinStream &operator<<(BinStream &stream, const std::vector<T> &elements) {
311 const int nSize = static_cast<int>(elements.size());
312 stream.WriteEndian(&nSize, sizeof(nSize));
313 for (const T &element : elements) {
314 stream << element;
315 }
316 return stream;
317}
318
366template <typename T>
367BinStream &operator>>(BinStream &stream, std::vector<T> &elements) {
368 int nSize;
369 stream.ReadEndian(&nSize, sizeof(nSize));
370 elements.resize(nSize, T());
371 for (T &element : elements) {
372 stream >> element;
373 }
374 return stream;
375}
376
389template <typename T>
390BinStream &operator<<(BinStream &stream, const std::list<T> &elements) {
391 const int nSize = static_cast<int>(elements.size());
392 stream.WriteEndian(&nSize, sizeof(nSize));
393 for (const T &element : elements) {
394 stream << element;
395 }
396 return stream;
397}
398
412template <typename T>
413BinStream &operator>>(BinStream &stream, std::list<T> &elements) {
414 int nSize;
415 stream.ReadEndian(&nSize, sizeof(nSize));
416 elements.resize(nSize, T());
417 for (T &element : elements) {
418 stream >> element;
419 }
420 return stream;
421}
BinStream & operator>>(BinStream &stream, String &text)
Read text into a string.
BinStream & operator<<(BinStream &stream, const std::vector< T > &elements)
Write a vector as its element count followed by each element.
Definition binstream.h:310
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 Read(void *pData, int nBytes)=0
Read bytes.
virtual bool Eof()=0
Report whether the position is at the end.
void ReadString(String &text)
Read a length-prefixed string.
void ReadString(char *pszBuffer, int nSize)
Read a length-prefixed string into a buffer and terminate it.
SeekType
Origins of Seek().
Definition binstream.h:25
@ kSeekEnd
Definition binstream.h:28
@ kSeekCurrent
Definition binstream.h:27
@ kSeekBegin
Definition binstream.h:26
virtual int Tell()=0
Report the position.
virtual void Flush()=0
Write out buffered data.
virtual bool Fail()=0
Report whether a transfer failed.
BinStream(bool bLittleEndian)
Construct a stream.
Definition binstream.h:38
virtual void Write(const void *pData, int nBytes)=0
Write bytes.
virtual ~BinStream()
Release the stream.
Definition binstream.h:100
virtual void Mark(const char *pszMark)
Receive a named mark in the data, such as the end of a chunk.
Definition binstream.h:163
BinStream & WriteString(const char *pszText)
Write a string with its length first.
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.
virtual void Seek(int nOffset, SeekType eFrom)=0
Move the position.
Growable text buffer that is also a PrnStream.
Definition string.h:19