マクロの構造

この章では、 XML マクロ・スクリプト内に見られるマクロの全般的な構造について説明します。

マクロ・スクリプト

マクロ・スクリプトは、マクロの保管に使用される XML スクリプトです。マクロ・スクリプトの XML テキストは、VME または基本マクロ・エディターの 「ソース」ビューを使用することによって表示および編集できます。

マクロ言語の XML エレメントについて少し学習すると、次のものを含めて、重要なトピックの理解がはるかに深まります。

このマニュアルでは、マクロ・エディターが提供する入力フィールド、 ボタン、およびリスト・ボックスだけでなく、同じ情報が保管されている 対応する XML エレメントも頻繁に言及します。

XML エレメント

マクロ・スクリプトを理解するには、XML について多くを学習する必要はありません。構文の基本だけで十分です。 XML 構文の知識を復習する必要がある場合は、Host On-Demand マクロ言語の XML 構文で詳しく学習できます。 しかし、必要な情報はほとんどすべて、このサブセクションに記載されています。

XML スクリプトは、XML エレメントの集合から構成されます。XML エレメントの一部には、他の XML エレメントが含まれています。これは、一部の HTML エレメントに他の HTML エレメントが含まれているのとほぼ同じです。しかし、HTML の場合と異なり、XML では、プログラム開発者が、保管したい情報の構造を表す新しい XML エレメントを定義できます。 Host On-Demand マクロ言語には、マクロの記述に必要な情報を保管するために、約 35 種類の XML エレメントがあります。 このマクロ言語については、Host On-Demand マクロ言語で詳しく説明しています。

XML マクロ・エレメント名は、不等号括弧によって囲まれています。例えば、<HAScript> エレメント、<screen> エレメントなどです。

図 2 は、XML エレメントの例を示しています。

図 2. サンプル XML エレメント
<SampleElement attribute1="value1" attribute2="value2">
...
</SampleElement>

図 2 に示されるエレメント <SampleElement>には、すべてのマクロ・エレメントのキー・コンポーネントが含まれています。最初の行は、開始タグです。開始タグは、左不等号括弧 (<) の後に、XML エレメントの名前 (SampleElement)、属性定義、右不等号括弧 (>) の順に続きます。2 行目は省略符号 (...) で構成されています。この省略記号は、XML 構文の一部ではありませんが、上の図では、<SampleElement> エレメント内部に他のエレメントが存在する可能性を示すために使用されています。3 行目は、終了タグです。 終了タグでは、エレメント名が不等号括弧で囲まれ、最初の不等号括弧の後にスラッシュが付きます (</Sample Element>)。

開始タグでは、属性を指定するのに、属性名 (例えば、attribute1) の後に、等号 (=)、引用符で囲まれた属性値 (例えば、"value1") の順に続きます。開始タグの内部には、任意の数の属性が存在する可能性があります。

マクロ・エレメントに他の XML エレメントが含まれていない場合、図 3 のように、省略形式で書き込むことができます。

図 3. 省略形式で書かれたサンプル XML エレメント
<SampleElement attribute1="value1" attribute2="value2"  />

図 3 では、<SampleElement> エレメントは左不等号括弧 (<) の後に、名前 (SampleElement)、属性、スラッシュ、右不等号括弧 (/>) の順に続けて書き込まれています。このように、XML エレメント全体が 1 対の不等号括弧内に書き込まれます。

マクロ・スクリプトの概念視点

Host On-Demand マクロ・スクリプトは、 最大 3 つのタイプのサブエレメントを含む 1 つの <HAScript> エレメントから構成されます。

図 4 は、サンプル・マクロ・スクリプトの概念視点を示しています。

図 4. マクロ・スクリプトの概念視点
マクロ・スクリプトの概念視点

図 4 は、主なタイプのサブエレメントのインスタンスが含まれている <HAScript> エレメントを示しています。これらのサブエレメントは、<import> エレメント (Import)、<vars> エレメント (Variables)、および 3 つの <screen> エレメント (Screen1、Screen2、および Screen3) です。

すべてのマクロ・スクリプトは、上記のような構造を持っています。ただし、大部分のマクロ・スクリプトには、もっと多くの screen があります。 上記のマクロで 50 個の screen がある場合、図 4 の外観はほぼ同じですが、Screen3 の後に、追加の screen (Screen4、Screen5 から、Screen50 まで) が続きます。ただし、screen が格納される順序は、必ずしも、マクロの実行時に screen が実行される順序を表しているわけではありません。 マクロ・ランタイムによるマクロ画面の処理方法を参照してください。

<HAScript> エレメントは、マクロ・スクリプトのマスター・エレメントです (HAScript は、Host Access Script を意味します)。 このエレメントは、マクロ全体を囲み、その開始タグには、マクロ全体に適用できる情報 (例えば、マクロの名前) を含む属性が入っています。 <HAScript> エレメントの例については、図 1 を参照してください。

<import> エレメントは、Java™ クラスのインポートに使用されるオプションです。Java クラスのインポートは、上級トピックであり、 変数とインポートした Java クラスで説明します。

<vars> エレメントは、標準データ・タイプ (boolean、integer、double、string、または field) のいずれかに属する変数を宣言し、初期化するのに使用されます。 標準変数の使用は、上級トピックであり、変数とインポートした Java クラスで説明します。

