ステップ 1 検出

対象となるソースファイルが格納されているディレクトリを、ここでは c:\targetsrc とします。 （後からVaci plug-inを使ってEclipseで結果をブラウズする場合には、対象としてEclipseのプロジェクトのルートディレクトリ、すなわち、 .project というファイルが格納されているディレクトリを指定してください。） また、ソースコードはプログラミング言語Javaで記述されているとします(もしC/C++なら、以下の説明でjavaとある部分をcppに置き換えてください）。

コマンドラインで以下のようにvacicmdを実行してください。:

c:\>pushd c:\targetsrc
c:\targetsrc>vacicmd c java .

解析が正常に終了すると、 _transclasses.txt というファイルが生成されます。 テキストファイルなので、 more コマンドやエディタで中身を確認することができます:

c:\targetsrc>more _tralsclass.txt

ステップ 2 ブラウズ

このステップでは、読み替えクラスをEclipseによってブラウズする方法を示します。

あらかじめ、 c:\targetsrc のプロジェクトをEclipseにインポートしておいてください。

Eclipseのツールバーの[Vaci search]というボタンを押すと、ダイアログが現れます。

このダイアログでは読み替えクラスを表示する際のオプションを指定することができます。 デフォルトで、名前の揺れを表す可能性が高いと思われる3つのタイプが(チェックマークにより)選択されています。

このダイアログの[OK]ボタンを押すと、[Vaci View]というウィンドウの内容が更新されます。

Vaciビューには、読み替えクラスがツリーとして表示されます。

• ツリーのルートノード(アイコン )はEclipseのプロジェクトのルートディレクトリを表します。
• 次のレベルのノードは読み替えクラスです。付加されているアイコン( など)は、読み替えクラスのタイプを表します。 それぞれのタイプの詳細については、 読み替えクラスのタイプの説明 を参照してください。
• その次のレベルのノード(アイコン )は、それぞれの読み替えクラスに含まれる識別子です。
• 一番深いレベルのノード(アイコン )は、識別子の出現位置を表します。

一番深いレベルのノードをダブルクリックすると、ソースコード上でその識別子が現れている部分がテキストエディタに表示されます。

ステップ 3 テキストエディタで読む

このステップでは、読み替えクラスをテキストエディタで読む方法を説明します。 （出力結果を加工するためのツールを作る際などの参考にしてください。）

読み替えクラスのファイル( _tralsclasses.txt )はtype: ...という行で始まり、空白行で終了するセクションの並びです。 1つのセクションが、1つの読み替えクラスを表します。 以下に、セクションの例を挙げます。:

type: minority
id|cf.endPos
      h:\kamiya\prog\smith2008\GemX\model\layeredgroup\CodeFragment.java:49
id|cf.beginPos
      h:\kamiya\prog\smith2008\GemX\model\layeredgroup\CodeFragment.java:46
--
id|right.end
      h:\kamiya\prog\smith2008\GemX\model\CodeFragment.java:29
id|right.begin
      h:\kamiya\prog\smith2008\GemX\model\CodeFragment.java:25
id|right.leftEnd
      h:\kamiya\prog\smith2008\GemX\model\ClonePair.java:54
id|right.rightEnd
      h:\kamiya\prog\smith2008\GemX\model\ClonePair.java:62
id|right.leftBegin
      h:\kamiya\prog\smith2008\GemX\model\ClonePair.java:50
id|right.rightFile
      h:\kamiya\prog\smith2008\GemX\model\ClonePair.java:46
id|right.rightBegin
      h:\kamiya\prog\smith2008\GemX\model\ClonePair.java:58

1行目は、読み替えクラスのタイプ（含まれる名前に一定の命名規則があったか 、その場合はどんな規則か。`読み替えクラスのタイプの説明`_ を参照）を表しています。 それ以降の行のうち、「id|...」という行は識別子を表します。タブで始まる行はその識別子が現れる場所を、 ファイル名と行番号によって示します。

さらに、その読み替えクラスのタイプが「少数派を含む」である場合(上の例の場合)には、セクションは「--」という行によって2つのパートに分けられます。 最初のパートには、少数派とみなされた識別子が並べられます。2つめのパートには、多数派とみなされた名前が並びます。

ステップ 1 検出

対象となる旧バージョンと新バージョンのソースコードが格納されているディレクトリを、ここではそれぞれ c:\oldver 、 c:\newver とします。 解析結果のファイルをディレクトリ c:\analysis に生成することにします。 ソースコードはプログラミング言語Javaで記述されているものとします。

コマンドラインで以下のようにvacicmdを実行してください。:

c:\>pushd c:\analsys
c:\analsys>vacicmd m java c:\oldver c:\newver

解析が正常に終了すると、 _transmaps.txt というファイルが生成されます。:

c:\analsys>more _transmaps.txt

ステップ 2 ブラウズ

このステップでは、読み替えマップからHTMLファイルを生成してブラウズする方法を説明します。

コマンドラインで以下のように、visualizetransmapを実行してください。 ここでは、 browse というサブディレクトリを作って、その中に生成されたHTMLファイルが格納することとします。:

c:\analysis>visualizetransmap _transmaps.txt -p browse

生成されたindex.htmlをWebブラウザで開くと、次のような画面が表示されます。

左側のペインには、順に、サマリ(summary)、タイプ1to1、タイプ1toN、タイプNto1、タイプMtoNの見出しがあります。 サマリは検出された読み替えマップの数を、タイプ別に集計したものです（初期状態では右側のペインにサマリの内容が表示されています）。 それぞれのタイプの見出しの下には、そのタイプに属する読み替えクラスの通し番号(#数字)が並んでいます。 クリックすると、その読み替えクラスの内容が、右側のペインに表示されます。

右側のペインには、サマリの内容か、あるいは、左側のペインで選択した読み替えクラスの内容が表示されています。 ある読み替えクラスの内容を表示させた状態の画面を次に示します。

順に、読み替えクラスの通し番号、グラフ(Graph)、グラフの辺(Edges)の見出しがあります。

グラフの見出しの下に、その読み替えクラスをグラフとして表現したものが表示されます（SVGをサポートしていないブラウザではうまく表示されません）。 グラフの頂点（四角）は識別子を表します。旧バージョンの識別子がグラフの左側に並びます。新バージョンの識別子はグラフの右側に並びます。 グラフの辺のうち実線のものは、識別子の対応を表します。すなわち、辺の両端の識別子はコンテキストを共有しています。 グラフの辺のうち点線のものは、同じ名前を意味します。すなわち、辺の両端の識別子は旧バージョンと新バージョンで同じ名前になっています。

グラフの辺(Edges)の見出しの下に、グラフに含まれているそれぞれの辺について、その辺が意味する識別子の対応関係のコンテキストが、 ソースコード中に現れている場所が示されます。

ステップ 3 テキストエディタで読む

このステップでは、読み替えマップ( _transmap.txt )をテキストエディタで読む方法を説明します。 （出力結果を加工するためのツールを作る際などの参考にしてください。）

読み替えマップのファイルはtype: ...という行で始まり、空白行で終了するセクションの並びです。

1つのセクションが、1つの読み替えマップを表します。以下に、セクションの例を挙げます。:

type: MtoN
id|addPreprocessorItem        id|addPreprocessScript
      c:\analysis\10.1.9\GemX\gemx\MainWindow.java:890        c:\analysis\10.2.3.5\GemX\gemx\MainWindow.java:577
id|add        id|addPreprocessorItem
      c:\analysis\10.1.9\GemX\gemx\MainWindow.java:470        c:\analysis\10.2.3.5\GemX\gemx\MainWindow.java:1040
id|add        id|addPreprocessScript
      c:\analysis\10.1.9\GemX\gemx\MainWindow.java:470        c:\analysis\10.2.3.5\GemX\gemx\MainWindow.java:577

1行目は、読み替えマップのタイプ（ 読み替えマップのタイプの説明 を参照）を示します。 それ以降の行のうち、「id|...」という行は新旧の識別子を表します。 行はタブで区切られていて、タブの前が旧バージョンの識別子、後ろが新バージョンの識別子です。 タブで始まる行はそれら新旧の識別子が現れる場所を、ファイル名と行番号によって示します。 その行に現れる2つめのタブの前が旧バージョンでの出現場所、後ろが新バージョンでの出現場所です。