10.3 Flex変数およびFlex関数の要約

Flexに対する主要なCインターフェイスは、 以下のルーチンおよび変数を通じて実現されます。 個々のルーチン、変数に関する完全な説明については、 See Interfacing to Flex。

yylex()

主要なインターフェイスです。 これが実際のスキャン処理を行う関数です。




yyin

yylex()が文字を読み込む元となるファイルです。 このデフォルトはstdinです。




yyout

スキャナの出力ファイルです。 デフォルトはstdoutです。




yytext

最後にマッチした文字列を保持する大域変数です。 つまり、 最後に認識されたトークンを保持しています。




yyleng

最後に認識されたトークンの長さを保持する大域変数です。




yywrap()

この関数は、 yyinの終端に達した時に呼び出されます。 これがTRUE（ゼロ以外）を返すとスキャナは実行を終了しますが、 FALSE（ゼロ）を返すと、 yyinが次の入力ファイルを指すよう設定されたものと想定し、 スキャン処理は継続されます。




yymore()

次に認識されるトークンでyytextの内容を上書きするのではなく、 そのトークンをyytextの末尾に付加するようFlexに通知する関数です。




yyless(n)

yymore()とほぼ反対のことを行います。 この関数は、 最初のn文字を除くすべての文字を戻します。 戻された文字の並びは、 次のトークンをマッチするのに使われます。 yylengとyytextの内容には、 この変更が反映されます。




input()

入力から次の１文字を返します。 これは、 標準のFlex記述言語や特にLex記述言語を使ったのではうまく処理できないようなスキャナにおいて、 よく使われます。




unput(c)

この関数は、 文字cを入力ストリームに戻します。 この後、 この文字は次にスキャンされる文字になります。




yyterminate()

この関数は、 アクションの中で使われると、 スキャナ（yylex()）の実行を終了させます。 終了したスキャナは0を返します。 この後yyrestart()が呼び出されない間は、 yylex()を呼び出してもすぐに復帰してしまいます。




yyrestart(file)

この関数は、 スキャナの実行を再開するようFlexに通知します。 これは、 スキャンすべきファイル（通常はyyin）を表す引数を１つ取ります。 EOFを処理するのに使うことができますし、 また、 Flexに割り込みをかけ、 その後で再開始することを可能にするために使うこともできます。 （Flexが再入可能ではないので、 このようなことが必要になります。）




ECHO

yytextの内容をyyoutにコピーするマクロです。


REJECT

カレントなトークンを認識しないで、 次に最もよくマッチするものを選択するよう、 スキャナに通知します。 スキャナは、 マッチするもののうち最も長いものを探します。 マッチするものが２つあってその長さが同じ場合には、 スキャナ記述の中で最初に定義されているものを選択します。




BEGIN(state)

スキャナをある特定のスタート状態に置くために使われます。 BEGINの後ろの名前は、 スタート状態の名前です。 これは、 スキャナ記述の先頭の定義セクションにおいて宣言されているものでなければなりません。




YY_USER_INIT

スキャナが初期化される前に実行されるべきアクションを定義します。 詳細については、 Flex and Cを参照してください。




YY_USER_ACTION

マッチが発生した後で、 ルール・セクションに定義されたアクションが実行される前に、 実行されるべきアクションを定義します。 例えば、 yytextの内容を小文字から大文字へ変換する等を行うのに使うことができます。 デフォルトのルールでは何も実行されません。 詳細については、 Flex and Cを参照してください。




YY_BREAK

実際にはインターフェイス機能ではなく、 むしろ生成されるコードを変更するために使うことができるものです。

スキャナの中では、 すべてのアクションは１つの大きなswitch文の構成要素であり、 個々のアクションの区切りは、 デフォルトで`break;'文に変換されるYY_BREAKで与えられます。 もし、 ほとんどのルールのアクション部が`return;'文を含んでいると、 コンパイラは`statement not reached'というエラーをたくさん表示することになるでしょう （表示するはずです）。 YY_BREAKを再定義することによって、 この警告メッセージを表示させないようにすることが可能です。

注：YY_BREAKを再定義する場合は、 アクションが必ず`return;'か`break;'で終わるようにしてください。




YY_DECL

スキャン処理を実行する関数の名前を定義するマクロです。 デフォルトはyylexですが、 再定義することができます。 再定義した名前は、 関数のプロトタイプとして正当なものでなければなりません。




YY_INPUT

入力ルーチンの名前を定義するマクロです。 必要があれば、 この名前は再定義することができます。 例えば、 文字列や、 標準的ではない何らかの入力デバイスを入力として、 スキャン処理を行う場合に役に立ちます。




YY_NEW_FILE

yyinが新しいファイルを指すよう設定されたこと、 および、 処理が継続されるべきであることをFlexに通知するマクロです。¹


YY_CURRENT_BUFFER

カレントな入力バッファを返すマクロです。


yy_create_buffer()

新しい入力バッファを作成するのに使われます。 この関数と、 この後の２つの関数を使うことにより、 複数のバッファを作成し、 バッファ間で切り替えることが可能になります。 See バッファを操作する関数。


yy_delete_buffer()

以前に作成された入力バッファを削除するのに使われます。




yy_switch_to_buffer()

複数の入力バッファの間で切り替えを行うのに使われます。




YY_BUFFER_STATE

バッファを処理するのに使われる型です。 バッファのカレントなコンテキストを保持します。 複数のバッファ間で切り替えを行う時には、 この型の変数が必要になります。




YYSTYPE

Bisonファイル中の%unionの型です。 これは、 FlexとBisonの間のインターフェイスで使われます。




yylval

Bisonパーサのカレントなパース状態に関連するデータを保持する、 Bisonパーサ中の変数です。 この変数を使うことで、 データをFlexとBisonの間で渡すことができます。