std::scanf,...std::sscanf(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

🌸 NAME 🌸

std::scanf, std::fscanf, std::sscanf β€” std::scanf,std::fscanf,std::sscanf. This is the C++ Standard Libary (3) page, bestie. πŸ’…

✨ Synopsis ✨

Defined in header <cstdio>
int scanf( const char* format, ... );                      (1)
int fscanf( std::FILE* stream, const char* format, ... );  (2)
int sscanf( const char* buffer, const char* format, ... ); (3)

Reads data from a variety of sources, interprets it according to format and stores the results into given locations. 🫢

  1. Reads the data from stdin.
  2. Reads the data from file stream stream. (yes, β€œstream stream,” she said it, not me πŸ’€)
  3. Reads the data from null-terminated character string buffer.

πŸŽ€ Parameters πŸŽ€

  • stream β€” input file stream to read from.
  • buffer β€” pointer to a null-terminated character string to read from.
  • format β€” pointer to a null-terminated character string specifying how to read the input.
  • ... β€” receiving arguments.

The format string consists of:

  • non-whitespace multibyte characters except %: each such character in the format string consumes exactly one identical character from the input stream, or causes the function to fail if the next character on the stream does not compare equal.
  • whitespace characters: any single whitespace character in the format string consumes all available consecutive whitespace characters from the input (determined as if by calling isspace in a loop). Note that there is no difference between "\n", " ", "\t\t", or other whitespace in the format string.
  • conversion specifications. Each conversion specification has the following format:
    • introductory % character.
    • (optional) assignment-suppressing character *. If this option is present, the function does not assign the result of the conversion to any receiving argument.
    • (optional) integer number (greater than zero) that specifies maximum field width, that is, the maximum number of characters that the function is allowed to consume when doing the conversion specified by the current conversion specification. Note that %s and %[ may lead to buffer overflow if the width is not provided. ⚠️ no cap, that part is serious ⚠️
    • (optional) length modifier that specifies the size of the receiving argument, that is, the actual destination type. This affects the conversion accuracy and overflow rules. The default destination type is different for each conversion type (see table below).
    • conversion format specifier.

The following format specifiers are available:

The length-modifier columns are hh, h, (none), l, ll, j, z, t, and L; hh, ll, j, z, and t are marked (C++11) in the original table. πŸ’«

🌈 Conversion specifier table vibes 🌈

  • % β€” Matches literal %. Argument type: hh β†’ N/A, h β†’ N/A, (none) β†’ N/A, l β†’ N/A, ll β†’ N/A, j β†’ N/A, z β†’ N/A, t β†’ N/A, L β†’ N/A.
  • c β€” Matches a character or a sequence of characters. If a width specifier is used, matches exactly width characters (the argument must be a pointer to an array with sufficient room). Unlike %s and %[, does not append the null character to the array. Argument type: hh β†’ N/A, h β†’ N/A, (none) β†’ char*, l β†’ wchar_t*, ll β†’ N/A, j β†’ N/A, z β†’ N/A, t β†’ N/A, L β†’ N/A.
  • s β€” Matches a sequence of non-whitespace characters (a string). If width specifier is used, matches up to width or until the first whitespace character, whichever appears first. Always stores a null character in addition to the characters matched (so the argument array must have room for at least width+1 characters). Argument type: hh β†’ N/A, h β†’ N/A, (none) β†’ char*, l β†’ wchar_t*, ll β†’ N/A, j β†’ N/A, z β†’ N/A, t β†’ N/A, L β†’ N/A.
  • [set] β€” Matches a non-empty sequence of character from set of characters. If the first character of the set is ^, then all characters not in the set are matched. If the set begins with ] or ^] then the ] character is also included into the set. It is implementation-defined whether the character - in the non-initial position in the scanset may be indicating a range, as in [0-9]. If width specifier is used, matches only up to width. Always stores a null character in addition to the characters matched (so the argument array must have room for at least width+1 characters). Argument type: same as s: hh β†’ N/A, h β†’ N/A, (none) β†’ char*, l β†’ wchar_t*, ll β†’ N/A, j β†’ N/A, z β†’ N/A, t β†’ N/A, L β†’ N/A.
  • d β€” Matches a decimal integer. The format of the number is the same as expected by strtol with the value 10 for the base argument. Argument type: hh β†’ signed char*, h β†’ short*, (none) β†’ int*, l β†’ long*, ll β†’ long long*, j β†’ intmax_t*, z β†’ signed size_t*, t β†’ ptrdiff_t*, L β†’ N/A.
  • i β€” Matches an integer. The format of the number is the same as expected by strtol with the value 0 for the base argument (base is determined by the first characters parsed). Argument type: same as d: hh β†’ signed char*, h β†’ short*, (none) β†’ int*, l β†’ long*, ll β†’ long long*, j β†’ intmax_t*, z β†’ signed size_t*, t β†’ ptrdiff_t*, L β†’ N/A.
  • u β€” Matches an unsigned decimal integer. The format of the number is the same as expected by strtoul with the value 10 for the base argument. Argument type: hh β†’ unsigned char*, h β†’ unsigned short*, (none) β†’ unsigned int*, l β†’ unsigned long*, ll β†’ unsigned long long*, j β†’ uintmax_t*, z β†’ size_t*, t β†’ N/A, L β†’ N/A.
  • o β€” Matches an unsigned octal integer. The format of the number is the same as expected by strtoul with the value 8 for the base argument. Argument type: same as u: hh β†’ unsigned char*, h β†’ unsigned short*, (none) β†’ unsigned int*, l β†’ unsigned long*, ll β†’ unsigned long long*, j β†’ uintmax_t*, z β†’ size_t*, t β†’ N/A, L β†’ N/A.
  • x, X β€” Matches an unsigned hexadecimal integer. The format of the number is the same as expected by strtoul with the value 16 for the base argument. Argument type: same as u: hh β†’ unsigned char*, h β†’ unsigned short*, (none) β†’ unsigned int*, l β†’ unsigned long*, ll β†’ unsigned long long*, j β†’ uintmax_t*, z β†’ size_t*, t β†’ N/A, L β†’ N/A.
  • n β€” Returns the number of characters read so far. No input is consumed. Does not increment the assignment count. If the specifier has assignment-suppressing operator defined, the behavior is undefined. Argument type: hh β†’ signed char*, h β†’ short*, (none) β†’ int*, l β†’ long*, ll β†’ long long*, j β†’ intmax_t*, z β†’ signed size_t*, t β†’ ptrdiff_t*, L β†’ N/A.
  • a, A (C++11), e, E, f, F, g, G β€” Matches a floating-point number. The format of the number is the same as expected by strtof. Argument type: hh β†’ N/A, h β†’ N/A, (none) β†’ float*, l β†’ double*, ll β†’ N/A, j β†’ N/A, z β†’ N/A, t β†’ N/A, L β†’ long double*.
  • p β€” Matches implementation defined character sequence defining a pointer. printf family of functions should produce the same sequence using %p format specifier. Argument type: hh β†’ N/A, h β†’ N/A, (none) β†’ void**, l β†’ N/A, ll β†’ N/A, j β†’ N/A, z β†’ N/A, t β†’ N/A, L β†’ N/A.

