/** @file\r
Provides interface to shell MAN file parser.\r
\r
- Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>\r
Copyright 2015 Dell Inc.\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
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
}\r
};\r
\r
-\r
-/**\r
- Convert a Unicode character to upper case only if\r
- it maps to a valid small-case ASCII character.\r
-\r
- This internal function only deal with Unicode character\r
- which maps to a valid small-case ASCII character, i.e.\r
- L'a' to L'z'. For other Unicode character, the input character\r
- is returned directly.\r
-\r
- @param Char The character to convert.\r
-\r
- @retval LowerCharacter If the Char is with range L'a' to L'z'.\r
- @retval Unchanged Otherwise.\r
-\r
-**/\r
-CHAR16\r
-EFIAPI \r
-InternalShellCharToUpper (\r
- IN CHAR16 Char\r
- );\r
-\r
/**\r
Verifies that the filename has .EFI on the end.\r
\r
@return the new filename with .efi as the extension.\r
**/\r
CHAR16 *\r
-EFIAPI\r
GetExecuatableFileName (\r
IN CONST CHAR16 *NameString\r
)\r
@return the new filename with .man as the extension.\r
**/\r
CHAR16 *\r
-EFIAPI\r
GetManFileName(\r
IN CONST CHAR16 *ManFileName\r
)\r
} else {\r
Buffer = AllocateZeroPool(StrSize(ManFileName) + 4*sizeof(CHAR16));\r
if (Buffer != NULL) {\r
- StrnCpyS( Buffer, \r
- (StrSize(ManFileName) + 4*sizeof(CHAR16))/sizeof(CHAR16), \r
- ManFileName, \r
+ StrnCpyS( Buffer,\r
+ (StrSize(ManFileName) + 4*sizeof(CHAR16))/sizeof(CHAR16),\r
+ ManFileName,\r
StrLen(ManFileName)\r
);\r
- StrnCatS( Buffer, \r
+ StrnCatS( Buffer,\r
(StrSize(ManFileName) + 4*sizeof(CHAR16))/sizeof(CHAR16),\r
- L".man", \r
+ L".man",\r
4\r
);\r
}\r
@retval EFI_NOT_FOUND The file was not found.\r
**/\r
EFI_STATUS\r
-EFIAPI\r
SearchPathForFile(\r
IN CONST CHAR16 *FileName,\r
OUT SHELL_FILE_HANDLE *Handle\r
return (Status);\r
}\r
\r
-/**\r
- parses through Buffer (which is MAN file formatted) and returns the\r
- detailed help for any sub section specified in the comma seperated list of\r
- sections provided. If the end of the file or a .TH section is found then\r
- return.\r
-\r
- Upon a sucessful return the caller is responsible to free the memory in *HelpText\r
-\r
- @param[in] Buffer Buffer to read from\r
- @param[in] Sections name of command's sub sections to find\r
- @param[in] HelpText pointer to pointer to string where text goes.\r
- @param[in] HelpSize pointer to size of allocated HelpText (may be updated)\r
-\r
- @retval EFI_OUT_OF_RESOURCES a memory allocation failed.\r
- @retval EFI_SUCCESS the section was found and its description sotred in\r
- an alloceted buffer.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ManBufferFindSections(\r
- IN CONST CHAR16 *Buffer,\r
- IN CONST CHAR16 *Sections,\r
- IN CHAR16 **HelpText,\r
- IN UINTN *HelpSize\r
- )\r
-{\r
- EFI_STATUS Status;\r
- CONST CHAR16 *CurrentLocation;\r
- BOOLEAN CurrentlyReading;\r
- CHAR16 *SectionName;\r
- UINTN SectionLen;\r
- BOOLEAN Found;\r
- CHAR16 *TempString;\r
- CHAR16 *TempString2;\r
-\r
- if ( Buffer == NULL\r
- || HelpText == NULL\r
- || HelpSize == NULL\r
- ){\r
- return (EFI_INVALID_PARAMETER);\r
- }\r
-\r
- Status = EFI_SUCCESS;\r
- CurrentlyReading = FALSE;\r
- Found = FALSE;\r
-\r
- for (CurrentLocation = Buffer,TempString = NULL\r
- ; CurrentLocation != NULL && *CurrentLocation != CHAR_NULL\r
- ; CurrentLocation=StrStr(CurrentLocation, L"\r\n"),TempString = NULL\r
- ){\r
- while(CurrentLocation[0] == L'\r' || CurrentLocation[0] == L'\n') {\r
- CurrentLocation++;\r
- }\r
- if (CurrentLocation[0] == L'#') {\r
- //\r
- // Skip comment lines\r
- //\r
- continue;\r
- }\r
- if (StrnCmp(CurrentLocation, L".TH", 3) == 0) {\r
- //\r
- // we hit the end of this commands section so stop.\r
- //\r
- break;\r
- }\r
- if (StrnCmp(CurrentLocation, L".SH ", 4) == 0) {\r
- if (Sections == NULL) {\r
- CurrentlyReading = TRUE;\r
- continue;\r
- } else if (CurrentlyReading) {\r
- CurrentlyReading = FALSE;\r
- }\r
- CurrentLocation += 4;\r
- //\r
- // is this a section we want to read in?\r
- //\r
- if (StrLen(CurrentLocation)!=0) {\r
- TempString2 = StrStr(CurrentLocation, L" ");\r
- TempString2 = MIN(TempString2, StrStr(CurrentLocation, L"\r"));\r
- TempString2 = MIN(TempString2, StrStr(CurrentLocation, L"\n"));\r
- ASSERT(TempString == NULL);\r
- TempString = StrnCatGrow(&TempString, NULL, CurrentLocation, TempString2==NULL?0:TempString2 - CurrentLocation);\r
- if (TempString == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- break;\r
- }\r
- SectionName = TempString;\r
- SectionLen = StrLen(SectionName);\r
- SectionName = StrStr(Sections, SectionName);\r
- if (SectionName == NULL) {\r
- SHELL_FREE_NON_NULL(TempString);\r
- continue;\r
- }\r
- if (*(SectionName + SectionLen) == CHAR_NULL || *(SectionName + SectionLen) == L',') {\r
- CurrentlyReading = TRUE;\r
- }\r
- }\r
- } else if (CurrentlyReading) {\r
- Found = TRUE;\r
- if (StrLen(CurrentLocation)!=0) {\r
- TempString2 = StrStr(CurrentLocation, L"\r");\r
- TempString2 = MIN(TempString2, StrStr(CurrentLocation, L"\n"));\r
- ASSERT(TempString == NULL);\r
- TempString = StrnCatGrow(&TempString, NULL, CurrentLocation, TempString2==NULL?0:TempString2 - CurrentLocation);\r
- if (TempString == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- break;\r
- }\r
- //\r
- // copy and save the current line.\r
- //\r
- ASSERT((*HelpText == NULL && *HelpSize == 0) || (*HelpText != NULL));\r
- StrnCatGrow (HelpText, HelpSize, TempString, 0);\r
- if (HelpText == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- break;\r
- }\r
- StrnCatGrow (HelpText, HelpSize, L"\r\n", 0);\r
- if (HelpText == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- break;\r
- }\r
- }\r
- }\r
- SHELL_FREE_NON_NULL(TempString);\r
- }\r
- SHELL_FREE_NON_NULL(TempString);\r
- if (!Found && !EFI_ERROR(Status)) {\r
- return (EFI_NOT_FOUND);\r
- }\r
- return (Status);\r
-}\r
-\r
/**\r
parses through the MAN file specified by SHELL_FILE_HANDLE and returns the\r
detailed help for any sub section specified in the comma seperated list of\r
an alloceted buffer.\r
**/\r
EFI_STATUS\r
-EFIAPI\r
ManFileFindSections(\r
IN SHELL_FILE_HANDLE Handle,\r
IN CONST CHAR16 *Sections,\r
return (Status);\r
}\r
\r
-/**\r
- parses through the MAN file formatted Buffer and returns the\r
- "Brief Description" for the .TH section as specified by Command. If the\r
- command section is not found return EFI_NOT_FOUND.\r
-\r
- Upon a sucessful return the caller is responsible to free the memory in *BriefDesc\r
-\r
- @param[in] Buffer Buffer to read from\r
- @param[in] Command name of command's section to find\r
- @param[in] BriefDesc pointer to pointer to string where description goes.\r
- @param[in] BriefSize pointer to size of allocated BriefDesc\r
-\r
- @retval EFI_OUT_OF_RESOURCES a memory allocation failed.\r
- @retval EFI_SUCCESS the section was found and its description sotred in\r
- an alloceted buffer.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ManBufferFindTitleSection(\r
- IN CHAR16 **Buffer,\r
- IN CONST CHAR16 *Command,\r
- IN CHAR16 **BriefDesc,\r
- IN UINTN *BriefSize\r
- )\r
-{\r
- EFI_STATUS Status;\r
- CHAR16 *TitleString;\r
- CHAR16 *TitleEnd;\r
- CHAR16 *CurrentLocation;\r
- UINTN TitleLength;\r
- UINTN Start;\r
- CONST CHAR16 StartString[] = L".TH ";\r
- CONST CHAR16 EndString[] = L" 0 ";\r
-\r
- if ( Buffer == NULL\r
- || Command == NULL\r
- || (BriefDesc != NULL && BriefSize == NULL)\r
- ){\r
- return (EFI_INVALID_PARAMETER);\r
- }\r
-\r
- Status = EFI_SUCCESS;\r
-\r
- //\r
- // Do not pass any leading path information that may be present to IsTitleHeader().\r
- //\r
- Start = StrLen(Command);\r
- while ((Start != 0)\r
- && (*(Command + Start - 1) != L'\\')\r
- && (*(Command + Start - 1) != L'/')\r
- && (*(Command + Start - 1) != L':')) {\r
- --Start;\r
- }\r
-\r
- //\r
- // more characters for StartString and EndString\r
- //\r
- TitleLength = StrSize(Command + Start) + (StrLen(StartString) + StrLen(EndString)) * sizeof(CHAR16);\r
- TitleString = AllocateZeroPool(TitleLength);\r
- if (TitleString == NULL) {\r
- return (EFI_OUT_OF_RESOURCES);\r
- }\r
- StrCpyS(TitleString, TitleLength/sizeof(CHAR16), StartString);\r
- StrCatS(TitleString, TitleLength/sizeof(CHAR16), Command + Start);\r
- StrCatS(TitleString, TitleLength/sizeof(CHAR16), EndString);\r
-\r
- CurrentLocation = StrStr(*Buffer, TitleString);\r
- if (CurrentLocation == NULL){\r
- Status = EFI_NOT_FOUND;\r
- } else {\r
- //\r
- // we found it so copy out the rest of the line into BriefDesc\r
- // After skipping any spaces or zeroes\r
- //\r
- for (CurrentLocation += StrLen(TitleString)\r
- ; *CurrentLocation == L' ' || *CurrentLocation == L'0' || *CurrentLocation == L'1' || *CurrentLocation == L'\"'\r
- ; CurrentLocation++);\r
-\r
- TitleEnd = StrStr(CurrentLocation, L"\"");\r
- if (TitleEnd == NULL) {\r
- Status = EFI_DEVICE_ERROR;\r
- } else {\r
- if (BriefDesc != NULL) {\r
- *BriefSize = StrSize(TitleEnd);\r
- *BriefDesc = AllocateZeroPool(*BriefSize);\r
- if (*BriefDesc == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- } else {\r
- StrnCpyS(*BriefDesc, (*BriefSize)/sizeof(CHAR16), CurrentLocation, TitleEnd-CurrentLocation);\r
- }\r
- }\r
-\r
- for (CurrentLocation = TitleEnd\r
- ; *CurrentLocation != L'\n'\r
- ; CurrentLocation++);\r
- for (\r
- ; *CurrentLocation == L' ' || *CurrentLocation == L'\n' || *CurrentLocation == L'\r'\r
- ; CurrentLocation++);\r
- *Buffer = CurrentLocation;\r
- }\r
- }\r
-\r
- FreePool(TitleString);\r
- return (Status);\r
-}\r
-\r
/**\r
Parses a line from a MAN file to see if it is the Title Header. If it is, then\r
if the "Brief Description" is desired, allocate a buffer for it and return a\r
ReturnFound = TRUE; // This is the desired command's title header line.\r
State = (BriefDesc == NULL) ? Final : GetBriefDescription;\r
}\r
- else if (InternalShellCharToUpper (*Line) != InternalShellCharToUpper (*(Command + CommandIndex++))) {\r
+ else if (CharToUpper (*Line) != CharToUpper (*(Command + CommandIndex++))) {\r
State = Final;\r
}\r
Line++;\r
an allocated buffer if requested.\r
**/\r
EFI_STATUS\r
-EFIAPI\r
ManFileFindTitleSection(\r
IN SHELL_FILE_HANDLE Handle,\r
IN CONST CHAR16 *Command,\r
@retval EFI_NOT_FOUND There is no help text available for Command.\r
**/\r
EFI_STATUS\r
-EFIAPI\r
ProcessManFile(\r
IN CONST CHAR16 *ManFileName,\r
IN CONST CHAR16 *Command,\r
UINTN BriefSize;\r
UINTN StringIdWalker;\r
BOOLEAN Ascii;\r
- CHAR16 *TempString2;\r
CHAR16 *CmdFileName;\r
CHAR16 *CmdFilePathName;\r
- CHAR16 *StringBuff;\r
EFI_DEVICE_PATH_PROTOCOL *FileDevPath;\r
EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
EFI_HII_PACKAGE_LIST_HEADER *PackageListHeader;\r
CmdFileName = NULL;\r
CmdFilePathName = NULL;\r
CmdFileImgHandle = NULL;\r
- StringBuff = NULL;\r
PackageListHeader = NULL;\r
FileDevPath = NULL;\r
DevPath = NULL;\r
//\r
TempString = ShellCommandGetCommandHelp(Command);\r
if (TempString != NULL) {\r
- TempString2 = TempString;\r
- Status = ManBufferFindTitleSection(&TempString2, Command, BriefDesc, &BriefSize);\r
+ FileHandle = ConvertEfiFileProtocolToShellHandle (CreateFileInterfaceMem (TRUE), NULL);\r
+ HelpSize = StrLen (TempString) * sizeof (CHAR16);\r
+ ShellWriteFile (FileHandle, &HelpSize, TempString);\r
+ ShellSetFilePosition (FileHandle, 0);\r
+ HelpSize = 0;\r
+ BriefSize = 0;\r
+ Status = ManFileFindTitleSection(FileHandle, Command, BriefDesc, &BriefSize, &Ascii);\r
if (!EFI_ERROR(Status) && HelpText != NULL){\r
- Status = ManBufferFindSections(TempString2, Sections, HelpText, &HelpSize);\r
+ Status = ManFileFindSections(FileHandle, Sections, HelpText, &HelpSize, Ascii);\r
}\r
+ ShellCloseFile (&FileHandle);\r
} else {\r
//\r
// If the image is a external app, check .MAN file first.\r
\r
StringIdWalker = 1;\r
do {\r
- SHELL_FREE_NON_NULL(StringBuff);\r
+ SHELL_FREE_NON_NULL(TempString);\r
if (BriefDesc != NULL) {\r
SHELL_FREE_NON_NULL(*BriefDesc);\r
}\r
- StringBuff = HiiGetString (mShellManHiiHandle, (EFI_STRING_ID)StringIdWalker, NULL);\r
- if (StringBuff == NULL) {\r
+ TempString = HiiGetString (mShellManHiiHandle, (EFI_STRING_ID)StringIdWalker, NULL);\r
+ if (TempString == NULL) {\r
Status = EFI_NOT_FOUND;\r
goto Done;\r
}\r
- TempString2 = StringBuff;\r
- Status = ManBufferFindTitleSection(&TempString2, Command, BriefDesc, &BriefSize);\r
+ FileHandle = ConvertEfiFileProtocolToShellHandle (CreateFileInterfaceMem (TRUE), NULL);\r
+ HelpSize = StrLen (TempString) * sizeof (CHAR16);\r
+ ShellWriteFile (FileHandle, &HelpSize, TempString);\r
+ ShellSetFilePosition (FileHandle, 0);\r
+ HelpSize = 0;\r
+ BriefSize = 0;\r
+ Status = ManFileFindTitleSection(FileHandle, Command, BriefDesc, &BriefSize, &Ascii);\r
if (!EFI_ERROR(Status) && HelpText != NULL){\r
- Status = ManBufferFindSections(TempString2, Sections, HelpText, &HelpSize);\r
+ Status = ManFileFindSections(FileHandle, Sections, HelpText, &HelpSize, Ascii);\r
}\r
+ ShellCloseFile (&FileHandle);\r
if (!EFI_ERROR(Status)){\r
//\r
// Found what we need and return\r
}\r
\r
StringIdWalker += 1;\r
- } while (StringIdWalker < 0xFFFF && StringBuff != NULL);\r
+ } while (StringIdWalker < 0xFFFF && TempString != NULL);\r
\r
}\r
\r
Status = gBS->UnloadImage (CmdFileImgHandle);\r
}\r
\r
- SHELL_FREE_NON_NULL(StringBuff);\r
SHELL_FREE_NON_NULL(TempString);\r
SHELL_FREE_NON_NULL(CmdFileName);\r
SHELL_FREE_NON_NULL(CmdFilePathName);\r
projects / mirror_edk2.git / blobdiff