Correct all header files for doxygen format and correct the license issue for VgaClas...

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / SetupBrowserDxe / Print.c

/**@file\r
  Basic Ascii AvSPrintf() function named VSPrint(). VSPrint() enables very\r
  simple implemenation of SPrint() and Print() to support debug.\r
\r
  You can not Print more than EFI_DRIVER_LIB_MAX_PRINT_BUFFER characters at a\r
  time. This makes the implementation very simple.\r
\r
  VSPrint, Print, SPrint format specification has the follwoing form\r
\r
  %type\r
\r
  type:\r
    'S','s' - argument is an Unicode string\r
    'c' - argument is an ascii character\r
    '%' - Print a %\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. 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
\r
**/\r
\r
#include "Print.h"\r
\r
STATIC\r
UINTN\r
_IPrint (\r
  IN UINTN                            Column,\r
  IN UINTN                            Row,\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  *Out,\r
  IN CHAR16                           *fmt,\r
  IN VA_LIST                          args\r
  )\r
//\r
// Display string worker for: Print, PrintAt, IPrint, IPrintAt\r
//\r
{\r
  CHAR16  *Buffer;\r
  CHAR16  *BackupBuffer;\r
  UINTN   Index;\r
  UINTN   PreviousIndex;\r
\r
  //\r
  // For now, allocate an arbitrarily long buffer\r
  //\r
  Buffer        = AllocateZeroPool (0x10000);\r
  BackupBuffer  = AllocateZeroPool (0x10000);\r
  ASSERT (Buffer);\r
  ASSERT (BackupBuffer);\r
\r
  if (Column != (UINTN) -1) {\r
    Out->SetCursorPosition (Out, Column, Row);\r
  }\r
\r
  UnicodeVSPrint (Buffer, 0x10000, fmt, args);\r
\r
  Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;\r
\r
  Out->SetAttribute (Out, Out->Mode->Attribute);\r
\r
  Index         = 0;\r
  PreviousIndex = 0;\r
\r
  do {\r
    for (; (Buffer[Index] != NARROW_CHAR) && (Buffer[Index] != WIDE_CHAR) && (Buffer[Index] != 0); Index++) {\r
      BackupBuffer[Index] = Buffer[Index];\r
    }\r
\r
    if (Buffer[Index] == 0) {\r
      break;\r
    }\r
    //\r
    // Null-terminate the temporary string\r
    //\r
    BackupBuffer[Index] = 0;\r
\r
    //\r
    // Print this out, we are about to switch widths\r
    //\r
    Out->OutputString (Out, &BackupBuffer[PreviousIndex]);\r
\r
    //\r
    // Preserve the current index + 1, since this is where we will start printing from next\r
    //\r
    PreviousIndex = Index + 1;\r
\r
    //\r
    // We are at a narrow or wide character directive.  Set attributes and strip it and print it\r
    //\r
    if (Buffer[Index] == NARROW_CHAR) {\r
      //\r
      // Preserve bits 0 - 6 and zero out the rest\r
      //\r
      Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;\r
      Out->SetAttribute (Out, Out->Mode->Attribute);\r
    } else {\r
      //\r
      // Must be wide, set bit 7 ON\r
      //\r
      Out->Mode->Attribute = Out->Mode->Attribute | EFI_WIDE_ATTRIBUTE;\r
      Out->SetAttribute (Out, Out->Mode->Attribute);\r
    }\r
\r
    Index++;\r
\r
  } while (Buffer[Index] != 0);\r
\r
  //\r
  // We hit the end of the string - print it\r
  //\r
  Out->OutputString (Out, &BackupBuffer[PreviousIndex]);\r
\r
  FreePool (Buffer);\r
  FreePool (BackupBuffer);\r
  return EFI_SUCCESS;\r
}\r
\r
UINTN\r
Print (\r
  IN CHAR16   *fmt,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
    Prints a formatted unicode string to the default console\r
\r
Arguments:\r
\r
    fmt         - Format string\r
\r
Returns:\r
\r
    Length of string printed to the console\r
\r
--*/\r
{\r
  VA_LIST args;\r
\r
  VA_START (args, fmt);\r
  return _IPrint ((UINTN) -1, (UINTN) -1, gST->ConOut, fmt, args);\r
}\r
\r
UINTN\r
PrintString (\r
  CHAR16       *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Prints a unicode string to the default console,\r
  using L"%s" format.\r
\r
Arguments:\r
\r
  String      - String pointer.\r
\r
Returns:\r
\r
  Length of string printed to the console\r
\r
--*/\r
{\r
  return Print ((CHAR16 *) L"%s", String);\r
}\r
\r
UINTN\r
PrintChar (\r
  CHAR16       Character\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Prints a chracter to the default console,\r
  using L"%c" format.\r
\r
Arguments:\r
\r
  Character   - Character to print.\r
\r
Returns:\r
\r
  Length of string printed to the console.\r
\r
--*/\r
{\r
  return Print ((CHAR16 *) L"%c", Character);\r
}\r
\r
UINTN\r
PrintAt (\r
  IN UINTN     Column,\r
  IN UINTN     Row,\r
  IN CHAR16    *fmt,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Prints a formatted unicode string to the default console, at\r
  the supplied cursor position\r
\r
Arguments:\r
\r
  Column, Row - The cursor position to print the string at\r
\r
  fmt         - Format string\r
\r
Returns:\r
\r
  Length of string printed to the console\r
\r
--*/\r
{\r
  VA_LIST args;\r
\r
  VA_START (args, fmt);\r
  return _IPrint (Column, Row, gST->ConOut, fmt, args);\r
}\r
\r
UINTN\r
PrintStringAt (\r
  IN UINTN     Column,\r
  IN UINTN     Row,\r
  CHAR16       *String\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Prints a unicode string to the default console, at\r
  the supplied cursor position, using L"%s" format.\r
\r
Arguments:\r
\r
  Column, Row - The cursor position to print the string at\r
\r
  String      - String pointer.\r
\r
Returns:\r
\r
  Length of string printed to the console\r
\r
--*/\r
{\r
  return PrintAt (Column, Row, (CHAR16 *) L"%s", String);\r
}\r
\r
UINTN\r
PrintCharAt (\r
  IN UINTN     Column,\r
  IN UINTN     Row,\r
  CHAR16       Character\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Prints a chracter to the default console, at\r
  the supplied cursor position, using L"%c" format.\r
\r
Arguments:\r
\r
  Column, Row - The cursor position to print the string at\r
\r
  Character   - Character to print.\r
\r
Returns:\r
\r
  Length of string printed to the console.\r
\r
--*/\r
{\r
  return PrintAt (Column, Row, (CHAR16 *) L"%c", Character);\r
}\r
\r
\r