mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
01f75b3927
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
90 lines
2 KiB
C
90 lines
2 KiB
C
/** @file
|
|
|
|
Copyright (c) 2017 - 2021, Arm Limited. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/** Is a character upper case
|
|
*/
|
|
#define IS_UPPER_CHAR(x) ((x >= 'A') && (x <= 'Z'))
|
|
|
|
/** Is a character a decimal digit
|
|
*/
|
|
#define IS_DIGIT(x) ((x >= '0') && (x <= '9'))
|
|
|
|
/** Is a character an upper case hexadecimal digit
|
|
*/
|
|
#define IS_UPPER_HEX(x) (((x >= 'A') && (x <= 'F')) || IS_DIGIT (x))
|
|
|
|
/** Convert a hex number to its ASCII code.
|
|
|
|
@param [in] Hex Hex number to convert.
|
|
Must be 0 <= x < 16.
|
|
|
|
@return The ASCII code corresponding to x.
|
|
-1 if error.
|
|
**/
|
|
UINT8
|
|
EFIAPI
|
|
AsciiFromHex (
|
|
IN UINT8 Hex
|
|
);
|
|
|
|
/** Convert an ASCII char representing an hexadecimal number
|
|
to its integer value.
|
|
|
|
@param [in] Char Char to convert.
|
|
Must be between '0'-'9' or 'A'-'F' or 'a'-'f'.
|
|
|
|
@return The corresponding integer (between 0-16).
|
|
-1 if error.
|
|
**/
|
|
UINT8
|
|
EFIAPI
|
|
HexFromAscii (
|
|
IN CHAR8 Char
|
|
);
|
|
|
|
/** Check if a HID is a valid PNP ID.
|
|
|
|
@param [in] Hid The Hid to validate.
|
|
|
|
@retval TRUE The Hid is a valid PNP ID.
|
|
@retval FALSE The Hid is not a valid PNP ID.
|
|
**/
|
|
BOOLEAN
|
|
IsValidPnpId (
|
|
IN CONST CHAR8 *Hid
|
|
);
|
|
|
|
/** Check if a HID is a valid ACPI ID.
|
|
|
|
@param [in] Hid The Hid to validate.
|
|
|
|
@retval TRUE The Hid is a valid ACPI ID.
|
|
@retval FALSE The Hid is not a valid ACPI ID.
|
|
**/
|
|
BOOLEAN
|
|
IsValidAcpiId (
|
|
IN CONST CHAR8 *Hid
|
|
);
|
|
|
|
/** Convert a EisaId string to its compressed UINT32 equivalent.
|
|
|
|
Cf. ACPI 6.4 specification, s19.3.4 "ASL Macros": "Eisaid"
|
|
|
|
@param [in] EisaIdStr Input EisaId string.
|
|
@param [out] EisaIdInt Output EisaId UINT32 (compressed).
|
|
|
|
@retval EFI_SUCCESS The function completed successfully.
|
|
@retval EFI_INVALID_PARAMETER Invalid parameter.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
AmlGetEisaIdFromString (
|
|
IN CONST CHAR8 *EisaIdStr,
|
|
OUT UINT32 *EisaIdInt
|
|
);
|