]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Include/Library/ShellCommandLib.h
ShellPkg: Apply uncrustify changes
[mirror_edk2.git] / ShellPkg / Include / Library / ShellCommandLib.h
index bc1afed5e7f53e9a1cb985611818ee932645dbb1..7a97b203f1ff3958b536a89590cb18ade4d65757 100644 (file)
 //\r
 // The extern global protocol poionters.\r
 //\r
-extern        EFI_UNICODE_COLLATION_PROTOCOL    *gUnicodeCollation;\r
-extern        CONST CHAR16*                     SupportLevel[];\r
+extern        EFI_UNICODE_COLLATION_PROTOCOL  *gUnicodeCollation;\r
+extern        CONST CHAR16                    *SupportLevel[];\r
 \r
 //\r
 // The map list objects.\r
 //\r
 typedef struct {\r
-  LIST_ENTRY                    Link;\r
-  EFI_DEVICE_PATH_PROTOCOL      *DevicePath;\r
-  CHAR16                        *MapName;\r
-  CHAR16                        *CurrentDirectoryPath;\r
-  UINT64                         Flags;\r
+  LIST_ENTRY                  Link;\r
+  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;\r
+  CHAR16                      *MapName;\r
+  CHAR16                      *CurrentDirectoryPath;\r
+  UINT64                      Flags;\r
 } SHELL_MAP_LIST;\r
 /// List of Mappings - DeviceName and Drive Letter(ism).\r
-extern        SHELL_MAP_LIST                      gShellMapList;\r
+extern        SHELL_MAP_LIST  gShellMapList;\r
 /// Pointer to node of current directory in the mMapList.\r
-extern        SHELL_MAP_LIST                      *gShellCurMapping;\r
+extern        SHELL_MAP_LIST  *gShellCurMapping;\r
 \r
 /**\r
   Returns the help MAN fileName for a given shell command.\r
@@ -130,14 +130,14 @@ SHELL_STATUS
 RETURN_STATUS\r
 EFIAPI\r
 ShellCommandRegisterCommandName (\r
-  IN CONST  CHAR16                      *CommandString,\r
-  IN        SHELL_RUN_COMMAND           CommandHandler,\r
-  IN        SHELL_GET_MAN_FILENAME      GetManFileName,\r
-  IN        UINT32                      ShellMinSupportLevel,\r
-  IN CONST  CHAR16                      *ProfileName,\r
-  IN CONST  BOOLEAN                     CanAffectLE,\r
-  IN CONST  EFI_HII_HANDLE              HiiHandle,\r
-  IN CONST  EFI_STRING_ID               ManFormatHelp\r
+  IN CONST  CHAR16                  *CommandString,\r
+  IN        SHELL_RUN_COMMAND       CommandHandler,\r
+  IN        SHELL_GET_MAN_FILENAME  GetManFileName,\r
+  IN        UINT32                  ShellMinSupportLevel,\r
+  IN CONST  CHAR16                  *ProfileName,\r
+  IN CONST  BOOLEAN                 CanAffectLE,\r
+  IN CONST  EFI_HII_HANDLE          HiiHandle,\r
+  IN CONST  EFI_STRING_ID           ManFormatHelp\r
   );\r
 \r
 /**\r
@@ -167,9 +167,9 @@ ShellCommandRegisterCommandName (
 RETURN_STATUS\r
 EFIAPI\r
 ShellCommandRunCommandHandler (\r
-  IN CONST CHAR16               *CommandString,\r
-  IN OUT SHELL_STATUS           *RetVal,\r
-  IN OUT BOOLEAN                *CanAffectLE OPTIONAL\r
+  IN CONST CHAR16      *CommandString,\r
+  IN OUT SHELL_STATUS  *RetVal,\r
+  IN OUT BOOLEAN       *CanAffectLE OPTIONAL\r
   );\r
 \r
 /**\r
@@ -185,16 +185,15 @@ ShellCommandRunCommandHandler (
   @retval other                     The name of the MAN file.\r
   @sa SHELL_GET_MAN_FILENAME\r
 **/\r
-CONST CHAR16*\r
+CONST CHAR16 *\r
 EFIAPI\r
 ShellCommandGetManFileNameHandler (\r
-  IN CONST CHAR16               *CommandString\r
+  IN CONST CHAR16  *CommandString\r
   );\r
 \r
-\r
 typedef struct {\r
-  LIST_ENTRY  Link;\r
-  CHAR16      *CommandString;\r
+  LIST_ENTRY    Link;\r
+  CHAR16        *CommandString;\r
 } COMMAND_LIST;\r
 \r
 /**\r
@@ -206,16 +205,16 @@ typedef struct {
 \r
   @return A linked list of all available shell commands.\r
 **/\r
