Destructor (computer programming)

In object-oriented programming, a destructor (sometimes abbreviated dtor ^[1] ) is a method which is invoked mechanically just before the memory of the object is released. ^[2] It can happen when its lifetime is bound to scope and the execution leaves the scope, when it is embedded in another object whose lifetime ends, or when it was allocated dynamically and is released explicitly. Its main purpose is to free the resources (memory allocations, open files or sockets, database connections, resource locks, etc.) which were acquired by the object during its life and/or deregister from other entities which may keep references to it. Use of destructors is needed for the process of Resource Acquisition Is Initialization (RAII).

With most kinds of automatic garbage collection algorithms, the releasing of memory may happen a long time after the object becomes unreachable, making destructors (called finalizers in this case) unsuitable for most purposes. In such languages, the freeing of resources is done either through a lexical construct (such as try..finally, Python's "with" or Java's "try-with-resources"), which is the equivalent to RAII, or explicitly by calling a function (equivalent to explicit deletion); in particular, many object-oriented languages use the Dispose pattern.

Destructor syntax

• C++: destructors have the same name as the class with which they are associated, but with a tilde prefix (for example, a class X with a constructor X() has a destructor ~X()). ^[2]
• C#: same syntax as C++ (prefixed with a tilde). The language historically referred to these as destructors, however they are now referred to as finalizers due to the confusion this caused. ^[3]
• D: destructors are declared with name ~this() (whereas constructors are declared with this()).
• Object Pascal: destructors have the keyword destructor and can have user-defined names, but are mostly named Destroy.
• Objective-C: the destructor method has the name dealloc.
• Perl: the destructor method has the name DESTROY; in the Moose object system extension, it is named DEMOLISH.
• PHP: In PHP 5+, the destructor method has the name __destruct. There were no destructors in prior versions of PHP. ^[4]
• Python: there are __del__ methods called destructors by the Python 2 language guide, ^[5] but they are actually finalizers as acknowledged in Python 3. ^[6]
• Rust: the destructor method for Rust has the name drop and is provided by the Drop trait. ^[7]
• Swift: the destructor method has the name deinit.

In C++

The destructor has the same name as the class, but with a tilde (~) before it. ^[2] For example, a class called foo will have the destructor ~foo(). Additionally, destructors have neither parameters nor return types. ^[2] As stated above, a destructor for an object is called whenever the object's lifetime ends. ^[2] If the object was created as an automatic variable, its lifetime ends and the destructor is called automatically when the object goes out of scope. Because C++ does not have garbage collection, if the object was created with a new statement (dynamically on the heap), then its destructor is called when the delete operator is applied to a pointer to the object. Usually that operation occurs within another destructor, typically the destructor of a smart pointer object.

In inheritance hierarchies, the declaration of a virtual destructor in the base class ensures that the destructors of derived classes are invoked properly when an object is deleted through a pointer-to-base-class. Objects that may be deleted in this way need to inherit a virtual destructor.

A destructor should never throw an exception. ^[8]

Non-class scalar types have what's called a pseudo-destructor which can be accessed by using typedef or template arguments. This construct makes it possible to write code without having to know if a destructor exists for a given type.

intf(){inta=123;usingT=int;a.~T();returna;// undefined behavior}

In older versions of the standard, pseudo-destructors were specified to have no effect, however that was changed in a defect report to make them end the lifetime of the object they are called on. ^[9]

Example

#include<cstring>#include<iostream>classFoo{public:Foo():data_(newchar[sizeof("Hello, World!")]){std::strcpy(data_,"Hello, World!");}Foo(constFoo&other)=delete;// disable copy constructionFoo&operator=(constFoo&other)=delete;// disable assignment~Foo(void){delete[]data_;}private:friendstd::ostream&operator<<(std::ostream&os,constFoo&foo){os<<foo.data_;returnos;}char*data_;};intmain(){Foofoo;std::cout<<foo<<std::endl;}

Objects which cannot be safely copied and/or assigned should be disabled from such semantics by declaring their corresponding functions as deleted within a public encapsulation level. A detailed description of this method can be found in Scott Meyers' popular book, Effective Modern C++ (Item 11: "Prefer deleted functions to private undefined ones." ^[10] ).

UML class in C# containing a constructor and a destructor.

In C with GCC extensions

The GNU Compiler Collection's C compiler comes with 2 extensions that allow implementing destructors:

• The destructor function attribute ^[11] allows defining global prioritized destructor functions: when main() returns, these functions are called in priority order before the process terminates. See also: Hacking the art of exploitation. ^[12]
• The cleanup variable attribute allows attaching a destructor function to a variable: the function is called when the variable goes out of scope.

Xojo

Destructors in Xojo (REALbasic) can be in one of two forms. Each form uses a regular method declaration with a special name (with no parameters and no return value). The older form uses the same name as the Class with a ~ (tilde) prefix. The newer form uses the name Destructor. The newer form is preferred because it makes refactoring the class easier.

Class Foobar   // Old form   Sub ~Foobar()   End Sub    // New form   Sub Destructor()   End Sub End Class

See also

• Finalizer
• Constructor (computer science)
• Object lifetime
• Resource Acquisition Is Initialization
• Rule of three (C++ programming)

References

1. "dtor". TheFreeDictionary.com. Retrieved 2018-10-14.
2. Sebesta, Robert W. (2012). ""11.4.2.3 Constructors and Destructors"". Concepts of Programming Languages (print) (10th ed.). Boston, MA, USA: Addison-Wesley. p. 487. ISBN   978-0-13-139531-2.
3. "Finalizers (C# Programming Guide)".
4. Constructors and Destructors, from PHP online documentation
5. "3. Data model — Python 2.7.18 documentation".
6. "3. Data model — Python 3.10.4 documentation".
7. "Destructors - the Rust Reference".
8. GotW #47: Uncaught exceptions Accessed 31 July 2011.
9. Smith, Richard; Voutilainen, Ville. "P0593R6:Implicit creation of objects for low-level object manipulation". open-std.org. Retrieved 2022-11-25.
10. Scott Meyers: Effective Modern C++, O'REILLY, ISBN   9781491903995
11. C "destructor" function attribute
12. Erickson, Jon (2008). Hacking the art of exploitation. No Starch Press. ISBN   978-1-59327-144-2.