C++　フリーでぷろぐらみんぐ

前ページ
次ページ

boost::spiritの機能とは？（リファレンス一覧）

boost::spirit::qiの使い方は他の記事に譲りまして、

ここでは、フォーマット定義（rule）を作るためのクラス一覧を書いてみようと思います。

boost 1.55.0 の本家ドキュメントを翻訳する形ですが、英語はちょ～苦手

google先生の翻訳でもよくわからない項目は項目だけ書いています。

すみません

まあ、間違いが多くても役に立つかもしれないので、とりあえず行ってみましょー。

【一覧の見方】

amebaの機能制限で、4万文字以上1つの記事で書けないようです。

ですので、一覧が別々の記事になってしまっています。

テーマ一覧で見てもらった方が見やすいかもしれないです。

【パーサについて】

一覧にしているパーサは、どのような解釈をするのか？と返り値は何か？が重要です。

返り値は本家のドキュメントのコピーですが、独特の記法で記述しています。

ここでは、その記法について軽く説明しておこうと思います。

記号	説明
p	パーサ
P	パーサpの返り値。
fa	Actionのための関数、関数オブジェクト
a	任意の定数値。例：0.0 , "Hello"
cp	Character Parsers　のどれかを指す。
Unused	パーサの返り値が保管されないことを示します。

＜返り値の記法＞

p: P --> no_skip[p]: P

上記のように書かれた場合、

パーサpの返り値がPのとき、no_skip[p]の返り値はPになる、という意味になります。

【パーサ一覧について】

・文字列パーサ（String Parsers）
・パーサ演算子（Parser Operators ）
・数値パーサ（Numeric Parsers ）

・パーサへの命令（Parser Directives）

・文字パーサ（Character Parsers）

・バイナリデータパーサ（Binary Parsers）

・返り値補助パーサ（Auxiliary Parsers）

・イベント機能等

spirit機能：：文字列パーサ（String Parsers）

リファレンスのトップ

目	記法	説明	返り値と変数への代入（Attribute）
文字列パーサ String Parsers	↓	文字列にマッチします。このパーサは、lexemeパーサの機能も持っているので、スキップ機能が働きません。
	文字列""	例：　"abc"	unused
	lit(s)	例：　lit("abc")	unused
	string型変数	例：　string("abc")	string型を返します
Symbols Parser	下	設定したマップに従って、値を変換します。例：　入力は、"Banana" symbols<char, int> sym; sym.add("Apple", 1) ("Banana", 2) ("Orange", 3) ; int i; parse(begin, end, sym, i); //i=2 が入ります。	symbol<Char, T>の場合、型Tで返り値を返します。

spirit機能：：パーサ演算子（Parser Operators ）

リファレンスのトップ