-CONST COMMAND_LIST*\r
+CONST COMMAND_LIST *\r
 EFIAPI\r
 ShellCommandGetCommandList (\r
-  IN CONST BOOLEAN Sort\r
+  IN CONST BOOLEAN  Sort\r
   );\r
 \r
 typedef struct {\r
-  LIST_ENTRY  Link;\r
-  CHAR16      *CommandString;\r
-  CHAR16      *Alias;\r
+  LIST_ENTRY    Link;\r
+  CHAR16        *CommandString;\r
+  CHAR16        *Alias;\r
 } ALIAS_LIST;\r
 \r
 /**\r
@@ -234,8 +233,8 @@ typedef struct {
 RETURN_STATUS\r
 EFIAPI\r
 ShellCommandRegisterAlias (\r
-  IN CONST CHAR16                       *Command,\r
-  IN CONST CHAR16                       *Alias\r
+  IN CONST CHAR16  *Command,\r
+  IN CONST CHAR16  *Alias\r
   );\r
 \r
 /**\r
@@ -245,7 +244,7 @@ ShellCommandRegisterAlias (
 \r
   @return A linked list of all requested shell aliases.\r
 **/\r
-CONST ALIAS_LIST*\r
+CONST ALIAS_LIST *\r
 EFIAPI\r
 ShellCommandGetInitAliasList (\r
   VOID\r
@@ -262,7 +261,7 @@ ShellCommandGetInitAliasList (
 BOOLEAN\r
 EFIAPI\r
 ShellCommandIsOnAliasList (\r
-  IN CONST CHAR16 *Alias\r
+  IN CONST CHAR16  *Alias\r
   );\r
 \r
 /**\r
@@ -276,7 +275,7 @@ ShellCommandIsOnAliasList (
 BOOLEAN\r
 EFIAPI\r
 ShellCommandIsCommandOnList (\r
-  IN CONST  CHAR16                      *CommandString\r
+  IN CONST  CHAR16  *CommandString\r
   );\r
 \r
 /**\r
@@ -287,10 +286,10 @@ ShellCommandIsCommandOnList (
   @retval NULL  No help text was found.\r
   @return       The string of the help text.  The caller required to free.\r
 **/\r
-CHAR16*\r
+CHAR16 *\r
 EFIAPI\r
 ShellCommandGetCommandHelp (\r
-  IN CONST  CHAR16                      *CommandString\r
+  IN CONST  CHAR16  *CommandString\r
   );\r
 \r
 /**\r
@@ -324,11 +323,9 @@ ShellCommandGetEchoState (
 VOID\r
 EFIAPI\r
 ShellCommandSetEchoState (\r
-  IN BOOLEAN State\r
+  IN BOOLEAN  State\r
   );\r
 \r
-\r
-\r
 /**\r
   Indicate that the current shell or script should exit.\r
 \r
@@ -338,8 +335,8 @@ ShellCommandSetEchoState (
 VOID\r
 EFIAPI\r
 ShellCommandRegisterExit (\r
-  IN BOOLEAN      ScriptOnly,\r
-  IN CONST UINT64 ErrorCode\r
+  IN BOOLEAN       ScriptOnly,\r
+  IN CONST UINT64  ErrorCode\r
   );\r
 \r
 /**\r
@@ -380,20 +377,20 @@ ShellCommandGetScriptExit (
   );\r
 \r
 typedef struct {\r
-  LIST_ENTRY      Link;     ///< List enumerator items.\r
-  UINTN           Line;     ///< What line of the script file this was on.\r
-  CHAR16          *Cl;      ///< The original command line.\r
-  VOID            *Data;    ///< The data structure format dependant upon Command. (not always used)\r
-  BOOLEAN         Reset;    ///< Reset the command (it must be treated like a initial run (but it may have data already))\r
+  LIST_ENTRY    Link;       ///< List enumerator items.\r
+  UINTN         Line;       ///< What line of the script file this was on.\r
+  CHAR16        *Cl;        ///< The original command line.\r
+  VOID          *Data;      ///< The data structure format dependant upon Command. (not always used)\r
+  BOOLEAN       Reset;      ///< Reset the command (it must be treated like a initial run (but it may have data already))\r
 } SCRIPT_COMMAND_LIST;\r
 \r
 typedef struct {\r
-  CHAR16              *ScriptName;        ///< The filename of this script.\r
-  CHAR16              **Argv;             ///< The parmameters to the script file.\r
-  UINTN               Argc;               ///< The count of parameters.\r
-  LIST_ENTRY          CommandList;        ///< The script converted to a list of commands (SCRIPT_COMMAND_LIST objects).\r
-  SCRIPT_COMMAND_LIST *CurrentCommand;    ///< The command currently being operated.  If !=NULL must be a member of CommandList.\r
-  LIST_ENTRY          SubstList;          ///< A list of current script loop alias' (ALIAS_LIST objects) (Used for the for %-based replacement).\r
+  CHAR16                 *ScriptName;     ///< The filename of this script.\r
+  CHAR16                 **Argv;          ///< The parmameters to the script file.\r
+  UINTN                  Argc;            ///< The count of parameters.\r
+  LIST_ENTRY             CommandList;     ///< The script converted to a list of commands (SCRIPT_COMMAND_LIST objects).\r
+  SCRIPT_COMMAND_LIST    *CurrentCommand; ///< The command currently being operated.  If !=NULL must be a member of CommandList.\r
+  LIST_ENTRY             SubstList;       ///< A list of current script loop alias' (ALIAS_LIST objects) (Used for the for %-based replacement).\r
 } SCRIPT_FILE;\r
 \r
 /**\r
@@ -402,7 +399,7 @@ typedef struct {
   @retval NULL        A script file is not currently running.\r
   @return             A pointer to the current script file object.\r
 **/\r
-SCRIPT_FILE*\r
+SCRIPT_FILE *\r
 EFIAPI\r
 ShellCommandGetCurrentScriptFile (\r
   VOID\r
@@ -419,10 +416,10 @@ ShellCommandGetCurrentScriptFile (
   @return             A pointer to the current running script file after this\r
                       change.  It is NULL if removing the final script.\r
 **/\r
-SCRIPT_FILE*\r
+SCRIPT_FILE *\r
 EFIAPI\r
 ShellCommandSetNewScript (\r
-  IN SCRIPT_FILE *Script OPTIONAL\r
+  IN SCRIPT_FILE  *Script OPTIONAL\r
   );\r
 \r
 /**\r
@@ -433,7 +430,7 @@ ShellCommandSetNewScript (
 VOID\r
 EFIAPI\r
 DeleteScriptFileStruct (\r
-  IN SCRIPT_FILE *Script\r
+  IN SCRIPT_FILE  *Script\r
   );\r
 \r
 /**\r
@@ -466,10 +463,10 @@ typedef enum {
   @retval NULL                  a memory allocation failed.\r
   @return a new map name string\r
 **/\r
-CHAR16*\r
+CHAR16 *\r
 EFIAPI\r
-ShellCommandCreateNewMappingName(\r
-  IN CONST SHELL_MAPPING_TYPE Type\r
+ShellCommandCreateNewMappingName (\r
+  IN CONST SHELL_MAPPING_TYPE  Type\r
   );\r
 \r
 /**\r
@@ -482,7 +479,7 @@ ShellCommandCreateNewMappingName(
 EFI_STATUS\r
 EFIAPI\r
 ShellCommandConsistMappingInitialize (\r
-  EFI_DEVICE_PATH_PROTOCOL           ***Table\r
+  EFI_DEVICE_PATH_PROTOCOL  ***Table\r
   );\r
 \r
 /**\r
@@ -497,7 +494,7 @@ ShellCommandConsistMappingInitialize (
 EFI_STATUS\r
 EFIAPI\r
 ShellCommandConsistMappingUnInitialize (\r
-  EFI_DEVICE_PATH_PROTOCOL      **Table\r
+  EFI_DEVICE_PATH_PROTOCOL  **Table\r
   );\r
 \r
 /**\r
@@ -513,11 +510,11 @@ ShellCommandConsistMappingUnInitialize (
   @retval NULL            A consistent mapped name could not be created.\r
   @return                 A pointer to a string allocated from pool with the device name.\r
 **/\r
-CHAR16*\r
+CHAR16 *\r
 EFIAPI\r
 ShellCommandConsistMappingGenMappingName (\r
-  IN EFI_DEVICE_PATH_PROTOCOL      *DevicePath,\r
-  IN EFI_DEVICE_PATH_PROTOCOL      **Table\r
+  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
+  IN EFI_DEVICE_PATH_PROTOCOL  **Table\r
   );\r
 \r
 /**\r
@@ -528,10 +525,10 @@ ShellCommandConsistMappingGenMappingName (
 \r
   @return the node on the list.\r
 **/\r
-SHELL_MAP_LIST*\r
+SHELL_MAP_LIST *\r
 EFIAPI\r
 ShellCommandFindMapItem (\r
-  IN CONST CHAR16               *MapKey\r
+  IN CONST CHAR16  *MapKey\r
   );\r
 \r
 /**\r
@@ -553,11 +550,11 @@ ShellCommandFindMapItem (
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-ShellCommandAddMapItemAndUpdatePath(\r
-  IN CONST CHAR16                   *Name,\r
-  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
-  IN CONST UINT64                   Flags,\r
-  IN CONST BOOLEAN                  Path\r
+ShellCommandAddMapItemAndUpdatePath (\r
+  IN CONST CHAR16                    *Name,\r
+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
+  IN CONST UINT64                    Flags,\r
+  IN CONST BOOLEAN                   Path\r
   );\r
 \r
 /**\r
@@ -574,7 +571,7 @@ ShellCommandAddMapItemAndUpdatePath(
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-ShellCommandCreateInitialMappingsAndPaths(\r
+ShellCommandCreateInitialMappingsAndPaths (\r
   VOID\r
   );\r
 \r
@@ -596,10 +593,10 @@ ShellCommandUpdateMapping (
 \r
   @return a EFI_FILE_PROTOCOL* representing the same file.\r
 **/\r
-EFI_FILE_PROTOCOL*\r
+EFI_FILE_PROTOCOL *\r
 EFIAPI\r
-ConvertShellHandleToEfiFileProtocol(\r
-  IN CONST SHELL_FILE_HANDLE Handle\r
+ConvertShellHandleToEfiFileProtocol (\r
+  IN CONST SHELL_FILE_HANDLE  Handle\r
   );\r
 \r
 /**\r
@@ -612,8 +609,8 @@ ConvertShellHandleToEfiFileProtocol(
 **/\r
 BOOLEAN\r
 EFIAPI\r
-ShellFileHandleRemove(\r
-  IN CONST SHELL_FILE_HANDLE Handle\r
+ShellFileHandleRemove (\r
+  IN CONST SHELL_FILE_HANDLE  Handle\r
   );\r
 \r
 /**\r
@@ -626,9 +623,9 @@ ShellFileHandleRemove(
 **/\r
 SHELL_FILE_HANDLE\r
 EFIAPI\r
-ConvertEfiFileProtocolToShellHandle(\r
-  IN CONST EFI_FILE_PROTOCOL *Handle,\r
-  IN CONST CHAR16            *Path\r
+ConvertEfiFileProtocolToShellHandle (\r
+  IN CONST EFI_FILE_PROTOCOL  *Handle,\r
+  IN CONST CHAR16             *Path\r
   );\r
 \r
 /**\r
@@ -638,13 +635,12 @@ ConvertEfiFileProtocolToShellHandle(
 \r
   @return A pointer to the path for the file.\r
 **/\r
-CONST CHAR16*\r
+CONST CHAR16 *\r
 EFIAPI\r
-ShellFileHandleGetPath(\r
-  IN CONST SHELL_FILE_HANDLE Handle\r
+ShellFileHandleGetPath (\r
+  IN CONST SHELL_FILE_HANDLE  Handle\r
   );\r
 \r
-\r
 /**\r
   Function to determine if a SHELL_FILE_HANDLE is at the end of the file.\r
 \r
@@ -659,8 +655,8 @@ ShellFileHandleGetPath(
 **/\r
 BOOLEAN\r
 EFIAPI\r
-ShellFileHandleEof(\r
-  IN SHELL_FILE_HANDLE Handle\r
+ShellFileHandleEof (\r
+  IN SHELL_FILE_HANDLE  Handle\r
   );\r
 \r
 typedef struct {\r
@@ -676,7 +672,7 @@ typedef struct {
 VOID\r
 EFIAPI\r
 FreeBufferList (\r
-  IN BUFFER_LIST *List\r
+  IN BUFFER_LIST  *List\r
   );\r
 \r
 /**\r
@@ -690,10 +686,10 @@ FreeBufferList (
 VOID\r
 EFIAPI\r
 DumpHex (\r
-  IN UINTN        Indent,\r
-  IN UINTN        Offset,\r
-  IN UINTN        DataSize,\r
-  IN VOID         *UserData\r
+  IN UINTN  Indent,\r
+  IN UINTN  Offset,\r
+  IN UINTN  DataSize,\r
+  IN VOID   *UserData\r
   );\r
 \r
 /**\r
@@ -705,7 +701,7 @@ DumpHex (
   @param[in] DataSize   The size in bytes of UserData.\r
   @param[in] UserData   The data to print out.\r
 **/\r
-CHAR16*\r
+CHAR16 *\r
 EFIAPI\r
 CatSDumpHex (\r
   IN CHAR16  *Buffer,\r
@@ -791,8 +787,9 @@ typedef enum {
 EFI_STATUS\r
 EFIAPI\r
 ShellSortFileList (\r
-  IN OUT EFI_SHELL_FILE_INFO  **FileList,\r
-     OUT EFI_SHELL_FILE_INFO  **Duplicates OPTIONAL,\r
-  IN     SHELL_SORT_FILE_LIST Order\r
+  IN OUT EFI_SHELL_FILE_INFO   **FileList,\r
+  OUT EFI_SHELL_FILE_INFO      **Duplicates OPTIONAL,\r
+  IN     SHELL_SORT_FILE_LIST  Order\r
   );\r
+\r
 #endif //_SHELL_COMMAND_LIB_\r