2.1 パターン記述

TEBA は、パターン変換によるソースプログラムの書換え機能を提供しています。 パターン変換の記述は、 書換え前のパターン記述と書換え後のプログラム断片の2つで構成します。 入れ子になっている if 文を一つの if 文に合成するパターン変換の例を以下に示します。

%before

if (${cond1:EXPR}) {
  if (${cond2:EXPR}) {
    $[stmt: ${:STMT} $]+
  }
}

%after

if (${cond1} && ${cond2}) {
  $[stmt]$;
}

%end

書き換えたい箇所の記述である書換え前パターンを %before の直後に、 その記述をどう書き換えたいかを表す書換え後パターンを %after の直後に記述します。 一般的に、書き換えたい箇所が全く同じ記述であることは少なく、 異なる部分が含まれます。その異なる箇所を、「パターン変数」や「グループ」 を用いて、抽象化した形式で記述します。

2.2 パターン変数

パターン変数は、書換え前パターンと書換え後パターンで、 それぞれ以下のように記述します。

書換え前:	${名前:型} or ${:型}
書換え後:	${名前}

書換え前のパターン変数は型が一致する字句(列)に適合し、 その字句(列)を保持します。 書換え後は、書換え前の同じ名前を持つ変数の参照を表します。 なお、書換え前は名前を省略した変数を記述できますが、 名前がないので書換え後に参照することはできません。

パターン変数の型は、字句の種別か、ユーザが定義した型を書きます。 ユーザ定義の型は、定義ファイルの一つである TEBA/default-pt.rules で定義します。定義するときは、字句の並びに対する文字列の正規表現で記述します。

例として示した入れ子の if のパターンでは、${cond1:EXPR} が、 名前が cond1 という変数で、EXPR型なので構文要素である式に適合します。 また、${:STMT} は、名前のない変数でSTMT型の構文要素である文に適合します。

2.3 グループ

グループは、字句の並びをひとまとめに扱うための表現で、 以下のように記述します。

書換え前:	$[名前: …字句列… $]
書換え後:	$[名前]

書換え前は、ひとまとめに扱いたい範囲を $[名前: と $] で囲みます。 書換え後は、その名前で参照をします。パターン変数と同様に、 書換え前は、名前を省略できますが、書換え後に参照できません。 パターン変数と異なり、名前の後の : の後ろには型名を付けない点に注意してください。

書換え前のグループでは、「字句列の繰り返し」を、 以下のようにグループの最後に記号を付けて表現できます。

0または1回の繰り返し:	$[名前: …字句列… $]?
0回以上の繰り返し:	$[名前: …字句列… $]*
1回以上の繰り返し:	$[名前: …字句列… $]+

入れ子のif文例の場合、$[stmt: ${:STMT} $]+ のうち、 $[stmt: がグループの開始、$]+ がグループの終了を意味し、 名前が stmt で1回以上の繰り返しを表すグループを表現しています。 このグループは、1つの文を表わす ${:STMT} だけを含んでいるので、 1つ以上の文の並びに適合します。

2.4 仮想文区切り

グループには、型がないので、グループで参照している字句列が文なのか、 式なのかといった区別ができません。そのため、 グループを用いて文や宣言を参照する場合には、 明示的に文の区切り $; を指定する必要があります。 上記の例で、$[stmt] の直後に記述されています。 なお、グループが式を参照する場合には、指定する必要はありません。

直感的には、C言語で式文の終りに書くセミコロンと同じです。 ただし、セミコロンは “;” というテキストが存在するのに対し、 $; は空のテキストで、書換え後には何も残りません。 パターン記述を構文解析するときの補助的な役割です。

仮想文区切りは、必要であれば書換え前に記述することもできます。 ただし、STMT 型のパターン変数は文であることがわかっているので、 何も指定しなくてもその直後に仮想文区切りが自動的に挿入されます。

2.5 書換え方法

書換えにはコマンド rewrite.pl を使用します。 rewrite.pl は引数に指定されたパターン記述ファイルに従い字句系列を書き換えます。 例えば、最初のパターン記述を double-if.pt というファイルに書き込み、 iff.c というソースプログラムを書き換える場合には、以下のように実行します。

cparse.pl iff.c | rewrite.pl -p double-if.pt | join-token.pl

