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

/** @file\r
  Base Print Library instance Internal Functions definition.\r
\r
  Copyright (c) 2006 - 2008, 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       0x02\r
#define PREFIX_BLANK      0x04\r
#define LONG_TYPE         0x10\r
#define OUTPUT_UNICODE    0x40\r
#define FORMAT_UNICODE    0x100\r
#define PAD_TO_WIDTH      0x200\r
#define ARGUMENT_UNICODE  0x400\r
#define PRECISION         0x800\r
#define ARGUMENT_REVERSED 0x1000\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
  @param  Buffer          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
  @param  Flags           Initial flags value.\r
                          Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
  @param  Format          A Null-terminated format string.\r
  @param  VaListMarker    VA_LIST style variable argument list consumed by processing Format.\r
  @param  BaseListMarker  BASE_LIST style variable argument list consumed by processing Format.\r
\r
  @return The number of characters printed not including the Null-terminator.\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 - 2008, 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 0x02\r
	28	#define PREFIX_BLANK 0x04\r
	29	#define LONG_TYPE 0x10\r
	30	#define OUTPUT_UNICODE 0x40\r
	31	#define FORMAT_UNICODE 0x100\r
	32	#define PAD_TO_WIDTH 0x200\r
	33	#define ARGUMENT_UNICODE 0x400\r
	34	#define PRECISION 0x800\r
	35	#define ARGUMENT_REVERSED 0x1000\r
	36	\r
	37	//\r
	38	// Record date and time information\r
	39	//\r
	40	typedef struct {\r
	41	UINT16 Year;\r
	42	UINT8 Month;\r
	43	UINT8 Day;\r
	44	UINT8 Hour;\r
	45	UINT8 Minute;\r
	46	UINT8 Second;\r
	47	UINT8 Pad1;\r
	48	UINT32 Nanosecond;\r
	49	INT16 TimeZone;\r
	50	UINT8 Daylight;\r
	51	UINT8 Pad2;\r
	52	} TIME;\r
	53	\r
	54	/**\r
	55	Worker function that produces a Null-terminated string in an output buffer \r
	56	based on a Null-terminated format string and a VA_LIST argument list.\r
	57	\r
	58	VSPrint function to process format and place the results in Buffer. Since a \r
	59	VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
	60	this is the main print working routine.\r
	61	\r
	62	@param Buffer The character buffer to print the results of the parsing\r
	63	of Format into.\r
	64	@param BufferSize The maximum number of characters to put into buffer.\r
	65	@param Flags Initial flags value.\r
	66	Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
	67	@param Format A Null-terminated format string.\r
	68	@param VaListMarker VA_LIST style variable argument list consumed by processing Format.\r
	69	@param BaseListMarker BASE_LIST style variable argument list consumed by processing Format.\r
	70	\r
	71	@return The number of characters printed not including the Null-terminator.\r
	72	\r
	73	**/\r
	74	UINTN\r
	75	BasePrintLibSPrintMarker (\r
	76	OUT CHAR8 *Buffer,\r
	77	IN UINTN BufferSize,\r
	78	IN UINTN Flags,\r
	79	IN CONST CHAR8 *Format,\r
	80	IN VA_LIST VaListMarker, OPTIONAL\r
	81	IN BASE_LIST BaseListMarker OPTIONAL\r
	82	);\r
	83	\r
	84	/**\r
	85	Worker function that produces a Null-terminated string in an output buffer \r
	86	based on a Null-terminated format string and variable argument list.\r
	87	\r
	88	VSPrint function to process format and place the results in Buffer. Since a \r
	89	VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
	90	this is the main print working routine\r
	91	\r
	92	@param StartOfBuffer The character buffer to print the results of the parsing\r
	93	of Format into.\r
	94	@param BufferSize The maximum number of characters to put into buffer.\r
	95	Zero means no limit.\r
	96	@param Flags Initial flags value.\r
	97	Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
	98	@param FormatString Null-terminated format string.\r
	99	@param ... The variable argument list.\r
	100	\r
	101	@return The number of characters printed.\r
	102	\r
	103	**/\r
	104	UINTN\r
	105	EFIAPI\r
	106	BasePrintLibSPrint (\r
	107	OUT CHAR8 *StartOfBuffer,\r
	108	IN UINTN BufferSize,\r
	109	IN UINTN Flags,\r
	110	IN CONST CHAR8 *FormatString,\r
	111	...\r
	112	);\r
	113	\r
	114	/**\r
	115	Internal function that places the character into the Buffer.\r
	116	\r
	117	Internal function that places ASCII or Unicode character into the Buffer.\r
	118	\r
	119	@param Buffer Buffer to place the Unicode or ASCII string.\r
	120	@param EndBuffer The end of the input Buffer. No characters will be\r
	121	placed after that. \r
	122	@param Length The count of character to be placed into Buffer.\r
	123	(Negative value indicates no buffer fill.)\r
	124	@param Character The character to be placed into Buffer.\r
	125	@param Increment The character increment in Buffer.\r
	126	\r
	127	@return Buffer Buffer filled with the input Character.\r
	128	\r
	129	**/\r
	130	CHAR8 *\r
	131	BasePrintLibFillBuffer (\r
	132	OUT CHAR8 *Buffer,\r
	133	IN CHAR8 *EndBuffer,\r
	134	IN INTN Length,\r
	135	IN UINTN Character,\r
	136	IN INTN Increment\r
	137	);\r
	138	\r
	139	/**\r
	140	Internal function that convert a number to a string in Buffer.\r
	141	\r
	142	Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.\r
	143	\r
	144	@param Buffer Location to place the ASCII string of Value.\r
	145	@param Value The value to convert to a Decimal or Hexadecimal string in Buffer.\r
	146	@param Radix Radix of the value\r
	147	\r
	148	@return A pointer to the end of buffer filled with ASCII string.\r
	149	\r
	150	**/\r
	151	CHAR8 *\r
	152	BasePrintLibValueToString (\r
	153	IN OUT CHAR8 *Buffer, \r
	154	IN INT64 Value, \r
	155	IN UINTN Radix\r
	156	);\r
	157	\r
	158	/**\r
	159	Internal function that converts a decimal value to a Null-terminated string.\r
	160	\r
	161	Converts the decimal number specified by Value to a Null-terminated \r
	162	string specified by Buffer containing at most Width characters.\r
	163	If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
	164	The total number of characters placed in Buffer is returned.\r
	165	If the conversion contains more than Width characters, then only the first\r
	166	Width characters are returned, and the total number of characters \r
	167	required to perform the conversion is returned.\r
	168	Additional conversion parameters are specified in Flags. \r
	169	The Flags bit LEFT_JUSTIFY is always ignored.\r
	170	All conversions are left justified in Buffer.\r
	171	If Width is 0, PREFIX_ZERO is ignored in Flags.\r
	172	If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas\r
	173	are inserted every 3rd digit starting from the right.\r
	174	If Value is < 0, then the fist character in Buffer is a '-'.\r
	175	If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, \r
	176	then Buffer is padded with '0' characters so the combination of the optional '-' \r
	177	sign character, '0' characters, digit characters for Value, and the Null-terminator\r
	178	add up to Width characters.\r
	179	\r
	180	If Buffer is NULL, then ASSERT().\r
	181	If unsupported bits are set in Flags, then ASSERT().\r
	182	If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
	183	\r
	184	@param Buffer The pointer to the output buffer for the produced Null-terminated\r
	185	string.\r
	186	@param Flags The bitmask of flags that specify left justification, zero pad,\r
	187	and commas.\r
	188	@param Value The 64-bit signed value to convert to a string.\r
	189	@param Width The maximum number of characters to place in Buffer, not including\r
	190	the Null-terminator.\r
	191	@param Increment Character increment in Buffer.\r
	192	\r
	193	@return Total number of characters required to perform the conversion.\r
	194	\r
	195	**/\r
	196	UINTN\r
	197	BasePrintLibConvertValueToString (\r
	198	IN OUT CHAR8 *Buffer,\r
	199	IN UINTN Flags,\r
	200	IN INT64 Value,\r
	201	IN UINTN Width,\r
	202	IN UINTN Increment\r
	203	);\r
	204	\r
	205	#endif\r