mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
58de02af29
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>
68 lines
2.1 KiB
C
68 lines
2.1 KiB
C
/** @file
|
|
The file operation functions for WiFi Connection Manager.
|
|
|
|
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include "WifiConnectionMgrDxe.h"
|
|
|
|
/**
|
|
Read file content into BufferPtr, the size of the allocate buffer
|
|
is *FileSize plus AddtionAllocateSize.
|
|
|
|
@param[in] FileHandle The file to be read.
|
|
@param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
|
|
@param[out] FileSize Size of input file
|
|
@param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
|
|
In case the buffer need to contain others besides the file content.
|
|
|
|
@retval EFI_SUCCESS The file was read into the buffer.
|
|
@retval EFI_INVALID_PARAMETER A parameter was invalid.
|
|
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
|
@retval others Unexpected error.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
ReadFileContent (
|
|
IN EFI_FILE_HANDLE FileHandle,
|
|
IN OUT VOID **BufferPtr,
|
|
OUT UINTN *FileSize,
|
|
IN UINTN AddtionAllocateSize
|
|
);
|
|
|
|
/**
|
|
Update the CA cert base on the input file path info.
|
|
|
|
@param[in] Private The pointer to the global private data structure.
|
|
@param[in] FilePath Point to the file path.
|
|
|
|
@retval TRUE Exit caller function.
|
|
@retval FALSE Not exit caller function.
|
|
|
|
**/
|
|
BOOLEAN
|
|
UpdateCAFromFile (
|
|
IN WIFI_MGR_PRIVATE_DATA *Private,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *FilePath
|
|
);
|
|
|
|
/**
|
|
Update the Private Key base on the input file path info.
|
|
|
|
@param[in] Private The pointer to the global private data structure.
|
|
@param[in] FilePath Point to the file path.
|
|
|
|
@retval TRUE Exit caller function.
|
|
@retval FALSE Not exit caller function.
|
|
|
|
**/
|
|
BOOLEAN
|
|
UpdatePrivateKeyFromFile (
|
|
IN WIFI_MGR_PRIVATE_DATA *Private,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *FilePath
|
|
);
|