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>
85 lines
2.7 KiB
C
85 lines
2.7 KiB
C
/** @file
|
|
Configuration Manager Object parser.
|
|
|
|
Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
|
|
Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define OUTPUT_FIELD_COLUMN_WIDTH 32
|
|
|
|
/** A helper macro for populating the Reserved objects
|
|
like EArmObjReserved, EArmObjMax, etc. in the CM_OBJ_PARSER_ARRAY.
|
|
**/
|
|
#define CM_PARSER_ADD_OBJECT_RESERVED(ObjectId) \
|
|
{ObjectId, #ObjectId, NULL, 0}
|
|
|
|
/** A helper macro for populating the Cm Arm objects
|
|
in the CM_OBJ_PARSER_ARRAY.
|
|
**/
|
|
#define CM_PARSER_ADD_OBJECT(ObjectId, Parser) \
|
|
{ObjectId, #ObjectId, Parser, ARRAY_SIZE(Parser) }
|
|
|
|
/** Function prototype to format a field print.
|
|
|
|
@param [in] Format Format string for tracing the data as specified by
|
|
the 'Format' member of ACPI_PARSER.
|
|
@param [in] Ptr Pointer to the start of the buffer.
|
|
@param [in] Length Length of the field
|
|
**/
|
|
typedef VOID (EFIAPI *FNPTR_PRINT_FORMATTER)(CONST CHAR8 *Format, UINT8 *Ptr, UINT32 Length);
|
|
|
|
/**
|
|
The CM_OBJ_PARSER structure describes the fields of an CmObject and
|
|
provides means for the parser to interpret and trace appropriately.
|
|
|
|
ParseAcpi() uses the format string specified by 'Format' for tracing
|
|
the field data.
|
|
*/
|
|
typedef struct CmObjParser CM_OBJ_PARSER;
|
|
struct CmObjParser {
|
|
/// String describing the Cm Object
|
|
CONST CHAR8 *NameStr;
|
|
|
|
/// The length of the field.
|
|
UINT32 Length;
|
|
|
|
/// Optional Print() style format string for tracing the data. If not
|
|
/// used this must be set to NULL.
|
|
CONST CHAR8 *Format;
|
|
|
|
/// Optional pointer to a print formatter function which
|
|
/// is typically used to trace complex field information.
|
|
/// If not used this must be set to NULL.
|
|
/// The Format string is passed to the PrintFormatter function
|
|
/// but may be ignored by the implementation code.
|
|
FNPTR_PRINT_FORMATTER PrintFormatter;
|
|
|
|
/// Optional pointer to print the fields of another CM_OBJ_PARSER
|
|
/// structure. This is useful to print sub-structures.
|
|
CONST CM_OBJ_PARSER *SubObjParser;
|
|
|
|
/// Count of items in the SubObj.
|
|
UINTN SubObjItemCount;
|
|
};
|
|
|
|
/**
|
|
A structure mapping an array of Configuration Manager Object parsers
|
|
with their object names.
|
|
*/
|
|
typedef struct CmObjParserArray {
|
|
/// Object ID
|
|
CONST UINTN ObjectId;
|
|
|
|
/// Object name
|
|
CONST CHAR8 *ObjectName;
|
|
|
|
/// Function pointer to the parser
|
|
CONST CM_OBJ_PARSER *Parser;
|
|
|
|
/// Count of items
|
|
UINTN ItemCount;
|
|
} CM_OBJ_PARSER_ARRAY;
|