ソースファイルの分割

開発中のグラフィックスインタプリタ cg.c では， ソースコードが随分と長くなってきた． 今回は，単独の大きなソースファイルを 複数の小さなソースファイル群へ分割する方法を修得しよう．

今回は，いつもより多数のファイルを作成する． 各プログラムごとにディレクトリを用意し， そのディレクトリの中で作業することを強く推奨する．

• 基本的なソース分割
• ソース分割の利点
• ヘッダファイルの利用
• 構造体定義のソース分割
• 練習問題
• 補足

今回，課題はないが，作業は多くある． 置き去りにされないように！ （次回は，今回の作業結果を使う課題がある予定．）

基本的なソース分割

まず，List 1 の統計処理プログラム calcstat を例として， ソースファイルの基本的な分割方法を説明する． このセクションでは，ディレクトリ calcstat-1 を作り， その中で作業することを推奨．

$  mkdir  calcstat-1
$  cd  calcstat-1

/****************************************************
 統計処理プログラム
  実数データを標準入力し，平均と標準偏差を表示する．
****************************************************/

#include <stdio.h>
#include <stdlib.h>
#include <math.h>

#define SIZE 10000	// データ配列の最大サイズ

int  data_error = 0;	// 入力データのエラーコード（グローバル変数）

/* 合計を計算する関数 */
double Sum(double x[], int n)
{
	int    i;
	double s = 0.0;

	for (i = 0; i < n; i++) {
		s += x[i];
	}
	return (s);
}

/* 平均を計算する関数 */
double Average(double x[], int n)
{
	return (Sum(x, n)/n);
}

/* 標準偏差を計算する関数 */
double StdDev(double x[], int n)
{
	int    i;
	double a, d, s = 0.0;

	a = Average(x, n);	// 平均

	for (i = 0; i < n; i++) {
		d = x[i] - a;		 // 偏差
		s += d*d;		 // 偏差自乗和
	}
	return (sqrt(s/n));
}

/* ファイルからデータを入力する関数 */
int ReadData(FILE *fp, double x[], int size)
{
	int	n, c;

	for (n = 0; n < size; n++) {
		c = fscanf(fp, "%lf", &x[n]);
		if (c != 1) break;
	}
	if (c == 0) data_error = 1;		// 異常なデータ
	else if (n == 0) data_error = 2;	// データなし
	else if (n >= size) data_error = 3;	// 配列サイズ不足
	return (n);
}

/* 入力データのエラー処理 */
void DataError(int n)
{
	char *msg;

	switch (data_error) {
	case 1: msg = "データが変です．"; break;
	case 2: msg = "データありません．"; break;
	case 3: msg = "データ多すぎです．"; break;
	default: msg = "なんか変です．";
	}
	fprintf(stderr, "データ %d 番：%s\n", n, msg);
	exit (EXIT_FAILURE);
}

int main()
{
	double x[SIZE];
	int		n;

	n = ReadData(stdin, x, SIZE);
	if (data_error != 0) DataError(n);

	printf("平　　均：%f\n", Average(x, n));
	printf("標準偏差：%f\n", StdDev(x, n));

	return (EXIT_SUCCESS);
}

• コンパイル方法：

$  cc  calcstat.c  -lm  -o  calcstat

• 実行例：

$  cat > data.txt
20
15
30
...
[Ctrl]+[D]

$  ./calcstat < data.txt
平　　均：...
標準偏差：...

Ｃ言語では， List 1 のような単独ソースファイルのプログラムを， List 2 のように複数のファイルへ分割して記述できる． List 1 のソースファイルを元にして， List 2 (a)-(c) の各ファイルを作成してみよう． （関数の内部は List 1 とまったく同じ．関数の外部だけが少しだけ異なる．）

ソース分割（List 2）の準備作業の例：

$  cp  calcstat.c  main.c	# 同一内容のファイルを３個作成
$  cp  calcstat.c  input.c
$  cp  calcstat.c  func.c
$  ls
calcstat.c  input.c   func.c   main.c
$  vi  main.c			# コードの修正（重複部分の削除等）
$  vi  input.c
$  vi  func.c

/****************************************************
 統計処理プログラム
  実数データを標準入力し，平均と標準偏差を表示する．
****************************************************/

#include <stdio.h>
#include <stdlib.h>

#define SIZE 10000	// データ配列の最大サイズ

// 外部変数の型宣言
extern int  data_error;

// 外部関数のプロトタイプ宣言（extern は省略可）
extern double Average(double x[], int n);
extern double StdDev(double x[], int n);
extern int ReadData(FILE *fp, double x[], int size);
extern void DataError(int n);
				// 行末のセミコロン「;」忘れやすい
int main()
{
	...		// 関数の定義内容には変更なし
}

#include <stdio.h>
#include <stdlib.h>

// グローバル変数の定義
int  data_error = 0;	// 入力データのエラーコード

