Difference between revisions of "cpp/language/copy initialization"
m (no need to #include everything for inline code fragments) |
(Link update.) |
||
(20 intermediate revisions by 11 users not shown) | |||
Line 1: | Line 1: | ||
− | {{title| | + | {{title|Copy-initialization}} |
{{cpp/language/initialization/navbar}} | {{cpp/language/initialization/navbar}} | ||
− | Initializes an object from another object | + | Initializes an object from another object. |
===Syntax=== | ===Syntax=== | ||
− | |||
{{sdsc begin}} | {{sdsc begin}} | ||
− | {{sdsc | num=1 | {{spar|T}} {{spar|object}} {{ttb| | + | {{sdsc|num=1|{{spar|T}} {{spar|object}} {{ttb|1==}} {{spar|other}}{{ttb|;}}}} |
− | {{sdsc | num=2 | notes={{mark until c++11}} | {{spar|T}} {{spar|object}} {{ttb| | + | {{sdsc|num=2|notes={{mark until c++11}}|{{spar|T}} {{spar|object}} {{ttb|1==}} {{ttb|{}}{{spar|other}}{{ttb|};}}}} |
− | {{sdsc | num=3 | {{spar|f}}{{ttb|(}}{{spar|other}}{{ttb|)}} }} | + | {{sdsc|num=3|{{spar|f}}{{ttb|(}}{{spar|other}}{{ttb|)}}}} |
− | {{sdsc | num=4 | {{ttb|return}} {{spar|other}}{{ttb|;}} }} | + | {{sdsc|num=4|{{ttb|return}} {{spar|other}}{{ttb|;}}}} |
− | {{sdsc | num=5 | {{ttb|throw }}{{spar|object}}{{ttb|;}} | + | {{sdsc|num=5|{{ttb|throw }}{{spar|object}}{{ttb|;}} |
− | {{ttb|catch (}}{{spar|T}} {{spar|object}}{{ttb|)}} }} | + | {{ttb|catch (}}{{spar|T}} {{spar|object}}{{ttb|)}}}} |
− | {{sdsc | num=6 | {{spar|T}} {{spar|array}}{{ttb|[}}{{spar|N}}{{ttb|] | + | {{sdsc|num=6|{{spar|T}} {{spar|array}}{{ttb|[}}{{spar|N}}{{ttb|1=] = {}}{{spar|other-sequence}}{{ttb|};}}}} |
{{sdsc end}} | {{sdsc end}} | ||
===Explanation=== | ===Explanation=== | ||
+ | Copy-initialization is performed in the following situations: | ||
+ | @1@ When a named variable (automatic, static, or thread-local) of a non-reference type {{tt|T}} is declared with the initializer consisting of an equals sign followed by an expression. | ||
+ | @2@ {{mark until c++11}} When a named variable of a scalar type {{tt|T}} is declared with the initializer consisting of an equals sign followed by a brace-enclosed expression (Note: as of C++11, this is classified as {{rlp|list initialization}}, and narrowing conversion is not allowed). | ||
+ | @3@ When {{rlp|operator other#Built-in function call operator|passing an argument}} to a function by value. | ||
+ | @4@ When {{rlp|return|returning}} from a function that returns by value. | ||
+ | @5@ When {{rlp|throw|throwing}} or {{rlp|catch|catching}} an exception by value. | ||
+ | @6@ As part of {{rlp|aggregate initialization}}, to initialize each element for which an initializer is provided. | ||
− | + | The effects of copy-initialization are: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | The effects of copy initialization are: | + | |
{{rev begin}} | {{rev begin}} | ||
{{rev|since=c++17| | {{rev|since=c++17| | ||
− | * First, if {{tt|T}} is a class type and the initializer is a {{rlp|value category|prvalue}} expression whose cv-unqualified type is the same class as {{tt|T}}, the initializer expression itself, rather than a temporary materialized from it, is used to initialize the destination object: see {{rlp|copy elision}} | + | * First, if {{tt|T}} is a class type and the initializer is a {{rlp|value category|prvalue}} expression whose cv-unqualified type is the same class as {{tt|T}}, the initializer expression itself, rather than a temporary materialized from it, is used to initialize the destination object: see {{rlp|copy elision}}. |
}} | }} | ||
{{rev end}} | {{rev end}} | ||
− | * | + | * Otherwise, if {{tt|T}} is a class type and the cv-unqualified version of the type of {{spar|other}} is {{tt|T}} or a class derived from {{tt|T}}, the {{rlp|converting constructor|non-explicit constructors}} of {{tt|T}} are examined and the best match is selected by overload resolution. That constructor is then called to initialize the object. |
− | * | + | * Otherwise, if {{tt|T}} is a class type, and the cv-unqualified version of the type of {{spar|other}} is not {{tt|T}} or derived from {{tt|T}}, or if {{tt|T}} is non-class type, but the type of {{spar|other}} is a class type, {{rlp|implicit cast|user-defined conversion sequences}} that can convert from the type of {{spar|other}} to {{tt|T}} (or to a type derived from {{tt|T}} if {{tt|T}} is a class type and a conversion function is available) are examined and the best one is selected through overload resolution. The result of the conversion, which is a {{rev inl|until=c++11|rvalue temporary}}{{rev inl|since=c++11|until=c++17|prvalue temporary}}{{rev inl|since=c++17|prvalue expression}} of the cv-unqualified version of {{tt|T}} if a {{rlp|converting constructor}} was used, is then used to {{rlp|direct initialization|direct-initialize}} the object. {{rev inl|until=c++17|The last step is usually {{rlp|copy elision|optimized out}} and the result of the conversion is constructed directly in the memory allocated for the target object, but the appropriate constructor (move or copy) is required to be accessible even though it's not used.}} |
− | * Otherwise (if neither {{tt|T}} nor the type of {{spar|other}} are class types), | + | * Otherwise (if neither {{tt|T}} nor the type of {{spar|other}} are class types), {{rlp|implicit cast|standard conversions}} are used, if necessary, to convert the value of {{spar|other}} to the cv-unqualified version of {{tt|T}}. |
===Notes=== | ===Notes=== | ||
Line 54: | Line 52: | ||
{{source|1= | {{source|1= | ||
struct S { S(std::string) {} }; // implicitly convertible from std::string | struct S { S(std::string) {} }; // implicitly convertible from std::string | ||
− | S s("abc"); // OK: conversion from const char[4] to std::string | + | S s("abc"); // OK: conversion from const char[4] to std::string |
− | S s = "abc"; // Error: no conversion from const char[4] to S | + | S s = "abc"; // Error: no conversion from const char[4] to S |
S s = "abc"s; // OK: conversion from std::string to S | S s = "abc"s; // OK: conversion from std::string to S | ||
}} | }} | ||
− | If {{spar|other}} is an rvalue expression, | + | If {{spar|other}} is an rvalue expression, a {{rlp|move constructor}} will be selected by overload resolution and called during copy-initialization. This is still considered copy-initialization; there is no special term (e.g., move-initialization) for this case. |
− | + | {{rlp|implicit cast|Implicit conversion}} is defined in terms of copy-initialization: if an object of type {{tt|T}} can be copy-initialized with expression {{tt|E}}, then {{tt|E}} is implicitly convertible to {{tt|T}}. | |
− | The equals sign, {{ttb| | + | The equals sign, {{ttb|1==}}, in copy-initialization of a named variable is not related to the assignment operator. Assignment operator overloads have no effect on copy-initialization. |
===Example=== | ===Example=== | ||
− | |||
{{example | {{example | ||
− | + | | | |
− | + | |code= | |
+ | #include <memory> | ||
#include <string> | #include <string> | ||
#include <utility> | #include <utility> | ||
− | |||
− | struct A | + | struct A |
{ | { | ||
− | + | operator int() { return 12;} | |
}; | }; | ||
− | struct B | + | struct B |
{ | { | ||
− | + | B(int) {} | |
}; | }; | ||
int main() | int main() | ||
{ | { | ||
− | std::string s = "test"; // OK: constructor is non-explicit | + | std::string s = "test"; // OK: constructor is non-explicit |
std::string s2 = std::move(s); // this copy-initialization performs a move | std::string s2 = std::move(s); // this copy-initialization performs a move | ||
// std::unique_ptr<int> p = new int(1); // error: constructor is explicit | // std::unique_ptr<int> p = new int(1); // error: constructor is explicit | ||
− | std::unique_ptr<int> p(new int(1)); // OK: direct-initialization | + | std::unique_ptr<int> p(new int(1)); // OK: direct-initialization |
− | + | ||
int n = 3.14; // floating-integral conversion | int n = 3.14; // floating-integral conversion | ||
const int b = n; // const doesn't matter | const int b = n; // const doesn't matter | ||
int c = b; // ...either way | int c = b; // ...either way | ||
− | |||
A a; | A a; | ||
B b0 = 12; | B b0 = 12; | ||
− | // | + | // B b1 = a; // < error: conversion from 'A' to non-scalar type 'B' requested |
B b2{a}; // < identical, calling A::operator int(), then B::B(int) | B b2{a}; // < identical, calling A::operator int(), then B::B(int) | ||
B b3 = {a}; // < | B b3 = {a}; // < | ||
auto b4 = B{a}; // < | auto b4 = B{a}; // < | ||
− | // | + | // b0 = a; // < error, assignment operator overload needed |
+ | |||
+ | [](...){}(c, b0, b3, b4); // pretend these variables are used | ||
} | } | ||
− | |||
}} | }} | ||
+ | |||
+ | ===Defect reports=== | ||
+ | {{dr list begin}} | ||
+ | {{dr list item|wg=cwg|dr=5|std=C++98|before=the cv-qualification of the destination type is applied to<br>the temporary initialized by a converting constructor|after=the temporary is not cv-qualified}} | ||
+ | {{dr list item|wg=cwg|dr=177|std=C++98|before=the value category of the temporary created during<br>copy-initialization of a class object is unspecified|after=specified as rvalue}} | ||
+ | {{dr list end}} | ||
===See also=== | ===See also=== | ||
− | * | + | * {{rlp|copy elision}} |
− | * | + | * {{rlp|converting constructor}} |
− | * | + | * {{rlp|copy assignment}} |
− | * | + | * {{rlp|copy constructor}} |
+ | * {{rlp|default constructor}} | ||
+ | * {{rlp|destructor}} | ||
+ | * {{rlpt|explicit}} | ||
+ | * {{rlp|initialization}} | ||
+ | ** {{rlp|aggregate initialization}} | ||
+ | ** {{rlp|constant initialization}} | ||
+ | ** {{rlp|default initialization}} | ||
+ | ** {{rlp|direct initialization}} | ||
+ | ** {{rlp|initializer list}} | ||
+ | ** {{rlp|list initialization}} | ||
+ | ** {{rlp|reference initialization}} | ||
+ | ** {{rlp|value initialization}} | ||
+ | ** {{rlp|zero initialization}} | ||
+ | * {{rlp|move assignment}} | ||
+ | * {{rlp|move constructor}} | ||
+ | * {{rlpt|new}} | ||
− | + | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Latest revision as of 22:17, 5 June 2024
Initializes an object from another object.
Contents |
[edit] Syntax
T object = other;
|
(1) | ||||||||
T object = { other};
|
(2) | (until C++11) | |||||||
f( other)
|
(3) | ||||||||
return other;
|
(4) | ||||||||
throw object;
|
(5) | ||||||||
T array[ N] = { other-sequence};
|
(6) | ||||||||
[edit] Explanation
Copy-initialization is performed in the following situations:
T
is declared with the initializer consisting of an equals sign followed by an expression.T
is declared with the initializer consisting of an equals sign followed by a brace-enclosed expression (Note: as of C++11, this is classified as list initialization, and narrowing conversion is not allowed).The effects of copy-initialization are:
|
(since C++17) |
- Otherwise, if
T
is a class type and the cv-unqualified version of the type of other isT
or a class derived fromT
, the non-explicit constructors ofT
are examined and the best match is selected by overload resolution. That constructor is then called to initialize the object.
- Otherwise, if
T
is a class type, and the cv-unqualified version of the type of other is notT
or derived fromT
, or ifT
is non-class type, but the type of other is a class type, user-defined conversion sequences that can convert from the type of other toT
(or to a type derived fromT
ifT
is a class type and a conversion function is available) are examined and the best one is selected through overload resolution. The result of the conversion, which is a rvalue temporary(until C++11)prvalue temporary(since C++11)(until C++17)prvalue expression(since C++17) of the cv-unqualified version ofT
if a converting constructor was used, is then used to direct-initialize the object. The last step is usually optimized out and the result of the conversion is constructed directly in the memory allocated for the target object, but the appropriate constructor (move or copy) is required to be accessible even though it's not used.(until C++17)
- Otherwise (if neither
T
nor the type of other are class types), standard conversions are used, if necessary, to convert the value of other to the cv-unqualified version ofT
.
[edit] Notes
Copy-initialization is less permissive than direct-initialization: explicit constructors are not converting constructors and are not considered for copy-initialization.
struct Exp { explicit Exp(const char*) {} }; // not convertible from const char* Exp e1("abc"); // OK Exp e2 = "abc"; // Error, copy-initialization does not consider explicit constructor struct Imp { Imp(const char*) {} }; // convertible from const char* Imp i1("abc"); // OK Imp i2 = "abc"; // OK
In addition, the implicit conversion in copy-initialization must produce T
directly from the initializer, while, e.g. direct-initialization expects an implicit conversion from the initializer to an argument of T
's constructor.
struct S { S(std::string) {} }; // implicitly convertible from std::string S s("abc"); // OK: conversion from const char[4] to std::string S s = "abc"; // Error: no conversion from const char[4] to S S s = "abc"s; // OK: conversion from std::string to S
If other is an rvalue expression, a move constructor will be selected by overload resolution and called during copy-initialization. This is still considered copy-initialization; there is no special term (e.g., move-initialization) for this case.
Implicit conversion is defined in terms of copy-initialization: if an object of type T
can be copy-initialized with expression E
, then E
is implicitly convertible to T
.
The equals sign, =
, in copy-initialization of a named variable is not related to the assignment operator. Assignment operator overloads have no effect on copy-initialization.
[edit] Example
#include <memory> #include <string> #include <utility> struct A { operator int() { return 12;} }; struct B { B(int) {} }; int main() { std::string s = "test"; // OK: constructor is non-explicit std::string s2 = std::move(s); // this copy-initialization performs a move // std::unique_ptr<int> p = new int(1); // error: constructor is explicit std::unique_ptr<int> p(new int(1)); // OK: direct-initialization int n = 3.14; // floating-integral conversion const int b = n; // const doesn't matter int c = b; // ...either way A a; B b0 = 12; // B b1 = a; // < error: conversion from 'A' to non-scalar type 'B' requested B b2{a}; // < identical, calling A::operator int(), then B::B(int) B b3 = {a}; // < auto b4 = B{a}; // < // b0 = a; // < error, assignment operator overload needed [](...){}(c, b0, b3, b4); // pretend these variables are used }
[edit] Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
CWG 5 | C++98 | the cv-qualification of the destination type is applied to the temporary initialized by a converting constructor |
the temporary is not cv-qualified |
CWG 177 | C++98 | the value category of the temporary created during copy-initialization of a class object is unspecified |
specified as rvalue |