Copy constructor

A copy constructor is a special constructor in the C++ programming language used to create a new object as a copy of an existing object. The first argument of such a constructor is a reference to an object of the same type as is being constructed (const or non-const), which might be followed by parameters of any type (all having default values).

Normally the compiler automatically creates a copy constructor for each class (known as a default copy constructor) but for special cases the programmer creates the copy constructor, known as a user-defined copy constructor. In such cases, the compiler does not create one.

A user-defined copy constructor is generally needed when an object owns pointers or non-shareable references, such as to a file, in which case a destructor and an assignment operator should also be written (see Rule of three).

Definition

Copying of objects is achieved by the use of a copy constructor and a copy assignment operator. A copy constructor has as its first parameter a (possibly const or volatile) reference to its own class type. It can have more arguments, but the rest must have default values associated with them.^[1] The following would be valid copy constructors for class X: <source lang="cpp"> X(const X& copyFromMe); X(X& copyFromMe); X(const volatile X& copyFromMe); X(volatile X& copyFromMe); X(const X& copyFromMe, int = 10); X(const X& copyFromMe, double = 1.0, int = 40); </source> The first one should be used unless there is a good reason to use one of the others. One of the differences between the first and the second is that temporaries can be copied with the first. For example: <source lang="cpp"> X a = X(); // valid if you have X(X const& copyFromMe) but not valid if you have X(X& copyFromMe)

              // because the second wants a non-const X&
              // to create a, the compiler first creates a temporary by invoking the default constructor of X,
              // then uses the copy constructor to initialize a as a copy of that temporary. 
              // However, for some compilers both the first and the second actually work.

</source> Another difference between them is the obvious: <source lang="cpp"> X const a; X b = a; // valid if you have X(X const& copyFromMe) but not valid if you have X(X& copyFromMe)

              // because the second wants a non-const X&

</source> The X& form of the copy constructor is used when it is necessary to modify the copied object. This is very rare but it can be seen used in the standard library's std::auto_ptr. A reference must be provided: <source lang="cpp"> X a; X b = a; // valid if any of the copy constructors is defined

              // since you're passing in a reference

</source> The following are invalid copy constructors: <source lang="cpp"> X(X copyFromMe); X(const X copyFromMe); </source> because the call to those constructors would require a copy as well, which would result in an infinitely recursive call.

The following cases may result in a call to a copy constructor:

When an object is returned by value
When an object is passed (to a function) by value as an argument
When an object is thrown
When an object is caught
When an object is placed in a brace-enclosed initializer list

These cases are collectively called copy-initialization and are equivalent to:^[2] T x = a;

It is however, not guaranteed that a copy constructor will be called in these cases, because the C++ Standard allows the compiler to optimize the copy away in certain cases, one example being the return value optimization (sometimes referred to as RVO).

Operation

An object can be assigned value using one of the two techniques:

Explicit assignment in an expression
Initialization

Explicit assignment in an expression

<source lang="cpp"> Object A; Object B; A = B; // translates as Object::operator=(const Object&), thus A.operator=(B) is called

            // (invoke simple copy, not copy constructor!)

</source>

Initialization

An object can be initialized by any one of the following ways.

a. Through declaration <source lang="cpp">Object B = A; // translates as Object::Object(const Object&) (invoke copy constructor)</source> b. Through function arguments <source lang="cpp">type function (Object a);</source> c. Through function return value <source lang="cpp">Object a = function();</source>

The copy constructor is used only in latter case (initializations) and does not apply to assignments where the assignment operator is used instead.

The implicit copy constructor of a class calls base copy constructors and copies its members by means appropriate to their type. If it is a class type, the copy constructor is called. If it is a scalar type, the built-in assignment operator is used. Finally, if it is an array, each element is copied in the manner appropriate to its type.^[3]

By using a user-defined copy constructor the programmer can define the behavior to be performed when an object is copied.

Examples

These examples illustrate how copy constructors work and why they are required sometimes.

Implicit copy constructor

Let us consider the following example. <source lang="cpp">

include <iostream>

class Person {

   public:
   
   int age;

   explicit Person(int age)
     : age(age) {}

};

int main() {

   Person timmy(10);
   Person sally(15);

   Person timmy_clone = timmy;

   std::cout << timmy.age << " " << sally.age << " " << timmy_clone.age << std::endl;

   timmy.age = 23;

   std::cout << timmy.age << " " << sally.age << " " << timmy_clone.age << std::endl;

} </source> Output

10 15 10
23 15 10

As expected, timmy has been copied to the new object, timmy_clone. While timmy's age was changed, timmy_clone's age remained the same. This is because they are totally different objects.

The compiler has generated a copy constructor for us, and it could be written like this: <source lang="cpp"> Person(const Person& copy)

 : age(copy.age) {}

</source> So, when do we really need a user-defined copy constructor? The next section will explore that question.

User-defined copy constructor

Now, consider a very simple dynamic array class like the following: <source lang="cpp">

include <iostream>

class Array {

 public:
   int size;
   int* data;

   explicit Array(int size)
       : size(size), data(new int[size]) {}

   ~Array() 
   {
       delete[] data;
   }

};

int main() {

   Array first(20);
   first.data[0] = 25;

   {
       Array copy = first;

       std::cout << first.data[0] << " " << copy.data[0] << std::endl;

   }    // (1)

   first.data[0] = 10;    // (2)

} </source> Output

25 25
Segmentation fault

Since we did not specify a copy constructor, the compiler generated one for us. The generated constructor would look something like: <source lang="cpp"> Array(const Array& copy)

 : size(copy.size), data(copy.data) {}

</source> The problem with this constructor is that it performs a shallow copy of the data pointer. It only copies the address of the original data member; this means they both share a pointer to the same chunk of memory, which is not what we want. When the program reaches line (1), copy's destructor gets called (because objects on the stack are destroyed automatically when their scope ends). Array's destructor deletes the data array of the original, therefore when it deleted copy's data, because they share the same pointer, it also deleted first's data. Line (2) now accesses invalid data and writes to it! This produces the famous segmentation fault.

If we write our own copy constructor that performs a deep copy then this problem goes away. <source lang="cpp"> Array(const Array& copy)

 : size(copy.size), data(new int[copy.size])

{

   std::copy(copy.data, copy.data + copy.size, data);    // #include <algorithm> for std::copy

} </source> Here, we are creating a new int array and copying the contents to it. Now, copy's destructor only deletes its data and not first's data as well. Line (2) will not produce a segmentation fault anymore.

Instead of doing a deep copy right away, there are some optimization strategies that can be used. These allow you to safely share the same data between several objects, thus saving space. The copy on write strategy makes a copy of the data only when it is written to. Reference counting keeps the count of how many objects are referencing the data, and will delete it only when this count reaches zero (e.g. boost::shared_ptr).