Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix eaassert.h include guard #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix eaassert.h include guard #3

wants to merge 1 commit into from

Commits on Mar 26, 2023

  1. Fix eaassert.h include guard 

    `eassert.h` does not have a strict enough include guard to trigger the multiple
inclusion optimization on most compilers.

The `#if defined(EA_PRAGMA_ONCE_SUPPORTED)` check occurs before any include of
`eacompilertraits.h` (where `EA_PRAGMA_ONCE_SUPPORTED` is defined) so the
preprocessor sees the `#pragma once` only if `eassert.h` is included **after**
another header that includes `eacompilertraits.h`.

The traditional include guard is also not strict enough to trigger the
multiple-inclusion optimization as the only tokens that can appear outside of
the `#ifdef`/`#endif` pair are whitespace, comments, and the null directive `#`
(for certain compilers
https://gcc.gnu.org/onlinedocs/cppinternals/Guard-Macros.html).  However, the
previously mentioned `EA_PRAGMA_ONCE_SUPPORTED` check disables this
optimization.

This commit moves the `#pragma once` code after the include directive where
`EA_PRAGMA_ONCE_SUPPORTED` would be defined.  It also tidies up the traditional
include guard so that it satisfies the stricter rules mentioned above.

This was issues was found with IncludeGuardian 0.0.7.
    IncludeGuardian committed Mar 26, 2023
    Configuration menu
    Copy the full SHA
    a9e539f View commit details
    Browse the repository at this point in the history