Updated headers to follow coding standard

[mirror_edk2.git] / MdePkg / Library / BasePrintLib / PrintLibInternal.h

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.h b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
index f395bb795622d97ee02df45275404703d0bffe2d..3a1003beeaccefd1f47ccaf6e250bbdbf3105780 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.h
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Print Library.\r
+  Print Library Internal Functions.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2007, 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
@@ -10,10 +10,16 @@
   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:  PrintLibInternal.h\r
-\r
 **/\r
 \r
+#ifndef __PRINT_LIB_INTERNAL_H\r
+#define __PRINT_LIB_INTERNAL_H\r
+\r
+//\r
+// Include common header file for this module.\r
+//\r
+#include "CommonHeader.h"\r
+\r
 //\r
 // Print primitives\r
 //\r
@@ -24,7 +30,7 @@
 #define LONG_TYPE         0x10\r
 //#define PREFIX_ZERO       0x20\r
 #define OUTPUT_UNICODE    0x40\r
-#define RADIX_HEX         0x80\r
+//#define RADIX_HEX         0x80\r
 #define FORMAT_UNICODE    0x100\r
 #define PAD_TO_WIDTH      0x200\r
 #define ARGUMENT_UNICODE  0x400\r
@@ -48,6 +54,34 @@ typedef struct {
   UINT8   Pad2;\r
 } TIME;\r
 \r
+/**\r
+  Worker function that produces a Null-terminated string in an output buffer \r
+  based on a Null-terminated format string and a VA_LIST argument list.\r
+\r
+  VSPrint function to process format and place the results in Buffer. Since a \r
+  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
+  this is the main print working routine.\r
+\r
+  @param  Buffer      Character buffer to print the results of the parsing\r
+                      of Format into.\r
+  @param  BufferSize  Maximum number of characters to put into buffer.\r
+  @param  Flags       Intial flags value.\r
+                      Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
+  @param  Format      Null-terminated format string.\r
+  @param  Marker      Vararg list consumed by processing Format.\r
+\r
+  @return Number of characters printed not including the Null-terminator.\r
+\r
+**/\r
+UINTN\r
+BasePrintLibVSPrint (\r
+  OUT CHAR8        *Buffer,\r
+  IN  UINTN        BufferSize,\r
+  IN  UINTN        Flags,\r
+  IN  CONST CHAR8  *Format,\r
+  IN  VA_LIST      Marker\r
+  );\r
+\r
 /**\r
   Worker function that produces a Null-terminated string in an output buffer \r
   based on a Null-terminated format string and variable argument list.\r
@@ -82,6 +116,8 @@ BasePrintLibSPrint (
   Internal function that places ASCII or Unicode character into the Buffer.\r
 \r
   @param  Buffer      Buffer to place the Unicode or ASCII string.\r
+  @param  EndBuffer   The end of the input Buffer. No characters will be\r
+                      placed after that. \r
   @param  Length      Count of character to be placed into Buffer.\r
   @param  Character   Character to be placed into Buffer.\r
   @param  Increment   Character increment in Buffer.\r
@@ -92,6 +128,7 @@ BasePrintLibSPrint (
 CHAR8 *\r
 BasePrintLibFillBuffer (\r
   CHAR8   *Buffer,\r
+  CHAR8   *EndBuffer,\r
   INTN    Length,\r
   UINTN   Character,\r
   INTN    Increment\r
@@ -148,7 +185,8 @@ BasePrintLibValueToString (
   @param  Flags     The bitmask of flags that specify left justification, zero pad,\r
                     and commas.\r
   @param  Value     The 64-bit signed value to convert to a string.\r
-  @param  Width            The maximum number of characters to place in Buffer.\r
+  @param  Width     The maximum number of characters to place in Buffer, not including\r
+                    the Null-terminator.\r
   @param  Increment Character increment in Buffer.\r
   \r
   @return Total number of characters required to perform the conversion.\r
@@ -162,3 +200,5 @@ BasePrintLibConvertValueToString (
   IN UINTN       Width,\r
   IN UINTN       Increment\r
   );\r
+\r
+#endif\r