Macro typology - ytomino/headmaster GitHub Wiki

C言語で、#defineの実際の使われ方を分類したもの。Cのヘッダを読むトランスレータ(未完)を書いているときに見つけたこれは酷い集と思っていただければ。 良い例とか悪い例とか分けているつもりはなくて、全部悪い例のつもりです。

#define HAS_FUNC
...
#ifdef HAS_FUNC
...
#endif

一番よくある使い方。 多重#include防止には必須ですが……。

よくある間違いとしては、configureの生成したHAVE_XXXを#ifdefで使ってしまうなど。(無いときも 0 で定義される)

#define TARGET 100
...
#if defined(TARGET) && TARGET >= 105
...
#endif

Windows APIやLinuxのヘッダー等に見られます。 対象とするOSのバージョンなんかを外から指定できるようになっているわけですね。 ちなみに前にdefinedが入っているのは気が利いている方です。

#define HAS_FUNC 1
...
#if HAS_FUNC
...
#endif

確かにこれでも正しく動くは動く。 ただし 0 に#defineされると条件が偽になるので注意。実害はあまりない。 mcpp等の気の利いたプリプロセッサはオプションによって、未定義シンボルを0に評価したとき警告を出せます。

#define TARGET 100
...
#if defined(TARGET)
...
#endif
...
#if TARGET >= 105
...
#endif
...
#if TARGET
...
#endif

混在されている。#defineされる内容次第ではちぐはぐになってしまう。でもやっぱり実害はあまりないことが多い。 大抵は理由もなく不統一なだけ。揃えてください……。

#define FOR_INCLUDE_HEADER <are.h>
...
#include FOR_INCLUDE_HEADER

mcppのドキュメントでもけなされてた使い方ですが……字句解析の時点で < are . h > に分解されるはずなんですよね、これ。 で、# がないので、間にスペースが入っていると解釈されるはずなんですよね。 プリプロセッサの中の人も大変です。 ダブルクオーテーションの#includeでもシステムのヘッダーは探してくれますので、 #define FOR_INCLUDE_HEADER "are.h" で何の問題もないはずです。

#define VALUE 100

普通の使い方ではあるのですが、実はこの時点でもう酷い。 マクロ全般に言えることですが、VALUEという名前のローカル変数を宣言できなくなってしまいます。 条件コンパイル用のシンボルは大抵被らないようにヘッダ名などで装飾されていますが、定数値は「よくある名前」が大量に押さえられていることも多く。 仮にC++を使っていても、namespaceすら無視される凶悪具合。 enumかconstを使いましょう……。

#define VALUE 100 + 200

式になっているのに括弧がついていないため、 VALUE * 2 なんて使われると意図しない値になってしまいます。 これでも、使う側で括弧を補えば回避可能なため、マシな方。 ちゃんと括弧を……ではなくて、enumかconstを……。

#define VALUE \
    | A \
    | B \
    | C

演算子を綺麗に揃えてはいるのですが、Aの頭の | が余計です。 マクロは使われるまで構文チェックが入らないですからね……。定数を大量に宣言しているヘッダーの場合、全部確認されてないことも多く。 類型で、括弧の数が合っていない、等。 enumかconstなら使わなくても構文チェックは入るのに……。

#define ZERO_POINT {0, 0}

使い方は struct point p = ZERO_POINT; 。 初期化部分に書かないとエラーですね。 C99ならcompound literalとして (struct point){0, 0} と書いたほうが、初期化以外の式中でも使えますし、型もわかってトランスレータにも嬉しいし、いいことずくめですよ。

#define ADD(a, b) ((a) + (b))

