mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
e679741305
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>
128 lines
3.7 KiB
C
128 lines
3.7 KiB
C
/** @file
|
|
SimpleFileSystem protocol as defined in the UEFI 2.0 specification.
|
|
|
|
The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32)
|
|
file system specified in UEFI 2.0. It can also be used to abstract a file
|
|
system other than FAT.
|
|
|
|
UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.
|
|
|
|
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
|
Portions copyright (c) 2011, Apple Inc. All rights reserved.
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/SimplePointer.h>
|
|
#include <Protocol/SimpleTextIn.h>
|
|
#include <Protocol/SimpleTextInEx.h>
|
|
#include <Protocol/GraphicsOutput.h>
|
|
|
|
#define EMU_GRAPHICS_WINDOW_PROTOCOL_GUID \
|
|
{ 0x30FD316A, 0x6728, 0x2E41, { 0xA6, 0x90, 0x0D, 0x13, 0x33, 0xD8, 0xCA, 0xC1 } }
|
|
|
|
typedef struct _EMU_GRAPHICS_WINDOW_PROTOCOL EMU_GRAPHICS_WINDOW_PROTOCOL;
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_CLOSE)(
|
|
EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_SIZE)(
|
|
EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
UINT32 Width,
|
|
UINT32 Height
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_CHECK_KEY)(
|
|
EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_GET_KEY)(
|
|
EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
EFI_KEY_DATA *key
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_KEY_SET_STATE)(
|
|
IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
IN EFI_KEY_TOGGLE_STATE *KeyToggleState
|
|
);
|
|
|
|
typedef
|
|
VOID
|
|
(EFIAPI *EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK)(
|
|
IN VOID *Context,
|
|
IN EFI_KEY_DATA *KeyData
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_REGISTER_KEY_NOTIFY)(
|
|
IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK CallBack,
|
|
IN VOID *Context
|
|
);
|
|
|
|
typedef struct {
|
|
UINTN SourceX;
|
|
UINTN SourceY;
|
|
UINTN DestinationX;
|
|
UINTN DestinationY;
|
|
UINTN Width;
|
|
UINTN Height;
|
|
UINTN Delta;
|
|
} EMU_GRAPHICS_WINDOWS__BLT_ARGS;
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_BLT)(
|
|
IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
|
|
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
|
|
IN EMU_GRAPHICS_WINDOWS__BLT_ARGS *Args
|
|
);
|
|
|
|
typedef
|
|
BOOLEAN
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_IS_KEY_PRESSED)(
|
|
IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
IN EFI_KEY_DATA *KeyData
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_CHECK_POINTER)(
|
|
EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EMU_GRAPHICS_WINDOWS_GET_POINTER_STATE)(
|
|
EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows,
|
|
EFI_SIMPLE_POINTER_STATE *state
|
|
);
|
|
|
|
struct _EMU_GRAPHICS_WINDOW_PROTOCOL {
|
|
EMU_GRAPHICS_WINDOWS_SIZE Size;
|
|
EMU_GRAPHICS_WINDOWS_CHECK_KEY CheckKey;
|
|
EMU_GRAPHICS_WINDOWS_KEY_SET_STATE KeySetState;
|
|
EMU_GRAPHICS_WINDOWS_GET_KEY GetKey;
|
|
EMU_GRAPHICS_WINDOWS_REGISTER_KEY_NOTIFY RegisterKeyNotify;
|
|
EMU_GRAPHICS_WINDOWS_BLT Blt;
|
|
EMU_GRAPHICS_WINDOWS_IS_KEY_PRESSED IsKeyPressed;
|
|
EMU_GRAPHICS_WINDOWS_CHECK_POINTER CheckPointer;
|
|
EMU_GRAPHICS_WINDOWS_GET_POINTER_STATE GetPointerState;
|
|
};
|
|
|
|
extern EFI_GUID gEmuGraphicsWindowProtocolGuid;
|