AUTOSAR C++14 Rule M7-1-2

A pointer or reference parameter in a function shall be declared as pointer to const or reference to const if the corresponding object is not modified

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

説明

ルール定義

A pointer or reference parameter in a function shall be declared as pointer to const or reference to const if the corresponding object is not modified

根拠

関数シグネチャのベストプラクティスは、パラメーターでオブジェクトを関数に渡した場合に、そのオブジェクトが変更されるかどうかを明確に伝えることです。次の関数シグネチャについて考えます。

void foo(const in&);
void bar(int&);

ここでは、foo() が const の参照として整数を受け入れます。これにより、入力参照が foo() によって変更されないことが明確に伝わります。bar() のシグネチャからは、入力参照が変更されるかどうかが明確ではありません。

このルールに準拠するには、名前付きポインターまたは参照パラメーターの型を const で修飾します。例外として、一連のオーバーライド関数のうちのいずれかによってパラメーターが変更される場合、このルールは適用されません。

Polyspace 実装

チェッカーは、基になるオブジェクトが関数本体で変更されない場合、const でないポインターパラメーターにフラグを設定します。

ポインターパラメーターが const でない参照またはポインターとして別の関数に渡される場合、チェッカーは、そのパラメーターは変更される可能性があると想定します。このようなパラメーターは違反として報告されません。

トラブルシューティング

ルール違反が想定されるものの、Polyspace^® から報告されない場合は、コーディング規約違反が想定どおりに表示されない理由の診断を参照してください。

例

すべて展開する

変更されない非 `const` ポインターパラメーター

この例では、パラメーター *b および *c が関数内で変更されず、const として修飾されていません。Polyspace は、このルールに対する違反を報告します。

void sum(int *a, int *b, int *c, const int *d) { //Noncompliant
	*a = *b + *c + *d;

}

チェック情報

グループ: 宣言

カテゴリ: Required、Automated

バージョン履歴

R2019a で導入

すべて展開する

R2024b: オーバーライド関数によってパラメーターが変更される場合、違反は報告されない

バーチャル関数で使用している const でない参照パラメーターが、そのオーバーライド関数のいずれかによって変更される場合、Polyspace はこのバーチャル関数に対してこのルールの違反を報告しません。

R2024a: チェッカーが可変個引数関数の呼び出しを正しく処理する

ポインターパラメーターがさらに可変個引数関数に渡される場合、ルールチェッカーはポインターパラメーターに対して違反を報告しません。その理由は、このようなポインターを const へのポインターとして宣言できない可能性があるためです。たとえば以下の例では、チェッカーは関数 fill_buffer() のポインターパラメーター buff に対して違反を報告しません。これは、このパラメーターがさらに関数 snprintf() に渡され、この関数によってポインター値が変更される可能性があるためです。

#include <cstdlib>
#include <cstdio>


int fill_buffer(char * const buff, const size_t sizeOfBuff){
    const int id = rand() % sizeOfBuff;
    return ::snprintf(buff, sizeOfBuff, "%d", id);
}

以前は、snprintf() などの可変個引数関数が正しく処理されなかったために、違反が報告されました。

参考

AUTOSAR C++14 をチェック (-autosar-cpp14)

トピック

コーディング規約違反のチェックおよびレビュー