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>
50 lines
1.7 KiB
C
50 lines
1.7 KiB
C
/** @file
|
|
FrontPage routines to handle the callbacks and browser calls
|
|
|
|
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi.h>
|
|
#include <Guid/MdeModuleHii.h>
|
|
#include <Library/UefiBootManagerLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/HiiLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Protocol/LoadedImage.h>
|
|
#include <Protocol/BootLogo.h>
|
|
|
|
#define TITLE_TOKEN_COUNT 1
|
|
#define HELP_TOKEN_COUNT 3
|
|
|
|
typedef struct _BOOT_MENU_SCREEN {
|
|
UINTN StartCol;
|
|
UINTN StartRow;
|
|
UINTN Width;
|
|
UINTN Height;
|
|
} BOOT_MENU_SCREEN;
|
|
|
|
typedef struct _BOOT_MENU_SCROLL_BAR_CONTROL {
|
|
BOOLEAN HasScrollBar;
|
|
UINTN ItemCountPerScreen;
|
|
UINTN FirstItem;
|
|
UINTN LastItem;
|
|
} BOOT_MENU_SCROLL_BAR_CONTROL;
|
|
|
|
typedef struct _BOOT_MENU_POPUP_DATA {
|
|
EFI_STRING_ID TitleToken[TITLE_TOKEN_COUNT]; // Title string ID
|
|
UINTN ItemCount; // Selectable item count
|
|
EFI_STRING_ID *PtrTokens; // All of selectable items string ID
|
|
EFI_STRING_ID HelpToken[HELP_TOKEN_COUNT]; // All of help string ID
|
|
UINTN SelectItem; // Current select item
|
|
BOOT_MENU_SCREEN MenuScreen; // Boot menu screen information
|
|
BOOT_MENU_SCROLL_BAR_CONTROL ScrollBarControl; // Boot menu scroll bar information
|
|
} BOOT_MENU_POPUP_DATA;
|