CERT C: Rec.PRE11-C

マクロ定義をセミコロンで終了しない

このページをすべて展開する

説明

ルール定義

マクロ定義をセミコロンで終了しないようにします。1

Polyspace 実装

ルール チェッカーは、"セミコロンで終了するマクロ" をチェックします。

例

すべて展開する

問題

[セミコロンで終了するマクロ] は、1 回以上呼び出されたマクロにセミコロンで終了する定義が含まれている場合に発生します。

リスク

マクロ定義がセミコロンで終了している場合は、マクロ展開が式の内部などの特定のコンテキストでの意図しないプログラム ロジックにつながる可能性があります。

たとえば、次のマクロを考えてみましょう。

#define INC_BY_ONE(x) ++x;
次の式で使用された場合は、
res = INC_BY_ONE(x)%2;
式が次のように解決されます。 
res = ++x; %2;
x+1 の値が res に代入されますが、これは意図されていない可能性があります。残りのスタンドアロン ステートメント %2; は有効な C コードであり、厳密なコンパイラ警告を有効にしない限り検出されません。

修正方法

マクロ定義をセミコロンで終了しないようにします。マクロの後ろにセミコロンを付けるかどうかはユーザーに任せてください。

または、セミコロンで終わるステートメントを含む関数形式マクロより、インライン関数を使用します。

例 – マクロ定義内の誤ったセミコロン
#define WHILE_LOOP(n) while(n>0); //Noncompliant

void performAction(int timeStep);

void main() {
    int loopIter = 100;
    WHILE_LOOP(loopIter) {
        performAction(loopIter);
        loopIter--;
    }
}

この例では、マクロ WHILE_LOOP(n) の定義がセミコロンで終わっているため、不具合が発生します。このセミコロンがあるため、while ループの本体が空になり、後続のステートメントが 1 回しか実行されません。ループは 100 回実行されるように想定されていました。

修正 – マクロ定義からセミコロンを削除する

マクロ定義から末尾のセミコロンを削除します。マクロのユーザーは、必要に応じてマクロの後ろにセミコロンを追加できます。この例では、セミコロンは必要ありません。

#define WHILE_LOOP(n) while(n>0)

void performAction(int timeStep);

void main() {
    int loopIter = 100;
    WHILE_LOOP(loopIter) {
        performAction(loopIter);
        loopIter--;
    }
}

チェック情報

グループ: Rec.01.プリプロセッサ (PRE)

バージョン履歴

R2020a で導入

参考

トピック

外部の Web サイト

1 This software has been created by MathWorks incorporating portions of: the “SEI CERT-C Website,” © 2017 Carnegie Mellon University, the SEI CERT-C++ Web site © 2017 Carnegie Mellon University, ”SEI CERT C Coding Standard – Rules for Developing safe, Reliable and Secure systems – 2016 Edition,” © 2016 Carnegie Mellon University, and “SEI CERT C++ Coding Standard – Rules for Developing safe, Reliable and Secure systems in C++ – 2016 Edition” © 2016 Carnegie Mellon University, with special permission from its Software Engineering Institute.

ANY MATERIAL OF CARNEGIE MELLON UNIVERSITY AND/OR ITS SOFTWARE ENGINEERING INSTITUTE CONTAINED HEREIN IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.

This software and associated documentation has not been reviewed nor is it endorsed by Carnegie Mellon University or its Software Engineering Institute.