変数のシャドウイング

入れ子にされたスコープで変数が同じ名前の別の変数を隠す

説明

この欠陥は、変数が同じ名前の別の変数を外側のスコープ内に隠している場合に発生します。

たとえば、ローカル変数の名前がグローバル変数と同じ名前である場合、ローカル変数はその有効期間の間、グローバル変数を隠します。

Polyspace^® は、構造体バインディングの _ という名前の変数について欠陥を報告しません。多くの場合、この名前の変数はプレースホルダーです。

リスク

内側のスコープと外側のスコープに同じ名前の 2 つの変数が存在する場合、その変数名を参照すると、内側のスコープの変数が使用されます。しかし、開発者またはコード レビュー担当者は、外側のスコープの変数が使用されるという誤った想定をする可能性があります。

修正方法

修正方法は欠陥の根本原因によって異なります。たとえば、関数をリファクタリングして、ローカルの静的変数をグローバル変数の代わりに使用するとします。この場合、グローバル変数は冗長であり、その宣言を削除できます。または、グローバル変数が他の場所で使用されているか不明な場合、ローカルの静的変数の名前とその関数内のすべての参照を変更できます。

シャドウイングが意図したもので、問題を修正しない場合は、改めてレビューされないように結果またはコードにコメントを追加します。詳細は、以下を参照してください。

• Polyspace ユーザー インターフェイスでのバグ修正または正当化による結果への対処 (Polyspace ユーザー インターフェイスで結果をレビューする場合)。

• Polyspace Access でのバグ修正または正当化による結果への対処 (Polyspace Access) (Web ブラウザーで結果をレビューする場合)。

• コードへの注釈付けと既知の結果または許容可能な結果の非表示 (IDE で結果をレビューする場合)

例

変数のシャドウイング エラー

#include <stdio.h>

int fact[5]={1,2,6,24,120};

int factorial(int n)
 {
  int fact=1; 
  /*Defect: Local variable hides global array with same name */

  for(int i=1;i<=n;i++)
    fact*=i;

  return(fact);
 }

関数 factorial 内で、整数変数 fact がグローバル整数配列 fact を隠しています。

修正 — 変数名を変更

1 つの修正方法として、いずれかの変数、できればよりローカルなスコープをもつ変数の名前を変更することができます。

#include <stdio.h>

int fact[5]={1,2,6,24,120};

int factorial(int n)
 {
  /* Fix: Change name of local variable */
  int f=1; 

  for(int i=1;i<=n;i++)
    f*=i;

  return(f);
 }

結果情報

グループ: データ フロー

言語: C | C++

既定値: 手書きコードはオン、生成コードはオフ

コマンド ライン構文: VAR_SHADOWING

影響度: Low

バージョン履歴

R2013b で導入

R2025a: チェッカーはデータ メンバーと同じ名前を持つ static メンバー関数のローカル変数にフラグを設定しない

チェッカーは、C++ クラスの static メンバー関数内のローカル変数が同じクラスの非静的データ メンバーと同じ名前を持つ場合に欠陥を表示しなくなりました。非静的データ メンバーには静的メンバー関数内からアクセスできないので、その関数内のローカル変数を非静的データ メンバーより優先することはできません。

たとえば、チェッカーはデータ メンバー error と同じ名前を持つ static メンバー関数 createError 内のローカル変数 error について欠陥を報告しません。

class validateResult {.
    int error;
    static void createError(int error) { 
        
    }
};

R2024b: チェッカーは構造体バインディングの _ という名前の変数について欠陥を報告しない

Polyspace は、構造体バインディングの _ という名前の変数について欠陥を報告しなくなりました。多くの場合、この名前の変数はプレースホルダーです。以下に例を示します。

struct my_inner_struct {
    int i;
    int j;
};

struct my_struct {
    int a;
    my_inner_struct b;
};

void exampleA(const my_struct s) {
    auto [_, b] = s; 		    // Compliant
    {
        auto [_, j] = b; 	    // Compliant
    }
}

参考

欠陥の検出 (-checkers)

トピック

• Polyspace デスクトップ ユーザー インターフェイスでの Bug Finder の結果の解釈
• Polyspace Access Web インターフェイスでの Bug Finder の結果の解釈 (Polyspace Access)
• Polyspace ユーザー インターフェイスでのバグ修正または正当化による結果への対処
• Polyspace Access でのバグ修正または正当化による結果への対処 (Polyspace Access)