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>
86 lines
2.1 KiB
C
86 lines
2.1 KiB
C
/** @file
|
|
EFI Shell Interface protocol from EDK shell (no spec).
|
|
|
|
Shell Interface - additional information (over image_info) provided
|
|
to an application started by the shell.
|
|
|
|
ConIo provides a file-style interface to the console.
|
|
|
|
The shell interface's and data (including ConIo) are only valid during
|
|
the applications Entry Point. Once the application returns from it's
|
|
entry point the data is freed by the invoking shell.
|
|
|
|
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/SimpleFileSystem.h>
|
|
|
|
#define SHELL_INTERFACE_PROTOCOL_GUID \
|
|
{ \
|
|
0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \
|
|
}
|
|
|
|
///
|
|
/// Bit definitions for EFI_SHELL_ARG_INFO
|
|
///
|
|
typedef enum {
|
|
ARG_NO_ATTRIB = 0x0,
|
|
ARG_IS_QUOTED = BIT0,
|
|
ARG_PARTIALLY_QUOTED = BIT1,
|
|
ARG_FIRST_HALF_QUOTED = BIT2,
|
|
ARG_FIRST_CHAR_IS_ESC = BIT3
|
|
} EFI_SHELL_ARG_INFO_TYPES;
|
|
|
|
///
|
|
/// Attributes for an argument.
|
|
///
|
|
typedef struct _EFI_SHELL_ARG_INFO {
|
|
UINT32 Attributes;
|
|
} EFI_SHELL_ARG_INFO;
|
|
|
|
///
|
|
/// This protocol provides access to additional information about a shell application.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// Handle back to original image handle & image information.
|
|
///
|
|
EFI_HANDLE ImageHandle;
|
|
EFI_LOADED_IMAGE_PROTOCOL *Info;
|
|
|
|
///
|
|
/// Parsed arg list converted more C-like format.
|
|
///
|
|
CHAR16 **Argv;
|
|
UINTN Argc;
|
|
|
|
///
|
|
/// Storage for file redirection args after parsing.
|
|
///
|
|
CHAR16 **RedirArgv;
|
|
UINTN RedirArgc;
|
|
|
|
///
|
|
/// A file style handle for console io.
|
|
///
|
|
EFI_FILE_PROTOCOL *StdIn;
|
|
EFI_FILE_PROTOCOL *StdOut;
|
|
EFI_FILE_PROTOCOL *StdErr;
|
|
|
|
///
|
|
/// List of attributes for each argument.
|
|
///
|
|
EFI_SHELL_ARG_INFO *ArgInfo;
|
|
|
|
///
|
|
/// Whether we are echoing.
|
|
///
|
|
BOOLEAN EchoOn;
|
|
} EFI_SHELL_INTERFACE;
|
|
|
|
extern EFI_GUID gEfiShellInterfaceGuid;
|