For every conversion specifier other than n, the longest sequence of input characters which does not exceed any specified field width and which either is exactly what the conversion specifier expects or is a prefix of a sequence it would expect, is what’s consumed from the stream. The first character, if any, after this consumed sequence remains unread. If the consumed sequence has length zero or if the consumed sequence cannot be converted as specified above, the matching failure occurs unless end-of-file, an encoding error, or a read error prevented input from the stream, in which case it is an input failure. 😭

All conversion specifiers other than [, c, and n consume and discard all leading whitespace characters (determined as if by calling isspace) before attempting to parse the input. These consumed characters do not count towards the specified maximum field width.

The conversion specifiers lc, ls, and l[ perform multibyte-to-wide character conversion as if by calling mbrtowc with an mbstate_t object initialized to zero before the first character is converted. πŸ¦‹

The conversion specifiers s and [ always store the null terminator in addition to the matched characters. The size of the destination array must be at least one greater than the specified field width.

⚠️ bestie, listen: the use of %s or %[, without specifying the destination array size, is as unsafe as std::gets. ⚠️

The correct conversion specifications for the fixed-width integer types (int8_t, etc) are defined in the header <cinttypes> (although SCNdMAX, SCNuMAX, etc is synonymous with %jd, %ju, etc).

There is a sequence point after the action of each conversion specifier; this permits storing multiple fields in the same "sink" variable.

When parsing an incomplete floating-point value that ends in the exponent with no digits, such as parsing "100er" with the conversion specifier %f, the sequence "100e" (the longest prefix of a possibly valid floating-point number) is consumed, resulting in a matching error (the consumed sequence cannot be converted to a floating-point number), with "r" remaining. Some existing implementations do not follow this rule and roll back to consume only "100", leaving "er", e.g. glibc bug 1765. πŸ’€

πŸ’– Return value πŸ’–

Number of receiving arguments successfully assigned (which may be zero in case a matching failure occurred before the first receiving argument was assigned), or EOF if input failure occurs before the first receiving argument was assigned. 🫢

πŸŒ€ Complexity πŸŒ€

Not guaranteed. Notably, some implementations of std::sscanf are O(N), where N = std::strlen(buffer) [1]. For performant string parsing, see std::from_chars. ✨

πŸ’­ Notes πŸ’­

Okay bestie, here's the whitespace tea: most conversion specifiers first consume all consecutive whitespace, so code like

std::scanf("%d", &a);
std::scanf("%d", &b);

will read two integers that are entered on different lines β€” the second %d will consume the newline left over by the first β€” or on the same line, separated by spaces or tabs, where the second %d will consume the spaces or tabs. Slay, but also lowkey chaotic. πŸ’…

The conversion specifiers that do not consume leading whitespace, such as %c, can be made to do so by using a whitespace character in the format string:

std::scanf("%d", &a);
std::scanf(" %c", &c); // ignore the endline after %d, then read a char
Heads up, bestie: some implementations of std::sscanf involve a call to std::strlen, which makes their runtime linear on the length of the entire string. This means that if std::sscanf is called in a loop to repeatedly parse values from the front of a string, your code might run in quadratic time (example). Not the quadratic-time jump scare 😭

πŸ§ͺ Example πŸ§ͺ

Run this code, bestie β€” it's giving "let me cook" energy:

#include <clocale>
#include <cstdio>
#include <iostream>

int main()
{
    int i, j;
    float x, y;
    char str1[10], str2[4];
    wchar_t warr[2];
    std::setlocale(LC_ALL, "en_US.utf8");

    char input[] = "25 54.32E-1 Thompson 56789 0123 56ß水";
    // parse as follows:
    // %d: an integer
    // %f: a floating-point value
    // %9s: a string of at most 9 non-whitespace characters
    // %2d: two-digit integer (digits 5 and 6)
    // %f: a floating-point value (digits 7, 8, 9)
    // %*d an integer which isn't stored anywhere
    // ' ': all consecutive whitespace
    // %3[0-9]: a string of at most 3 digits (digits 5 and 6)
    // %2lc: two wide characters, using multibyte to wide conversion
    const int ret = std::sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc",
                                &i, &x, str1, &j, &y, str2, warr);

    std::cout << "Converted " << ret << " fields:\n"
                 "i = " << i << "\n"
                 "x = " << x << "\n"
                 "str1 = " << str1 << "\n"
                 "j = " << j << "\n"
                 "y = " << y << "\n"
                 "str2 = " << str2 << std::hex << "\n"
                 "warr[0] = U+" << (int)warr[0] << "\n"
                 "warr[1] = U+" << (int)warr[1] << '\n';
}

Output:

Converted 7 fields:
i = 25
x = 5.432
str1 = Thompson
j = 56
y = 789
str2 = 56
warr[0] = U+df
warr[1] = U+6c34

πŸ‘€ See also πŸ‘€

  • vscanf, vfscanf, vsscanf β€” reads formatted input from stdin, a file stream or a buffer using variable argument list; the reference tags these with (C++11) and (function). 🫢
  • fgets β€” gets a character string from a file stream (function).
  • printf, fprintf, sprintf β€” prints formatted output to stdout, a file stream or a buffer (function).
  • snprintf β€” prints formatted output to a buffer, tagged (C++11) and (function).
  • from_chars β€” converts a character sequence to an integer or floating-point value, tagged (C++17) and (function).
  • C documentation for scanf, fscanf, sscanf β€” the C-side lore, iykyk. πŸ¦‹

Source/version/date sign-off: this page is from cppreference.com, dated 2024.06.10, and it's the page for std::scanf,...std::sscanf(3). Periodt, bestie β€” that's the whole part 2. πŸ’–βœ¨

πŸ“¦ where this page comes from