POC: Self-contained headers #1423

1. 
   hebasto commented at 10:39 pm on September 11, 2023: member

   This PR adds a tool that verifies every header whether it is self-contained.

   As an example, the field_5x52.h and field_10x26.h headers have been refactored to get self-contained.

2. Add `tools/check_header.sh` to check whether headers are self-contained e44e8df1e7
3. refactor: Make `field_NxM.h` headers self-contained 652afd3960
4. real-or-random added the label ci on Sep 12, 2023
5. real-or-random added the label build on Sep 12, 2023
6. real-or-random added the label refactor/smell on Sep 12, 2023
7. real-or-random added the label development on Sep 12, 2023
8. 
   real-or-random commented at 8:13 am on September 12, 2023: contributor

   Interesting!

   This raises the question: Should self-containedness be tested in VERIFY mode, or non-VERIFY mode, or both? I believe at least in VERIFY mode because the goal here will be to help development tooling (e.g., clangd), and development is typically more convenient in VERIFY mode. Otherwise all #ifdef VERIFY blocks don’t exist, i.e., you don’t even get syntax highlighting for them…

   Of course, we could manage to make this happen in both modes without too much hassle, that will be ideal.

   This is related to #1039, where I suggested something like this.

9. 
   hebasto commented at 2:26 pm on September 12, 2023: member

   This is related to #1039, where I suggested something like this.

   I’ve been working on this branch a few months but decided to PR it now as I feel it might help with #1421 (comment).

Contributors
hebasto real-or-random

Labels
ci build refactor/smell development