Difference between revisions of "cpp/language/definition"

Latest revision as of 22:22, 30 May 2024

Definitions are declarations that fully define the entity introduced by the declaration. Every declaration is a definition, except for the following:

• A function declaration without a function body:

int f(int); // declares, but doesn't define f

• Any declaration with an extern storage class specifier or with a language linkage specifier (such as extern "C") without an initializer:

extern const int a;     // declares, but doesn't define a
extern const int b = 1; // defines b

• Declaration of a non-inline(since C++17) static data member inside a class definition:

struct S
{
    int n;               // defines S::n
    static int i;        // declares, but doesn't define S::i
    inline static int x; // defines S::x
};                       // defines S
 
int S::i;                // defines S::i

struct S
{
    static constexpr int x = 42; // implicitly inline, defines S::x
};
 
constexpr int S::x; // declares S::x, not a redefinition

• Declaration of a class name (by forward declaration or by the use of the elaborated type specifier in another declaration):

struct S;             // declares, but doesn't define S
 
class Y f(class T p); // declares, but doesn't define Y and T (and also f and p)

enum Color : int; // declares, but doesn't define Color

• Declaration of a template parameter:

template<typename T> // declares, but doesn't define T

• A parameter declaration in a function declaration that isn't a definition:

int f(int x); // declares, but doesn't define f and x
 
int f(int x)  // defines f and x
{
    return x + a;
}

• A typedef declaration:

typedef S S2; // declares, but doesn't define S2 (S may be incomplete)

using S2 = S; // declares, but doesn't define S2 (S may be incomplete)

• A using-declaration:

using N::d; // declares, but doesn't define d

• An empty declaration (does not define any entities)
• A using-directive (does not define any entities)

extern template
f<int, char>; // declares, but doesn't define f<int, char>

• An explicit specialization whose declaration is not a definition:

template<>
struct A<int>; // declares, but doesn't define A<int>

An asm declaration does not define any entities, but it is classified as a definition.

Where necessary, the compiler may implicitly define the default constructor, copy constructor, move constructor, copy assignment operator, move assignment operator, and the destructor.

If the definition of any object results in an object of incomplete type or abstract class type, the program is ill-formed.

[edit] One Definition Rule

Only one definition of any variable, function, class type, enumeration type, concept(since C++20) or template is allowed in any one translation unit (some of these may have multiple declarations, but only one definition is allowed).

One and only one definition of every non-inline function or variable that is odr-used (see below) is required to appear in the entire program (including any standard and user-defined libraries). The compiler is not required to diagnose this violation, but the behavior of the program that violates it is undefined.

For an inline function or inline variable(since C++17), a definition is required in every translation unit where it is odr-used.

For a class, a definition is required wherever the class is used in a way that requires it to be complete.

There can be more than one definition in a program of each of the following: class type, enumeration type, inline function, inline variable(since C++17), templated entity (template or member of template, but not full template specialization), as long as all of the following is true:

• each definition appears in a different translation unit

• each definition consists of the same sequence of tokens (typically, appears in the same header file)
• name lookup from within each definition finds the same entities (after overload-resolution), except that

• constants with internal or no linkage may refer to different objects as long as they are not odr-used and have the same values in every definition

• overloaded operators, including conversion, allocation, and deallocation functions refer to the same function from each definition (unless referring to one defined within the definition)
• corresponding entities have the same language linkage in each definition (e.g. the include file isn't inside an extern "C" block)
• if a const object is constant-initialized in any of the definitions, it is constant-initialized in each definition
• the rules above apply to every default argument used in each definition
• if the definition is for a class with an implicitly-declared constructor, every translation unit where it is odr-used must call the same constructor for the base and members

• if the definition is for a template, then all these requirements apply to both names at the point of definition and dependent names at the point of instantiation

If all these requirements are satisfied, the program behaves as if there is only one definition in the entire program. Otherwise, the program is ill-formed, no diagnostic required.

Note: in C, there is no program-wide ODR for types, and even extern declarations of the same variable in different translation units may have different types as long as they are compatible. In C++, the source-code tokens used in declarations of the same type must be the same as described above: if one .cpp file defines struct S { int x; }; and the other .cpp file defines struct S { int y; };, the behavior of the program that links them together is undefined. This is usually resolved with unnamed namespaces.

[edit] ODR-use

Informally,

• an object is odr-used if its value is read (unless it is a compile time constant) or written, its address is taken, or a reference is bound to it,
• a reference is odr-used if it is used and its referent is not known at compile time,
• a function is odr-used if a function call to it is made or its address is taken.

If an object, a reference or a function is odr-used, its definition must exist somewhere in the program; a violation of that is usually a link-time error.

struct S
{
    static const int x = 0; // static data member
    // a definition outside of class is required if it is odr-used
};
 
const int& f(const int& r);
 
int n = b ? (1, S::x) // S::x is not odr-used here
          : f(S::x);  // S::x is odr-used here: a definition is required

Formally,

struct S { static const int x = 1; }; // applying lvalue-to-rvalue conversion
                                      // to S::x yields a constant expression
 
int f()
{
    S::x;        // discarded-value expression does not odr-use S::x
 
    return S::x; // expression where lvalue-to-rvalue conversion
                 // applies does not odr-use S::x
}

A set of potential results of an expression E is a (possibly empty) set of id-expressions that appear within E, combined as follows:

• If E is an id-expression, the expression E is its only potential result.
• If E is a subscript expression (E1[E2]) where one of the operands is an array, the potential results of that operand is included in the set.
• If E is a class member access expression of the form E1.E2 or E1.template E2 naming a non-static data member, the potential results of E1 is included in the set.
• If E is a class member access expression naming a static data member, the id-expression designating the data member is included in the set.
• If E is a pointer-to-member access expression of the form E1.*E2 or E1.*template E2 whose second operand is a constant expression, the potential results of E1 are included in the set.
• If E is an expression in parentheses ((E1)), the potential results of E1 are included in the set.
• If E is a glvalue conditional expression (E1 ? E2 : E3, where E2 and E3 are glvalues), the union of the potential results of E2 and E3 are both included in the set.
• If E is a comma expression (E1, E2), the potential results of E2 are in the set of potential results.
• Otherwise, the set is empty.

struct S
{
    static const int a = 1;
    static const int b = 2;
};
 
int f(bool x)
{
    return x ? S::a : S::b;
    // x is a part of the subexpression "x" (to the left of ?),
    // which applies lvalue-to-rvalue conversion, but applying that conversion to x
    // does not yield a constant expression, so x is odr-used
    // S::a and S::b are lvalues, and carry over as "potential results"
    // to the result of the glvalue conditional
    // That result is then subject to lvalue-to-rvalue conversion requested
    // to copy-initialize the return value, therefore S::a and S::b are not odr-used
}

[edit] Naming a function

A function is named by an expression or conversion in following cases:

• A function whose name appears as an expression or conversion (including named function, overloaded operator, user-defined conversion, user-defined placement forms of operator new, non-default initialization) is named by that expression if it is selected by overload resolution, except when it is an unqualified pure virtual member function or a pointer-to-member to a pure virtual function.
• An allocation or deallocation function for a class is named by a new expression appearing in an expression.
• A deallocation function for a class is named by a delete expression appearing in an expression.
• A constructor selected to copy or move an object is considered to be named by the expression or conversion even if copy elision takes place. Using a prvalue in some contexts does not copy or move an object, see mandatory elision.(since C++17)

A potentially evaluated expression or conversion odr-uses a function if it names it.

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

[edit] References