Tianocore/edk2.git/MdePkg/Include/Protocol/SimpleTextInEx.h, branch master

MdePkg: Replace include guards with #pragma once

2026-02-23T21:01:28+00:00

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

MdePkg Updated the comments of EFI_SYSTEM_TABLE and ReadKeyStroke

2024-02-26T19:18:00+00:00

1. Refer to Uefi spec 2.10 section 4.3.1, Updated the comments of EFI_SYSTEM_TABLE to satisfy ConIn/ConOut/StdErr requirements. 2. Refer to Uefi spec 2.10 section 13.3.3, Add a new retval EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke(). Signed-off-by: Junfeng Guan Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Reviewed-by: Liming Gao

MdePkg: Apply uncrustify changes

2021-12-07T17:24:28+00:00

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3737 Apply uncrustify changes to .c/.h files in the MdePkg package Cc: Andrew Fish Cc: Leif Lindholm Cc: Michael D Kinney Signed-off-by: Michael Kubacki Reviewed-by: Liming Gao

MdePkg: Replace BSD License with BSD+Patent License

2019-04-09T17:58:13+00:00

https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney Reviewed-by: Liming Gao

MdePkg/SimpleTextInEx.h: Fix comments alignment

2018-02-01T06:03:45+00:00

Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni Cc: Liming Gao Reviewed-by: Star Zeng

MdePkg/SimpleTextInEx: Update comments according to UEFI 2.7 spec

2017-06-20T01:29:41+00:00

Cc: Liming Gao Cc: Star Zeng Cc: Ruiyu Ni Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi Reviewed-by: Star Zeng Reviewed-by: Ruiyu Ni

Change the type of NotifyHandle from EFI_HANDLE to VOID * for SimpleTextInEx protocol.

2012-07-30T03:50:42+00:00

Clean up the code to remove unnecessary NotifyHandle in the private data structure. Signed-off-by: Ruiyu Ni Reviewed-by: Elvin Li git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13565 6f19259b-4bc3-4df7-8a09-765794883524

1. Add Partial Keystroke Support definition in SimpleTextInputEx.h See the Uefi2.3.1a chapter 11.2

2011-09-30T07:26:07+00:00

Signed-off-by: qianouyang Reviewed-by: niruiyu vanjeff git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12493 6f19259b-4bc3-4df7-8a09-765794883524

Add definition of SCAN_PAUSE for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.

2011-05-16T01:49:42+00:00

Signed-off-by: vanjeff Reviewed-by: niruiyu git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11655 6f19259b-4bc3-4df7-8a09-765794883524

1.Move the definitions of SCAN_F11 and SCAN_F12 from SimpleTextIn.h to SimpleTextInEx.h because they are defined in Table - EFI Scan Codes for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.

2011-05-04T01:06:43+00:00

2.Include SimpleTextIn.h in SimpleTextInEx.h because EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is an extension of the EFI_SIMPLE_TEXT_INPUT_PROTOCOL. 3.Include SimpleTextInEx.h in UefiSpec.h. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11612 6f19259b-4bc3-4df7-8a09-765794883524