ShellPkg: Updates to 'help' command

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Chris Phillips <chrisp@hp.com>
reviewed-by: Jaben Carsey <jaben.carsey@intel.com>

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13997 6f19259b-4bc3-4df7-8a09-765794883524

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 caf852ee4f..2dfb808c0d 100644
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni
diff --git a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
index 9ffad7ec04..4354b140f6 100644
--- a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni
index 1c6a04108d..81ef1b2ce2 100644
--- a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni
diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni b/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni
index e9dec01bf2..c2020ca7f7 100644
--- a/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni
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 <command> 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 db91f5b8cc..bf5714c9a0 100644
--- a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni