Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Dxe / Include / EfiPrintLib.h

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\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
\r
Module Name:\r
\r
  EfiPrintLib.h\r
\r
Abstract:\r
\r
  Light weight lib to support EFI drivers.\r
\r
--*/\r
\r
#ifndef _EFI_PRINT_LIB_H_\r
#define _EFI_PRINT_LIB_H_\r
\r
#include EFI_PROTOCOL_DEFINITION(GraphicsOutput)\r
#include EFI_PROTOCOL_DEFINITION(UgaDraw)\r
#include EFI_PROTOCOL_DEFINITION(Print)\r
\r
UINTN\r
ErrorPrint (\r
  IN CONST CHAR16 *ErrorString,\r
  IN CONST CHAR8  *Format,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Print function for a maximum of EFI_DRIVER_LIB_MAX_PRINT_BUFFER ascii \r
  characters.\r
\r
Arguments:\r
\r
  ErrorString   - Error message printed first\r
\r
  Format - Ascii format string see file header for more details.\r
\r
  ...    - Vararg list consumed by processing Format.\r
\r
Returns: \r
\r
  Number of characters printed.\r
\r
--*/\r
;\r
\r
VOID\r
ErrorDumpHex (\r
  IN UINTN        Indent,\r
  IN UINTN        Offset,\r
  IN UINTN        DataSize,\r
  IN VOID         *UserData\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Dump error info by hex.\r
\r
Arguments:\r
\r
  Indent    - Indent number\r
  Offset    - Offset number\r
  DataSize  - Size of user data\r
  UserData  - User data to dump\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
UINTN\r
Print (\r
  IN CONST CHAR16  *Format,\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
\r
UINTN\r
PrintXY (\r
  IN UINTN                            X,\r
  IN UINTN                            Y,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Foreground, OPTIONAL\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Background, OPTIONAL\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
    X           - X coordinate to start printing\r
    \r
    Y           - Y coordinate to start printing\r
    \r
    ForeGround  - Foreground color\r
    \r
    BackGround  - Background color\r
\r
    Fmt         - Format string\r
    \r
    ...         - Print arguments\r
\r
Returns:\r
\r
    Length of string printed to the console\r
\r
--*/\r
;\r
\r
UINTN\r
Aprint (\r
  IN CONST CHAR8  *Format,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Print function for a maximum of EFI_DRIVER_LIB_MAX_PRINT_BUFFER ascii \r
  characters.\r
\r
Arguments:\r
\r
  Format - Ascii format string see file header for more details.\r
\r
  ...    - Vararg list consumed by processing Format.\r
\r
Returns: \r
\r
  Number of characters printed.\r
\r
--*/\r
;\r
\r
UINTN\r
UPrint (\r
  IN CONST CHAR16  *Format,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Print function for a maximum of EFI_DRIVER_LIB_MAX_PRINT_BUFFER ascii \r
  characters.\r
\r
Arguments:\r
\r
  Format - Ascii format string see file header for more details.\r
\r
  ...    - Vararg list consumed by processing Format.\r
\r
Returns: \r
\r
  Number of characters printed.\r
\r
--*/\r
;\r
\r
UINTN\r
EFIAPI\r
VSPrint (\r
  OUT CHAR16        *StartOfBuffer,\r
  IN  UINTN         StrLen,\r
  IN  CONST CHAR16  *Format,\r
  IN  VA_LIST       Marker\r
  )\r
/*++\r
\r
Routine Description:\r
\r
    Prints a formatted unicode string to a buffer\r
\r
Arguments:\r
\r
    StartOfBuffer   - Output buffer to print the formatted string into\r
    StrLen          - Size of Str.  String is truncated to this size.\r
                      A size of 0 means there is no limit\r
    Format          - The format string\r
    Marker          - Vararg list consumed by processing Format.\r
\r
Returns:\r
\r
    String length returned in buffer\r
\r
--*/\r
;\r
\r
UINTN\r
SPrint (\r
  OUT CHAR16      *Buffer,\r
  IN UINTN        BufferSize,\r
  IN CONST CHAR16 *Format,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  SPrint function to process format and place the results in Buffer.\r
\r
Arguments:\r
\r
  Buffer     - Wide char buffer to print the results of the parsing of Format into.\r
\r
  BufferSize - Maximum number of characters to put into buffer. Zero means no \r
               limit.\r
\r
  Format - Format string see file header for more details.\r
\r
  ...    - Vararg list consumed by processing Format.\r
\r
Returns: \r
\r
  Number of characters printed.\r
\r
--*/\r
;\r
\r
//\r
// BoxDraw support\r
//\r
BOOLEAN\r
IsValidEfiCntlChar (\r
  IN  CHAR16  CharC\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Test whether a wide char is a valid control char.\r
\r
Arguments:\r
\r
  CharC - A char\r
\r
Returns:\r
\r
  TRUE    - A control char\r
  \r
  FALSE   - Not a control char\r
\r
--*/\r
;\r
\r
BOOLEAN\r
IsValidAscii (\r
  IN  CHAR16  Ascii\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Test whether a wide char is a normal printable char\r
\r
Arguments:\r
\r
  Ascii - A char\r
\r
Returns:\r
\r
  True      - A normal, printable char\r
  FALSE     - Not a normal, printable char\r
\r
--*/\r
;\r
\r
BOOLEAN\r
LibIsValidTextGraphics (\r
  IN  CHAR16  Graphic,\r
  OUT CHAR8   *PcAnsi,    OPTIONAL\r
  OUT CHAR8   *Ascii      OPTIONAL\r
  )\r
/*++\r
\r
Routine Description:\r
\r
    Detects if a Unicode char is for Box Drawing text graphics.\r
\r
Arguments:\r
\r
    Graphic - Unicode char to test.\r
\r
    PcAnsi  - Optional pointer to return PCANSI equivalent of Graphic.\r
\r
    Ascii   - Optional pointer to return Ascii equivalent of Graphic.\r
\r
Returns:\r
\r
    TRUE if Gpaphic is a supported Unicode Box Drawing character.\r
\r
--*/\r
;\r
\r
#endif\r