From e2f8297f9cd71ade709cc0e0e3bc310dd11e6917 Mon Sep 17 00:00:00 2001 From: jcarsey Date: Tue, 1 Dec 2009 05:40:24 +0000 Subject: [PATCH] updates from code review, buffer length, and correct use of StdOut for printing git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9499 6f19259b-4bc3-4df7-8a09-765794883524 --- ShellPkg/Library/UefiShellLib/UefiShellLib.c | 63 +++++++++++++++---- .../Library/UefiShellLib/UefiShellLib.inf | 5 +- 2 files changed, 54 insertions(+), 14 deletions(-) diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.c b/ShellPkg/Library/UefiShellLib/UefiShellLib.c index b1128ffc14..ae76b42080 100644 --- a/ShellPkg/Library/UefiShellLib/UefiShellLib.c +++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.c @@ -54,6 +54,8 @@ STATIC EFI_SHELL_PARAMETERS_PROTOCOL *mEfiShellParametersProtocol; STATIC EFI_HANDLE mEfiShellEnvironment2Handle; STATIC FILE_HANDLE_FUNCTION_MAP FileFunctionMap; STATIC UINTN mTotalParameterCount; +STATIC EFI_FILE_HANDLE StdOut; +STATIC EFI_FILE_HANDLE StdErr; /** Check if a Unicode character is a hexadecimal character. @@ -2244,6 +2246,34 @@ CopyReplace( return (EFI_SUCCESS); } +/** + Internal worker function to output a string. + + This function will output a string to the correct StdOut. + + @param[in] String The string to print out. + + @retval EFI_SUCCESS The operation was sucessful. + @retval !EFI_SUCCESS The operation failed. +**/ +EFI_STATUS +EFIAPI +InternalPrintTo ( + IN CONST CHAR16 *String + ) +{ + UINTN Size; + Size = StrSize(String) - sizeof(CHAR16); + if (mEfiShellParametersProtocol != NULL) { + return (mEfiShellParametersProtocol->StdOut->Write(mEfiShellParametersProtocol->StdOut, &Size, (VOID*)String)); + } + if (mEfiShellInterface != NULL) { + return ( mEfiShellInterface->StdOut->Write(mEfiShellInterface->StdOut, &Size, (VOID*)String)); + } + ASSERT(FALSE); + return (EFI_UNSUPPORTED); +} + /** Print at a specific location on the screen. @@ -2291,7 +2321,8 @@ InternalShellPrintWorker( CHAR16 *ResumeLocation; CHAR16 *FormatWalker; - BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16); + BufferSize = PcdGet16 (PcdShellLibMaxPrintBufferSize); + ASSERT(PcdGet16 (PcdShellLibMaxPrintBufferSize) < PcdGet32 (PcdMaximumUnicodeStringLength)); PostReplaceFormat = AllocateZeroPool (BufferSize); ASSERT (PostReplaceFormat != NULL); PostReplaceFormat2 = AllocateZeroPool (BufferSize); @@ -2336,7 +2367,7 @@ InternalShellPrintWorker( // // print the current FormatWalker string // - Status = gST->ConOut->OutputString(gST->ConOut, FormatWalker); + Status = InternalPrintTo(FormatWalker); ASSERT_EFI_ERROR(Status); // // update the attribute @@ -2359,7 +2390,12 @@ InternalShellPrintWorker( gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_GREEN, ((NormalAttribute&(BIT4|BIT5|BIT6))>>4))); break; default: - ASSERT(FALSE); + // + // Print a simple '%' symbol + // + Status = InternalPrintTo(L"%"); + ASSERT_EFI_ERROR(Status); + ResumeLocation = ResumeLocation - 1; break; } } else { @@ -2384,13 +2420,13 @@ InternalShellPrintWorker( /** Print at a specific location on the screen. - This function will move the cursor to a given screen location and print the specified string + This function will move the cursor to a given screen location and print the specified string. If -1 is specified for either the Row or Col the current screen location for BOTH will be used. - if either Row or Col is out of range for the current console, then ASSERT - if Format is NULL, then ASSERT + If either Row or Col is out of range for the current console, then ASSERT. + If Format is NULL, then ASSERT. In addition to the standard %-based flags as supported by UefiLib Print() this supports the following additional flags: @@ -2419,21 +2455,23 @@ ShellPrintEx( ) { VA_LIST Marker; + EFI_STATUS Status; VA_START (Marker, Format); - return (InternalShellPrintWorker(Col, Row, Format, Marker)); + Status = InternalShellPrintWorker(Col, Row, Format, Marker); + VA_END(Marker); + return(Status); } /** Print at a specific location on the screen. - This function will move the cursor to a given screen location, print the specified string, - and return the cursor to the original locaiton. + This function will move the cursor to a given screen location and print the specified string. If -1 is specified for either the Row or Col the current screen location for BOTH - will be used and the cursor's position will not be moved back to an original location. + will be used. - if either Row or Col is out of range for the current console, then ASSERT - if Format is NULL, then ASSERT + If either Row or Col is out of range for the current console, then ASSERT. + If Format is NULL, then ASSERT. In addition to the standard %-based flags as supported by UefiLib Print() this supports the following additional flags: @@ -2473,6 +2511,7 @@ ShellPrintHiiEx( RetVal = InternalShellPrintWorker(Col, Row, HiiFormatString, Marker); FreePool(HiiFormatString); + VA_END(Marker); return (RetVal); } diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.inf b/ShellPkg/Library/UefiShellLib/UefiShellLib.inf index 832028b73d..28fe893033 100644 --- a/ShellPkg/Library/UefiShellLib/UefiShellLib.inf +++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.inf @@ -64,5 +64,6 @@ gEfiShellEnvironment2ExtGuid # ALWAYS_CONSUMED [Pcd.common] - gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize # ALWAYS_CONSUMED - gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize # ALWAYS_CONSUMED + gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize # ALWAYS_CONSUMED + gEfiShellPkgTokenSpaceGuid.PcdShellLibMaxPrintBufferSize # ALWAYS_CONSUMED + gEfiMdePkgTokenSpaceGuid.PcdMaximumUnicodeStringLength # ALWAYS_CONSUMED \ No newline at end of file -- 2.39.2