Skip to content

Latest commit

 

History

History
900 lines (641 loc) · 32.9 KB

ChangeLog.rst

File metadata and controls

900 lines (641 loc) · 32.9 KB
Raw

3.0.0 - 2016-05-07

  • The project has been renamed from C++ Format (cppformat) to fmt for consistency with the used namespace and macro prefix (#307). Library headers are now located in the fmt directory:

    #include "fmt/format.h"

    Including format.h from the cppformat directory is deprecated but works via a proxy header which will be removed in the next major version.

    The documentation is now available at http://fmtlib.net.

  • Added support for strftime-like date and time formatting (#283):

    #include "fmt/time.h"

std::time_t t = std::time(nullptr);
// Prints "The date is 2016-04-29." (with the current date)
fmt::print("The date is {:%Y-%m-%d}.", *std::localtime(&t));

  • std::ostream support including formatting of user-defined types that provide overloaded operator<< has been moved to fmt/ostream.h:

    #include "fmt/ostream.h"

class Date {
  int year_, month_, day_;
public:
  Date(int year, int month, int day) : year_(year), month_(month), day_(day) {}

  friend std::ostream &operator<<(std::ostream &os, const Date &d) {
    return os << d.year_ << '-' << d.month_ << '-' << d.day_;
  }
};

std::string s = fmt::format("The date is {}", Date(2012, 12, 9));
// s == "The date is 2012-12-9"

  • Added support for custom argument formatters (#235).

  • Added support for locale-specific integer formatting with the n specifier (#305):

    std::setlocale(LC_ALL, "en_US.utf8");
fmt::print("cppformat: {:n}\n", 1234567); // prints 1,234,567

  • Sign is now preserved when formatting an integer with an incorrect printf format specifier (#265):

    fmt::printf("%lld", -42); // prints -42

    Note that it would be an undefined behavior in std::printf.

  • Length modifiers such as ll are now optional in printf formatting functions and the correct type is determined automatically (#255):

    fmt::printf("%d", std::numeric_limits<long long>::max());

    Note that it would be an undefined behavior in std::printf.

  • Added initial support for custom formatters (#231).

  • Fixed detection of user-defined literal support on Intel C++ compiler (#311, #312). Thanks to @dean0x7d (Dean Moldovan) and @speth (Ray Speth).

  • Reduced compile time (#243, #249, #317):

    https://cloud.githubusercontent.com/assets/4831417/11614060/b9e826d2-9c36-11e5-8666-d4131bf503ef.png https://cloud.githubusercontent.com/assets/4831417/11614080/6ac903cc-9c37-11e5-8165-26df6efae364.png

    Thanks to @dean0x7d (Dean Moldovan).

  • Compile test fixes (#313). Thanks to @dean0x7d (Dean Moldovan).

  • Documentation fixes (#239, #248, #252, #258, #260, #301, #309). Thanks to @ReadmeCritic @Gachapen (Magnus Bjerke Vik) and @jwilk (Jakub Wilk).

  • Fixed compiler and sanitizer warnings (#244, #256, #259, #263, #274, #277, #286, #291, #296, #308) Thanks to @mwinterb, @pweiskircher (Patrik Weiskircher), @Naios.

  • Improved compatibility with Windows Store apps (#280, #285) Thanks to @mwinterb.

  • Added tests of compatibility with older C++ standards (#273). Thanks to @niosHD.

  • Fixed Android build (#271). Thanks to @newnon.

  • Changed ArgMap to be backed by a vector instead of a map. (#261, #262). Thanks to @mwinterb.

  • Added fprintf overload that writes to a std::ostream (#251). Thanks to nickhutchinson (Nicholas Hutchinson).

  • Export symbols when building a Windows DLL (#245). Thanks to macdems (Maciek Dems).

  • Fixed compilation on Cygwin (#304).

  • Implemented a workaround for a bug in Apple LLVM version 4.2 of clang (#276).

  • Implemented a workaround for Google Test bug #705 on gcc 6 (#268). Thanks to octoploid.

  • Removed Biicode support because the latter has been discontinued.

2.1.1 - 2016-04-11

  • The install location for generated CMake files is now configurable via the FMT_CMAKE_DIR CMake variable (#299). Thanks to @niosHD.
  • Documentation fixes (#252).

2.1.0 - 2016-03-21

  • Project layout and build system improvements (#267):

    • The code have been moved to the cppformat directory. Including format.h from the top-level directory is deprecated but works via a proxy header which will be removed in the next major version.
    • C++ Format CMake targets now have proper interface definitions.
    • Installed version of the library now supports the header-only configuration.
    • Targets doc, install, and test are now disabled if C++ Format is included as a CMake subproject. They can be enabled by setting FMT_DOC, FMT_INSTALL, and FMT_TEST in the parent project.

    Thanks to @niosHD.

2.0.1 - 2016-03-13

2.0.0 - 2015-12-01

General

  • [Breaking] Named arguments (#169, #173, #174):

    fmt::print("The answer is {answer}.", fmt::arg("answer", 42));

    Thanks to @jamboree.

  • [Experimental] User-defined literals for format and named arguments (#204, #206, #207):

    using namespace fmt::literals;
fmt::print("The answer is {answer}.", "answer"_a=42);

    Thanks to @dean0x7d (Dean Moldovan).

  • [Breaking] Formatting of more than 16 arguments is now supported when using variadic templates (#141). Thanks to @Shauren.

  • Runtime width specification (#168):

    fmt::format("{0:{1}}", 42, 5); // gives "   42"

    Thanks to @jamboree.

  • [Breaking] Enums are now formatted with an overloaded std::ostream insertion operator (operator<<) if available (#232).

  • [Breaking] Changed default bool format to textual, "true" or "false" (#170):

    fmt::print("{}", true); // prints "true"

    To print bool as a number use numeric format specifier such as d:

    fmt::print("{:d}", true); // prints "1"

  • fmt::printf and fmt::sprintf now support formatting of bool with the %s specifier giving textual output, "true" or "false" (#223):

    fmt::printf("%s", true); // prints "true"

    Thanks to @LarsGullik.

  • [Breaking] signed char and unsigned char are now formatted as integers by default (#217).

  • [Breaking] Pointers to C strings can now be formatted with the p specifier (#223):

    fmt::print("{:p}", "test"); // prints pointer value

    Thanks to @LarsGullik.

  • [Breaking] fmt::printf and fmt::sprintf now print null pointers as (nil) and null strings as (null) for consistency with glibc (#226). Thanks to @LarsGullik.

  • [Breaking] fmt::(s)printf now supports formatting of objects of user-defined types that provide an overloaded std::ostream insertion operator (operator<<) (#201):

    fmt::printf("The date is %s", Date(2012, 12, 9));

  • [Breaking] The Buffer template is now part of the public API and can be used to implement custom memory buffers (#140). Thanks to @polyvertex (Jean-Charles Lefebvre).

  • [Breaking] Improved compatibility between BasicStringRef and std::experimental::basic_string_view (#100, #159, #183):

    • Comparison operators now compare string content, not pointers
    • BasicStringRef::c_str replaced by BasicStringRef::data
    • BasicStringRef is no longer assumed to be null-terminated

    References to null-terminated strings are now represented by a new class, BasicCStringRef.

  • Dependency on pthreads introduced by Google Test is now optional (#185).

  • New CMake options FMT_DOC, FMT_INSTALL and FMT_TEST to control generation of doc, install and test targets respectively, on by default (#197, #198, #200). Thanks to @maddinat0r (Alex Martin).

  • noexcept is now used when compiling with MSVC2015 (#215). Thanks to @dmkrepo (Dmitriy).

  • Added an option to disable use of windows.h when FMT_USE_WINDOWS_H is defined as 0 before including format.h (#171). Thanks to @alfps (Alf P. Steinbach).

  • [Breaking] windows.h is now included with NOMINMAX unless FMT_WIN_MINMAX is defined. This is done to prevent breaking code using std::min and std::max and only affects the header-only configuration (#152, #153, #154). Thanks to @DevO2012.

  • Improved support for custom character types (#171). Thanks to @alfps (Alf P. Steinbach).

  • Added an option to disable use of IOStreams when FMT_USE_IOSTREAMS is defined as 0 before including format.h (#205, #208). Thanks to @JodiTheTigger.

  • Improved detection of isnan, isinf and signbit.

Optimization

  • Made formatting of user-defined types more efficient with a custom stream buffer (#92, #230). Thanks to @NotImplemented.
  • Further improved performance of fmt::Writer on integer formatting and fixed a minor regression. Now it is ~7% faster than karma::generate on Karma's benchmark (#186).
  • [Breaking] Reduced compiled code size (#143, #149).

Distribution

Documentation

Fixes

1.1.0 - 2015-03-06

  • Added BasicArrayWriter, a class template that provides operations for formatting and writing data into a fixed-size array (#105 and #122):

    char buffer[100];
fmt::ArrayWriter w(buffer);
w.write("The answer is {}", 42);

  • Added 0 A.D. and PenUltima Online (POL) to the list of notable projects using C++ Format.

  • C++ Format now uses MSVC intrinsics for better formatting performance (#115, #116, #118 and #121). Previously these optimizations where only used on GCC and Clang. Thanks to @CarterLi and @objectx.

  • CMake install target (#119). Thanks to @TrentHouliston.

    You can now install C++ Format with make install command.

  • Improved Biicode support (#98 and #104). Thanks to @MariadeAnton and @franramirez688.

  • Improved support for building with Android NDK (#107). Thanks to @newnon.

    The android-ndk-example repository provides and example of using C++ Format with Android NDK:

    https://raw.githubusercontent.com/fmtlib/android-ndk-example/master/screenshot.png

  • Improved documentation of SystemError and WindowsError (#54).

  • Various code improvements (#110, #111 #112). Thanks to @CarterLi.

  • Improved compile-time errors when formatting wide into narrow strings (#117).

  • Fixed BasicWriter::write without formatting arguments when C++11 support is disabled (#109).

  • Fixed header-only build on OS X with GCC 4.9 (#124).

  • Fixed packaging issues (#94).

  • Added changelog (#103).

1.0.0 - 2015-02-05

  • Add support for a header-only configuration when FMT_HEADER_ONLY is defined before including format.h:

    #define FMT_HEADER_ONLY
#include "format.h"

  • Compute string length in the constructor of BasicStringRef instead of the size method (#79). This eliminates size computation for string literals on reasonable optimizing compilers.

  • Fix formatting of types with overloaded operator << for std::wostream (#86):

    fmt::format(L"The date is {0}", Date(2012, 12, 9));

  • Fix linkage of tests on Arch Linux (#89).

  • Allow precision specifier for non-float arguments (#90):

    fmt::print("{:.3}\n", "Carpet"); // prints "Car"

  • Fix build on Android NDK (#93)

  • Improvements to documentation build procedure.

  • Remove FMT_SHARED CMake variable in favor of standard BUILD_SHARED_LIBS.

  • Fix error handling in fmt::fprintf.

  • Fix a number of warnings.

0.12.0 - 2014-10-25

  • [Breaking] Improved separation between formatting and buffer management. Writer is now a base class that cannot be instantiated directly. The new MemoryWriter class implements the default buffer management with small allocations done on stack. So fmt::Writer should be replaced with fmt::MemoryWriter in variable declarations.

    Old code:

    fmt::Writer w;

    New code:

    fmt::MemoryWriter w;

    If you pass fmt::Writer by reference, you can continue to do so:

    void f(fmt::Writer &w);

    This doesn't affect the formatting API.

  • Support for custom memory allocators (#69)

  • Formatting functions now accept signed char and unsigned char strings as arguments (#73):

    auto s = format("GLSL version: {}", glGetString(GL_VERSION));

  • Reduced code bloat. According to the new benchmark results, cppformat is close to printf and by the order of magnitude better than Boost Format in terms of compiled code size.

  • Improved appearance of the documentation on mobile by using the Sphinx Bootstrap theme:

    Old

    New

    old

    new

0.11.0 - 2014-08-21

  • Safe printf implementation with a POSIX extension for positional arguments:

    fmt::printf("Elapsed time: %.2f seconds", 1.23);
fmt::printf("%1$s, %3$d %2$s", weekday, month, day);

  • Arguments of char type can now be formatted as integers (Issue #55):

    fmt::format("0x{0:02X}", 'a');

  • Deprecated parts of the API removed.

  • The library is now built and tested on MinGW with Appveyor in addition to existing test platforms Linux/GCC, OS X/Clang, Windows/MSVC.

0.10.0 - 2014-07-01

Improved API

  • All formatting methods are now implemented as variadic functions instead of using operator<< for feeding arbitrary arguments into a temporary formatter object. This works both with C++11 where variadic templates are used and with older standards where variadic functions are emulated by providing lightweight wrapper functions defined with the FMT_VARIADIC macro. You can use this macro for defining your own portable variadic functions:

    void report_error(const char *format, const fmt::ArgList &args) {
  fmt::print("Error: {}");
  fmt::print(format, args);
}
FMT_VARIADIC(void, report_error, const char *)

report_error("file not found: {}", path);

    Apart from a more natural syntax, this also improves performance as there is no need to construct temporary formatter objects and control arguments' lifetimes. Because the wrapper functions are very lightweight, this doesn't cause code bloat even in pre-C++11 mode.

  • Simplified common case of formatting an std::string. Now it requires a single function call:

    std::string s = format("The answer is {}.", 42);

    Previously it required 2 function calls:

    std::string s = str(Format("The answer is {}.") << 42);

    Instead of unsafe c_str function, fmt::Writer should be used directly to bypass creation of std::string:

    fmt::Writer w;
w.write("The answer is {}.", 42);
w.c_str();  // returns a C string

    This doesn't do dynamic memory allocation for small strings and is less error prone as the lifetime of the string is the same as for std::string::c_str which is well understood (hopefully).

  • Improved consistency in naming functions that are a part of the public API. Now all public functions are lowercase following the standard library conventions. Previously it was a combination of lowercase and CapitalizedWords. Issue #50.

  • Old functions are marked as deprecated and will be removed in the next release.

Other Changes

  • Experimental support for printf format specifications (work in progress):

    fmt::printf("The answer is %d.", 42);
std::string s = fmt::sprintf("Look, a %s!", "string");

  • Support for hexadecimal floating point format specifiers a and A:

    print("{:a}", -42.0); // Prints -0x1.5p+5
print("{:A}", -42.0); // Prints -0X1.5P+5

  • CMake option FMT_SHARED that specifies whether to build format as a shared library (off by default).

0.9.0 - 2014-05-13

  • More efficient implementation of variadic formatting functions.

  • Writer::Format now has a variadic overload:

    Writer out;
out.Format("Look, I'm {}!", "variadic");

  • For efficiency and consistency with other overloads, variadic overload of the Format function now returns Writer instead of std::string. Use the str function to convert it to std::string:

    std::string s = str(Format("Look, I'm {}!", "variadic"));

  • Replaced formatter actions with output sinks: NoAction -> NullSink, Write -> FileSink, ColorWriter -> ANSITerminalSink. This improves naming consistency and shouldn't affect client code unless these classes are used directly which should be rarely needed.

  • Added ThrowSystemError function that formats a message and throws SystemError containing the formatted message and system-specific error description. For example, the following code

    FILE *f = fopen(filename, "r");
if (!f)
  ThrowSystemError(errno, "Failed to open file '{}'") << filename;

    will throw SystemError exception with description "Failed to open file '<filename>': No such file or directory" if file doesn't exist.

  • Support for AppVeyor continuous integration platform.

  • Format now throws SystemError in case of I/O errors.

  • Improve test infrastructure. Print functions are now tested by redirecting the output to a pipe.

0.8.0 - 2014-04-14

  • Initial release