nlib
FileOutputStream.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_FILEOUTPUTSTREAM_H_
17 #define INCLUDE_NN_NLIB_FILEOUTPUTSTREAM_H_
18 
19 #include "nn/nlib/OutputStream.h"
20 
21 NLIB_NAMESPACE_BEGIN
22 
24  void* buf;
25  size_t buffer_size;
26 
27  public:
28  NLIB_CEXPR FileOutputStreamSettings() NLIB_NOEXCEPT : buf(NULL), buffer_size(4096) {}
29  NLIB_CEXPR FileOutputStreamSettings(void* buf_, size_t buffer_size_) NLIB_NOEXCEPT
30  : buf(buf_),
31  buffer_size(buffer_size_) {}
32 };
33 
35  public:
37  buf_(NULL),
38  buf_size_(0),
39  is_internal_buffer_(false) {}
43  return this->Init(settings);
44  }
46  NLIB_CHECK_RESULT errno_t Open(const char* filename,
47  int flags, int mode) NLIB_NOEXCEPT NLIB_NONNULL;
48  NLIB_CHECK_RESULT errno_t Open(const char* filename) NLIB_NOEXCEPT {
49  return Open(filename, NLIB_FD_O_WRONLY | NLIB_FD_O_CREAT | NLIB_FD_O_TRUNC, 0644);
50  }
51  NLIB_CHECK_RESULT errno_t Open(const char* filename, int flags) NLIB_NOEXCEPT {
52  return Open(filename, flags, 0644);
53  }
54  NLIB_CHECK_RESULT errno_t Open(const wchar_t* filename,
55  int flags, int mode) NLIB_NOEXCEPT NLIB_NONNULL;
56  NLIB_CHECK_RESULT errno_t Open(const wchar_t* filename, int flags) NLIB_NOEXCEPT {
57  return Open(filename, flags, 0644);
58  }
59  NLIB_CHECK_RESULT errno_t Open(const wchar_t* filename) NLIB_NOEXCEPT {
60  return Open(filename, NLIB_FD_O_WRONLY | NLIB_FD_O_CREAT | NLIB_FD_O_TRUNC, 0644);
61  }
63  nlib_fd GetFd() const NLIB_NOEXCEPT { return fd_; }
64 
65  private:
66  virtual bool PushBuffer_(const void* p, size_t nbytes,
67  bool do_flush) NLIB_NOEXCEPT NLIB_OVERRIDE;
68  virtual bool Close_() NLIB_NOEXCEPT NLIB_OVERRIDE;
69  virtual bool WriteGather_(const nlib_fd_iovec* iov, int iovcnt) NLIB_NOEXCEPT NLIB_OVERRIDE;
70 
71  private:
72  nlib_fd fd_;
73  unsigned char* buf_;
74  size_t buf_size_;
75  bool is_internal_buffer_;
77 };
78 
79 NLIB_NAMESPACE_END
80 
81 #endif // INCLUDE_NN_NLIB_FILEOUTPUTSTREAM_H_
constexpr FileOutputStreamSettings() noexcept
デフォルトコンストラクタです。デフォルト値を設定します。
#define NLIB_OVERRIDE
利用可能であればoverrideが定義されます。そうでない場合は空文字列です。
Definition: Config.h:228
ファイルストリームの設定情報を格納する構造体です。
#define NLIB_DISALLOW_COPY_AND_ASSIGN(TypeName)
TypeName で指定されたクラスのコピーコンストラクタと代入演算子を禁止します。
Definition: Config.h:163
#define NLIB_FD_O_CREAT
nlib_fd_open()のflags 引数で使われます。
Definition: Platform.h:1478
ファイルの出力ストリームです。
#define NLIB_CHECK_RESULT
関数の呼び出し元が戻り値をチェックする必要があることを示します。
void * buf
バッファのポインタです。
nlib_fd GetFd() const noexcept
ファイルディスクリプタを返します。
#define NLIB_FD_INVALID
無効なファイルディスクリプタを定義したマクロです。
Definition: Platform.h:1514
#define NLIB_VIS_PUBLIC
関数やクラス等のシンボルをライブラリの外部に公開します。
Definition: Platform_unix.h:89
size_t buffer_size
バッファサイズです。
errno_t Init() noexcept
ストリームをデフォルトの設定で初期化します。
#define NLIB_FD_O_WRONLY
nlib_fd_open()のflags 引数で使われます。
Definition: Platform.h:1457
int nlib_fd
(nlib独自の)ファイルディスクリプタで、32bit整数です。
Definition: Platform.h:1513
#define NLIB_FD_O_TRUNC
nlib_fd_open()のflags 引数で使われます。
Definition: Platform.h:1485
#define NLIB_NOEXCEPT
環境に合わせてnoexcept 又は同等の定義がされます。
Definition: Config.h:99
#define NLIB_CEXPR
利用可能であればconstexprが定義されます。そうでない場合は空文字列です。
Definition: Config.h:93
FileOutputStream() noexcept
デフォルトコンストラクタです。更にInit()でバッファを設定して初期化する必要があります。 ...
constexpr FileOutputStreamSettings(void *buf_, size_t buffer_size_) noexcept
それぞれのデータメンバを設定します。
#define NLIB_FINAL
利用可能であればfinalが定義されます。そうでない場合は空文字列です。
Definition: Config.h:229
出力ストリームの基底クラスを定義しています。
#define NLIB_NONNULL
全ての引数にNULLを指定することができないことを示します。
出力ストリームの基底クラスです。このクラスを実体化することはできません。
Definition: OutputStream.h:30
int errno_t
intのtypedefで、戻り値としてPOSIXのエラー値を返すことを示します。
Definition: NMalloc.h:37