マクロで明らかに無意味なdo-whileおよびif-elseステートメントを使用するのはなぜですか？

多くのC / C ++マクロで、無意味なdo whileループのように見えるマクロに囲まれたマクロのコードが表示されます。以下に例を示します。

#define FOO(X) do { f(X); g(X); } while (0)
#define FOO(X) if (1) { f(X); g(X); } else

私は何をしdo whileているのか分かりません。これなしでこれを書いてみませんか？

#define FOO(X) f(X); g(X)

do ... whileそしてif ... else、あなたのマクロの後にセミコロンが常に同じことを意味するようにそれを作るためにあります。2番目のマクロのようなものがあったとしましょう。

#define BAR(X) f(x); g(x)

あなたが使用した場合、今BAR(X);ではif ... elseif文の体が中括弧に包まれていなかった声明、あなたが悪い驚きを得ると思います。

if (corge)
  BAR(corge);
else
  gralt();

上記のコードは次のように展開されます

if (corge)
  f(corge); g(corge);
else
  gralt();

これは、elseがifに関連付けられなくなったため、構文的に正しくありません。中括弧の後のセミコロンは構文的に正しくないため、マクロ内で中括弧で囲むことは役に立ちません。

if (corge)
  {f(corge); g(corge);};
else
  gralt();

問題を修正するには2つの方法があります。1つ目は、コンマを使用して、式のように機能する機能を奪わずに、マクロ内のステートメントをシーケンス処理することです。

#define BAR(X) f(X), g(X)

上記のバーのバージョンはBAR、上記のコードを次のように拡張します。これは構文的に正しいです。

if (corge)
  f(corge), g(corge);
else
  gralt();

f(X)たとえばローカル変数を宣言するために、独自のブロックに移動する必要があるより複雑なコードの本体がある場合、これは機能しません。最も一般的なケースでは、解決策はdo ... while、マクロを単一のステートメントにして、混乱することなくセミコロンを取る単一のステートメントにするようなものを使用することです。

#define BAR(X) do { \
  int i = f(X); \
  if (i > 4) g(i); \
} while (0)

あなたが使用する必要はありませんdo ... while、あなたが何かを調理することができif ... elseたときにも、同様にif ... else内部の膨張しif ... else、それが「につながるぶら下がり他に、次のコードのように、既存のダングリング他の問題はさらに困難を見つけるために作ることができました、」 。

if (corge)
  if (1) { f(corge); g(corge); } else;
else
  gralt();

ポイントは、ぶら下がっているセミコロンが誤っている状況でセミコロンを使い果たすことです。もちろん、この時点でBAR、マクロではなく実際の関数として宣言する方がよいと主張することもできます（おそらくそうすべきです）。

要約するdo ... whileと、Cプリプロセッサの欠点を回避するためにあります。それらのCスタイルガイドがCプリプロセッサを解雇するように指示するとき、これは彼らが心配しているようなものです。

マクロは、プリプロセッサが正規のコードに挿入するテキストのコピー/貼り付け部分です。マクロの作成者は、置き換えによって有効なコードが生成されることを期待しています。

これを成功させるには、3つの「ヒント」があります。

マクロが本物のコードのように動作するのを助けます

通常のコードは通常セミコロンで終わります。ユーザーがコードを必要としない場合は、コードを表示する必要があります...

doSomething(1) ;
DO_SOMETHING_ELSE(2)  // <== Hey? What's this?
doSomethingElseAgain(3) ;

これは、セミコロンがない場合、ユーザーはコンパイラーがエラーを生成することを期待することを意味します。

しかし、本当の本当に良い理由は、いつか、マクロの作者がおそらくマクロを本物の関数（おそらくインライン化）に置き換える必要があることです。したがって、マクロは実際のように動作するはずです。

したがって、セミコロンを必要とするマクロが必要です。

有効なコードを生成する

jfm3の回答に示されているように、マクロに複数の命令が含まれている場合があります。マクロがifステートメント内で使用されている場合、これは問題になります。

if(bIsOk)
   MY_MACRO(42) ;

このマクロは次のように展開できます。

#define MY_MACRO(x) f(x) ; g(x)

if(bIsOk)
   f(42) ; g(42) ; // was MY_MACRO(42) ;

g関数は、の値に関係なく実行されますbIsOk。

つまり、マクロにスコープを追加する必要があります。

#define MY_MACRO(x) { f(x) ; g(x) ; }

if(bIsOk)
   { f(42) ; g(42) ; } ; // was MY_MACRO(42) ;

有効なコードを生成する2

マクロが次のようなものである場合：

#define MY_MACRO(x) int i = x + 1 ; f(i) ;

次のコードで別の問題が発生する可能性があります。

void doSomething()
{
    int i = 25 ;
    MY_MACRO(32) ;
}

それは次のように拡張されるためです：

void doSomething()
{
    int i = 25 ;
    int i = 32 + 1 ; f(i) ; ; // was MY_MACRO(32) ;
}

もちろん、このコードはコンパイルされません。つまり、ソリューションはスコープを使用しています。

#define MY_MACRO(x) { int i = x + 1 ; f(i) ; }

void doSomething()
{
    int i = 25 ;
    { int i = 32 + 1 ; f(i) ; } ; // was MY_MACRO(32) ;
}

コードは再び正しく動作します。

セミコロン+スコープ効果を組み合わせる？

この効果を生み出すC / C ++イディオムが1つあります：do / whileループ：

do
{
    // code
}
while(false) ;

do / whileはスコープを作成できるため、マクロのコードをカプセル化し、最後にセミコロンが必要になるため、必要なコードに拡張できます。

