Text ライブラリ

• 概要 - Abstruct
• 目次 - Index
• 構造体 - Structs
• 変数 - Variables
• 関数 - Functions
• 実装コード
• テストコード

概要 - Abstract

VCSSL Text ライブラリ は、テキスト（文字列）処理を扱う標準ライブラリです。

このライブラリでは、文字列を扱う string 型の変数に対して、長さや部分文字列の取得、検索と置換、分割などの機能を提供します。なお、検索、置換、分割では、正規表現を用いる事もできます。

目次 - Index

const int ALL

文字列と一致する、全ての部分を探す検索モードです。

const int ALL_PATTERN

正規表現と一致する、全ての部分を探す検索モードです。

const int FIRST

文字列と一致する、最初の部分を探す検索モードです。

const int FIRST_PATTERN

正規表現と一致する、最初の部分を探す検索モードです。

const int LAST

文字列と一致する、最後の部分を探す検索モードです。

const int LAST_PATTERN

正規表現と一致する、最後の部分を探す検索モードです。

const int START

文字列の先頭が、部分文字列と一致するかを判断する判定モードです。

const int START_PATTERN

文字列の先頭が、正規表現と一致するかを判断する判定モードです。

const int END

文字列の終端が、部分文字列と一致するかを判断する判定モードです。

const int END_PATTERN

文字列の終端が、正規表現と一致するかを判断する判定モードです。

const int CONTAIN

文字列のどこかに、部分文字列と一致する部分が存在するかを判断する判定モードです。

const int CONTAIN_PATTERN

文字列のどこかに、正規表現と一致する部分が存在するかを判断する判定モードです。

const int FULL_PATTERN

文字列の全体が、正規表現と一致するかを判断する判定モードです。

string atText( string text, int index )

文字列内の、指定されたインデックスの位置にある文字を、1文字のstring型変数として返します。

bool checkText( string text, string query, int mode )

文字列の先頭、末尾、または全体が、指定された文字列か正規表現に一致するかを判定します。

string cropText( string text, int cropBegin, int cropEnd )

テキストから、指定された範囲を抜き出したものを返します。抜き出す範囲は、テキストの各文字に、先頭を 0 としてインデックスを割りふると、cropBegin 番目から cropEnd - 1 番目までの文字列となります。また、文字と文字の「 隙間（すきま） 」にインデックスを割りふると、抜き出す範囲はちょうど cropBegin 番目から cropEnd 番目までの隙間に挟まれた範囲となります。

int countText( string text )

テキストの文字数をカウントして返します。

int countText( string text, string query, int mode )

テキストから、部分文字列（ または正規表現 ）に一致する箇所を検索し、その個数をカウントして返します。

int countText( string text, string query, int searchBegin, int mode )

テキストの指定位置以降から、部分文字列（ または正規表現 ）に一致する箇所を検索し、その個数をカウントして返します。

int countText( string text, string query, int searchBegin, int searchEnd, int mode )

テキストの指定範囲内から、部分文字列（ または正規表現 ）に一致する箇所を検索し、その個数をカウントして返します。

int[ ] findText( string text, string query, int mode )

テキストから、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所の文字インデックスを配列にまとめて返します。

int[ ] findText( string text, string query, int searchBegin, int mode )

テキスト指定位置以降から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所の文字インデックスを配列にまとめて返します。検索で一致する箇所が無かった場合、戻り値は要素数 0 の配列となります。

int[ ] findText( string text, string query, int searchBegin, int searchEnd, int mode )

テキスト指定範囲内から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所の文字インデックスを配列にまとめて返します。検索で一致する箇所が無かった場合、戻り値は要素数 0 の配列となります。

string[ ] extractText( string text, string query, int mode )

テキストから、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所を抜き出した文字列を配列にまとめて返します。検索で一致する箇所が無かった場合、戻り値は要素数 0 の配列となります。

string[ ] extractText( string text, string query, int searchBegin, int mode )

テキストの指定位置以降から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所を抜き出した文字列を配列にまとめて返します。検索で一致する箇所が無かった場合、戻り値は要素数 0 の配列となります。

string[ ] extractText( string text, string query, int searchBegin, int searchEnd, int mode )

テキストの指定範囲内から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所を抜き出した文字列を配列にまとめて返します。検索で一致する箇所が無かった場合、戻り値は要素数 0 の配列となります。

string replaceText( string text, string query, string newPart, int mode )

テキストから、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所を別の文字列で置き換えて返します。

string replaceText( string text, string query, string newPart, int searchBegin, int mode )

