]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Include/Protocol/DisplayProtocol.h
MdeModulePkg: Apply uncrustify changes
[mirror_edk2.git] / MdeModulePkg / Include / Protocol / DisplayProtocol.h
index 748ceed177edd4e67752a1d8c2065a382741a0f2..be08b74b296a84532aee3219bb0fd133386bcee3 100644 (file)
@@ -17,11 +17,11 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 //\r
 // Do nothing.\r
 //\r
-#define BROWSER_ACTION_NONE         BIT16\r
+#define BROWSER_ACTION_NONE  BIT16\r
 //\r
 // ESC Exit\r
 //\r
-#define BROWSER_ACTION_FORM_EXIT    BIT17\r
+#define BROWSER_ACTION_FORM_EXIT  BIT17\r
 \r
 #define BROWSER_SUCCESS                   0x0\r
 #define BROWSER_ERROR                     BIT31\r
@@ -44,53 +44,53 @@ typedef struct {
   //\r
   // HII Data Type\r
   //\r
-  UINT8               Type;\r
+  UINT8                 Type;\r
   //\r
   // Buffer Data and Length if Type is EFI_IFR_TYPE_BUFFER or EFI_IFR_TYPE_STRING\r
   //\r
-  UINT8               *Buffer;\r
-  UINT16              BufferLen;\r
-  EFI_IFR_TYPE_VALUE  Value;\r
+  UINT8                 *Buffer;\r
+  UINT16                BufferLen;\r
+  EFI_IFR_TYPE_VALUE    Value;\r
 } EFI_HII_VALUE;\r
 \r
 #define DISPLAY_QUESTION_OPTION_SIGNATURE  SIGNATURE_32 ('Q', 'O', 'P', 'T')\r
 \r
 typedef struct {\r
-  UINTN                  Signature;\r
-  LIST_ENTRY             Link;\r
+  UINTN                    Signature;\r
+  LIST_ENTRY               Link;\r
   //\r
   // OneOfOption Data\r
   //\r
-  EFI_IFR_ONE_OF_OPTION  *OptionOpCode;\r
+  EFI_IFR_ONE_OF_OPTION    *OptionOpCode;\r
   //\r
   // Option ImageId and AnimationId\r
   //\r
-  EFI_IMAGE_ID           ImageId;\r
-  EFI_ANIMATION_ID       AnimationId;\r
+  EFI_IMAGE_ID             ImageId;\r
+  EFI_ANIMATION_ID         AnimationId;\r
 } DISPLAY_QUESTION_OPTION;\r
 \r
 #define DISPLAY_QUESTION_OPTION_FROM_LINK(a)  CR (a, DISPLAY_QUESTION_OPTION, Link, DISPLAY_QUESTION_OPTION_SIGNATURE)\r
 \r
-typedef struct _FORM_DISPLAY_ENGINE_STATEMENT FORM_DISPLAY_ENGINE_STATEMENT;\r
-typedef struct _FORM_DISPLAY_ENGINE_FORM      FORM_DISPLAY_ENGINE_FORM;\r
+typedef struct _FORM_DISPLAY_ENGINE_STATEMENT  FORM_DISPLAY_ENGINE_STATEMENT;\r
+typedef struct _FORM_DISPLAY_ENGINE_FORM       FORM_DISPLAY_ENGINE_FORM;\r
 \r
-#define STATEMENT_VALID             0x0\r
-#define STATEMENT_INVALID           BIT31\r
+#define STATEMENT_VALID    0x0\r
+#define STATEMENT_INVALID  BIT31\r
 \r
