/** @file\r
Provides interface to shell functionality for shell commands and applications.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+ Copyright (c) 2006 - 2010, Intel Corporation<BR>\r
+ All rights reserved. This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#if !defined(__SHELL_LIB__)\r
#define __SHELL_LIB__\r
\r
+#include <Uefi.h>\r
+#include <Guid/FileInfo.h>\r
#include <Protocol/SimpleFileSystem.h>\r
+#include <Protocol/LoadedImage.h>\r
+#include <Protocol/EfiShellInterface.h>\r
+#include <Protocol/EfiShellEnvironment2.h>\r
#include <Protocol/EfiShell.h>\r
+#include <Protocol/EfiShellParameters.h>\r
\r
/**\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
This function allocates a buffer to store the file's information. It is the \r
- caller's responsibility to free the buffer\r
+ caller's responsibility to free the buffer.\r
\r
- @param FileHandle The file handle of the file for which information is \r
- being requested.\r
+ @param[in] FileHandle The file handle of the file for which information is \r
+ being requested.\r
\r
- @retval NULL information could not be retrieved.\r
+ @retval NULL Information could not be retrieved.\r
\r
- @return the information about the file\r
+ @return The information about the file.\r
**/\r
EFI_FILE_INFO*\r
EFIAPI\r
This function will set the information about the file for the opened handle \r
specified.\r
\r
- @param FileHandle The file handle of the file for which information \r
- is being set\r
+ @param[in] FileHandle The file handle of the file for which information \r
+ is being set.\r
\r
- @param FileInfo The infotmation to set.\r
+ @param[in] FileInfo The infotmation to set.\r
\r
- @retval EFI_SUCCESS The information was set.\r
+ @retval EFI_SUCCESS The information was set.\r
@retval EFI_UNSUPPORTED The InformationType is not known.\r
@retval EFI_NO_MEDIA The device has no medium.\r
@retval EFI_DEVICE_ERROR The device reported an error.\r
This function opens a file with the open mode according to the file path. The \r
Attributes is valid only for EFI_FILE_MODE_CREATE.\r
\r
- @param FilePath on input the device path to the file. On output \r
- the remaining device path.\r
- @param DeviceHandle pointer to the system device handle.\r
- @param FileHandle pointer to the file handle.\r
- @param OpenMode the mode to open the file with.\r
- @param Attributes the file's file attributes.\r
+ @param[in] FilePath On input the device path to the file. On output \r
+ the remaining device path.\r
+ @param[out] DeviceHandle Pointer to the system device handle.\r
+ @param[out] FileHandle Pointer to the file handle.\r
+ @param[in] OpenMode The mode to open the file with.\r
+ @param[in] Attributes The file's file attributes.\r
\r
@retval EFI_SUCCESS The information was set.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
otherwise, the Filehandle is NULL. The Attributes is valid only for \r
EFI_FILE_MODE_CREATE.\r
\r
- @param FileName pointer to file name\r
- @param FileHandle pointer to the file handle.\r
- @param OpenMode the mode to open the file with.\r
- @param Attributes the file's file attributes.\r
+ @param[in] FileName Pointer to file name.\r
+ @param[out] FileHandle Pointer to the file handle.\r
+ @param[in] OpenMode The mode to open the file with.\r
+ @param[in] Attributes The file's file attributes.\r
\r
- @retval EFI_SUCCESS The information was set.\r
+ @retval EFI_SUCCESS The information was set.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
- @retval EFI_UNSUPPORTED Could not open the file path. \r
+ @retval EFI_UNSUPPORTED Could not open the file path. \r
@retval EFI_NOT_FOUND The specified file could not be found on the \r
device or the file system could not be found \r
on the device.\r
- @retval EFI_NO_MEDIA The device has no medium.\r
- @retval EFI_MEDIA_CHANGED The device has a different medium in it or the \r
+ @retval EFI_NO_MEDIA The device has no medium.\r
+ @retval EFI_MEDIA_CHANGED The device has a different medium in it or the \r
medium is no longer supported.\r
- @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
- @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
- @retval EFI_ACCESS_DENIED The file was opened read only.\r
+ @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
+ @retval EFI_ACCESS_DENIED The file was opened read only.\r
@retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the \r
file.\r
- @retval EFI_VOLUME_FULL The volume is full.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function create a directory\r
+ This function creates a directory.\r
\r
If return is EFI_SUCCESS, the Filehandle is the opened directory's handle; \r
otherwise, the Filehandle is NULL. If the directory already existed, this \r
function opens the existing directory.\r
\r
- @param DirectoryName pointer to Directory name\r
- @param FileHandle pointer to the file handle.\r
+ @param[in] DirectoryName Pointer to Directory name.\r
+ @param[out] FileHandle Pointer to the file handle.\r
\r
@retval EFI_SUCCESS The information was set.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
- @retval EFI_UNSUPPORTED Could not open the file path. \r
+ @retval EFI_UNSUPPORTED Could not open the file path. \r
@retval EFI_NOT_FOUND The specified file could not be found on the \r
device or the file system could not be found \r
on the device.\r
- @retval EFI_NO_MEDIA The device has no medium.\r
- @retval EFI_MEDIA_CHANGED The device has a different medium in it or the \r
+ @retval EFI_NO_MEDIA The device has no medium.\r
+ @retval EFI_MEDIA_CHANGED The device has a different medium in it or the \r
medium is no longer supported.\r
- @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
- @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
- @retval EFI_ACCESS_DENIED The file was opened read only.\r
+ @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
+ @retval EFI_ACCESS_DENIED The file was opened read only.\r
@retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the \r
file.\r
- @retval EFI_VOLUME_FULL The volume is full.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
**/\r
EFI_STATUS\r
EFIAPI\r
are no more directory entries, the read returns a zero-length buffer. \r
EFI_FILE_INFO is the structure returned as the directory entry.\r
\r
- @param FileHandle the opened file handle\r
- \r
- @param ReadSize on input the size of buffer in bytes. on return \r
+ @param[in] FileHandle The opened file handle.\r
+ @param[in] ReadSize On input the size of buffer in bytes. On return \r
the number of bytes written.\r
+ @param[out] Buffer The buffer to put read data into.\r
\r
- @param Buffer the buffer to put read data into.\r
-\r
- @retval EFI_SUCCESS Data was read.\r
- @retval EFI_NO_MEDIA The device has no media.\r
- @retval EFI_DEVICE_ERROR The device reported an error.\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
- @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required \r
+ @retval EFI_SUCCESS Data was read.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required \r
size.\r
\r
**/\r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
- @param FileHandle The opened file for writing\r
+ @param[in] FileHandle The opened file for writing.\r
\r
- @param BufferSize on input the number of bytes in Buffer. On output\r
+ @param[in] BufferSize On input the number of bytes in Buffer. On output\r
the number of bytes written.\r
\r
- @param Buffer the buffer containing data to write is stored.\r
+ @param[in] Buffer The buffer containing data to write is stored.\r
\r
- @retval EFI_SUCCESS Data was written.\r
- @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
- @retval EFI_NO_MEDIA The device has no media.\r
- @retval EFI_DEVICE_ERROR The device reported an error.\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
- @retval EFI_WRITE_PROTECTED The device is write-protected.\r
- @retval EFI_ACCESS_DENIED The file was open for read only.\r
- @retval EFI_VOLUME_FULL The volume is full.\r
+ @retval EFI_SUCCESS Data was written.\r
+ @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED The device is write-protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
**/\r
EFI_STATUS\r
EFIAPI\r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
-@param FileHandle the file handle to close.\r
+ @param[in] FileHandle The file handle to close.\r
\r
-@retval EFI_SUCCESS the file handle was closed sucessfully.\r
-@retval INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_SUCCESS The file handle was closed sucessfully.\r
+ @retval INVALID_PARAMETER One of the parameters has an invalid value.\r
**/\r
EFI_STATUS\r
EFIAPI\r
If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is \r
returned, but the handle is still closed.\r
\r
- @param FileHandle the file handle to delete\r
+ @param[in] FileHandle The file handle to delete.\r
\r
- @retval EFI_SUCCESS the file was closed sucessfully\r
- @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not \r
- deleted\r
- @retval INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_SUCCESS The file was closed sucessfully.\r
+ @retval EFI_WARN_DELETE_FAILURE The handle was closed, but the file was not \r
+ deleted.\r
+ @retval INVALID_PARAMETER One of the parameters has an invalid value.\r
**/\r
EFI_STATUS\r
EFIAPI\r
If FileHandle is a directory, the only position that may be set is zero. This \r
has the effect of starting the read process of the directory entries over.\r
\r
- @param FileHandle The file handle on which the position is being set\r
+ @param[in] FileHandle The file handle on which the position is being set.\r
\r
- @param Position Byte position from begining of file\r
+ @param[in] Position Byte position from begining of file.\r
\r
@retval EFI_SUCCESS Operation completed sucessfully.\r
- @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on \r
+ @retval EFI_UNSUPPORTED The seek request for non-zero is not valid on \r
directories.\r
@retval INVALID_PARAMETER One of the parameters has an invalid value.\r
**/\r
system driver and as such the operation is not supported. An error is returned\r
if FileHandle is a directory.\r
\r
- @param FileHandle The open file handle on which to get the position.\r
- @param Position Byte position from begining of file.\r
+ @param[in] FileHandle The open file handle on which to get the position.\r
+ @param[out] Position Byte position from begining of file.\r
\r
- @retval EFI_SUCCESS the operation completed sucessfully.\r
+ @retval EFI_SUCCESS The operation completed sucessfully.\r
@retval INVALID_PARAMETER One of the parameters has an invalid value.\r
- @retval EFI_UNSUPPORTED the request is not valid on directories.\r
+ @retval EFI_UNSUPPORTED The request is not valid on directories.\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
This function flushes all modified data associated with a file to a device.\r
\r
- @param FileHandle The file handle on which to flush data\r
+ @param[in] FileHandle The file handle on which to flush data.\r
\r
@retval EFI_SUCCESS The data was flushed.\r
@retval EFI_NO_MEDIA The device has no media.\r
\r
Caller must use FreePool on *Buffer opon completion of all file searching.\r
\r
- @param DirHandle The file handle of the directory to search\r
- @param Buffer Pointer to pointer to buffer for file's information\r
+ @param[in] DirHandle The file handle of the directory to search\r
+ @param[out] Buffer Pointer to pointer to buffer for file's information\r
\r
@retval EFI_SUCCESS Found the first file.\r
@retval EFI_NOT_FOUND Cannot find the directory.\r
call of this function has no file to get. *NoFile will be set to TRUE and the \r
data in Buffer is meaningless. \r
\r
- @param DirHandle the file handle of the directory\r
- @param Buffer pointer to buffer for file's information\r
- @param NoFile pointer to boolean when last file is found\r
+ @param[in] DirHandle The file handle of the directory.\r
+ @param[out] Buffer Pointer to buffer for file's information.\r
+ @param[out] NoFile Pointer to boolean when last file is found.\r
\r
@retval EFI_SUCCESS Found the next file.\r
@retval EFI_NO_MEDIA The device has no media.\r
This function extracts the file size info from the FileHandle's EFI_FILE_INFO \r
data.\r
\r
- @param FileHandle file handle from which size is retrieved\r
- @param Size pointer to size\r
+ @param[in] FileHandle The file handle from which size is retrieved.\r
+ @param[out] Size Pointer to size.\r
\r
- @retval EFI_SUCCESS operation was completed sucessfully\r
- @retval EFI_DEVICE_ERROR cannot access the file\r
+ @retval EFI_SUCCESS The operation was completed sucessfully.\r
+ @retval EFI_DEVICE_ERROR Cannot access the file.\r
**/\r
EFI_STATUS\r
EFIAPI\r
/**\r
Retrieves the status of the break execution flag\r
\r
- this function is useful to check whether the application is being asked to halt by the shell.\r
+ This function is useful to check whether the application is being asked to halt by the shell.\r
\r
@retval TRUE the execution break is enabled\r
@retval FALSE the execution break is not enabled\r
);\r
\r
/**\r
- return the value of an environment variable\r
+ Return the value of an environment variable.\r
\r
- this function gets the value of the environment variable set by the \r
- ShellSetEnvironmentVariable function\r
+ This function gets the value of the environment variable set by the \r
+ ShellSetEnvironmentVariable function.\r
\r
- @param EnvKey The key name of the environment variable.\r
+ @param[in] EnvKey The key name of the environment variable.\r
\r
- @retval NULL the named environment variable does not exist.\r
- @return != NULL pointer to the value of the environment variable\r
+ @retval NULL The named environment variable does not exist.\r
+ @return != NULL pointer to the value of the environment variable.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
);\r
\r
/**\r
- set the value of an environment variable\r
+ Set the value of an environment variable.\r
\r
-This function changes the current value of the specified environment variable. If the\r
-environment variable exists and the Value is an empty string, then the environment\r
-variable is deleted. If the environment variable exists and the Value is not an empty\r
-string, then the value of the environment variable is changed. If the environment\r
-variable does not exist and the Value is an empty string, there is no action. If the\r
-environment variable does not exist and the Value is a non-empty string, then the\r
-environment variable is created and assigned the specified value.\r
+ This function changes the current value of the specified environment variable. If the\r
+ environment variable exists and the Value is an empty string, then the environment\r
+ variable is deleted. If the environment variable exists and the Value is not an empty\r
+ string, then the value of the environment variable is changed. If the environment\r
+ variable does not exist and the Value is an empty string, there is no action. If the\r
+ environment variable does not exist and the Value is a non-empty string, then the\r
+ environment variable is created and assigned the specified value.\r
\r
This is not supported pre-UEFI Shell 2.0.\r
\r
- @param EnvKey The key name of the environment variable.\r
- @param EnvVal The Value of the environment variable\r
- @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r
+ @param[in] EnvKey The key name of the environment variable.\r
+ @param[in] EnvVal The Value of the environment variable\r
+ @param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r
\r
@retval EFI_SUCCESS the operation was completed sucessfully\r
@retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments\r
);\r
\r
/**\r
- cause the shell to parse and execute a command line.\r
+ Cause the shell to parse and execute a command line.\r
\r
This function creates a nested instance of the shell and executes the specified\r
-command (CommandLine) with the specified environment (Environment). Upon return,\r
-the status code returned by the specified command is placed in StatusCode.\r
-If Environment is NULL, then the current environment is used and all changes made\r
-by the commands executed will be reflected in the current environment. If the\r
-Environment is non-NULL, then the changes made will be discarded.\r
-The CommandLine is executed from the current working directory on the current\r
-device.\r
-\r
-EnvironmentVariables and Status are only supported for UEFI Shell 2.0.\r
-Output is only supported for pre-UEFI Shell 2.0\r
-\r
- @param ImageHandle Parent image that is starting the operation\r
- @param CommandLine pointer to null terminated command line.\r
- @param Output true to display debug output. false to hide it.\r
- @param EnvironmentVariables optional pointer to array of environment variables\r
- in the form "x=y". if NULL current set is used.\r
- @param Status the status of the run command line.\r
-\r
- @retval EFI_SUCCESS the operation completed sucessfully. Status\r
- contains the status code returned.\r
- @retval EFI_INVALID_PARAMETER a parameter contains an invalid value\r
- @retval EFI_OUT_OF_RESOURCES out of resources\r
- @retval EFI_UNSUPPORTED the operation is not allowed.\r
+ command (CommandLine) with the specified environment (Environment). Upon return,\r
+ the status code returned by the specified command is placed in StatusCode.\r
+ If Environment is NULL, then the current environment is used and all changes made\r
+ by the commands executed will be reflected in the current environment. If the\r
+ Environment is non-NULL, then the changes made will be discarded.\r
+ The CommandLine is executed from the current working directory on the current\r
+ device.\r
+\r
+ EnvironmentVariables and Status are only supported for UEFI Shell 2.0 (or later).\r
+ Output is only supported for pre-UEFI Shell 2.0\r
+\r
+ @param[in] ImageHandle Parent image that is starting the operation.\r
+ @param[in] CommandLine Pointer to null terminated command line.\r
+ @param[in] Output True to display debug output. False to hide it.\r
+ @param[in] EnvironmentVariables Optional pointer to array of environment variables\r
+ in the form "x=y". If NULL current set is used.\r
+ @param[out] Status The status of the run command line.\r
+\r
+ @retval EFI_SUCCESS The operation completed sucessfully. Status\r
+ contains the status code returned.\r
+ @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
+ @retval EFI_UNSUPPORTED The operation is not allowed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- Retreives the current directory path\r
+ Retreives the current directory path.\r
\r
If the DeviceName is NULL, it returns the current device's current directory \r
name. If the DeviceName is not NULL, it returns the current directory name \r
on specified drive.\r
\r
- @param DeviceName the name of the drive to get directory on\r
+ @param[in] DeviceName The name of the file system to get directory on.\r
\r
- @retval NULL the directory does not exist\r
- @return != NULL the directory\r
+ @retval NULL The directory does not exist.\r
+ @retval != NULL The directory.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
);\r
\r
/**\r
- sets (enabled or disabled) the page break mode\r
+ Sets (enabled or disabled) the page break mode.\r
\r
- when page break mode is enabled the screen will stop scrolling \r
+ When page break mode is enabled the screen will stop scrolling \r
and wait for operator input before scrolling a subsequent screen.\r
\r
- @param CurrentState TRUE to enable and FALSE to disable\r
+ @param[in] CurrentState TRUE to enable and FALSE to disable.\r
**/\r
VOID \r
EFIAPI\r
file has a SHELL_FILE_ARG structure to record the file information. These \r
structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG \r
structures from ListHead to access each file. This function supports wildcards\r
- and will process '?' and '*' as such. the list must be freed with a call to \r
+ and will process '?' and '*' as such. The list must be freed with a call to \r
ShellCloseFileMetaArg().\r
\r
- If you are NOT appending to an existing list *ListHead must be NULL.\r
+ If you are NOT appending to an existing list *ListHead must be NULL. If \r
+ *ListHead is NULL then it must be callee freed.\r
\r
- @param Arg pointer to path string\r
- @param OpenMode mode to open files with\r
- @param ListHead head of linked list of results\r
+ @param[in] Arg Pointer to path string.\r
+ @param[in] OpenMode Mode to open files with.\r
+ @param[in] ListHead Head of linked list of results.\r
\r
- @retval EFI_SUCCESS the operation was sucessful and the list head \r
- contains the list of opened files\r
- #retval EFI_UNSUPPORTED a previous ShellOpenFileMetaArg must be closed first.\r
- *ListHead is set to NULL.\r
- @return != EFI_SUCCESS the operation failed\r
+ @retval EFI_SUCCESS The operation was sucessful and the list head \r
+ contains the list of opened files.\r
+ @retval != EFI_SUCCESS The operation failed.\r
\r
@sa InternalShellConvertFileListType\r
**/\r
);\r
\r
/**\r
- Free the linked list returned from ShellOpenFileMetaArg\r
+ Free the linked list returned from ShellOpenFileMetaArg.\r
\r
- @param ListHead the pointer to free\r
+ @param[in] ListHead The pointer to free.\r
\r
- @retval EFI_SUCCESS the operation was sucessful\r
- @retval EFI_INVALID_PARAMETER A parameter was invalid\r
+ @retval EFI_SUCCESS The operation was sucessful.\r
+ @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
IN OUT EFI_SHELL_FILE_INFO **ListHead\r
);\r
\r
+/**\r
+ Find a file by searching the CWD and then the path.\r
+\r
+ If FileName is NULL, then ASSERT.\r
+\r
+ If the return value is not NULL then the memory must be caller freed.\r
+\r
+ @param[in] FileName Filename string.\r
+\r
+ @retval NULL The file was not found.\r
+ @retval !NULL The path to the file.\r
+**/\r
+CHAR16 *\r
+EFIAPI\r
+ShellFindFilePath (\r
+ IN CONST CHAR16 *FileName\r
+ );\r
+\r
+/**\r
+ Find a file by searching the CWD and then the path with a variable set of file \r
+ extensions. If the file is not found it will append each extension in the list \r
+ in the order provided and return the first one that is successful.\r
+\r
+ If FileName is NULL, then ASSERT.\r
+ If FileExtension is NULL, then behavior is identical to ShellFindFilePath.\r
+\r
+ If the return value is not NULL then the memory must be caller freed.\r
+\r
+ @param[in] FileName Filename string.\r
+ @param[in] FileExtension Semi-colon delimeted list of possible extensions.\r
+\r
+ @retval NULL The file was not found.\r
+ @retval !NULL The path to the file.\r
+**/\r
+CHAR16 *\r
+EFIAPI\r
+ShellFindFilePathEx (\r
+ IN CONST CHAR16 *FileName,\r
+ IN CONST CHAR16 *FileExtension\r
+ );\r
+\r
typedef enum {\r
- TypeFlag = 0,\r
- TypeValue,\r
- TypePosition,\r
+ TypeFlag = 0, ///< A flag that is present or not present only (IE "-a").\r
+ TypeValue, ///< A flag that has some data following it with a space (IE "-a 1").\r
+ TypePosition, ///< Some data that did not follow a parameter (IE "filename.txt").\r
+ TypeStart, ///< A flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).\r
+ TypeDoubleValue, ///< A flag that has 2 space seperated value data following it (IE "-a 1 2").\r
+ TypeMaxValue, ///< A flag followed by all the command line data before the next flag.\r
TypeMax,\r
} ParamType;\r
\r
\r
If no initialization is required, then return RETURN_SUCCESS.\r
\r
- @param CheckList pointer to list of parameters to check\r
- @param CheckPackage Package of checked values\r
- @param ProblemParam optional pointer to pointer to unicode string for \r
+ @param[in] CheckList Pointer to list of parameters to check.\r
+ @param[out] CheckPackage Package of checked values.\r
+ @param[out] ProblemParam Optional pointer to pointer to unicode string for \r
the paramater that caused failure.\r
- @param AutoPageBreak will automatically set PageBreakEnabled\r
+ @param[in] AutoPageBreak Will automatically set PageBreakEnabled.\r
+ @param[in] AlwaysAllowNumbers Will never fail for number based flags.\r
\r
@retval EFI_SUCCESS The operation completed sucessfully.\r
- @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
- @retval EFI_INVALID_PARAMETER A parameter was invalid\r
- @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was \r
- duplicated. the duplicated command line argument \r
+ @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
+ @retval EFI_VOLUME_CORRUPTED The command line was corrupt. An argument was \r
+ duplicated. The duplicated command line argument \r
was returned in ProblemParam if provided.\r
- @retval EFI_DEVICE_ERROR the commands contained 2 opposing arguments. one\r
+ @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One\r
of the command line arguments was returned in \r
ProblemParam if provided.\r
- @retval EFI_NOT_FOUND a argument required a value that was missing. \r
- the invalid command line argument was returned in\r
+ @retval EFI_NOT_FOUND A argument required a value that was missing. \r
+ The invalid command line argument was returned in\r
ProblemParam if provided.\r
**/\r
EFI_STATUS\r
EFIAPI\r
-ShellCommandLineParse (\r
+ShellCommandLineParseEx (\r
IN CONST SHELL_PARAM_ITEM *CheckList,\r
OUT LIST_ENTRY **CheckPackage,\r
OUT CHAR16 **ProblemParam OPTIONAL,\r
- IN BOOLEAN AutoPageBreak\r
+ IN BOOLEAN AutoPageBreak,\r
+ IN BOOLEAN AlwaysAllowNumbers\r
);\r
\r
+/// Make it easy to upgrade from older versions of the shell library.\r
+#define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)\r
+\r
/**\r
Frees shell variable list that was returned from ShellCommandLineParse.\r
\r
This function will free all the memory that was used for the CheckPackage\r
list of postprocessed shell arguments.\r
\r
- this function has no return value.\r
-\r
- if CheckPackage is NULL, then return\r
+ If CheckPackage is NULL, then return.\r
\r
- @param CheckPackage the list to de-allocate\r
+ @param[in] CheckPackage The list to de-allocate.\r
**/\r
VOID\r
EFIAPI\r
);\r
\r
/**\r
- Checks for presence of a flag parameter\r
+ Checks for presence of a flag parameter.\r
\r
- flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key\r
+ Flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key.\r
\r
- if CheckPackage is NULL then return FALSE.\r
- if KeyString is NULL then ASSERT()\r
+ If CheckPackage is NULL then return FALSE.\r
+ If KeyString is NULL then ASSERT().\r
\r
- @param CheckPackage The package of parsed command line arguments\r
- @param KeyString the Key of the command line argument to check for\r
+ @param[in] CheckPackage The package of parsed command line arguments.\r
+ @param[in] KeyString The Key of the command line argument to check for.\r
\r
- @retval TRUE the flag is on the command line\r
- @retval FALSE the flag is not on the command line\r
+ @retval TRUE The flag is on the command line.\r
+ @retval FALSE The flag is not on the command line.\r
**/\r
BOOLEAN\r
EFIAPI\r
);\r
\r
/**\r
- returns value from command line argument\r
+ Returns value from command line argument.\r
\r
- value parameters are in the form of "-<Key> value" or "/<Key> value"\r
+ Value parameters are in the form of "-<Key> value" or "/<Key> value".\r
\r
- if CheckPackage is NULL, then return NULL;\r
+ If CheckPackage is NULL, then return NULL.\r
\r
- @param CheckPackage The package of parsed command line arguments\r
- @param KeyString the Key of the command line argument to check for\r
+ @param[in] CheckPackage The package of parsed command line arguments.\r
+ @param[in] KeyString The Key of the command line argument to check for.\r
\r
- @retval NULL the flag is not on the command line\r
- @return !=NULL pointer to unicode string of the value\r
+ @retval NULL The flag is not on the command line.\r
+ @retval !=NULL Pointer to unicode string of the value.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
);\r
\r
/**\r
- returns raw value from command line argument\r
+ Returns raw value from command line argument.\r
\r
- raw value parameters are in the form of "value" in a specific position in the list\r
+ Raw value parameters are in the form of "value" in a specific position in the list.\r
\r
- if CheckPackage is NULL, then return NULL;\r
+ If CheckPackage is NULL, then return NULL.\r
\r
- @param CheckPackage The package of parsed command line arguments\r
- @param Position the position of the value \r
+ @param[in] CheckPackage The package of parsed command line arguments.\r
+ @param[in] Position The position of the value.\r
\r
- @retval NULL the flag is not on the command line\r
- @return !=NULL pointer to unicode string of the value\r
+ @retval NULL The flag is not on the command line.\r
+ @retval !=NULL Pointer to unicode string of the value.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
IN UINT32 Position\r
);\r
\r
+/**\r
+ Returns the number of command line value parameters that were parsed. \r
+ \r
+ This will not include flags.\r
+\r
+ @retval (UINTN)-1 No parsing has ocurred.\r
+ @return The number of value parameters found.\r
+**/\r
+UINTN\r
+EFIAPI\r
+ShellCommandLineGetCount(\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Determins if a parameter is duplicated.\r
+\r
+ If Param is not NULL then it will point to a callee allocated string buffer \r
+ with the parameter value if a duplicate is found.\r
+\r
+ If CheckPackage is NULL, then ASSERT.\r
+\r
+ @param[in] CheckPackage The package of parsed command line arguments.\r
+ @param[out] Param Upon finding one, a pointer to the duplicated parameter.\r
+\r
+ @retval EFI_SUCCESS No parameters were duplicated.\r
+ @retval EFI_DEVICE_ERROR A duplicate was found.\r
+ **/\r
+EFI_STATUS\r
+EFIAPI\r
+ShellCommandLineCheckDuplicate (\r
+ IN CONST LIST_ENTRY *CheckPackage,\r
+ OUT CHAR16 **Param\r
+ );\r
+\r
/**\r
This function causes the shell library to initialize itself. If the shell library\r
is already initialized it will de-initialize all the current protocol poitners and\r
EFI_STATUS\r
EFIAPI\r
ShellInitialize (\r
+ VOID\r
);\r
\r
/**\r
Print at a specific location on the screen.\r
\r
- This function will move the cursor to a given screen location, print the specified string, \r
- and return the cursor to the original locaiton. \r
+ This function will move the cursor to a given screen location and print the specified string.\r
\r
If -1 is specified for either the Row or Col the current screen location for BOTH \r
- will be used and the cursor's position will not be moved back to an original location.\r
+ will be used.\r
\r
- if either Row or Col is out of range for the current console, then ASSERT\r
- if Format is NULL, then ASSERT\r
+ If either Row or Col is out of range for the current console, then ASSERT.\r
+ If Format is NULL, then ASSERT.\r
\r
In addition to the standard %-based flags as supported by UefiLib Print() this supports \r
the following additional flags:\r
\r
Note: The background color is controlled by the shell command cls.\r
\r
- @param[in] Row the row to print at\r
- @param[in] Col the column to print at\r
- @param[in] Format the format string\r
+ @param[in] Row The row to print at.\r
+ @param[in] Col The column to print at.\r
+ @param[in] Format The format string.\r
\r
- @return the number of characters printed to the screen\r
+ @return The number of characters printed to the screen.\r
**/\r
\r
UINTN\r
...\r
);\r
\r
-#endif // __SHELL_LIB__
\ No newline at end of file
+/**\r
+ Print at a specific location on the screen.\r
+\r
+ This function will move the cursor to a given screen location and print the specified string.\r
+ \r
+ If -1 is specified for either the Row or Col the current screen location for BOTH \r
+ will be used.\r
+\r
+ If either Row or Col is out of range for the current console, then ASSERT.\r
+ If Format is NULL, then ASSERT.\r
+\r
+ In addition to the standard %-based flags as supported by UefiLib Print() this supports \r
+ the following additional flags:\r
+ %N - Set output attribute to normal.\r
+ %H - Set output attribute to highlight.\r
+ %E - Set output attribute to error.\r
+ %B - Set output attribute to blue color.\r
+ %V - Set output attribute to green color.\r
+\r
+ Note: The background color is controlled by the shell command cls.\r
+\r
+ @param[in] Row The row to print at.\r
+ @param[in] Col The column to print at.\r
+ @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
+ @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
+\r
+ @return the number of characters printed to the screen.\r
+**/\r
+UINTN\r
+EFIAPI\r
+ShellPrintHiiEx(\r
+ IN INT32 Col OPTIONAL,\r
+ IN INT32 Row OPTIONAL,\r
+ IN CONST EFI_STRING_ID HiiFormatStringId,\r
+ IN CONST EFI_HANDLE HiiFormatHandle,\r
+ ...\r
+ );\r
+\r
+/**\r
+ Function to determine if a given filename represents a directory.\r
+\r
+ If DirName is NULL, then ASSERT.\r
+\r
+ @param[in] DirName Path to directory to test.\r
+\r
+ @retval EFI_SUCCESS The Path represents a directory.\r
+ @retval EFI_NOT_FOUND The Path does not represent a directory.\r
+ @retval other The path failed to open.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ShellIsDirectory(\r
+ IN CONST CHAR16 *DirName\r
+ );\r
+\r
+/**\r
+ Function to determine if a given filename represents a file.\r
+\r
+ This will search the CWD only.\r
+\r
+ If Name is NULL, then ASSERT.\r
+\r
+ @param[in] Name Path to file to test.\r
+\r
+ @retval EFI_SUCCESS The Path represents a file.\r
+ @retval EFI_NOT_FOUND The Path does not represent a file.\r
+ @retval other The path failed to open.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ShellIsFile(\r
+ IN CONST CHAR16 *Name\r
+ );\r
+\r
+/**\r
+ Function to determine if a given filename represents a file.\r
+\r
+ This will search the CWD and then the Path.\r
+\r
+ If Name is NULL, then ASSERT.\r
+\r
+ @param[in] Name Path to file to test.\r
+\r
+ @retval EFI_SUCCESS The Path represents a file.\r
+ @retval EFI_NOT_FOUND The Path does not represent a file.\r
+ @retval other The path failed to open.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ShellIsFileInPath(\r
+ IN CONST CHAR16 *Name\r
+ );\r
+\r
+/**\r
+ Function to determine whether a string is decimal or hex representation of a number \r
+ and return the number converted from the string.\r
+\r
+ @param[in] String String representation of a number\r
+\r
+ @return The unsigned integer result of the conversion.\r
+**/\r
+UINTN\r
+EFIAPI\r
+ShellStrToUintn(\r
+ IN CONST CHAR16 *String\r
+ );\r
+\r
+/**\r
+ Safely append with automatic string resizing given length of Destination and \r
+ desired length of copy from Source.\r
+\r
+ Append the first D characters of Source to the end of Destination, where D is \r
+ the lesser of Count and the StrLen() of Source. If appending those D characters \r
+ will fit within Destination (whose Size is given as CurrentSize) and \r
+ still leave room for a null terminator, then those characters are appended, \r
+ starting at the original terminating null of Destination, and a new terminating \r
+ null is appended.\r
+\r
+ If appending D characters onto Destination will result in a overflow of the size\r
+ given in CurrentSize the string will be grown such that the copy can be performed\r
+ and CurrentSize will be updated to the new size.\r
+\r
+ If Source is NULL, there is nothing to append, just return the current buffer in \r
+ Destination.\r
+\r
+ If Destination is NULL, then ASSERT().\r
+ If Destination's current length (including NULL terminator) is already more than \r
+ CurrentSize, then ASSERT().\r
+\r
+ @param[in,out] Destination The String to append onto.\r
+ @param[in,out] CurrentSize On call the number of bytes in Destination. On \r
+ return possibly the new size (still in bytes). If NULL\r
+ then allocate whatever is needed.\r
+ @param[in] Source The String to append from.\r
+ @param[in] Count Maximum number of characters to append. If 0 then \r
+ all are appended.\r
+\r
+ @return The Destination after apending the Source.\r
+**/\r
+CHAR16* \r
+EFIAPI\r
+StrnCatGrow (\r
+ IN OUT CHAR16 **Destination,\r
+ IN OUT UINTN *CurrentSize,\r
+ IN CONST CHAR16 *Source,\r
+ IN UINTN Count\r
+ );\r
+\r
+/**\r
+ This is a find and replace function. Upon successful return the NewString is a copy of \r
+ SourceString with each instance of FindTarget replaced with ReplaceWith.\r
+\r
+ If SourceString and NewString overlap the behavior is undefined.\r
+\r
+ If the string would grow bigger than NewSize it will halt and return error.\r
+\r
+ @param[in] SourceString String with source buffer.\r
+ @param[in,out] NewString String with resultant buffer.\r
+ @param[in] NewSize Size in bytes of NewString.\r
+ @param[in] FindTarget String to look for.\r
+ @param[in] ReplaceWith String to replace FindTarget with.\r
+ @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
+ immediately before it.\r
+\r
+ @retval EFI_INVALID_PARAMETER SourceString was NULL.\r
+ @retval EFI_INVALID_PARAMETER NewString was NULL.\r
+ @retval EFI_INVALID_PARAMETER FindTarget was NULL.\r
+ @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.\r
+ @retval EFI_INVALID_PARAMETER FindTarget had length < 1.\r
+ @retval EFI_INVALID_PARAMETER SourceString had length < 1.\r
+ @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold \r
+ the new string (truncation occurred).\r
+ @retval EFI_SUCCESS The string was sucessfully copied with replacement.\r
+**/\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ShellCopySearchAndReplace2(\r
+ IN CHAR16 CONST *SourceString,\r
+ IN CHAR16 *NewString,\r
+ IN UINTN NewSize,\r
+ IN CONST CHAR16 *FindTarget,\r
+ IN CONST CHAR16 *ReplaceWith,\r
+ IN CONST BOOLEAN SkipPreCarrot\r
+ );\r
+\r
+///\r
+/// make upgrades easier from old version\r
+///\r
+#define ShellLibCopySearchAndReplace(a,b,c,d,e) ShellCopySearchAndReplace2(a,b,c,d,e,FALSE)\r
+\r
+/**\r
+ Check if a Unicode character is a hexadecimal character.\r
+\r
+ This internal function checks if a Unicode character is a \r
+ decimal character. The valid hexadecimal character is \r
+ L'0' to L'9', L'a' to L'f', or L'A' to L'F'.\r
+\r
+ @param[in] Char The character to check.\r
+\r
+ @retval TRUE The Char is a hexadecmial character.\r
+ @retval FALSE The Char is not a hexadecmial character.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+ShellIsHexaDecimalDigitCharacter (\r
+ IN CHAR16 Char\r
+ );\r
+\r
+#endif // __SHELL_LIB__\r
projects / mirror_edk2.git / blobdiff