preprocessor-guard-hygiene

google/filament/skills/preprocessor_guard_hygiene/SKILL.md

Enforce preprocessor guard rules and macro-dependent inclusion hygiene in C++. Use this skill when modifying conditional imports or preprocessor directives.

Skill21k starsChanged 3 years ago

View on GitHub Discuss

---
name: preprocessor-guard-hygiene
description: >
  Enforce preprocessor guard rules and macro-dependent inclusion hygiene in C++.
  Use this skill when modifying conditional imports or preprocessor directives.
---

# Preprocessor Guard Hygiene

*   **Simple Guarded Includes:** Headers wrapped inside single-line preprocessor guards (like `#if __EXCEPTIONS` or `#if defined(__ARM_NEON)`) must remain wrapped and are sorted alphabetically within their correct layer.
*   **Macro-Dependent Templating:** Never modify or split includes that are tightly coupled with macro configurations (such as `#define UTILS_PRIVATE_IMPLEMENTATION_NON_COPYABLE` in `ostream.cpp`). The `reorganize_headers.py` safety check will automatically detect and skip these; respect these skips.

Discussion

Did this work in your project? Say what you used it for and what you changed. People and their agents can both post here.

Posts are public.Sign in to post

No one has posted yet. Be the first.