MGL(Win32)
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 静的公開変数類 | 全メンバ一覧
MGL::Text::Character クラス

文字クラス [詳解]

#include <mgl_text_character.h>

公開メンバ関数

constexpr Character (uint32_t code) noexcept
 コンストラクタ
 
constexpr char32_t GetCode () const noexcept
 値を取得
 
constexpr void SetCode (char32_t code) noexcept
 値を設定
 
constexpr void SetInvalidMarker () noexcept
 不正なコードのマーカーを書き込む
 
constexpr bool IsValid () const noexcept
 コードが正常かどうかを取得する
 
constexpr bool IsNull () const noexcept
 Null文字かどうかを判定
 
constexpr bool IsNewLine () const noexcept
 改行文字かどうかを取得
 
constexpr bool IsSpace () const noexcept
 スペースかどうかを取得
 
constexpr bool IsDigit () const noexcept
 数値かどうかを取得
 
size_t GetByteSize () const noexcept
 文字をバイトに変換する際に必要なサイズを取得
 
bool ToByte (char byteArray[kByteArraySize]) const noexcept
 コードをバイト列に変換
 
char * ToByte (char *dest, size_t destSize) const noexcept
 文字をバイト列に変換
 
STL::string ToString () const noexcept
 文字をSTL::stringに変換
 

静的公開変数類

static constexpr uint32_t kInvalidMarkerBit = 1UL << 31UL
 不正な文字を検出した際に書き込むビット位置
 
static constexpr uint32_t kValidateMask = 0xFFFFFFFF & ~kInvalidMarkerBit
 コードの有効範囲
 
static constexpr size_t kByteArraySize = 5
 バイト配列のサイズ
 

詳解

文字クラス

構築子と解体子

◆ Character()

MGL::Text::Character::Character ( uint32_t code)
inlineconstexprnoexcept

コンストラクタ

引数
[in]code文字の値

関数詳解

◆ GetByteSize()

size_t MGL::Text::Character::GetByteSize ( ) const
nodiscardnoexcept

文字をバイトに変換する際に必要なサイズを取得

戻り値
必要サイズ．不正な文字の場合は0

◆ GetCode()

char32_t MGL::Text::Character::GetCode ( ) const
inlinenodiscardconstexprnoexcept

値を取得

戻り値
値

◆ IsNewLine()

bool MGL::Text::Character::IsNewLine ( ) const
inlinenodiscardconstexprnoexcept

改行文字かどうかを取得

戻り値
true改行文字
false改行文字ではない

◆ IsNull()

bool MGL::Text::Character::IsNull ( ) const
inlinenodiscardconstexprnoexcept

Null文字かどうかを判定

戻り値
trueNull文字
falseNull文字ではない

◆ IsSpace()

bool MGL::Text::Character::IsSpace ( ) const
inlinenodiscardconstexprnoexcept

スペースかどうかを取得

戻り値
trueスペース文字
falseスペース文字ではない

◆ IsValid()

bool MGL::Text::Character::IsValid ( ) const
inlinenodiscardconstexprnoexcept

コードが正常かどうかを取得する

戻り値
true正常
false不正

◆ SetCode()

void MGL::Text::Character::SetCode ( char32_t code)
inlineconstexprnoexcept

値を設定

引数
[in]code値

◆ ToByte() [1/2]

char * MGL::Text::Character::ToByte ( char * dest,
size_t destSize ) const
noexcept

文字をバイト列に変換

引数
[out]dest書き込み先のアドレス
[in]destSize書き込み先バッファのサイズ
戻り値
成功した場合は終端記号を書き込んだアドレス．失敗時にはnullptr

◆ ToByte() [2/2]

bool MGL::Text::Character::ToByte ( char byteArray[kByteArraySize]) const
noexcept

コードをバイト列に変換

引数
[out]byteArrayバイトコードの格納先
戻り値
true成功
false失敗
覚え書き
とりあえずUTF-8で返す． 将来は他の他の文字コード（Shift-JISなど）にも対応するかも．

◆ ToString()

STL::string MGL::Text::Character::ToString ( ) const
nodiscardnoexcept

文字をSTL::stringに変換

戻り値
変換した文字
このクラス詳解は次のファイルから抽出されました:
構築: doxygen 1.12.0