nlib
InputStream.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_INPUTSTREAM_H_
17 #define INCLUDE_NN_NLIB_INPUTSTREAM_H_
18 
19 #include "nn/nlib/Config.h"
20 #include "nn/nlib/TypeTraits.h"
21 
22 NLIB_NAMESPACE_BEGIN
23 
24 // code snippets:
25 // InputStream& stream = 'stream that inherits InputStream';
26 // if (!stream.Read(dataptr, nbyte)) { error = stream.GetErrorValue(); ..... }
27 // while ((c = stream.Read()) >= 0) { c is [0x00 - 0xFF] }
28 // if (!stream) { error = stream.GetErrorValue(); ..... }
30  public:
32  is_buf_curidx_(0),
33  is_buf_endidx_(0),
34  is_buf_(NULL),
35  is_bufsize_(0),
36  errno_(0) {}
38  // NOTE:
39  // cannot call Close_() from this destructor.
40  // the destructor of the derived class has to call Close_() if needed.
41  }
42  // returns true if there has been no errors
43  // you can also write the codes such that 'if (!!stream) { ... }'
44  errno_t GetErrorValue() const NLIB_NOEXCEPT { return errno_; }
45  // use Pos64() if you need a 64bit value on 32bit arch
46  size_t Pos() const NLIB_NOEXCEPT { return static_cast<size_t>(Pos64()); }
47  uint64_t Pos64() const NLIB_NOEXCEPT { return pos_ + is_buf_curidx_; }
49  if (*this && is_buf_curidx_ == is_buf_endidx_) {
50  CheckBuffer();
51  return *this && is_buf_curidx_ == is_buf_endidx_;
52  }
53  return false;
54  }
55  // < 0 if EOS or error, otherwise returns a byte and ++pos
57  if (NLIB_UNLIKELY(is_buf_curidx_ == is_buf_endidx_)) {
58  CheckBuffer();
59  if (NLIB_UNLIKELY(is_buf_curidx_ == is_buf_endidx_)) return -1;
60  }
61  return is_buf_[is_buf_curidx_++];
62  }
63  // < 0 if EOS or error, otherwise returns a byte and pos is unchanged
65  if (NLIB_UNLIKELY(is_buf_curidx_ == is_buf_endidx_)) {
66  CheckBuffer();
67  if (NLIB_UNLIKELY(is_buf_curidx_ == is_buf_endidx_)) return -1;
68  }
69  return is_buf_[is_buf_curidx_];
70  }
71  // returns skipped number of bytes
72  size_t Skip(size_t nbytes) NLIB_NOEXCEPT;
73  size_t Read(void* ptr, size_t nbytes) NLIB_NOEXCEPT NLIB_NONNULL {
74 #ifndef NLIB_NONNULL_ENABLED
75  if (!ptr) {
76  this->SetError(EINVAL);
77  return 0;
78  }
79 #endif
80  if (nbytes > RSIZE_MAX) { // INT01-C
81  this->SetError(EINVAL);
82  return 0;
83  }
84  if (is_buf_curidx_ + nbytes <= is_buf_endidx_) {
85  nlib_memcpy(ptr, nbytes, &is_buf_[is_buf_curidx_], nbytes);
86  is_buf_curidx_ += nbytes;
87  return nbytes;
88  }
89  return this->Read_(ptr, nbytes);
90  }
91  bool Close() NLIB_NOEXCEPT;
92  NLIB_SAFE_BOOL(InputStream, errno_ == 0)
93 
94  protected:
95  void ResetBuffer(void* p, size_t nbytes) NLIB_NOEXCEPT {
96  is_buf_ = reinterpret_cast<unsigned char*>(p);
97  is_bufsize_ = static_cast<int>(nbytes);
98  }
99  void SetError(errno_t e) const NLIB_NOEXCEPT {
100  if (errno_ == 0) errno_ = e;
101  }
102 
103  private:
104  virtual size_t FillBuffer_(void* p, size_t nbytes) NLIB_NOEXCEPT = 0;
105  virtual bool Close_() NLIB_NOEXCEPT = 0;
106  virtual void* GetWorkBuffer_(size_t* nbytes) NLIB_NOEXCEPT;
107  size_t Read_(void* ptr, size_t nbytes) NLIB_NOEXCEPT;
108 
109  // By default, Skip_() reads data on is_buf_.
110  // you can override it if you can implement more efficient code.
111  virtual size_t Skip_(size_t nbytes) NLIB_NOEXCEPT;
112 
113  private:
114  void CheckBuffer() NLIB_NOEXCEPT;
115  bool GetWorkBuffer() NLIB_NOEXCEPT;
116 
117  private:
118  uint64_t pos_;
119  size_t is_buf_curidx_;
120  size_t is_buf_endidx_;
121  unsigned char* is_buf_;
122  size_t is_bufsize_;
123  mutable ErrnoT errno_;
124  // errno_ is changed only from derived classes.
125  // FillBuffer_() or Close_() changes errno_ in other words.
126 
128 };
129 
131  public:
133  virtual ~NullInputStream() NLIB_NOEXCEPT {}
134 
135  private:
136  char dummy_buf_[256];
137  virtual size_t FillBuffer_(void* p, size_t nbytes) NLIB_NOEXCEPT NLIB_OVERRIDE;
138  virtual bool Close_() NLIB_NOEXCEPT NLIB_OVERRIDE { return true; }
139  virtual size_t Skip_(size_t nbytes) NLIB_NOEXCEPT NLIB_OVERRIDE;
140 };
141 
142 namespace detail {
143 
144 template<size_t N>
145 class MiniBufIn {
146  public:
147  NLIB_STATIC_ASSERT(N >= 16);
148  static NLIB_CEXPR const size_t buf_size = N;
149  NLIB_ALWAYS_INLINE MiniBufIn() NLIB_NOEXCEPT { cur_ = end_ = &buf_[0]; }
150  template<class IS>
151  NLIB_ALWAYS_INLINE bool Prefetch(IS* stream, size_t n) NLIB_NOEXCEPT {
152  if (cur_ + n > end_) {
153  NLIB_ASSERT(n <= N);
154  size_t rem = end_ - cur_;
155  nlib_memmove(reinterpret_cast<void*>(&buf_[0]), N,
156  cur_, rem);
157  size_t nread = stream->Read(&buf_[rem], N - rem);
158  cur_ = &buf_[0];
159  end_ = &buf_[0] + rem + nread;
160  return (nread + rem >= n);
161  }
162  return true;
163  }
164  template<class IS>
165  NLIB_ALWAYS_INLINE int Peek(IS* stream) NLIB_NOEXCEPT {
166  if (NLIB_UNLIKELY(cur_ == end_)) {
167  size_t nread = stream->Read(&buf_[0], N);
168  if (NLIB_UNLIKELY(nread == 0)) return -1;
169  cur_ = &buf_[0];
170  end_ = &buf_[0] + nread;
171  }
172  return *cur_;
173  }
174  template<class IS>
175  NLIB_ALWAYS_INLINE int Read(IS* stream) NLIB_NOEXCEPT {
176  int c;
177  if (NLIB_UNLIKELY(cur_ == end_)) {
178  size_t nread = stream->Read(&buf_[0], N);
179  if (NLIB_UNLIKELY(nread == 0)) return -1;
180  cur_ = &buf_[0] + 1;
181  end_ = &buf_[0] + nread;
182  return buf_[0];
183  } else {
184  c = *cur_;
185  ++cur_;
186  return c;
187  }
188  }
189 
190  NLIB_ALWAYS_INLINE void Advance(size_t n) NLIB_NOEXCEPT {
191  // Prefetch(stream, n) must be successful beforehand
192  cur_ += n;
193  }
194  NLIB_ALWAYS_INLINE const uint8_t& operator[](size_t n) NLIB_NOEXCEPT {
195  // Prefetch(stream, n + 1) must be successful beforehand
196  return cur_[n];
197  }
198  template<class IS>
200  size_t ReadBytes(IS* stream, void* data, size_t nbytes) NLIB_NOEXCEPT {
201  if (cur_ + nbytes <= end_) {
202  nlib_memcpy(data, nbytes, cur_, nbytes);
203  cur_ += nbytes;
204  return nbytes;
205  }
206  uint8_t* p = reinterpret_cast<uint8_t*>(data);
207  size_t rem = end_ - cur_;
208  nlib_memcpy(reinterpret_cast<void*>(p), nbytes, cur_, rem);
209  cur_ = end_ = &buf_[0];
210  size_t nread = stream->Read(p + rem, nbytes - rem);
211  return nread + rem;
212  }
213  template<class IS, class T>
214  size_t Read(IS* stream, T* data, size_t count) NLIB_NOEXCEPT {
215  NLIB_STATIC_ASSERT(sizeof(*data) <= N);
216  NLIB_STATIC_ASSERT(IsPod<T>::value);
217  size_t nbytes = sizeof(*data) * count;
218  size_t nread = ReadBytes(stream, data, nbytes);
219  if (NLIB_LIKELY(nread == nbytes)) return count;
220  size_t mod = nread % sizeof(*data);
221  uint8_t* p = reinterpret_cast<uint8_t*>(data);
222  nlib_memcpy(reinterpret_cast<void*>(&buf_[0]), N,
223  p + nread - mod, mod);
224  end_ = &buf_[mod];
225  return nread / sizeof(*data);
226  }
227  NLIB_ALWAYS_INLINE size_t size() const NLIB_NOEXCEPT { return end_ - cur_; }
228 
229  private:
230  uint8_t* cur_;
231  uint8_t* end_;
232  uint8_t buf_[N];
233 };
234 
235 } // namespace detail
236 NLIB_NAMESPACE_END
237 
238 #endif // INCLUDE_NN_NLIB_INPUTSTREAM_H_
#define NLIB_OVERRIDE
利用可能であればoverrideが定義されます。そうでない場合は空文字列です。
Definition: Config.h:228
size_t Read(void *ptr, size_t nbytes) noexcept
ptr で示されるメモリにnbytes 読み込みます。
Definition: InputStream.h:73
#define NLIB_ALWAYS_INLINE
コンパイラに関数をインライン展開するように強く示します。
Definition: Platform_unix.h:97
C++11の標準ヘッダとなるtype_traitsの代用定義です。 コンパイラや標準ライブラリによってサポートされてい...
uint64_t Pos64() const noexcept
ストリーム上の現在位置を64bit値で返します。
Definition: InputStream.h:47
#define NLIB_DISALLOW_COPY_AND_ASSIGN(TypeName)
TypeName で指定されたクラスのコピーコンストラクタと代入演算子を禁止します。
Definition: Config.h:163
#define NLIB_SAFE_BOOL(class_name, exp)
クラス内に安全なoperator bool()を定義します。 可能であればC++11のexplicit boolを利用します。 ...
Definition: Config.h:178
errno_t GetErrorValue() const noexcept
エラー値を取得します。
Definition: InputStream.h:44
bool IsEos() noexcept
ストリームを最後まで読み終えている場合trueを返します。最後まで読み終えていない場合やエラーが発生して...
Definition: InputStream.h:48
#define NLIB_CHECK_RESULT
関数の呼び出し元が戻り値をチェックする必要があることを示します。
int Read() noexcept
ストリームから1バイトを読み込みます。
Definition: InputStream.h:56
#define NLIB_UNLIKELY(x)
条件xが偽になる傾向が高いことをコンパイラに示します。
#define RSIZE_MAX
size_tの最大値よりいくらか小さい値が定義されています。
Definition: Platform.h:216
void ResetBuffer(void *p, size_t nbytes) noexcept
InputStreamが持つバッファを設定します。
Definition: InputStream.h:95
#define NLIB_VIS_PUBLIC
関数やクラス等のシンボルをライブラリの外部に公開します。
Definition: Platform_unix.h:89
size_t Pos() const noexcept
ストリーム上の現在位置を返します。
Definition: InputStream.h:46
virtual ~InputStream() noexcept
デストラクタです。派生クラスから呼び出されます。
Definition: InputStream.h:37
#define NLIB_LIKELY(x)
条件xが真になる傾向が高いことをコンパイラに示します。
Definition: Platform_unix.h:99
constexpr InputStream() noexcept
コンストラクタです。派生クラスから呼び出されます。
Definition: InputStream.h:31
入力ストリームの基底クラスです。このクラスを実体化することはできません。
Definition: InputStream.h:29
errno_tをラップするクラスです。Visual Studioのデバッガ上での表示を改善します。
Definition: Config.h:492
static errno_t nlib_memcpy(void *s1, size_t s1max, const void *s2, size_t n)
N1078のmemcpy_sに相当する実装です。
Definition: Platform.h:2357
NLIB_CHECK_RESULT int Peek() noexcept
ストリームを消費せずに次の1バイトを読み込みます。
Definition: InputStream.h:64
#define NLIB_NOEXCEPT
環境に合わせてnoexcept 又は同等の定義がされます。
Definition: Config.h:99
#define NLIB_CEXPR
利用可能であればconstexprが定義されます。そうでない場合は空文字列です。
Definition: Config.h:93
開発環境別の設定が書かれるファイルです。
void SetError(errno_t e) const noexcept
InputStreamにエラーを設定します。
Definition: InputStream.h:99
#define NLIB_FINAL
利用可能であればfinalが定義されます。そうでない場合は空文字列です。
Definition: Config.h:229
#define NLIB_STATIC_ASSERT(exp)
静的アサートが定義されます。利用可能であればstatic_assertを利用します。
Definition: Config.h:154
bool Read(BinaryReader *r, T *x)
この関数テンプレートを特殊化することで、ユーザー定義クラスに読み込むことができます。 ...
Definition: BinaryReader.h:172
常に0を読み込むストリームです。
Definition: InputStream.h:130
static errno_t nlib_memmove(void *s1, size_t s1max, const void *s2, size_t n)
N1078のmemmove_sに相当する実装です。
Definition: Platform.h:2375
#define NLIB_NONNULL
全ての引数にNULLを指定することができないことを示します。
int errno_t
intのtypedefで、戻り値としてPOSIXのエラー値を返すことを示します。
Definition: NMalloc.h:37