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

consist mapping - add comments and change variable names.

Browse Source 
UefiShellCommandLib - add comments and zero out memory allocations.

add guid to inf file.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11433 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jcarsey
2011-03-25 21:09:21 +00:00
parent b0475f1289
commit 1a63ec8f82
3 changed files with 187 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
View File

@ -1,7 +1,7 @@
/** @file
Provides interface to shell internal functions for shell commands.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, 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
@ -17,7 +17,7 @@
/// The tag for use in identifying UNICODE files.
/// If the file is UNICODE, the first 16 bits of the file will equal this value.
enum {
UnicodeFileTag = 0xFEFF
gUnicodeFileTag = 0xFEFF
};
// STATIC local variables
@ -207,6 +207,12 @@ ShellCommandLibDestructor (
FreePool(mProfileList);
}
gEfiShellProtocol = NULL;
gEfiShellParametersProtocol = NULL;
gUnicodeCollation = NULL;
gDevPathToText = NULL;
gShellCurDir = NULL;
return (RETURN_SUCCESS);
}
@ -374,9 +380,9 @@ ShellCommandRegisterCommandName (
//
// allocate memory for new struct
//
Node = AllocatePool(sizeof(SHELL_COMMAND_INTERNAL_LIST_ENTRY));
Node = AllocateZeroPool(sizeof(SHELL_COMMAND_INTERNAL_LIST_ENTRY));
ASSERT(Node != NULL);
Node->CommandString = AllocatePool(StrSize(CommandString));
Node->CommandString = AllocateZeroPool(StrSize(CommandString));
ASSERT(Node->CommandString != NULL);
//
@ -440,8 +446,6 @@ ShellCommandGetProfileList (
information will be returned. If Sections is NULL, then all help text information
available will be returned.
@param Sections pointer to string representing which section to get help on.
@param[in] CommandString Pointer to the command name. This is the name
found on the command line in the shell.
@param[in,out] RetVal Pointer to the return vaule from the command handler.
@ -546,13 +550,19 @@ ShellCommandGetManFileNameHandler (
(via LIST_ENTRY structure). enumerate through it using the BaseLib linked
list functions. do not modify the values.
@param[in] Sort TRUE to alphabetically sort the values first. FALSE otherwise.
@return a Linked list of all available shell commands.
**/
CONST COMMAND_LIST*
EFIAPI
ShellCommandGetCommandList (
IN CONST BOOLEAN Sort
)
{
// if (!Sort) {
// return ((COMMAND_LIST*)(&mCommandList));
// }
return ((COMMAND_LIST*)(&mCommandList));
}
@ -587,10 +597,10 @@ ShellCommandRegisterAlias (
//
// allocate memory for new struct
//
Node = AllocatePool(sizeof(ALIAS_LIST));
Node = AllocateZeroPool(sizeof(ALIAS_LIST));
ASSERT(Node != NULL);
Node->CommandString = AllocatePool(StrSize(Command));
Node->Alias = AllocatePool(StrSize(Alias));
Node->CommandString = AllocateZeroPool(StrSize(Command));
Node->Alias = AllocateZeroPool(StrSize(Alias));
ASSERT(Node->CommandString != NULL);
ASSERT(Node->Alias != NULL);
@ -625,7 +635,7 @@ ShellCommandGetInitAliasList (
}
/**
Determine if a given alias is on the list of built in alias'
Determine if a given alias is on the list of built in alias'.
@param[in] Alias The alias to test for
@ -694,6 +704,8 @@ ShellCommandGetEchoState(
If State is TRUE, Echo will be enabled.
If State is FALSE, Echo will be disabled.
@param[in] State How to set echo.
**/
VOID
EFIAPI
@ -1040,7 +1052,7 @@ ShellCommandCreateInitialMappingsAndPaths(
//
// Get all Device Paths
//
DevicePathList = AllocatePool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);
DevicePathList = AllocateZeroPool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);
ASSERT(DevicePathList != NULL);
for (Count = 0 ; HandleList[Count] != NULL ; Count++) {
@ -1097,7 +1109,7 @@ ShellCommandCreateInitialMappingsAndPaths(
//
// Get all Device Paths
//
DevicePathList = AllocatePool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);
DevicePathList = AllocateZeroPool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);
ASSERT(DevicePathList != NULL);
for (Count = 0 ; HandleList[Count] != NULL ; Count++) {
@ -1132,6 +1144,13 @@ ShellCommandCreateInitialMappingsAndPaths(
return (EFI_SUCCESS);
}
/**
Function to make sure all directory delimeters are backslashes.
@param[in,out] Path The path to modify.
@return Path.
**/
CHAR16*
EFIAPI
ShellCommandCleanPath (
@ -1189,7 +1208,7 @@ ConvertEfiFileProtocolToShellHandle(
if (Buffer == NULL) {
return (NULL);
}
NewNode = AllocatePool(sizeof(BUFFER_LIST));
NewNode = AllocateZeroPool(sizeof(BUFFER_LIST));
if (NewNode == NULL) {
return (NULL);
}
@ -1232,7 +1251,7 @@ ShellFileHandleGetPath(
}
/**
Remove a SHELL_FILE_HANDLE frmo the list of SHELL_FILE_HANDLES.
Remove a SHELL_FILE_HANDLE from the list of SHELL_FILE_HANDLES.
@param[in] Handle The SHELL_FILE_HANDLE to remove.
@ -1340,7 +1359,7 @@ ShellFileHandleReturnLine(
Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);
if (Status == EFI_BUFFER_TOO_SMALL) {
RetVal = AllocatePool(Size);
RetVal = AllocateZeroPool(Size);
Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);
}
ASSERT_EFI_ERROR(Status);
@ -1409,7 +1428,7 @@ ShellFileHandleReadLine(
CharSize = sizeof(CHAR16);
Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);
ASSERT_EFI_ERROR(Status);
if (CharBuffer == UnicodeFileTag) {
if (CharBuffer == gUnicodeFileTag) {
*Ascii = FALSE;
} else {
*Ascii = TRUE;
@ -1462,6 +1481,8 @@ ShellFileHandleReadLine(
}
/**
Frees any BUFFER_LIST defined type.
@param[in] List The BUFFER_LIST object to free.
**/
VOID
EFIAPI
@ -1493,7 +1514,7 @@ FreeBufferList (
/**
Chops off last directory or file entry in a path leaving the trailing slash
@param[in,out] Path
@param[in,out] PathToReturn The path to modify.
@retval FALSE No directory was found to chop off.
@retval TRUE A directory was chopped off.
@ -1505,11 +1526,11 @@ ChopLastSlash(
)
{
CHAR16 *Walker;
CHAR16 *LastSlash = NULL;
CHAR16 *LastSlash;
//
// get directory name from path... ('chop' off extra)
//
for ( Walker = PathToReturn
for ( Walker = PathToReturn, LastSlash = NULL
; Walker != NULL && *Walker != CHAR_NULL
; Walker++
){