Monday, November 8, 2010

Wide String Shims for std::exception

The new release of STLSoft supports seamless use of exceptions with FastFormat (and Pantheios) in wide-string builds; described on this post on the STLSoft project blog.

Thursday, October 14, 2010

fmt::flush

As discussed in the latest instalment of Quality Matters, having flushing output streams and verifying their status is a pre-requisite of writing a robust program. Doing this with the IOStreams is a somewhat onerous task; see the column for details. Using the new flush() function, introduced in version 0.6.2, makes doing so with FastFormat a breeze, as in:


#include <fastformat/ff.hpp>
#include <fastformat/sinks/ostream.hpp>

#include <iostream>

int main()
{
 ff::flush(ff::writeln(std::cout, "Hello, world!"));

 return 0;
}

FastFormat 0.6.2 released

I've just released version 0.6.2 of FastFormat, containing a number of improvements and several new features, which will be detailed in a series of forthcoming posts on this blog. The new features include the flush() function, whose purpose and behaviour is described in the latest instalment of my Quality Matters column in October's instalment of ACCU's Overload.

Wednesday, June 23, 2010

FastFormat 0.6.1 (alpha 1) released

I'm currently releasing version 0.6.1 (alpha 1) of FastFormat. Although 0.6 will contain a number of new additions, the first alpha release contains no functional changes. It's entirely about releasing some performance improvements that I've had in the bag for a long time, but keep overlooking.

The reason I'm doing so now is, in part, that there's been a thread on the FastFormat Help Forum concerning one potential user's assertion that FastFormat (and some of the STLSoft components upon which it relies) is not as quick as my previous claims have indicated. Thankfully, it was easy to perform some simple tests and ascertain that, so far, nothing's overtaken it in terms of performance. In one of the tests I added FastFormat (both write() and fmt()) and STLSoft's integer_to_string to an integer-to-string conversion test that included, amongst other things, Boost.Spirit.Karma. I'm pleased to report - with Visual C++ 9, at least (haven't had time to use other compilers yet) - that FastFormat holds its own, and with the new optimisations in 0.6 it is the fastest of the possible format components, including ~10% faster than Karma.

The only thing faster is the low-level stlsoft::integer_to_string() function that FastFormat uses internally, which is a good 30-40% faster than the rest. (Not that I'd advocate using it in application code, of course, since it's not so expressive, and requires pointer and buffer-length parameters.)

I owe thanks to the OP for causing me to look again and confirm FastFormat's performance advantages, and to release the long-awaited optimisations.

Sunday, June 6, 2010

FastFormat 0.5.8 released

FastFormat 0.5.8 is released, containing a fix to ensure that a replacement parameter with a maximum width of 0 truncates (completely) the resulting field. For example:

    string_t sink;

    ff::fmt(sink, "{0,,0}", "abc");

    assert("" == sink);

Wednesday, June 2, 2010

format_iterator on Dr Dobb's

Dr. Dobb's have just published a new article, "C++ and format_iterator", describing the design and implementation of the FastFormat library's format_iterator component.

The article describes how FastFormat's flexiblity, expressiveness and type-safety has been combined with the output iterator concept  to produce the fastformat::format_iterator component. Applying STL-extension techniques described in Extended STL, volume 1, the format_iterator() component is able to create an output iterator that can receive arbitrate types, apply a format string or arbitrary complexity, and write to an arbitrary sink, as in:

 #include <fastformat/ff.hpp>
 #include <fastformat/iterators/format_iterator.hpp>
 #include <fastformat/sinks/ostream.hpp>

 int          numbers[] = { -2, -1, 0, 1, 2 };
 char const*  strings[] = { "abc", "def", "ghi" };
 std::string  prefix = "\t";
 char const*  suffix = "\n";


 std::copy(
   numbers, numbers + 5
 , ff::format_iterator(std::cout, "[{0}]"));

 // outputs "[-2][-1][0][1][2]"


 std::copy(
   strings, strings + 3
 , ff::format_iterator(std::cout, "{1}'{0}'{2}", prefix, suffix));

 // outputs:
 //     'abc'
 //     'def'
 //     'ghi'



This is the fourth article on the FastFormat library, following on from the introductory series of three published in ACCU's Overload magazine:

Wednesday, May 12, 2010

Beware of the \r\n gotcha on Windows

If (as I have just done) you decide to FastFormat to prepare intermediate text for output, and your program runs on Windows, beware of the writeln() and fmtln() API functions. Consider the following code

std::string s;

ff::writeln(s, "hello"); // s => "hello\r\n"

ff::write(std::cout, s); // writes "hello\r\r\n"

This occurs because the underlying C standard library expands each standard end-of-line (EOL) character \n to the Windows-specific EOL sequence \r\n.

Instead, use the *ln() functions on the output, as in:

ff::write(s, "hello"); // s => "hello"

ff::writeln(std::cout, s); // writes "hello\r\n"

Remember that FastFormat "appends" to sinks

A user recently posted a note on the Help forum, suggesting that FastFormat was up to 100 times slower than MFC's CString::Format(). Thankfully that's not the case, and FastFormat appears to be faster than CString::Format() in even the simple case suggested.

The reason this appeared to be so was because the test program reused the same CString instance in each call to fastformat::fmt(), resulting in concatenation to a huge size. The fault here is no doubt mine, for not having made the nature of FastFormat's formatting more clear in the documentation. So I'll try and do so briefly now.


All FastFormat formatting is appending, and this is a deliberate design decision. In part, this is to achieve consistency between immediate sinks such as strings, and stream sinks (such as std::cout, stdout, ...). Also, it's useful to be able to break apart large or complex formatting operations into statements, without sacrificing performance or expressiveness. (Note: there'll always a small performance penalty for such things, but it will be insignificant in most cases where the size and complexity of the statement demands breaking up.) Consider the following example:

