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  Length      Count of character to be placed into Buffer.
  89   @param  Character   Character to be placed into Buffer.
  90   @param  Increment   Character increment in Buffer.
  91
  92   @return Number of characters printed.
  93
  94 **/
  95 CHAR8 *
  96 BasePrintLibFillBuffer (
  97   CHAR8   *Buffer,
  98   INTN    Length,
  99   UINTN   Character,
 100   INTN    Increment
 101   );
 102
 103 /**
 104   Internal function that convert a decimal number to a string in Buffer.
 105
 106   Print worker function that convert a decimal number to a string in Buffer.
 107
 108   @param  Buffer    Location to place the Unicode or ASCII string of Value.
 109   @param  Value     Value to convert to a Decimal or Hexidecimal string in Buffer.
 110   @param  Radix     Radix of the value
 111
 112   @return Number of characters printed.
 113
 114 **/
 115 UINTN
 116 EFIAPI
 117 BasePrintLibValueToString (
 118   IN OUT CHAR8  *Buffer,
 119   IN INT64      Value,
 120   IN UINTN      Radix
 121   );
 122
 123 /**
 124   Internal function that converts a decimal value to a Null-terminated string.
 125
 126   Converts the decimal number specified by Value to a Null-terminated
 127   string specified by Buffer containing at most Width characters.
 128   If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.
 129   The total number of characters placed in Buffer is returned.
 130   If the conversion contains more than Width characters, then only the first
 131   Width characters are returned, and the total number of characters
 132   required to perform the conversion is returned.
 133   Additional conversion parameters are specified in Flags.
 134   The Flags bit LEFT_JUSTIFY is always ignored.
 135   All conversions are left justified in Buffer.
 136   If Width is 0, PREFIX_ZERO is ignored in Flags.
 137   If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
 138   are inserted every 3rd digit starting from the right.
 139   If Value is < 0, then the fist character in Buffer is a '-'.
 140   If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
 141   then Buffer is padded with '0' characters so the combination of the optional '-'
 142   sign character, '0' characters, digit characters for Value, and the Null-terminator
 143   add up to Width characters.
 144
 145   If Buffer is NULL, then ASSERT().
 146   If unsupported bits are set in Flags, then ASSERT().
 147   If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
 148
 149   @param  Buffer    Pointer to the output buffer for the produced Null-terminated
 150                     string.
 151   @param  Flags     The bitmask of flags that specify left justification, zero pad,
 152                     and commas.
 153   @param  Value     The 64-bit signed value to convert to a string.
 154   @param  Width     The maximum number of characters to place in Buffer.
 155   @param  Increment Character increment in Buffer.
 156
 157   @return Total number of characters required to perform the conversion.
 158
 159 **/
 160 UINTN
 161 BasePrintLibConvertValueToString (
 162   IN OUT CHAR8   *Buffer,
 163   IN UINTN       Flags,
 164   IN INT64       Value,
 165   IN UINTN       Width,
 166   IN UINTN       Increment
 167   );
 168
 169 #endif