「OptionControlFile」の版間の差分

提供: Eospedia
移動: 案内検索
行1: 行1:
'''OptionControlFile'''は、Eosのmaketoolによって利用されるファイルです。Eosのコマンドの引数の取り扱いや使用方法の提供などの情報を提供しています。
+
'''OptionControlFile'''は、Eosのmaketoolによって利用されるファイルです。[[Eos]]のコマンドの引数の取り扱いや使用方法の提供などの情報を提供しています。
  
 
EosにおけるOptionControlFileのフォーマット
 
EosにおけるOptionControlFileのフォーマット

2012年10月14日 (日) 17:59時点における版

OptionControlFileは、Eosのmaketoolによって利用されるファイルです。Eosのコマンドの引数の取り扱いや使用方法の提供などの情報を提供しています。

EosにおけるOptionControlFileのフォーマット 各行は次の様なフォーマットからなっています。

"Option","fullOption","OptionName","OptionProperties","OptionNumber","argIndex","argName","argType","InitialValue",...

それぞれの項目の意味は次の様なものです。

Option     :実際に利用される引数です。-Option の形で利用できる様になります。
fullOption   :上記のオプションの省略の元を顕しています。
           OptionNumber(引数の数)が0であれば、
         fullOptionは、flagNameとしてプログラム中で定義されます。
OptionName   :引数の意味を示します。
OptionProperties:引数が必須かオプショナルかを示しています。
           詳細は下記のテーブルを参考にして下さい。 
OptionNumber  :この引数のパラメータの数を示しています。
         0のときは、下記のargが必要ありません。
argIndex    :パラメータのインデックスです。1から始まります。
argName     :パラメータの名前です。prototype無いではメンバ変数になります。
argType     :引数の型を示しています。
           詳細は下記のテーブルを参考にして下さい。 
InitialValue  :パラメータの初期値を示しています。     

それぞれの定義されている型を示します。

OptionPropertiesに対しては下記の様に定義されています。

Essential : 必須の引数です。設定していない場合は、実行時に要求されます。
Optional  : オプショナルな引数です。設定していない場合には、初期値が使われる場合が多いです。
Variable : 引数の数が可変の引数です。一番最後に一回だけ利用できるので注意が必要です。

argTypeに対しては、下記のように引数の型が定義されています。

Integer    : 整数
Real     : 実数

inFile    : 入力ファイル名(読み込みファイル名) 
outFile    : 出力ファイル名(書き出しファイル名)
appendFile  : アペンドモードの出力ファイル名
inFileList  : 入力ファイル名のリストが格納されたファイルの名前
outFileList  : 出力ファイル名のリストが格納されたファイルの名前
appendFileList: アペンドモードの出力ファイル名のリストが格納されたファイルの名前
※ 通常それぞれがプログラムの開始時にファイルを開きますが、
※ NoOpenをつけると、ファイルを開きません。
inFileNoOpen, outFileNoOpen, appendFileNoOpen, 
inFileListNoOpen, outFileListNoOpen, appendFileListNoOpen

Character   : 文字一文字
String      : 文字列(ただし、最初の一語のみ)
StringAll   : 文字列(全て)