man imake (1): make ユーティリティに対する C プリプロセッサのインタフェース

書式

imake [ -Ddefine ] [ -Idir ] [ -Udefine ] [ -Ttemplate ] [ -f filename ] [ -C filename ] [ -s filename ] [ -e ] [ -v ]

説明

imake は、テンプレート、cpp マクロ関数群、Imakefile と呼ばれるディレクトリごとの入力ファイルから Makefile を生成する。これを使うことにより、プログラムを構築するための様々な要素の記述から、マシンに依存する部分(コンパイラのオプション、異なるコマンド名、特別な make の規則など)を切り離すことができる。

オプション

以下のコマンド行オプションは imake に渡される。

-Ddefine: このオプションは直接 cpp に渡される。このオプションは通常、ディレクトリ固有の変数をセットするために使われる。例えば、Xウィンドウシステムはこのフラグを使って、TOPDIR にコアディストリビューションの最上位ディレクトリの名前をセットし、CURDIR には最上位ディレクトリからカレントとディレクトリへの相対パスをセットする。
-Idirectory: このオプションは直接 cpp に渡される。このオプションは通常、 imake のテンプレートや設定ファイルがあるディレクトリを指定するために使われる。
-Udefine: このオプションは直接 cpp に渡される。このオプションは通常、 imake の設定ファイルをデバッグするときに変数をセット解除するために使う。
-Ttemplate: このオプションは、cpp が使うマスターテンプレートファイル(通常は -I で指定されたディレクトリに置かれる)の名前を指定する。デフォルト値は Imake.tmpl である。
-f filename: このオプションは、ディレクトリごとに置く入力ファイルの名前を指定する。デフォルト値は Imakefile である。
-C filename: このオプションは、カレントディレクトリに作られる .c ファイルの名前を指定する。デフォルト値は Imakefile.c である。
-s filename: このオプションでは、生成される make 記述ファイルの名前を指定するが、このオプションを指定しても make が実行されることはない。 filename がダッシュ(-)ならば、出力は stdout に対して行われる。デフォルトの動作では Makefile を生成するが、実行はしない。
-e: このオプションを指定すると、imake は生成した Makefile を実行する。デフォルトでは、Makefile の実行はユーザに任されている。
-v: このオプションを指定すると、imake は Makefile の生成に使う cpp のコマンド行を表示する。

imake の動作

imake は、コマンド行で -I オプションや -D オプションを渡してcpp を起動し、次の内容を持つファイル名を渡す。

                #define IMAKE_TEMPLATE "Imake.tmpl"
                #define INCLUDE_IMAKEFILE <Imakefile>
                #include IMAKE_TEMPLATE

このとき、Imake.tmpl の部分はコマンドの -T オプションで書き換えられることがあり、Imakefile の部分は -f オプションで書き換えられることがある。

IMAKE_TEMPLATE は通常、マシン依存のパラメータ(cpp のシンボルで指定する)が書かれたファイル、サイト特有のパラメータファイル、変数を定義するファイル、make を生成するための cpp のマクロ関数が書かれたファイル、カレントディレクトリの Imakefile (INCLUDE_IMAKEFILE で指定する)を読む。Imakefile は、このマクロ関数を用いて生成すべき対象を示す。imake は、責任を持って適切な規則を生成する。

Imake の設定ファイルは、2つのタイプの変数を持つ。すなわち、imake 変数と make 変数である。imake 変数は imake を実行した際に cpp によって解釈される。慣習により、imake 変数の名前は大文字と小文字が混ざった形となる。make 変数は Makefile に書き込まれ、後で make に解釈される。慣習により、make 変数の名前は大文字で書かれる。

規則ファイル(通常は設定ディレクトリの Imake.rules)には、現在のプラットフォームにしたがって設定された cpp マクロ関数群が記述されている。マクロが複数行の make 規則を生成できるように、 imake は文字列 ``@@'' が現れると、これを改行に置き換える。例えば、次のマクロ

 #define  program_target(program, objlist)        @@\
 program: objlist                                 @@\
          $(CC)  -o  $@  objlist  $(LDFLAGS)

は、 program_target(foo, foo1.o foo2.o) で呼ばれたとき、

 foo:     foo1.o  foo2.o
          $(CC)  -o  $@  foo1.o  foo2.o  $(LDFLAGS)

