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>
42 lines
1 KiB
C
42 lines
1 KiB
C
/** @file
|
|
Define NVData structures used by the HTTP Boot configuration component.
|
|
|
|
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Guid/HttpBootConfigHii.h>
|
|
|
|
#define HTTP_BOOT_IP_VERSION_4 0
|
|
#define HTTP_BOOT_IP_VERSION_6 1
|
|
|
|
//
|
|
// Macros used for an IPv4 or an IPv6 address.
|
|
//
|
|
#define URI_STR_MIN_SIZE 0
|
|
#define URI_STR_MAX_SIZE 255
|
|
|
|
#define DESCRIPTION_STR_MIN_SIZE 6
|
|
#define DESCRIPTION_STR_MAX_SIZE 75
|
|
|
|
#define CONFIGURATION_VARSTORE_ID 0x1234
|
|
|
|
#define FORMID_MAIN_FORM 1
|
|
|
|
#define KEY_INITIATOR_URI 0x101
|
|
#define KEY_INITIATOR_PROXY_URI 0x102
|
|
|
|
#define HTTP_BOOT_DEFAULT_DESCRIPTION_STR L"UEFI HTTP"
|
|
|
|
#pragma pack(1)
|
|
typedef struct _HTTP_BOOT_CONFIG_IFR_NVDATA {
|
|
UINT8 IpVersion;
|
|
UINT8 Padding;
|
|
CHAR16 Description[DESCRIPTION_STR_MAX_SIZE];
|
|
CHAR16 Uri[URI_STR_MAX_SIZE];
|
|
CHAR16 ProxyUri[URI_STR_MAX_SIZE];
|
|
} HTTP_BOOT_CONFIG_IFR_NVDATA;
|
|
#pragma pack()
|