C 記述子による引数の互換性保持

ランク引き継ぎ

ランク引き継ぎオブジェクトは、ランクが実引数から引き継がれる仮引数です。任意のランクの引数を受け付ける C 関数との互換性を保持します。組込み関数 RANK を使用して、ランク引き継ぎ変数のランクを取得できます。

ランク引き継ぎ仮引数が含まれる場合、プロシージャーには明示的なインターフェイスが必要です。

SHAPE、SIZE、UBOUND 組込み関数は、大きさ引き継ぎ配列に関連付けられたランク引き継ぎ配列用に定義されています。

ランク引き継ぎ仮引数は、任意のランクの実引数に対応できます。実引数のランクが 0 の場合、仮引数のランクは 0 になります。形状はサイズが 0 の配列となり、LBOUND と UBOUND 組込み関数 (DIM 引数なし) はサイズ 0 の配列を返します。実引数のランクが 0 よりも大きい場合、仮引数のランクと範囲は、大きさ引き継ぎ配列の最終範囲がないことも含め、実引数から引き継がれます。実引数が配列で、仮引数が ALLOCATABLE または POINTER 属性を持つ場合、仮引数の境界は実引数から引き継がれます。

型引き継ぎ

型引き継ぎオブジェクトは、TYPE(*) として宣言される仮引数です。C の (void *) 型の仮引数との互換性を提供します。

型引き継ぎ仮引数は多相なため、型引き継ぎ仮引数を含むプロシージャーには明示的なインターフェイスが必要です。

型引き継ぎ仮引数は、型引数、型バインド・プロシージャー、または最終サブルーチンを持つ派生型の実引数と一致してはなりません。

CFI_cdesc

C 記述子は、ISO_Fortran_binding.h ファイルで定義されている CFI_cdesc 型の C 構造体です。

BIND(C) の制約事項

プロシージャーに対して BIND(C) を指定する場合、各仮引数は互換性のあるプロシージャーか、変数 (互換性がある、形状引き継ぎ、ランク引き継ぎ、型引き継ぎ、文字長引き継ぎ、または ALLOCATABLE あるいは POINTER 属性) でなければなりません。関数に対して BIND(C) を指定する場合、関数の結果は互換性のあるスカラー変数でなければなりません。

BIND(C) プロシージャーの仮引数は、OPTIONAL 属性と VALUE 属性の両方を持つことはできません。

BIND(C) プロシージャーの仮引数である変数は、互換性のある型か引き継ぎ型でなければなりません。

Co-Array は、BIND(C) プロシージャーの仮引数に指定できません。

ALLOCATABLE または POINTER 属性は、BIND(C) プロシージャーのデフォルトで初期化される仮引数では指定できません。

その他の制約事項

ASYNCHRONOUS 属性を持つ変数は、Fortran プロシージャーと C プロシージャー間の非同期通信に使用できます。

INTENT (OUT) 属性の割付け仮引数を持つ Fortran プロシージャーが C 関数によって呼び出され、C 関数の実引数が割り当てられた割付け変数を表す C 記述子のアドレスである場合、変数は Fortran プロシージャーの入口で解放されます。C 関数が INTENT (OUT) 属性の割付け仮引数を利用して Fortran プロシージャーから呼び出され、C 関数への参照の実引数が割り当てられた割付け変数の場合、変数は呼び出し時 (C 関数の実行前) に解放されます。

ISO_Fortran_binding.h

ISO_Fortran_binding.h で定義されている型、マクロ、関数は、C 記述子を解釈し、C 記述子によって表されるオブジェクトを割り当て/解放するために C 関数で使用できます。これらは、割付け、引き継ぎ文字長、ランク引き継ぎ、形状引き継ぎ、またはデータポインター仮引数を持つ Fortran インターフェイスと互換性を保持する C プロトタイプを指定するために提供されています。

ISO_Fortran_binding.h は、次の定義を含む C ヘッダーファイルです。

