サンプル：Dialog System ダイアログに代わる Windows Forms

Customer + .NET WinForm サンプルの CustomerWinForm.sln は、Dialog System の元の Customer サンプルを取得し、Orders ダイアログをより最新式の Windows Forms Orders フォームに置き換えます。メインの Customer アプリケーションはほとんど未変更のままであるため、アプリケーションはネイティブコードのメインプログラムになり、マネージコードを COM オブジェクトとして呼び出して Windows Forms Orders フォームを処理します。

次の図の左側には、ネイティブコードと、スクリーンセットを処理する Dialog System があります。マネージコードは、新しい Windows Forms フォームとともに右側にあります。この図は、マネージコードを含んだ COM 呼び出し可能ラッパ (COM Callable Wrapper; CCW) のインターフェースとなるネイティブコード、および渡されて返されるデータブロックも示しています。

上図の数字は、プロセス内の重要なポイントを示しています。次では、これらの重要なポイントについて説明します。

ネイティブ COBOL アプリケーションは、従来の方法で Dialog System を呼び出します。
新しい余分なダイアログを呼び出す代わりに、ダイアログは RETC を使用して制御をアプリケーションに返します。
ネイティブ COBOL は、標準のネイティブ OO COBOL 構文を使用して IFormsFactory マネージコードインターフェイスを起動します。
データブロックのコピーは、使用するマネージクラス用に作成されます。

エントリポイントはネイティブコードで作成され、マネージコードからコールバックできる状態になります。
マネージコードライブラリの OrderFormsLibrary は、COM 相互運用のために登録されます。これにより、COM 呼び出し可能ラッパ (COM Callable Wrapper; CCW) が確実に作成されます。COM 呼び出し可能ラッパは、使用するネイティブコードのインターフェースを提供します。
マネージコードクラスの FormsFactory は、フォームをモーダルダイアログとしてインスタンス化して表示し、必要に応じてイベントを処理します。
マネージコードは、以前にネイティブ COBOL で作成されたエントリポイントにコールバックし、更新されたデータブロックへのポインターを渡します。

ネイティブ COBOL での Customer プロジェクト

ソリューションには、ネイティブプロジェクトとマネージプロジェクトという 2 つのプロジェクトがあります。ネイティブプロジェクトの Customer には、元のソースのほかに、別の方法で Orders ダイアログを処理するための変更、およびマネージコードプロジェクトと対話するための変更が含まれています。

Customer ネイティブプロジェクトの内容は次のとおりです。

プロパティ - これらのプロパティは、プロジェクトのビルド方法を定義します。例えば、プロジェクトは Customer という Windows アプリケーションとしてビルドされ、.\bin\x86\Debug に格納されます。
Customer.cbl - 元のソースコードと、新しい Windows Forms Orders フォームを処理するマネージ COBOL プロジェクトと対話するための追加コード。
Customer.cpb - Dialog System データブロックから生成された元の未変更のコピーブック。
Customer.gs - 元のスクリーンセット。現在、このスクリーンセットは、Orders ダイアログの表示ではなく customer.cbl に制御を返すことによって Orders ボタンを処理します。
Cust.ism - 変更されていない元のデータファイル。

ネイティブプロジェクトをデバッグするには、Customer プロジェクトがスタートアッププロジェクトとして設定されていることを確認します。これを行うには、プロジェクトを右クリックして [Set as StartUp Project] をクリックします。

マネージ COBOL での OrderFormsLibrary プロジェクト

マネージプロジェクトの OrderFormsLibrary には、新しい Windows Forms Orders フォームが含まれています。また、マネージコードとネイティブコード間で顧客データブロックを渡すためのサポートコードも含まれています。このマネージプロジェクトは、COM オブジェクトとして登録および公開されます。

OrderFormsLibrary マネージプロジェクトの内容は次のとおりです。

プロパティ - これらのプロパティは、プロジェクトのビルド方法を定義します。プロジェクトは COM オブジェクトとして登録されることに注意してください。その結果、プロジェクトは COM オブジェクトとして公開され、ネイティブプロジェクトはそのプロジェクトにアクセスできるようになります。[Project > Properties > COBOL > Advanced] を参照してください。
リファレンス - 必要なすべての .NET クラス。
Calendar.cbl - データグリッドで使用するカレンダエディター列を実装します。
Customer.cpb へのリンク - ネイティブ COBOL プロジェクトとマネージ COBOL プロジェクトでは、同じコピーブックが使用および認識されます。コピーブック自体はネイティブプロジェクト内に残り、そのコピーブックへのリンクがマネージプロジェクト内に追加されます。
FormsFactory.cbl - CreateOrderForm() メソッドを実装し、コールバック関数のデリゲートを作成します。このデリゲートは、顧客データブロックを確保するために使用されます。
IFormsFactory.cbl - CreateOrderForm() メソッドを定義します。このメソッドは、ネイティブコードからマネージコードへのエントリポイントを提供します。
OrderForm.cbl [Design] - これは、デザイナで描画されるオーダーフォームです。
OrderForm.cbl [Code] - これにはフォームを処理するコードが含まれています。ユーザーは、これを編集して独自のコードを追加できます。

