liveBook · Manning

Format string

As explained in 100 C++ Mistakes and How to Avoid Them

A format string is a character string containing literal text and directives that control formatted input or output.

A format string mixes literal text with directives that control formatted input or output. In C-style functions, those directives must match the types, number, and order of the supplied arguments; mistakes can produce incorrect results or undefined behavior. section 4.3 section 6.1

Format strings can make routine maintenance error-prone:

  • For output, swapping a placeholder or argument may compile while producing surprising behavior. A student record illustrates the risk; std::format offers a type-safe alternative, while string streams can become awkward. section 4.3
  • For input, specifiers can be difficult to parse: for example, reading a double requires %lf, and a wrong specifier can yield bad data or a crash. Stream extraction uses the destination types instead. section 6.1
Listing 4.7 Using std::format for fine-grained formatting functionality
struct Student {
    std::string name;
    int age;
    double gpa;
    Student(const std::string& n, int a, double g) : name(n), age(a), gpa(g) {}
};
 
int main() {
    Student dinah("Dinah", 26, 3.3);
    std::cout << std::format("{} is a student aged {} carrying a gpa of 
    {:0^4}", dinah.name, dinah.age, dinah.gpa) << '\n';     #1
    return 0;
}
#1 sprintf-like functionality with type-safe behavior

Compare the student output example with sprintf-style formatting: std::format keeps the placeholders while providing type-safe behavior. section 4.3

Listing 6.1 Using complicated format specifiers to determine conversions
int main() {
    const char* str = "3.14159 042 boxes .3";
    double pi;
    int cats;
    int mice;
    char buffer[5];
 
    int count = sscanf(str, "%lf%*c%i%s%d", &pi, &cats, 
        buffer, &mice);                                       #1
    if (count != 4)                                           #2
        std::cout << "error reading value " << count+1 << '\n';
 
    printf("%f being eaten by %d cats in %s along with %d mice\n",
        pi, cats, mice, mice);                                #3
    return 0;
}

The sscanf example shows how several conversion directives can make input parsing hard to read and maintain. section 6.1

How 100 C++ Mistakes and How to Avoid Them covers it

How deep it goes
Explains type and argument mismatches, undefined behavior, difficult specifiers, and C++ alternatives through examples.
Examples
Uses student-record output and sscanf parsing of numeric text to demonstrate formatting risks and alternatives.
What you can do after
Apply std::format for type-safe output and stream extraction for typed input.
How it connects
Connects printf and scanf to string streams and std::format.

Also explained in

Compare how 7 books explain format string →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of 100 C++ Mistakes and How to Avoid Them. The section links point to the parts of the book it draws on.