/* ファイルからデータを入力する関数 */
int ReadData(FILE *fp, double x[], int size)
{
	...		// 変更なし
}

/* 入力データのエラー処理 */
void DataError(int n)
{
	...		// 変更なし
}

#include <math.h>

// 内部関数のプロトタイプ宣言（関数定義の順序次第では省略してもよい）
double Average(double x[], int n);
double StdDev(double x[], int n);
double Sum(double x[], int n);

/* 平均を計算する関数 */
double Average(double x[], int n)
{
	...		// 変更なし
}

/* 標準偏差を計算する関数 */
double StdDev(double x[], int n)
{
	...		// 変更なし
}

/* 合計を計算する関数 */
double Sum(double x[], int n)
{
	...		// 変更なし
}

List 2 をコンパイルするには，次の２通りの方法がある：

• 一括コンパイル：

$  cc  main.c  input.c  func.c  -lm  -o  calcstat

• 分割コンパイル：

$  cc  -c  main.c	# ソース main.c をコンパイルしオブジェクト main.o を生成
$  cc  -c  input.c	# 　〃　 input.c を　　　　　 〃 　　　　 input.o を生成
$  cc  -c  func.c	# 　〃　 func.c を　　　　　　〃　　　　　 func.o を生成
$  cc  main.o  input.o  func.o  -lm  -o  calcstat
			# オブジェクトを連結して実行形式ファイルを生成

オブジェクトファイルについては， 前期「プログラミング言語 II」の ここで ちょっとだけ登場していた．

実行結果は単独ソースの場合とまったく同じハズだ． 確認しよう．

ソース分割の利点

ソースファイルやコンパイルを分割することは， ただ面倒を増やしているだけに見えるかも知れない． しかし，大規模なプログラムを開発する場合には， 次のように，多くのメリットがある：

• 複数のプロジェクト（プログラム）の間での関数の再利用が簡単になる．
つまり，同じ関数を作り直す必要はない． printf( ) や sin( ) などのライブラリ関数と同様に， 呼び出すだけで済む．
• コンパイルにかかるコンピュータパワーの節約が可能になる．
人間がソースコードを作成・修正する際には， ほぼ間違いなく間違いを犯してしまうので， コンパイルは何度も繰り返されることになる． その際，変更部分の再コンパイルは仕方ないにしても， 完成済みの部分の再コンパイルは時間と電力の無駄でしかない．
• ソースファイルを編集しやすくなる．
長いソースファイルだと，変更したい場所を探すまでが大変．

さて，List 2 に関連して，次の概念についても理解しておこう：

• 関数プロトタイプ： 関数の戻り値の型，引数の個数，各引数の型，などの情報． 関数の処理内容ではない．
変数でいうところの「型」に相当するもの． 変数を使用する前に型を宣言する必要があるように， 関数を呼び出す前にはプロトタイプを宣言する必要がある．
• 外部変数： 他のソースファイルの中で定義されているグローバル変数． extern を付けて型宣言．
extern を付けないと同名の変数を二重に定義することになり， コンパイルエラーとなる．
• 外部関数： 他のソースファイルの中で定義されている関数．
外部変数と同様，extern を付けてプロトタイプ宣言する． （実は，関数の場合，extern は省略可能だが，明示すべき．）
• 内部関数： そのソースファイルの中で定義されている関数．
定義の順序次第ではプロトタイプ宣言は省略可．

なお，List 2(c) 内の関数の順序は List 1 の順序から意図的に変えられている． Average( ) で Sum( ) を呼び出しているが， プロトタイプ宣言がない場合， Sum( ) の型がわからないのでコンパイルエラーになる： （プロトタイプ宣言の部分をコメントにして試してみよう．）

// double Sum(...);	// プロトタイプ宣言がないと...

double Average(...)
{
	... Sum(...) ...	// コンパイルエラー!!
}

...

double Sum(...)		// 使う前に宣言しとかなきゃ...
{
	...
}

一方，List 1 のように Sum( ) を Average( ) の前に定義すれば， 問題無くコンパイルできる． この場合，定義が宣言を兼ねているわけだ．

ヘッダファイルの利用

List 2 の分割ソースファイルでは， 同じプロトタイプ宣言が複数のファイルに分散していた． たとえば，Average( ) と StdDev( ) の宣言が main.c と func.c の両方にある．

より大規模なプログラムでは，当然， 複数のファイルに共通した記述が， より多く必要になる． しかし，プログラマの立場から見ると， 何度も同じことを書くのは， 単に面倒なだけでなく， 入力ミスの元凶でもあり， 回避すべきである．

この問題を解決するのがヘッダファイルである． ヘッダファイルは， 複数のソースファイルで共通する（かもしれない）コード （プロトタイプ宣言や構造体定義など）だけを記述したものだ． 各ソースファイルでは，共通する宣言等を個別に重複して記述する必要はなくなり， それらのヘッダファイルをインクルードするだけで済む．