std::string s;
ff::fmt(s, "{0};{1};{2}|{3};{4};{5}|{6};{7};{8}|{9};{10};{11}|", a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11);

The same can be achieved as follows:


std::string s;
ff::fmt(s, "{0};{1};{2}|", a0, a1, a2);
ff::fmt(s, "{0};{1};{2}|", a3, a4, a5);
ff::fmt(s, "{0};{1};{2}|", a6, a7, a8);
ff::fmt(s, "{0};{1};{2}|", a9, a10, a11);


In real-world cases, such clarity may be worth paying a few more extra cycles for.

Sunday, March 14, 2010

Sink creator function

Just started working on a creator function, called to_sink(), which will allow sinks to be generated in situ from free functions. A little like a bind, just not as complicated (I hope).

An example of use would be:


std::copy(files.begin(), files.end()
  , ff::format_iterator(ff::to_sink(::OutputDebugString)
                      , "\t{0}\n"));

Hopefully I should have something releasable in the next week or so.

Tuesday, March 9, 2010

FastFormat 0.5.4 released: VC++ 10 support

FastFormat now supports Visual C++ 10. Note that it requires STLSoft 1.9.96 (or later).

Monday, March 8, 2010

VC++ 10 support imminent

Currently adding VC++ support to STLSoft. Should have FastFormat up and working automatically.

FastFormat 0.5.3 released

Just released the latest version of FastFormat, fixing some minor compilation defects encountered on Fedora.

The problem was my omission of an explicit inclusion of limits.h, required for use of INT_MIN (and INT_MAX) in test.component.inserter.integer.cpp and test.scratch.inserter.integer.cpp. Now fixed.

Thanks to yozara.

Thursday, February 4, 2010

FastFormat 0.5.1 (alpha 1) released

The latest version of FastFormat, 0.5.1 (alpha 1), is released. Along with a bunch of minor changes, the main addition is the support for hex integer conversion, via to_x()/to_X(), as in:

    ff::fmtln(stm, "i={0}", ff::to_x(123456)); // i=1e240
    ff::fmtln(stm, "i={0}", ff::to_x(123456, 0, 10)); // i=000001e240


and, if you want it uppercase:


    ff::fmtln(stm, "i={0}", ff::to_X(123456)); // i=1E240
    ff::fmtln(stm, "i={0}", ff::to_X(123456, 0, 10)); // i=000001E240