テキストの指定位置以降から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所を別の文字列で置き換えて返します。

string replaceText( string text, string query, string newPart, int searchBegin, int searchEnd, int mode )

テキストの指定範囲内から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所を別の文字列で置き換えて返します。

string[ ] splitText( string text, string query, int mode )

テキストから、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所で元のテキストを分割したものを、配列にまとめて返します。

string[ ] splitText( string text, string query, int searchBegin, int mode )

テキストの指定位置以降から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所で元のテキストを分割したものを、配列にまとめて返します。

string[ ] splitText( string text, string query, int searchBegin, int searchEnd, int mode )

テキストの指定範囲内から、部分文字列（ または正規表現 ）に一致する箇所を検索し、一致箇所で元のテキストを分割したものを、配列にまとめて返します。

string[ ] split( string text, string query )

文字列を、特定の文字列の位置で分割し、配列にまとめて返します。現在は、同様の（またはより高度な）機能を提供する、新しい splitText 関数がサポートされています。例えば、splitText(text, query, ALL) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。なお、この関数では、引数 text のちょうど終端に query が存在する場合、その後に空文字があるとは見なされず、返される配列の最終要素にも空文字は格納されません。この点の挙動は splitText と異なりますが、互換性を保つため、今後も改修されません。

string[ ] splitPattern( string text, string query )

