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>
67 lines
2.0 KiB
C
67 lines
2.0 KiB
C
/** @file
|
|
|
|
This file explorer protocol defines defines a set of interfaces for
|
|
how to do file explorer.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define EFI_FILE_EXPLORER_PROTOCOL_GUID \
|
|
{ 0x2C03C536, 0x4594, 0x4515, { 0x9E, 0x7A, 0xD3, 0xD2, 0x04, 0xFE, 0x13, 0x63 } }
|
|
|
|
//
|
|
// Forward reference for pure ANSI compatability
|
|
//
|
|
typedef struct _EFI_FILE_EXPLORER_PROTOCOL EFI_FILE_EXPLORER_PROTOCOL;
|
|
|
|
/**
|
|
Prototype for the next process after user chosed one file.
|
|
|
|
@param[in] FilePath The device path of the find file.
|
|
|
|
@retval TRUE Need exit file explorer after do the extra task.
|
|
@retval FALSE Not need to exit file explorer after do the extra task.
|
|
|
|
**/
|
|
typedef
|
|
BOOLEAN
|
|
(EFIAPI *CHOOSE_HANDLER)(
|
|
IN EFI_DEVICE_PATH_PROTOCOL *FilePath
|
|
);
|
|
|
|
/**
|
|
Choose a file in the specified directory.
|
|
|
|
If user input NULL for the RootDirectory, will choose file in the system.
|
|
|
|
If user input *File != NULL, function will return the allocate device path
|
|
info for the choosed file, caller has to free the memory after use it.
|
|
|
|
@param RootDirectory Pointer to the root directory.
|
|
@param FileType The file type need to choose.
|
|
@param ChooseHandler Function pointer to the extra task need to do
|
|
after choose one file.
|
|
@param File Return the device path for the last time chosed file.
|
|
|
|
@retval EFI_SUCCESS Choose the file success.
|
|
@retval Other errors Choose the file failed.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *CHOOSE_FILE)(
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory,
|
|
IN CHAR16 *FileType OPTIONAL,
|
|
IN CHOOSE_HANDLER ChooseHandler OPTIONAL,
|
|
OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL
|
|
);
|
|
|
|
struct _EFI_FILE_EXPLORER_PROTOCOL {
|
|
CHOOSE_FILE ChooseFile;
|
|
};
|
|
|
|
extern EFI_GUID gEfiFileExplorerProtocolGuid;
|