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

diff --git a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
index fb44768c0b0a92f40c22a408fa269af0bd2e0392..66a242f66ff23192d27361ad758b2af6c686bffa 100644 (file)
--- a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
+++ b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
@@ -334,6 +334,16 @@ ShellCommandRegisterCommandName (
   )\r
 {\r
   SHELL_COMMAND_INTERNAL_LIST_ENTRY *Node;\r
+  SHELL_COMMAND_INTERNAL_LIST_ENTRY *Command;\r
+  SHELL_COMMAND_INTERNAL_LIST_ENTRY *PrevCommand;\r
+  INTN LexicalMatchValue;\r
+\r
+  //\r
+  // Initialize local variables.\r
+  //\r
+  Command = NULL;\r
+  PrevCommand = NULL;\r
+  LexicalMatchValue = 0;\r
 \r
   //\r
   // ASSERTs for NULL parameters\r
@@ -392,9 +402,40 @@ ShellCommandRegisterCommandName (
   }\r
 \r
   //\r
-  // add the new struct to the list\r
+  // Insert a new entry on top of the list\r
   //\r
-  InsertTailList (&mCommandList.Link, &Node->Link);\r
+  InsertHeadList (&mCommandList.Link, &Node->Link);\r
+\r
+  //\r
+  // Move a new registered command to its sorted ordered location in the list\r
+  //\r
+  for (Command = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *)GetFirstNode (&mCommandList.Link),\r
+        PrevCommand = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *)GetFirstNode (&mCommandList.Link)\r
+        ; !IsNull (&mCommandList.Link, &Command->Link)\r
+        ; Command = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *)GetNextNode (&mCommandList.Link, &Command->Link)) {\r
+\r
+    //\r
+    // Get Lexical Comparison Value between PrevCommand and Command list entry\r
+    //\r
+    LexicalMatchValue = gUnicodeCollation->StriColl (\r
+                                             gUnicodeCollation,\r
+                                             PrevCommand->CommandString,\r
+                                             Command->CommandString\r
+                                             );\r
+\r
+    //\r
+    // Swap PrevCommand and Command list entry if PrevCommand list entry\r
+    // is alphabetically greater than Command list entry\r
+    //\r
+    if (LexicalMatchValue > 0){\r
+      Command = (SHELL_COMMAND_INTERNAL_LIST_ENTRY *) SwapListEntries (&PrevCommand->Link, &Command->Link);\r
+    } else if (LexicalMatchValue < 0) {\r
+      //\r
+      // PrevCommand entry is lexically lower than Command entry\r
+      //\r
+      break;\r
+    }\r
+  }\r
 \r
   return (RETURN_SUCCESS);\r
 }\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni
index caf852ee4f4fc31453a9701faf516886ce7d5594..2dfb808c0dce791fd00b17c34a5dbb9a30a4e578 100644 (file)
Binary files a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni and b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.uni differ

diff --git a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
index 9ffad7ec04275b61bd2f182e0abe00afcb8becc2..4354b140f69825d7ec985f2ea706683831e34643 100644 (file)
Binary files a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni and b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni differ

diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni
index 1c6a04108d21d0fd3c599b860e44f12143711de8..81ef1b2ce265902c047f261b7fe858a7478d1732 100644 (file)
Binary files a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni and b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.uni differ

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni b/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni
index e9dec01bf2f55a46dd9df2eecd238b6fc6ec2030..c2020ca7f7bc46868f9ad4dfda38fa0da5d1db89 100644 (file)
Binary files a/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni and b/ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.uni differ

diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c b/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c
index 1c643b0e578f6536e2118efb06c2e3a56a209365..57ae8fc5e393bff8d3de0734bc5ae5b379156285 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c
+++ b/ShellPkg/Library/UefiShellLevel3CommandsLib/Help.c
@@ -48,7 +48,9 @@ ShellCommandRunHelp (
   CHAR16              *SectionToGetHelpOn;\r
   CHAR16              *HiiString;\r
   BOOLEAN             Found;\r
+  BOOLEAN             HelpPage;\r
 \r
+  HelpPage            = FALSE;\r
   ProblemParam        = NULL;\r
   ShellStatus         = SHELL_SUCCESS;\r
   OutText             = NULL;\r
@@ -109,6 +111,7 @@ ShellCommandRunHelp (
         ASSERT(SectionToGetHelpOn == NULL);\r
         StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0);\r
       } else {\r
+        HelpPage = TRUE;\r
         ASSERT(SectionToGetHelpOn == NULL);\r
         //\r
         // Get the section name for the given command name\r
@@ -119,7 +122,10 @@ ShellCommandRunHelp (
           StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME,SYNOPSIS", 0);\r
         } else if (ShellCommandLineGetFlag(Package, L"-verbose") || ShellCommandLineGetFlag(Package, L"-v")) {\r
         } else {\r
-          StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0);\r
+          //\r
+          // The output of help <command> will display NAME, SYNOPSIS, OPTIONS, DESCRIPTION, and EXAMPLES sections.\r
+          //\r
+          StrnCatGrow (&SectionToGetHelpOn, NULL, L"NAME,SYNOPSIS,OPTIONS,DESCRIPTION,EXAMPLES", 0);\r
         }\r
       }\r
 \r
