mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-06-13 19:16:19 -07:00
Michael Kubackiandmergify[bot]
7a934d0bef
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>
63 lines
2.2 KiB
C
63 lines
2.2 KiB
C
/** @file
|
|
The Platform Logo Protocol defines the interface to get the Platform logo
|
|
image with the display attribute.
|
|
|
|
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/HiiImage.h>
|
|
|
|
//
|
|
// GUID for EDKII Platform Logo Protocol
|
|
//
|
|
#define EDKII_PLATFORM_LOGO_PROTOCOL_GUID \
|
|
{ 0x53cd299f, 0x2bc1, 0x40c0, { 0x8c, 0x07, 0x23, 0xf6, 0x4f, 0xdb, 0x30, 0xe0 } }
|
|
|
|
typedef struct _EDKII_PLATFORM_LOGO_PROTOCOL EDKII_PLATFORM_LOGO_PROTOCOL;
|
|
|
|
typedef enum {
|
|
EdkiiPlatformLogoDisplayAttributeLeftTop,
|
|
EdkiiPlatformLogoDisplayAttributeCenterTop,
|
|
EdkiiPlatformLogoDisplayAttributeRightTop,
|
|
EdkiiPlatformLogoDisplayAttributeCenterRight,
|
|
EdkiiPlatformLogoDisplayAttributeRightBottom,
|
|
EdkiiPlatformLogoDisplayAttributeCenterBottom,
|
|
EdkiiPlatformLogoDisplayAttributeLeftBottom,
|
|
EdkiiPlatformLogoDisplayAttributeCenterLeft,
|
|
EdkiiPlatformLogoDisplayAttributeCenter
|
|
} EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE;
|
|
|
|
/**
|
|
Load a platform logo image and return its data and attributes.
|
|
|
|
@param This The pointer to this protocol instance.
|
|
@param Instance The visible image instance is found.
|
|
@param Image Points to the image.
|
|
@param Attribute The display attributes of the image returned.
|
|
@param OffsetX The X offset of the image regarding the Attribute.
|
|
@param OffsetY The Y offset of the image regarding the Attribute.
|
|
|
|
@retval EFI_SUCCESS The image was fetched successfully.
|
|
@retval EFI_NOT_FOUND The specified image could not be found.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_PLATFORM_LOGO_GET_IMAGE)(
|
|
IN EDKII_PLATFORM_LOGO_PROTOCOL *This,
|
|
IN OUT UINT32 *Instance,
|
|
OUT EFI_IMAGE_INPUT *Image,
|
|
OUT EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE *Attribute,
|
|
OUT INTN *OffsetX,
|
|
OUT INTN *OffsetY
|
|
);
|
|
|
|
struct _EDKII_PLATFORM_LOGO_PROTOCOL {
|
|
EDKII_PLATFORM_LOGO_GET_IMAGE GetImage;
|
|
};
|
|
|
|
extern EFI_GUID gEdkiiPlatformLogoProtocolGuid;
|