/** @file\r
Provides interface to shell internal functions for shell commands.\r
\r
- Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
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
/// The tag for use in identifying UNICODE files.\r
/// If the file is UNICODE, the first 16 bits of the file will equal this value.\r
enum {\r
- UnicodeFileTag = 0xFEFF\r
+ gUnicodeFileTag = 0xFEFF\r
};\r
\r
// STATIC local variables\r
STATIC ALIAS_LIST mAliasList;\r
STATIC BOOLEAN mEchoState;\r
STATIC BOOLEAN mExitRequested;\r
+STATIC UINT64 mExitCode;\r
STATIC BOOLEAN mExitScript;\r
STATIC CHAR16 *mProfileList;\r
STATIC UINTN mProfileListSize;\r
STATIC BUFFER_LIST mFileHandleList;\r
\r
// global variables required by library class.\r
-EFI_SHELL_PROTOCOL *gEfiShellProtocol = NULL;\r
-EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol = NULL;\r
EFI_UNICODE_COLLATION_PROTOCOL *gUnicodeCollation = NULL;\r
EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *gDevPathToText = NULL;\r
SHELL_MAP_LIST gShellMapList;\r
)\r
{\r
EFI_STATUS Status;\r
- if (gEfiShellParametersProtocol == NULL) {\r
- Status = gBS->OpenProtocol(gImageHandle,\r
- &gEfiShellParametersProtocolGuid,\r
- (VOID **)&gEfiShellParametersProtocol,\r
- gImageHandle,\r
- NULL,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
- if (EFI_ERROR(Status)) {\r
- return (EFI_DEVICE_ERROR);\r
- }\r
- }\r
- if (gEfiShellProtocol == NULL) {\r
- Status = gBS->LocateProtocol(&gEfiShellProtocolGuid, NULL, (VOID**)&gEfiShellProtocol);\r
- if (EFI_ERROR(Status)) {\r
- return (EFI_DEVICE_ERROR);\r
- }\r
- }\r
if (gUnicodeCollation == NULL) {\r
Status = gBS->LocateProtocol(&gEfiUnicodeCollation2ProtocolGuid, NULL, (VOID**)&gUnicodeCollation);\r
if (EFI_ERROR(Status)) {\r
FreePool(mProfileList);\r
}\r
\r
+ gUnicodeCollation = NULL;\r
+ gDevPathToText = NULL;\r
+ gShellCurDir = NULL;\r
+\r
return (RETURN_SUCCESS);\r
}\r
\r
//\r
// allocate memory for new struct\r
//\r
- Node = AllocatePool(sizeof(SHELL_COMMAND_INTERNAL_LIST_ENTRY));\r
+ Node = AllocateZeroPool(sizeof(SHELL_COMMAND_INTERNAL_LIST_ENTRY));\r
ASSERT(Node != NULL);\r
- Node->CommandString = AllocatePool(StrSize(CommandString));\r
+ Node->CommandString = AllocateZeroPool(StrSize(CommandString));\r
ASSERT(Node->CommandString != NULL);\r
\r
//\r
information will be returned. If Sections is NULL, then all help text information\r
available will be returned.\r
\r
- @param Sections pointer to string representing which section to get help on.\r
-\r
- @param[in] CommandString Pointer to the command name. This is the name\r
- found on the command line in the shell.\r
- @param[in,out] RetVal Pointer to the return vaule from the command handler.\r
+ @param[in] CommandString Pointer to the command name. This is the name\r
+ found on the command line in the shell.\r
+ @param[in, out] RetVal Pointer to the return vaule from the command handler.\r
\r
- @param[in,out] CanAffectLE indicates whether this command's return value\r
- needs to be placed into LASTERROR environment variable.\r
+ @param[in, out] CanAffectLE indicates whether this command's return value\r
+ needs to be placed into LASTERROR environment variable.\r
\r
@retval RETURN_SUCCESS The handler was run.\r
@retval RETURN_NOT_FOUND The CommandString did not match a registered\r
(via LIST_ENTRY structure). enumerate through it using the BaseLib linked\r
list functions. do not modify the values.\r
\r
+ @param[in] Sort TRUE to alphabetically sort the values first. FALSE otherwise.\r
+\r
@return a Linked list of all available shell commands.\r
**/\r
CONST COMMAND_LIST*\r
EFIAPI\r
ShellCommandGetCommandList (\r
+ IN CONST BOOLEAN Sort\r
)\r
{\r
+// if (!Sort) {\r
+// return ((COMMAND_LIST*)(&mCommandList));\r
+// }\r
return ((COMMAND_LIST*)(&mCommandList));\r
}\r
\r
//\r
// allocate memory for new struct\r
//\r
- Node = AllocatePool(sizeof(ALIAS_LIST));\r
+ Node = AllocateZeroPool(sizeof(ALIAS_LIST));\r
ASSERT(Node != NULL);\r
- Node->CommandString = AllocatePool(StrSize(Command));\r
- Node->Alias = AllocatePool(StrSize(Alias));\r
+ Node->CommandString = AllocateZeroPool(StrSize(Command));\r
+ Node->Alias = AllocateZeroPool(StrSize(Alias));\r
ASSERT(Node->CommandString != NULL);\r
ASSERT(Node->Alias != NULL);\r
\r
}\r
\r
/**\r
- Determine if a given alias is on the list of built in alias'\r
+ Determine if a given alias is on the list of built in alias'.\r
\r
@param[in] Alias The alias to test for\r
\r
\r
If State is TRUE, Echo will be enabled.\r
If State is FALSE, Echo will be disabled.\r
+\r
+ @param[in] State How to set echo.\r
**/\r
VOID\r
EFIAPI\r
/**\r
Indicate that the current shell or script should exit.\r
\r
- @param[in] ScriptOnly TRUE if only exiting a script, FALSE othrwise.\r
+ @param[in] ScriptOnly TRUE if exiting a script; FALSE otherwise.\r
+ @param[in] ErrorCode The 64 bit error code to return.\r
**/\r
VOID\r
EFIAPI\r
ShellCommandRegisterExit (\r
- IN BOOLEAN ScriptOnly\r
+ IN BOOLEAN ScriptOnly,\r
+ IN CONST UINT64 ErrorCode\r
)\r
{\r
mExitRequested = (BOOLEAN)(!mExitRequested);\r
} else {\r
mExitScript = FALSE;\r
}\r
+ mExitCode = ErrorCode;\r
}\r
\r
/**\r
return (mExitRequested);\r
}\r
\r
+/**\r
+ Retrieve the Exit code.\r
+\r
+ If ShellCommandGetExit returns FALSE than the return from this is undefined.\r
+\r
+ @return the value passed into RegisterExit.\r
+**/\r
+UINT64\r
+EFIAPI\r
+ShellCommandGetExitCode (\r
+ VOID\r
+ )\r
+{\r
+ return (mExitCode);\r
+}\r
/**\r
Retrieve the Exit script indicator.\r
\r
//\r
// Get all Device Paths\r
//\r
- DevicePathList = AllocatePool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);\r
+ DevicePathList = AllocateZeroPool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);\r
ASSERT(DevicePathList != NULL);\r
\r
for (Count = 0 ; HandleList[Count] != NULL ; Count++) {\r
//\r
// Get all Device Paths\r
//\r
- DevicePathList = AllocatePool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);\r
+ DevicePathList = AllocateZeroPool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);\r
ASSERT(DevicePathList != NULL);\r
\r
for (Count = 0 ; HandleList[Count] != NULL ; Count++) {\r
return (EFI_SUCCESS);\r
}\r
\r
-CHAR16*\r
-EFIAPI\r
-ShellCommandCleanPath (\r
- IN OUT CHAR16 *Path\r
- )\r
-{\r
- CHAR16 *Path2;\r
-\r
- for (Path2 = Path ; Path2 != NULL && *Path2 != CHAR_NULL ; Path2++) {\r
- if (*Path2 == L'/') {\r
- *Path2 = L'\\';\r
- }\r
- }\r
-\r
- return (Path);\r
-}\r
-\r
/**\r
Converts a SHELL_FILE_HANDLE to an EFI_FILE_PROTOCOL*.\r
\r
if (Buffer == NULL) {\r
return (NULL);\r
}\r
- NewNode = AllocatePool(sizeof(BUFFER_LIST));\r
+ NewNode = AllocateZeroPool(sizeof(BUFFER_LIST));\r
if (NewNode == NULL) {\r
return (NULL);\r
}\r
}\r
\r
/**\r
- Remove a SHELL_FILE_HANDLE frmo the list of SHELL_FILE_HANDLES.\r
+ Remove a SHELL_FILE_HANDLE from the list of SHELL_FILE_HANDLES.\r
\r
@param[in] Handle The SHELL_FILE_HANDLE to remove.\r
\r
return (RetVal);\r
}\r
\r
-/**\r
- Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned\r
- buffer. The returned buffer must be callee freed.\r
-\r
- If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
- maintained and not changed for all operations with the same file.\r
-\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
-\r
- @return The line of text from the file.\r
-\r
- @sa ShellFileHandleReadLine\r
-**/\r
-CHAR16*\r
-EFIAPI\r
-ShellFileHandleReturnLine(\r
- IN SHELL_FILE_HANDLE Handle,\r
- IN OUT BOOLEAN *Ascii\r
- )\r
-{\r
- CHAR16 *RetVal;\r
- UINTN Size;\r
- EFI_STATUS Status;\r
-\r
- Size = 0;\r
- RetVal = NULL;\r
-\r
- Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r
- if (Status == EFI_BUFFER_TOO_SMALL) {\r
- RetVal = AllocatePool(Size);\r
- Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r
- }\r
- ASSERT_EFI_ERROR(Status);\r
- if (EFI_ERROR(Status) && (RetVal != NULL)) {\r
- FreePool(RetVal);\r
- RetVal = NULL;\r
- }\r
- return (RetVal);\r
-}\r
-\r
-/**\r
- Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.\r
-\r
- If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
- maintained and not changed for all operations with the same file.\r
-\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Buffer The pointer to buffer to read into.\r
- @param[in,out] Size The pointer to number of bytes in Buffer.\r
- @param[in] Truncate If the buffer is large enough, this has no effect.\r
- If the buffer is is too small and Truncate is TRUE,\r
- the line will be truncated.\r
- If the buffer is is too small and Truncate is FALSE,\r
- then no read will occur.\r
-\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
-\r
- @retval EFI_SUCCESS The operation was successful. The line is stored in\r
- Buffer.\r
- @retval EFI_INVALID_PARAMETER Handle was NULL.\r
- @retval EFI_INVALID_PARAMETER Size was NULL.\r
- @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.\r
- Size was updated to the minimum space required.\r
- @sa ShellFileHandleRead\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ShellFileHandleReadLine(\r
- IN SHELL_FILE_HANDLE Handle,\r
- IN OUT CHAR16 *Buffer,\r
- IN OUT UINTN *Size,\r
- IN BOOLEAN Truncate,\r
- IN OUT BOOLEAN *Ascii\r
- )\r
-{\r
- EFI_STATUS Status;\r
- CHAR16 CharBuffer;\r
- UINTN CharSize;\r
- UINTN CountSoFar;\r
- UINT64 OriginalFilePosition;\r
-\r
-\r
- if (Handle == NULL\r
- ||Size == NULL\r
- ){\r
- return (EFI_INVALID_PARAMETER);\r
- }\r
- if (Buffer == NULL) {\r
- ASSERT(*Size == 0);\r
- } else {\r
- *Buffer = CHAR_NULL;\r
- }\r
- gEfiShellProtocol->GetFilePosition(Handle, &OriginalFilePosition);\r
- if (OriginalFilePosition == 0) {\r
- CharSize = sizeof(CHAR16);\r
- Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r
- ASSERT_EFI_ERROR(Status);\r
- if (CharBuffer == UnicodeFileTag) {\r
- *Ascii = FALSE;\r
- } else {\r
- *Ascii = TRUE;\r
- gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r
- }\r
- }\r
-\r
- for (CountSoFar = 0;;CountSoFar++){\r
- CharBuffer = 0;\r
- if (*Ascii) {\r
- CharSize = sizeof(CHAR8);\r
- } else {\r
- CharSize = sizeof(CHAR16);\r
- }\r
- Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r
- if ( EFI_ERROR(Status)\r
- || CharSize == 0\r
- || (CharBuffer == L'\n' && !(*Ascii))\r
- || (CharBuffer == '\n' && *Ascii)\r
- ){\r
- break;\r
- }\r
- //\r
- // if we have space save it...\r
- //\r
- if ((CountSoFar+1)*sizeof(CHAR16) < *Size){\r
- ASSERT(Buffer != NULL);\r
- ((CHAR16*)Buffer)[CountSoFar] = CharBuffer;\r
- ((CHAR16*)Buffer)[CountSoFar+1] = CHAR_NULL;\r
- }\r
- }\r
-\r
- //\r
- // if we ran out of space tell when...\r
- //\r
- if ((CountSoFar+1)*sizeof(CHAR16) > *Size){\r
- *Size = (CountSoFar+1)*sizeof(CHAR16);\r
- if (!Truncate) {\r
- gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r
- } else {\r
- DEBUG((DEBUG_WARN, "The line was truncated in ShellFileHandleReadLine"));\r
- }\r
- return (EFI_BUFFER_TOO_SMALL);\r
- }\r
- while(Buffer[StrLen(Buffer)-1] == L'\r') {\r
- Buffer[StrLen(Buffer)-1] = CHAR_NULL;\r
- }\r
-\r
- return (Status);\r
-}\r
/**\r
Frees any BUFFER_LIST defined type.\r
+\r
+ @param[in] List The BUFFER_LIST object to free.\r
**/\r
VOID\r
EFIAPI\r
}\r
}\r
\r
-/**\r
- Chops off last directory or file entry in a path leaving the trailing slash\r
-\r
- @param[in,out] Path\r
-\r
- @retval FALSE No directory was found to chop off.\r
- @retval TRUE A directory was chopped off.\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ChopLastSlash(\r
- IN OUT CHAR16 *PathToReturn\r
- )\r
-{\r
- CHAR16 *Walker;\r
- CHAR16 *LastSlash = NULL;\r
- //\r
- // get directory name from path... ('chop' off extra)\r
- //\r
- for ( Walker = PathToReturn\r
- ; Walker != NULL && *Walker != CHAR_NULL\r
- ; Walker++\r
- ){\r
- if (*Walker == L'\\' && *(Walker + 1) != CHAR_NULL) {\r
- LastSlash = Walker+1;\r
- }\r
- }\r
- if (LastSlash != NULL) {\r
- *LastSlash = CHAR_NULL;\r
- return (TRUE);\r
- }\r
- return (FALSE);\r
-}\r
-\r
projects / mirror_edk2.git / blobdiff