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

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