X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ShellPkg%2FApplication%2FShell%2FShellManParser.c;h=6909f294418befbb5bdb3f290b6a9bc430d0f5e0;hb=8da8daafc9055ce83804fcc65d0f4cf01b2ca6fe;hp=ab32c36b7502816a31db79b2da770366f434a60d;hpb=733f138d84a25a5993bc32ffe016c364daba686c;p=mirror_edk2.git
diff --git a/ShellPkg/Application/Shell/ShellManParser.c b/ShellPkg/Application/Shell/ShellManParser.c
index ab32c36b75..6909f29441 100644
--- a/ShellPkg/Application/Shell/ShellManParser.c
+++ b/ShellPkg/Application/Shell/ShellManParser.c
@@ -1,19 +1,96 @@
/** @file
Provides interface to shell MAN file parser.
- Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
- This program and the accompanying materials
- 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
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+ Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.
+ Copyright 2015 Dell Inc.
+ SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "Shell.h"
+#define SHELL_MAN_HII_GUID \
+{ \
+ 0xf62ccd0c, 0x2449, 0x453c, { 0x8a, 0xcb, 0x8c, 0xc5, 0x7c, 0xf0, 0x2a, 0x97 } \
+}
+
+EFI_HII_HANDLE mShellManHiiHandle = NULL;
+EFI_HANDLE mShellManDriverHandle = NULL;
+
+
+SHELL_MAN_HII_VENDOR_DEVICE_PATH mShellManHiiDevicePath = {
+ {
+ {
+ HARDWARE_DEVICE_PATH,
+ HW_VENDOR_DP,
+ {
+ (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
+ (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
+ }
+ },
+ SHELL_MAN_HII_GUID
+ },
+ {
+ END_DEVICE_PATH_TYPE,
+ END_ENTIRE_DEVICE_PATH_SUBTYPE,
+ {
+ (UINT8) (END_DEVICE_PATH_LENGTH),
+ (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
+ }
+ }
+};
+
+/**
+ Verifies that the filename has .EFI on the end.
+
+ allocates a new buffer and copies the name (appending .EFI if necessary).
+ Caller to free the buffer.
+
+ @param[in] NameString original name string
+
+ @return the new filename with .efi as the extension.
+**/
+CHAR16 *
+GetExecuatableFileName (
+ IN CONST CHAR16 *NameString
+ )
+{
+ CHAR16 *Buffer;
+ CHAR16 *SuffixStr;
+ if (NameString == NULL) {
+ return (NULL);
+ }
+
+ //
+ // Fix the file name
+ //
+ if (StrnCmp(NameString+StrLen(NameString)-StrLen(L".efi"), L".efi", StrLen(L".efi"))==0) {
+ Buffer = AllocateCopyPool(StrSize(NameString), NameString);
+ } else if (StrnCmp(NameString+StrLen(NameString)-StrLen(L".man"), L".man", StrLen(L".man"))==0) {
+ Buffer = AllocateCopyPool(StrSize(NameString), NameString);
+ if (Buffer != NULL) {
+ SuffixStr = Buffer+StrLen(Buffer)-StrLen(L".man");
+ StrnCpyS (SuffixStr, StrSize(L".man")/sizeof(CHAR16), L".efi", StrLen(L".efi"));
+ }
+ } else {
+ Buffer = AllocateZeroPool(StrSize(NameString) + StrLen(L".efi")*sizeof(CHAR16));
+ if (Buffer != NULL) {
+ StrnCpyS( Buffer,
+ (StrSize(NameString) + StrLen(L".efi")*sizeof(CHAR16))/sizeof(CHAR16),
+ NameString,
+ StrLen(NameString)
+ );
+ StrnCatS( Buffer,
+ (StrSize(NameString) + StrLen(L".efi")*sizeof(CHAR16))/sizeof(CHAR16),
+ L".efi",
+ StrLen(L".efi")
+ );
+ }
+ }
+ return (Buffer);
+
+}
+
/**
Verifies that the filename has .MAN on the end.
@@ -26,7 +103,6 @@
@return the new filename with .man as the extension.
**/
CHAR16 *
-EFIAPI
GetManFileName(
IN CONST CHAR16 *ManFileName
)
@@ -39,15 +115,20 @@ GetManFileName(
// Fix the file name
//
if (StrnCmp(ManFileName+StrLen(ManFileName)-4, L".man", 4)==0) {
- Buffer = AllocateZeroPool(StrSize(ManFileName));
- if (Buffer != NULL) {
- StrCpy(Buffer, ManFileName);
- }
+ Buffer = AllocateCopyPool(StrSize(ManFileName), ManFileName);
} else {
Buffer = AllocateZeroPool(StrSize(ManFileName) + 4*sizeof(CHAR16));
if (Buffer != NULL) {
- StrCpy(Buffer, ManFileName);
- StrCat(Buffer, L".man");
+ StrnCpyS( Buffer,
+ (StrSize(ManFileName) + 4*sizeof(CHAR16))/sizeof(CHAR16),
+ ManFileName,
+ StrLen(ManFileName)
+ );
+ StrnCatS( Buffer,
+ (StrSize(ManFileName) + 4*sizeof(CHAR16))/sizeof(CHAR16),
+ L".man",
+ 4
+ );
}
}
return (Buffer);
@@ -68,7 +149,6 @@ GetManFileName(
@retval EFI_NOT_FOUND The file was not found.
**/
EFI_STATUS
-EFIAPI
SearchPathForFile(
IN CONST CHAR16 *FileName,
OUT SHELL_FILE_HANDLE *Handle
@@ -98,121 +178,6 @@ SearchPathForFile(
return (Status);
}
-/**
- parses through Buffer (which is MAN file formatted) and returns the
- detailed help for any sub section specified in the comma seperated list of
- sections provided. If the end of the file or a .TH section is found then
- return.
-
- Upon a sucessful return the caller is responsible to free the memory in *HelpText
-
- @param[in] Buffer Buffer to read from
- @param[in] Sections name of command's sub sections to find
- @param[in] HelpText pointer to pointer to string where text goes.
- @param[in] HelpSize pointer to size of allocated HelpText (may be updated)
-
- @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
- @retval EFI_SUCCESS the section was found and its description sotred in
- an alloceted buffer.
-**/
-EFI_STATUS
-EFIAPI
-ManBufferFindSections(
- IN CONST CHAR16 *Buffer,
- IN CONST CHAR16 *Sections,
- IN CHAR16 **HelpText,
- IN UINTN *HelpSize
- )
-{
- EFI_STATUS Status;
- CONST CHAR16 *CurrentLocation;
- BOOLEAN CurrentlyReading;
- CHAR16 *SectionName;
- UINTN SectionLen;
- BOOLEAN Found;
- CHAR16 *TempString;
- CHAR16 *TempString2;
-
- if ( Buffer == NULL
- || HelpText == NULL
- || HelpSize == NULL
- ){
- return (EFI_INVALID_PARAMETER);
- }
-
- Status = EFI_SUCCESS;
- CurrentlyReading = FALSE;
- Found = FALSE;
-
- for (CurrentLocation = Buffer,TempString = NULL
- ; CurrentLocation != NULL && *CurrentLocation != CHAR_NULL
- ; CurrentLocation=StrStr(CurrentLocation, L"\r\n"),TempString = NULL
- ){
- while(CurrentLocation[0] == L'\r' || CurrentLocation[0] == L'\n') {
- CurrentLocation++;
- }
- if (CurrentLocation[0] == L'#') {
- //
- // Skip comment lines
- //
- continue;
- }
- if (StrnCmp(CurrentLocation, L".TH", 3) == 0) {
- //
- // we hit the end of this commands section so stop.
- //
- break;
- }
- if (StrnCmp(CurrentLocation, L".SH ", 4) == 0) {
- if (Sections == NULL) {
- CurrentlyReading = TRUE;
- continue;
- } else if (CurrentlyReading) {
- CurrentlyReading = FALSE;
- }
- CurrentLocation += 4;
- //
- // is this a section we want to read in?
- //
- if (StrLen(CurrentLocation)!=0) {
- TempString2 = StrStr(CurrentLocation, L" ");
- TempString2 = MIN(TempString2, StrStr(CurrentLocation, L"\r"));
- TempString2 = MIN(TempString2, StrStr(CurrentLocation, L"\n"));
- ASSERT(TempString == NULL);
- TempString = StrnCatGrow(&TempString, NULL, CurrentLocation, TempString2==NULL?0:TempString2 - CurrentLocation);
- SectionName = TempString;
- SectionLen = StrLen(SectionName);
- SectionName = StrStr(Sections, SectionName);
- if (SectionName == NULL) {
- continue;
- }
- if (*(SectionName + SectionLen) == CHAR_NULL || *(SectionName + SectionLen) == L',') {
- CurrentlyReading = TRUE;
- }
- }
- } else if (CurrentlyReading) {
- Found = TRUE;
- if (StrLen(CurrentLocation)!=0) {
- TempString2 = StrStr(CurrentLocation, L"\r");
- TempString2 = MIN(TempString2, StrStr(CurrentLocation, L"\n"));
- ASSERT(TempString == NULL);
- TempString = StrnCatGrow(&TempString, NULL, CurrentLocation, TempString2==NULL?0:TempString2 - CurrentLocation);
- //
- // copy and save the current line.
- //
- ASSERT((*HelpText == NULL && *HelpSize == 0) || (*HelpText != NULL));
- StrnCatGrow (HelpText, HelpSize, TempString, 0);
- StrnCatGrow (HelpText, HelpSize, L"\r\n", 0);
- }
- }
- SHELL_FREE_NON_NULL(TempString);
- }
- if (!Found && !EFI_ERROR(Status)) {
- return (EFI_NOT_FOUND);
- }
- return (Status);
-}
-
/**
parses through the MAN file specified by SHELL_FILE_HANDLE and returns the
detailed help for any sub section specified in the comma seperated list of
@@ -232,7 +197,6 @@ ManBufferFindSections(
an alloceted buffer.
**/
EFI_STATUS
-EFIAPI
ManFileFindSections(
IN SHELL_FILE_HANDLE Handle,
IN CONST CHAR16 *Sections,
@@ -330,112 +294,153 @@ ManFileFindSections(
}
/**
- parses through the MAN file formatted Buffer and returns the
- "Brief Description" for the .TH section as specified by Command. If the
- command section is not found return EFI_NOT_FOUND.
-
- Upon a sucessful return the caller is responsible to free the memory in *BriefDesc
-
- @param[in] Handle Buffer to read from
- @param[in] Command name of command's section to find
- @param[in] BriefDesc pointer to pointer to string where description goes.
- @param[in] BriefSize pointer to size of allocated BriefDesc
-
- @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
- @retval EFI_SUCCESS the section was found and its description sotred in
- an alloceted buffer.
+ Parses a line from a MAN file to see if it is the Title Header. If it is, then
+ if the "Brief Description" is desired, allocate a buffer for it and return a
+ copy. Upon a sucessful return the caller is responsible to free the memory in
+ *BriefDesc
+
+ Uses a simple state machine that allows "unlimited" whitespace before and after the
+ ".TH", compares Command and the MAN file commnd name without respect to case, and
+ allows "unlimited" whitespace and '0' and '1' characters before the Short Description.
+ The PCRE regex describing this functionality is: ^\s*\.TH\s+(\S)\s[\s01]*(.*)$
+ where group 1 is the Command Name and group 2 is the Short Description.
+
+ @param[in] Command name of command whose MAN file we think Line came from
+ @param[in] Line Pointer to a line from the MAN file
+ @param[out] BriefDesc pointer to pointer to string where description goes.
+ @param[out] BriefSize pointer to size of allocated BriefDesc
+ @param[out] Found TRUE if the Title Header was found and it belongs to Command
+
+ @retval TRUE Line contained the Title Header
+ @retval FALSE Line did not contain the Title Header
**/
-EFI_STATUS
-EFIAPI
-ManBufferFindTitleSection(
- IN CHAR16 **Buffer,
- IN CONST CHAR16 *Command,
- IN CHAR16 **BriefDesc,
- IN UINTN *BriefSize
+BOOLEAN
+IsTitleHeader(
+ IN CONST CHAR16 *Command,
+ IN CHAR16 *Line,
+ OUT CHAR16 **BriefDesc OPTIONAL,
+ OUT UINTN *BriefSize OPTIONAL,
+ OUT BOOLEAN *Found
)
{
- EFI_STATUS Status;
- CHAR16 *TitleString;
- CHAR16 *TitleEnd;
- CHAR16 *CurrentLocation;
+ // The states of a simple state machine used to recognize a title header line
+ // and to extract the Short Description, if desired.
+ typedef enum {
+ LookForThMacro, LookForCommandName, CompareCommands, GetBriefDescription, Final
+ } STATEVALUES;
- if ( Buffer == NULL
- || Command == NULL
- || (BriefDesc != NULL && BriefSize == NULL)
- ){
- return (EFI_INVALID_PARAMETER);
- }
+ STATEVALUES State;
+ UINTN CommandIndex; // Indexes Command as we compare its chars to the MAN file.
+ BOOLEAN ReturnValue; // TRUE if this the Title Header line of *some* MAN file.
+ BOOLEAN ReturnFound; // TRUE if this the Title Header line of *the desired* MAN file.
- Status = EFI_SUCCESS;
+ ReturnValue = FALSE;
+ ReturnFound = FALSE;
+ CommandIndex = 0;
+ State = LookForThMacro;
- TitleString = AllocateZeroPool((7*sizeof(CHAR16)) + StrSize(Command));
- if (TitleString == NULL) {
- return (EFI_OUT_OF_RESOURCES);
- }
- StrCpy(TitleString, L".TH ");
- StrCat(TitleString, Command);
- StrCat(TitleString, L" 0 ");
+ do {
- CurrentLocation = StrStr(*Buffer, TitleString);
- if (CurrentLocation == NULL){
- Status = EFI_NOT_FOUND;
- } else {
- //
- // we found it so copy out the rest of the line into BriefDesc
- // After skipping any spaces or zeroes
- //
- for (CurrentLocation += StrLen(TitleString)
- ; *CurrentLocation == L' ' || *CurrentLocation == L'0' || *CurrentLocation == L'1' || *CurrentLocation == L'\"'
- ; CurrentLocation++);
-
- TitleEnd = StrStr(CurrentLocation, L"\"");
- if (TitleEnd == NULL) {
- Status = EFI_DEVICE_ERROR;
- } else {
- if (BriefDesc != NULL) {
- *BriefSize = StrSize(TitleEnd);
- *BriefDesc = AllocateZeroPool(*BriefSize);
- if (*BriefDesc == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- } else {
- StrnCpy(*BriefDesc, CurrentLocation, TitleEnd-CurrentLocation);
+ if (*Line == L'\0') {
+ break;
+ }
+
+ switch (State) {
+
+ // Handle "^\s*.TH\s"
+ // Go to state LookForCommandName if the title header macro is present; otherwise,
+ // eat white space. If we see something other than white space, this is not a
+ // title header line.
+ case LookForThMacro:
+ if (StrnCmp (L".TH ", Line, 4) == 0 || StrnCmp (L".TH\t", Line, 4) == 0) {
+ Line += 4;
+ State = LookForCommandName;
}
- }
+ else if (*Line == L' ' || *Line == L'\t') {
+ Line++;
+ }
+ else {
+ State = Final;
+ }
+ break;
- for (CurrentLocation = TitleEnd
- ; *CurrentLocation != L'\n'
- ; CurrentLocation++);
- for (
- ; *CurrentLocation == L' ' || *CurrentLocation == L'\n' || *CurrentLocation == L'\r'
- ; CurrentLocation++);
- *Buffer = CurrentLocation;
+ // Handle "\s*"
+ // Eat any "extra" whitespace after the title header macro (we have already seen
+ // at least one white space character). Go to state CompareCommands when a
+ // non-white space is seen.
+ case LookForCommandName:
+ if (*Line == L' ' || *Line == L'\t') {
+ Line++;
+ }
+ else {
+ ReturnValue = TRUE; // This is *some* command's title header line.
+ State = CompareCommands;
+ // Do not increment Line; it points to the first character of the command
+ // name on the title header line.
+ }
+ break;
+
+ // Handle "(\S)\s"
+ // Compare Command to the title header command name, ignoring case. When we
+ // reach the end of the command (i.e. we see white space), the next state
+ // depends on whether the caller wants a copy of the Brief Description.
+ case CompareCommands:
+ if (*Line == L' ' || *Line == L'\t') {
+ ReturnFound = TRUE; // This is the desired command's title header line.
+ State = (BriefDesc == NULL) ? Final : GetBriefDescription;
+ }
+ else if (CharToUpper (*Line) != CharToUpper (*(Command + CommandIndex++))) {
+ State = Final;
+ }
+ Line++;
+ break;
+
+ // Handle "[\s01]*(.*)$"
+ // Skip whitespace, '0', and '1' characters, if any, prior to the brief description.
+ // Return the description to the caller.
+ case GetBriefDescription:
+ if (*Line != L' ' && *Line != L'\t' && *Line != L'0' && *Line != L'1') {
+ *BriefSize = StrSize(Line);
+ *BriefDesc = AllocateZeroPool(*BriefSize);
+ if (*BriefDesc != NULL) {
+ StrCpyS(*BriefDesc, (*BriefSize)/sizeof(CHAR16), Line);
+ }
+ State = Final;
+ }
+ Line++;
+ break;
+
+ default:
+ break;
}
- }
- FreePool(TitleString);
- return (Status);
+ } while (State < Final);
+
+ *Found = ReturnFound;
+ return ReturnValue;
}
/**
parses through the MAN file specified by SHELL_FILE_HANDLE and returns the
- "Brief Description" for the .TH section as specified by Command. if the
+ "Brief Description" for the .TH section as specified by Command. If the
command section is not found return EFI_NOT_FOUND.
Upon a sucessful return the caller is responsible to free the memory in *BriefDesc
- @param[in] Handle FileHandle to read from
- @param[in] Command name of command's section to find
- @param[out] BriefDesc pointer to pointer to string where description goes.
- @param[out] BriefSize pointer to size of allocated BriefDesc
- @param[in,out] Ascii TRUE if the file is ASCII, FALSE otherwise, will be
- set if the file handle is at the 0 position.
+ @param[in] Handle FileHandle to read from
+ @param[in] Command name of command's section to find as entered on the
+ command line (may be a relative or absolute path or
+ be in any case: upper, lower, or mixed in numerous ways!).
+ @param[out] BriefDesc pointer to pointer to string where description goes.
+ @param[out] BriefSize pointer to size of allocated BriefDesc
+ @param[in, out] Ascii TRUE if the file is ASCII, FALSE otherwise, will be
+ set if the file handle is at the 0 position.
@retval EFI_OUT_OF_RESOURCES a memory allocation failed.
- @retval EFI_SUCCESS the section was found and its description sotred in
- an alloceted buffer.
+ @retval EFI_SUCCESS the section was found and its description stored in
+ an allocated buffer if requested.
**/
EFI_STATUS
-EFIAPI
ManFileFindTitleSection(
IN SHELL_FILE_HANDLE Handle,
IN CONST CHAR16 *Command,
@@ -445,12 +450,10 @@ ManFileFindTitleSection(
)
{
EFI_STATUS Status;
- CHAR16 *TitleString;
CHAR16 *ReadLine;
UINTN Size;
- CHAR16 *TitleEnd;
- UINTN TitleLen;
BOOLEAN Found;
+ UINTN Start;
if ( Handle == NULL
|| Command == NULL
@@ -468,57 +471,34 @@ ManFileFindTitleSection(
return (EFI_OUT_OF_RESOURCES);
}
- TitleString = AllocateZeroPool((4*sizeof(CHAR16)) + StrSize(Command));
- if (TitleString == NULL) {
- FreePool(ReadLine);
- return (EFI_OUT_OF_RESOURCES);
+ //
+ // Do not pass any leading path information that may be present to IsTitleHeader().
+ //
+ Start = StrLen(Command);
+ while ((Start != 0)
+ && (*(Command + Start - 1) != L'\\')
+ && (*(Command + Start - 1) != L'/')
+ && (*(Command + Start - 1) != L':')) {
+ --Start;
}
- StrCpy(TitleString, L".TH ");
- StrCat(TitleString, Command);
- TitleLen = StrLen(TitleString);
+
for (;!ShellFileHandleEof(Handle);Size = 1024) {
Status = ShellFileHandleReadLine(Handle, ReadLine, &Size, TRUE, Ascii);
- if (ReadLine[0] == L'#') {
- //
- // Skip comment lines
- //
- continue;
- }
//
// ignore too small of buffer...
//
- if (Status == EFI_BUFFER_TOO_SMALL) {
- Status = EFI_SUCCESS;
- }
- if (EFI_ERROR(Status)) {
+ if (EFI_ERROR(Status) && Status != EFI_BUFFER_TOO_SMALL) {
break;
}
- if (StrnCmp(ReadLine, TitleString, TitleLen) == 0) {
- Found = TRUE;
- //
- // we found it so copy out the rest of the line into BriefDesc
- // After skipping any spaces or zeroes
- //
- for ( TitleEnd = ReadLine+TitleLen
- ; *TitleEnd == L' ' || *TitleEnd == L'0' || *TitleEnd == L'1'
- ; TitleEnd++);
- if (BriefDesc != NULL) {
- *BriefSize = StrSize(TitleEnd);
- *BriefDesc = AllocateZeroPool(*BriefSize);
- if (*BriefDesc == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- break;
- }
- StrCpy(*BriefDesc, TitleEnd);
- }
+
+ Status = EFI_NOT_FOUND;
+ if (IsTitleHeader (Command+Start, ReadLine, BriefDesc, BriefSize, &Found)) {
+ Status = Found ? EFI_SUCCESS : EFI_NOT_FOUND;
break;
}
}
+
FreePool(ReadLine);
- FreePool(TitleString);
- if (!Found && !EFI_ERROR(Status)) {
- return (EFI_NOT_FOUND);
- }
return (Status);
}
@@ -548,11 +528,11 @@ ManFileFindTitleSection(
@retval EFI_SUCCESS The help text was returned.
@retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
returned help text.
- @retval EFI_INVALID_PARAMETER HelpText is NULL
+ @retval EFI_INVALID_PARAMETER HelpText is NULL.
+ @retval EFI_INVALID_PARAMETER ManFileName is invalid.
@retval EFI_NOT_FOUND There is no help text available for Command.
**/
EFI_STATUS
-EFIAPI
ProcessManFile(
IN CONST CHAR16 *ManFileName,
IN CONST CHAR16 *Command,
@@ -563,13 +543,17 @@ ProcessManFile(
{
CHAR16 *TempString;
SHELL_FILE_HANDLE FileHandle;
+ EFI_HANDLE CmdFileImgHandle;
EFI_STATUS Status;
UINTN HelpSize;
UINTN BriefSize;
+ UINTN StringIdWalker;
BOOLEAN Ascii;
- CHAR16 *TempString2;
- EFI_DEVICE_PATH_PROTOCOL *FileDevPath;
- EFI_DEVICE_PATH_PROTOCOL *DevPath;
+ CHAR16 *CmdFileName;
+ CHAR16 *CmdFilePathName;
+ EFI_DEVICE_PATH_PROTOCOL *FileDevPath;
+ EFI_DEVICE_PATH_PROTOCOL *DevPath;
+ EFI_HII_PACKAGE_LIST_HEADER *PackageListHeader;
if ( ManFileName == NULL
|| Command == NULL
@@ -578,30 +562,51 @@ ProcessManFile(
return (EFI_INVALID_PARAMETER);
}
- HelpSize = 0;
- BriefSize = 0;
- TempString = NULL;
+ HelpSize = 0;
+ BriefSize = 0;
+ StringIdWalker = 0;
+ TempString = NULL;
+ Ascii = FALSE;
+ CmdFileName = NULL;
+ CmdFilePathName = NULL;
+ CmdFileImgHandle = NULL;
+ PackageListHeader = NULL;
+ FileDevPath = NULL;
+ DevPath = NULL;
+
//
// See if it's in HII first
//
TempString = ShellCommandGetCommandHelp(Command);
if (TempString != NULL) {
- TempString2 = TempString;
- Status = ManBufferFindTitleSection(&TempString2, Command, BriefDesc, &BriefSize);
+ FileHandle = ConvertEfiFileProtocolToShellHandle (CreateFileInterfaceMem (TRUE), NULL);
+ HelpSize = StrLen (TempString) * sizeof (CHAR16);
+ ShellWriteFile (FileHandle, &HelpSize, TempString);
+ ShellSetFilePosition (FileHandle, 0);
+ HelpSize = 0;
+ BriefSize = 0;
+ Status = ManFileFindTitleSection(FileHandle, Command, BriefDesc, &BriefSize, &Ascii);
if (!EFI_ERROR(Status) && HelpText != NULL){
- Status = ManBufferFindSections(TempString2, Sections, HelpText, &HelpSize);
+ Status = ManFileFindSections(FileHandle, Sections, HelpText, &HelpSize, Ascii);
}
+ ShellCloseFile (&FileHandle);
} else {
+ //
+ // If the image is a external app, check .MAN file first.
+ //
FileHandle = NULL;
TempString = GetManFileName(ManFileName);
+ if (TempString == NULL) {
+ return (EFI_INVALID_PARAMETER);
+ }
Status = SearchPathForFile(TempString, &FileHandle);
if (EFI_ERROR(Status)) {
FileDevPath = FileDevicePath(NULL, TempString);
DevPath = AppendDevicePath (ShellInfoObject.ImageDevPath, FileDevPath);
Status = InternalOpenFileDevicePath(DevPath, &FileHandle, EFI_FILE_MODE_READ, 0);
- FreePool(FileDevPath);
- FreePool(DevPath);
+ SHELL_FREE_NON_NULL(FileDevPath);
+ SHELL_FREE_NON_NULL(DevPath);
}
if (!EFI_ERROR(Status)) {
@@ -612,13 +617,132 @@ ProcessManFile(
Status = ManFileFindSections(FileHandle, Sections, HelpText, &HelpSize, Ascii);
}
ShellInfoObject.NewEfiShellProtocol->CloseFile(FileHandle);
- } else {
+ if (!EFI_ERROR(Status)) {
+ //
+ // Get help text from .MAN file success.
+ //
+ goto Done;
+ }
+ }
+
+ //
+ // Load the app image to check EFI_HII_PACKAGE_LIST_PROTOCOL.
+ //
+ CmdFileName = GetExecuatableFileName(TempString);
+ if (CmdFileName == NULL) {
+ Status = EFI_OUT_OF_RESOURCES;
+ goto Done;
+ }
+ //
+ // If the file in CWD then use the file name, else use the full
+ // path name.
+ //
+ CmdFilePathName = ShellFindFilePath(CmdFileName);
+ if (CmdFilePathName == NULL) {
+ Status = EFI_NOT_FOUND;
+ goto Done;
+ }
+ DevPath = ShellInfoObject.NewEfiShellProtocol->GetDevicePathFromFilePath(CmdFilePathName);
+ Status = gBS->LoadImage(FALSE, gImageHandle, DevPath, NULL, 0, &CmdFileImgHandle);
+ if(EFI_ERROR(Status)) {
*HelpText = NULL;
+ goto Done;
+ }
+ Status = gBS->OpenProtocol(
+ CmdFileImgHandle,
+ &gEfiHiiPackageListProtocolGuid,
+ (VOID**)&PackageListHeader,
+ gImageHandle,
+ NULL,
+ EFI_OPEN_PROTOCOL_GET_PROTOCOL
+ );
+ if(EFI_ERROR(Status)) {
+ *HelpText = NULL;
+ goto Done;
+ }
+
+ //
+ // If get package list on image handle, install it on HiiDatabase.
+ //
+ Status = gBS->InstallProtocolInterface (
+ &mShellManDriverHandle,
+ &gEfiDevicePathProtocolGuid,
+ EFI_NATIVE_INTERFACE,
+ &mShellManHiiDevicePath
+ );
+ if (EFI_ERROR(Status)) {
+ goto Done;
}
+
+ Status = gHiiDatabase->NewPackageList (
+ gHiiDatabase,
+ PackageListHeader,
+ mShellManDriverHandle,
+ &mShellManHiiHandle
+ );
+ if (EFI_ERROR (Status)) {
+ goto Done;
+ }
+
+ StringIdWalker = 1;
+ do {
+ SHELL_FREE_NON_NULL(TempString);
+ if (BriefDesc != NULL) {
+ SHELL_FREE_NON_NULL(*BriefDesc);
+ }
+ TempString = HiiGetString (mShellManHiiHandle, (EFI_STRING_ID)StringIdWalker, NULL);
+ if (TempString == NULL) {
+ Status = EFI_NOT_FOUND;
+ goto Done;
+ }
+ FileHandle = ConvertEfiFileProtocolToShellHandle (CreateFileInterfaceMem (TRUE), NULL);
+ HelpSize = StrLen (TempString) * sizeof (CHAR16);
+ ShellWriteFile (FileHandle, &HelpSize, TempString);
+ ShellSetFilePosition (FileHandle, 0);
+ HelpSize = 0;
+ BriefSize = 0;
+ Status = ManFileFindTitleSection(FileHandle, Command, BriefDesc, &BriefSize, &Ascii);
+ if (!EFI_ERROR(Status) && HelpText != NULL){
+ Status = ManFileFindSections(FileHandle, Sections, HelpText, &HelpSize, Ascii);
+ }
+ ShellCloseFile (&FileHandle);
+ if (!EFI_ERROR(Status)){
+ //
+ // Found what we need and return
+ //
+ goto Done;
+ }
+
+ StringIdWalker += 1;
+ } while (StringIdWalker < 0xFFFF && TempString != NULL);
+
}
- if (TempString != NULL) {
- FreePool(TempString);
+
+Done:
+ if (mShellManDriverHandle != NULL) {
+ gBS->UninstallProtocolInterface (
+ mShellManDriverHandle,
+ &gEfiDevicePathProtocolGuid,
+ &mShellManHiiDevicePath
+ );
+ mShellManDriverHandle = NULL;
}
+ if (mShellManHiiHandle != NULL) {
+ HiiRemovePackages (mShellManHiiHandle);
+ mShellManHiiHandle = NULL;
+ }
+
+ if (CmdFileImgHandle != NULL) {
+ Status = gBS->UnloadImage (CmdFileImgHandle);
+ }
+
+ SHELL_FREE_NON_NULL(TempString);
+ SHELL_FREE_NON_NULL(CmdFileName);
+ SHELL_FREE_NON_NULL(CmdFilePathName);
+ SHELL_FREE_NON_NULL(FileDevPath);
+ SHELL_FREE_NON_NULL(DevPath);
+
return (Status);
}
+