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>
41 lines
1.3 KiB
C
41 lines
1.3 KiB
C
/** @file
|
|
Routines used to operate the Ip4Dxe.
|
|
|
|
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Guid/Ip4Config2Hii.h>
|
|
|
|
#define FORMID_MAIN_FORM 1
|
|
#define FORMID_DEVICE_FORM 2
|
|
|
|
#define KEY_ENABLE 0x100
|
|
#define KEY_DHCP_ENABLE 0x101
|
|
#define KEY_LOCAL_IP 0x102
|
|
#define KEY_SUBNET_MASK 0x103
|
|
#define KEY_GATE_WAY 0x104
|
|
#define KEY_DNS 0x105
|
|
#define KEY_SAVE_CHANGES 0x106
|
|
|
|
#define IP_MIN_SIZE 7
|
|
#define IP_MAX_SIZE 15
|
|
#define IP4_STR_MAX_SIZE 16
|
|
#define ADDRESS_STR_MAX_SIZE 255
|
|
#define MAX_IP4_CONFIG_DNS 16
|
|
|
|
///
|
|
/// IP4_CONFIG2_IFR_NVDATA contains the IP4 configure
|
|
/// parameters for that NIC.
|
|
///
|
|
typedef struct {
|
|
UINT8 Configure; ///< NIC configure status
|
|
UINT8 DhcpEnable; ///< Static or DHCP
|
|
CHAR16 StationAddress[IP4_STR_MAX_SIZE]; ///< IP addresses
|
|
CHAR16 SubnetMask[IP4_STR_MAX_SIZE]; ///< Subnet address
|
|
CHAR16 GatewayAddress[IP4_STR_MAX_SIZE]; ///< Gateway address
|
|
CHAR16 DnsAddress[ADDRESS_STR_MAX_SIZE]; ///< DNS server address
|
|
} IP4_CONFIG2_IFR_NVDATA;
|