All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class epp.Tree

java.lang.Object
   |
   +----epp.Tree

public class Tree

extends Object

implements Cloneable, Serializable

例えば、 if 文は EPP の内部では (if condition then else ) という抽象構文木で表現されます。 このノードは、 new Tree(:if, condition, then, else) というインスタンス生成式で生成することができます。 ノードの種類を表す部分(この場合は :if)を tag 、 ノードのすべて subtree (この場合は condition, then, else)を args と呼びます。

Tree は immutable object です。 tag や args を変更することはできません。 （プログラマーは、メソッド呼び出し tree.args() が返す Tree の配列の中身を うっかり書き換えないように注意する必要があります。 万一書き換えてしまうと、非常に見つけにくいバグの原因になります。）

Tree のサブクラスに、 Identifier と LiteralTree があります。 すべての抽象構文木のノードは、 Tree, Identifier, LiteralTree の３つのいずれかで 表現されます。 plug-in は、構文を拡張して新たな種類のノードを導入できますが、 その場合でもノードを３つのクラスのいずれかで表現しなければなりません。

クラス Tree のインスタンス tree に対して tree.print() という メソッド呼び出しをすることで、抽象構文木をＳ式の形で 出力することができます。 例えば、

	if (x == 0) System.out.println("Hello!");

      (if
       (==
        (id x)
        (literalTree int "0"))
       (expressionStatement
        (invokeLong
         (name
          (id System)
          (id out))
         (id println)
         (argumentList
          (literalTree string "Hello!"))))
       (emptyStatement))

LiteralTree と Identifier に関しては、 tree.args() は 常に長さ０の配列を返します。 このような仕掛けになっているため、 tree に対する再帰的処理は 非常に簡単になります。例えば、 tree の中に if 文が現れる数を数える メソッドは、

int countIf(Tree tree){
  int c = 0;
  if (tree.tag() == :if) c++;
  Tree[] args = tree.args();
  for (int i = 0; i < args.length; i++){
    c += countIf(args[i]);
  }
  return c;
}

クラス Tree は、 tag と args の他にも行番号情報などの付加情報を 持っています。 これらの情報を保存したまま、 args の値だけを変更した tree を 生成したい時には、 "modifyArgs" というメソッドを使います。

	Tree[] newArgs = {...};
	Tree newTree = tree.modifyArgs(newArgs);

	Tree[] newArgs = {...};
	Tree newTree = new Tree(tree.tag(), newArgs);

大きい Tree を生成するコードを簡単に書くために、 BackQuote plug-in が提供されています。 詳しくは、../BackQuote.html を見て下さい。 tree.print() あるいは epp の -tree オプションによって出力された抽象構文木は、 カットアンドペーストして、 BackQuote マクロにそのまま使うことができます。

Tree の可変長配列を使うことがよくあるので、クラス TreeVec が用意されています。 キャストが不要なので java.lang.Vector より便利です。

See Also:

Identifier, LiteralTree, TreeVec

Tree(Symbol)

Tree(Symbol, Tree)

Tree(Symbol, Tree, Tree)

Tree(Symbol, Tree, Tree, Tree)

Tree(Symbol, Tree, Tree, Tree, Tree)

Tree(Symbol, Tree, Tree, Tree, Tree, Tree)

Tree(Symbol, Tree, Tree, Tree, Tree, Tree, Tree)

Tree(Symbol, Tree, Tree, Tree, Tree, Tree, Tree, Tree)

Tree(Symbol, Tree[])

Tree(Symbol, TreeVec)

args()

抽象構文木の subtree を取り出します。

beginningPoint()

このノードの開始位置の point を返します。.

endPoint()

このノードの終了位置の point を返します。.

idName()

このノードが Identifier ならば、その名前を返します。.

isTyped()

このメソッドが型情報を持っていれば true 、そうでなければ false を 返します。

lineNumber()

このノードの行番号情報を返します。.

literalToken()

このノードが LiteralTree ならば、その中身を表す LiteralToken を返します。.

main(String[])

テスト用のメソッドです。

modifyArgs(Tree[])

このノードの args のみを変更した Tree を作って返します。.

modifyBeginningPoint(int)

modifyEndPoint(int)

modifyLineNumber(int)

modifyProperty(Symbol, Object)

このノードのプロパティを変更した Tree を作って返します。.

modifyTypeAndArgs(Type, Tree[])

このノードの type と args のみを変更した Tree を作って返します。.

nameEqual(Tree, Tree)

:name をタグに持つ Tree 同士を比較します。.

nameToString()

:name をタグに持つ Tree を文字列に変換します。.

print()

Opts.out に、人間に見やすいように中身を出力するデバッグ用メソッドです。.

print(PrintWriter)

print(PrintWriter, String)

printProp(PrintWriter)

property(Symbol)

ノードに付けられたプロパティを検索して返します。.

quoteString(String)