のように展開される。

imake は ``XCOMM'' が現れると、これを ``#'' 文字に置換する。これにより、プリプロセッサに ``invalid directive'' エラーを出させることなく Makefile にコメントを置くことができる。

複雑な imake の場合、生成される make 変数がマクロのそれぞれの呼び出しにおいて局所性が必要なことがある。これはしばしば、その値がマクロに渡されるパラメータに依存するために起こる。このような変数は、XVARdefn の形式の imake 変数を使って作ることができる。ここで、n は1桁の数字である。一意に決まる make には代入が行われる。後で変数 XVARusen が現れたとき、これは対応する XVARdefn によって生成された変数に置き換えられる。

cpp が複数のタブや空白を1つの空白に減らすようなシステムにおいては、imake は必要なタブを戻そうと試みる(make はタブと空白の違いに大変厳しい)。このため、コマンド行ではコロン(:)の前にバックスラッシュ(\)を置かなければならない。

X ウィンドウシステムでの利用

X ウィンドウシステムは、ソースからのシステム全体の構築と外部ソフトウェアの構築の両方で imake を広く用いる。先に述べたように、相対パス名を用いたファイルの参照を容易にするために2つの特別な変数 TOPDIR と CURDIR がセットされる。例えば、lib/X/ における Makefile を作るため、次のコマンドが自動的に生成される(ソースの最上位ディレクトリからの相対パス):

          %  ../.././config/imake  -I../.././config  \
                -DTOPDIR=../../.   -DCURDIR=./lib/X

ソースツリーに含まれない X のプログラムを構築する際には、特殊なシンボル UseInstalled が定義され、TOPDIR と CURDIR は無視される。設定ファイルが正しくインストールされていれば、スクリプト xmkmf(1) を使うことができる。

入力ファイル

X に使われるときに imake が読むファイルについての概略を示す。字下げは、他のファイルをインクルードすることを示す。


    Imake.tmpl                一般的な変数
        site.def              サイト固有、BeforeVendorCF が定義される
        *.cf                  マシン固有
            *Lib.rules        共有ライブラリの規則
        site.def              サイト固有、AfterVendorCF が定義される
        Imake.rules           規則
        Project.tmpl          X 特有の変数
            *Lib.tmpl         共有ライブラリについての変数
        Imakefile
            Library.tmpl      ライブラリについての規則
            Server.tmpl       サーバについての規則
            Threads.tmpl      マルチスレッドについての規則

site.def は2度インクルードされる点に注意せよ。1度目は *.cf ファイルの前で、次はこのファイルの後である。サイトにおけるカスタマイズのほとんどは *.cf ファイルの後でなければならないが、コンパイラの選択のように先に指定しなければならないものもある。他の変数設定がこれらに依存しているからである。

最初に site.def をインクルードしたときには変数 BeforeVendorCF が定義され、2度目にインクルードしたときには変数 AfterVendorCF が定義される。site.def の全てのコードはどちらかのシンボルについての #ifdef の内側に置かれているはずである。

ファイル

Imakefile.c                  cpp の入力に使う一時ファイル

/tmp/Imf.XXXXXX             -s のための一時的な Makefile

/tmp/IIf.XXXXXX             指定した Imakefile が # 形式のコメントを使っている場合の一時的な Imakefile

/lib/cpp                    デフォルトの C プリプロセッサ

環境変数

以下の環境変数を設定することができる。ただし、これらは imake が実行されるときに容易にはわからない依存関係をもたらすため、あまり使わないほうがよい。

IMAKEINCLUDE: この環境変数が定義された場合、C プリプロセッサにインクルードの引き数 ``-I'' を渡すことを指定。例: ``-I/usr/X11/config''.
IMAKECPP: この環境変数が定義された場合、これはプリプロセッサのプログラムの有効なパスでなければならない。例: ``/usr/local/cpp''. デフォルトでは、 imake は /lib/cpp を用いる。
IMAKEMAKE: この環境変数が定義された場合、これは ``/usr/local/make'' のような make プログラムの有効なパスでなければならない。デフォルトでは、 execvp(3) を使って見つけた make を使用する。この環境変数が使用されるのは、``-e'' オプションが指定されたときだけである。

著者

Todd Brunhoff, Tektronix and MIT Project Athena; Jim Fulton, MIT X Consortium

書式

説明