Should I include every header?

by

TLDR

If you use it, include it.

The longer version…

If you use a header related entity (e.g. some type) in a file, you should include the related header for it. Don’t rely on headers to include each other. If you use it, include it.

The C++ standard library doesn’t mandate inclusion of <string> in <vector> nor vice-versa. Trying to make use of functionality like this would limit the code to a specific implementation. In general, the standard library headers may or may not include other headers (or their own internal headers) in an unspecified order or manner. One notable exception is <initializer_list> which is required to be included in a few of the other standard headers. Changes to this unspecified order or manner can also happen, thus breaking previously compiling code with the updated compiler or an updated standard library implementation (this has been known to happen).

Also consider that if the header file is the definition for the class, then it should include what is required for the definition of that class. The associated .cpp should include its associated .h and the remaining files required to implement the class. Don’t need it, don’t include it; don’t include more than needed (llvm style guide). One exception here is templates (that don’t have an associated .cpp); this exception would apply to other header only implementations.

It is noted that maintenance of the include what you use can be difficult in the long run; thus it makes sense that it is important in the beginning of the coding cycle to include what is required for the interface; and then again to check the includes with any reasonable change that is made to the code.

There seems to be some progress w.r.t. tools in this regard, such as the iwyu project, that uses the clang tool chain and seems to have support for msvc as well.

One counter example would be if the reason for the header is to include other headers, then maybe, but even then I would be very careful – make sure it is clearly defined what it includes. An example of this could be a precompiled header.

More Related Contents:

  1. what is the concept of evaluation of expression z = (y = 30) + (y = 10) + (y = 20); [closed]
  2. Why C++11 in-class initializer cannot use parentheses?
  3. Sorting zipped (locked) containers in C++ using boost or the STL
  4. When should I really use noexcept?
  5. Is local static variable initialization thread-safe in C++11? [duplicate]
  6. What does the single ampersand after the parameter list of a member function declaration mean?
  7. What does the thread_local mean in C++11?
  8. What is the ‘override’ keyword in C++ used for? [duplicate]
  9. Does constexpr imply inline?
  10. When to use std::forward to forward arguments?
  11. Using member variable in lambda capture list inside a member function
  12. The reason of using `std::greater` for creating min heap via `priority_queue`
  13. C++11: The range-based for statement: “range-init” lifetime?
  14. istream behavior change in C++ upon failure
  15. Do rvalue references allow dangling references?
  16. Initializer list not working with vector in Visual Studio 2012? [duplicate]
  17. On how to recognize Rvalue or Lvalue reference and if-it-has-a-name rule
  18. What does the void() in decltype(void()) mean exactly?
  19. Why does std::istringstream appear to resolve differently to std::ifstream in the ternary (?:) operator?
  20. What is std::promise?
  21. Random output different between implementations
  22. How can I pass std::unique_ptr into a function
  23. Understanding rvalue references
  24. C++11 std::threads vs posix threads
  25. How to know underlying type of class enum?
  26. In lambda functions syntax, what purpose does a ‘capture list’ serve?
  27. Multiple “could not be resolved” problems using Eclipse with minGW
  28. c++11 std::async doesn’t work in mingw
  29. Explicit Return Type of Lambda
  30. Why is this C++ wrapper class not being inlined away?

Leave a Comment