「ツールの作り方」の版間の差分

提供: Eospedia
移動: 案内検索
(Small Tools のコンパイル)
 
(2人の利用者による、間の7版が非表示)
行5: 行5:
 
まず、開発を行うディレクトリを作成します。
 
まず、開発を行うディレクトリを作成します。
  
  $ maketool ClassName ToolName All
+
  $ maketool ClassName ToolName new
  
を実行すると、$EOS_HOME/src/Tools/ClassName/ToolName のディレクトリが作られます。
+
を実行すると、$EOS_HOME/src/Tools/ClassName/ToolName のディレクトリが作られます。<br>
 
 その下には、src, inc, Config, docのディレクトリができあがります。
 
 その下には、src, inc, Config, docのディレクトリができあがります。
 +
<br><br>
  
 
== Small Toolsの引数の設定方法 ==
 
== Small Toolsの引数の設定方法 ==
  
次に設定するのは、Small Toolの引数です。これは、[[OptionControlFile]]を設定することがまず最初です。
+
次に設定するのは、Small Toolsの引数です。これは、[[OptionControlFile]]を設定することがまず最初です。<br>
 
設定できたら、
 
設定できたら、
  
  $ make check
+
  $ make check   ;  ディレクトリが正常かを確認します。
 
  $ cd src
 
  $ cd src
 +
$ make update        ;  OptionControlFileを使って、ソースコードを変更します。
 +
$ make depend      ; ファイルの依存関係を確認します。
 +
$ make                  ; コンパイル・リンクします。 
 +
$ make install        ; ユーザーが利用できる場所にコピーします。
 +
 +
の手順です。次回からは、OptionControlFileを変更するたびに
 +
 
  $ make update
 
  $ make update
 +
 +
により、init.c, argCheck.c等をアップデートします。
 +
<br><br>
 +
 +
== Small Tools のコンパイル==
 +
 以下のコマンドでSmall Toolsのソースコードをコンパイルして実行可能なコマンドへ変換します。
 +
 
  $ make depend
 
  $ make depend
 +
$ make clean
 
  $ make  
 
  $ make  
 
  $ make install
 
  $ make install
  
の手順です。次回からは、OptionControlFileを変更するたびに
+
なお、ライブラリ([[API]])との関係が変わった場合はそちらも再コンパイルする必要があります。
 +
<br><br>
  
$ make update
 
  
により、init.c, argCheck.cをアップデートします。
+
== Small Toolsの個々のテスト ==
 +
 それぞれのtestディレクトリの下で、コマンドのテストが可能です。
 +
 
 +
$ make Test
  
 +
でテストを実行できます。ただし、test/Makefileを準備し、test/data の下にテスト用のデータをおいておく必要があります。このデータは,baseには含まれず、dataのレポジトリに含まれるので、通常はアップデートされません。
  
 
== デバッグ等に有用なサポート ==
 
== デバッグ等に有用なサポート ==
 +
[[genUtil(API)]]にはログやデバッグメッセージを出力するAPIがあります。動作確認を行いたい場合に活用できます。
 +
<br><br>
  
== 特別なオプションと拡張の仕組み ==
+
== [[特別なオプション]]と拡張の仕組み ==
 +
Eosでは、それぞれのコマンドで共通に利用出来るオプションをもっています。詳細は、[[特別なオプション]]をご覧下さい。
 +
<br><br>

2015年7月8日 (水) 10:29時点における最新版

ここでは、Eosの環境を利用した迅速なSmall Toolsの開発方法を概説します。これを支えるのがmaketoolというコマンドとOptionControlFileと呼ばれる設定ファイルです。これらにより、統一的なSmall Toolsの入出力のための引数、main関数における引数の値の利用方法、簡易版の使用方法、マニュアルなどが与えられます。

Small Toolsを開発するディレクトリの作成方法

まず、開発を行うディレクトリを作成します。

$ maketool ClassName ToolName new

を実行すると、$EOS_HOME/src/Tools/ClassName/ToolName のディレクトリが作られます。
 その下には、src, inc, Config, docのディレクトリができあがります。

Small Toolsの引数の設定方法

次に設定するのは、Small Toolsの引数です。これは、OptionControlFileを設定することがまず最初です。
設定できたら、

$ make check   ;  ディレクトリが正常かを確認します。
$ cd src
$ make update        ;  OptionControlFileを使って、ソースコードを変更します。
$ make depend       ; ファイルの依存関係を確認します。
$ make                   ; コンパイル・リンクします。  
$ make install        ; ユーザーが利用できる場所にコピーします。

の手順です。次回からは、OptionControlFileを変更するたびに

$ make update

により、init.c, argCheck.c等をアップデートします。

Small Tools のコンパイル

 以下のコマンドでSmall Toolsのソースコードをコンパイルして実行可能なコマンドへ変換します。

$ make depend
$ make clean
$ make 
$ make install

なお、ライブラリ(API)との関係が変わった場合はそちらも再コンパイルする必要があります。


Small Toolsの個々のテスト

 それぞれのtestディレクトリの下で、コマンドのテストが可能です。

$ make Test

でテストを実行できます。ただし、test/Makefileを準備し、test/data の下にテスト用のデータをおいておく必要があります。このデータは,baseには含まれず、dataのレポジトリに含まれるので、通常はアップデートされません。

デバッグ等に有用なサポート

genUtil(API)にはログやデバッグメッセージを出力するAPIがあります。動作確認を行いたい場合に活用できます。

特別なオプションと拡張の仕組み

Eosでは、それぞれのコマンドで共通に利用出来るオプションをもっています。詳細は、特別なオプションをご覧下さい。