isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-30 03:50:47 -05:00
Code Issues Packages Projects Releases Wiki Activity

HACKING: Describe include order

Browse Source 
It's what we ended up with, so lets describe it.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3297>
This commit is contained in:
Jonas Ådahl 2023-09-27 14:21:37 +08:00 committed by Marge Bot
parent 8f4ab53bd6
commit da8f881551
1 changed files with 44 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
HACKING.md
View File

@ -75,17 +75,50 @@ MetaUdev * meta_udev_new (MetaBackendNative *backend_native);
Keep functions in the following order in source files: Keep functions in the following order in source files:
1. GPL header 1. GPL header
2. Enums 2. Include header files
3. Structures 3. Enums
4. Function prototypes 4. Structures
5. `G_DEFINE_TYPE()` 5. Function prototypes
6. Static variables 6. `G_DEFINE_TYPE()`
7. Auxiliary functions 7. Static variables
8. Callbacks 8. Auxiliary functions
9. Interface implementations 9. Callbacks
10. Parent vfunc overrides 10. Interface implementations
11. class_init and init 11. Parent vfunc overrides
12. Public API 12. class_init and init
13. Public API
### Include header files
Source files should use the header include order of the following example:
* `meta-example.c`:
```c
#include "config.h"
#include "meta-example-private.h"
#include <glib-object.h>
#include <stdint.h>
#ifdef HAVE_WAYLAND
#include <wayland-server-core.h>
#endif
#include "clutter/clutter.h"
#include "backends/meta-backend-private.h"
#include "mtk/mtk.h"
#ifdef HAVE_WAYLAND
#include "wayland/meta-wayland-surface.h"
#endif
#include "meta-dbus-file-generated-by-gdbus-codegen.h"
```
Include paths for non-system includes should be relative to the corresponding
modules source root; i.e. `"backends/meta-backend-private.h"` for
`src/backends/` and `"clutter/clutter.h"` for `clutter/clutter/clutter.h`.
### Structures ### Structures