おまけ？

C ++コンパイラーは、事後条件がfalseであるという事実がコンパイル時にわかっているため、do / whileループを最適化します。これは、次のようなマクロを意味します。

#define MY_MACRO(x)                                  \
do                                                   \
{                                                    \
    const int i = x + 1 ;                            \
    f(i) ; g(i) ;                                    \
}                                                    \
while(false)

void doSomething(bool bIsOk)
{
   int i = 25 ;

   if(bIsOk)
      MY_MACRO(42) ;

   // Etc.
}

正しく拡張されます

void doSomething(bool bIsOk)
{
   int i = 25 ;

   if(bIsOk)
      do
      {
         const int i = 42 + 1 ; // was MY_MACRO(42) ;
         f(i) ; g(i) ;
      }
      while(false) ;

   // Etc.
}

そしてコンパイルされて最適化されます

void doSomething(bool bIsOk)
{
   int i = 25 ;

   if(bIsOk)
   {
      f(43) ; g(43) ;
   }

   // Etc.
}

@ jfm3-あなたは質問に対して素晴らしい答えがあります。また、マクロイディオムは、単純な 'if'ステートメントを使用して、（エラーが発生しないため）潜在的に危険な意図しない動作を防止することも追加できます。

#define FOO(x)  f(x); g(x)

if (test) FOO( baz);

展開する：

if (test) f(baz); g(baz);

これは構文的に正しいため、コンパイラエラーは発生しませんが、g（）が常に呼び出されるという意図しない結果になる可能性があります。

上記の回答はこれらの構成要素の意味を説明していますが、言及されていない2つの構成要素には大きな違いがあります。実際には、好む理由があるdo ... whileにif ... else構築物。

構成の問題は、セミコロンを置くことを強制if ... elseしないことです。このコードのように：

FOO(1)
printf("abc");

セミコロンは（誤って）省略していますが、コードは次のように展開されます。

if (1) { f(X); g(X); } else
printf("abc");

サイレントコンパイルします（ただし、一部のコンパイラは到達できないコードに対して警告を発行する場合があります）。ただし、printfステートメントは実行されません。

do ... whileの後に有効なトークンwhile(0)はセミコロンだけなので、構文にはそのような問題はありません。

コンパイラーはdo { ... } while(false);ループを最適化することが期待されていますが、その構造を必要としない別の解決策があります。解決策はコンマ演算子を使用することです：

#define FOO(X) (f(X),g(X))

またはさらにエキゾチックに：

#define FOO(X) g((f(X),(X)))

これは個別の命令でうまく機能しますが、変数が構成され、の一部として使用される場合には機能しません#define。

#define FOO(X) (int s=5,f((X)+s),g((X)+s))

これにより、do / while構文の使用が強制されます。

Jens GustedtのP99プリプロセッサーライブラリー（そうです、そのようなものが存在するという事実も私の頭を吹き飛ばしました！）はif(1) { ... } else、次のように定義することによって、小さいながら重要な方法で構成を改善します。

#define P99_NOP ((void)0)
#define P99_PREFER(...) if (1) { __VA_ARGS__ } else
#define P99_BLOCK(...) P99_PREFER(__VA_ARGS__) P99_NOP

これの根拠は、do { ... } while(0)構成とは異なり、与えられたブロック内breakでcontinueも機能((void)0)しますが、マクロの呼び出しの後にセミコロンを省略すると、構文エラーが発生します。そうしないと、次のブロックがスキップされます。（実際には、ここでは「ぶら下がるelse」の問題はありません。これは、マクロ内のelse最も近いifにバインドしているためです。）

Cプリプロセッサで多かれ少なかれ安全に実行できる種類のことに興味があるなら、そのライブラリをチェックしてください。

いくつかの理由で、最初の回答についてコメントすることはできません...

ローカル変数を使用してマクロを表示した人もいましたが、マクロで名前を使用するだけではだめだと言った人はいませんでした。いつかユーザーを噛みます！どうして？入力引数がマクロテンプレートに代入されるためです。また、マクロの例では、おそらく最も一般的に使用される変数名iを使用しています。

たとえば、次のマクロ

#define FOO(X) do { int i; for (i = 0; i < (X); ++i) do_something(i); } while (0)

次の関数で使用されます

void some_func(void) {
    int i;
    for (i = 0; i < 10; ++i)
        FOO(i);
}

マクロは、some_funcの先頭で宣言されている目的の変数iを使用しませんが、マクロのdo ... whileループで宣言されているローカル変数を使用します。

したがって、マクロでは一般的な変数名を使用しないでください。

説明

do {} while (0)そしてif (1) {} else、マクロが1つだけの命令に展開されていることを確認しています。さもないと：

if (something)
  FOO(X); 

次のように拡張されます：

if (something)
  f(X); g(X); 

そしてg(X)、if制御ステートメントの外で実行されます。これはdo {} while (0)、およびを使用する場合は回避されif (1) {} elseます。

より良い代替案

GNU ステートメント式（標準Cの一部ではない）を使用すると、以下を使用するだけで、これを解決するよりも優れた方法がdo {} while (0)あります。if (1) {} else({})

#define FOO(X) ({f(X); g(X);})

そして、この構文は次のように戻り値と互換性があります（そうでdo {} while (0)はないことに注意してください）。

return FOO("X");

言及されたとは思わないので、これを検討してください

while(i<100)
  FOO(i++);

に翻訳されます

while(i<100)
  do { f(i++); g(i++); } while (0)

i++マクロによって2回評価される方法に注意してください。これにより、いくつかの興味深いエラーが発生する可能性があります。