• C 構造体 CFI_cdesc_t と CFI_dim_t
• CFI_attribute_t、CFI_index_t、CFI_rank_t、CFI_type_t の型宣言
• CFI_CDESC_T マクロとさまざまな有効値の整数定数式に展開されるマクロ定義
• CFI_address、CFI_allocate、CFI_deallocate、CFI_establish、CFI_is_contiguous、CFI_section、CFI_select_part、CFI_setpointer の C 関数プロトタイプまたはマクロ定義これらの関数のいくつかは、エラーコード (エラー状態を示す整数値) を返します。値 0 (CFI_SUCCESS) は、エラー状態が検出されなかったことを示します。0 以外の値は、検出されたエラー状態を示します。「ISO_Fortran_binding.h にあるマクロと型宣言」に、エラー状態とマクロ名の対応表があります。

  添字、境界、範囲、ストライドを表す関数引数の要素順は、C 記述子の dim メンバーの要素順と同じです。

Fortran プロシージャーと互換性を保持するための C 関数の制約事項

Fortran プロシージャーと互換性を保持するための C 関数は、次の条件を満たしている必要があります。

• C 記述子は、ISO_Fortran_binding.h にある関数を呼び出す場合を除いて、初期化、更新、コピーされません。
• C 記述子のアドレスが Fortran 実引数に対応する仮引数、または Fortran 仮引数に対応する C 実引数の場合、次の条件を満たしている必要があります。
  • Fortran インターフェイスの対応する仮引数が INTENT(IN) 属性を持つ場合、または C 記述子が割付けでない非ポインター・オブジェクトの場合、C 記述子は変更されません。
  • Fortran インターフェイスの対応する仮引数が POINTER および INTENT(IN) 属性を持つ場合、C 記述子の base_addr メンバーは値が設定される前にアクセスされません。

  ここで、変更とは C 記述子の場所または内容の変更 (作成と更新を含む) を指します。これらの制約事項は、アクティブな Fortran プロシージャーが常に同じ状態の C 記述子を利用できるようにし、Fortran コード側で C 記述子をコピーしなくても済むようにするためです。

• C 関数内で、割付けオブジェクトは、CFI_allocate 関数と CFI_deallocate 関数を実行することでのみ割り当て/解放されます。Fortran ポインターは、CFI_allocate 関数を実行することでターゲットと関連付けられます。
• C 記述子に対する CFI_allocate または CFI_deallocate の呼び出しは、C 記述子が表す Fortran 変数と関連する割付け変数の割り当て状況を変更します。
• オブジェクトのアドレスが、BIND(C) インターフェイスの非ポインター仮引数に対応する仮引数の値である場合、次の条件を満たしている必要があります。
  • INTENT (IN) 属性を持つ仮引数の場合、オブジェクトは定義/未定義されません。
  • INTENT (OUT) 属性を持つ仮引数の場合、オブジェクトは定義前に参照されません。
• Fortran オブジェクトが解放されるか、ホスト関数の実行が完了するか、関連付けが未定義になると、そのオブジェクトへのすべての C 記述子と C ポインターは未定義になり、使用された場合の動作は不定です。
• アドレスが Fortran 仮引数に対応する仮引数である C 記述子は、Fortran 関数の呼び出しから戻ると未定義になります。TARGET または ASYNCHRONOUS 属性を持たない仮引数の場合、C 記述子で表されるオブジェクトへのすべての C ポインターは、呼び出しから戻ると未定義になり、使用された場合の動作は不定です。
• Fortran オブジェクトが解放されるか、ホスト関数の実行が完了するか、関連付けが未定義になると、そのオブジェクトへのすべての C 記述子と C ポインターは未定義になり、使用された場合の動作は不定です。
• C 記述子のアドレスが実引数として Fortran プロシージャーに渡される場合、C 記述子は、プロシージャーの呼び出しから戻るまで C 側で存続していなければなりません。
• オブジェクトが割付けでない非ポインターとして Fortran プロシージャーに渡される場合、オブジェクトはプロシージャーの呼び出しから戻るまで存続していなければなりません。
• C によって作成された割付けオブジェクトの C 記述子の存続期間がプログラム終了前に終了した場合、その時点でオブジェクトは解放されます。
• Fortran ポインターが C オブジェクトに関連付けられた場合、C オブジェクトの存続期間が終了すると Fortran ポインターの関連付けは未定義になります。