D Programming Language
Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

# Classes

The object-oriented features of D all come from classes. The class hierarchy has as its root the class Object. Object defines a minimum level of functionality that each derived class has, and a default implementation for that functionality.

Classes are programmer defined types. Support for classes are what make D an object oriented language, giving it encapsulation, inheritance, and polymorphism. D classes support the single inheritance paradigm, extended by adding support for interfaces. Class objects are instantiated by reference only.

A class can be exported, which means its name and all its non-private members are exposed externally to the DLL or EXE.

A class declaration is defined:

    ClassDeclaration:
        class Identifier ;
        class Identifier BaseClassListopt AggregateBody
        ClassTemplateDeclaration

    BaseClassList:
        : SuperClass
        : SuperClass , Interfaces
        : Interfaces

    SuperClass:
        BasicType

    Interfaces:
        Interface
        Interface , Interfaces

    Interface:
        BasicType

Classes consist of:

- a super class
- interfaces
- dynamic fields
- static fields
- types
- an optional synchronized attribute
- member functions
  - static member functions
  - Virtual Functions
  - Constructors
  - Destructors
  - Static Constructors
  - Static Destructors
  - SharedStaticConstructors
  - SharedStaticDestructors
  - Class Invariants
  - Unit Tests
  - Class Allocators
  - Class Deallocators
  - Alias This

A class is defined:

    class Foo
    {
        ... members ...
    }

Note that there is no trailing ; after the closing } of the class definition. It is also not possible to declare a variable var like:

    class Foo { } var;

Instead:

    class Foo { }
    Foo var;

### Access Control

Access to class members is controlled using ProtectionAttributes. The default protection attribute is public. Access control does not affect visibility.

### Fields

Class members are always accessed with the . operator.

Members of a base class can be accessed by prepending the name of the base class followed by a dot:

    class A { int a; }
    class B : A { int a; }

    void foo(B b)
    {
        b.a = 3;   // accesses field B.a
        b.A.a = 4; // accesses field A.a
    }

The D compiler is free to rearrange the order of fields in a class to optimally pack them in an implementation-defined manner. Consider the fields much like the local variables in a function - the compiler assigns some to registers and shuffles others around all to get the optimal stack frame layout. This frees the code designer to organize the fields in a manner that makes the code more readable rather than being forced to organize it according to machine optimization rules. Explicit control of field layout is provided by struct/union types, not classes.

### Field Properties

The .offsetof property gives the offset in bytes of the field from the beginning of the class instantiation. .offsetof can only be applied to expressions which produce the type of the field itself, not the class type:

    class Foo
    {
        int x;
    }
    ...
    void test(Foo foo)
    {
        size_t o;

        o = Foo.x.offsetof; // error, Foo.x needs a 'this' reference
        o = foo.x.offsetof; // ok
    }

### Class Properties

The .tupleof property returns an ExpressionTuple of all the fields in the class, excluding the hidden fields and the fields in the base class.

    class Foo { int x; long y; }
    void test(Foo foo)
    {
        foo.tupleof[0] = 1; // set foo.x to 1
        foo.tupleof[1] = 2; // set foo.y to 2
        foreach (x; foo.tupleof)
            write(x);       // prints 12
    }

The properties .__vptr and .__monitor give access to the class object's vtbl[] and monitor, respectively, but should not be used in user code.

### Super Class

All classes inherit from a super class. If one is not specified, it inherits from Object. Object forms the root of the D class inheritance hierarchy.

### Member Functions

Non-static member functions have an extra hidden parameter called this through which the class object's other members can be accessed.

Non-static member functions can have, in addition to the usual FunctionAttributes, the attributes const, immutable, shared, or inout. These attributes apply to the hidden this parameter.

    class C
    {
        int a;
        const void foo()
        {
            a = 3; // error, 'this' is const
        }
        void foo() immutable
        {
            a = 3; // error, 'this' is immutable
        }
    }

### Synchronized Classes

All member functions of synchronized classes are synchronized. A static member function is synchronized on the classinfo object for the class, which means that one monitor is used for all static member functions for that synchronized class. For non-static functions of a synchronized class, the monitor used is part of the class object. For example:

    synchronized class Foo
    {
        void bar() { ...statements... }
    }

is equivalent to (as far as the monitors go):

    synchronized class Foo
    {
        void bar()
        {
            synchronized (this) { ...statements... }
        }
    }

Member functions of non-synchronized classes cannot be individually marked as synchronized. The synchronized attribute must be applied to the class declaration itself:

    class Foo
    {
        synchronized void foo() { }  // disallowed!
    }

    synchronized class Bar
    {
        void bar() { }  // bar is synchronized
    }