@@ -139,6 +145,12 @@ ShellCommandRunHelp (
             ; CommandList != NULL && !IsListEmpty(&CommandList->Link) && !IsNull(&CommandList->Link, &Node->Link)\r
             ; Node = (COMMAND_LIST*)GetNextNode(&CommandList->Link, &Node->Link)\r
            ){\r
+          //\r
+          // Checking execution break flag when print multiple command help information.\r
+          //\r
+          if (ShellGetExecutionBreakFlag ()) {\r
+            break;\r
+          } \r
           if ((gUnicodeCollation->MetaiMatch(gUnicodeCollation, Node->CommandString, CommandToGetHelpOn)) ||\r
              (gEfiShellProtocol->GetAlias(CommandToGetHelpOn, NULL) != NULL && (gUnicodeCollation->MetaiMatch(gUnicodeCollation, Node->CommandString, (CHAR16*)(gEfiShellProtocol->GetAlias(CommandToGetHelpOn, NULL)))))) {\r
             //\r
@@ -153,16 +165,44 @@ ShellCommandRunHelp (
               }\r
               ShellStatus = SHELL_NOT_FOUND;\r
             } else {\r
-              while (OutText[StrLen(OutText)-1] == L'\r' || OutText[StrLen(OutText)-1] == L'\n' || OutText[StrLen(OutText)-1] == L' ') {\r
-                OutText[StrLen(OutText)-1] = CHAR_NULL;\r
+              if (HelpPage == TRUE) {\r
+                 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_PAGE_COMMAND), gShellLevel3HiiHandle, OutText);\r
+              } else {\r
+                while (OutText[StrLen(OutText)-1] == L'\r' || OutText[StrLen(OutText)-1] == L'\n' || OutText[StrLen(OutText)-1] == L' ') {\r
+                  OutText[StrLen(OutText)-1] = CHAR_NULL;\r
+                }\r
+                ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_COMMAND), gShellLevel3HiiHandle, Node->CommandString, OutText);\r
               }\r
-              ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_COMMAND), gShellLevel3HiiHandle, Node->CommandString, OutText);\r
               FreePool(OutText);\r
               OutText = NULL;\r
               Found = TRUE;\r
             }\r
           }\r
         }\r
+        //\r
+        // Search the .man file for Shell applications (Shell external commands).\r
+        //\r
+        if (!Found) {\r
+          Status = gEfiShellProtocol->GetHelpText (CommandToGetHelpOn, SectionToGetHelpOn, &OutText);\r
+          if (EFI_ERROR(Status) || OutText == NULL) {\r
+            if (Status == EFI_DEVICE_ERROR) {\r
+              ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, CommandToGetHelpOn);\r
+            } else {\r
+              ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn);\r
+            }\r
+            ShellStatus = SHELL_NOT_FOUND;\r
+          } else {\r
+            while (OutText[StrLen (OutText) - 1] == L'\r' || OutText[StrLen (OutText) - 1] == L'\n' || OutText[StrLen (OutText) - 1] == L' ') {\r
+              OutText[StrLen (OutText)-1] = CHAR_NULL;\r
+            }\r
+            ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_COMMAND), gShellLevel3HiiHandle, CommandToGetHelpOn, OutText);\r
+            if (OutText != NULL) {\r
+              FreePool (OutText);\r
+              OutText = NULL;\r
+            }\r
+            Found = TRUE;\r
+          }\r
+        }\r
       }\r
 \r
       if (!Found && ShellStatus == SHELL_SUCCESS) {\r

diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
index db91f5b8cc8fce84e988dbab7c02ee10b8f5d858..bf5714c9a0b00501a2d5434bed524e9f0a8ede61 100644 (file)
Binary files a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni and b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni differ