CERT C++: OOP58-CPP

Copy operations must not mutate the source object

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

説明

ルール定義

コピー操作によってソースオブジェクトが変化してはなりません。¹

Polyspace 実装

ルールチェッカーは、"ソースオペランドを変更するコピー操作" をチェックします。

例

すべて展開する

ソースオペランドを変更するコピー操作

問題

ソースオペランドを変更するコピー操作は、コピーコンストラクターまたはコピー代入演算子によってそのソースオペランドの変更可能なデータメンバーが変更されると発生します。

たとえば、次のコピーコンストラクター A はそのソースオペランド other のデータメンバー m を変更します。

class A {
  mutable int m;
   
public:
 ...
  A(const A &other) : m(other.m) {
    other.m = 0; //Modification of source
  }
}

リスク

コピーコンストラクター (またはコピー代入演算子) を使用した次のようなコピー操作があります。

className new_object = old_object; //Calls copy constructor of className

これは、そのソースオペランド old_object をコピー先のオペランド new_object にコピーします。操作後、コピー先のオペランドは未変更のソースオペランドのコピーになっていると想定されます。ソースオペランドがコピー中に変更されている場合、この想定に反することになります。

修正方法

コピー操作でソースオペランドを変更しないようにします。

移動操作を実装するためにコピーコンストラクターでソースオペランドを変更する場合は、移動コンストラクターを代わりに使用します。移動コンストラクターは C++11 規格以降で定義されます。

例 - ソースを変更するコピーコンストラクター


#include <algorithm>
#include <vector>
 
class A {
  mutable int m;
   
public:
  A() : m(0) {}
  explicit A(int m) : m(m) {}
   
  A(const A &other) : m(other.m) {
    other.m = 0; //Noncompliant
  }
   
  A& operator=(const A &other) {
    if (&other != this) {
      m = other.m;
      other.m = 0; //Noncompliant //Noncompliant
    }
    return *this;
  }
   
  int get_m() const { return m; }
};
 
void f() {
  std::vector<A> v{10};
  A obj(12);
  std::fill(v.begin(), v.end(), obj);
}

この例では、A 型の 10 個のオブジェクトのベクトルを作成しています。関数 std::fill は、値 12 のデータメンバーをもつ A 型のオブジェクトを、10 個の各オブジェクトにコピーします。この操作後、ベクトル内の 10 個のオブジェクトすべてが値 12 のデータメンバーをもつと想定するかもしれません。

しかし、最初のコピーによってソースのデータメンバーの値が 0 に変更されます。残りの 9 回のコピーではこの値がコピーされます。std::fill 呼び出しの後、ベクトル内の最初のオブジェクトは値 12 のデータメンバーをもち、残りのオブジェクトは値 0 のデータメンバーをもちます。

修正 — ソースの変更に移動コンストラクターを使用

コピーコンストラクターまたはコピー代入演算子でソースオペランドのデータメンバーを変更しないようにします。クラスで移動操作を行う場合、コピーコンストラクターではなく移動コンストラクターを使用します。

この修正例では、クラス A のコピーコンストラクターおよびコピー代入演算子ではデータメンバー m を変更していません。別の移動コンストラクターでソースオペランドを変更しています。


#include <algorithm>
#include <vector>
 
class A {
  int m;
   
public:
  A() : m(0) {}
  explicit A(int m) : m(m) {}
   
  A(const A &other) : m(other.m) {}
  A(A &&other) : m(other.m) { other.m = 0; }
   
  A& operator=(const A &other) {
    if (&other != this) {
      m = other.m;
    }
    return *this;
  }
  
  //Move constructor
  A& operator=(A &&other) {
    m = other.m;
    other.m = 0;
    return *this;
  }
   
  int get_m() const { return m; }
};
 
void f() {
  std::vector<A> v{10};
  A obj(12);
  std::fill(v.begin(), v.end(), obj);
}

チェック情報

グループ: 09.オブジェクト指向プログラミング (OOP)

バージョン履歴

R2019a で導入

参考

SEI CERT-C++ をチェック (-cert-cpp)

トピック

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

外部の Web サイト

OOP58-CPP

¹ 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.