/** @file\r
Main file for Help shell level 3 function.\r
\r
- Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved. <BR>\r
+ Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved. <BR>\r
+ Copyright (c) 2014, ARM Limited. All rights reserved. <BR>\r
+ (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
+\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
#include "UefiShellLevel3CommandsLib.h"\r
\r
#include <Library/ShellLib.h>\r
+#include <Library/HandleParsingLib.h>\r
+\r
+#include <Protocol/EfiShellDynamicCommand.h>\r
+\r
+/**\r
+ Attempt to print help from a dynamically added command.\r
+\r
+ @param[in] CommandToGetHelpOn The unicode name of the command that help is\r
+ requested on.\r
+ @param[in] SectionToGetHelpOn Pointer to the section specifier(s).\r
+ @param[in] PrintCommandText Print the command followed by the help content\r
+ or just help.\r
+\r
+ @retval EFI_SUCCESS The help was displayed\r
+ @retval EFI_NOT_FOUND The command name could not be found\r
+ @retval EFI_DEVICE_ERROR The help data format was incorrect.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PrintDynamicCommandHelp(\r
+ IN CHAR16 *CommandToGetHelpOn,\r
+ IN CHAR16 *SectionToGetHelpOn,\r
+ IN BOOLEAN PrintCommandText\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ BOOLEAN Found;\r
+ EFI_HANDLE *CommandHandleList;\r
+ EFI_HANDLE *NextCommand;\r
+ EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *DynamicCommand;\r
+\r
+ Status = EFI_NOT_FOUND;\r
+ Found = FALSE;\r
+ CommandHandleList = NULL;\r
+\r
+ CommandHandleList = GetHandleListByProtocol(&gEfiShellDynamicCommandProtocolGuid);\r
+\r
+ if (CommandHandleList == NULL) {\r
+ //\r
+ // not found or out of resources\r
+ //\r
+ return Status;\r
+ }\r
+\r
+ for (NextCommand = CommandHandleList; *NextCommand != NULL; NextCommand++) {\r
+ Status = gBS->HandleProtocol(\r
+ *NextCommand,\r
+ &gEfiShellDynamicCommandProtocolGuid,\r
+ (VOID **)&DynamicCommand\r
+ );\r
+\r
+ if (EFI_ERROR(Status)) {\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Check execution break flag when printing multiple command help information.\r
+ //\r
+ if (ShellGetExecutionBreakFlag ()) {\r
+ break;\r
+ }\r
+\r
+ if ((gUnicodeCollation->MetaiMatch (gUnicodeCollation, (CHAR16 *)DynamicCommand->CommandName, CommandToGetHelpOn)) ||\r
+ (gEfiShellProtocol->GetAlias (CommandToGetHelpOn, NULL) != NULL && (gUnicodeCollation->MetaiMatch (gUnicodeCollation, (CHAR16 *)DynamicCommand->CommandName, (CHAR16*)(gEfiShellProtocol->GetAlias(CommandToGetHelpOn, NULL)))))) {\r
+ // Print as Shell Help if in ManPage format.\r
+ Status = ShellPrintHelp (DynamicCommand->CommandName, SectionToGetHelpOn,\r
+ PrintCommandText);\r
+ if (Status == EFI_DEVICE_ERROR) {\r
+ ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_INV),\r
+ gShellLevel3HiiHandle, DynamicCommand->CommandName);\r
+ } else if (EFI_ERROR(Status)) {\r
+ ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_HELP_NF),\r
+ gShellLevel3HiiHandle, DynamicCommand->CommandName);\r
+ } else {\r
+ Found = TRUE;\r
+ }\r
+ }\r
+ }\r
+\r
+ return (Found ? EFI_SUCCESS : Status);\r
+\r
+}\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
{L"-usage", TypeFlag},\r
LIST_ENTRY *Package;\r
CHAR16 *ProblemParam;\r
SHELL_STATUS ShellStatus;\r
- CHAR16 *OutText;\r
CONST COMMAND_LIST *CommandList;\r
CONST COMMAND_LIST *Node;\r
CHAR16 *CommandToGetHelpOn;\r
CHAR16 *SectionToGetHelpOn;\r
CHAR16 *HiiString;\r
BOOLEAN Found;\r
- BOOLEAN HelpPage;\r
+ BOOLEAN PrintCommandText;\r
\r
- HelpPage = FALSE;\r
+ PrintCommandText = TRUE;\r
ProblemParam = NULL;\r
ShellStatus = SHELL_SUCCESS;\r
- OutText = NULL;\r
CommandToGetHelpOn = NULL;\r
SectionToGetHelpOn = NULL;\r
Found = FALSE;\r
Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
if (EFI_ERROR(Status)) {\r
if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
- ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, ProblemParam);\r
+ ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel3HiiHandle, L"help", ProblemParam); \r
FreePool(ProblemParam);\r
ShellStatus = SHELL_INVALID_PARAMETER;\r
} else {\r
&&ShellCommandLineGetFlag(Package, L"-section")\r
&&(ShellCommandLineGetFlag(Package, L"-verbose") || ShellCommandLineGetFlag(Package, L"-v"))\r
){\r
- ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellLevel3HiiHandle);\r
+ ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellLevel3HiiHandle, L"help"); \r
ShellStatus = SHELL_INVALID_PARAMETER;\r
} else if (ShellCommandLineGetRawValue(Package, 2) != NULL) {\r
- ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel3HiiHandle);\r
+ ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel3HiiHandle, L"help"); \r
ShellStatus = SHELL_INVALID_PARAMETER;\r
} else {\r
//\r
ASSERT(SectionToGetHelpOn == NULL);\r
StrnCatGrow(&SectionToGetHelpOn, NULL, L"NAME", 0);\r
} else {\r
- HelpPage = TRUE;\r
+ PrintCommandText = FALSE;\r
ASSERT(SectionToGetHelpOn == NULL);\r
//\r
// Get the section name for the given command name\r
//\r
// We have a command to look for help on.\r
//\r
- Status = gEfiShellProtocol->GetHelpText(Node->CommandString, SectionToGetHelpOn, &OutText);\r
- if (EFI_ERROR(Status) || OutText == NULL) {\r
- if (Status == EFI_DEVICE_ERROR) {\r
+ Status = ShellPrintHelp(Node->CommandString, SectionToGetHelpOn, PrintCommandText);\r
+ if (Status == EFI_DEVICE_ERROR) {\r
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, Node->CommandString);\r
- } else {\r
+ } else if (EFI_ERROR(Status)) {\r
ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, Node->CommandString);\r
- }\r
- ShellStatus = SHELL_NOT_FOUND;\r
} else {\r
- if (HelpPage) {\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
- FreePool(OutText);\r
- OutText = NULL;\r
- Found = TRUE;\r
+ Found = TRUE;\r
}\r
}\r
}\r
+\r
+ //\r
+ // now try to match against the dynamic command list and print help\r
+ //\r
+ Status = PrintDynamicCommandHelp (CommandToGetHelpOn, SectionToGetHelpOn,\r
+ PrintCommandText);\r
+ if (!EFI_ERROR(Status)) {\r
+ Found = TRUE;\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
+ Status = ShellPrintHelp(CommandToGetHelpOn, SectionToGetHelpOn, FALSE);\r
+ if (Status == EFI_DEVICE_ERROR) {\r
+ ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_INV), gShellLevel3HiiHandle, CommandToGetHelpOn);\r
+ } else if (EFI_ERROR(Status)) {\r
+ ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn);\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
- ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_NF), gShellLevel3HiiHandle, CommandToGetHelpOn);\r
+ if (!Found) {\r
ShellStatus = SHELL_NOT_FOUND;\r
}\r
\r
ShellCommandLineFreeVarList (Package);\r
}\r
}\r
+\r
+ if (CommandToGetHelpOn != NULL && StrCmp(CommandToGetHelpOn, L"*") == 0){\r
+ //\r
+ // If '*' then the command entered was 'Help' without qualifiers, This footer\r
+ // provides additional info on help switches\r
+ //\r
+ ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HELP_FOOTER), gShellLevel3HiiHandle);\r
+ }\r
if (CommandToGetHelpOn != NULL) {\r
FreePool(CommandToGetHelpOn);\r
}\r
\r
return (ShellStatus);\r
}\r
-\r
projects / mirror_edk2.git / blobdiff