You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
7a934d0bef
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>
139 lines
3.6 KiB
C
139 lines
3.6 KiB
C
/** @file
|
|
This library class defines a set of interfaces to be used by customize Ui module
|
|
|
|
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
Create Time Out Menu in the page.
|
|
|
|
@param[in] HiiHandle The hii handle for the Uiapp driver.
|
|
@param[in] StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateTimeOutMenu (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Create the dynamic item to allow user to set the "BootNext" vaule.
|
|
|
|
@param[in] HiiHandle The hii handle for the Uiapp driver.
|
|
@param[in] StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateBootNextMenu (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Create Boot Option menu in the page.
|
|
|
|
@param[in] HiiHandle The hii handle for the Uiapp driver.
|
|
@param[in] StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateBootOptionMenu (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Create Driver Option menu in the page.
|
|
|
|
@param[in] HiiHandle The hii handle for the Uiapp driver.
|
|
@param[in] StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateDriverOptionMenu (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Create Com Option menu in the page.
|
|
|
|
@param[in] HiiHandle The hii handle for the Uiapp driver.
|
|
@param[in] StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateComOptionMenu (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Create Com Option menu in the page.
|
|
|
|
@param[in] HiiHandle The hii handle for the Uiapp driver.
|
|
@param[in] StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateBootFromFileMenu (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Create empty line menu in the front page.
|
|
|
|
@param HiiHandle The hii handle for the Uiapp driver.
|
|
@param StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
**/
|
|
VOID
|
|
BmmCreateEmptyLine (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|
|
|
|
/**
|
|
Rename the driver name if necessary.
|
|
|
|
@param DriverName Input the driver name.
|
|
@param NewDriverName Return the new driver name.
|
|
@param EmptyLineAfter Whether need to insert empty line.
|
|
|
|
@retval New driver name if compared, else NULL.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *DRIVER_SPECIAL_HANDLER)(
|
|
IN CHAR16 *DriverName,
|
|
OUT CHAR16 **NewName,
|
|
OUT BOOLEAN *EmptyLineAfter
|
|
);
|
|
|
|
/**
|
|
Search the drivers in the system which need to show in the front page
|
|
and insert the menu to the front page.
|
|
|
|
@param HiiHandle The hii handle for the Uiapp driver.
|
|
@param ClassGuid The class guid for the driver which is the target.
|
|
@param SpecialHandlerFn The pointer to the specail handler function, if any.
|
|
@param StartOpCodeHandle The opcode handle to save the new opcode.
|
|
|
|
@retval EFI_SUCCESS Search the driver success
|
|
|
|
**/
|
|
EFI_STATUS
|
|
BmmListThirdPartyDrivers (
|
|
IN EFI_HII_HANDLE HiiHandle,
|
|
IN EFI_GUID *ClassGuid,
|
|
IN DRIVER_SPECIAL_HANDLER SpecialHandlerFn,
|
|
IN VOID *StartOpCodeHandle
|
|
);
|