Member fields of a synchronized class cannot be public:

    synchronized class Foo
    {
        int foo;  // disallowed: public field
    }

    synchronized class Bar
    {
        private int bar;  // ok
    }

The synchronized attribute can only be applied to classes, structs cannot be marked to be synchronized.

### Constructors

    Constructor:
        this Parameters MemberFunctionAttributesopt ;
        this Parameters MemberFunctionAttributesopt FunctionBody
        ConstructorTemplate

Members are always initialized to the default initializer for their type, which is usually 0 for integer types and NAN for floating point types. This eliminates an entire class of obscure problems that come from neglecting to initialize a member in one of the constructors. In the class definition, there can be a static initializer to be used instead of the default:

    class Abc
    {
        int a;      // default initializer for a is 0
        long b = 7; // default initializer for b is 7
        float f;    // default initializer for f is NAN
    }

This static initialization is done before any constructors are called.

Constructors are defined with a function name of this and having no return value:

    class Foo
    {
        this(int x)  // declare constructor for Foo
        {   ...
        }
        this()
        {   ...
        }
    }

Base class construction is done by calling the base class constructor by the name super:

    class A { this(int y) { } }

    class B : A
    {
        int j;
        this()
        {
            ...
            super(3);  // call base constructor A.this(3)
            ...
        }
    }

Constructors can also call other constructors for the same class in order to share common initializations (this is called delegating constructors):

    class C
    {
        int j;
        this()
        {
            ...
        }
        this(int i)
        {
            this();
            j = i;
        }
    }

If no call to constructors via this or super appear in a constructor, and the base class has a constructor, a call to super() is inserted at the beginning of the constructor.

If there is no constructor for a class, but there is a constructor for the base class, a default constructor of the form:

    this() { }

is implicitly generated.

Class object construction is very flexible, but some restrictions apply:

1. It is illegal for constructors to mutually call each other, although the compiler is not required to detect it. It will result in undefined behavior.

       this() { this(1); }
       this(int i) { this(); } // illegal, cyclic constructor calls

2. If any constructor call appears inside a constructor, any path through the constructor must make exactly one constructor call:

       this() { a || super(); }       // illegal

       this() { (a) ? this(1) : super(); }     // ok

       this()
       {
           for (...)
           {
               super();  // illegal, inside loop
           }
       }