普通の使い方ではあるのですが、実はこの時点で(ry ところで折角C言語にもinlineが入ったんですから全面的に書き直しましょうよ……。

#define offsetof(T, FIELD) ((char *)&((T *)0)->FIELD - (char *)0)

offsetofが典型ですが、バリエーションもいくつかあります。 トリックめいてますが仕方ないのでしょうか。

#define COMPARE(A, OP, B) (func(A) OP func(B))

使い方は COMPARE(10, >=, 5) のように二項演算子を渡します。 C言語が演算子を関数と別物として扱ってるのがいけないんや。部分適用が無いのがいけないんや。 ……でも綺麗に書くなら inline bool LE(int a, int b){ return a < b; } みたいなものを一揃い用意してあげるべきと思います。

#define func(a) func_impl((void *)a, sizeof(a))

inline関数として書き直せない例。 複数種類の構造体を受け付ける関数とか、構造体のフィールドが追加されても互換性を取るとか、理由はあるんだと思います。 型を付けられないのでトランスレータの敵。

#define LSHIFT8(V) V##00

LSHIFT8(0x12) みたいに使うらしいです。 なんで (V) << 8 ではダメなんでしょうか……。 私には理解できません。

#define funcAB(a, b) do { funcA(a); funcB(b); } while(0)

最後の ; が無いのがポイント。 ところで折角C言語にもinlineが入ったんですから全面的に書き直しましょうよ……。

#define funcAB(a, b) do { funcA(a); funcB(b); } while(0);

if文で使うとelseが続けられなくなります。 inline関数ならこんなミスもしないのに……。

extern int add10(int a);
#define add10(a) ((a) + 10)

関数アドレスも取りたいけれど、インライン展開もしたいという使い方ですね。 引数ありマクロを引数なしで使うと展開されないことを利用しています。 ところでC99以降ならインライン関数を普通に inline とだけ宣言すれば、同様の効果を得られますよ。gccなら extern inline __atteribute__((__gnu_inline__)) で。

void f(void);
void custom_f(void);
#define f custom_f

何らかの追加処理が必要なときに既存関数を乗っ取る方法。 正統なやり方としては、ちゃんと元関数にフックを仕掛けられるようにしてもらうべきですね。 こんなので済ましていたら絶対漏れが出ます。 mainを乗っ取るのが最凶パターン。SDLなど。

#define T int

割と見ますが、やっぱりこの時点でかなり酷いことは確かです。 typedefを使いましょう。

#define CONST const

constのない古いコンパイラに対応してくれてるんでしょうね……。 constなら最近はサポートしてないコンパイラなんて無いでしょうから直接constと書け、で済みますが、restrictなんかは、まあ、同情できなくもないです。 でも暗黙のintルールが絡んだりすると迷惑なマクロには違いなく。 complex.hの #define complex _Complex はcomplexを直接予約語にしたくないがためにわざわざこれをやってるパターン。

#define CONST(T) const T

用途としては同上。 関数宣言に__stdcallを付加したり、いろいろ。 基本的にはソースを読みにくくしてるだけと思われます。わざわざ関数マクロにしなくても、上の引数なしのパターンにできるならそっちの方がマシな気がします。何よりトランスレータにとっては引数なしの方が扱いやすいので……。

#define T int *

C言語の構文を理解しているかの有名な踏み絵。

declaration-specifiersに収まってません。 こんなの説明したくないんですが…… T a, b; という風に使うとですね……。 気づきにくいだけ罠になります。 typedefを使いましょう。

#define EXTERN extern

ライブラリ本体のソースを.dllとしてコンパイルするときは__declspec(dllexport)に#defineし直して使ったり。

... //特に#ifとかはなし
#define IMPORT __declspec(dllimport)

マクロだけあって実際には使われてなかったりします。 ごくまれにあったりする。

#define PARAMS bool a, const char * b, int c

あるんですよ……これが……。 条件コンパイルによって引数を増減させるようなデザインはやらないでくださいね……。型を変えたいだけならtypedefで充分ですし。

#define THOSE_VALUE 100
...
#define THESE_VALUE THOSE_VALUE

別の関数やマクロに別名を与える例。 繰り返しますがtypedef, enum, const, インライン関数で代替できるものはそちらを使ってください……。

struct S {
    int the_field_name;
};
#define old_field_name the_field_name

実際の構造は変化させつつも互換性を保つ目的ですね。 広く使われていて今更アクセサ関数を使ってもらうようにできないなど、理由はありそうですが、こんなことを続けていてもそのうち破綻しそうな……。

#ifdef HAS_THOSE
#define THOSE_VALUE 100
#endif
...
#define THESE_VALUE THOSE_VALUE

元のやつが条件によっては定義されないのに、別名は常に定義される。 結構あるんです……。

... //THOSE_VALUEは別ヘッダ
#define THESE_VALUE THOSE_VALUE

上のバリエーション。 常にふたつセットで#includeを書いていたりして気付かないことも多いと思います。 ヘッダファイルは単独で読まれた場合でもコンパイルできるように書いていただけたら嬉しいなあ、とは思うんですが……マクロの場合チェックが難しいんですよね。使ってみるしかない。 やはり可能な限りtypedef, enum, const, インライン関数(ry

#define LONG_NAME_MACRO 100
...
#define SHORT_ALIAS LONG_NAMAE_MACRO

いろいろ大量に宣言しているヘッダーの場合、全部確認されてないことも多く……以下略。

#define _T(text) L##text

windows.hの有名なやつですね。 他には整数定数にULLをくっつけたり等。

#define static_assert(a) typedef int SA##__LINE__ [a ? 1 : -1];

中身はなんでもいいんですが、要するに0を渡したらコンパイルエラーになるコードですね。 C11からは_Static_assertが使えます。

glibcの<sys/sysmacros.h>から抜粋。

#define __SYSMACROS_DM(symbol) __SYSMACROS_DM1 \
 (In the GNU C Library, #symbol is defined\n\
  by <sys/sysmacros.h>. For historical compatibility, it is\n\
  currently defined by <sys/types.h> as well, but we plan to\n\
  remove this soon.  To use #symbol, include <sys/sysmacros.h>\n\
  directly.  If you did not intend to use a system-defined macro\n\
  #symbol, you should undefine it after including <sys/types.h>.)

任意のエラーメッセージを出力するために\nをリテラルの外に書いています。そんなに世の中が憎いのですかって感じですね。末期症状です。 素直に_Static_assertを使いましょう。

詳しくは書きませんがトリッキーなマクロの嵐。 誰だよこんなの標準に入れた馬鹿は……。こんなの採用するなら素直にオーバーロードを入れてくださいよ。

ちなみにclangではC言語でもオーバーロードが使えて、tgmath.hはそれで実現されています。

委細省略。

委細省略。