大項目	記法	説明	返り値と変数への代入（Attribute）
パイプ（｜）パーサ Alternative Parser	a \| b	aもしくはbにマッチするもの。意味合いとしては、「OR」ではなく、「if～else if～else if～」という表現に近いです。次の違いを見るともう少し、イメージできると思います。例：　以下は同じではありません。表現①：　(double_ \| int_) 表現②：　(int_ \| double_) 例えば、入力が"123.45"のとき、①では完全マッチしますが、②では完全マッチしません。 ①の場合、double_ は小数点文字（ピリオド）も許すため、「.45」まで読み進めます。しかし、②の場合、int_ は、数字でない文字が表れるまで読み進めます。ピリオドは数字ではないので、「123」までです。つまり、（）内はint_ にマッチして（）を抜けます。そして次のパーサがないので、次の読み取りで終端にならなければなりませんが、「.45」が残っているので、マッチしないのです。つまり、パイプ（｜）は、else ifと同様に最初にマッチしたパーサを適用してそこまで読み進め、次のパーサにマッチするかを検証しようとするのです。 ※このように次のパーサのマッチに失敗した時に、読み進めた位置を元に戻してもう一つのパーサbを検証しません。また、保管した返り値も元に戻しません。このことを、spirit本家のドキュメントでは「ロールバック（rollback）しない」と表現しているようです。英語のドキュメントを読むときにこの知識が役立つかもしれません。	a: A, b: B --> (a \| b): variant<A, B> a: A, b: Unused --> (a \| b): optional<A> a: A, b: B, c: Unused --> (a \| b \| c): optional<variant<A, B> > a: Unused, b: B --> (a \| b): optional<B> a: Unused, b: Unused --> (a \| b): Unused a: A, b: A --> (a \| b): A
And述語パーサ And-Predicate Parser	&a	？	unused_type
差分パーサ Difference Parser	a - b	パースaにマッチして、bにはマッチしないもの。条件から外すときに便利です。例：　入力文字列　"/A Comment/" "/" >> (char_ - "/") >> "/" ⇒マッチします。　もし、"/" >> char_ >> "/"　だとマッチしません。char_ はなんでもマッチするので、入力の最後の"/"までマッチして読み進めます。位置が終端まで行った後に、「>> "*/"」にマッチするか試すため、当然マッチしません。	a: A, b: B --> (a - b): A a: Unused, b: B --> (a - b): Unused
期待値チェックパーサ Expectation Parser	a > b	入力がある条件に一致しなければならない場合にあります。そんなときに使用するのがこの演算子です。このパーサで指定したパーサa bが順番にマッチしない場合は、例外を発生します。	a: A, b: A --> (a > b): vector<A> a: vector<A>, b: A --> (a > b): vector<A> a: A, b: vector<A> --> (a > b): vector<A> a: vector<A>, b: vector<A> --> (a > b): vector<A>
アスタリスクパーサ Kleene Parser	*a	0回以上aにマッチする演算子です。注意点としては、パーサaがマッチするたびに返り値が返って、保管先に保管されることです。例：　入力が "abc" vector<string> vec; qi::parse(first, last, qi::char_, vec); ⇒vec[0]には、"a"が格納されます。なんとなくvec[0]="abc"となりそうですが、毎回char_ にマッチするたびに返り値が保管されます。もし、"abc"を格納したい場合は、qi::as_string[qi::char_]　というように記述すると良いかと思います。	a: A --> a: vector<A> a: Unused --> a: Unused
配列パーサ List Parser	a % b	配列に分解する演算子です。 a >> *(b >> a)　と同じ意味になります。例：　"111, 222, 333, 444, 555" int_ % ','	a: A, b: B --> (a % b): vector<A> a: Unused, b: B --> (a % b): Unused
否定パーサ Not-Predicate Parser	!a	パーサaとマッチしなければ、成功。マッチした場合はその時点で失敗（fail）になります。パーサaとマッチしない場合は、次のパーサに行きますが、!aは返り値は返しません。例：　入力は、"abcdef;" *(!lit(';') >> char_) >> ';'	unused_type
オプション的パーサ Optional Parser	-a	0回もしくは1回だけマッチする演算子です。例：　入力は、"123" -('+' \| '-') >> int_ ⇒例題の入力だけでなく、"+123"や"-123"にもマッチします。	a: A --> -a: optional<A> a: Unused --> -a: Unused
順列自在パーサ Permutation Parser	a ^ b	ハット（^）でつないだパーサのうち、1個以上のパーサにマッチします。ただし、a、bの順番は任意です。つまり、　aや bや、 a >> b　にも、b >> aにもマッチします。例：　入力は、"ACTGGCTAGACT" *(char_('A') ^ 'C' ^ 'T' ^ 'G')	a: A, b: B --> (a ^ b): tuple<optional<A>, optional<B> > a: A, b: Unused --> (a ^ b): optional<A> a: Unused, b: B --> (a ^ b): optional<B> a: Unused, b: Unused --> (a ^ b): Unused
1個以上パーサ Plus Parser	+a	1回以上マッチする演算子です。	a: A --> +a: vector<A> a: Unused --> +a: Unused
順番パーサ Sequence Parser	a >> b	パーサaにマッチした後、パーサbにマッチします。入力文字列が、順番にマッチする場合に成功します。	a: A, b: B --> (a >> b): tuple<A, B> a: A, b: Unused --> (a >> b): A a: Unused, b: B --> (a >> b): B a: Unused, b: Unused --> (a >> b): Unused a: A, b: A --> (a >> b): vector<A> a: vector<A>, b: A --> (a >> b): vector<A> a: A, b: vector<A> --> (a >> b): vector<A> a: vector<A>, b: vector<A> --> (a >> b): vector<A>
順列OR混合パーサ Sequential Or Parser	a \|\| b	「aのみ」もしくは、「bのみ」にマッチするか、「a b」の順番に両方にマッチする演算子です。【解釈の順番と返り値】入力文字列が、「aのみ」、「bのみ」、「aとb」の3つのうちどれにもマッチする場合、いったいどれにマッチするのでしょうか？どうも、「aとｂ」をまず試して、マッチしないと、「aのみ」、「bのみ」の順番にで試すようです。例：　入力は、"123.456" int_ \|\| ('.' >> int_) 　⇒数値123 と456の2つが返り値として保管されます。　　もし、入力が"123"の場合は、「aのみ」にマッチします。　　もし、入力が".456"の場合は、「bのみ」にマッチします。	a: A, b: B --> (a \|\| b): tuple<optional<A>, optional<B> > a: A, b: Unused --> (a \|\| b): optional<A> a: Unused, b: B --> (a \|\| b): optional<B> a: Unused, b: Unused --> (a \|\| b): Unused a: A, b: A --> (a \|\| b): vector<optional<A> >

