マクロ言語の機能

この章では、Host On-Demand マクロ言語の構文、 編集、階層、コメント、およびデバッグ機能について 説明します。

構文と編集

Host On-Demand マクロ言語の XML 構文

Host On-Demand マクロは、Host On-Demand マクロ言語の XML エレメントを 使用して XML スクリプトに保管されます。ここでは XML のいくつかの規則について説明し、Host On-Demand マクロ言語 の例を示します。

ソース表示編集

マクロ・スクリプトの XML テキストは、ソース表示で直接編集できます。

ソース表示とシステム・クリップボードの間で、テキストのカット・アンド・ペーストを行うことができます。この機能は、ソース表示と他の XML エディター (またはテキスト・エディター) との間でのテキストの転送を可能にするものなので、非常に重要です。

エレメントの階層

図 82 は、HATS で サポートされる Host On-Demand マクロ言語の XML エレメントすべての開始タグをリストします。このリストは、XML 構文の観点から見て有効なものではなく、 同じタイプのエレメントを複数指定できる個所を示していません。 ただしこのリストでは、他の XML エレメント内で指定できる XML エレメントを インデントによって示しています。例えば、リストの最初にあるエレメント (<HAScript> エレメント) は まったくインデントされていません。これは、このエレメントがマスター・エレメントであり、 他のエレメントをすべて含むことを示しています。 2 番目のエレメント (<import> エレメント) は、<HAScript> エレメントの 内側にあり、<type> エレメントなどを含みます。

図 82. HATS でサポートされる Host On-Demand マクロ言語のエレメントの階層
<HAScript>                 スクリプト内の他のエレメントをすべて囲みます。
   <import>                <type> エレメントのコンテナー。
      <type>               インポートしたデータ・タイプ (Java クラス) を宣言します。
   <vars>                  <create> エレメントのコンテナー。
      <create>             変数を作成し、初期化します。
   <screen>                1 つのマクロ画面に関する情報を含む画面エレメント。
      <description>        記述子のコンテナー。
         <attrib>          特定のフィールド属性を記述します。
         <cursor>          カーソルの位置を記述します。
         <customreco>      カスタム認識エレメントを参照します。
         <numfields>       画面内のフィールドの数を記述します。
         <numinputfields>  画面内の入力フィールドの数を記述します。
         <string>          画面の文字ストリングを記述します。
         <varupdate>       変数に値を割り当てます。
      <actions>            アクションのコンテナー。
         <commwait>        指定の通信状況が発生するまで待ちます。
         <custom>          カスタム・アクションを呼び出します。
         <extract>         ホスト・アプリケーション画面からデータをコピーします。
         <else>            else 条件を挿入できます。
         <if>              if 条件を挿入できます。
         <input>           ホスト・アプリケーションにキー・ストロークを送ります。
         <mouseclick>      マウス・クリックをシミュレートします。
         <pause>           指定の時間だけ待ちます。
         <perform>         ユーザー提供の Java メソッドを呼び出します。
         <playmacro>       別のマクロを呼び出します。
         <prompt>          ユーザーにプロンプトを出して情報の入力を促します。
         <trace>           トレース・レコードを書き出します。
         <sqlquery>        SQL ステートメントをホスト・データベースに送信し、データ
                           を検索して、そのデータを書き込むか、または表示します。
         <varupdate>       変数に値を割り当てます。
      <nextscreens>        <nextscreen> エレメントのコンテナー。
         <nextscreen>      有効な次のマクロ画面の名前を指定します。
      <recolimit>          認識限界に達した場合にアクションを行います。

エレメントの階層と、対応するマクロ・スクリプトの構造については、 本書のさまざまな個所で説明しています。 特に、次のセクションを参照してください。

個々のエレメントの説明については、マクロ言語エレメントを参照してください。

マクロ・スクリプトへのコメントの挿入

XML スタイルのコメント・ブラケット <!-- --> を 使用してコメントのテキストを囲むことにより、<HAScript> エレメント内の 任意の個所にコメントを挿入できます。

コメントは、次の用途に便利です。

コメント・エラー

ソース表示は、次の状況が発生するとエラー・メッセージを表示します。

また、<HAScript> エレメントの外側でブラケット <!-- --> を 使用することはできません。 このようにした場合、ソース表示は、スクリプトを保存する際にこれらの コメント・ブラケットとその内側のテキストを 破棄します。

コメントの例

以下に、コメント・ブラケット <!-- --> を使用して コメントを挿入する例をいくつか示します。

<!--
A multi-line comment that comments on
the following <screen> element
-->
<screen name="Screen1" entryscreen="true" exitscreen="false" transient="false">

<!-- A comment on the following <description> element -->
<description>
   <oia status="NOTINHIBITED" optional="false" invertmatch="false" />
</description>

<!-- A comment on the following <actions> element -->
<actions>
   <mouseclick row="4" col="16" />
   <input value="3[enter]" row="0" col="0" movecursor="true"
             xlatehostkeys="true" />
</actions>
<!--
BEGIN
An accidental comment that surrounds part of
a <nextscreens> element,  thereby corrupting
the macro script.
You will get an error when you try to save
this macro script
<nextscreens timeout="0" >
   <nextscreen name="Screen2" />
END of accidental comment
-->
</nextscreens>
</screen>

<trace> エレメントを使用したマクロ・スクリプトのデバッグ

デバッグの際に <trace> エレメントを使用して、 テキストと値をトレース出力先に送ることができます。 特に、出力に変数の名前を組み込むと、マクロ・ランタイムは 変数の名前と値の両方を中括弧 {} で囲んで出力に表示します。 次に例を示します。

図 83. <trace> エレメントの使用例
<vars>
<create name="$var1$" type="string" value="'original'" />
</vars>
.
.
<actions>
<trace type="SYSOUT" value="'Before update: '+$var1$" />
<varupdate name="$var1$" value="'updated'" />
<trace type="SYSOUT" value="'After update: '+$var1$" />
</actions>

上記の図のコードは、次のテキストをコンソールに出力します。

図 84. <trace> エレメントの使用例の出力
Before update: +{$var1$ = original}
After update: +{$var1$ = updated}

<trace> アクションでは各変数が中括弧 {} で囲まれて表示され、括弧内には変数名と変数の内容が含まれています。