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.7 KiB
C
86 lines
2.7 KiB
C
/** @file
|
|
Provides interface to shell functionality for shell commands and applications.
|
|
|
|
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi.h>
|
|
|
|
#include <Guid/FileInfo.h>
|
|
|
|
#include <Protocol/SimpleFileSystem.h>
|
|
#include <Protocol/LoadedImage.h>
|
|
#include <Protocol/EfiShellInterface.h>
|
|
#include <Protocol/EfiShellEnvironment2.h>
|
|
#include <Protocol/Shell.h>
|
|
#include <Protocol/ShellParameters.h>
|
|
#include <Protocol/UnicodeCollation.h>
|
|
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/FileHandleLib.h>
|
|
#include <Library/PrintLib.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/HiiLib.h>
|
|
#include <Library/ShellLib.h>
|
|
|
|
typedef struct {
|
|
EFI_SHELL_GET_FILE_INFO GetFileInfo;
|
|
EFI_SHELL_SET_FILE_INFO SetFileInfo;
|
|
EFI_SHELL_READ_FILE ReadFile;
|
|
EFI_SHELL_WRITE_FILE WriteFile;
|
|
EFI_SHELL_CLOSE_FILE CloseFile;
|
|
EFI_SHELL_DELETE_FILE DeleteFile;
|
|
EFI_SHELL_GET_FILE_POSITION GetFilePosition;
|
|
EFI_SHELL_SET_FILE_POSITION SetFilePosition;
|
|
EFI_SHELL_FLUSH_FILE FlushFile;
|
|
EFI_SHELL_GET_FILE_SIZE GetFileSize;
|
|
} FILE_HANDLE_FUNCTION_MAP;
|
|
|
|
/**
|
|
Function to determin if an entire string is a valid number.
|
|
|
|
If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
|
|
|
|
@param[in] String The string to evaluate.
|
|
@param[in] ForceHex TRUE - always assume hex.
|
|
@param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
|
|
@param[in] TimeNumbers TRUE to allow numbers with ":", FALSE otherwise.
|
|
|
|
@retval TRUE It is all numeric (dec/hex) characters.
|
|
@retval FALSE There is a non-numeric character.
|
|
**/
|
|
BOOLEAN
|
|
InternalShellIsHexOrDecimalNumber (
|
|
IN CONST CHAR16 *String,
|
|
IN CONST BOOLEAN ForceHex,
|
|
IN CONST BOOLEAN StopAtSpace,
|
|
IN CONST BOOLEAN TimeNumbers
|
|
);
|
|
|
|
/**
|
|
Cleans off all the quotes in the string.
|
|
|
|
@param[in] OriginalString pointer to the string to be cleaned.
|
|
@param[out] CleanString The new string with all quotes removed.
|
|
Memory allocated in the function and free
|
|
by caller.
|
|
|
|
@retval EFI_SUCCESS The operation was successful.
|
|
**/
|
|
EFI_STATUS
|
|
InternalShellStripQuotes (
|
|
IN CONST CHAR16 *OriginalString,
|
|
OUT CHAR16 **CleanString
|
|
);
|