]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Application/Shell/Shell.h
ShellPkg: Apply uncrustify changes
[mirror_edk2.git] / ShellPkg / Application / Shell / Shell.h
index e6eb150f57a525fbf75974c2752ac0f67f3b17db..89b4ac6b026d3e44d0c026601eefcad2c1dd5a98 100644 (file)
 #include "ConsoleWrappers.h"\r
 #include "FileHandleWrappers.h"\r
 \r
-extern CONST CHAR16 mNoNestingEnvVarName[];\r
-extern CONST CHAR16 mNoNestingTrue[];\r
-extern CONST CHAR16 mNoNestingFalse[];\r
+extern CONST CHAR16  mNoNestingEnvVarName[];\r
+extern CONST CHAR16  mNoNestingTrue[];\r
+extern CONST CHAR16  mNoNestingFalse[];\r
 \r
 typedef struct {\r
-  LIST_ENTRY        Link;           ///< Standard linked list handler.\r
-  SHELL_FILE_HANDLE SplitStdOut;    ///< ConsoleOut for use in the split.\r
-  SHELL_FILE_HANDLE SplitStdIn;     ///< ConsoleIn for use in the split.\r
+  LIST_ENTRY           Link;        ///< Standard linked list handler.\r
+  SHELL_FILE_HANDLE    SplitStdOut; ///< ConsoleOut for use in the split.\r
+  SHELL_FILE_HANDLE    SplitStdIn;  ///< ConsoleIn for use in the split.\r
 } SPLIT_LIST;\r
 \r
 typedef struct {\r
-  UINT32  Startup:1;      ///< Was "-startup"       found on command line.\r
-  UINT32  NoStartup:1;    ///< Was "-nostartup"     found on command line.\r
-  UINT32  NoConsoleOut:1; ///< Was "-noconsoleout"  found on command line.\r
-  UINT32  NoConsoleIn:1;  ///< Was "-noconsolein"   found on command line.\r
-  UINT32  NoInterrupt:1;  ///< Was "-nointerrupt"   found on command line.\r
-  UINT32  NoMap:1;        ///< Was "-nomap"         found on command line.\r
-  UINT32  NoVersion:1;    ///< Was "-noversion"     found on command line.\r
-  UINT32  Delay:1;        ///< Was "-delay[:n]      found on command line\r
-  UINT32  Exit:1;         ///< Was "-_exit"         found on command line\r
-  UINT32  NoNest:1;       ///< Was "-nonest"        found on command line\r
-  UINT32  Reserved:7;     ///< Extra bits\r
+  UINT32    Startup      : 1; ///< Was "-startup"       found on command line.\r
+  UINT32    NoStartup    : 1; ///< Was "-nostartup"     found on command line.\r
+  UINT32    NoConsoleOut : 1; ///< Was "-noconsoleout"  found on command line.\r
+  UINT32    NoConsoleIn  : 1; ///< Was "-noconsolein"   found on command line.\r
+  UINT32    NoInterrupt  : 1; ///< Was "-nointerrupt"   found on command line.\r
+  UINT32    NoMap        : 1; ///< Was "-nomap"         found on command line.\r
+  UINT32    NoVersion    : 1; ///< Was "-noversion"     found on command line.\r
+  UINT32    Delay        : 1; ///< Was "-delay[:n]      found on command line\r
+  UINT32    Exit         : 1; ///< Was "-_exit"         found on command line\r
+  UINT32    NoNest       : 1; ///< Was "-nonest"        found on command line\r
+  UINT32    Reserved     : 7; ///< Extra bits\r
 } SHELL_BITS;\r
 \r
 typedef union {\r
-  SHELL_BITS  Bits;\r
-  UINT16      AllBits;\r
+  SHELL_BITS    Bits;\r
+  UINT16        AllBits;\r
 } SHELL_BIT_UNION;\r
 \r
 typedef struct {\r
-  SHELL_BIT_UNION BitUnion;\r
-  UINTN           Delay;          ///< Seconds of delay default:5.\r
-  CHAR16          *FileName;      ///< Filename to run upon successful initialization.\r
-  CHAR16          *FileOptions;   ///< Options to pass to FileName.\r
+  SHELL_BIT_UNION    BitUnion;\r
+  UINTN              Delay;        ///< Seconds of delay default:5.\r
+  CHAR16             *FileName;    ///< Filename to run upon successful initialization.\r
+  CHAR16             *FileOptions; ///< Options to pass to FileName.\r
 } SHELL_INIT_SETTINGS;\r
 \r
 typedef struct {\r
-  BUFFER_LIST                 CommandHistory;\r
-  UINTN                       VisibleRowNumber;\r
-  UINTN                       OriginalVisibleRowNumber;\r
-  BOOLEAN                     InsertMode;           ///< Is the current typing mode insert (FALSE = overwrite).\r
+  BUFFER_LIST    CommandHistory;\r
+  UINTN          VisibleRowNumber;\r
+  UINTN          OriginalVisibleRowNumber;\r
+  BOOLEAN        InsertMode;                        ///< Is the current typing mode insert (FALSE = overwrite).\r
 } SHELL_VIEWING_SETTINGS;\r
 \r
 typedef struct {\r
-  EFI_SHELL_PARAMETERS_PROTOCOL *NewShellParametersProtocol;\r
-  EFI_SHELL_PROTOCOL            *NewEfiShellProtocol;\r
-  BOOLEAN                       PageBreakEnabled;\r
-  BOOLEAN                       RootShellInstance;\r
-  SHELL_INIT_SETTINGS           ShellInitSettings;\r
-  BUFFER_LIST                   BufferToFreeList;     ///< List of buffers that were returned to the user to free.\r
-  SHELL_VIEWING_SETTINGS        ViewingSettings;\r
-  EFI_HII_HANDLE                HiiHandle;            ///< Handle from HiiLib.\r
-  UINTN                         LogScreenCount;       ///< How many screens of log information to save.\r
-  EFI_EVENT                     UserBreakTimer;       ///< Timer event for polling for CTRL-C.\r
-  EFI_DEVICE_PATH_PROTOCOL      *ImageDevPath;        ///< DevicePath for ourselves.\r
-  EFI_DEVICE_PATH_PROTOCOL      *FileDevPath;         ///< DevicePath for ourselves.\r
-  CONSOLE_LOGGER_PRIVATE_DATA   *ConsoleInfo;         ///< Pointer for ConsoleInformation.\r
-  EFI_SHELL_PARAMETERS_PROTOCOL *OldShellParameters;  ///< old shell parameters to reinstall upon exiting.\r
-  SHELL_PROTOCOL_HANDLE_LIST    OldShellList;         ///< List of other instances to reinstall when closing.\r
-  SPLIT_LIST                    SplitList;            ///< List of Splits in FILO stack.\r
-  VOID                          *CtrlCNotifyHandle1;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlCNotifyHandle2;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlCNotifyHandle3;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlCNotifyHandle4;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlSNotifyHandle1;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlSNotifyHandle2;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlSNotifyHandle3;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  VOID                          *CtrlSNotifyHandle4;  ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
-  BOOLEAN                       HaltOutput;           ///< TRUE to start a CTRL-S halt.\r
+  EFI_SHELL_PARAMETERS_PROTOCOL    *NewShellParametersProtocol;\r
+  EFI_SHELL_PROTOCOL               *NewEfiShellProtocol;\r
+  BOOLEAN                          PageBreakEnabled;\r
+  BOOLEAN                          RootShellInstance;\r
+  SHELL_INIT_SETTINGS              ShellInitSettings;\r
+  BUFFER_LIST                      BufferToFreeList;  ///< List of buffers that were returned to the user to free.\r
+  SHELL_VIEWING_SETTINGS           ViewingSettings;\r
+  EFI_HII_HANDLE                   HiiHandle;           ///< Handle from HiiLib.\r
+  UINTN                            LogScreenCount;      ///< How many screens of log information to save.\r
+  EFI_EVENT                        UserBreakTimer;      ///< Timer event for polling for CTRL-C.\r
+  EFI_DEVICE_PATH_PROTOCOL         *ImageDevPath;       ///< DevicePath for ourselves.\r
+  EFI_DEVICE_PATH_PROTOCOL         *FileDevPath;        ///< DevicePath for ourselves.\r
+  CONSOLE_LOGGER_PRIVATE_DATA      *ConsoleInfo;        ///< Pointer for ConsoleInformation.\r
+  EFI_SHELL_PARAMETERS_PROTOCOL    *OldShellParameters; ///< old shell parameters to reinstall upon exiting.\r
+  SHELL_PROTOCOL_HANDLE_LIST       OldShellList;        ///< List of other instances to reinstall when closing.\r
+  SPLIT_LIST                       SplitList;           ///< List of Splits in FILO stack.\r
+  VOID                             *CtrlCNotifyHandle1; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlCNotifyHandle2; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlCNotifyHandle3; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlCNotifyHandle4; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlSNotifyHandle1; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlSNotifyHandle2; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlSNotifyHandle3; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  VOID                             *CtrlSNotifyHandle4; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.\r
+  BOOLEAN                          HaltOutput;          ///< TRUE to start a CTRL-S halt.\r
 } SHELL_INFO;\r
 \r
 #pragma pack(1)\r
