| Elektra 0.11.0

Including Headers

# Problem

In C you can include a header file with

#include "header.h"

or

#include <header.h>

In the C standard, section 6.10.2, paragraphs 2 to 4 state:

> ‍2. A preprocessing directive of the form

> #include <h-char-sequence> new-line

> searches a sequence of implementation-defined places for a header identified uniquely by the specified sequence between the `<` and `>` delimiters, and causes the replacement of that directive by the entire contents of the header. How the places are specified or the header identified is implementation-defined.

> 1. A preprocessing directive of the form

>    #include "q-char-sequence" new-line

>    causes the replacement of that directive by the entire contents of the source file identified by the specified sequence between the `"</tt> delimiters. The named source file is searched for in an implementation-defined manner. If this search is not supported, or if the search fails, the directive is reprocessed as if it read @icode{c} #include <h-char-sequence> new-line @endicode with the identical contained sequence (including <tt>\></tt> characters, if any) from the original directive. 4. A preprocessing directive of the form @icode{c} #include pp-tokens new-line @endicode (that does not match one of the two previous forms) is permitted. The preprocessing tokens after include in the directive are processed just as in normal text. (Each identifier currently defined as a macro name is replaced by its replacement list of preprocessing tokens.) The directive resulting after all replacements shall match one of the two previous forms. The method by which a sequence of preprocessing tokens between a <tt>\<</tt> and a <tt>\></tt> preprocessing token pair or a pair of <tt>"` characters is combined into a single header name preprocessing token is implementation-defined.

## Definitions:

- h-char: any member of the source character set except the new-line character and `>`
- q-char: any member of the source character set except the new-line character and `"</tt> </blockquote> In short, the whole search process of the <tt>\#include</tt> mechanism is implementation-defined. However, because <tt>\#include</tt> works (mostly) like a literal copy-paste, deciding between <tt>""</tt> and <tt>\<\></tt> within a public header file can affect user code. @section autotoc_md2100 Assumptions - Modern Compilers work like <a href="https://gcc.gnu.org/onlinedocs/cpp/header-files/search-path.html" >GCC</a>: - <tt>\#include "[header]"</tt> treats <tt>[header]</tt> as file path relative to the current file (as defined by the standard, if such a file doesn't exist there is a fallback to the <tt>\<\></tt> behavior) - <tt>\#include \<[header]\></tt> treats <tt>[header]</tt> as file path relative to one of the pre-defined include-paths - We can write a tool that enforces all rules in this decision, in such a way that new contributors can learn the rules as they go. @section autotoc_md2101 Considered Alternatives - Let developers decide: This would just create inconsistent code. - Put all headers into one directory and use the same relative layout as will be installed. Then use <tt>""</tt>: This makes for an inconvenient development experience. It is also pretty hard to achieve for plugins and private headers would clutter the include-directory. - Only use <tt>\#include \<\></tt> and add everything to include path. This makes the build setup more complicated. It also makes it much easier to accidentally include a non-installed header in an installed one. @section autotoc_md2102 Decision The rules for including headers are: - To include a private non-installed header (i.e., a file that is only available in the source repo) use: @icode{c} #include "./header.h" // or #include "./subdir/header.h" @endicode It should not be necessary, to include a private non-installed header from another directory. This ensures that libraries only use their own private APIs. Going up one (or more) directories, but staying in the same library would be okay, but is considered an indication of bad code structure. A library can always be restructured to avoid needing a <tt>\#include "../`.
- Internal non-installed headers (i.e., a file that is not installed, but contains APIs exposed to other libraries within Elektra) can be included with
  #include <internal/somelib.h>
  // or
  #include <internal/somelib/header.h>
  Since these internal headers are not installed, they must only be included from other headers that are not installed or from code files.
- Installed headers are included with their full path as if they are installed already:
  #include <elektra/somelib.h>
  // or
  #include <elektra/somelib/header.h>
- System headers or headers for external libraries are included with:
  #include <stdlib.h>
  #include <dbus/dbus.h>
  // etc.

Only `build/include`, which is a copy of `src/include` after CMake processing, is added to the include path. The entire `build/include/elektra` directory is installed as-is, with the exact same directory structure and without any further processing.

This is enough for `#include <>`s to work.

But we will create an additional script that enforces that `internal/*` headers are not included from headers in `src/include/elektra`. We will also enforce that the path in a `#include ""` always starts with a `./` and does not contain any `/../`.

These include-rules do not apply to tests. Tests can include anything (including `.c` files) from anywhere within the code base to allow testing private APIs.

# Rationale

The decision highlights the difference between installed and non-installed headers. The main driving factor for using `""` at all was that including a non-installed private header with `<>` would be unexpected, since non-installed headers shouldn't be in the (standard) include-path. This distinction also makes it easier to ensure that non-installed headers are not accidentally included in installed ones.

See also considered alternatives.

# Implications

- All installed headers (and only those) must be put into `src/include/elektra`.
- To enforce the restrictions on the path in an `#include ""`, we will use a simple `grep`-based script that runs as a test case and as an early part of the CI (like e.g., the formatting check).
- There must not be any `#include <internal/...>`s anywhere within `src/include/elektra`. This will be enforced by the same `grep`-based script as the paths in `#include ""`.

# Related Decisions

- Header File Structure
- Library Directory Structure

# Notes