なお、書き換えた箇所を再帰的に書換えるには rewrite.pl に -r オプションを加えます。これにより、 if 文が3重になっているときも1つの if 文に集約されます。

3.1 複合文に適合する変数

前の節で示したパターン記述は、以下のように記述することもできます。

% before

if (${cond1:EXPR}) {
  if (${cond2:EXPR})
    ${stmt:STMT}
}

%after

if (${cond1} && ${cond2})
  ${stmt}

%end

最内の文の形が異なることに注意をしてください。すなわち、 書換え前において、内側の if 文が複合文(波括弧で囲まれた文)ではなく、 単体のパターン変数 ${stmt:STMT} になっています。 書換え後の方も、複合文ではなく、単体のパターン変数に変わっています。 パターン変数は型があり、${stmt}が文であることがわかるので、 仮想文区切りも記述していません。

if文は、else がない場合、構文上、次のような構成になっています。 すなわち、if 文は文を1つしか持つことができません。複数の文を直接持たせる方法はありません。

<if文> ::= 'if' '(' <式> ')' <文>

複数の文を持つ場合があるのではないかと思う人は誤解をしています。 複数の文を持たせたいときは、「複合文」という1つの文を持たせます。 複合文は、複数の文を持つことができる文ですが、それ自体では1つの文として扱います 構文上は次のような構成になっています。 なお、*は 0 個以上の繰り返しを意味します。

<複合文> ::= '{' <文>* '}'

入れ子のif文を変換するときに、if文が持つ文がどうなっているかは重要ではありません。 変換したあとに、それが残っていれば問題ありません。構文に従えば、 if文は1つの文しか持たないので、パターン記述中の次の部分は、if文が持つ文が式文であろうと、 複合文であろうと適合します。

  if (${cond2:EXPR})
    ${stmt:STMT}

最初のパターン記述では次のように書いていましたが、これは複合文を持つ場合にしか適合できません。 また、複合文は複数の文を持つので、グループを使って表現をしており、より複雑なパターンになっていました。

  if (${cond2:EXPR}) {
    $[stmt: ${:STMT} $]+
  }

このように、汎用性や可読性の観点では、if文が1つの文を持つと表現したパターンの方が望ましいことになります。 なお、教科書等で、「文」とは何かを確認するようにしましょう。 a = 1; を「代入文」と呼ぶ人がいますが、間違いです。 printf("hello\n"); を関数呼出し文と呼ぶ人がいるかもしれませんが、これも間違いです。 この両者とも「式文」です。正しい用語、正しい構文規則を理解していないと、適切にパターン記述を書くことができません。

3.2 波括弧の省略

この説明を読んで、「ならば、外側の if 文の波括弧を省略できないのか?」 と疑問を持った人がいれば、良いセンスの持ち主です。 もちろん省略はできます。ただし、その場合、波括弧がある場合に対応できなくなります。 では、絶対に不可能なのかというと、そうではありません。 発想を変えて、すべてを1つのパターンで記述するではなく、 複数のパターンで記述するようにすれば簡単に解決します。 最も簡単に思いつく方法は、波括弧がある場合とない場合のパターン記述を作り、 それぞれの書換えを適用するという方法です。 波括弧がない場合は以下のように書けばよいだけです。

% before

if (${cond1:EXPR})
  if (${cond2:EXPR})
    ${stmt:STMT}

%after

if (${cond1} && ${cond2})
  ${stmt}

%end

波括弧の有無が違う2つのパターンをそれぞれを double-if1.pt, double-if2.pt という名前のファイルに記述しているなら、次のようにパイプで接続すれば目的を達成します。

cparse.pl iff.c | rewrite.pl -p double-if1.pt | rewrite.pl -p double-if2.pt | join-token.pl

もうひとつ別の方法があります。良いプログラムの書き方として、 統一的なスタイルを用いるということがあります。 波括弧が存在するかどうかを気にするということは、書換えの対象となる プログラムが統一的なスタイルでは記述されていないということを示唆します。 したがって、入れ子の if 文で波括弧がついていない場合には、 波括弧を挿入するというパターン(あるいはその逆をするパターン)を記述して、 まずそのパターンを適用するという方法があります。 こちらの方法の方が、問題の本質を見極めていることや、 スタイルの統一は再利用性の高い作業なので、 より綺麗な方法と言えるでしょう。