nlib
BinaryReader.h
[詳解]
1 
2 /*--------------------------------------------------------------------------------*
3  Project: CrossRoad
4  Copyright (C)Nintendo All rights reserved.
5 
6  These coded instructions, statements, and computer programs contain proprietary
7  information of Nintendo and/or its licensed developers and are protected by
8  national and international copyright laws. They may not be disclosed to third
9  parties or copied or duplicated in any form, in whole or in part, without the
10  prior written consent of Nintendo.
11 
12  The content herein is highly confidential and should be handled accordingly.
13  *--------------------------------------------------------------------------------*/
14 
15 #pragma once
16 #ifndef INCLUDE_NN_NLIB_BINARYREADER_H_
17 #define INCLUDE_NN_NLIB_BINARYREADER_H_
18 
19 #include "nn/nlib/Config.h"
20 #include "nn/nlib/Swap.h"
21 #include "nn/nlib/InputStream.h"
22 
23 NLIB_NAMESPACE_BEGIN
24 NLIB_EXPIMP_TEMPLATE(detail::MiniBufIn<512>);
25 
27  public:
28  enum EndianSetting { kEndianDefault = 0, kEndianLittle, kEndianBig };
29 
30  public:
31  BinaryReader() NLIB_NOEXCEPT : stream_(nullptr), errno_(-1), swap_endian_(false) {}
32  ~BinaryReader() NLIB_NOEXCEPT { this->Close(); }
33  errno_t Init(EndianSetting endian) NLIB_NOEXCEPT;
34  errno_t Init() NLIB_NOEXCEPT { return Init(kEndianDefault); }
35  errno_t Open(InputStream* stream) NLIB_NOEXCEPT;
36 
37 #define NLIB_BINR(tp) return this->Read_(reinterpret_cast<tp*>(x))
38 
39  bool Read(char* x) NLIB_NOEXCEPT { NLIB_BINR(uint8_t); }
40  bool Read(signed char* x) NLIB_NOEXCEPT { NLIB_BINR(uint8_t); }
41  bool Read(unsigned char* x) NLIB_NOEXCEPT { NLIB_BINR(uint8_t); }
42  bool Read(short* x) NLIB_NOEXCEPT { NLIB_BINR(uint16_t); }
43  bool Read(unsigned short* x) NLIB_NOEXCEPT { NLIB_BINR(uint16_t); }
44  bool Read(int* x) NLIB_NOEXCEPT { NLIB_BINR(uint32_t); }
45  bool Read(unsigned int* x) NLIB_NOEXCEPT { NLIB_BINR(uint32_t); }
46  bool Read(long* x) NLIB_NOEXCEPT { NLIB_BINR(nlib_ulong_compatible_t); }
47  bool Read(unsigned long* x) NLIB_NOEXCEPT { NLIB_BINR(nlib_ulong_compatible_t); }
48  bool Read(long long* x) NLIB_NOEXCEPT { NLIB_BINR(uint64_t); }
49  bool Read(unsigned long long* x) NLIB_NOEXCEPT { NLIB_BINR(uint64_t); }
50  bool Read(float* x) NLIB_NOEXCEPT { NLIB_BINR(float); }
51  bool Read(double* x) NLIB_NOEXCEPT { NLIB_BINR(double); }
52 
53  template<class T>
54  bool Read(T* x) NLIB_NOEXCEPT NLIB_NONNULL;
55 
56  int Peek() NLIB_NOEXCEPT { return mini_buf_.Peek(stream_); }
57  bool Skip(size_t n) NLIB_NOEXCEPT {
58  size_t rem = mini_buf_.size();
59  if (rem <= n) {
60  mini_buf_.Advance(n);
61  return true;
62  } else {
63  mini_buf_.Advance(rem);
64  n -= rem;
65  return this->Skip_(n);
66  }
67  }
68 #undef NLIB_BINR
69 
70  size_t ReadArray(unsigned char* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
71  size_t ReadArray(unsigned short* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
72  size_t ReadArray(unsigned int* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
73  size_t ReadArray(unsigned long long* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
74  size_t ReadArray(unsigned long* x, size_t n) NLIB_NOEXCEPT {
75 #ifdef NLIB_LP64
76  return this->ReadArray(reinterpret_cast<unsigned long long*>(x), n);
77 #else
78  return this->ReadArray(reinterpret_cast<unsigned int*>(x), n);
79 #endif
80  }
81 
82  size_t ReadArray(float* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
83  size_t ReadArray(double* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
84 
85  size_t ReadArray(signed char* x, size_t n) NLIB_NOEXCEPT {
86  return this->ReadArray(reinterpret_cast<unsigned char*>(x), n);
87  }
88  size_t ReadArray(char* x, size_t n) NLIB_NOEXCEPT {
89  return this->ReadArray(reinterpret_cast<unsigned char*>(x), n);
90  }
91  size_t ReadArray(short* x, size_t n) NLIB_NOEXCEPT {
92  return this->ReadArray(reinterpret_cast<unsigned short*>(x), n);
93  }
94  size_t ReadArray(int* x, size_t n) NLIB_NOEXCEPT {
95  return this->ReadArray(reinterpret_cast<unsigned int*>(x), n);
96  }
97  size_t ReadArray(long* x, size_t n) NLIB_NOEXCEPT {
98 #ifdef NLIB_LP64
99  return this->ReadArray(reinterpret_cast<unsigned long long*>(x), n);
100 #else
101  return this->ReadArray(reinterpret_cast<unsigned int*>(x), n);
102 #endif
103  }
104  size_t ReadArray(long long* x, size_t n) NLIB_NOEXCEPT {
105  return this->ReadArray(reinterpret_cast<unsigned long long*>(x), n);
106  }
107 
108  template<class T>
109  size_t ReadArray(T* x, size_t n) NLIB_NOEXCEPT NLIB_NONNULL;
110  template<class T, size_t N>
111  size_t ReadArray(T (&a)[N]) NLIB_NOEXCEPT;
113  // Do not stream_->Close(). only detach it from BinaryReader.
114  stream_ = nullptr;
115  return true;
116  }
118  if (errno_ == 0) errno_ = e;
119  }
120  errno_t GetErrorValue() const NLIB_NOEXCEPT { return errno_; }
121 
122  NLIB_SAFE_BOOL(BinaryReader, GetErrorValue() == 0)
123 
124  private:
125  bool Skip_(size_t n) NLIB_NOEXCEPT;
126  bool Read_(uint8_t* x) NLIB_NOEXCEPT NLIB_NONNULL;
127  bool Read_(uint16_t* x) NLIB_NOEXCEPT NLIB_NONNULL;
128  bool Read_(uint32_t* x) NLIB_NOEXCEPT NLIB_NONNULL;
129  bool Read_(uint64_t* x) NLIB_NOEXCEPT NLIB_NONNULL;
130  bool Read_(float* x) NLIB_NOEXCEPT {
131  union {
132  float f;
133  uint32_t i;
134  } v;
135  if (!this->Read_(&v.i)) return false;
136  *x = v.f;
137  return true;
138  }
139  bool Read_(double* x) NLIB_NOEXCEPT {
140  union {
141  double f;
142  uint64_t i;
143  } v;
144  if (!this->Read_(&v.i)) return false;
145  *x = v.f;
146  return true;
147  }
148 
149  private:
150  InputStream* stream_;
151  ErrnoT errno_;
152  bool swap_endian_;
153  detail::MiniBufIn<512> mini_buf_;
154 
155  NLIB_DISALLOW_COPY_AND_ASSIGN(BinaryReader);
156 };
157 
158 namespace binary_reader {
159 
160 template<class T>
162  return r->Read(x);
163 }
164 
165 template<class T>
166 NLIB_ALWAYS_INLINE bool ReadArray(BinaryReader* r, T* x, size_t n) {
167  return r->ReadArray(x, n);
168 }
169 } // namespace binary_reader
170 
171 template<class T>
173  return binary_reader::Read(this, x);
174 }
175 
176 template<class T>
178  return binary_reader::ReadArray(this, x, n);
179 }
180 
181 template<class T, size_t N>
183  return this->ReadArray(&a[0], N);
184 }
185 
186 NLIB_NAMESPACE_END
187 
188 #endif // INCLUDE_NN_NLIB_BINARYREADER_H_
bool Read(unsigned long long *x) noexcept
ストリームからバイナリでunsigned long long型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:49
bool Skip(size_t n) noexcept
ストリームからn バイトを読み飛ばします。
Definition: BinaryReader.h:57
size_t ReadArray(unsigned char *x, size_t n) noexcept
ストリームからバイナリでunsigned char型のデータ列を読み取ります。
bool Read(unsigned char *x) noexcept
ストリームからバイナリでunsigned char型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:41
#define NLIB_ALWAYS_INLINE
コンパイラに関数をインライン展開するように強く示します。
Definition: Platform_unix.h:95
errno_t GetErrorValue() const noexcept
書き込み等が失敗した際に、エラーの原因を取得できます。
Definition: BinaryReader.h:120
bool Read(signed char *x) noexcept
ストリームからバイナリでsigned char型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:40
#define NLIB_DISALLOW_COPY_AND_ASSIGN(TypeName)
TypeName で指定されたクラスのコピーコンストラクタと代入演算子を禁止します。
Definition: Config.h:183
#define NLIB_SAFE_BOOL(class_name, exp)
クラス内に安全なoperator bool()を定義します。 可能であればC++11のexplicit boolを利用します。 ...
Definition: Config.h:199
入力ストリームの基底クラスを定義しています。
size_t ReadArray(char *x, size_t n) noexcept
ストリームからバイナリでchar型のデータ列を読み取ります。
Definition: BinaryReader.h:88
void SetError(errno_t e) noexcept
エラーを設定します。既にエラーが設定されている場合にはエラーは設定されません。
Definition: BinaryReader.h:117
bool Read(int *x) noexcept
ストリームからバイナリでint型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:44
bool Read(double *x) noexcept
ストリームからバイナリでdouble型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:51
uint32_t nlib_ulong_compatible_t
unsigned longと互換性のある整数型がtypedefされています。
Definition: Platform.h:324
リトルエンディアンで書き込みます。
Definition: BinaryReader.h:28
#define NLIB_VIS_PUBLIC
関数やクラス等のシンボルをライブラリの外部に公開します。
Definition: Platform_unix.h:87
BinaryReader() noexcept
デフォルトコンストラクタです。
Definition: BinaryReader.h:31
bool Read(short *x) noexcept
ストリームからバイナリでshort型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:42
size_t ReadArray(unsigned long *x, size_t n) noexcept
ストリームからバイナリでunsigned long型のデータ列を読み取ります。
Definition: BinaryReader.h:74
size_t ReadArray(int *x, size_t n) noexcept
ストリームからバイナリでint型のデータ列を読み取ります。
Definition: BinaryReader.h:94
入力ストリームの基底クラスです。このクラスを実体化することはできません。
Definition: InputStream.h:29
bool Read(unsigned int *x) noexcept
ストリームからバイナリでunsigned int型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:45
bool Read(float *x) noexcept
ストリームからバイナリでfloat型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:50
size_t ReadArray(long long *x, size_t n) noexcept
ストリームからバイナリでlong long型のデータ列を読み取ります。
Definition: BinaryReader.h:104
#define NLIB_NOEXCEPT
環境に合わせてnoexcept 又は同等の定義がされます。
Definition: Config.h:109
開発環境別の設定が書かれるファイルです。
bool Read(unsigned short *x) noexcept
ストリームからバイナリでunsigned short型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:43
size_t ReadArray(short *x, size_t n) noexcept
ストリームからバイナリでshort型のデータ列を読み取ります。
Definition: BinaryReader.h:91
EndianSetting
エンディアンを指定します。
Definition: BinaryReader.h:28
bool Close() noexcept
バイナリリーダをクローズします。
Definition: BinaryReader.h:112
size_t ReadArray(signed char *x, size_t n) noexcept
ストリームからバイナリでsigned char型のデータ列を読み取ります。
Definition: BinaryReader.h:85
#define NLIB_FINAL
利用可能であればfinalが定義されます。そうでない場合は空文字列です。
Definition: Config.h:250
int Peek() noexcept
ストリームの先頭1バイトを参照します。
Definition: BinaryReader.h:56
bool Read(BinaryReader *r, T *x)
この関数テンプレートを特殊化することで、ユーザー定義クラスに読み込むことができます。 ...
Definition: BinaryReader.h:161
ストリーム(InputStream)からバイナリを読み込むクラスです。
Definition: BinaryReader.h:26
bool Read(unsigned long *x) noexcept
ストリームからバイナリでunsigned long型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:47
errno_t Init() noexcept
プログラムが動作しているマシンと同じエンディアンでバイナリリーダーを初期化します。 ...
Definition: BinaryReader.h:34
bool Read(long *x) noexcept
ストリームからバイナリでlong型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:46
#define NLIB_NONNULL
全ての引数にNULLを指定することができないことを示します。
~BinaryReader() noexcept
デストラクタです。 ストリームをクローズしません。
Definition: BinaryReader.h:32
size_t ReadArray(long *x, size_t n) noexcept
ストリームからバイナリでlong型のデータ列を読み取ります。
Definition: BinaryReader.h:97
bool Read(long long *x) noexcept
ストリームからバイナリでlong long型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:48
bool Read(char *x) noexcept
ストリームからバイナリでchar型のデータを読み取ります。成功した場合はtrueを返します。 ...
Definition: BinaryReader.h:39
bool ReadArray(BinaryReader *r, T *x, size_t n)
この関数テンプレートを特殊化することで、ユーザー定義クラスに読み込むことができます。 ...
Definition: BinaryReader.h:166
int errno_t
intのtypedefで、戻り値としてPOSIXのエラー値を返すことを示します。
Definition: NMalloc.h:37