spirit機能：：数値パーサ（Numeric Parsers ）

リファレンスのトップ

大項目	記法	説明	返り値と変数への代入（Attribute）
正数パーサ Unsigned Integer Parsers	↓	以下のtemplateの型を決めたパーサを提供します。もちろん、自分でtemplateのパラメタを決めて使用することもできます。 uint_parser<T, Radix, MinDigits, MaxDigits>() uint_parser<T, Radix, MinDigits, MaxDigits>()(num) ※型Tに応じたオーバーフローもチェックしていることにもご注意ください。
	lit(num)	numで指定した数値にマッチするもの。	Unused
	ushort_	正の整数。(num)つきのものは、numで指定した数値にマッチするもの。	unsigned short
	ushort_(num)	正の整数。(num)つきのものは、numで指定した数値にマッチするもの。	unsigned short
	uint_	同上	unsigned int
	uint_(num)
	bin
	bin(num)
	oct
	oct(num)
	hex
	hex(num)
	ulong_	同上	unsigned long
	ulong_(num)	同上	unsigned long
	ulong_long	同上	boost::ulong_long_type
	ulong_long(num)	同上	boost::ulong_long_type
正負数パーサ Signed Integer Parsers	↓	以下のtemplateの型を決めたパーサを提供します。もちろん、自分でtemplateのパラメタを決めて使用することもできます。 int_parser<T, Radix, MinDigits, MaxDigits>() int_parser<T, Radix, MinDigits, MaxDigits>()(num) ※型Tに応じたオーバーフローもチェックしていることにもご注意ください。
	lit(num)	numで指定した数値にマッチするもの。	unused
	short_	正の整数。(num)つきのものは、numで指定した数値にマッチするもの。	short
	short_(num)	正の整数。(num)つきのものは、numで指定した数値にマッチするもの。	short
	int_	同上	int
	int_(num)	同上	int
	long_	同上	long
	long_(num)	同上	long
	long_long	同上	boost::long_long_type
	long_long(num)	同上	boost::long_long_type
浮動小数パーサ Real Number Parsers	↓	以下のtemplateの型を決めたパーサを提供します。もちろん、自分でtemplateのパラメタを決めて使用することもできます。 real_parser<T, RealPolicies>() real_parser<T, RealPolicies>()(num) ※型Tに応じたオーバーフローもチェックしていることにもご注意ください。
	lit(num)	numで指定した数値にマッチするもの。	Unused
	float_	浮動小数。(num)つきのものは、numで指定した数値にマッチするもの。	float
	float_(num)	浮動小数。(num)つきのものは、numで指定した数値にマッチするもの。	float
	double_	同上	double
	double_(num)	同上	double
	long_double	同上	long double
	long_double(num)	同上	long double
ブールパーサ Boolean Parser	↓	以下のtemplateの型を決めたパーサを提供します。もちろん、自分でtemplateのパラメタを決めて使用することもできます。 bool_parser<T, BoolPolicies>() bool_parser<T, BoolPolicies>()(num)
	lit(boolean)	booleanで指定した数値にマッチするもの。	Unused
	true_	bool型を提供します。	bool
	false_
	bool_
	bool_(boolean)

前ページ
次ページ

目次

boost::spiritの機能とは？（リファレンス一覧）

spirit機能：：文字列パーサ（String Parsers）

spirit機能：：パーサ演算子（Parser Operators ）

spirit機能：：数値パーサ（Numeric Parsers ）