You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
8472271dae
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>
110 lines
2.6 KiB
C
110 lines
2.6 KiB
C
/** @file
|
|
Declares menubar interface functions.
|
|
|
|
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define SCAN_CONTROL_E 5
|
|
#define SCAN_CONTROL_F 6
|
|
#define SCAN_CONTROL_G 7
|
|
#define SCAN_CONTROL_K 11
|
|
#define SCAN_CONTROL_O 15
|
|
#define SCAN_CONTROL_Q 17
|
|
#define SCAN_CONTROL_R 18
|
|
#define SCAN_CONTROL_S 19
|
|
#define SCAN_CONTROL_T 20
|
|
#define SCAN_CONTROL_U 21
|
|
#define SCAN_CONTROL_W 23
|
|
#define SCAN_CONTROL_Z 26
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(*MENU_ITEM_FUNCTION) (
|
|
VOID
|
|
);
|
|
|
|
typedef struct _EDITOR_MENU_ITEM {
|
|
EFI_STRING_ID NameToken;
|
|
CHAR16 FunctionKeyToken;
|
|
MENU_ITEM_FUNCTION Function;
|
|
} EDITOR_MENU_ITEM;
|
|
|
|
/**
|
|
Initializa the menu bar with the specified items.
|
|
|
|
@param[in] Items The items to display and their functions.
|
|
|
|
@retval EFI_SUCCESS The initialization was correct.
|
|
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
|
**/
|
|
EFI_STATUS
|
|
MenuBarInit (
|
|
IN CONST EDITOR_MENU_ITEM *Items
|
|
);
|
|
|
|
/**
|
|
Initialize the control hot-key with the specified items.
|
|
|
|
@param[in] Items The hot-key functions.
|
|
|
|
@retval EFI_SUCCESS The initialization was correct.
|
|
**/
|
|
EFI_STATUS
|
|
ControlHotKeyInit (
|
|
IN MENU_ITEM_FUNCTION *Items
|
|
);
|
|
|
|
/**
|
|
Cleanup function for a menu bar. frees all allocated memory.
|
|
**/
|
|
VOID
|
|
MenuBarCleanup (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Refresh function for the menu bar.
|
|
|
|
@param[in] LastRow The last printable row.
|
|
@param[in] LastCol The last printable column.
|
|
|
|
@retval EFI_SUCCESS The refresh was successful.
|
|
**/
|
|
EFI_STATUS
|
|
MenuBarRefresh (
|
|
IN CONST UINTN LastRow,
|
|
IN CONST UINTN LastCol
|
|
);
|
|
|
|
/**
|
|
Function to dispatch the correct function based on a function key (F1...)
|
|
|
|
@param[in] Key The pressed key.
|
|
|
|
@retval EFI_NOT_FOUND The key was not a valid function key
|
|
(an error was sent to the status bar).
|
|
@return The return value from the called dispatch function.
|
|
**/
|
|
EFI_STATUS
|
|
MenuBarDispatchFunctionKey (
|
|
IN CONST EFI_INPUT_KEY *Key
|
|
);
|
|
|
|
/**
|
|
Function to dispatch the correct function based on a control-based key (ctrl+o...)
|
|
|
|
@param[in] KeyData The pressed key.
|
|
|
|
@retval EFI_NOT_FOUND The key was not a valid control-based key
|
|
(an error was sent to the status bar).
|
|
@return EFI_SUCCESS.
|
|
**/
|
|
EFI_STATUS
|
|
MenuBarDispatchControlHotKey (
|
|
IN CONST EFI_KEY_DATA *KeyData
|
|
);
|