文字列を、特定の正規表現に適合する位置で分割し、配列にまとめて返します。現在は、同様の（またはより高度な）機能を提供する、新しい splitText 関数がサポートされています。例えば、splitText(text, query, ALL_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。なお、この関数では、引数 text のちょうど終端に query が存在する場合、その後に空文字があるとは見なされず、返される配列の最終要素にも空文字は格納されません。この点の挙動は splitText と異なりますが、互換性を保つため、今後も改修されません。

string replace( string text, string oldText, string newText )

文字列に含まれる部分文字列を、全て別の部分文字列に置換したものを返します。現在は、同様の（またはより高度な）機能を提供する、新しい replaceText 関数がサポートされています。例えば、replaceText(text, query, ALL) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string replacePattern( string text, string oldText, string newText )

文字列内で正規表現に適合する区間を、全て別の部分文字列に置換したものを返します。現在は、同様の（またはより高度な）機能を提供する、新しい replaceText 関数がサポートされています。例えば、replaceText(text, query, ALL_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string replaceFirst( string text, string oldText, string newText )

文字列に含まれる部分文字列を、最初のものだけ、別の部分文字列に置換したものを返します。現在は、同様の（またはより高度な）機能を提供する、新しい replaceText 関数がサポートされています。例えば、replaceText(text, query, FIRST) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string replaceFirstPattern( string text, string oldText, string newText )

文字列内で正規表現に適合する区間を、最初のものだけ、別の部分文字列に置換したものを返します。現在は、同様の（またはより高度な）機能を提供する、新しい replaceText 関数がサポートされています。例えば、replaceText(text, query, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string replaceFirst( string text, string oldText, string newText, int start )

文字列に含まれる部分文字列を、別の部分文字列に置換したものを返します。部分文字列の適合箇所が複数存在する場合は、引数 start に指定したインデックス以降で、最初のものだけが置換されます。現在は、同様の（またはより高度な）機能を提供する、新しい replaceText 関数がサポートされています。例えば、replaceText(text, query, start, FIRST) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string replaceFirstPattern( string text, string oldText, string newText, int start )

文字列内で正規表現に適合する区間を、別の部分文字列に置換したものを返します。正規表現の適合箇所が複数存在する場合は、引数 start に指定したインデックス以降で、最初のものだけが置換されます。現在は、同様の（またはより高度な）機能を提供する、新しい replaceText 関数がサポートされています。例えば、replaceText(text, query, start, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string substring( string text, int start, int end )

文字列内の、指定されたインデックス区間にある部分文字列を返します。現在は、同様の機能を提供する、新しい cropText 関数がサポートされています。例えば、cropText(text, start, end) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

int lengthOf( string text )

文字列の文字数を返します。現在は、同様の機能を提供する、新しい countText 関数がサポートされています。例えば、countText(text) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

bool startsWith( string text, string word )

文字列が、指定された部分文字列で始まっているかどうか判定します。現在は、同様の機能を提供する、新しい checkText 関数がサポートされています。例えば、checkText(text, word, START) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

bool endsWith( string text, string word )

文字列が、指定された部分文字列で終わっているかどうか判定します。現在は、同様の機能を提供する、新しい checkText 関数がサポートされています。例えば、checkText(text, word, END) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string match( string text, string pattern )

この API の使用は推奨されません。現在は、同様の機能を提供する、新しい extractText 関数がサポートされています。例えば、extractText(text, pattern, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string match( string text, string pattern, int start )

この API の使用は推奨されません。現在は、同様の機能を提供する、新しい extractText 関数がサポートされています。例えば、extractText(text, pattern, start, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

bool matchFull( string text, string pattern )

文字列全体が、正規表現に適合するかどうか判定します。現在は、同様の機能を提供する、新しい checkText 関数がサポートされています。例えば、checkText(text, word, FULL_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string matchFirst( string text, string pattern )

文字列全体から、正規表現に最初に適合する箇所を抜き出して返します。現在は、同様の機能を提供する、新しい extractText 関数がサポートされています。例えば、extractText(text, pattern, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string matchFirst( string text, string pattern, int start )

文字列から、正規表現に適合する箇所を抜き出して返します。正規表現の適合箇所が複数存在する場合は、引数 start に指定したインデックス以降から、最初のものだけが選択されます。現在は、同様の機能を提供する、新しい extractText 関数がサポートされています。例えば、extractText(text, pattern, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string matchLast( string text, string pattern )

文字列全体から、正規表現に最後に適合する箇所を抜き出して返します。現在は、同様の機能を提供する、新しい extractText 関数がサポートされています。例えば、extractText(text, pattern, LAST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string matchLast( string text, string pattern, int end )

文字列から、正規表現に適合する箇所を抜き出して返します。正規表現の適合箇所が複数存在する場合は、引数 end に指定したインデックスの位置よりも前から、最後のものだけが選択されます。現在は、同様の機能を提供する、新しい extractText 関数がサポートされています。例えば、extractText(text, pattern, 0, end, LAST_PATTERN) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

int indexOf( string text, string word )

文字列内から、指定された部分文字列の位置を取得します。複数存在する場合は、最初のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, FIRST) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）文字列内に部分文字列が含まれているかどうかの判断は、 0 < countText(text, word, ALL) などで行えます。この関数は互換目的でサポートされています。

int indexOf( string text, string word, int start )

文字列内から、指定された部分文字列の位置を取得します。複数存在する場合は、引数 start に指定したインデックス以降から、最初のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, start, FIRST) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）文字列内の指定位置以降に部分文字列が含まれているかどうかの判断は、 0 < countText(text, word, start, ALL) などで行えます。この関数は互換目的でサポートされています。

string indexOfPattern( string text, string word )

文字列内から、指定された正規表現に適合する位置を取得します。複数存在する場合は、最初のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）この関数は互換目的でサポートされています。

string indexOfPattern( string text, string word, int start )

文字列内から、指定された正規表現に適合する位置を取得します。複数存在する場合は、最初のものが選択されます。引数 start に指定したインデックス以降から、存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, start, FIRST_PATTERN) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）この関数は互換目的でサポートされています。

int lastIndexOf( string text, string word )

文字列内から、指定された部分文字列の位置を取得します。複数存在する場合は、最後のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, LAST) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）この関数は互換目的でサポートされています。

int lastIndexOf( string text, string word, int end )

文字列内から、指定された部分文字列の位置を取得します。複数存在する場合は、引数 end に指定したインデックス以前から、最後のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, 0, end, LAST) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）この関数は互換目的でサポートされています。

string lastIndexOfPattern( string text, string word )

文字列内から、指定された正規表現に適合する位置を取得します。複数存在する場合は、最後のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, LAST_PATTERN) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）この関数は互換目的でサポートされています。

string lastIndexOfPattern( string text, string word, int end )

文字列内から、指定された正規表現に適合する位置を取得します。複数存在する場合は、引数 end に指定したインデックス以前から、最後のものが選択されます。存在しない場合は -1 を返します。現在は、同様の機能を提供する、新しい findText 関数がサポートされています。例えば、findText(text, word, 0, end, LAST_PATTERN) とすればこの関数と同様の結果が得られます。（ただし、一致部分が無い場合は要素数 0 の配列が返されます。）この関数は互換目的でサポートされています。

string charAt( string text, int index )

文字列内の、指定されたインデックスの位置にある文字を返します。現在は、同様の機能を提供する、新しい atText 関数がサポートされています。例えば、atText(text, index) とすればこの関数と同様の結果が得られます。この関数は互換目的でサポートされています。

string[ ] tokenize( string text )

文字列内を、空白またはタブ、もしくは改行区切りでトークンに分割し、配列にまとめて返します。

構造体 - Structs

- なし - None -

変数 - Variables

関数 - Functions