C++ Core Guidelines: Interfaces I

This is a crosspost from www.ModernesCpp.com.

Interfaces are a contract between a service provider and a service consumer. The C++ Core Guidelines has 20 rules to make them right because "interfaces is probably the most important single aspect of code organization".

Before I dive into the rules, here is an overview of the 20 rules.

• I.1: Make interfaces explicit
• I.2: Avoid global variables
• I.3: Avoid singletons
• I.4: Make interfaces precisely and strongly typed
• I.5: State preconditions (if any)
• I.6: Prefer Expects() for expressing preconditions
• I.7: State postconditions
• I.8: Prefer Ensures() for expressing postconditions
• I.9: If an interface is a template, document its parameters using concepts
• I.10: Use exceptions to signal a failure to perform a required task
• I.11: Never transfer ownership by a raw pointer (T*)
• I.12: Declare a pointer that must not be null as not_null
• I.13: Do not pass an array as a single pointer
• I.22: Avoid complex initialization of global objects
• I.23: Keep the number of function arguments low
• I.24: Avoid adjacent unrelated parameters of the same type
• I.25: Prefer abstract classes as interfaces to class hierarchies
• I.26: If you want a cross-compiler ABI, use a C-style subset
• I.27: For stable library ABI, consider the Pimpl idiom
• I.30: Encapsulate rule violations

I will make my discussion of the rules not so elaborated because there are too many rules. My idea is that I write in this post about the first ten rules and in the next post about the remaining 10. So, let's start.

I.1: Make interfaces explicit

This rule is about correctness and means: assumptions should be stated in an interface. Otherwise, they are easily overlooked and hard to test.

int round(double d)
{
    return (round_up) ? ceil(d) : d;    // don't: "invisible" dependency
}

For example, the function round does not express that its result depends on the invisible dependency round_up.

I.2: Avoid global variables

This rule is kind of obvious but the emphasis lies on mutable global variables. Global constants are fine because they cannot introduce a dependency into the function and cannot be subject to race conditions.

I.3: Avoid singletons

Singletons are global objects under the hood, therefore, you should avoid them.

I.4: Make interfaces precisely and strongly typed

The reason for this rule makes it clear: "Types are the simplest and best documentation, have a well-defined meaning, and are guaranteed to be checked at compile time."

Have a look at an example:

void draw_rect(int, int, int, int);   // great opportunities for mistakes
draw_rect(p.x, p.y, 10, 20);          // what does 10, 20 mean?

void draw_rectangle(Point top_left, Point bottom_right);
void draw_rectangle(Point top_left, Size height_width);

draw_rectangle(p, Point{10, 20});  // two corners
draw_rectangle(p, Size{10, 20});   // one corner and a (height, width) pair

How easy is it to use the function draw_rect in the incorrect way. Compare this to the function draw_rectangle. The compiler guarantees that the argument is a Point or a Size object.

You should, therefore, look in your process of code improvement for functions with many built-in type arguments and even worse, for functions that accept void* as parameter.

I.5: State preconditions (if any)

If possible, preconditions such that x in double sqrt(double x) must be non-negative, should be expressed as assertions.

Expects() from the Guideline support library (GSL) let you express your precondition directly.

double sqrt(double x) { Expects(x >= 0); /* ... */ }

Contracts, consisting of preconditions, postconditions, and assertions may be part of the next C++20 standard. See the proposal p03801.pdf.

I.6: Prefer Expects() for expressing preconditions

That is similar to the previous rule, but the emphasis is on a different aspect. You should use Expects() for expressing preconditions and not, for example, an if expression, a comment, or an assert() statement.

The expression Expects() is easier to spot and may be checkable by the upcoming C++20 standard.

I.7: State postconditions, I.8: Prefer Ensures() for expressing postconditions

In accordance to the arguments of a function, you have to think about its results. Therefore, the postcondition rules are quite similar to previous precondition rules.

I.9: If an interface is a template, document its parameters using concepts

We will get with high probability with C++20 concepts. Concepts are predicates on template parameters that ca be evaluated at compile time. A concept may limit the set of arguments that are accepted as template parameters. I already wrote four posts about concepts, because there is a lot more to concepts.

The rule of the C++ Core Guidelines is quite easy. You should apply them.

template<typename Iter, typename Val>
requires InputIterator<Iter> && EqualityComparable<ValueType<Iter>>, Val>
Iter find(Iter first, Iter last, Val v)
{
    // ...
}

The generic find algorithm requires that the template parameter Iter is an InputIterator and the underlying value of the template parameter Iter is EqualityComparable. If you invoke the find algorithm with a template argument that does not satisfy this requirement, you will get a readable and easy to understand error message.

I. 10: Use exceptions to signal a failure to perform a required task

Here is the reason: "It should not be possible to ignore an error because that could leave the system or a computation in an undefined (or unexpected) state."

The rule provides a bad and a good example.

int printf(const char* ...);    // bad: return negative number if output fails

template <class F, class ...Args>
// good: throw system_error if unable to start the new thread
explicit thread(F&& f, Args&&... args);

In the bad case, you can ignore the exception and your program has undefined behaviour.

If you can't use exceptions, you should return a pair of values. Thanks to C++17 feature structured binding, you can do it quite elegantly.

auto [val, error_code] = do_something();
if (error_code == 0) {
    // ... handle the error or exit ...
}
// ... use val ...?

What's next?

That is quite easy to guess. In the next post, I write about the remaining rules to pointers, initialisation of globals objects, function parameters, abstract classes, and ABI (application binary interface)? There is a lot to know about good interface design.