MdePkg/Library/BasePrintLib/PrintLibInternal.h

   1 /** @file
   2   Print Library.
   3
   4   Copyright (c) 2006, 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   Module Name:  PrintLibInternal.h
  14
  15 **/
  16
  17 #ifndef __PRINT_LIB_INTERNAL_H
  18 #define __PRINT_LIB_INTERNAL_H
  19
  20 //
  21 // Print primitives
  22 //
  23 //#define LEFT_JUSTIFY      0x01
  24 #define PREFIX_SIGN       0x02
  25 #define PREFIX_BLANK      0x04
  26 //#define COMMA_TYPE        0x08
  27 #define LONG_TYPE         0x10
  28 //#define PREFIX_ZERO       0x20
  29 #define OUTPUT_UNICODE    0x40
  30 #define RADIX_HEX         0x80
  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 variable 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                         Zero means no limit.
  66   @param  Flags         Intial flags value.
  67                         Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
  68   @param  FormatString  Null-terminated format string.
  69
  70   @return Number of characters printed.
  71
  72 **/
  73 UINTN
  74 BasePrintLibSPrint (
  75   OUT CHAR8        *Buffer,
  76   IN  UINTN        BufferSize,
  77   IN  UINTN        Flags,
  78   IN  CONST CHAR8  *FormatString,
  79   ...
  80   );
  81
  82 /**
  83   Internal function that places the character into the Buffer.
  84
  85   Internal function that places ASCII or Unicode character into the Buffer.
  86
  87   @param  Buffer      Buffer to place the Unicode or ASCII string.
  88   @param  EndBuffer   The end of the input Buffer. No characters will be
  89                       placed after that.
  90   @param  Length      Count of character to be placed into Buffer.
  91   @param  Character   Character to be placed into Buffer.
  92   @param  Increment   Character increment in Buffer.
  93
  94   @return Number of characters printed.
  95
  96 **/
  97 CHAR8 *
  98 BasePrintLibFillBuffer (
  99   CHAR8   *Buffer,
 100   CHAR8   *EndBuffer,
 101   INTN    Length,
 102   UINTN   Character,
 103   INTN    Increment
 104   );
 105
 106 /**
 107   Internal function that convert a decimal number to a string in Buffer.
 108
 109   Print worker function that convert a decimal number to a string in Buffer.
 110
 111   @param  Buffer    Location to place the Unicode or ASCII string of Value.
 112   @param  Value     Value to convert to a Decimal or Hexidecimal string in Buffer.
 113   @param  Radix     Radix of the value
 114
 115   @return Number of characters printed.
 116
 117 **/
 118 UINTN
 119 EFIAPI
 120 BasePrintLibValueToString (
 121   IN OUT CHAR8  *Buffer,
 122   IN INT64      Value,
 123   IN UINTN      Radix
 124   );
 125
 126 /**
 127   Internal function that converts a decimal value to a Null-terminated string.
 128
 129   Converts the decimal number specified by Value to a Null-terminated
 130   string specified by Buffer containing at most Width characters.
 131   If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.
 132   The total number of characters placed in Buffer is returned.
 133   If the conversion contains more than Width characters, then only the first
 134   Width characters are returned, and the total number of characters
 135   required to perform the conversion is returned.
 136   Additional conversion parameters are specified in Flags.
 137   The Flags bit LEFT_JUSTIFY is always ignored.
 138   All conversions are left justified in Buffer.
 139   If Width is 0, PREFIX_ZERO is ignored in Flags.
 140   If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
 141   are inserted every 3rd digit starting from the right.
 142   If Value is < 0, then the fist character in Buffer is a '-'.
 143   If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
 144   then Buffer is padded with '0' characters so the combination of the optional '-'
 145   sign character, '0' characters, digit characters for Value, and the Null-terminator
 146   add up to Width characters.
 147
 148   If Buffer is NULL, then ASSERT().
 149   If unsupported bits are set in Flags, then ASSERT().
 150   If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
 151
 152   @param  Buffer    Pointer to the output buffer for the produced Null-terminated
 153                     string.
 154   @param  Flags     The bitmask of flags that specify left justification, zero pad,
 155                     and commas.
 156   @param  Value     The 64-bit signed value to convert to a string.
 157   @param  Width     The maximum number of characters to place in Buffer, not including
 158                     the Null-terminator.
 159   @param  Increment Character increment in Buffer.
 160
 161   @return Total number of characters required to perform the conversion.
 162
 163 **/
 164 UINTN
 165 BasePrintLibConvertValueToString (
 166   IN OUT CHAR8   *Buffer,
 167   IN UINTN       Flags,
 168   IN INT64       Value,
 169   IN UINTN       Width,
 170   IN UINTN       Increment
 171   );
 172
 173 #endif