56. バイナリファイル¶
バイナリ形式でデータの読み書きを行う方法を学びます。
56.1 バイナリファイル¶
56.1.1 テキストファイルとバイナリファイル¶
- バイナリファイルは、データをコンピュータが直接処理できるバイナリデータ形式で保存したファイルです
- 例えば
299792458というint32型の数値をファイルに保存する場合：- テキスト形式では、ASCII文字列 "299792458" として 9 バイトで保存します
- バイナリ形式では、32 ビットの整数値として 4 バイトで保存します（
00010001110111100111100001001010）
テキストファイル¶
- メリット
- 人間が読み書きしやすい
- テキストエディタで内容を確認・編集できる
- デメリット
- 数値 ⇔ テキストの変換処理でオーバーヘッドが生じる
- ファイルサイズが大きくなる
バイナリファイル¶
- メリット
- プログラムによる読み書きが高速
- ファイルサイズを最小限に抑えられる
- デメリット
- 人間が直接内容を確認しづらい
56.1.2 シリアライズの利用¶
- 組み込み型（
int32,doubleなど）や、組み込み型で構成された単純なクラス（Point,Vec2,Rect,ColorFなど）は、メモリ上のバイト列を直接ファイルに書き込み可能です（trivially copyable） - 一方で、複雑なデータ構造（
String,Arrayなど）は、ポインタやメモリ管理を含むため、直接バイナリ化できません。56.7～56.9 で説明する シリアライズ機能 を使って、適切なバイナリデータに変換する必要があります - 自作のクラスについても、シリアライズ機能を使ってバイナリファイルでの入出力に対応させることができます
56.2 バイナリデータの書き込み¶
- バイナリファイルを作成するには
BinaryWriterクラスを使います BinaryWriterのコンストラクタ引数に、書き込み先のファイルのパスを渡します- ファイルパスは、実行ファイルがあるフォルダ（開発中は App フォルダ）を基準とする相対パスか、絶対パスを使用します
- ファイルのオープンに成功したかどうかは、
if (writer),if (not writer)で調べられます - 同名のファイルがすでに存在する場合は、それを破棄して新しいファイルを作成します
- オープンしたファイルはデストラクタでクローズされるため、明示的にクローズする必要はありません
- オープン・クローズのタイミングを制御したい場合は、
TextWriter（チュートリアル 54）と同じように、.open()を使ってファイルをオープン、.close()を使ってファイルをクローズします .write()に trivially copyable な型の値を渡すと、その値のバイナリデータをファイルの末尾に追加で書き込みます- 次のサンプルコードを実行すると、36 バイトのバイナリファイルが作成されます
# include <Siv3D.hpp>
// ゲームのスコアを記録する構造体
struct GameScore
{
int32 a, b, c, d;
};
void Main()
{
// 書き込み用のバイナリファイルをオープン
BinaryWriter writer{ U"tutorial1.bin" };
if (not writer) // もしオープンに失敗したら
{
throw Error{ U"Failed to open `tutorial1.bin`" };
}
// int32 型の値 (4 バイト) を書き込む
writer.write(777);
// double 型の値 (8 バイト) を書き込む
writer.write(3.1415);
// Point 型の値 (8 バイト) を書き込む
writer.write(Point{ 123, 456 });
// GameScore 型の値 (16 バイト) を書き込む
const GameScore s = { 10, 20, 30, 40 };
writer.write(s);
while (System::Update())
{
}
// writer のデストラクタで自動的にファイルがクローズされる
}
56.2 バイナリデータの読み込み¶
- バイナリファイルからバイナリデータを読み込むには
BinaryReaderクラスを使います BinaryReaderのコンストラクタ引数に、読み込みたいテキストファイルのパスを渡します- ファイルパスは、実行ファイルがあるフォルダ（開発中は App フォルダ）を基準とする相対パスか、絶対パスを使用します
- ファイルのオープンに成功したかどうかは、
if (reader),if (not reader)で調べられます - オープン直後は、読み込み位置はファイルの先頭にセットされています
.read()に trivially copyable な型の変数を参照で渡すと、読み込み位置を始点とし、その値のサイズ分のバイナリデータを読み込んでその変数にコピーし、読み込み位置をその分進めてtrueを返します- 読み込み位置がすでにファイルの終端にあって、これ以上ファイルから読み込めないときには
falseを返します - 次のサンプルコードでは、56.1 で作成したバイナリファイルに保存されている値を順に読み出します
# include <Siv3D.hpp>
// ゲームのスコアを記録する構造体
struct GameScore
{
int32 a, b, c, d;
};
void Main()
{
BinaryReader reader{ U"tutorial1.bin" };
// もしオープンに失敗したら
if (not reader)
{
throw Error{ U"Failed to open `tutorial1.bin`" };
}
// int32 型の値 (4 バイト) を読み込む
int32 n;
reader.read(n);
Print << n;
// double 型の値 (8 バイト) を読み込む
double d;
reader.read(d);
Print << d;
// Point 型の値 (8 バイト) を読み込む
Point pos;
reader.read(pos);
Print << pos;
// GameScore 型の値 (16 バイト) を読み込む
GameScore s;
reader.read(s);
Print << U"{}, {}, {}, {}"_fmt(s.a, s.b, s.c, s.d);
while (System::Update())
{
}
// reader のデストラクタで自動的にファイルがクローズされる
}
56.3 読み込み位置の変更¶
BinaryReaderの.setPos(pos)で、読み込み位置を指定した場所に移動できます.skip(size)を使うと、指定したサイズ分読み飛ばすことができます- 次のサンプルでは、56.1 で作成したバイナリファイルに保存されている値の一部だけを読み出します
# include <Siv3D.hpp>
// ゲームのスコアを記録する構造体
struct GameScore
{
int32 a, b, c, d;
};
void Main()
{
BinaryReader reader{ U"tutorial1.bin" };
// もしオープンに失敗したら
if (not reader)
{
throw Error{ U"Failed to open `tutorial1.bin`" };
}
// 先頭から 4 バイト進んだ位置に移動する
reader.setPos(4);
// double 型の値 (8 バイト) を読み込む
double d;
reader.read(d);
Print << d;
// 8 バイト分読み飛ばす
reader.skip(8);
// GameScore 型の値 (16 バイト) を読み込む
GameScore s;
reader.read(s);
Print << U"{}, {}, {}, {}"_fmt(s.a, s.b, s.c, s.d);
while (System::Update())
{
}
// reader のデストラクタで自動的にファイルがクローズされる
}
56.4 複雑なデータの書き込み（シリアライズを使わない場合）¶
StringやArrayのように単純にコピーできない (trivially copyableでない) データを、シリアライズ機能を使わずにバイナリファイルに書き込む例です.write(データの先頭ポインタ, データのサイズ)で、データの先頭ポインタから指定したサイズ分のデータを書き込みます
# include <Siv3D.hpp>
void Main()
{
BinaryWriter writer{ U"tutorial2.bin" };
// もしオープンに失敗したら
if (not writer)
{
throw Error{ U"Failed to open `tutorial2.bin`" };
}
// 書き込む文字列
const String text = U"Hello, Siv3D";
// 書き込む文字列の長さ
const uint64 length = text.length();
// 文字列の長さを書き込む (8 バイト)
writer.write(length);
// 格納されてるデータの先頭ポインタから
// (4 バイト × 長さ）分の文字列データを書き込む
writer.write(text.data(), (sizeof(char32) * length));
while (System::Update())
{
}
// writer のデストラクタで自動的にファイルがクローズされる
}
56.5 複雑なデータの読み込み（シリアライズを使わない場合）¶
StringやArrayのように単純にコピーできない (trivially copyableでない) データを、シリアライズ機能を使わずにバイナリファイルから読み込む例です.read(格納先の先頭ポインタ, データのサイズ)で、ファイルから指定したサイズ分のデータを読み込み、指定された格納先にコピーします- 次のサンプルコードでは、56.4 で作成したバイナリファイルに保存されている
Stringを読み込みます
# include <Siv3D.hpp>
void Main()
{
BinaryReader reader{ U"tutorial2.bin" };
// もしオープンに失敗したら
if (not reader)
{
throw Error{ U"Failed to open `tutorial2.bin`" };
}
// 読み込むテキストの長さを格納する変数
uint64 length = 0;
// 読み込んだテキストの格納先
String text;
// テキストの長さを読み込む
reader.read(length);
if (0 < length)
{
// テキストデータを格納するためにリサイズする
text.resize(length);
// テキストのサイズ分だけデータを読み込む
reader.read(text.data(), (sizeof(char32) * length));
}
Print << U"length: " << length;;
Print << U"text: " << text;
while (System::Update())
{
}
// reader のデストラクタで自動的にファイルがクローズされる
}
56.6 複雑なデータの書き込み（シリアライズ）¶
- シリアライズ機能を使うと、シリアライズに対応した型 (
trivially copyableでない型も含む) について、バイナリ形式への変換やバイナリ形式からの復元を手軽に行うことができます BinaryWeiterとシリアライズ機能を連係させるにはSerializer<BinaryWriter>クラスを使いますSerializer<BinaryWriter>のコンストラクタ引数に、書き込み先のファイルのパスを渡します- ファイルのオープンに成功したかどうかは、
if (writer),if (not writer)で調べられます Serializer<BinaryWriter>にシリアライズに対応した型の値を渡すと、そのデータをバイナリデータに変換してファイルの末尾に追加で書き込みます- シリアライズに対応していない型を渡した場合はコンパイルエラーになります
# include <Siv3D.hpp>
void Main()
{
Serializer<BinaryWriter> writer{ U"tutorial3.bin" };
// もしオープンに失敗したら
if (not writer)
{
throw Error{ U"Failed to open `tutorial3.bin`" };
}
// 書き込む文字列
const String text = U"Hello, Siv3D";
// 書き込むデータ
int a = 123, b = 456;
// バイナリファイルにシリアライズ対応型のデータを書き込む
writer(text);
// まとめて記述することもできる
writer(a, b);
while (System::Update())
{
}
// writer のデストラクタで自動的にファイルがクローズされる
}
56.7 複雑なデータの読み込み（シリアライズ）¶
- シリアライズ機能を使って書き込んだデータを読み込むには
Deserializer<BinaryReader>クラスの機能を使います Deserializer<BinaryReader>のコンストラクタ引数に、読み込みたいテキストファイルのパスを渡します- ファイルのオープンに成功したかどうかは、
if (reader),if (not reader)で調べられます Deserializer<BinaryReader>に()で変数の参照を渡すと、ファイルからデータをデシリアライズし、その変数に結果を格納します- シリアライズに対応していない型を渡した場合はコンパイルエラーになります
- 次のサンプルコードでは、56.6 で作成したバイナリファイルに保存されている
Stringとint32を読み込みます
# include <Siv3D.hpp>
void Main()
{
Deserializer<BinaryReader> reader{ U"tutorial3.bin" };
// もしオープンに失敗したら
if (not reader)
{
throw Error{ U"Failed to open `tutorial3.bin`" };
}
// 読み込み先の String
String text;
// 読み込み先の変数
int32 a, b;
// バイナリファイルからシリアライズ対応型のデータを読み込む
// （文字列や Array は自動でリサイズが行われる）
reader(text);
reader(a, b);
Print << U"length: " << text.length();
Print << U"text: " << text;
Print << a << U", " << b;
while (System::Update())
{
}
// reader のデストラクタで自動的にファイルがクローズされる
}
56.8 自作クラスのシリアライズ対応¶
- 自作クラスをシリアライズに対応させるには、
template <class Archive> void SIV3D_SERIALIZE(Archive& archive)という public メンバ関数をクラスに実装します - その関数の中で、
archive(a, b, c, ...)のように、シリアライズに対応したメンバ変数を順次渡すコードを書くことで、そのクラス自体もシリアライズ可能になり、SerializerやDeserializerで使用できるようになります
# include <Siv3D.hpp>
// ユーザデータとゲームのスコアを記録する構造体
struct GameScore
{
String name;
int32 id;
int32 score;
// シリアライズに対応させるためのメンバ関数
template <class Archive>
void SIV3D_SERIALIZE(Archive& archive)
{
archive(name, id, score);
}
};
void Main()
{
{
// 記録したいデータ
const Array<GameScore> scores =
{
{ U"Player1", 111, 1000 },
{ U"Player2", 222, 2000 },
{ U"Player3", 333, 3000 },
};
Serializer<BinaryWriter> writer{ U"tutorial4.bin" };
if (not writer)
{
throw Error{ U"Failed to open `tutorial4.bin`" };
}
// バイナリファイルにシリアライズ対応データ（の配列）を書き込む
writer(scores);
// writer のデストラクタで自動的にファイルがクローズされる
}
// 読み込み先
Array<GameScore> scores;
{
Deserializer<BinaryReader> reader{ U"tutorial4.bin" };
if (not reader)
{
throw Error{ U"Failed to open `tutorial4.bin`" };
}
// バイナリファイルからシリアライズ対応データを読み込む
// （Array は自動でリサイズされる）
reader(scores);
// reader のデストラクタで自動的にファイルがクローズされる
}
// 正しく読み込めていることを確認
for (const auto& score : scores)
{
Print << U"{}(id: {}): {}"_fmt(score.name, score.id, score.score);
}
while (System::Update())
{
}
}