From d51088b764304f920a41a186bef45ca789e080dc Mon Sep 17 00:00:00 2001 From: jcarsey Date: Thu, 13 Dec 2012 21:26:22 +0000 Subject: [PATCH] ShellPkg: Updates to 'help' command Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Chris Phillips reviewed-by: Jaben Carsey git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13997 6f19259b-4bc3-4df7-8a09-765794883524 --- .../UefiShellCommandLib/UefiShellCommandLib.c | 45 +++++++++++++++- .../UefiShellDebug1CommandsLib.uni | Bin 153084 -> 152966 bytes .../UefiShellDriver1CommandsLib.uni | Bin 70090 -> 69812 bytes .../UefiShellLevel1CommandsLib.uni | Bin 38214 -> 38016 bytes .../UefiShellLevel2CommandsLib.uni | Bin 111570 -> 111322 bytes .../Library/UefiShellLevel3CommandsLib/Help.c | 48 ++++++++++++++++-- .../UefiShellLevel3CommandsLib.uni | Bin 42584 -> 42418 bytes 7 files changed, 87 insertions(+), 6 deletions(-) diff --git a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c index fb44768c0b..66a242f66f 100644 --- a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c +++ b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c @@ -334,6 +334,16 @@ ShellCommandRegisterCommandName ( ) { SHELL_COMMAND_INTERNAL_LIST_ENTRY *Node; + SHELL_COMMAND_INTERNAL_LIST_ENTRY *Command; + SHELL_COMMAND_INTERNAL_LIST_ENTRY *PrevCommand; + INTN LexicalMatchValue; + + // + // Initialize local variables. + // + Command = NULL; + PrevCommand = NULL; + LexicalMatchValue = 0; // // ASSERTs for NULL parameters @@ -392,9 +402,40 @@ ShellCommandRegisterCommandName ( } // - // add the new struct to the list + // Insert a new entry on top of the list // - InsertTailList (&mCommandList.Link, &Node->Link); + InsertHeadList (&mCommandList.Link, &Node->Link); + + // + // Move a new registered command to its sorted ordered location in the list + // + for (Command = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *)GetFirstNode (&mCommandList.Link), + PrevCommand = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *)GetFirstNode (&mCommandList.Link) + ; !IsNull (&mCommandList.Link, &Command->Link) + ; Command = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *)GetNextNode (&mCommandList.Link, &Command->Link)) { + + // + // Get Lexical Comparison Value between PrevCommand and Command list entry + // + LexicalMatchValue = gUnicodeCollation->StriColl ( + gUnicodeCollation, + PrevCommand->CommandString, + Command->CommandString + ); + + // + // Swap PrevCommand and Command list entry if PrevCommand list entry + // is alphabetically greater than Command list entry + // + if (LexicalMatchValue > 0){ + Command = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *) SwapListEntries (&PrevCommand->Link, &Command->Link); + } else if (LexicalMatchValue < 0) { + // + // PrevCommand entry is lexically lower than Command entry + // + break; + } + } return (RETURN_SUCCESS); } diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni index caf852ee4f4fc31453a9701faf516886ce7d5594..2dfb808c0dce791fd00b17c34a5dbb9a30a4e578 100644 GIT binary patch delta 33 pcmeyfnzL;+XTui8OI_PFx)~FuPG6_OK-CII|04Q>Dc delta 108 zcmZo$&G~0FXTui8OI_1{ON(A#V8FGL!3P2Tk uK(d4(1I$YUswo1hN(7210NH8VPj@k#~lLWIAlcKH`lQatulQ6b0vzDwh EWhlNWVE_OC delta 104 zcmV-u0GI!?p#;jK1h5WClR{1slOn+wlX8(3lcG@;6LkP?0Av7V0CE6q0C@mu0B!(h zlQBshlhRQjlQs(ulTfQHvx-TM9Fl3elQ51tvwCKFM3cI(5R=NZ5R>4tNCPeaAeX@j K0XwsLt2$+rXeN#T diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni index 1c6a04108d21d0fd3c599b860e44f12143711de8..81ef1b2ce265902c047f261b7fe858a7478d1732 100644 GIT binary patch delta 134 zcmX@Mim72G(}pZbPIZPfhJ1!12KCMPlALmkzMCt}Bf0rq87df38Il=F8A^b3@nl9B zQRYmByvd3Z;*&Rc3TWWH4kh zBm+qWAU_!>lgUuPP%@cOTXgaTBPH1+hD4xvDnklTKA#~ENEU!~mjTtKOy+f#oV*~2 zWinro#AXfW3J1YlprSIMa*)x9Kr3=4uWr_yEYQm0nF5q42OD4rl*?l%Wyobn0;((m z@-!f7!73m+lYveFnF8WLOa!SjWH4aRoZKjBy;-Tngp=D9?1xmKMCRo1URmJ+pwc3S j5}?Z^*8cu_QPxF- diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni b/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni index e9dec01bf2f55a46dd9df2eecd238b6fc6ec2030..c2020ca7f7bc46868f9ad4dfda38fa0da5d1db89 100644 GIT binary patch delta 229 zcmccgobA?AwhcQXC!dh!+k7PQ9Lr?64z|g54>>l^i_6lPeus-uWBP<9MwZEKOGH?6 z81fmCCo|5MogTo!sIhrgH;3}{37(8%yeSN+3~3CR40%Ahcyi-r;mO;!34s+&4%o=H zIcdF_{qz7^Mi$-@h9aP{RE9FJ!sG80xr>0TWT3f43@MXk-&;;rT5q*^$@?_@>GM1p zIrwvdGATeEAj3gMzpm1s{y~{h4Q%%IP4bK%TBk4YWMrExlPWNM8apH3bDcmcw7Pr(2H delta 230 zcmcchloyk@cqBh5MJ1DcKGNdtNGUQFZy)&Cr zfgyt-ks*&EWpe)%@yQeJXl)i)Z)MNx%#hEJ3xp7yAsI+2Fq8w;7Ef+}XF2)LSCPp~XRS8>dY7iJtpk(-DF7Li4%A)@MZ J-BQLFUI1(CPE`N^ diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c b/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c index 1c643b0e57..57ae8fc5e3 100644 --- a/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c +++ b/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c @@ -48,7 +48,9 @@ ShellCommandRunHelp ( CHAR16 *SectionToGetHelpOn; CHAR16 *HiiString; BOOLEAN Found; + BOOLEAN HelpPage; + HelpPage = FALSE; ProblemParam = NULL; ShellStatus = SHELL_SUCCESS; OutText = NULL; @@ -109,6 +111,7 @@ ShellCommandRunHelp ( ASSERT(SectionToGetHelpOn == NULL); StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0); } else { + HelpPage = TRUE; ASSERT(SectionToGetHelpOn == NULL); // // Get the section name for the given command name @@ -119,7 +122,10 @@ ShellCommandRunHelp ( StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME,SYNOPSIS", 0); } else if (ShellCommandLineGetFlag(Package, L"-verbose") || ShellCommandLineGetFlag(Package, L"-v")) { } else { - StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0); + // + // The output of help will display NAME, SYNOPSIS, OPTIONS, DESCRIPTION, and EXAMPLES sections. + // + StrnCatGrow (&SectionToGetHelpOn, NULL, L"NAME,SYNOPSIS,OPTIONS,DESCRIPTION,EXAMPLES", 0); } } @@ -139,6 +145,12 @@ ShellCommandRunHelp ( ; CommandList != NULL && !IsListEmpty(&CommandList->Link) && !IsNull(&CommandList->Link, &Node->Link) ; Node = (COMMAND_LIST*)GetNextNode(&CommandList->Link, &Node->Link) ){ + // + // Checking execution break flag when print multiple command help information. + // + if (ShellGetExecutionBreakFlag ()) { + break; + } if ((gUnicodeCollation->MetaiMatch(gUnicodeCollation, Node->CommandString, CommandToGetHelpOn)) || (gEfiShellProtocol->GetAlias(CommandToGetHelpOn, NULL) != NULL && (gUnicodeCollation->MetaiMatch(gUnicodeCollation, Node->CommandString, (CHAR16*)(gEfiShellProtocol->GetAlias(CommandToGetHelpOn, NULL)))))) { // @@ -153,16 +165,44 @@ ShellCommandRunHelp ( } 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; + if (HelpPage == 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); } - ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_COMMAND), gShellLevel3HiiHandle, Node->CommandString, OutText); FreePool(OutText); OutText = NULL; Found = TRUE; } } } + // + // Search the .man file for Shell applications (Shell external commands). + // + if (!Found) { + Status = gEfiShellProtocol->GetHelpText (CommandToGetHelpOn, SectionToGetHelpOn, &OutText); + if (EFI_ERROR(Status) || OutText == NULL) { + if (Status == EFI_DEVICE_ERROR) { + ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, CommandToGetHelpOn); + } else { + ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn); + } + 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) { diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni index db91f5b8cc8fce84e988dbab7c02ee10b8f5d858..bf5714c9a0b00501a2d5434bed524e9f0a8ede61 100644 GIT binary patch delta 324 zcmca{hH2AjrVTUH#61{P8FU#88B7?8fh<2DTLDNHPu{PtJy}4Ci#>qBk-?q8b+W&j z^yE2gDy)7m+08f9G?*sevKO1Y!CGMQ88d~+PaFlHrd5d zY_f(2-{fV9LX!&`G&VapOc9=}(xou@Pq5zPC!s)H0s@m0y0kX;ge>Eltdb-)`H`d0 z#ma$VB@7vp5Aq7D7K01|@=}3vAPW+~Yy}{l2joHZPgV?*1zR$s bp-P-Fbn@I;l9Q8WX-xhj3vukD8D+cxEqz}| delta 274 zcmdmVn(4+FrVTUHM4cE^8FU#884MVTfh<2DTa}@BvZIFf<|uUyrpZxeN~$Fc84QUG zB@7BcvWOuSNGCCrGGsF3fW