User:Ybab321/printf format
The format string consists of ordinary byte characters (except %
), which are copied unchanged into the output stream, and conversion specifications. Each conversion specification has the following format:
- introductory
%
character.
- introductory
- (optional) flags that modify the behavior of the conversion:
-
-
: the result of the conversion is left-justified within the field (by default it is right-justified). -
+
: the sign of signed conversions is always prepended to the result of the conversion (by default the result is preceded by minus only when it is negative). - space: if the result of a signed conversion does not start with a sign character, or is empty, space is prepended to the result. It is ignored if
+
flag is present. -
#
: for floating-point and non-decimal integer conversions, the alternative form of the conversion is performed. See below for the exact semantics. Other conversions using this flag have undefined behavior. -
0
: for floating-point and integer conversions, leading zeros are used to pad the field instead of space characters. For integer numbers it is ignored if the precision is explicitly specified. Other conversions using this flag have undefined behavior. It is ignored if-
flag is present.
-
- (optional) integer value or
*
: specifies minimum field width. The result is padded with space characters (by default), if required, on the left when right-justified, or on the right if left-justified. In the case when*
is used, the width is specified by an additional argument of type int, which appears before the argument to be converted and the argument supplying precision if one is supplied. If the value of the argument is negative, then the-
flag is implied and the absolute value used for minimum field width.
- (optional) integer value or
- (optional)
.
followed by integer number or*
: specifies the precision of the conversion. In the case when*
is used, the precision is specified by an additional argument of type int, which appears before the argument to be converted, but after the argument supplying minimum field width if one is supplied. If the value of this argument is negative, it is ignored. If neither a number nor*
is used, the precision is taken as zero. See below for the exact semantics.
- (optional)
- (optional) length modifier that specifies the size of the argument (in combination with the conversion format specifier, it specifies the type of the corresponding argument).
- conversion format specifier.
If a conversion specification is invalid, the behavior is undefined.
Non-numeric
-
%
: Writes%
character. Has no argument. No modifiers supported, full conversion specification must be%%
. -
p
: Writes a pointer. Argument is a void*. Output format is implementation defined. -
c
: Writes a character. Argument type depends on the length modifier:
- (none): Argument is an int, which is converted to unsigned char and copied to the output stream.
-
l
: Argument is a wint_t, which is converted to a wchar_t, put into a null terminated array, and printed with the semantics of%ls
.
-
s
: Write a string. Argument is a pointer to the initial element of an array of characters. Argument type depends on the length modifier:
- (none): Argument is a char*. Characters are copied to the output stream.
-
l
: Argument is a wchar_t*. String is converted to a narrow string via wcrtomb (with zero-initialised conversion state), and resulting characters copied to the output stream. For the precision modifier and%n
specifier, the number of characters refers to the wide string, not the converted-to narrow string.
- The precision specifies the maximum number of characters to write. Characters are copied until the maximum is reached or a null terminator is found. The null terminator does not contribute to the number of characters reported by
%n
.
Even though %c
expects int
argument, it is safe to pass a char
because of the integer promotion that takes place when a variadic function is called.
Integer
Let SInt
and UInt
be respective types determined by the length specifier:
|
(since C99) |
-
h
: short and unsigned short -
(none)
: int and unsigned -
l
: long and unsigned long
|
(since C99) |
|
(since C23) |
Then:
-
d/i
: Writes a signed integer in decimal representation. Argument is anSInt
. -
u
: Writes an unsigned integer in decimal representation. Argument is anUInt
. -
x/X
: Writes an unsigned integer in hexadecimal representation. Argument is anUInt
. The alternative form prefixes0x
if the argument is non-zero. If the format specifier is uppercase, the corresponding output will also be uppercase.
|
(since C23) |
-
o
: Writes an unsigned integer in octal representation. Argument is anUInt
. The alternative form increases the precision as much as is needed for the first digit written to be zero. -
n
: Returns the number of characters written so far by this call to the function, including minimum field width padding. Argument is anSInt*
to write the result to. Only supported modifier is length modifier.
- The precision specifies the minimum number of digits to write, leading zeros will be written if necessary. If unspecified, a precision of 1 is used. If precision is 0 and the argument is 0, no digits will be written.
The correct conversion specifications for the fixed-width character types (int8_t, etc) are defined in the header <inttypes.h>
(although PRIdMAX, PRIuMAX, etc is synonymous with %jd
, %ju
, etc).
The memory-writing conversion specifier %n is a common target of security exploits where format strings depend on user input and is not supported by the bounds-checked printf_s
family of functions.
There is a sequence point after the action of each conversion specifier; this permits storing multiple %n results in the same variable or, as an edge case, printing a string modified by an earlier %n within the same call.
Floating-point
The argument type is determined by the length specifier:
-
(none)
: double
|
(since C99) |
-
L
: long double
|
(since C23) |
Then:
- If the argument is infinity, then
inf
orinfinity
is written. Which one is used is implementation defined. - If the argument is not-a-number, then
nan
ornan(char_sequence)
is written. Which one is used is implementation defined.
Otherwise:
-
f/F
: Writes a floating-point in decimal notation [-]ddd.ddd. The precision specifies the number of decimal places, trailing zeros will be written if necessary. If unspecified, a precision of 6 is used. -
e/E
: Writes a floating-point in decimal exponent notation [-]d.ddde
±dd. If the exponent is less than 10, it is written with a leading zero. The precision specifies the number of decimal places, trailing zeros will be written if necessary. If unspecified, a precision of 6 is used. -
g/G
: Writes a floating-point in decimal or decimal exponent notation, depending on the argument and precision.
- Let P = max(0, precision - 1), or 5 if precision is unspecified.
- Let EXP be the exponent written if
%e
were the specification.- If -4 ≤ EXP ≤ P, then the argument is written as if the
e/E
format specifier was used with precision P. - Otherwise, the argument is written as if the
f/F
format specifier was used with precision P - EXP.
- If -4 ≤ EXP ≤ P, then the argument is written as if the
|
(since C99) |
The alternative form writes a decimal point even if precision is 0. If the format specifier is uppercase, the corresponding output will also be uppercase.