マネージプロジェクトをデバッグするには、OrderFormsLibrary プロジェクトがスタートアッププロジェクトとして設定されていることを確認します。

ネイティブ COBOL での Customer.cbl

Customer.cbl には、ビジネスロジック用および Dialog System スクリーンセットとの対話用の元のコードが含まれています。Customer.cbl には、マネージ COBOL プロジェクトと対話するための追加コードと Windows Forms Order フォームを表示するための追加コードも含まれています。Customer.cbl に含まれている追加コードは、次の処理を行います。

$SET を使用して次のコンパイラ指令を設定します。
```
  $SET ans85 mfoo ooctrl(+P) case
```
- ANS85 は以前と同じ設定のままです。
- MFOO は、Micro Focus ネイティブ OO 構文のサポートを有効にします。
- OOCTRL(+P) は、ランタイムシステムで COBOL データタイプを COM データタイプにマッピングすることを可能にします。
- CASE は、外部シンボル (呼び出されたプログラムのプログラム ID や名前など) が大文字に変換されないようにします。
CLASS-CONTROL パラグラフで COM クラスの OrderFormsLibrary.FormsFactory を OO COBOL クラス名の OrderFormFact にマッピングします。このパラグラフでは、COM クラスは Micro Focus ネイティブ OO クラスライブラリの $OLE$ という COM ドメイン内にあります。
```
  class-control.  
  OrderFormFact is class"$OLE$OrderFormsLibrary.FormsFactory".
```
フラグを評価して Orders ボタンが押されたどうかを判断し、それに応じて応答を行います。
```
  WHEN customer-orders-flg-true
  PERFORM Show-Orders-Form
```
customer.gs に元々存在していた Orders ダイアログの Windows Forms バージョンを実装する COM オブジェクトのインスタンス (新しい .NET オーダーフォームライブラリ) を作成します。
```
  invoke OrderFormFact "New" Returning formsLibrary
```
マネージコードでネイティブコードを呼び出す際に使用できるプロシージャポインターを設定します。
```
  set  pptr  to  entry  "Customer_Callback"
```

コールバックで使用されるデータブロックへのポインターを取得します。

  Customer-Callback SECTION.
      entry "Customer_Callback" stdcall.
      exit program returning address of CUSTOMER-DATA-BLOCK.

新しい Orders フォームを起動して表示します。

  invoke formsLibrary "CreateOrderForm" using
      by value pptr-val

Customer.GS (Dialog System スクリーンセット)

スクリーンセットの customer.gs は、元の [Orders] ダイアログを表示しなくなっていますが、代わりにネイティブ COBOL プログラムに制御を渡します。[Main-Window] ダイアログ内の [Orders] ボタンに対する命令は、次のように変更されています。

  SET-FLAG ORDERS-FLG(1)
  RETC
  * REFRESH-OBJECT DIALOG-BOX
  * SET-FOCUS DIALOG-BOX

上記の命令により、ORDERS-FLG は Orders ボタンが押されたことを示すように設定されます。そのため、ネイティブ COBOL プログラムはフラグを評価し、それに応じて応答を行うことができます。制御は、ネイティブ COBOL プログラムに返されます。余分な行はコメントアウトされるため、古い Orders ダイアログは表示されなくなります。

マネージ COBOL での IFormsFactory.cbl

IFormsFactory.cbl は、Windows Forms Order フォームを作成するためのインターフェイスを定義します。IFormsFactory.cbl には、次の処理を行うコードがあります。

.NET Framework の InteropServices クラスを使用して、インターフェースを宣言します。また、ComInterfaceType:: InterfaceIsDual の指定によって、遅延バインドに対する COM オブジェクトサポートを確立します。別の方法として、ComInterfaceType::InterfaceIsIDispatch (ComInterfaceType::InterfaceIsIUnknown ではない) を指定することもできます。
```
  interface-id OrderFormsLibrary.IFormsFactory
      attribute System.Runtime.InteropServices.InterfaceType 
        (type
        System.Runtime.InteropServices.ComInterfaceType::InterfaceIsDual)
```
デフォルトでは、'Register For COM Interop' プロパティはすべてのものをデュアルインターフェースとして公開するので注意してください。
CreateOrderForm() メソッドを定義します。これは、ネイティブコードからマネージコードへのエントリポイントの定義です。
```
  method-id CreateOrderForm.
  procedure division using by value callback as binary-long.
  end method.
```