<screen> エレメントは、マクロ画面の定義に使用されます。 <screen> エレメントは、<HAScript> エレメント内にある最も重要な エレメントです。 図 4 で理解できるように、マクロ・スクリプトは、主に <screen> エレメント (例えば、図中の Screen1、 Screen2、および Screen3) から構成されます。 また、マクロ・スクリプト内のその他の種類の XML エレメントの大部分も、<screen> エレメント内で指定されます。

マクロ画面とそのサブコンポーネント

ここでは、マクロ画面とその主なサブコンポーネントについて説明します。 マクロ画面の定義は、別の条件である アプリケーション画面によって決まります。

アプリケーション画面

アプリケーション画面は、ホスト・アプリケーションによってホスト端末上に表示される、意味のある文字配置です。アプリケーション画面の一例は、図 5 に表示されている「OS/390® ISPF 基本オプション・メニュー (OS/390 ISPF Primary Option Menu)」です。

図 5. サンプル・アプリケーション画面 「OS/390 ISPF 基本オプション・メニュー (OS/390 ISPF Primary Option Menu)」
サンプル・アプリケーション画面 「OS/390 ISPF 基本オプション・メニュー (OS/390 ISPF Primary Option Menu)」

図 5 で、このアプリケーション画面には、 一番上の行にメニュー選択項目 (Menu、Utilities、Compilers、Options など)、上部付近にタイトル (OS/390 Primary Option Menu)、左側にオプションのリスト (0 から DAT)、およびオプション番号または文字を入力する入力フィールド (Option ===>) が表示されています。ユーザーが入力すると (例えば、3 (Utilities を表す) を入力した後、Enter キーを入力すると)、ISPF アプリケーションは、ホスト端末からこれらの表示項目をすべて除去し、別のアプリケーション画面を表示します。

マクロ画面

マクロ画面は、特定のアプリケーション画面へのアクセスを管理する方法をマクロ・ランタイムに指示する、1 組の命令です。 マクロ画面には、次のものが含まれています。

この時点での概念はそれほど直感的ではありませんが、同じマクロ内には、同じアプリケーション画面を参照するマクロ画面が数個存在する場合もあります。マクロ画面が相互にリンクされる方法によって、マクロ・ランタイムは、マクロの再生時に、同じアプリケーション画面に複数回アクセスして、アクセスごとに異なるマクロ画面を処理する場合があります。

また、1 つのマクロ画面が、複数のアプリケーション画面を参照する場合もあります。 複数のアプリケーション画面が互いに類似している場合、ユーザー自身で、類似したすべてのアプリケーション画面を処理するマクロ画面を作成することができます。

それにもかかわらず、各マクロ画面は、何らかのアプリケーション画面に対応します。 マクロを記録する際には、マクロ・オブジェクトは、記録中にユーザーがアクセスするアプリケーション画面ごとにマクロ画面を作成し、保管します。 同じアプリケーション画面に複数回アクセスする場合、マクロ・オブジェクトは、アクセスごとにマクロ画面を作成し、保管します。

記録されたマクロを再生する場合、マクロ・ランタイムは、一連の再生中にアクセスするアプリケーション画面ごとに 1 つ以上のマクロ画面を処理します。通常は、指定されたアプリケーション画面で 1 つのマクロ画面が実行されます。ただし、最初のマクロ画面のアクションによってアプリケーション画面が先に進まず、2 番目のマクロ画面が同じアプリケーション画面に一致するような方法で、マクロを編集することが可能です。

マクロ画面の概念視点

マクロ画面は、次の 3 つの必須サブエレメントを含む 1 つの <screen> エレメントから構成されます。

これらのサブエレメントは必須であり、それぞれ 1 つしか指定できません。

図 6 は、<screen> エレメントの概念視点を示しています。

図 6. <screen> エレメントの概念視点
<screen> エレメントの概念視点

図 6 は、3 つの必須サブエレメント (<description> エレメント (Description)、<actions> エレメント (Actions)、および <nextscreens> エレメント (Valid Next Screens)) を含む <screen> エレメント (Screen1) を示しています。

すべての <screen> エレメントは、これらの 3 つのサブエレメントを使用して上記のような構造を持っています。 (4 番目のオプションのサブエレメント <recolimit> エレメントについては、本書のこれ以降の部分で説明します。)

<screen> エレメントは、マクロ画面のマスター・エレメントです。 このエレメントには、その特定のマクロ画面に属している他のすべてのエレメントが含まれています。また、開始タグには、マクロ画面全体に適用できる情報 (例えば、マクロ画面の名前) が入っている属性も含まれています。

<description> エレメントには、<description> エレメントが属している <screen> エレメントが、特定のアプリケーション画面に関連していることを、マクロ・ランタイムが認識できるようにする記述子が含まれています。 この記述子と <description> エレメントについては、画面記述で説明しています。

<actions> エレメントには、マクロ・ランタイムがアプリケーション画面で実行する各種アクション (例えば、アプリケーション画面からのデータの読み取りや、キー・ストロークの入力) が含まれています。 これらのアクションと <actions> エレメントについては、マクロ・アクションで説明しています。

<nextscreens> エレメント (図 6 内の Valid Next Screens) には、現行のマクロ画面の後で表示される可能性があるすべての <screen> エレメントの画面名のリストが含まれています。 <nextscreens> エレメントと、そのエレメントの中に入っているエレメントについては、画面認識で説明しています。