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>
37 lines
901 B
C
37 lines
901 B
C
/** @file
|
|
Header file for NV data structure definition.
|
|
|
|
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Guid/HiiPlatformSetupFormset.h>
|
|
#include <Guid/VlanConfigHii.h>
|
|
|
|
#define VLAN_CONFIGURATION_VARSTORE_ID 0x0001
|
|
#define VLAN_CONFIGURATION_FORM_ID 0x0001
|
|
#define VLAN_HEAD_FORM_ID 0x0002
|
|
|
|
#define VLAN_ADD_QUESTION_ID 0x1000
|
|
#define VLAN_REMOVE_QUESTION_ID 0x2000
|
|
#define VLAN_UPDATE_QUESTION_ID 0x3000
|
|
|
|
#define LABEL_VLAN_LIST 0x0001
|
|
#define LABEL_END 0xffff
|
|
|
|
//
|
|
// The maximum number of VLAN that will be displayed on the menu
|
|
//
|
|
#define MAX_VLAN_NUMBER 100
|
|
|
|
//
|
|
// Nv Data structure referenced by IFR
|
|
//
|
|
typedef struct {
|
|
UINT16 VlanId;
|
|
UINT8 Priority;
|
|
UINT8 VlanList[MAX_VLAN_NUMBER];
|
|
} VLAN_CONFIGURATION;
|