マネージ COBOL での FormsFactory.cbl

FormsFactory.cbl は、ネイティブプログラムからの要求に応じて Orders フォームのインスタンスを作成します。FormsFactory.cbl には、次の処理を行うコードがあります。

IFormsFactory インターフェースを実装するクラスを宣言します。

  class-id OrderFormsLibrary.FormsFactory implements
      type OrderFormsLibrary.IFormsFactory.

クラスの可視化によって、そのクラスを COM に公開します。
```
  attribute ComVisible(true)
```
COM に公開するデフォルトインターフェースとして IFormsFactory インターフェースを指定します。
```
  attribute ComDefaultInterface
      (type of OrderFormsLibrary.IFormsFactory)
```
アセンブリレベルでは、デフォルトで ComVisible 属性をオフに設定します。つまり、公開するタイプは明示的に ComVisible(true) として示す必要があります。これにより、使用するクライアントに対してより適切に定義されたタイプのライブラリが提供されます。
```
  assembly-attributes.
  attribute ComVisible(false).
```
コールバック関数のデリゲートを取得し、それを使用して顧客データブロックを確保します。GetDelegateForFunctionPointer() は、アンマネージ関数ポインターをデリゲートに変換します。
```
  set  pptr to new System.IntPtr(callback)
  set  custCallback to type  
      System.Runtime.InteropServices.Marshal::GetDelegateForFunctionPointer
      (pptr, type of CustomerCallback) 
      as type  CustomerCallback
```

コールバック関数のデリゲートを宣言します。

  delegate-id CustomerCallback.
  procedure division returning pCustomerDataBlock as type IntPtr.
  end delegate.

Orders フォームを作成し、それをモーダルダイアログボックスとして表示します。
```
  set form to new OrderFormsLibrary.OrderForm(custCallback)
  invoke form::ShowDialog()
```

マネージ COBOL での OrderForm.cbl [Design]

オーダーフォームは、フォームデザイナで描画されます。Windows Forms チュートリアルを参照してください。

マネージ COBOL での OrderForm.cbl [Code]

OrderForm.cbl [Code] は部分クラスであり、OrderFormsLibrary.OrderForm とも呼ばれ、Windows Forms Orders フォームを処理するためのコードを含んでいます。

OrderForm.cbl [Code] には、次のメソッドがあります。

New()

ネイティブコードにコールバックして、顧客データブロックを取得します。ポインターは、_pCustomerDataBlock. に格納します。

  set  _pCustomerDataBlock  to  callback::Invoke()

OrderForm_Load()

データブロックをローカル記憶域内のコピーにアンパックします。このコピーには、ネイティブコードの場合と同じ方法でアクセスできます。Marshal::Copy() メソッドは、_pCustomerDataBlock ポインターを pData にコピーします。

  invoke type Marshal::Copy
  (_pCustomerDataBlock, pData, 0, length  of  CUSTOMER-DATA-BLOCK)
  set CUSTOMER-DATA-BLOCK to pData

PopulateOrder()

次のような PERFORM ブロックおよび文とともに CUSTOMER-DATA-BLOCK 内のオーダー情報を使用して Orders フォームを初期化します。

  perform varying row thru OrdersGridView::Rows
  move CUSTOMER-ORD-NO(array-ind) to  
      row::Cells::get_Item("OrderNo")::Value
  move CUSTOMER-ORD-DATE(array-ind) to dt1
  ...

OrderForm_FormClosing()

フォームクローズイベントを処理し、ローカルに保持された Dialog System データブロックを呼び出し元に移動します。Marshal::Copy() メソッドは、pData ポインターを _pCustomerDataBlock にコピーします。

  set pData to CUSTOMER-DATA-BLOCK
  invoke type Marshal::Copy
  (pData, 0, _pCustomerDataBlock, LENGTH OF CUSTOMER-DATA-BLOCK)

OK_Click()

[OK] ボタンクリックイベントを処理します。

Delete_Click()

[Delete] ボタンクリックイベントを処理します。

マネージ COBOL での OrderForm.Designer.cbl

これは、フォームを定義する Windows Forms の背後のコードであり、デザインから生成されます。Windows Forms チュートリアルを参照してください。