プログラミング技法

C言語でプログラムを作成する場合に参考となる知識，手法等を紹介する．

マクロ
プログラム技法

マクロ

C言語のプログラムは，いくつかの関数定義の集まりとして表わされるが，呼び出される回数が比較的多く，処理すべき内容が少ない機能的に小さいものは，関数化しないでマクロ定義で表現するのが良い．これにより，関数呼び出しの際に要するオーバヘッド時間を節約することができ，実行効率を上げることができる．

汎用マクロ

よく使われる汎用的なマクロを以下に示す．

マルチステートメントマクロ
単一の関数呼び出しと同様に使える複数文からなるマクロを書く伝統的な手法は以下のものである．このマクロでは，呼び出し側で文の終端のセミコロンを付ける．
```
  #define Func() do { \
      /* declarations */ \
      stmt1; \
      stmt2; \
      /* ... */ \
  } while(0)    /* (no trailing ; ) */
```
呼び出し側でセミコロンを付けるとき，この展開は単一の文になる．最適化コンパイラは通常このような常に偽となる条件のテストや分岐を取り除いてくれる．
マクロ内の文が宣言やループを含まない単純な式のみの場合は，コンマ演算子を用いる括弧で括られたマクロ定義が使える．
可変個の引数を持つマクロ
単一の引数を持つマクロを定義し，複数の引数を2重の括弧を付けて単一引数のようにして呼び出す．
例えば，以下のようにする．
```
  #define DEBUG(args) (printf("DEBUG: "), printf args)

  if (n != 0) DEBUG(("n is %d\n", n));
```

文字種類判定

  #define ishex(c)    (((c) >= '0' && (c) <= '9') || \
                      ((c) >= 'a' && (c) <= 'f') || \
                      ((c) >= 'A' && (c) <= 'F'))
  #define  iswhite(c)    ( (c) == ' ' || (c) == '\t' || (c) == '\n' )
  #define  isnum(c)      ( isdigit(c) || (c) == '-' )

漢字コード判定
iskanjiは引数cで指定された値がシフトＪＩＳコードの第１バイトかを，iskanji2は第２バイトかを判定する．

  #define iskanji(c)  ((unsigned char)(c) >= 0x81 && \
                      (unsigned char)(c) <= 0x9f || \
                      (unsigned char)(c) >= 0xe0 && \
                      (unsigned char)(c) <= 0xfc)
  #define iskanji2(c)  ((unsigned char)(c) >= 0x40 && \
                      (unsigned char)(c) <= 0xfc && \
                      (unsigned char)(c) != 0x7f)

空白文字スキップ

  #define skipwhite(s)   while(iswhite(*s))      ++s
  #define skipnwhite(s)  while(*s && !iswhite(*s)) ++s

文字列処理
文字列の最後の文字を返す．

  #define lastch(s)    s[strlen(s)-1]

文字列の終端の改行文字を削除する．

  #define rm_ret(s)    if (lastch(s) == '\n') lastch(s) = '\0'

最大，最小
x, yで指定される2つの数の大小を比較し，大きい数(maxの場合)／小さい数(minの場合)を返す．
```
  #define max(x, y)    ( (x) > (y) ? (x) : (y) )
  #define min(x, y)    ( (x) < (y) ? (x) : (y) )
```
文字列の比較
s1, s1で指定される文字列を比較し，一致（真）／不一致（偽）を返す．
```
  #define Streq(s1, s2) (strcmp((s1), (s2)) == 0)
```

ビットの集合，配列
ビットの操作は以下のような配列とマクロで実現できる．

  #include <limits.h>        /* for CHAR_BIT */

  #define Mask(bit)      (1 << ((bit) % CHAR_BIT))
  #define Slot(bit)      ((bit) / CHAR_BIT)
  #define Set(ary, bit)  ((ary)[Slot(bit)] |= Mask(bit))
  #define Test(ary, bit) ((ary)[Slot(bit)] & Mask(bit))

インクルードガード

ヘッダファイルが他のヘッダファイルをインクルードしても型の再定義エラーが起こらないように，すべてのヘッダファイルの先頭と最後に以下のような記述をする．

#ifndef _H_HEADER_
#define _H_HEADER_
          
// 変数や関数の定義
          
#endif  // _H_HEADER_

これにより，何回インクルードしても最初の1回だけ読み込まれ，再定義エラーにはならない．

デバグ文

デバグメッセージをコード中に埋め込むため

 #ifdef DEBUG
     printf("Debug message\n");
 #endif

がよく用いられる．

しかし，上記のコードは可読性を悪くする．すなわち，移植性を確保するために#defineを行の左端に置くことにより，字下げ（インデント）が乱されてしまう．また，各メッセージを表示するのに3行を使う．これは，以下のようなマクロを使うことにより改善できる．

  #ifdef DEBUG
  #define DBG(x) x
  #else
  #define DBG(x)
  #endif

上記では，DEBUGが定義されていると，DBG(x)というマクロがその引数に展開される．また，DEBUGが定義されていないとマクロDBG(x)はnull文字列になり，DBG(x)が無視されるようになる．マクロの引数は合法的なCの文や式ならば何でもよい．但し，マクロを起動する文の後にセミコロンを書いてはいけない．セミコロンがあると，マクロがnullに展開された場合，if--elseの対応を狂わせることがある．
例えば，以下のように使用する．

  DBG(printf("Debug start : %d\n", code);)

