sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ShellPkg: Add ShellPrintHelp function to ShellLib.

Browse Source 
This function allows for easier access to printing standard command help.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Matt Stanbro <Matthew.A.Stanbro@intel.com>
Reviewed-by: Jaben Carsey <Jaben.carsey@intel.com>

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@14159 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jcarsey
2013-03-04 21:54:02 +00:00
parent fb2ae5fdb5
commit 365aa98a5d
2 changed files with 79 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
ShellPkg/Include/Library/ShellLib.h
View File

@ -1357,4 +1357,23 @@ ShellDeleteFileByName(
IN CONST CHAR16 *FileName IN CONST CHAR16 *FileName
); );
/**
Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
@param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
@param[in] SectionToGetHelpOn Pointer to the section specifier(s).
@param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
the help content only.
@retval EFI_DEVICE_ERROR The help data format was incorrect.
@retval EFI_NOT_FOUND The help data could not be found.
@retval EFI_SUCCESS The operation was successful.
**/
EFI_STATUS
EFIAPI
ShellPrintHelp (
IN CONST CHAR16 *CommandToGetHelpOn,
IN CONST CHAR16 *SectionToGetHelpOn,
IN BOOLEAN PrintCommandText
);
#endif // __SHELL_LIB__ #endif // __SHELL_LIB__

60
ShellPkg/Library/UefiShellLib/UefiShellLib.c
View File

@ -4060,6 +4060,66 @@ ShellFileHandleReadLine(
return (Status); return (Status);
} }
/**
Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
@param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
@param[in] SectionToGetHelpOn Pointer to the section specifier(s).
@param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
the help content only.
@retval EFI_DEVICE_ERROR The help data format was incorrect.
@retval EFI_NOT_FOUND The help data could not be found.
@retval EFI_SUCCESS The operation was successful.
**/
EFI_STATUS
EFIAPI
ShellPrintHelp (
IN CONST CHAR16 *CommandToGetHelpOn,
IN CONST CHAR16 *SectionToGetHelpOn,
IN BOOLEAN PrintCommandText
)
{
EFI_STATUS Status;
CHAR16 *OutText;
OutText = NULL;
//
// Get the string to print based
//
Status = gEfiShellProtocol->GetHelpText (CommandToGetHelpOn, SectionToGetHelpOn, &OutText);
//
// make sure we got a valid string
//
if (EFI_ERROR(Status)){
return Status;
}
if (OutText == NULL || StrLen(OutText) == 0) {
return EFI_NOT_FOUND;
}
//
// Chop off trailing stuff we dont need
//
while (OutText[StrLen(OutText)-1] == L'\r' || OutText[StrLen(OutText)-1] == L'\n' || OutText[StrLen(OutText)-1] == L' ') {
OutText[StrLen(OutText)-1] = CHAR_NULL;
}
//
// Print this out to the console
//
if (PrintCommandText) {
ShellPrintEx(-1, -1, L"%H%-14s%N- %s\r\n", CommandToGetHelpOn, OutText);
} else {
ShellPrintEx(-1, -1, L"%N%s\r\n", OutText);
}
SHELL_FREE_NON_NULL(OutText);
return EFI_SUCCESS;
}
/** /**
Function to delete a file by name Function to delete a file by name