MGL::Text::TextStream クラス

テキストストリームクラス [詳解]

#include <mgl_text_stream.h>

公開メンバ関数
constexpr	TextStream () noexcept=default
	コンストラクタ
	TextStream (const uint8_t *buffer, size_t size, Encoding encoding=Encoding::Auto, bool existBOM=false) noexcept
	コンストラクタ
void	Set (const uint8_t *buffer, size_t size, Encoding encoding=Encoding::Auto, bool existBOM=false) noexcept
	バッファの設定
bool	Load (const File::PathView &filepath, Encoding encoding=Encoding::Auto) noexcept
	ファイルから読み込み
Encoding	GetEncoding () const noexcept
	エンコードタイプの取得
Character	Read () noexcept
	文字の取得
int	Read (CharacterArray &array) noexcept
	全ての文字を文字配列に格納
int	ReadLine (CharacterArray &array) noexcept
	現在位置から行末まで読み込み
void	PrintInfo () const noexcept
	情報の表示
constexpr bool	IsTerminated () const noexcept
	終了判定

詳解

テキストストリームクラス

構築子と解体子

TextStream()

MGL::Text::TextStream::TextStream ( const uint8_t * buffer, size_t size, Encoding encoding = Encoding::Auto, bool existBOM = false )

noexcept

コンストラクタ

引数

[in]	buffer	文字列バッファ
[in]	size	バッファサイズ
[in]	encoding	エンコードタイプ（省略で自動検出）
[in]	existBOM	BOMが付与されているかのフラグ．エンコードタイプにAutoを指定した場合は参照しない

関数詳解

GetEncoding()

Encoding MGL::Text::TextStream::GetEncoding ( ) const

inlinenodiscardnoexcept

エンコードタイプの取得

戻り値

設定されているエンコードタイプ

覚え書き

この関数で取得できるエンコードタイプは，引数で指定または自動認識によって判別された値であり， 関連づけられたバッファのエンコードタイプを正確に表しているものではない． 両者が一致していない場合，Read()またはReadLine()に失敗する．

IsTerminated()

bool MGL::Text::TextStream::IsTerminated ( ) const

inlinenodiscardconstexprnoexcept

終了判定

戻り値

true	終了
false	バッファに残りがある

Load()

bool MGL::Text::TextStream::Load ( const File::PathView & filepath, Encoding encoding = Encoding::Auto )

noexcept

ファイルから読み込み

引数

[in]	filepath	ファイルのパス
[in]	encoding	エンコードタイプ（省略で自動検出）

戻り値

true	成功
false	失敗

Read() [1/2]

Character MGL::Text::TextStream::Read ( )

noexcept

文字の取得

戻り値

取得した文字

Read() [2/2]

int MGL::Text::TextStream::Read ( CharacterArray & array )

noexcept

全ての文字を文字配列に格納

引数

[out]

array

文字配列の格納先

戻り値

新たに格納した文字の数

ReadLine()

int MGL::Text::TextStream::ReadLine ( CharacterArray & array )

noexcept

現在位置から行末まで読み込み

引数

[out]

array

文字配列の格納先

戻り値

新たに格納した文字の数

Set()

void MGL::Text::TextStream::Set ( const uint8_t * buffer, size_t size, Encoding encoding = Encoding::Auto, bool existBOM = false )

noexcept

バッファの設定

引数

[in]	buffer	文字列バッファ
[in]	size	バッファサイズ
[in]	encoding	エンコードタイプ（省略で自動検出）
[in]	existBOM	BOMが付与されているかのフラグ．エンコードタイプにAutoを指定した場合は参照しない

---

このクラス詳解は次のファイルから抽出されました:

• /Users/acerola/work/mgl-work/mgl/include/mgl/text/mgl_text_stream.h
• /Users/acerola/work/mgl-work/mgl/src/text/mgl_text_stream.cc