Submit a comment to an "Available C++ Libraries FAQ" entry

CategoryLibraries available to download (D-L)

FastFormat - 100% type-safe, infinitely extensible, very high performance C++ format library

FastFormat is an open source C++ formatting library, whose design parameters are 100% type-safety, efficiency, and flexibility. It is simple to use, highly-portable (platform and compiler-independent), and is infinitely extensible.

FastFormat supports output/formatting of statements of arbitrary complexity, consisting of heterogeneous types. It provides two APIs:

• Format: provides replacement-based formatting, like Streams (printf()-family), Boost.Format()
• Write: provides concatenation-based formatting, like IOStreams

FastFormat writes to output "sinks", which can be of arbitrary type. It implicitly supports any type that is structurally conformant with the standard library's string, and the library includes adaptors to allow writing to:

• std::ostream
• FILE*
• STLSoft's auto_buffer
• C-style string buffers and character buffers
• ACE's ACE_String
• ATL's CComBSTR
• MFC's CString
• std::stringstream
• speech (currently Windows-only)
• Windows' OutputDebugString()
• Windows' MessageBox()

FastFormat is robust. Both APIs are 100% type-safe - something no other C/C++ widely-used formatting library can claim - and with the Write API it is impossible to compile defective code.

FastFormat is fast. The processing of each statement involves at most one memory allocation to hold the entire statement, and each statement element is measured and copied exactly once. As a consequence, the library is on a par with (the type-unsafe) C's Streams (printf()-family) of functions, faster than C++'s IOStreams (by 2-10x) and Loki.SafeFormat (by 1-5x), and considerably faster than Boost.Format (by 5-17x).

FastFormat supports I18N/L10N by using numbered arguments, enabling reordering of arguments by exchanging format strings. The library comes with a number of resource bundles, classes whose instances can load sets of localised resource strings for use as format strings.

FastFormat does not contain any compiler-specific or platform-specific constructs. It supports UNIX (including Linux and Mac OS-X), and Windows, and should work with any operating system. It is known to be compatible with Comeau (4.3.3+), GCC (3.4+), Intel (8+), Metrowerks (8+), Microsoft Visual C++ (6.0+), and should work with any reasonably modern C++ compiler.

FastFormat is completely free and includes source released under a BSD-style license. Commercial customisations and related consultancy are provided by Synesis Software.

FastFormat features in a series of articles in ACCU's peer-reviewed Overload magazine:

• An Introduction to FastFormat, part 1: The State of the Art, Matthew Wilson, Overload #89, February 2009
• An Introduction to FastFormat, part 2: Custom Argument and Sink Types, Matthew Wilson, Overload #90, April 2009
• An Introduction to FastFormat, part 3: Solving Real Problems, Quickly, Matthew Wilson, Overload #91, June 2009

Examples:

• Emulate Streams' ability to specify widths:
  
    printf("[%-10d, %10d]\n", 123, -456);

  fastformat::fmtln(std::cout, "[{0,10,,<}, {1,10}]", 123, -456);
  
  Both produce the output:
  
    [123       ,       -456]
  
  
• Handle heterogeneous types:
  
    struct connection_t
  {
    std::string     connectionId;
    struct in_addr  remoteAddress;
    struct in_addr  localAddress;
    unsigned short  port;
    unsigned long   numBytesTransferred;
    struct tm       completionTime;
  };

  void log_connection(connection_t const& conn)
  {
    fastformat::fmtln(
      std::cout
    , "{0} {5} {1} {2} {3} {4}"
    , conn.connectionId
    , conn.remoteAddress
    , conn.localAddress
    , conn.port
    , conn.numBytesTransferred
    , conn.completionTime
  );
  }
  
  Produces output like:
  
    channel-1 May 03 03:50:41 2009 192.168.160.247 127.0.0.1 5651 102401
  
  
• Emulate Boost.Format's absolute tabulations (with a little indirection):
  
    std::cout
      << boost::format("%1% %2%, %|20t|lives at %3%\n")
          % "Mr"
          % "Smith"
          % "the Smith residence"
      << std::endl;


  std::string scratch;

  fastformat::fmtln(
      std::cout
  ,   "{0,20,,<}lives at {1}"
  ,   fastformat::fmt(
          scratch
      ,   "{0} {1}, "
      ,   "Mr"
      ,   "Smith"
      )
  ,   "the Smith residence"
  );

  
  Both produce the output:
  
    Mr Smith,           lives at the Smith residence
  
  

Performance:

FastFormat's performance has been extensively tested, and in every case it has superior performance to the C++ standard library's IOStreams, Boost.Format and Loki.SafeFormat. In most cases it has equivalent performance to the (type-unsafe) C standard library's Streams (printf()-family). Test results are included on the project website, and in the first in the Overload article series; the third article in the series has a further set of four performance tests, based on real-world uses of FastFormat in commercial projects.

Features:

• 100% type-safe
• Presents a natural syntax
• Infinitely extensible
• Highly-efficient:
• no intermediate memory allocations
• no intermediate string copying
• no repetition of any string-length calculations
• at most one allocation required to produce the resultant string
• Verified with Borland, Metrowerks' CodeWarrior, Digital Mars, GCC, Intel, and Visual C++ compilers
• Verified on Linux, Mac OS-X, and Windows

Requirements:

    STLSoft libraries (1.9.1 beta 81 or later); 100% header-only open-source.

Do not expect an immediate response - the contents of this form will be added to a queue, which I process manually about once a week. If you don't fill in your email address correctly, you will not (obviously) get any reply at all. Other invalid information may result in a mailed request for clarification.

Enter your comment in the areas provided below. Be sure to include your name and email address.

Please don't bother trying to post spam or links to dodgy web sites - everything you post here is reviewed by a human being before being released for public viewing.

For more information on any of Trumphurst's products and services, please

• Contact us using our contact form
• Phone us at +44 1691 659510 (In the U.K., replace "+44" with "0". Elsewhere, replace "+" with your international dialling code.)