This method is called by class Identifier and LiteralToken.

resetType()

型情報を持たない Tree を作って返します。.

stringToNameTree(String)

tag()

抽象構文木の種類を表す tag を取り出します。

toString()

Convert tree to String without indentation.

type()

このノードの型を返します。.

 public Tree(Symbol tag,
             Tree args[])

 public Tree(Symbol tag,
             TreeVec args)

 public Tree(Symbol t)

 public Tree(Symbol t,
             Tree a1)

 public Tree(Symbol t,
             Tree a1,
             Tree a2)

 public Tree(Symbol t,
             Tree a1,
             Tree a2,
             Tree a3)

 public Tree(Symbol t,
             Tree a1,
             Tree a2,
             Tree a3,
             Tree a4)

 public Tree(Symbol t,
             Tree a1,
             Tree a2,
             Tree a3,
             Tree a4,
             Tree a5)

 public Tree(Symbol t,
             Tree a1,
             Tree a2,
             Tree a3,
             Tree a4,
             Tree a5,
             Tree a6)

 public Tree(Symbol t,
             Tree a1,
             Tree a2,
             Tree a3,
             Tree a4,
             Tree a5,
             Tree a6,
             Tree a7)

 public static void main(String argv[])

テスト用のメソッドです。

 public Symbol tag()

抽象構文木の種類を表す tag を取り出します。

 public Tree[] args()

抽象構文木の subtree を取り出します。

 public int lineNumber()

このノードの行番号情報を返します。. 行番号情報は、このノードを表現していた構文の先頭の行番号です。 構文解析パスではなく マクロ展開パスで生成されるノードには、行番号情報はありません。 行番号情報がない場合は -1 を返します。

 public int beginningPoint()

このノードの開始位置の point を返します。. このメソッドは、まだ実装されていません。

See Also:

EppInputStream

 public int endPoint()

このノードの終了位置の point を返します。. このメソッドは、まだ実装されていません。

See Also:

EppInputStream

 public Type type()

このノードの型を返します。. 型が未決定の場合は fatal error になります。

 public Object property(Symbol key)

ノードに付けられたプロパティを検索して返します。.

See Also:

modifyProperty

 public Symbol idName()

このノードが Identifier ならば、その名前を返します。. そうでなければ、 fatal error です。

 public LiteralToken literalToken()

このノードが LiteralTree ならば、その中身を表す LiteralToken を返します。. そうでなければ、 fatal error です。

 public Tree modifyArgs(Tree args[])

このノードの args のみを変更した Tree を作って返します。. 行番号情報など、 args 以外の全ての情報は新たな Tree にコピーされます。

 public boolean isTyped()

このメソッドが型情報を持っていれば true 、そうでなければ false を 返します。

 public Tree modifyTypeAndArgs(Type type,
                               Tree args[])

このノードの type と args のみを変更した Tree を作って返します。. 行番号情報など、他の全ての情報は新たな Tree にコピーされます。 この Tree がすでに型情報を持っている場合は fatal error になります。

 public Tree resetType()

型情報を持たない Tree を作って返します。. 型情報以外の全ての情報は、もとの Tree から新たな Tree にコピーされます。

 public Tree modifyProperty(Symbol key,
                            Object val)

このノードのプロパティを変更した Tree を作って返します。. 付加情報以外の全ての情報は、 もとの Tree から新たな Tree にコピーされます。

See Also:

property

 public Tree modifyLineNumber(int x)

 public Tree modifyBeginningPoint(int x)

 public Tree modifyEndPoint(int x)

 public static boolean nameEqual(Tree name1,
                                 Tree name2)

:name をタグに持つ Tree 同士を比較します。.

 public String nameToString()

:name をタグに持つ Tree を文字列に変換します。. 例えば、 (name (id a) (id b) (id c)) は "a.b.c" になります。

 public Tree print()

Opts.out に、人間に見やすいように中身を出力するデバッグ用メソッドです。. tree.print() と書けば、 tree が、人間に見やすいようにインデントされて 出力されます。 このメソッドは返値として、自分自身を返します。

epp コマンドの起動時のオプションに応じて、 型情報、行番号情報も同時に出力されます。

これらの情報がついていない場合は、 出力結果をカットアンドペーストして、そのまま BackQuote macro の一部として 使うことができます。

 public Tree print(PrintWriter out)

 public void print(PrintWriter out,
                   String indent)

 public void printProp(PrintWriter out)

 public String toString()

Convert tree to String without indentation.

Overrides:

toString in class Object

 public static String quoteString(String in)

This method is called by class Identifier and LiteralToken.

   Examples:
  	"foo" -> "¥"foo¥""
  	"¥n" -> "¥"¥¥n¥""
  	"¥"" => "¥"¥¥¥"¥""

 public static Tree stringToNameTree(String str)

All Packages  Class Hierarchy  This Package  Previous  Next  Index