-#define INCOSISTENT_IF_TRUE         STATEMENT_INVALID | 0x01\r
-#define WARNING_IF_TRUE             STATEMENT_INVALID | 0x02\r
-#define STRING_TOO_LONG             STATEMENT_INVALID | 0x03\r
+#define INCOSISTENT_IF_TRUE  STATEMENT_INVALID | 0x01\r
+#define WARNING_IF_TRUE      STATEMENT_INVALID | 0x02\r
+#define STRING_TOO_LONG      STATEMENT_INVALID | 0x03\r
 // ... to be extended.\r
 \r
 typedef struct {\r
   //\r
   // StringId for INCONSITENT_IF or WARNING_IF\r
   //\r
-  EFI_STRING_ID  StringId;\r
+  EFI_STRING_ID    StringId;\r
   //\r
   // TimeOut for WARNING_IF\r
   //\r
-  UINT8          TimeOut;\r
+  UINT8            TimeOut;\r
 } STATEMENT_ERROR_INFO;\r
 \r
 /**\r
@@ -105,7 +105,7 @@ typedef struct {
 **/\r
 typedef\r
 UINT32\r
-(EFIAPI *VALIDATE_QUESTION) (\r
+(EFIAPI *VALIDATE_QUESTION)(\r
   IN FORM_DISPLAY_ENGINE_FORM      *Form,\r
   IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,\r
   IN EFI_HII_VALUE                 *Value,\r
@@ -126,7 +126,7 @@ UINT32
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PASSWORD_CHECK) (\r
+(EFIAPI *PASSWORD_CHECK)(\r
   IN FORM_DISPLAY_ENGINE_FORM      *Form,\r
   IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,\r
   IN EFI_STRING                    PasswordString  OPTIONAL\r
@@ -137,66 +137,66 @@ EFI_STATUS
 //\r
 // Attribute for Statement and Form\r
 //\r
-#define HII_DISPLAY_NONE             0\r
-#define HII_DISPLAY_GRAYOUT          BIT0\r
-#define HII_DISPLAY_LOCK             BIT1\r
-#define HII_DISPLAY_READONLY         BIT2\r
-#define HII_DISPLAY_MODAL            BIT3\r
-#define HII_DISPLAY_SUPPRESS         BIT4\r
-\r
-struct _FORM_DISPLAY_ENGINE_STATEMENT{\r
-  UINTN                 Signature;\r
+#define HII_DISPLAY_NONE      0\r
+#define HII_DISPLAY_GRAYOUT   BIT0\r
+#define HII_DISPLAY_LOCK      BIT1\r
+#define HII_DISPLAY_READONLY  BIT2\r
+#define HII_DISPLAY_MODAL     BIT3\r
+#define HII_DISPLAY_SUPPRESS  BIT4\r
+\r
+struct _FORM_DISPLAY_ENGINE_STATEMENT {\r
+  UINTN                Signature;\r
   //\r
   // Version for future structure extension\r
   //\r
-  UINTN                 Version;\r
+  UINTN                Version;\r
   //\r
   // link to all the statement which will show in the display form.\r
   //\r
-  LIST_ENTRY            DisplayLink;\r
+  LIST_ENTRY           DisplayLink;\r
   //\r
   // Pointer to statement opcode.\r
   // for Guided Opcode. All buffers will be here if GUIDED opcode scope is set.\r
   //\r
-  EFI_IFR_OP_HEADER     *OpCode;\r
+  EFI_IFR_OP_HEADER    *OpCode;\r
   //\r
   // Question CurrentValue\r
   //\r
-  EFI_HII_VALUE         CurrentValue;\r
+  EFI_HII_VALUE        CurrentValue;\r
   //\r
   // Flag to describe whether setting is changed or not.\r
   // Displayer may depend on it to show it with the different color.\r
   //\r
-  BOOLEAN               SettingChangedFlag;\r
+  BOOLEAN              SettingChangedFlag;\r
   //\r
   // nested Statement list inside of EFI_IFR_SUBTITLE\r
   //\r
-  LIST_ENTRY            NestStatementList;\r
+  LIST_ENTRY           NestStatementList;\r
   //\r
   // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r
   //\r
-  LIST_ENTRY            OptionListHead;\r
+  LIST_ENTRY           OptionListHead;\r
   //\r
   // Statement attributes: GRAYOUT, LOCK and READONLY\r
   //\r
-  UINT32                Attribute;\r
+  UINT32               Attribute;\r
 \r
   //\r
   // ValidateQuestion to do InconsistIf check\r
   // It may be NULL if any value is valid.\r
   //\r
-  VALIDATE_QUESTION     ValidateQuestion;\r
+  VALIDATE_QUESTION    ValidateQuestion;\r
 \r
   //\r
   // Password additional check. It may be NULL when the additional check is not required.\r
   //\r
-  PASSWORD_CHECK        PasswordCheck;\r
+  PASSWORD_CHECK       PasswordCheck;\r
 \r
   //\r
   // Statement ImageId and AnimationId\r
   //\r
-  EFI_IMAGE_ID          ImageId;\r
-  EFI_ANIMATION_ID      AnimationId;\r
+  EFI_IMAGE_ID         ImageId;\r
+  EFI_ANIMATION_ID     AnimationId;\r
 };\r
 \r
 #define FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK(a)  CR (a, FORM_DISPLAY_ENGINE_STATEMENT, DisplayLink, FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE)\r
@@ -204,19 +204,19 @@ struct _FORM_DISPLAY_ENGINE_STATEMENT{
 #define BROWSER_HOT_KEY_SIGNATURE  SIGNATURE_32 ('B', 'H', 'K', 'S')\r
 \r
 typedef struct {\r
-  UINTN                 Signature;\r
-  LIST_ENTRY            Link;\r
+  UINTN            Signature;\r
+  LIST_ENTRY       Link;\r
 \r
-  EFI_INPUT_KEY         *KeyData;\r
+  EFI_INPUT_KEY    *KeyData;\r
   //\r
   // Action is Discard, Default, Submit, Reset and Exit.\r
   //\r
-  UINT32                 Action;\r
-  UINT16                 DefaultId;\r
+  UINT32           Action;\r
+  UINT16           DefaultId;\r
   //\r
   // HotKey Help String\r
   //\r
-  EFI_STRING             HelpString;\r
+  EFI_STRING       HelpString;\r
 } BROWSER_HOT_KEY;\r
 \r
 #define BROWSER_HOT_KEY_FROM_LINK(a)  CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)\r
@@ -224,86 +224,86 @@ typedef struct {
 #define FORM_DISPLAY_ENGINE_FORM_SIGNATURE  SIGNATURE_32 ('F', 'F', 'R', 'M')\r
 \r
 struct _FORM_DISPLAY_ENGINE_FORM {\r
-  UINTN                Signature;\r
+  UINTN                            Signature;\r
   //\r
   // Version for future structure extension\r
   //\r
-  UINTN                Version;\r
+  UINTN                            Version;\r
   //\r
   // Statement List inside of Form\r
   //\r
-  LIST_ENTRY            StatementListHead;\r
+  LIST_ENTRY                       StatementListHead;\r
   //\r
   // Statement List outside of Form\r
   //\r
-  LIST_ENTRY            StatementListOSF;\r
+  LIST_ENTRY                       StatementListOSF;\r
   //\r
   // The input screen dimenstions info.\r
   //\r
-  EFI_SCREEN_DESCRIPTOR *ScreenDimensions;\r
+  EFI_SCREEN_DESCRIPTOR            *ScreenDimensions;\r
   //\r
   // FormSet information\r
   //\r
-  EFI_GUID             FormSetGuid;\r
+  EFI_GUID                         FormSetGuid;\r
   //\r
   // HiiHandle can be used to get String, Image or Animation\r
   //\r
-  EFI_HII_HANDLE       HiiHandle;\r
+  EFI_HII_HANDLE                   HiiHandle;\r
 \r
   //\r
   // Form ID and Title.\r
   //\r
-  UINT16               FormId;\r
-  EFI_STRING_ID        FormTitle;\r
+  UINT16                           FormId;\r
+  EFI_STRING_ID                    FormTitle;\r
   //\r
   // Form Attributes: Lock, Modal.\r
   //\r
-  UINT32               Attribute;\r
+  UINT32                           Attribute;\r
   //\r
   // Flag to describe whether setting is changed or not.\r
   // Displayer depends on it to show ChangedFlag.\r
   //\r
-  BOOLEAN              SettingChangedFlag;\r
+  BOOLEAN                          SettingChangedFlag;\r
 \r
   //\r
   // Statement to be HighLighted\r
   //\r
-  FORM_DISPLAY_ENGINE_STATEMENT *HighLightedStatement;\r
+  FORM_DISPLAY_ENGINE_STATEMENT    *HighLightedStatement;\r
   //\r
   // Event to notify Displayer that FormData is updated to be refreshed.\r
   //\r
-  EFI_EVENT              FormRefreshEvent;\r
+  EFI_EVENT                        FormRefreshEvent;\r
   //\r
   // Additional Hotkey registered by BrowserEx protocol.\r
   //\r
-  LIST_ENTRY             HotKeyListHead;\r
+  LIST_ENTRY                       HotKeyListHead;\r
 \r
   //\r
   // Form ImageId and AnimationId\r
   //\r
-  EFI_IMAGE_ID         ImageId;\r
-  EFI_ANIMATION_ID     AnimationId;\r
+  EFI_IMAGE_ID                     ImageId;\r
+  EFI_ANIMATION_ID                 AnimationId;\r
 \r
   //\r
   // If Status is error, display needs to handle it.\r
   //\r
-  UINT32               BrowserStatus;\r
+  UINT32                           BrowserStatus;\r
   //\r
   // String for error status. It may be NULL.\r
   //\r
-  EFI_STRING           ErrorString;\r
+  EFI_STRING                       ErrorString;\r
 };\r
 \r
 #define FORM_DISPLAY_ENGINE_FORM_FROM_LINK(a)  CR (a, FORM_DISPLAY_ENGINE_FORM, Link, FORM_DISPLAY_ENGINE_FORM_SIGNATURE)\r
 \r
 typedef struct {\r
-  FORM_DISPLAY_ENGINE_STATEMENT  *SelectedStatement; // Selected Statement and InputValue\r
+  FORM_DISPLAY_ENGINE_STATEMENT    *SelectedStatement; // Selected Statement and InputValue\r
 \r
-  EFI_HII_VALUE                  InputValue;\r
+  EFI_HII_VALUE                    InputValue;\r
 \r
-  UINT32                         Action;             // If SelectedStatement is NULL, Action will be used.\r
+  UINT32                           Action;           // If SelectedStatement is NULL, Action will be used.\r
                                                      // Trig Action (Discard, Default, Submit, Reset and Exit)\r
-  UINT16                         DefaultId;\r
+  UINT16                           DefaultId;\r
 } USER_INPUT;\r
 \r
 /**\r
@@ -316,10 +316,10 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *FORM_DISPLAY) (\r
+(EFIAPI *FORM_DISPLAY)(\r
   IN FORM_DISPLAY_ENGINE_FORM  *FormData,\r
   OUT USER_INPUT               *UserInputData\r
-);\r
+  );\r
 \r
 /**\r
   Exit Display and Clear Screen to the original state.\r
@@ -327,9 +327,9 @@ EFI_STATUS
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EXIT_DISPLAY) (\r
+(EFIAPI *EXIT_DISPLAY)(\r
   VOID\r
-);\r
+  );\r
 \r
 /**\r
   Confirm how to handle the changed data.\r
@@ -338,15 +338,15 @@ VOID
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *CONFIRM_DATA_CHANGE) (\r
+(EFIAPI *CONFIRM_DATA_CHANGE)(\r
   VOID\r
-);\r
+  );\r
 \r
 typedef struct {\r
-  FORM_DISPLAY        FormDisplay;\r
-  EXIT_DISPLAY        ExitDisplay;\r
-  CONFIRM_DATA_CHANGE ConfirmDataChange;\r
+  FORM_DISPLAY           FormDisplay;\r
+  EXIT_DISPLAY           ExitDisplay;\r
+  CONFIRM_DATA_CHANGE    ConfirmDataChange;\r
 } EDKII_FORM_DISPLAY_ENGINE_PROTOCOL;\r
 \r
-extern EFI_GUID gEdkiiFormDisplayEngineProtocolGuid;\r
+extern EFI_GUID  gEdkiiFormDisplayEngineProtocolGuid;\r
 #endif\r