@@ -127,12 +127,12 @@ typedef struct {
 /// HII specific Vendor Device Path definition.\r
 ///\r
 typedef struct {\r
-  VENDOR_DEVICE_PATH             VendorDevicePath;\r
-  EFI_DEVICE_PATH_PROTOCOL       End;\r
+  VENDOR_DEVICE_PATH          VendorDevicePath;\r
+  EFI_DEVICE_PATH_PROTOCOL    End;\r
 } SHELL_MAN_HII_VENDOR_DEVICE_PATH;\r
 #pragma pack()\r
 \r
-extern SHELL_INFO ShellInfoObject;\r
+extern SHELL_INFO  ShellInfoObject;\r
 \r
 /**\r
   Converts the command line to its post-processed form.  this replaces variables and alias' per UEFI Shell spec.\r
@@ -144,8 +144,8 @@ extern SHELL_INFO ShellInfoObject;
   @return                       some other error occurred\r
 **/\r
 EFI_STATUS\r
-ProcessCommandLineToFinal(\r
-  IN OUT CHAR16 **CmdLine\r
+ProcessCommandLineToFinal (\r
+  IN OUT CHAR16  **CmdLine\r
   );\r
 \r
 /**\r
@@ -154,8 +154,8 @@ ProcessCommandLineToFinal(
   @param[in] ErrorCode      the error code to put into lasterror\r
 **/\r
 EFI_STATUS\r
-SetLastError(\r
-  IN CONST SHELL_STATUS   ErrorCode\r
+SetLastError (\r
+  IN CONST SHELL_STATUS  ErrorCode\r
   );\r
 \r
 /**\r
@@ -164,7 +164,7 @@ SetLastError(
   @retval EFI_SUCCESS           all init commands were run successfully.\r
 **/\r
 EFI_STATUS\r
-SetBuiltInAlias(\r
+SetBuiltInAlias (\r
   VOID\r
   );\r
 \r
@@ -184,8 +184,8 @@ SetBuiltInAlias(
 **/\r
 EFI_STATUS\r
 GetDevicePathsForImageAndFile (\r
-  IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,\r
-  IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL  **DevPath,\r
+  IN OUT EFI_DEVICE_PATH_PROTOCOL  **FilePath\r
   );\r
 \r
 /**\r
@@ -216,7 +216,7 @@ GetDevicePathsForImageAndFile (
   @retval EFI_SUCCESS           the variable is initialized.\r
 **/\r
 EFI_STATUS\r
-ProcessCommandLine(\r
+ProcessCommandLine (\r
   VOID\r
   );\r
 \r
@@ -231,9 +231,9 @@ ProcessCommandLine(
   @retval EFI_SUCCESS           The variable is initialized.\r
 **/\r
 EFI_STATUS\r
-DoStartupScript(\r
-  IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,\r
-  IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
+DoStartupScript (\r
+  IN EFI_DEVICE_PATH_PROTOCOL  *ImagePath,\r
+  IN EFI_DEVICE_PATH_PROTOCOL  *FilePath\r
   );\r
 \r
 /**\r
@@ -255,9 +255,9 @@ DoShellPrompt (
 \r
   @param Buffer   Something to pass to FreePool when the shell is exiting.\r
 **/\r
-VOID*\r
-AddBufferToFreeList(\r
-  VOID *Buffer\r
+VOID *\r
+AddBufferToFreeList (\r
+  VOID  *Buffer\r
   );\r
 \r
 /**\r
@@ -266,8 +266,8 @@ AddBufferToFreeList(
   @param Buffer[in]     The line buffer to add.\r
 **/\r
 VOID\r
-AddLineToCommandHistory(\r
-  IN CONST CHAR16 *Buffer\r
+AddLineToCommandHistory (\r
+  IN CONST CHAR16  *Buffer\r
   );\r
 \r
 /**\r
@@ -281,8 +281,8 @@ AddLineToCommandHistory(
   @retval EFI_ABORTED     the command's operation was aborted\r
 **/\r
 EFI_STATUS\r
-RunCommand(\r
-  IN CONST CHAR16   *CmdLine\r
+RunCommand (\r
+  IN CONST CHAR16  *CmdLine\r
   );\r
 \r
 /**\r
@@ -298,12 +298,11 @@ RunCommand(
   @retval EFI_ABORTED     The command's operation was aborted.\r
 **/\r
 EFI_STATUS\r
-RunShellCommand(\r
-  IN CONST CHAR16   *CmdLine,\r
-  OUT EFI_STATUS    *CommandStatus\r
+RunShellCommand (\r
+  IN CONST CHAR16  *CmdLine,\r
+  OUT EFI_STATUS   *CommandStatus\r
   );\r
 \r
-\r
 /**\r
   Function to process a NSH script file via SHELL_FILE_HANDLE.\r
 \r
@@ -346,11 +345,11 @@ RunScriptFile (
   @return the location of the first character in the string\r
   @retval CHAR_NULL no instance of any character in CharacterList was found in String\r
 **/\r
-CONST CHAR16*\r
-FindFirstCharacter(\r
-  IN CONST CHAR16 *String,\r
-  IN CONST CHAR16 *CharacterList,\r
-  IN CONST CHAR16 EscapeCharacter\r
+CONST CHAR16 *\r
+FindFirstCharacter (\r
+  IN CONST CHAR16  *String,\r
+  IN CONST CHAR16  *CharacterList,\r
+  IN CONST CHAR16  EscapeCharacter\r
   );\r
 \r
 /**\r
@@ -359,8 +358,8 @@ FindFirstCharacter(
   @param[in] String pointer to the string to trim them off.\r
 **/\r
 EFI_STATUS\r
-TrimSpaces(\r
-  IN CHAR16 **String\r
+TrimSpaces (\r
+  IN CHAR16  **String\r
   );\r
 \r
 /**\r
@@ -371,7 +370,7 @@ TrimSpaces(
 **/\r
 VOID\r
 SaveBufferList (\r
-  OUT LIST_ENTRY     *OldBufferList\r
+  OUT LIST_ENTRY  *OldBufferList\r
   );\r
 \r
 /**\r
@@ -381,10 +380,7 @@ SaveBufferList (
 **/\r
 VOID\r
 RestoreBufferList (\r
-  IN OUT LIST_ENTRY     *OldBufferList\r
+  IN OUT LIST_ENTRY  *OldBufferList\r
   );\r
 \r
-\r
-\r
 #endif //_SHELL_INTERNAL_HEADER_\r
-\r