プログラム技法

プログラムで使われる技法のいくつかを示す．

可変長引数
可変長引数を用いた関数の例として，任意の個数の文字列をmallocされたメモリに結合する関数を以下に示す．

  #include <stddef.h>        /* for NULL, size_t */
  #include <stdarg.h>        /* for va_ stuff */
  #include <string.h>        /* for strcat et al */
  #include <stdlib.h>        /* for malloc */

  char *vstrcat(char *first, ...)
  {
      size_t len = 0;
      char *retbuf;
      va_list argp;
      char *p;

      if (first == NULL)
         return NULL;
      len = strlen(first);
      va_start(argp, first);
      while ((p = va_arg(argp, char *)) != NULL)
          len += strlen(p);
      va_end(argp);

      retbuf = malloc (len + 1);    /* +1 for trailing \0 */
      if (retbuf == NULL)
          return NULL;        /* error */

      (void)strcpy(retbuf, first);
      va_start(argp, first);
      while ((p = va_arg(argp, char *)) != NULL)
          (void)strcat(retbuf, p);
      va_end(argp);
      return retbuf;
  }

この関数の使用例を以下に示す．呼び出し側はmallocで確保された戻り値のメモリ領域を使用後解放しなければならない．

  char *str = vstrcat("Hello, ", "world!", (char *)NULL);

関数名称での関数の呼び出し
関数の名称で関数を呼び出すには，以下のようなテーブルを用意し，関数名称でテーブルを検索し対応する関数へのポインタで関数を呼び出す．
```
  int function1(), function2();

  struct {
      char *name;
      int (*funcptr)();
  } symtab[] = {
      "function1",    function1,
      "function2",    function2,
  };
```
構造体の宣言
以下のような構造体を使うプログラムでは，name型のデータを動的に確保するとき，name型の構造体とnameが指すポインタ用の2回のメモリアロケーションが必要になる．
```
  struct name {
      int namelen;
      char *name;
  };
```
これらは，name型の宣言を以下のようにすると1回で済ますことができる．
```
  struct name {
      int namelen;
      char name[1];
  };
```
name型のデータを確保するためには，name型と実際のname(aName)の合計サイズを計算してその大きさをmallocで確保する．
```
  p = (char *)malloc(sizeof(name) + strlen(aName));
  strcpy(p->name, aName);
```
多次元配列の動的確保
ポインタの配列を確保し，配列の各要素を動的に確保した各行(row)へのポインタで初期化する．結果の配列は実際の配列のようにメモリ上で必ずしも連続していないが，空間を節約することができる．
2次元配列に対する例を示す．
```
  int **array = (int **)malloc(nrows * sizeof(int *));
  for (i = 0; i < nrows; i++)
      array[i] = (int *)malloc(ncolumns * sizeof(int));
```
配列の内容を連続領域に確保したい場合は，以下のようにする．
```
  int **array = (int **)malloc(nrows * sizeof(int *));
  array[0] = (int *)malloc(nrows * ncolumns * sizeof(int));
  for (i = 1; i < nrows; i++)
      array[i] = array[0] + i * ncolumns;
```
どちらの場合も通常の配列と同様にarray[i][j]でその内容をアクセスすることができる．また，2次元配列を1次元配列で以下のように疑似することができる．
```
  int *array = (int *)malloc(nrows * ncolumns * sizeof(int));
```
この場合は，array[i * ncolums + j]で配列の(i, j)要素をアクセスする必要がある．なお，上記のいずれにおいても配列が不用になったときに配列領域を解放するのを忘れないようにする必要がある．
リダイレクション
標準出力を指定したファイルにリダイレクションする．
```
  fd = open(filename, O_WRONLY, 0666);
  close(1);
  dup(fd);
  close(fd);
```
上記により，以後の標準出力への書き込みはfdで指定されるファイルへ書き込まれる．
コマンド出力の読み込み
system()関数で実行されたコマンドの出力をプログラム内に読み込むには，UNIXではpopen()関数がある．
popen(char *command, char *type)関数は，指定したプログラムファイルによるプロセスを作り，そのプロセスのstdinまたはstdoutをコールしたプログラムにパイプで連結する．
以下のコードはcommand1の出力をcommand2の入力にパイプで接続する．
```
  fpin  = popen(command1, "r");
  fpout = popen(command2, "w");
  while ((c = getc(fpin)) != EOF)
      putc(c, fpout);
  pclose(fpin);
  pclose(fpout);
```

その他

データファイル共有
データ形式（語長，バイトオーダ，浮動小数点形式）の異なる計算機間でデータファイルを共用する最善の方法は，fprintfで書き込みfscanfで読み込むようなテキストファイル(ASCII)形式を用いることである．
サブルーチンの戻り値
サブルーチンの戻り値として複数の値が必要なときには，サブルーチンが値を書き込めるポインタをパラメータとして渡すか，必要な値を含む構造体を戻り値として返す．