3. It is illegal to refer to this implicitly or explicitly prior to making a constructor call.
4. Constructor calls cannot appear after labels (in order to make it easy to check for the previous conditions in the presence of goto's).

Instances of class objects are created with NewExpressions:

    A a = new A(3);

The following steps happen:

1. Storage is allocated for the object. If this fails, rather than return null, an OutOfMemoryError is thrown. Thus, tedious checks for null references are unnecessary.
2. The raw data is statically initialized using the values provided in the class definition. The pointer to the vtbl[] (the array of pointers to virtual functions) is assigned. This ensures that constructors are passed fully formed objects for which virtual functions can be called. This operation is equivalent to doing a memory copy of a static version of the object onto the newly allocated one, although more advanced compilers may be able to optimize much of this away.
3. If there is a constructor defined for the class, the constructor matching the argument list is called.
4. If class invariant checking is turned on, the class invariant is called at the end of the constructor.

Constructors can have one of these member function attributes: const, immutable, and shared. Construction of qualified objects will then be restricted to the implemented qualified constructors.

    class C
    {
        this();   // non-shared mutable constructor
    }

    // create mutable object
    C m = new C();

    // create const object using by mutable constructor
    const C c2 = new const C();

    // a mutable constructor cannot create an immutable object
    // immutable C i = new immutable C();

    // a mutable constructor cannot create a shared object
    // shared C s = new shared C();

Constructors can be overloaded with different attributes.

    class C
    {
        this();               // non-shared mutable constructor
        this() shared;        // shared mutable constructor
        this() immutable;     // immutable constructor
    }

    C m = new C();
    shared s = new shared C();
    immutable i = new immutable C();

If the constructor can create unique object (e.g. if it is pure), the object can be implicitly convertible to any qualifiers.

    class C
    {
        this() pure;
        // Based on the definition, this creates a mutable object. But the
        // created object cannot contain any mutable global data.
        // Then compiler can guarantee that the created object is unique.

        this(int[] arr) immutable pure;
        // Based on the definition, this creates an immutable object. But
        // the argument int[] never appears in the created object so it
        // isn't implicitly convertible to immutable. Also, it cannot store
        // any immutable global data.
        // Therefore the compiler can guarantee that the created object is
        // unique.
    }

    immutable i = new immutable C();           // this() pure is called
    shared s = new shared C();                 // this() pure is called
    C m = new C([1,2,3]);       // this(int[]) immutable pure is called

### Field initialization inside constructor

Inside constructor, the first instance field assignment is specially handled for its initialization.

    class C
    {
        int num;
        this()
        {
            num = 1;  // initialize
            num = 2;  // assignment
        }
    }

If the field type has opAssign method, it won't be used for initialization.

    struct A
    {
        this(int n) {}
        void opAssign(A rhs) {}
    }
    class C
    {
        A val;
        this()
        {
            val = A(1);  // A(1) is moved in this.val for initializing
            val = A(2);  // rewritten to val.opAssign(A(2))
        }
    }

If the field type is not modifiable, multiple initialization will be rejected.

    class C
    {
        immutable int num;
        this()
        {
            num = 1;  // OK
            num = 2;  // Error: multiple field initialization
        }
    }

If the assignment expression for the field initialization may be invoked multiple times, it would als be rejected.

    class C
    {
        immutable int num;
        immutable string str;
        this()
        {
            foreach (i; 0..2)
            {
                num = 1;    // Error: field initialization not allowed in loops
            }
            size_t i = 0;
        Label:
            str = "hello";  // Error: field initialization not allowed after labels
            if (i++ < 2)
                goto Label;
        }
    }

### Destructors

    Destructor:
        ~ this ( ) MemberFunctionAttributesopt ;
        ~ this ( ) MemberFunctionAttributesopt FunctionBody

The garbage collector calls the destructor function when the object is deleted. The syntax is:

    class Foo
    {
        ~this() // destructor for Foo
        {
        }
    }

There can be only one destructor per class, the destructor does not have any parameters, and has no attributes. It is always virtual.

The destructor is expected to release any resources held by the object.

The program can explicitly inform the garbage collector that an object is no longer referred to (with the delete expression), and then the garbage collector calls the destructor immediately, and adds the object's memory to the free storage. The destructor is guaranteed to never be called twice.

The destructor for the super class automatically gets called when the destructor ends. There is no way to call the super destructor explicitly.

The garbage collector is not guaranteed to run the destructor for all unreferenced objects. Furthermore, the order in which the garbage collector calls destructors for unreference objects is not specified. This means that when the garbage collector calls a destructor for an object of a class that has members that are references to garbage collected objects, those references may no longer be valid. This means that destructors cannot reference sub objects. This rule does not apply to auto objects or objects deleted with the DeleteExpression, as the destructor is not being run by the garbage collector, meaning all references are valid.

Objects referenced from the data segment never get collected by the gc.

### Static Constructors

    StaticConstructor:
        static this ( ) ;
        static this ( ) FunctionBody

A static constructor is a function that performs initializations of thread local data before the main() function gets control for the main thread, and upon thread startup. Static constructors are used to initialize static class members with values that cannot be computed at compile time.

Static constructors in other languages are built implicitly by using member initializers that can't be computed at compile time. The trouble with this stems from not having good control over exactly when the code is executed, for example:

    class Foo
    {
        static int a = b + 1;
        static int b = a * 2;
    }

What values do a and b end up with, what order are the initializations executed in, what are the values of a and b before the initializations are run, is this a compile error, or is this a runtime error? Additional confusion comes from it not being obvious if an initializer is static or dynamic.

D makes this simple. All member initializations must be determinable by the compiler at compile time, hence there is no order-of-evaluation dependency for member initializations, and it is not possible to read a value that has not been initialized. Dynamic initialization is performed by a static constructor, defined with a special syntax static this().

    class Foo
    {
        static int a;         // default initialized to 0
        static int b = 1;
        static int c = b + a; // error, not a constant initializer

        static this()    // static constructor
        {
            a = b + 1;          // a is set to 2
            b = a * 2;          // b is set to 4
        }
    }

If main() or the thread returns normally, (does not throw an exception), the static destructor is added to the list of functions to be called on thread termination. Static constructors have empty parameter lists.

Static constructors within a module are executed in the lexical order in which they appear. All the static constructors for modules that are directly or indirectly imported are executed before the static constructors for the importer.

The static in the static constructor declaration is not an attribute, it must appear immediately before the this:

    class Foo
    {
        static this() { ... } // a static constructor
        static private this() { ... } // not a static constructor
        static
        {
            this() { ... }      // not a static constructor
        }
        static:
            this() { ... }      // not a static constructor
    }

### Static Destructors

    StaticDestructor:
        static ~ this ( ) MemberFunctionAttributesopt ;
        static ~ this ( ) MemberFunctionAttributesopt FunctionBody

A static destructor is defined as a special static function with the syntax static ~this().

    class Foo
    {
        static ~this() // static destructor
        {
        }
    }

A static destructor gets called on thread termination, but only if the static constructor completed successfully. Static destructors have empty parameter lists. Static destructors get called in the reverse order that the static constructors were called in.

The static in the static destructor declaration is not an attribute, it must appear immediately before the ~this:

    class Foo
    {
        static ~this() { ... }  // a static destructor
        static private ~this() { ... } // not a static destructor
        static
        {
            ~this() { ... }  // not a static destructor
        }
        static:
            ~this() { ... }  // not a static destructor
    }

### Shared Static Constructors

    SharedStaticConstructor:
        shared static this ( ) ;
        shared static this ( ) FunctionBody

Shared static constructors are executed before any StaticConstructors, and are intended for initializing any shared global data.

### Shared Static Destructors

    SharedStaticDestructor:
        shared static ~ this ( ) MemberFunctionAttributesopt ;
        shared static ~ this ( ) MemberFunctionAttributesopt FunctionBody

Shared static destructors are executed at program termination in the reverse order that SharedStaticConstructors were executed.

### Class Invariants

    Invariant:
        invariant ( ) BlockStatement
        invariant BlockStatement

Class invariants are used to specify characteristics of a class that always must be true (except while executing a member function). They are described in Invariants.

### Class Allocators

Note: Class allocators are deprecated in D2.

    Allocator:
        new Parameters ;
        new Parameters FunctionBody

A class member function of the form:

    new(uint size)
    {
        ...
    }

is called a class allocator. The class allocator can have any number of parameters, provided the first one is of type uint. Any number can be defined for a class, the correct one is determined by the usual function overloading rules. When a new expression:

    new Foo;

is executed, and Foo is a class that has an allocator, the allocator is called with the first argument set to the size in bytes of the memory to be allocated for the instance. The allocator must allocate the memory and return it as a void*. If the allocator fails, it must not return a null, but must throw an exception. If there is more than one parameter to the allocator, the additional arguments are specified within parentheses after the new in the NewExpression:

    class Foo
    {
        this(char[] a) { ... }

        new(uint size, int x, int y)
        {
            ...
        }
    }

    ...

    new(1,2) Foo(a);        // calls new(Foo.sizeof,1,2)

Derived classes inherit any allocator from their base class, if one is not specified.

The class allocator is not called if the instance is created on the stack.

See also .

### Class Deallocators

Note: Class deallocators and the delete operator are deprecated in D2. Use the destroy function to finalize an object by calling its destructor. The memory of the object is not immediately deallocated, instead the GC will collect the memory of the object at an undetermined point after finalization:

    class Foo { int x; this() { x = 1; } }
    Foo foo = new Foo;
    destroy(foo);
    assert(foo.x == int.init);  // object is still accessible

    Deallocator:
        delete Parameters ;
        delete Parameters FunctionBody

A class member function of the form:

    delete(void *p)
    {
        ...
    }

is called a class deallocator. The deallocator must have exactly one parameter of type void*. Only one can be specified for a class. When a delete expression:

    delete f;

is executed, and f is a reference to a class instance that has a deallocator, the deallocator is called with a pointer to the class instance after the destructor (if any) for the class is called. It is the responsibility of the deallocator to free the memory.

Derived classes inherit any deallocator from their base class, if one is not specified.

The class allocator is not called if the instance is created on the stack.

See also Explicit Class Instance Allocation.

### Alias This

    AliasThis:
        alias Identifier this ;

An AliasThis declaration names a member to subtype. The Identifier names that member.

A class or struct can be implicitly converted to the AliasThis member.

    struct S
    {
        int x;
        alias x this;
    }

    int foo(int i) { return i * 2; }

    void test()
    {
        S s;
        s.x = 7;
        int i = -s;  // i == -7
        i = s + 8;   // i == 15
        i = s + s;   // i == 14
        i = 9 + s;   // i == 16
        i = foo(s);  // implicit conversion to int
    }

If the member is a class or struct, undefined lookups will be forwarded to the AliasThis member.

    struct Foo
    {
        int baz = 4;
        int get() { return 7; }
    }

    class Bar
    {
        Foo foo;
        alias foo this;
    }

    void test()
    {
        auto bar = new Bar;
        int i = bar.baz; // i == 4
        i = bar.get(); // i == 7
    }

If the Identifier refers to a property member function with no parameters, conversions and undefined lookups are forwarded to the return value of the function.

    struct S
    {
        int x;
        @property int get()
        {
            return x * 2;
        }
        alias get this;
    }

    void test()
    {
        S s;
        s.x = 2;
        int i = s; // i == 4
    }

Multiple AliasThis are allowed. For implicit conversions and forwarded lookups, all AliasThis declarations are attempted; if more than one AliasThis is eligible, the ambiguity is disallowed by raising an error. Note: Multiple AliasThis is currently unimplemented.

### Scope Classes

Note: Scope classes have been recommended for deprecation.

A scope class is a class with the scope attribute, as in:

    scope class Foo { ... }

The scope characteristic is inherited, so any classes derived from a scope class are also scope.

A scope class reference can only appear as a function local variable. It must be declared as being scope:

    scope class Foo { ... }

    void func()
    {
        Foo f;    // error, reference to scope class must be scope
        scope Foo g = new Foo(); // correct
    }

When a scope class reference goes out of scope, the destructor (if any) for it is automatically called. This holds true even if the scope was exited via a thrown exception.

### Final Classes

Final classes cannot be subclassed:

    final class A { }
    class B : A { }  // error, class A is final

## Nested Classes

A nested class is a class that is declared inside the scope of a function or another class. A nested class has access to the variables and other symbols of the classes and functions it is nested inside:

    class Outer
    {
        int m;

        class Inner
        {
            int foo()
            {
                return m;   // Ok to access member of Outer
            }
        }
    }

    void func()
    {
        int m;

        class Inner
        {
            int foo()
            {
                return m; // Ok to access local variable m of func()
            }
        }
    }

If a nested class has the static attribute, then it can not access variables of the enclosing scope that are local to the stack or need a this:

    class Outer
    {
        int m;
        static int n;

        static class Inner
        {
            int foo()
            {
                return m;   // Error, Inner is static and m needs a this
                return n;   // Ok, n is static
            }
        }
    }

    void func()
    {
        int m;
        static int n;

        static class Inner
        {
            int foo()
            {
                return m;   // Error, Inner is static and m is local to the stack
                return n;   // Ok, n is static
            }
        }
    }

Non-static nested classes work by containing an extra hidden member (called the context pointer) that is the frame pointer of the enclosing function if it is nested inside a function, or the this of the enclosing class's instance if it is nested inside a class.

When a non-static nested class is instantiated, the context pointer is assigned before the class's constructor is called, therefore the constructor has full access to the enclosing variables. A non-static nested class can only be instantiated when the necessary context pointer information is available:

    class Outer
    {
        class Inner { }

        static class SInner { }
    }

    void func()
    {
        class Nested { }

        Outer o = new Outer;        // Ok
        Outer.Inner oi = new Outer.Inner;   // Error, no 'this' for Outer
        Outer.SInner os = new Outer.SInner; // Ok

        Nested n = new Nested;      // Ok
    }

A this can be supplied to the creation of an inner class instance by prefixing it to the NewExpression:

    class Outer
    {
        int a;

        class Inner
        {
            int foo()
            {
                return a;
            }
        }
    }

    int bar()
    {
        Outer o = new Outer;
        o.a = 3;
        Outer.Inner oi = o.new Inner;
        return oi.foo();    // returns 3
    }

Here o supplies the this to the outer class instance of Outer.

The property .outer used in a nested class gives the this pointer to its enclosing class. If the enclosing context is not a class, the .outer will give the pointer to it as a void* type.

    class Outer
    {
        class Inner
        {
            Outer foo()
            {
                return this.outer;
            }
        }

        void bar()
        {
            Inner i = new Inner;
            assert(this == i.foo());
        }
    }

    void test()
    {
        Outer o = new Outer;
        o.bar();
    }

### Anonymous Nested Classes

An anonymous nested class is both defined and instantiated with a NewAnonClassExpression:

    NewAnonClassExpression:
        new AllocatorArgumentsopt class ClassArgumentsopt SuperClassopt Interfacesopt AggregateBody

    ClassArguments:
        ( ArgumentListopt )

which is equivalent to:

    class Identifier : SuperClass Interfaces AggregateBody

    new (ArgumentList) Identifier (ArgumentList);

where Identifier is the name generated for the anonymous nested class.

### Const, Immutable and Shared Classes

If a ClassDeclaration has a const, immutable or shared storage class, then it is as if each member of the class was declared with that storage class. If a base class is const, immutable or shared, then all classes derived from it are also const, immutable or shared.

Copyright © 1999-2015 by Digital Mars ®, All Rights Reserved | Page generated by Ddoc on Sat Apr 25 12:22:46 2015