List 3 がヘッダファイルを利用した例である． List 2 を元にして，List 3 を作ろう． なお，List 2 では， プロトタイプ宣言等を各ソースファイル *.c に記述していたが， List 3 では，それらを別のヘッダファイル *.h に分離している．

ヘッダ分割（List 3）の準備作業の例：

$  pwd
/.../calcstat-1				# 今いる場所を確認
$  cd  ..
$  cp  -r  calcstat-1  calcstat-2	# ディレクトリをコピー
$  cd  calcstat-2
$  ls
calcstat.c   data.txt   input.c   func.c   main.c

$  rm  calcstat.c

$  cp  input.c  input.h
$  cp  func.c  func.h
$  ls
calcstat.c   data.txt   input.c   input.h   func.c   func.h   main.c

/****************************************************
 統計処理プログラム
  実数データを標準入力し，平均と標準偏差を表示する．
****************************************************/

#include <stdio.h>
#include <stdlib.h>
#include "input.h"
#include "func.h"

#define SIZE 10000	// データ配列の最大サイズ

int main()
{
	...
}

#include <stdio.h>	// FILE 型に必要

extern int data_error;

extern int ReadData(FILE *fp, double x[], int size);
extern void DataError(int n);

#include <stdio.h>
#include <stdlib.h>
#include "input.h"

int  data_error = 0;	// 入力データのエラーコード

/* ファイルからデータを入力する関数 */
int ReadData(FILE *fp, double x[], int size)
{
	...
}

/* 入力データのエラー処理 */
void DataError(int n)
{
	...
}

extern double Average(double x[], int n);
extern double StdDev(double x[], int n);
extern double Sum(double x[], int n);

#include <math.h>
#include "func.h"

/* 平均を計算する関数 */
double Average(double x[], int n)
{
	...
}

/* 標準偏差を計算する関数 */
double StdDev(double x[], int n)
{
	...
}

/* 合計を計算する関数 */
double Sum(double x[], int n)
{
	...
}

コンパイル方法は List 2 の場合とまったく同じだ． 再度，コンパイルと実行を試してみよう．

構造体定義のソース分割

ところで，実用的なプログラムでは，構造体がよく利用される． このようなプログラムのソースを分割する場合， 構造体定義についてもヘッダファイルに記述することになるが， 特別な注意が必要である． ヘッダファイルは複数回インクルードされる可能性があるためだ．

たとえば，apple.c から apple.h と fruit.h をインクルードしたところ， fruit.h も apple.h をインクルードしていた， みたいな場合がある． この場合，apple.c をコンパイルすると， apple.h は 2 回インクルードされることになる． もし，apple.h で構造体を定義していると， 同名の構造体が二重に定義されることになり， これはコンパイルエラーとなる．

これを避けるために， インクルードガード（include guard）という技がある． たとえば，ヘッダファイル header.h で 構造体型 Record を定義する場合，次のようにすればよい：

#ifndef HEADER_H	// フラグが立っていなければ（ if HEADER_H is not defined ） {
#define HEADER_H	//     フラグを立てる（ define HEADER_H ）
typedef struct {	//     構造体を定義 {
	int member1;
	int member2;
} Record;		//     }
#endif			// }

こうすれば，このヘッダファイルが複数回インクルードされても， typedef は１回だけしか実行されない． なお，このときのフラグ（マクロ）は， 半角英大文字でヘッダファイルまたは構造体と似た名前を付けておくのが お約束となっている． これは，フラグ名の重複を避けるためだ．

練習問題

グラフィックスインタプリタ cg.c を 複数のソースファイルおよびヘッダファイルへ適切に分割せよ．

ヒント：

• ソースファイルについては最低限， PBM 関数群／描画関数群／その他 の３個には分けられるだろう．
「その他」は，このプログラム cg だけに固有の部分． 前２者は，他のプログラムでも流用できそうな部分．
• ヘッダファイルについては最低限， PBM 関数群／描画関数群の２個にはなるだろう．
• 構造体定義については， 関連性の最も高い方のヘッダファイルへ入れよう．

補足

ソースファイルおよびヘッダファイルの分類のコツ：

• このプロジェクトだけでしか使わない「物」／ 他のプロジェクトでも使うかもしれない「物」を分ける．
• 同じ「物」を操作する関数同士を束ねる．

今回の実験では，ソースファイルがかなり大きくなってから分割する， という開発方法を採用した． このため，分割作業は非常に面倒になってしまったかもしれない． 本来ならば，肥大化しすぎる前に， あらかじめ，こまめに，分割作業をしておくべきだ．

普通の大規模プロジェクトでは，開発作業の効率化のため， 最初から（大きくなることを予想して） 複数のソースファイルとして作り始める， という開発方法を採用することになるハズ． ま，予想以上に肥大化してしまった場合には， やはり分割作業が追加で必要になってくるのだが... 面倒なので分割せず，そのまま続行してしまうと， 肥大化が加速し，かえって面倒が増えることになるだろう．

参考：ファイル分割のイメージ図