Pimpl For Compile-Time Encapsulation (Modern C++)

The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

1 out of 4 rated this helpful - Rate this topic

Visual Studio 2012

The pimpl idiom is a modern C++ technique to hide implementation, to minimize coupling, and to separate interfaces. Pimpl is short for "pointer to implementation." You may already be familiar with the concept but know it by other names like Cheshire Cat or Compiler Firewall idiom.

Why use pimpl?

Here's how the pimpl idiom can improve the software development lifecycle:

Minimization of compilation dependencies.
Separation of interface and implementation.
Portability.

Pimpl header

C++

// my_class.h
class my_class {
   //  ... all public and protected stuff goes here ...
private:
   class impl; unique_ptr<impl> pimpl; // opaque type here
};

The pimpl idiom avoids rebuild cascades and brittle object layouts. It's well suited for (transitively) popular types.

Pimpl implementation

Define the impl class in the .cpp file.

C++

// my_class.cpp
class my_class::impl {  // defined privately here
  // ... all private data and functions: all of these
  //     can now change without recompiling callers ...
};
my_class::my_class(): pimpl( new impl )
{
  // ... set impl values ... 
}

Best practices

Consider whether to add support for non-throwing swap specialization.

Other Resources

Welcome Back to C++ (Modern C++)

C++ Language Reference

Standard C++ Library Reference

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Pimpl For Compile-Time Encapsulation (Modern C++)

Other Resources

Community Additions