sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ShellPkg: Apply uncrustify changes

Browse Source 
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3737

Apply uncrustify changes to .c/.h files in the ShellPkg package

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
This commit is contained in:
Michael Kubacki
2021-12-05 14:54:13 -08:00
committed by mergify[bot]
parent c411b485b6
commit 47d20b54f9
211 changed files with 30269 additions and 27004 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ShellPkg/Include/Library/AcpiViewCommandLib.h
View File

@@ -21,8 +21,8 @@
UINTN
EFIAPI
ShellDumpBufferToFile (
IN CONST CHAR16* FileNameBuffer,
IN CONST VOID* Buffer,
IN CONST CHAR16 *FileNameBuffer,
IN CONST VOID *Buffer,
IN CONST UINTN BufferSize
);

1
ShellPkg/Include/Library/BcfgCommandLib.h
View File

@@ -43,4 +43,3 @@ BcfgLibraryUnregisterBcfgCommand (
);
#endif

126
ShellPkg/Include/Library/HandleParsingLib.h
View File

@@ -26,10 +26,10 @@
**/
EFI_STATUS
EFIAPI
AddNewGuidNameMapping(
IN CONST EFI_GUID *Guid,
IN CONST CHAR16 *TheName,
IN CONST CHAR8 *Lang OPTIONAL
AddNewGuidNameMapping (
IN CONST EFI_GUID *Guid,
IN CONST CHAR16 *TheName,
IN CONST CHAR8 *Lang OPTIONAL
);
/**
@@ -43,11 +43,11 @@ AddNewGuidNameMapping(
@return The pointer to a string of the name. The caller
is responsible to free this memory.
**/
CHAR16*
CHAR16 *
EFIAPI
GetStringNameFromGuid(
IN CONST EFI_GUID *Guid,
IN CONST CHAR8 *Lang OPTIONAL
GetStringNameFromGuid (
IN CONST EFI_GUID *Guid,
IN CONST CHAR8 *Lang OPTIONAL
);
/**
@@ -63,10 +63,10 @@ GetStringNameFromGuid(
**/
EFI_STATUS
EFIAPI
GetGuidFromStringName(
IN CONST CHAR16 *Name,
IN CONST CHAR8 *Lang OPTIONAL,
OUT EFI_GUID **Guid
GetGuidFromStringName (
IN CONST CHAR16 *Name,
IN CONST CHAR8 *Lang OPTIONAL,
OUT EFI_GUID **Guid
);
/**
@@ -85,12 +85,12 @@ GetGuidFromStringName(
@return The pointer to string.
@retval NULL An error was encountered.
**/
CHAR16*
CHAR16 *
EFIAPI
GetProtocolInformationDump(
IN CONST EFI_HANDLE TheHandle,
IN CONST EFI_GUID *Guid,
IN CONST BOOLEAN Verbose
GetProtocolInformationDump (
IN CONST EFI_HANDLE TheHandle,
IN CONST EFI_GUID *Guid,
IN CONST BOOLEAN Verbose
);
/**
@@ -105,11 +105,11 @@ GetProtocolInformationDump(
@retval NULL The name could not be found.
@return A pointer to the string name. Do not de-allocate the memory.
**/
CONST CHAR16*
CONST CHAR16 *
EFIAPI
GetStringNameFromHandle(
IN CONST EFI_HANDLE TheHandle,
IN CONST CHAR8 *Language
GetStringNameFromHandle (
IN CONST EFI_HANDLE TheHandle,
IN CONST CHAR8 *Language
);
/**
@@ -133,19 +133,19 @@ GetBestLanguageForDriver (
IN BOOLEAN Iso639Language
);
#define HR_UNKNOWN 0
#define HR_IMAGE_HANDLE BIT1
#define HR_DRIVER_BINDING_HANDLE BIT2 // has driver binding
#define HR_DEVICE_DRIVER BIT3 // device driver (hybrid?)
#define HR_BUS_DRIVER BIT4 // a bus driver (hybrid?)
#define HR_DRIVER_CONFIGURATION_HANDLE BIT5
#define HR_DRIVER_DIAGNOSTICS_HANDLE BIT6
#define HR_COMPONENT_NAME_HANDLE BIT7
#define HR_DEVICE_HANDLE BIT8
#define HR_PARENT_HANDLE BIT9
#define HR_CONTROLLER_HANDLE BIT10
#define HR_CHILD_HANDLE BIT11
#define HR_VALID_MASK (BIT1|BIT2|BIT3|BIT4|BIT5|BIT6|BIT7|BIT8|BIT9|BIT10|BIT11)
#define HR_UNKNOWN 0
#define HR_IMAGE_HANDLE BIT1
#define HR_DRIVER_BINDING_HANDLE BIT2 // has driver binding
#define HR_DEVICE_DRIVER BIT3 // device driver (hybrid?)
#define HR_BUS_DRIVER BIT4 // a bus driver (hybrid?)
#define HR_DRIVER_CONFIGURATION_HANDLE BIT5
#define HR_DRIVER_DIAGNOSTICS_HANDLE BIT6
#define HR_COMPONENT_NAME_HANDLE BIT7
#define HR_DEVICE_HANDLE BIT8
#define HR_PARENT_HANDLE BIT9
#define HR_CONTROLLER_HANDLE BIT10
#define HR_CHILD_HANDLE BIT11
#define HR_VALID_MASK (BIT1|BIT2|BIT3|BIT4|BIT5|BIT6|BIT7|BIT8|BIT9|BIT10|BIT11)
/**
Gets all the related EFI_HANDLEs based on the mask supplied.
@@ -177,11 +177,11 @@ GetBestLanguageForDriver (
EFI_STATUS
EFIAPI
ParseHandleDatabaseByRelationship (
IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
IN CONST UINTN Mask,
IN UINTN *MatchingHandleCount,
OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
IN CONST UINTN Mask,
IN UINTN *MatchingHandleCount,
OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
);
/**
@@ -213,11 +213,11 @@ ParseHandleDatabaseByRelationship (
EFI_STATUS
EFIAPI
ParseHandleDatabaseByRelationshipWithType (
IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
IN UINTN *HandleCount,
OUT EFI_HANDLE **HandleBuffer,
OUT UINTN **HandleType
IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
IN UINTN *HandleCount,
OUT EFI_HANDLE **HandleBuffer,
OUT UINTN **HandleType
);
/**
@@ -290,10 +290,10 @@ ParseHandleDatabaseByRelationshipWithType (
**/
EFI_STATUS
EFIAPI
ParseHandleDatabaseForChildDevices(
IN CONST EFI_HANDLE DriverHandle,
IN UINTN *MatchingHandleCount,
OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
ParseHandleDatabaseForChildDevices (
IN CONST EFI_HANDLE DriverHandle,
IN UINTN *MatchingHandleCount,
OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
);
/**
@@ -309,13 +309,12 @@ ParseHandleDatabaseForChildDevices(
**/
EFI_STATUS
EFIAPI
ParseHandleDatabaseForChildControllers(
IN CONST EFI_HANDLE ControllerHandle,
OUT UINTN *MatchingHandleCount,
OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
ParseHandleDatabaseForChildControllers (
IN CONST EFI_HANDLE ControllerHandle,
OUT UINTN *MatchingHandleCount,
OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
);
/**
Function to retrieve the human-friendly index of a given handle. If the handle
does not have a index one will be automatically assigned. The index value is valid
@@ -329,8 +328,8 @@ ParseHandleDatabaseForChildControllers(
**/
UINTN
EFIAPI
ConvertHandleToHandleIndex(
IN CONST EFI_HANDLE TheHandle
ConvertHandleToHandleIndex (
IN CONST EFI_HANDLE TheHandle
);
/**
@@ -344,8 +343,8 @@ ConvertHandleToHandleIndex(
**/
EFI_HANDLE
EFIAPI
ConvertHandleIndexToHandle(
IN CONST UINTN TheIndex
ConvertHandleIndexToHandle (
IN CONST UINTN TheIndex
);
/**
@@ -359,10 +358,10 @@ ConvertHandleIndexToHandle(
@retval NULL A memory allocation failed.
@return A NULL terminated list of handles.
**/
EFI_HANDLE*
EFI_HANDLE *
EFIAPI
GetHandleListByProtocol (
IN CONST EFI_GUID *ProtocolGuid OPTIONAL
IN CONST EFI_GUID *ProtocolGuid OPTIONAL
);
/**
@@ -376,13 +375,12 @@ GetHandleListByProtocol (
@retval NULL ProtocolGuids was NULL.
@return A NULL terminated list of EFI_HANDLEs.
**/
EFI_HANDLE*
EFI_HANDLE *
EFIAPI
GetHandleListByProtocolList (
IN CONST EFI_GUID **ProtocolGuids
IN CONST EFI_GUID **ProtocolGuids
);
/**
Return all supported GUIDs.
@@ -397,8 +395,8 @@ GetHandleListByProtocolList (
EFI_STATUS
EFIAPI
GetAllMappingGuids (
OUT EFI_GUID *Guids,
IN OUT UINTN *Count
OUT EFI_GUID *Guids,
IN OUT UINTN *Count
);
#endif // __HANDLE_PARSING_LIB__

5
ShellPkg/Include/Library/ShellCEntryLib.h
View File

@@ -26,9 +26,8 @@
INTN
EFIAPI
ShellAppMain (
IN UINTN Argc,
IN CHAR16 **Argv
IN UINTN Argc,
IN CHAR16 **Argv
);
#endif

189
ShellPkg/Include/Library/ShellCommandLib.h
View File

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

299
ShellPkg/Include/Library/ShellLib.h
View File

@@ -27,8 +27,8 @@
} \
} while(FALSE)
extern EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol;
extern EFI_SHELL_PROTOCOL *gEfiShellProtocol;
extern EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol;
extern EFI_SHELL_PROTOCOL *gEfiShellProtocol;
/**
Return a clean, fully-qualified version of an input path. If the return value
@@ -58,10 +58,10 @@ extern EFI_SHELL_PROTOCOL *gEfiShellProtocol;
Path. The caller must free this memory when it is no
longer needed.
**/
CHAR16*
CHAR16 *
EFIAPI
FullyQualifyPath(
IN CONST CHAR16 *Path
FullyQualifyPath (
IN CONST CHAR16 *Path
);
/**
@@ -78,10 +78,10 @@ FullyQualifyPath(
@return The information about the file.
**/
EFI_FILE_INFO*
EFI_FILE_INFO *
EFIAPI
ShellGetFileInfo (
IN SHELL_FILE_HANDLE FileHandle
IN SHELL_FILE_HANDLE FileHandle
);
/**
@@ -106,8 +106,8 @@ ShellGetFileInfo (
EFI_STATUS
EFIAPI
ShellSetFileInfo (
IN SHELL_FILE_HANDLE FileHandle,
IN EFI_FILE_INFO *FileInfo
IN SHELL_FILE_HANDLE FileHandle,
IN EFI_FILE_INFO *FileInfo
);
/**
@@ -141,11 +141,11 @@ ShellSetFileInfo (
**/
EFI_STATUS
EFIAPI
ShellOpenFileByDevicePath(
IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,
OUT SHELL_FILE_HANDLE *FileHandle,
IN UINT64 OpenMode,
IN UINT64 Attributes
ShellOpenFileByDevicePath (
IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,
OUT SHELL_FILE_HANDLE *FileHandle,
IN UINT64 OpenMode,
IN UINT64 Attributes
);
/**
@@ -179,11 +179,11 @@ ShellOpenFileByDevicePath(
**/
EFI_STATUS
EFIAPI
ShellOpenFileByName(
IN CONST CHAR16 *FileName,
OUT SHELL_FILE_HANDLE *FileHandle,
IN UINT64 OpenMode,
IN UINT64 Attributes
ShellOpenFileByName (
IN CONST CHAR16 *FileName,
OUT SHELL_FILE_HANDLE *FileHandle,
IN UINT64 OpenMode,
IN UINT64 Attributes
);
/**
@@ -215,9 +215,9 @@ ShellOpenFileByName(
**/
EFI_STATUS
EFIAPI
ShellCreateDirectory(
IN CONST CHAR16 *DirectoryName,
OUT SHELL_FILE_HANDLE *FileHandle
ShellCreateDirectory (
IN CONST CHAR16 *DirectoryName,
OUT SHELL_FILE_HANDLE *FileHandle
);
/**
@@ -251,10 +251,10 @@ ShellCreateDirectory(
**/
EFI_STATUS
EFIAPI
ShellReadFile(
IN SHELL_FILE_HANDLE FileHandle,
IN OUT UINTN *ReadSize,
OUT VOID *Buffer
ShellReadFile (
IN SHELL_FILE_HANDLE FileHandle,
IN OUT UINTN *ReadSize,
OUT VOID *Buffer
);
/**
@@ -285,10 +285,10 @@ ShellReadFile(
**/
EFI_STATUS
EFIAPI
ShellWriteFile(
IN SHELL_FILE_HANDLE FileHandle,
IN OUT UINTN *BufferSize,
IN VOID *Buffer
ShellWriteFile (
IN SHELL_FILE_HANDLE FileHandle,
IN OUT UINTN *BufferSize,
IN VOID *Buffer
);
/**
@@ -306,7 +306,7 @@ ShellWriteFile(
EFI_STATUS
EFIAPI
ShellCloseFile (
IN SHELL_FILE_HANDLE *FileHandle
IN SHELL_FILE_HANDLE *FileHandle
);
/**
@@ -326,7 +326,7 @@ ShellCloseFile (
EFI_STATUS
EFIAPI
ShellDeleteFile (
IN SHELL_FILE_HANDLE *FileHandle
IN SHELL_FILE_HANDLE *FileHandle
);
/**
@@ -374,8 +374,8 @@ ShellSetFilePosition (
EFI_STATUS
EFIAPI
ShellGetFilePosition (
IN SHELL_FILE_HANDLE FileHandle,
OUT UINT64 *Position
IN SHELL_FILE_HANDLE FileHandle,
OUT UINT64 *Position
);
/**
@@ -395,7 +395,7 @@ ShellGetFilePosition (
EFI_STATUS
EFIAPI
ShellFlushFile (
IN SHELL_FILE_HANDLE FileHandle
IN SHELL_FILE_HANDLE FileHandle
);
/** Retrieve first entry from a directory.
@@ -425,8 +425,8 @@ ShellFlushFile (
EFI_STATUS
EFIAPI
ShellFindFirstFile (
IN SHELL_FILE_HANDLE DirHandle,
OUT EFI_FILE_INFO **Buffer
IN SHELL_FILE_HANDLE DirHandle,
OUT EFI_FILE_INFO **Buffer
);
/** Retrieve next entries from a directory.
@@ -451,10 +451,10 @@ ShellFindFirstFile (
**/
EFI_STATUS
EFIAPI
ShellFindNextFile(
IN SHELL_FILE_HANDLE DirHandle,
IN OUT EFI_FILE_INFO *Buffer,
IN OUT BOOLEAN *NoFile
ShellFindNextFile (
IN SHELL_FILE_HANDLE DirHandle,
IN OUT EFI_FILE_INFO *Buffer,
IN OUT BOOLEAN *NoFile
);
/**
@@ -472,8 +472,8 @@ ShellFindNextFile(
EFI_STATUS
EFIAPI
ShellGetFileSize (
IN SHELL_FILE_HANDLE FileHandle,
OUT UINT64 *Size
IN SHELL_FILE_HANDLE FileHandle,
OUT UINT64 *Size
);
/**
@@ -486,7 +486,7 @@ ShellGetFileSize (
**/
BOOLEAN
EFIAPI
ShellGetExecutionBreakFlag(
ShellGetExecutionBreakFlag (
VOID
);
@@ -501,10 +501,10 @@ ShellGetExecutionBreakFlag(
@retval NULL The named environment variable does not exist.
@return != NULL The pointer to the value of the environment variable.
**/
CONST CHAR16*
CONST CHAR16 *
EFIAPI
ShellGetEnvironmentVariable (
IN CONST CHAR16 *EnvKey
IN CONST CHAR16 *EnvKey
);
/**
@@ -530,9 +530,9 @@ ShellGetEnvironmentVariable (
EFI_STATUS
EFIAPI
ShellSetEnvironmentVariable (
IN CONST CHAR16 *EnvKey,
IN CONST CHAR16 *EnvVal,
IN BOOLEAN Volatile
IN CONST CHAR16 *EnvKey,
IN CONST CHAR16 *EnvVal,
IN BOOLEAN Volatile
);
/**
@@ -568,11 +568,11 @@ ShellSetEnvironmentVariable (
EFI_STATUS
EFIAPI
ShellExecute (
IN EFI_HANDLE *ParentHandle,
IN CHAR16 *CommandLine,
IN BOOLEAN Output,
IN CHAR16 **EnvironmentVariables,
OUT EFI_STATUS *Status
IN EFI_HANDLE *ParentHandle,
IN CHAR16 *CommandLine,
IN BOOLEAN Output,
IN CHAR16 **EnvironmentVariables,
OUT EFI_STATUS *Status
);
/**
@@ -589,10 +589,10 @@ ShellExecute (
@retval NULL The directory does not exist.
@retval != NULL The directory.
**/
CONST CHAR16*
CONST CHAR16 *
EFIAPI
ShellGetCurrentDir (
IN CHAR16 * CONST DeviceName OPTIONAL
IN CHAR16 *CONST DeviceName OPTIONAL
);
/**
@@ -606,7 +606,7 @@ ShellGetCurrentDir (
VOID
EFIAPI
ShellSetPageBreakMode (
IN BOOLEAN CurrentState
IN BOOLEAN CurrentState
);
/**
@@ -635,9 +635,9 @@ ShellSetPageBreakMode (
EFI_STATUS
EFIAPI
ShellOpenFileMetaArg (
IN CHAR16 *Arg,
IN UINT64 OpenMode,
IN OUT EFI_SHELL_FILE_INFO **ListHead
IN CHAR16 *Arg,
IN UINT64 OpenMode,
IN OUT EFI_SHELL_FILE_INFO **ListHead
);
/**
@@ -651,7 +651,7 @@ ShellOpenFileMetaArg (
EFI_STATUS
EFIAPI
ShellCloseFileMetaArg (
IN OUT EFI_SHELL_FILE_INFO **ListHead
IN OUT EFI_SHELL_FILE_INFO **ListHead
);
/**
@@ -669,7 +669,7 @@ ShellCloseFileMetaArg (
CHAR16 *
EFIAPI
ShellFindFilePath (
IN CONST CHAR16 *FileName
IN CONST CHAR16 *FileName
);
/**
@@ -691,12 +691,12 @@ ShellFindFilePath (
CHAR16 *
EFIAPI
ShellFindFilePathEx (
IN CONST CHAR16 *FileName,
IN CONST CHAR16 *FileExtension
IN CONST CHAR16 *FileName,
IN CONST CHAR16 *FileExtension
);
typedef enum {
TypeFlag = 0, ///< A flag that is present or not present only (IE "-a").
TypeFlag = 0, ///< A flag that is present or not present only (IE "-a").
TypeValue, ///< A flag that has some data following it with a space (IE "-a 1").
TypePosition, ///< Some data that did not follow a parameter (IE "filename.txt").
TypeStart, ///< A flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).
@@ -707,16 +707,15 @@ typedef enum {
} SHELL_PARAM_TYPE;
typedef struct {
CHAR16 *Name;
SHELL_PARAM_TYPE Type;
CHAR16 *Name;
SHELL_PARAM_TYPE Type;
} SHELL_PARAM_ITEM;
/// Helper structure for no parameters (besides -? and -b)
extern SHELL_PARAM_ITEM EmptyParamList[];
extern SHELL_PARAM_ITEM EmptyParamList[];
/// Helper structure for -sfo only (besides -? and -b)
extern SHELL_PARAM_ITEM SfoParamList[];
extern SHELL_PARAM_ITEM SfoParamList[];
/**
Checks the command line arguments passed against the list of valid ones.
@@ -745,15 +744,15 @@ extern SHELL_PARAM_ITEM SfoParamList[];
EFI_STATUS
EFIAPI
ShellCommandLineParseEx (
IN CONST SHELL_PARAM_ITEM *CheckList,
OUT LIST_ENTRY **CheckPackage,
OUT CHAR16 **ProblemParam OPTIONAL,
IN BOOLEAN AutoPageBreak,
IN BOOLEAN AlwaysAllowNumbers
IN CONST SHELL_PARAM_ITEM *CheckList,
OUT LIST_ENTRY **CheckPackage,
OUT CHAR16 **ProblemParam OPTIONAL,
IN BOOLEAN AutoPageBreak,
IN BOOLEAN AlwaysAllowNumbers
);
/// Make it easy to upgrade from older versions of the shell library.
#define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)
#define ShellCommandLineParse(CheckList, CheckPackage, ProblemParam, AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)
/**
Frees shell variable list that was returned from ShellCommandLineParse.
@@ -768,7 +767,7 @@ ShellCommandLineParseEx (
VOID
EFIAPI
ShellCommandLineFreeVarList (
IN LIST_ENTRY *CheckPackage
IN LIST_ENTRY *CheckPackage
);
/**
@@ -788,8 +787,8 @@ ShellCommandLineFreeVarList (
BOOLEAN
EFIAPI
ShellCommandLineGetFlag (
IN CONST LIST_ENTRY * CONST CheckPackage,
IN CONST CHAR16 * CONST KeyString
IN CONST LIST_ENTRY *CONST CheckPackage,
IN CONST CHAR16 *CONST KeyString
);
/**
@@ -805,11 +804,11 @@ ShellCommandLineGetFlag (
@retval NULL The flag is not on the command line.
@retval !=NULL The pointer to unicode string of the value.
**/
CONST CHAR16*
CONST CHAR16 *
EFIAPI
ShellCommandLineGetValue (
IN CONST LIST_ENTRY *CheckPackage,
IN CHAR16 *KeyString
IN CONST LIST_ENTRY *CheckPackage,
IN CHAR16 *KeyString
);
/**
@@ -825,11 +824,11 @@ ShellCommandLineGetValue (
@retval NULL The flag is not on the command line.
@retval !=NULL The pointer to unicode string of the value.
**/
CONST CHAR16*
CONST CHAR16 *
EFIAPI
ShellCommandLineGetRawValue (
IN CONST LIST_ENTRY * CONST CheckPackage,
IN UINTN Position
IN CONST LIST_ENTRY *CONST CheckPackage,
IN UINTN Position
);
/**
@@ -844,8 +843,8 @@ ShellCommandLineGetRawValue (
**/
UINTN
EFIAPI
ShellCommandLineGetCount(
IN CONST LIST_ENTRY *CheckPackage
ShellCommandLineGetCount (
IN CONST LIST_ENTRY *CheckPackage
);
/**
@@ -865,8 +864,8 @@ ShellCommandLineGetCount(
EFI_STATUS
EFIAPI
ShellCommandLineCheckDuplicate (
IN CONST LIST_ENTRY *CheckPackage,
OUT CHAR16 **Param
IN CONST LIST_ENTRY *CheckPackage,
OUT CHAR16 **Param
);
/**
@@ -919,10 +918,10 @@ ShellInitialize (
**/
EFI_STATUS
EFIAPI
ShellPrintEx(
IN INT32 Col OPTIONAL,
IN INT32 Row OPTIONAL,
IN CONST CHAR16 *Format,
ShellPrintEx (
IN INT32 Col OPTIONAL,
IN INT32 Row OPTIONAL,
IN CONST CHAR16 *Format,
...
);
@@ -960,12 +959,12 @@ ShellPrintEx(
**/
EFI_STATUS
EFIAPI
ShellPrintHiiEx(
IN INT32 Col OPTIONAL,
IN INT32 Row OPTIONAL,
IN CONST CHAR8 *Language OPTIONAL,
IN CONST EFI_STRING_ID HiiFormatStringId,
IN CONST EFI_HII_HANDLE HiiFormatHandle,
ShellPrintHiiEx (
IN INT32 Col OPTIONAL,
IN INT32 Row OPTIONAL,
IN CONST CHAR8 *Language OPTIONAL,
IN CONST EFI_STRING_ID HiiFormatStringId,
IN CONST EFI_HII_HANDLE HiiFormatHandle,
...
);
@@ -982,8 +981,8 @@ ShellPrintHiiEx(
**/
EFI_STATUS
EFIAPI
ShellIsDirectory(
IN CONST CHAR16 *DirName
ShellIsDirectory (
IN CONST CHAR16 *DirName
);
/**
@@ -1001,8 +1000,8 @@ ShellIsDirectory(
**/
EFI_STATUS
EFIAPI
ShellIsFile(
IN CONST CHAR16 *Name
ShellIsFile (
IN CONST CHAR16 *Name
);
/**
@@ -1020,8 +1019,8 @@ ShellIsFile(
**/
EFI_STATUS
EFIAPI
ShellIsFileInPath(
IN CONST CHAR16 *Name
ShellIsFileInPath (
IN CONST CHAR16 *Name
);
/**
@@ -1038,8 +1037,8 @@ ShellIsFileInPath(
**/
UINTN
EFIAPI
ShellStrToUintn(
IN CONST CHAR16 *String
ShellStrToUintn (
IN CONST CHAR16 *String
);
/**
@@ -1055,8 +1054,8 @@ ShellStrToUintn(
**/
UINTN
EFIAPI
ShellHexStrToUintn(
IN CONST CHAR16 *String
ShellHexStrToUintn (
IN CONST CHAR16 *String
);
/**
@@ -1091,13 +1090,13 @@ ShellHexStrToUintn(
@return The Destination after appending the Source.
**/
CHAR16*
CHAR16 *
EFIAPI
StrnCatGrow (
IN OUT CHAR16 **Destination,
IN OUT UINTN *CurrentSize,
IN CONST CHAR16 *Source,
IN UINTN Count
IN OUT CHAR16 **Destination,
IN OUT UINTN *CurrentSize,
IN CONST CHAR16 *Source,
IN UINTN Count
);
/**
@@ -1129,14 +1128,14 @@ StrnCatGrow (
**/
EFI_STATUS
EFIAPI
ShellCopySearchAndReplace(
IN CHAR16 CONST *SourceString,
IN OUT CHAR16 *NewString,
IN UINTN NewSize,
IN CONST CHAR16 *FindTarget,
IN CONST CHAR16 *ReplaceWith,
IN CONST BOOLEAN SkipPreCarrot,
IN CONST BOOLEAN ParameterReplacing
ShellCopySearchAndReplace (
IN CHAR16 CONST *SourceString,
IN OUT CHAR16 *NewString,
IN UINTN NewSize,
IN CONST CHAR16 *FindTarget,
IN CONST CHAR16 *ReplaceWith,
IN CONST BOOLEAN SkipPreCarrot,
IN CONST BOOLEAN ParameterReplacing
);
/**
@@ -1156,7 +1155,7 @@ ShellCopySearchAndReplace(
BOOLEAN
EFIAPI
ShellIsHexaDecimalDigitCharacter (
IN CHAR16 Char
IN CHAR16 Char
);
/**
@@ -1176,7 +1175,7 @@ ShellIsHexaDecimalDigitCharacter (
BOOLEAN
EFIAPI
ShellIsDecimalDigitCharacter (
IN CHAR16 Char
IN CHAR16 Char
);
///
@@ -1233,9 +1232,9 @@ typedef enum {
EFI_STATUS
EFIAPI
ShellPromptForResponse (
IN SHELL_PROMPT_REQUEST_TYPE Type,
IN CHAR16 *Prompt OPTIONAL,
IN OUT VOID **Response OPTIONAL
IN SHELL_PROMPT_REQUEST_TYPE Type,
IN CHAR16 *Prompt OPTIONAL,
IN OUT VOID **Response OPTIONAL
);
/**
@@ -1258,10 +1257,10 @@ ShellPromptForResponse (
EFI_STATUS
EFIAPI
ShellPromptForResponseHii (
IN SHELL_PROMPT_REQUEST_TYPE Type,
IN CONST EFI_STRING_ID HiiFormatStringId,
IN CONST EFI_HII_HANDLE HiiFormatHandle,
IN OUT VOID **Response
IN SHELL_PROMPT_REQUEST_TYPE Type,
IN CONST EFI_STRING_ID HiiFormatStringId,
IN CONST EFI_HII_HANDLE HiiFormatHandle,
IN OUT VOID **Response
);
/**
@@ -1301,9 +1300,9 @@ ShellIsHexOrDecimalNumber (
**/
EFI_STATUS
EFIAPI
ShellConvertStringToUint64(
ShellConvertStringToUint64 (
IN CONST CHAR16 *String,
OUT UINT64 *Value,
OUT UINT64 *Value,
IN CONST BOOLEAN ForceHex,
IN CONST BOOLEAN StopAtSpace
);
@@ -1319,8 +1318,8 @@ ShellConvertStringToUint64(
**/
EFI_STATUS
EFIAPI
ShellFileExists(
IN CONST CHAR16 *Name
ShellFileExists (
IN CONST CHAR16 *Name
);
/**
@@ -1338,11 +1337,11 @@ ShellFileExists(
@sa ShellFileHandleReadLine
**/
CHAR16*
CHAR16 *
EFIAPI
ShellFileHandleReturnLine(
IN SHELL_FILE_HANDLE Handle,
IN OUT BOOLEAN *Ascii
ShellFileHandleReturnLine (
IN SHELL_FILE_HANDLE Handle,
IN OUT BOOLEAN *Ascii
);
/**
@@ -1373,12 +1372,12 @@ ShellFileHandleReturnLine(
**/
EFI_STATUS
EFIAPI
ShellFileHandleReadLine(
IN SHELL_FILE_HANDLE Handle,
IN OUT CHAR16 *Buffer,
IN OUT UINTN *Size,
IN BOOLEAN Truncate,
IN OUT BOOLEAN *Ascii
ShellFileHandleReadLine (
IN SHELL_FILE_HANDLE Handle,
IN OUT CHAR16 *Buffer,
IN OUT UINTN *Size,
IN BOOLEAN Truncate,
IN OUT BOOLEAN *Ascii
);
/**
@@ -1406,8 +1405,8 @@ ShellFileHandleReadLine(
**/
EFI_STATUS
EFIAPI
ShellDeleteFileByName(
IN CONST CHAR16 *FileName
ShellDeleteFileByName (
IN CONST CHAR16 *FileName
);
/**
@@ -1424,9 +1423,9 @@ ShellDeleteFileByName(
EFI_STATUS
EFIAPI
ShellPrintHelp (
IN CONST CHAR16 *CommandToGetHelpOn,
IN CONST CHAR16 *SectionToGetHelpOn,
IN BOOLEAN PrintCommandText
IN CONST CHAR16 *CommandToGetHelpOn,
IN CONST CHAR16 *SectionToGetHelpOn,
IN BOOLEAN PrintCommandText
);
#endif // __SHELL_LIB__