MdePkg/Library/BasePrintLib/PrintLibInternal.h

   1 /** @file
   2   Base Print Library instance Internal Functions definition.
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __PRINT_LIB_INTERNAL_H__
  16 #define __PRINT_LIB_INTERNAL_H__
  17
  18 #include <Base.h>
  19 #include <Library/PrintLib.h>
  20 #include <Library/BaseLib.h>
  21 #include <Library/DebugLib.h>
  22
  23
  24 //
  25 // Print primitives
  26 //
  27 #define PREFIX_SIGN       0x02
  28 #define PREFIX_BLANK      0x04
  29 #define LONG_TYPE         0x10
  30 #define OUTPUT_UNICODE    0x40
  31 #define FORMAT_UNICODE    0x100
  32 #define PAD_TO_WIDTH      0x200
  33 #define ARGUMENT_UNICODE  0x400
  34 #define PRECISION         0x800
  35 #define ARGUMENT_REVERSED 0x1000
  36
  37 //
  38 // Record date and time information
  39 //
  40 typedef struct {
  41   UINT16  Year;
  42   UINT8   Month;
  43   UINT8   Day;
  44   UINT8   Hour;
  45   UINT8   Minute;
  46   UINT8   Second;
  47   UINT8   Pad1;
  48   UINT32  Nanosecond;
  49   INT16   TimeZone;
  50   UINT8   Daylight;
  51   UINT8   Pad2;
  52 } TIME;
  53
  54 /**
  55   Worker function that produces a Null-terminated string in an output buffer
  56   based on a Null-terminated format string and a VA_LIST argument list.
  57
  58   VSPrint function to process format and place the results in Buffer. Since a
  59   VA_LIST is used this rountine allows the nesting of Vararg routines. Thus
  60   this is the main print working routine.
  61
  62   @param  Buffer      Character buffer to print the results of the parsing
  63                       of Format into.
  64   @param  BufferSize  Maximum number of characters to put into buffer.
  65   @param  Flags       Intial flags value.
  66                       Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.
  67   @param  Format      Null-terminated format string.
  68   @param  Marker      Vararg list consumed by processing Format.
  69
  70   @return Number of characters printed not including the Null-terminator.
  71
  72 **/
  73 UINTN
  74 BasePrintLibVSPrint (
  75   OUT CHAR8        *Buffer,
  76   IN  UINTN        BufferSize,
  77   IN  UINTN        Flags,
  78   IN  CONST CHAR8  *Format,
  79   IN  VA_LIST      Marker
  80   );
  81
  82 /**
  83   Worker function that produces a Null-terminated string in an output buffer
  84   based on a Null-terminated format string and variable argument list.
  85
  86   VSPrint function to process format and place the results in Buffer. Since a
  87   VA_LIST is used this rountine allows the nesting of Vararg routines. Thus
  88   this is the main print working routine
  89
  90   @param  StartOfBuffer Character buffer to print the results of the parsing
  91                         of Format into.
  92   @param  BufferSize    Maximum number of characters to put into buffer.
  93                         Zero means no limit.
  94   @param  Flags         Intial flags value.
  95                         Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
  96   @param  FormatString  Null-terminated format string.
  97   @param  ...           The variable argument list.
  98
  99   @return Number of characters printed.
 100
 101 **/
 102 UINTN
 103 BasePrintLibSPrint (
 104   OUT CHAR8        *StartOfBuffer,
 105   IN  UINTN        BufferSize,
 106   IN  UINTN        Flags,
 107   IN  CONST CHAR8  *FormatString,
 108   ...
 109   );
 110
 111 /**
 112   Internal function that places the character into the Buffer.
 113
 114   Internal function that places ASCII or Unicode character into the Buffer.
 115
 116   @param  Buffer      Buffer to place the Unicode or ASCII string.
 117   @param  EndBuffer   The end of the input Buffer. No characters will be
 118                       placed after that.
 119   @param  Length      Count of character to be placed into Buffer.
 120                       (Negative value indicates no buffer fill.)
 121   @param  Character   Character to be placed into Buffer.
 122   @param  Increment   Character increment in Buffer.
 123
 124   @return Buffer      Buffer filled with the input Character.
 125
 126 **/
 127 CHAR8 *
 128 BasePrintLibFillBuffer (
 129   OUT CHAR8   *Buffer,
 130   IN  CHAR8   *EndBuffer,
 131   IN  INTN    Length,
 132   IN  UINTN   Character,
 133   IN  INTN    Increment
 134   );
 135
 136 /**
 137   Internal function that convert a decimal number to a string in Buffer.
 138
 139   Print worker function that convert a decimal number to a string in Buffer.
 140
 141   @param  Buffer    Location to place the Unicode or ASCII string of Value.
 142   @param  Value     Value to convert to a Decimal or Hexadecimal string in Buffer.
 143   @param  Radix     Radix of the value
 144
 145   @return Number of characters printed.
 146
 147 **/
 148 UINTN
 149 BasePrintLibValueToString (
 150   IN OUT CHAR8  *Buffer,
 151   IN INT64      Value,
 152   IN UINTN      Radix
 153   );
 154
 155 /**
 156   Internal function that converts a decimal value to a Null-terminated string.
 157
 158   Converts the decimal number specified by Value to a Null-terminated
 159   string specified by Buffer containing at most Width characters.
 160   If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.
 161   The total number of characters placed in Buffer is returned.
 162   If the conversion contains more than Width characters, then only the first
 163   Width characters are returned, and the total number of characters
 164   required to perform the conversion is returned.
 165   Additional conversion parameters are specified in Flags.
 166   The Flags bit LEFT_JUSTIFY is always ignored.
 167   All conversions are left justified in Buffer.
 168   If Width is 0, PREFIX_ZERO is ignored in Flags.
 169   If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
 170   are inserted every 3rd digit starting from the right.
 171   If Value is < 0, then the fist character in Buffer is a '-'.
 172   If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
 173   then Buffer is padded with '0' characters so the combination of the optional '-'
 174   sign character, '0' characters, digit characters for Value, and the Null-terminator
 175   add up to Width characters.
 176
 177   If Buffer is NULL, then ASSERT().
 178   If unsupported bits are set in Flags, then ASSERT().
 179   If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
 180
 181   @param  Buffer    Pointer to the output buffer for the produced Null-terminated
 182                     string.
 183   @param  Flags     The bitmask of flags that specify left justification, zero pad,
 184                     and commas.
 185   @param  Value     The 64-bit signed value to convert to a string.
 186   @param  Width     The maximum number of characters to place in Buffer, not including
 187                     the Null-terminator.
 188   @param  Increment Character increment in Buffer.
 189
 190   @return Total number of characters required to perform the conversion.
 191
 192 **/
 193 UINTN
 194 BasePrintLibConvertValueToString (
 195   IN OUT CHAR8   *Buffer,
 196   IN UINTN       Flags,
 197   IN INT64       Value,
 198   IN UINTN       Width,
 199   IN UINTN       Increment
 200   );
 201
 202 #endif