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>
84 lines
2.1 KiB
C
84 lines
2.1 KiB
C
/** @file
|
|
EFI_FILE_PROTOCOL wrappers for other items (Like Environment Variables, StdIn, StdOut, StdErr, etc...)
|
|
|
|
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
typedef struct {
|
|
LIST_ENTRY Link;
|
|
CHAR16 *Buffer;
|
|
} SHELL_LINE_LIST;
|
|
|
|
typedef struct {
|
|
UINTN LogCount;
|
|
SHELL_LINE_LIST *Log;
|
|
} SHELL_LINE_LOG;
|
|
|
|
///
|
|
/// FILE styte interfaces for StdIn.
|
|
///
|
|
extern EFI_FILE_PROTOCOL FileInterfaceStdIn;
|
|
|
|
///
|
|
/// FILE styte interfaces for StdOut.
|
|
///
|
|
extern EFI_FILE_PROTOCOL FileInterfaceStdOut;
|
|
|
|
///
|
|
/// FILE styte interfaces for StdErr.
|
|
///
|
|
extern EFI_FILE_PROTOCOL FileInterfaceStdErr;
|
|
|
|
///
|
|
/// FILE style interface for NUL file.
|
|
///
|
|
extern EFI_FILE_PROTOCOL FileInterfaceNulFile;
|
|
|
|
/**
|
|
Creates a EFI_FILE_PROTOCOL (almost) object for using to access
|
|
environment variables through file operations.
|
|
|
|
@param EnvName The name of the Environment Variable to be operated on.
|
|
|
|
@retval NULL Memory could not be allocated.
|
|
@return other a pointer to an EFI_FILE_PROTOCOL structure
|
|
**/
|
|
EFI_FILE_PROTOCOL *
|
|
CreateFileInterfaceEnv (
|
|
CONST CHAR16 *EnvName
|
|
);
|
|
|
|
/**
|
|
Creates a EFI_FILE_PROTOCOL (almost) object for using to access
|
|
a file entirely in memory through file operations.
|
|
|
|
@param[in] Unicode TRUE if the data is UNICODE, FALSE otherwise.
|
|
|
|
@retval NULL Memory could not be allocated.
|
|
@return other a pointer to an EFI_FILE_PROTOCOL structure
|
|
**/
|
|
EFI_FILE_PROTOCOL *
|
|
CreateFileInterfaceMem (
|
|
IN CONST BOOLEAN Unicode
|
|
);
|
|
|
|
/**
|
|
Creates a EFI_FILE_PROTOCOL (almost) object for using to access
|
|
a file entirely with unicode awareness through file operations.
|
|
|
|
@param[in] Template The pointer to the handle to start with.
|
|
@param[in] Unicode TRUE if the data is UNICODE, FALSE otherwise.
|
|
|
|
@retval NULL Memory could not be allocated.
|
|
@return other a pointer to an EFI_FILE_PROTOCOL structure
|
|
**/
|
|
EFI_FILE_PROTOCOL *
|
|
CreateFileInterfaceFile (
|
|
IN CONST EFI_FILE_PROTOCOL *Template,
|
|
IN CONST BOOLEAN Unicode
|
|
);
|