gtool4/Fortran 90 library document

エラーの取り扱い

2000-08-28 豊田英司

概要

プログラムの部品は必ずエラーの取り扱いを明確に規定すべきものである。エラーとは当該部品への入力が不適切であるとか、期待される動作をすることができないといった事態である。

gtool4/Fortran 90 ライブラリがユーザに提供する手続 (手続とはサブルーチンまたは関数の総称) はほとんどの場合、以下の2つの方式のいずれかで呼び出し元にエラーを報告する。

• エラーが発生すると適切なメッセージを表示してプログラム終了

• 論理型の省略できる引数 err が与えられた場合は、エラー時にはそれを真にする。err が省略された場合は上に同じ

これらの処理はすべて dc_error モジュールの StoreError サブルーチンで行っている。StoreError は以下のような引用仕様を持つ。

subroutine StoreError(number, where, err, cause_s, cause_i)
    use DC_STRING
    integer, intent(in):: number
    character(len = *), intent(in):: where
    logical, intent(out), optional:: err
    type(VSTRING), intent(in), optional:: cause_s
    integer, intent(in), optional:: cause_i
end subroutine

必要な引数は2つであり、第1引数は整数型のエラーコード、第2引数は文字型でエラーの発生した手続名を与える。デフォルトでは

where: error_message

	または

where(cause_s): error_message

の形式の文字列が端末に表示されてプログラムは終了する。

エラーコード一覧

gtool4 ライブラリにコードを追加するプログラマは適切なエラーコードで StoreError を呼び出すようにしなければならない。そこで、新しいエラーコードを定義する必要があるかどうか　ｈｙｇｇｇを判定するために、エラーコードの値と対応するメッセージを一覧する。エラーコードニーモニックを使用するためには、NF_E で始まる名前については netcdf_f77 モジュールを引用するか include 'netcdf.inc' を行い（後者は推奨されない）、GT_E で始まる名前については dc_error モジュールを引用する。

エラーコードの数値の欄を設けたのは新たなエラーコードを割り当てる際の指針を示すためである。コードではエラーコードをニーモニックで与えるべきであり、数値をハードコードすることは厳に慎まれたい。