tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ShellPkg: Rewrite’s Help.c to call the ShellPrintHelp function. 

also, adds a footer to the bottom of the “help” command to explain help switches. 

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Matt Stanbro <Matthew.A.Stanbro@intel.com>
Reviewed-by: Jaben Carsey <Jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@14202 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jcarsey 2013-03-12 20:54:07 +00:00
parent 2edb5ad38c
commit 7c8e7960ef
2 changed files with 22 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c
View File

@ -1,7 +1,7 @@
/** @file /** @file
Main file for Help shell level 3 function. Main file for Help shell level 3 function.
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved. <BR> Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved. <BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -48,9 +48,9 @@ ShellCommandRunHelp (
CHAR16 *SectionToGetHelpOn; CHAR16 *SectionToGetHelpOn;
CHAR16 *HiiString; CHAR16 *HiiString;
BOOLEAN Found; BOOLEAN Found;
BOOLEAN HelpPage; BOOLEAN PrintCommandText;
HelpPage = FALSE; PrintCommandText = TRUE;
ProblemParam = NULL; ProblemParam = NULL;
ShellStatus = SHELL_SUCCESS; ShellStatus = SHELL_SUCCESS;
OutText = NULL; OutText = NULL;
@ -111,7 +111,7 @@ ShellCommandRunHelp (
ASSERT(SectionToGetHelpOn == NULL); ASSERT(SectionToGetHelpOn == NULL);
StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0); StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0);
} else { } else {
HelpPage = TRUE; PrintCommandText = FALSE;
ASSERT(SectionToGetHelpOn == NULL); ASSERT(SectionToGetHelpOn == NULL);
// //
// Get the section name for the given command name // Get the section name for the given command name
@ -156,26 +156,13 @@ ShellCommandRunHelp (
// //
// We have a command to look for help on. // We have a command to look for help on.
// //
Status = gEfiShellProtocol->GetHelpText(Node->CommandString, SectionToGetHelpOn, &OutText); Status = ShellPrintHelp(Node->CommandString, SectionToGetHelpOn, PrintCommandText);
if (EFI_ERROR(Status) || OutText == NULL) { if (Status == EFI_DEVICE_ERROR) {
if (Status == EFI_DEVICE_ERROR) {
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, Node->CommandString); ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, Node->CommandString);
} else { } else if (EFI_ERROR(Status)) {
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, Node->CommandString); ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, Node->CommandString);
}
ShellStatus = SHELL_NOT_FOUND;
} else { } else {
if (HelpPage) { Found = TRUE;
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_PAGE_COMMAND), gShellLevel3HiiHandle, OutText);
} else {
while (OutText[StrLen(OutText)-1] == L'\r' || OutText[StrLen(OutText)-1] == L'\n' || OutText[StrLen(OutText)-1] == L' ') {
OutText[StrLen(OutText)-1] = CHAR_NULL;
}
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_COMMAND), gShellLevel3HiiHandle, Node->CommandString, OutText);
}
FreePool(OutText);
OutText = NULL;
Found = TRUE;
} }
} }
} }
@ -183,30 +170,18 @@ ShellCommandRunHelp (
// Search the .man file for Shell applications (Shell external commands). // Search the .man file for Shell applications (Shell external commands).
// //
if (!Found) { if (!Found) {
Status = gEfiShellProtocol->GetHelpText (CommandToGetHelpOn, SectionToGetHelpOn, &OutText); Status = ShellPrintHelp(CommandToGetHelpOn, SectionToGetHelpOn, FALSE);
if (EFI_ERROR(Status) || OutText == NULL) {
if (Status == EFI_DEVICE_ERROR) { if (Status == EFI_DEVICE_ERROR) {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, CommandToGetHelpOn); ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, CommandToGetHelpOn);
} else if (EFI_ERROR(Status)) {
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn);
} else { } else {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn); Found = TRUE;
} }
ShellStatus = SHELL_NOT_FOUND;
} else {
while (OutText[StrLen (OutText) - 1] == L'\r' || OutText[StrLen (OutText) - 1] == L'\n' || OutText[StrLen (OutText) - 1] == L' ') {
OutText[StrLen (OutText)-1] = CHAR_NULL;
}
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_COMMAND), gShellLevel3HiiHandle, CommandToGetHelpOn, OutText);
if (OutText != NULL) {
FreePool (OutText);
OutText = NULL;
}
Found = TRUE;
}
} }
} }
if (!Found && ShellStatus == SHELL_SUCCESS) { if (!Found) {
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn);
ShellStatus = SHELL_NOT_FOUND; ShellStatus = SHELL_NOT_FOUND;
} }
@ -216,6 +191,14 @@ ShellCommandRunHelp (
ShellCommandLineFreeVarList (Package); ShellCommandLineFreeVarList (Package);
} }
} }
if (CommandToGetHelpOn != NULL && StrCmp(CommandToGetHelpOn, L"*") == 0){
//
// If '*' then the command entered was 'Help' without qualifiers, This footer
// provides additional info on help switches
//
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_FOOTER), gShellLevel3HiiHandle);
}
if (CommandToGetHelpOn != NULL) { if (CommandToGetHelpOn != NULL) {
FreePool(CommandToGetHelpOn); FreePool(CommandToGetHelpOn);
} }

BIN
ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
View File

Binary file not shown.