文法

文法はルールの集合をカプセル化する。 grammar クラスは全ての文法のプロトコル基底クラスである。 基本的にはインターフェイス規約である[訳注：「このクラスから派生してください」だけでなく、「このようにインタフェースを定義してください」という規約があるということ]。 grammar はテンプレートクラスであり、それ自身の派生クラスである DerivedT と、 コンテキスト ContextT によってパラメータ化される。 テンプレートパラメータ ContextT はデフォルトでは定義済みコンテキスト parser_context である。 文法の低レベルな振る舞いに手を加えたいのでない限り、 ContextT テンプレートパラメータを気にする必要はまったくない。 ContextT テンプレートパラメータの詳細な情報は別のところで与えられる。 grammar はテンプレートパラメータ DerivedT に依存している。 これは実際にルールを定義している grammar のサブクラスである。

上記は公開された API である。 ContextT の後には実際にはより多くのテンプレートパラメータが存在しうる。 ContextT パラメータの後ろのすべてのものは利用者に考慮されるべきではなく、厳格に内部でのみ使用すべきものである。

    template<
        typename DerivedT,
        typename ContextT = parser_context>
    struct grammar;

文法定義

grammar を継承した具象サブクラスは definition という ネストされたテンプレートクラス（または構造体）を持つよう要求される：

typename ScannerT というパラメータを持つネストされたテンプレートクラスである。
コンストラクタでルールを定義する。
コンストラクタは実際の文法 self への参照を渡される。
start という名前のメンバ関数を持ち、これは開始ルール rule への参照を返す。

文法の概略

    struct my_grammar : public grammar<my_grammar>
    {
        template <typename ScannerT>
        struct definition
        {
            rule<ScannerT>  r;
            definition(my_grammar const& self)  { r = /*..define here..*/; }
            rule<ScannerT> const& start() const { return r; }
        };
    };

文法を形成するルールからスキャナやイテレータの型を切り離すことは、 おそらくは異なるスキャナ／イテレータを用いるであろう別のコンテキストの下でも、その文法が使えるようにする。 どんなスキャナを扱っているかを気にすることはない。 ユーザが定義した my_grammar はスキャナ型に関係なくインスタンス化されることができ、 あらゆる型のスキャナを用いるパーサとして使わうことができる。 すなわち、ルールとは異なり、文法は特定のスキャナ型に結びつけられていない。 なぜこれが重要であるか理解し、またこのスキャナとルールの組み合わせ問題についてさらなる理解を得るには "スキャナの働き" を参照して欲しい。

my_grammar のインスタンス化と使用

さて上述の文法をインスタンス化して動作させてみよう：

    my_grammar g;

    if (parse(first, last, g, space_p).full)
        cout << "parsing succeeded\n";
    else
        cout << "parsing failed\n";

my_grammar はパーサである。 パーサが期待されるところなら、それが例えほかのルールから参照されている場合であっても、どこででも使うことができる：

    rule<>  r = g >> str_p("cool huh?");

完全な文法の例

以下は我々のもともとの電卓の例であるが、ここでは文法を用いて書き直されている：

    struct calculator : public grammar<calculator>
    {
        template <typename ScannerT>
        struct definition
        {
            definition(calculator const& self)
            {
                group       = '(' >> expression >> ')';
                factor      = integer | group;
                term        = factor >> *(('*' >> factor) | ('/' >> factor));
                expression  = term >> *(('+' >> term) | ('-' >> term));
            }

            rule<ScannerT> expression, term, factor, group;

            rule<ScannerT> const&
            start() const { return expression; }
        };
    };

セマンティックアクションを伴う完全に動作する例は ここから見ることができる。 これは Spirit 配布物の一部である。
［ libs/spirit/example/fundamental/calc/calc_plain.cpp を参照］

self 文法の定義が外側の文法への const な参照を受けるコンストラクタを持つことお気づきだろうか。 上記の例では、 calculator::definition が calculator const&self を取っていることに注目。 これは上記の例では使われていないが、多くの場合、非常に有用である。 self 引数は definition の外の世界への窓である。 例えば電卓クラスは、構文解析処理が進行する間に definition がセマンティックアクションを使って更新できるいくつかの状態情報への参照を持つことができるだろう。

文法カプセル

いささか複雑な文法の場合、文法の各部を論理モジュールにグループ分けするのは良い考えである。 例えば、ある言語を書いているとき、式やステートメントを別々の文法カプセルに 分けておくのは賢明だろう。 その文法は C++ クラスのカプセル化という性質の長所を手にする。 クラスの宣言的な性質は文法の定義に完璧に適している。 文法とはクラス宣言以外の何者でもないので、好都合なことにヘッダーファイルの中で 公表できる。 ひとたび書かれ、完全にテストされた文法は、多くの文脈で再利用できるというアイディアである。 文法ライブラリという概念である。

再入可能性とマルチスレッド処理

文法のインスタンスは異なる場所で複数回何の問題もなく使われることができる。 その実装はいくらかのオーバーヘッドを費やしてこれを許すようにチューンされている。 しかし、もし文法が単一のインスタンスしか持たないと知っているならば、 少なからぬサイクル[訳注： CPU の処理周期＝処理時間]やバイト[訳注：つまりメモリ容量]を抑えることができる。 もしこれを望むなら、あらゆる spirit ヘッダファイルをインクルードする前に、 単に BOOST_SPIRIT_SINGLE_GRAMAR_INSANCE を定義すればよい。

#define BOOST_SPIRIT_SINGLE_GRAMMAR_INSTANCE

一方で、もしマルチスレッド化されたコードで用いられると意図されている文法であるならば、 あらゆる spirit ヘッダーファイルをインクルードする前に BOOST_SPIRIT_THREADSAFE を 定義するべきである。この場合、 Boost.Threads もリンクする必要があるだろう。

#define BOOST_SPIRIT_THREADSAFE

Copyright © 1998-2003 Joel de Guzman

Permission to copy, use, modify, sell and distribute this document is granted provided this copyright notice appears in all copies. This document is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.

Japanese Translation Copyright © 2003 Kent.N

オリジナルの、及びこの著作権表示が全ての複製の中に現れる限り、この文書の複製、利用、変更、販売そして配布を認める。このドキュメントは「あるがまま」に提供されており、いかなる明示的、暗黙的保証も行わない。また、いかなる目的に対しても、その利用が適していることを関知しない。

このドキュメントの対象: Boost Version 1.30.0
最新版ドキュメント（英語）