fixed license header / copyright date on all files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9810 6f19259b-4bc3-4df7-8a09-765794883524
diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.c b/ShellPkg/Library/UefiShellLib/UefiShellLib.c
index db46b80..f105176 100644
--- a/ShellPkg/Library/UefiShellLib/UefiShellLib.c
+++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.c
@@ -1,8 +1,8 @@
/** @file
Provides interface to shell functionality for shell commands and applications.
- Copyright (c) 2006 - 2010, Intel Corporation<BR>
- All rights reserved. This program and the accompanying materials
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
+ This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
@@ -40,8 +40,8 @@
/**
Check if a Unicode character is a hexadecimal character.
- This internal function checks if a Unicode character is a
- decimal character. The valid hexadecimal character is
+ This internal function checks if a Unicode character is a
+ decimal character. The valid hexadecimal character is
L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
@@ -74,7 +74,7 @@
BufferSize = 0;
Buffer = NULL;
- Status = gBS->OpenProtocol(ImageHandle,
+ Status = gBS->OpenProtocol(ImageHandle,
&gEfiShellEnvironment2Guid,
(VOID **)&mEfiShellEnvironment2,
ImageHandle,
@@ -113,7 +113,7 @@
//
Status = EFI_NOT_FOUND;
for (HandleIndex = 0; HandleIndex < (BufferSize/sizeof(Buffer[0])); HandleIndex++) {
- Status = gBS->OpenProtocol(Buffer[HandleIndex],
+ Status = gBS->OpenProtocol(Buffer[HandleIndex],
&gEfiShellEnvironment2Guid,
(VOID **)&mEfiShellEnvironment2,
ImageHandle,
@@ -156,7 +156,7 @@
//
// UEFI 2.0 shell interfaces (used preferentially)
//
- Status = gBS->OpenProtocol(ImageHandle,
+ Status = gBS->OpenProtocol(ImageHandle,
&gEfiShellProtocolGuid,
(VOID **)&mEfiShellProtocol,
ImageHandle,
@@ -166,7 +166,7 @@
if (EFI_ERROR(Status)) {
mEfiShellProtocol = NULL;
}
- Status = gBS->OpenProtocol(ImageHandle,
+ Status = gBS->OpenProtocol(ImageHandle,
&gEfiShellParametersProtocolGuid,
(VOID **)&mEfiShellParametersProtocol,
ImageHandle,
@@ -187,7 +187,7 @@
DEBUG((DEBUG_ERROR, "Status: 0x%08x\r\n", Status));
mEfiShellEnvironment2 = NULL;
}
- Status = gBS->OpenProtocol(ImageHandle,
+ Status = gBS->OpenProtocol(ImageHandle,
&gEfiShellInterfaceGuid,
(VOID **)&mEfiShellInterface,
ImageHandle,
@@ -201,7 +201,7 @@
//
// only success getting 2 of either the old or new, but no 1/2 and 1/2
//
- if ((mEfiShellEnvironment2 != NULL && mEfiShellInterface != NULL) ||
+ if ((mEfiShellEnvironment2 != NULL && mEfiShellInterface != NULL) ||
(mEfiShellProtocol != NULL && mEfiShellParametersProtocol != NULL) ) {
if (mEfiShellProtocol != NULL) {
FileFunctionMap.GetFileInfo = mEfiShellProtocol->GetFileInfo;
@@ -259,11 +259,11 @@
//
// verify that auto initialize is not set false
- //
+ //
if (PcdGetBool(PcdShellLibAutoInitialize) == 0) {
return (EFI_SUCCESS);
}
-
+
return (ShellLibConstructorWorker(ImageHandle, SystemTable));
}
@@ -287,21 +287,21 @@
gBS->CloseProtocol(ImageHandle,
&gEfiShellInterfaceGuid,
ImageHandle,
- NULL);
+ NULL);
mEfiShellInterface = NULL;
}
if (mEfiShellProtocol != NULL) {
gBS->CloseProtocol(ImageHandle,
&gEfiShellProtocolGuid,
ImageHandle,
- NULL);
+ NULL);
mEfiShellProtocol = NULL;
}
if (mEfiShellParametersProtocol != NULL) {
gBS->CloseProtocol(ImageHandle,
&gEfiShellParametersProtocolGuid,
ImageHandle,
- NULL);
+ NULL);
mEfiShellParametersProtocol = NULL;
}
mEfiShellEnvironment2Handle = NULL;
@@ -354,13 +354,13 @@
}
/**
- This function will retrieve the information about the file for the handle
+ This function will retrieve the information about the file for the handle
specified and store it in allocated pool memory.
- This function allocates a buffer to store the file's information. It is the
+ This function allocates a buffer to store the file's information. It is the
caller's responsibility to free the buffer
- @param FileHandle The file handle of the file for which information is
+ @param FileHandle The file handle of the file for which information is
being requested.
@retval NULL information could not be retrieved.
@@ -376,10 +376,10 @@
}
/**
- This function will set the information about the file for the opened handle
+ This function will set the information about the file for the opened handle
specified.
- @param FileHandle The file handle of the file for which information
+ @param FileHandle The file handle of the file for which information
is being set
@param FileInfo The infotmation to set.
@@ -400,15 +400,15 @@
IN EFI_FILE_INFO *FileInfo
) {
return (FileFunctionMap.SetFileInfo(FileHandle, FileInfo));
-}
-
+}
+
/**
This function will open a file or directory referenced by DevicePath.
- This function opens a file with the open mode according to the file path. The
+ This function opens a file with the open mode according to the file path. The
Attributes is valid only for EFI_FILE_MODE_CREATE.
- @param FilePath on input the device path to the file. On output
+ @param FilePath on input the device path to the file. On output
the remaining device path.
@param DeviceHandle pointer to the system device handle.
@param FileHandle pointer to the file handle.
@@ -417,18 +417,18 @@
@retval EFI_SUCCESS The information was set.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
- @retval EFI_UNSUPPORTED Could not open the file path.
- @retval EFI_NOT_FOUND The specified file could not be found on the
- device or the file system could not be found on
+ @retval EFI_UNSUPPORTED Could not open the file path.
+ @retval EFI_NOT_FOUND The specified file could not be found on the
+ device or the file system could not be found on
the device.
@retval EFI_NO_MEDIA The device has no medium.
- @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
+ @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
medium is no longer supported.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The file or medium is write protected.
@retval EFI_ACCESS_DENIED The file was opened read only.
- @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
+ @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
file.
@retval EFI_VOLUME_FULL The volume is full.
**/
@@ -452,7 +452,7 @@
ASSERT(FilePath != NULL);
ASSERT(FileHandle != NULL);
ASSERT(DeviceHandle != NULL);
- //
+ //
// which shell interface should we use
//
if (mEfiShellProtocol != NULL) {
@@ -466,14 +466,14 @@
Status = ShellOpenFileByName(FileName, FileHandle, OpenMode, Attributes);
FreePool(FileName);
return (Status);
- }
+ }
//
// use old shell method.
//
- Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid,
- FilePath,
+ Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid,
+ FilePath,
DeviceHandle);
if (EFI_ERROR (Status)) {
return Status;
@@ -555,8 +555,8 @@
/**
This function will open a file or directory referenced by filename.
- If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
- otherwise, the Filehandle is NULL. The Attributes is valid only for
+ If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
+ otherwise, the Filehandle is NULL. The Attributes is valid only for
EFI_FILE_MODE_CREATE.
if FileNAme is NULL then ASSERT()
@@ -568,18 +568,18 @@
@retval EFI_SUCCESS The information was set.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
- @retval EFI_UNSUPPORTED Could not open the file path.
- @retval EFI_NOT_FOUND The specified file could not be found on the
- device or the file system could not be found
+ @retval EFI_UNSUPPORTED Could not open the file path.
+ @retval EFI_NOT_FOUND The specified file could not be found on the
+ device or the file system could not be found
on the device.
@retval EFI_NO_MEDIA The device has no medium.
- @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
+ @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
medium is no longer supported.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The file or medium is write protected.
@retval EFI_ACCESS_DENIED The file was opened read only.
- @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
+ @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
file.
@retval EFI_VOLUME_FULL The volume is full.
**/
@@ -616,7 +616,7 @@
FreePool(FileInfo);
}
return (Status);
- }
+ }
//
// Using EFI Shell version
// this means convert name to path and call that function
@@ -636,8 +636,8 @@
/**
This function create a directory
- If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
- otherwise, the Filehandle is NULL. If the directory already existed, this
+ If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
+ otherwise, the Filehandle is NULL. If the directory already existed, this
function opens the existing directory.
@param DirectoryName pointer to directory name
@@ -645,18 +645,18 @@
@retval EFI_SUCCESS The information was set.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
- @retval EFI_UNSUPPORTED Could not open the file path.
- @retval EFI_NOT_FOUND The specified file could not be found on the
- device or the file system could not be found
+ @retval EFI_UNSUPPORTED Could not open the file path.
+ @retval EFI_NOT_FOUND The specified file could not be found on the
+ device or the file system could not be found
on the device.
@retval EFI_NO_MEDIA The device has no medium.
- @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
+ @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
medium is no longer supported.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
@retval EFI_WRITE_PROTECTED The file or medium is write protected.
@retval EFI_ACCESS_DENIED The file was opened read only.
- @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
+ @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
file.
@retval EFI_VOLUME_FULL The volume is full.
@sa ShellOpenFileByName
@@ -687,21 +687,21 @@
/**
This function reads information from an opened file.
- If FileHandle is not a directory, the function reads the requested number of
- bytes from the file at the file's current position and returns them in Buffer.
+ If FileHandle is not a directory, the function reads the requested number of
+ bytes from the file at the file's current position and returns them in Buffer.
If the read goes beyond the end of the file, the read length is truncated to the
- end of the file. The file's current position is increased by the number of bytes
- returned. If FileHandle is a directory, the function reads the directory entry
- at the file's current position and returns the entry in Buffer. If the Buffer
- is not large enough to hold the current directory entry, then
- EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
- BufferSize is set to be the size of the buffer needed to read the entry. On
- success, the current position is updated to the next directory entry. If there
- are no more directory entries, the read returns a zero-length buffer.
+ end of the file. The file's current position is increased by the number of bytes
+ returned. If FileHandle is a directory, the function reads the directory entry
+ at the file's current position and returns the entry in Buffer. If the Buffer
+ is not large enough to hold the current directory entry, then
+ EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
+ BufferSize is set to be the size of the buffer needed to read the entry. On
+ success, the current position is updated to the next directory entry. If there
+ are no more directory entries, the read returns a zero-length buffer.
EFI_FILE_INFO is the structure returned as the directory entry.
@param FileHandle the opened file handle
- @param BufferSize on input the size of buffer in bytes. on return
+ @param BufferSize on input the size of buffer in bytes. on return
the number of bytes written.
@param Buffer the buffer to put read data into.
@@ -709,7 +709,7 @@
@retval EFI_NO_MEDIA The device has no media.
@retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
- @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
+ @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
size.
**/
@@ -727,11 +727,11 @@
/**
Write data to a file.
- This function writes the specified number of bytes to the file at the current
- file position. The current file position is advanced the actual number of bytes
- written, which is returned in BufferSize. Partial writes only occur when there
- has been a data error during the write attempt (such as "volume space full").
- The file is automatically grown to hold the data if required. Direct writes to
+ This function writes the specified number of bytes to the file at the current
+ file position. The current file position is advanced the actual number of bytes
+ written, which is returned in BufferSize. Partial writes only occur when there
+ has been a data error during the write attempt (such as "volume space full").
+ The file is automatically grown to hold the data if required. Direct writes to
opened directories are not supported.
@param FileHandle The opened file for writing
@@ -758,11 +758,11 @@
return (FileFunctionMap.WriteFile(FileHandle, BufferSize, Buffer));
}
-/**
+/**
Close an open file handle.
- This function closes a specified file handle. All "dirty" cached file data is
- flushed to the device, and the file is closed. In all cases the handle is
+ This function closes a specified file handle. All "dirty" cached file data is
+ flushed to the device, and the file is closed. In all cases the handle is
closed.
@param FileHandle the file handle to close.
@@ -781,13 +781,13 @@
Delete a file and close the handle
This function closes and deletes a file. In all cases the file handle is closed.
- If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
+ If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
returned, but the handle is still closed.
@param FileHandle the file handle to delete
@retval EFI_SUCCESS the file was closed sucessfully
- @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
+ @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
deleted
@retval INVALID_PARAMETER One of the parameters has an invalid value.
**/
@@ -802,19 +802,19 @@
/**
Set the current position in a file.
- This function sets the current file position for the handle to the position
+ This function sets the current file position for the handle to the position
supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
- absolute positioning is supported, and seeking past the end of the file is
- allowed (a subsequent write would grow the file). Seeking to position
+ absolute positioning is supported, and seeking past the end of the file is
+ allowed (a subsequent write would grow the file). Seeking to position
0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
- If FileHandle is a directory, the only position that may be set is zero. This
+ If FileHandle is a directory, the only position that may be set is zero. This
has the effect of starting the read process of the directory entries over.
@param FileHandle The file handle on which the position is being set
@param Position Byte position from begining of file
@retval EFI_SUCCESS Operation completed sucessfully.
- @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
+ @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
directories.
@retval INVALID_PARAMETER One of the parameters has an invalid value.
**/
@@ -827,11 +827,11 @@
return (FileFunctionMap.SetFilePosition(FileHandle, Position));
}
-/**
+/**
Gets a file's current position
- This function retrieves the current file position for the file handle. For
- directories, the current file position has no meaning outside of the file
+ This function retrieves the current file position for the file handle. For
+ directories, the current file position has no meaning outside of the file
system driver and as such the operation is not supported. An error is returned
if FileHandle is a directory.
@@ -852,7 +852,7 @@
}
/**
Flushes data on a file
-
+
This function flushes all modified data associated with a file to a device.
@param FileHandle The file handle on which to flush data
@@ -875,8 +875,8 @@
/**
Retrieves the first file from a directory
- This function opens a directory and gets the first file's info in the
- directory. Caller can use ShellFindNextFile() to get other files. When
+ This function opens a directory and gets the first file's info in the
+ directory. Caller can use ShellFindNextFile() to get other files. When
complete the caller is responsible for calling FreePool() on Buffer.
@param DirHandle The file handle of the directory to search
@@ -904,12 +904,12 @@
/**
Retrieves the next file in a directory.
- To use this function, caller must call the LibFindFirstFile() to get the
- first file, and then use this function get other files. This function can be
- called for several times to get each file's information in the directory. If
- the call of ShellFindNextFile() got the last file in the directory, the next
- call of this function has no file to get. *NoFile will be set to TRUE and the
- Buffer memory will be automatically freed.
+ To use this function, caller must call the LibFindFirstFile() to get the
+ first file, and then use this function get other files. This function can be
+ called for several times to get each file's information in the directory. If
+ the call of ShellFindNextFile() got the last file in the directory, the next
+ call of this function has no file to get. *NoFile will be set to TRUE and the
+ Buffer memory will be automatically freed.
@param DirHandle the file handle of the directory
@param Buffer pointer to buffer for file's information
@@ -938,7 +938,7 @@
if FileHandle is NULL then ASSERT()
if Size is NULL then ASSERT()
- This function extracts the file size info from the FileHandle's EFI_FILE_INFO
+ This function extracts the file size info from the FileHandle's EFI_FILE_INFO
data.
@param FileHandle file handle from which size is retrieved
@@ -969,7 +969,7 @@
VOID
)
{
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
@@ -981,7 +981,7 @@
return (FALSE);
}
return (TRUE);
- }
+ }
//
// using EFI Shell; call the function to check
@@ -992,7 +992,7 @@
/**
return the value of an environment variable
- this function gets the value of the environment variable set by the
+ this function gets the value of the environment variable set by the
ShellSetEnvironmentVariable function
@param EnvKey The key name of the environment variable.
@@ -1006,7 +1006,7 @@
IN CONST CHAR16 *EnvKey
)
{
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
@@ -1051,12 +1051,12 @@
IN BOOLEAN Volatile
)
{
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
return (mEfiShellProtocol->SetEnv(EnvKey, EnvVal, Volatile));
- }
+ }
//
// This feature does not exist under EFI shell
@@ -1079,7 +1079,7 @@
Output is only supported for pre-UEFI Shell 2.0
@param ImageHandle Parent image that is starting the operation
- @param CommandLine pointer to null terminated command line.
+ @param CommandLine pointer to NULL terminated command line.
@param Output true to display debug output. false to hide it.
@param EnvironmentVariables optional pointer to array of environment variables
in the form "x=y". if NULL current set is used.
@@ -1101,7 +1101,7 @@
OUT EFI_STATUS *Status OPTIONAL
)
{
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
@@ -1112,7 +1112,7 @@
CommandLine,
EnvironmentVariables,
Status));
- }
+ }
//
// ASSERT that we must have EFI shell
//
@@ -1121,15 +1121,15 @@
// Call EFI Shell version (not using EnvironmentVariables or Status parameters)
// Due to oddity in the EFI shell we want to dereference the ParentHandle here
//
- return (mEfiShellEnvironment2->Execute(*ParentHandle,
- CommandLine,
+ return (mEfiShellEnvironment2->Execute(*ParentHandle,
+ CommandLine,
Output));
}
/**
Retreives the current directory path
- If the DeviceName is NULL, it returns the current device's current directory
- name. If the DeviceName is not NULL, it returns the current directory name
+ If the DeviceName is NULL, it returns the current device's current directory
+ name. If the DeviceName is not NULL, it returns the current directory name
on specified drive.
@param DeviceName the name of the drive to get directory on
@@ -1143,12 +1143,12 @@
IN CHAR16 *DeviceName OPTIONAL
)
{
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
return (mEfiShellProtocol->GetCurDir(DeviceName));
- }
+ }
//
// ASSERT that we must have EFI shell
//
@@ -1158,12 +1158,12 @@
/**
sets (enabled or disabled) the page break mode
- when page break mode is enabled the screen will stop scrolling
+ when page break mode is enabled the screen will stop scrolling
and wait for operator input before scrolling a subsequent screen.
@param CurrentState TRUE to enable and FALSE to disable
**/
-VOID
+VOID
EFIAPI
ShellSetPageBreakMode (
IN BOOLEAN CurrentState
@@ -1173,7 +1173,7 @@
// check for enabling
//
if (CurrentState != 0x00) {
- //
+ //
// check for UEFI Shell 2.0
//
if (mEfiShellProtocol != NULL) {
@@ -1183,7 +1183,7 @@
mEfiShellProtocol->EnablePageBreak();
return;
} else {
- //
+ //
// ASSERT that must have EFI Shell
//
ASSERT(mEfiShellEnvironment2 != NULL);
@@ -1194,7 +1194,7 @@
return;
}
} else {
- //
+ //
// check for UEFI Shell 2.0
//
if (mEfiShellProtocol != NULL) {
@@ -1204,7 +1204,7 @@
mEfiShellProtocol->DisablePageBreak();
return;
} else {
- //
+ //
// ASSERT that must have EFI Shell
//
ASSERT(mEfiShellEnvironment2 != NULL);
@@ -1235,7 +1235,7 @@
if OldStyleFileList is NULL then ASSERT()
- this function will convert a SHELL_FILE_ARG based list into a callee allocated
+ this function will convert a SHELL_FILE_ARG based list into a callee allocated
EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
the ShellCloseFileMetaArg function.
@@ -1270,7 +1270,7 @@
//
// make sure the old list was valid
//
- ASSERT(OldInfo != NULL);
+ ASSERT(OldInfo != NULL);
ASSERT(OldInfo->Info != NULL);
ASSERT(OldInfo->FullName != NULL);
ASSERT(OldInfo->FileName != NULL);
@@ -1279,8 +1279,8 @@
// allocate a new EFI_SHELL_FILE_INFO object
//
NewInfo = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
-
- //
+
+ //
// copy the simple items
//
NewInfo->Handle = OldInfo->Handle;
@@ -1295,7 +1295,7 @@
NewInfo->FullName = AllocateZeroPool(StrSize(OldInfo->FullName));
NewInfo->FileName = AllocateZeroPool(StrSize(OldInfo->FileName));
NewInfo->Info = AllocateZeroPool((UINTN)OldInfo->Info->Size);
-
+
//
// make sure all the memory allocations were sucessful
//
@@ -1320,21 +1320,21 @@
/**
Opens a group of files based on a path.
- This function uses the Arg to open all the matching files. Each matched
- file has a SHELL_FILE_ARG structure to record the file information. These
- structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
+ This function uses the Arg to open all the matching files. Each matched
+ file has a SHELL_FILE_ARG structure to record the file information. These
+ structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
structures from ListHead to access each file. This function supports wildcards
- and will process '?' and '*' as such. the list must be freed with a call to
+ and will process '?' and '*' as such. the list must be freed with a call to
ShellCloseFileMetaArg().
- If you are NOT appending to an existing list *ListHead must be NULL. If
+ If you are NOT appending to an existing list *ListHead must be NULL. If
*ListHead is NULL then it must be callee freed.
@param Arg pointer to path string
@param OpenMode mode to open files with
@param ListHead head of linked list of results
- @retval EFI_SUCCESS the operation was sucessful and the list head
+ @retval EFI_SUCCESS the operation was sucessful and the list head
contains the list of opened files
#retval EFI_UNSUPPORTED a previous ShellOpenFileMetaArg must be closed first.
*ListHead is set to NULL.
@@ -1352,14 +1352,14 @@
{
EFI_STATUS Status;
LIST_ENTRY mOldStyleFileList;
-
+
//
// ASSERT that Arg and ListHead are not NULL
//
ASSERT(Arg != NULL);
ASSERT(ListHead != NULL);
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
@@ -1369,9 +1369,9 @@
return (EFI_OUT_OF_RESOURCES);
}
InitializeListHead(&((*ListHead)->Link));
- }
- Status = mEfiShellProtocol->OpenFileList(Arg,
- OpenMode,
+ }
+ Status = mEfiShellProtocol->OpenFileList(Arg,
+ OpenMode,
ListHead);
if (EFI_ERROR(Status)) {
mEfiShellProtocol->RemoveDupInFileList(ListHead);
@@ -1379,7 +1379,7 @@
Status = mEfiShellProtocol->RemoveDupInFileList(ListHead);
}
return (Status);
- }
+ }
//
// ASSERT that we must have EFI shell
@@ -1441,18 +1441,18 @@
//
ASSERT(ListHead != NULL);
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellProtocol != NULL) {
return (mEfiShellProtocol->FreeFileList(ListHead));
} else {
//
- // Since this is EFI Shell version we need to free our internally made copy
+ // Since this is EFI Shell version we need to free our internally made copy
// of the list
//
- for ( Node = GetFirstNode(&(*ListHead)->Link)
- ; IsListEmpty(&(*ListHead)->Link) == FALSE
+ for ( Node = GetFirstNode(&(*ListHead)->Link)
+ ; IsListEmpty(&(*ListHead)->Link) == FALSE
; Node = GetFirstNode(&(*ListHead)->Link)) {
RemoveEntryList(Node);
((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle->Close(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle);
@@ -1514,7 +1514,7 @@
Size = StrSize(Path);
Size += StrSize(FileName);
TestPath = AllocateZeroPool(Size);
- Walker = (CHAR16*)Path;
+ Walker = (CHAR16*)Path;
do {
CopyMem(TestPath, Walker, StrSize(Walker));
if (StrStr(TestPath, L";") != NULL) {
@@ -1539,8 +1539,8 @@
}
/**
- Find a file by searching the CWD and then the path with a variable set of file
- extensions. If the file is not found it will append each extension in the list
+ Find a file by searching the CWD and then the path with a variable set of file
+ extensions. If the file is not found it will append each extension in the list
in the order provided and return the first one that is successful.
If FileName is NULL, then ASSERT.
@@ -1606,9 +1606,9 @@
} SHELL_PARAM_PACKAGE;
/**
- Checks the list of valid arguments and returns TRUE if the item was found. If the
+ Checks the list of valid arguments and returns TRUE if the item was found. If the
return value is TRUE then the type parameter is set also.
-
+
if CheckList is NULL then ASSERT();
if Name is NULL then ASSERT();
if Type is NULL then ASSERT();
@@ -1694,7 +1694,7 @@
//
// If the Name has a / or - as the first character return TRUE
//
- if ((Name[0] == L'/') ||
+ if ((Name[0] == L'/') ||
(Name[0] == L'-') ||
(Name[0] == L'+')
) {
@@ -1704,13 +1704,13 @@
}
/**
- Checks the command line arguments passed against the list of valid ones.
+ Checks the command line arguments passed against the list of valid ones.
If no initialization is required, then return RETURN_SUCCESS.
-
+
@param CheckList pointer to list of parameters to check
@param CheckPackage pointer to pointer to list checked values
- @param ProblemParam optional pointer to pointer to unicode string for
+ @param ProblemParam optional pointer to pointer to unicode string for
the paramater that caused failure. If used then the
caller is responsible for freeing the memory.
@param AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
@@ -1720,10 +1720,10 @@
@retval EFI_SUCCESS The operation completed sucessfully.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed
@retval EFI_INVALID_PARAMETER A parameter was invalid
- @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
- duplicated. the duplicated command line argument
+ @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
+ duplicated. the duplicated command line argument
was returned in ProblemParam if provided.
- @retval EFI_NOT_FOUND a argument required a value that was missing.
+ @retval EFI_NOT_FOUND a argument required a value that was missing.
the invalid command line argument was returned in
ProblemParam if provided.
**/
@@ -1804,9 +1804,9 @@
switch (CurrentItemPackage->Type) {
//
// possibly trigger the next loop(s) to populate the value of this item
- //
+ //
case TypeValue:
- GetItemValue = 1;
+ GetItemValue = 1;
ValueSize = 0;
break;
case TypeDoubleValue:
@@ -1886,27 +1886,27 @@
}
/**
- Checks the command line arguments passed against the list of valid ones.
+ Checks the command line arguments passed against the list of valid ones.
Optionally removes NULL values first.
-
+
If no initialization is required, then return RETURN_SUCCESS.
-
+
@param CheckList pointer to list of parameters to check
@param CheckPackage pointer to pointer to list checked values
- @param ProblemParam optional pointer to pointer to unicode string for
+ @param ProblemParam optional pointer to pointer to unicode string for
the paramater that caused failure.
@param AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
@retval EFI_SUCCESS The operation completed sucessfully.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed
@retval EFI_INVALID_PARAMETER A parameter was invalid
- @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
- duplicated. the duplicated command line argument
+ @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
+ duplicated. the duplicated command line argument
was returned in ProblemParam if provided.
@retval EFI_DEVICE_ERROR the commands contained 2 opposing arguments. one
- of the command line arguments was returned in
+ of the command line arguments was returned in
ProblemParam if provided.
- @retval EFI_NOT_FOUND a argument required a value that was missing.
+ @retval EFI_NOT_FOUND a argument required a value that was missing.
the invalid command line argument was returned in
ProblemParam if provided.
**/
@@ -1919,33 +1919,33 @@
IN BOOLEAN AutoPageBreak,
IN BOOLEAN AlwaysAllowNumbers
) {
- //
+ //
// ASSERT that CheckList and CheckPackage aren't NULL
//
ASSERT(CheckList != NULL);
ASSERT(CheckPackage != NULL);
- //
+ //
// Check for UEFI Shell 2.0 protocols
//
if (mEfiShellParametersProtocol != NULL) {
- return (InternalCommandLineParse(CheckList,
- CheckPackage,
- ProblemParam,
- AutoPageBreak,
+ return (InternalCommandLineParse(CheckList,
+ CheckPackage,
+ ProblemParam,
+ AutoPageBreak,
(CONST CHAR16**) mEfiShellParametersProtocol->Argv,
mEfiShellParametersProtocol->Argc,
AlwaysAllowNumbers));
}
- //
+ //
// ASSERT That EFI Shell is not required
//
ASSERT (mEfiShellInterface != NULL);
- return (InternalCommandLineParse(CheckList,
- CheckPackage,
- ProblemParam,
- AutoPageBreak,
+ return (InternalCommandLineParse(CheckList,
+ CheckPackage,
+ ProblemParam,
+ AutoPageBreak,
(CONST CHAR16**) mEfiShellInterface->Argv,
mEfiShellInterface->Argc,
AlwaysAllowNumbers));
@@ -2002,7 +2002,7 @@
if (((SHELL_PARAM_PACKAGE*)Node)->Value != NULL) {
FreePool(((SHELL_PARAM_PACKAGE*)Node)->Value);
}
-
+
//
// free the node structure
//
@@ -2020,7 +2020,7 @@
if CheckPackage is NULL then return FALSE.
if KeyString is NULL then ASSERT()
-
+
@param CheckPackage The package of parsed command line arguments
@param KeyString the Key of the command line argument to check for
@@ -2050,9 +2050,9 @@
//
// enumerate through the list of parametrs
//
- for ( Node = GetFirstNode(CheckPackage)
- ; !IsNull (CheckPackage, Node)
- ; Node = GetNextNode(CheckPackage, Node)
+ for ( Node = GetFirstNode(CheckPackage)
+ ; !IsNull (CheckPackage, Node)
+ ; Node = GetNextNode(CheckPackage, Node)
){
//
// If the Name matches, return TRUE (and there may be NULL name)
@@ -2061,7 +2061,7 @@
//
// If Type is TypeStart then only compare the begining of the strings
//
- if ( ((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart
+ if ( ((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart
&& StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0
){
return (TRUE);
@@ -2076,7 +2076,7 @@
returns value from command line argument
value parameters are in the form of "-<Key> value" or "/<Key> value"
-
+
if CheckPackage is NULL, then return NULL;
@param CheckPackage The package of parsed command line arguments
@@ -2103,9 +2103,9 @@
//
// enumerate through the list of parametrs
//
- for ( Node = GetFirstNode(CheckPackage)
- ; !IsNull (CheckPackage, Node)
- ; Node = GetNextNode(CheckPackage, Node)
+ for ( Node = GetFirstNode(CheckPackage)
+ ; !IsNull (CheckPackage, Node)
+ ; Node = GetNextNode(CheckPackage, Node)
){
//
// If the Name matches, return the value (name can be NULL)
@@ -2114,7 +2114,7 @@
//
// If Type is TypeStart then only compare the begining of the strings
//
- if ( ((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart
+ if ( ((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart
&& StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0
){
//
@@ -2135,11 +2135,11 @@
returns raw value from command line argument
raw value parameters are in the form of "value" in a specific position in the list
-
+
if CheckPackage is NULL, then return NULL;
@param CheckPackage The package of parsed command line arguments
- @param Position the position of the value
+ @param Position the position of the value
@retval NULL the flag is not on the command line
@return !=NULL pointer to unicode string of the value
@@ -2162,9 +2162,9 @@
//
// enumerate through the list of parametrs
//
- for ( Node = GetFirstNode(CheckPackage)
- ; !IsNull (CheckPackage, Node)
- ; Node = GetNextNode(CheckPackage, Node)
+ for ( Node = GetFirstNode(CheckPackage)
+ ; !IsNull (CheckPackage, Node)
+ ; Node = GetNextNode(CheckPackage, Node)
){
//
// If the position matches, return the value
@@ -2177,8 +2177,8 @@
}
/**
- returns the number of command line value parameters that were parsed.
-
+ returns the number of command line value parameters that were parsed.
+
this will not include flags.
@retval (UINTN)-1 No parsing has ocurred
@@ -2196,7 +2196,7 @@
/**
Determins if a parameter is duplicated.
- If Param is not NULL then it will point to a callee allocated string buffer
+ If Param is not NULL then it will point to a callee allocated string buffer
with the parameter value if a duplicate is found.
If CheckPackage is NULL, then ASSERT.
@@ -2216,16 +2216,16 @@
{
LIST_ENTRY *Node1;
LIST_ENTRY *Node2;
-
+
ASSERT(CheckPackage != NULL);
- for ( Node1 = GetFirstNode(CheckPackage)
- ; !IsNull (CheckPackage, Node1)
- ; Node1 = GetNextNode(CheckPackage, Node1)
+ for ( Node1 = GetFirstNode(CheckPackage)
+ ; !IsNull (CheckPackage, Node1)
+ ; Node1 = GetNextNode(CheckPackage, Node1)
){
- for ( Node2 = GetNextNode(CheckPackage, Node1)
- ; !IsNull (CheckPackage, Node2)
- ; Node2 = GetNextNode(CheckPackage, Node2)
+ for ( Node2 = GetNextNode(CheckPackage, Node1)
+ ; !IsNull (CheckPackage, Node2)
+ ; Node2 = GetNextNode(CheckPackage, Node2)
){
if (StrCmp(((SHELL_PARAM_PACKAGE*)Node1)->Name, ((SHELL_PARAM_PACKAGE*)Node2)->Name) == 0) {
if (Param != NULL) {
@@ -2240,7 +2240,7 @@
}
/**
- This is a find and replace function. Upon successful return the NewString is a copy of
+ This is a find and replace function. Upon successful return the NewString is a copy of
SourceString with each instance of FindTarget replaced with ReplaceWith.
If SourceString and NewString overlap the behavior is undefined.
@@ -2261,7 +2261,7 @@
@retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
@retval EFI_INVALID_PARAMETER FindTarget had length < 1.
@retval EFI_INVALID_PARAMETER SourceString had length < 1.
- @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
+ @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
the new string (truncation occurred).
@retval EFI_SUCCESS the string was sucessfully copied with replacement.
**/
@@ -2275,7 +2275,7 @@
IN CONST CHAR16 *FindTarget,
IN CONST CHAR16 *ReplaceWith,
IN CONST BOOLEAN SkipPreCarrot
- )
+ )
{
UINTN Size;
if ( (SourceString == NULL)
@@ -2290,10 +2290,10 @@
NewString = SetMem16(NewString, NewSize, CHAR_NULL);
while (*SourceString != CHAR_NULL) {
//
- // if we find the FindTarget and either Skip == FALSE or Skip == TRUE and we
+ // if we find the FindTarget and either Skip == FALSE or Skip == TRUE and we
// dont have a carrot do a replace...
//
- if (StrnCmp(SourceString, FindTarget, StrLen(FindTarget)) == 0
+ if (StrnCmp(SourceString, FindTarget, StrLen(FindTarget)) == 0
&& ((SkipPreCarrot && *(SourceString-1) != L'^') || SkipPreCarrot == FALSE)
){
SourceString += StrLen(FindTarget);
@@ -2350,14 +2350,14 @@
Print at a specific location on the screen.
This function will move the cursor to a given screen location and print the specified string
-
- If -1 is specified for either the Row or Col the current screen location for BOTH
+
+ If -1 is specified for either the Row or Col the current screen location for BOTH
will be used.
if either Row or Col is out of range for the current console, then ASSERT
if Format is NULL, then ASSERT
- In addition to the standard %-based flags as supported by UefiLib Print() this supports
+ In addition to the standard %-based flags as supported by UefiLib Print() this supports
the following additional flags:
%N - Set output attribute to normal
%H - Set output attribute to highlight
@@ -2382,14 +2382,14 @@
IN INT32 Row OPTIONAL,
IN CONST CHAR16 *Format,
VA_LIST Marker
- )
+ )
{
UINTN Return;
EFI_STATUS Status;
UINTN NormalAttribute;
CHAR16 *ResumeLocation;
CHAR16 *FormatWalker;
-
+
//
// Back and forth each time fixing up 1 of our flags...
//
@@ -2479,14 +2479,14 @@
Print at a specific location on the screen.
This function will move the cursor to a given screen location and print the specified string.
-
- If -1 is specified for either the Row or Col the current screen location for BOTH
+
+ If -1 is specified for either the Row or Col the current screen location for BOTH
will be used.
If either Row or Col is out of range for the current console, then ASSERT.
If Format is NULL, then ASSERT.
- In addition to the standard %-based flags as supported by UefiLib Print() this supports
+ In addition to the standard %-based flags as supported by UefiLib Print() this supports
the following additional flags:
%N - Set output attribute to normal
%H - Set output attribute to highlight
@@ -2510,7 +2510,7 @@
IN INT32 Row OPTIONAL,
IN CONST CHAR16 *Format,
...
- )
+ )
{
VA_LIST Marker;
EFI_STATUS Status;
@@ -2524,35 +2524,38 @@
Print at a specific location on the screen.
This function will move the cursor to a given screen location and print the specified string.
-
- If -1 is specified for either the Row or Col the current screen location for BOTH
+
+ If -1 is specified for either the Row or Col the current screen location for BOTH
will be used.
If either Row or Col is out of range for the current console, then ASSERT.
If Format is NULL, then ASSERT.
- In addition to the standard %-based flags as supported by UefiLib Print() this supports
+ In addition to the standard %-based flags as supported by UefiLib Print() this supports
the following additional flags:
- %N - Set output attribute to normal
- %H - Set output attribute to highlight
- %E - Set output attribute to error
- %B - Set output attribute to blue color
- %V - Set output attribute to green color
+ %N - Set output attribute to normal.
+ %H - Set output attribute to highlight.
+ %E - Set output attribute to error.
+ %B - Set output attribute to blue color.
+ %V - Set output attribute to green color.
Note: The background color is controlled by the shell command cls.
- @param[in] Row the row to print at
- @param[in] Col the column to print at
- @param[in] HiiFormatStringId the format string Id for getting from Hii
- @param[in] HiiFormatHandle the format string Handle for getting from Hii
+ @param[in] Row The row to print at.
+ @param[in] Col The column to print at.
+ @param[in] Language The language of the string to retrieve. If this parameter
+ is NULL, then the current platform language is used.
+ @param[in] HiiFormatStringId The format string Id for getting from Hii.
+ @param[in] HiiFormatHandle The format string Handle for getting from Hii.
- @return the number of characters printed to the screen
+ @return the number of characters printed to the screen.
**/
UINTN
EFIAPI
ShellPrintHiiEx(
IN INT32 Col OPTIONAL,
IN INT32 Row OPTIONAL,
+ IN CONST CHAR8 *Language OPTIONAL,
IN CONST EFI_STRING_ID HiiFormatStringId,
IN CONST EFI_HANDLE HiiFormatHandle,
...
@@ -2563,7 +2566,7 @@
UINTN RetVal;
VA_START (Marker, HiiFormatHandle);
- HiiFormatString = HiiGetString(HiiFormatHandle, HiiFormatStringId, NULL);
+ HiiFormatString = HiiGetString(HiiFormatHandle, HiiFormatStringId, Language);
ASSERT(HiiFormatString != NULL);
RetVal = InternalShellPrintWorker(Col, Row, HiiFormatString, Marker);
@@ -2678,7 +2681,7 @@
return (Status);
}
/**
- Function to determine whether a string is decimal or hex representation of a number
+ Function to determine whether a string is decimal or hex representation of a number
and return the number converted from the string.
@param[in] String String representation of a number
@@ -2706,9 +2709,9 @@
append the first D characters of Source to the end of Destination, where D is
the lesser of Count and the StrLen() of Source. If appending those D characters
will fit within Destination (whose Size is given as CurrentSize) and
- still leave room for a null terminator, then those characters are appended,
- starting at the original terminating null of Destination, and a new terminating
- null is appended.
+ still leave room for a NULL terminator, then those characters are appended,
+ starting at the original terminating NULL of Destination, and a new terminating
+ NULL is appended.
If appending D characters onto Destination will result in a overflow of the size
given in CurrentSize the string will be grown such that the copy can be performed