X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=folly%2FFormat-inl.h;h=ea9ce8752f06b7d8938ddd156a9e5310571fa386;hb=23e1c2d30b3314f37e0642afb3a84aff7e6b93a0;hp=b8eb0a164c8fb9acb176acf7dc90f0a601abd049;hpb=8e8b5e75d573305b7a9c34f4a405be5df0f17738;p=folly.git diff --git a/folly/Format-inl.h b/folly/Format-inl.h index b8eb0a16..ea9ce875 100644 --- a/folly/Format-inl.h +++ b/folly/Format-inl.h @@ -1,5 +1,5 @@ /* - * Copyright 2013 Facebook, Inc. + * Copyright 2015 Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,13 +18,28 @@ #error This file may only be included from Format.h. #endif -#include "folly/Exception.h" -#include "folly/Traits.h" +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +// Ignore -Wformat-nonliteral warnings within this file +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wformat-nonliteral" namespace folly { namespace detail { +// Updates the end of the buffer after the comma separators have been added. +void insertThousandsGroupingUnsafe(char* start_buffer, char** end_buffer); + extern const char formatHexUpper[256][2]; extern const char formatHexLower[256][2]; extern const char formatOctal[512][3]; @@ -137,22 +152,20 @@ size_t uintToBinary(char* buffer, size_t bufLen, Uint v) { } // namespace detail - -template -Formatter::Formatter(StringPiece str, Args&&... args) - : str_(str), - values_(FormatValue::type>( - std::forward(args))...) { +template +BaseFormatter::BaseFormatter(StringPiece str, + Args&&... args) + : str_(str), + values_(FormatValue::type>( + std::forward(args))...) { static_assert(!containerMode || sizeof...(Args) == 1, "Exactly one argument required in container mode"); } -template +template template -void Formatter::operator()(Output& out) const { - auto p = str_.begin(); - auto end = str_.end(); - +void BaseFormatter::operator()(Output& out) + const { // Copy raw string (without format specifiers) to output; // not as simple as we'd like, as we still need to translate "}}" to "}" // and throw if we see any lone "}" @@ -169,11 +182,16 @@ void Formatter::operator()(Output& out) const { out(StringPiece(p, q)); p = q; - CHECK(p != end && *p == '}') << "single '}' in format string"; + if (p == end || *p != '}') { + throw BadFormatArg("folly::format: single '}' in format string"); + } ++p; } }; + auto p = str_.begin(); + auto end = str_.end(); + int nextArg = 0; bool hasDefaultArgIndex = false; bool hasExplicitArgIndex = false; @@ -186,7 +204,9 @@ void Formatter::operator()(Output& out) const { outputString(StringPiece(p, q)); p = q + 1; - CHECK(p != end) << "'{' at end of format string"; + if (p == end) { + throw BadFormatArg("folly::format: '}' at end of format string"); + } // "{{" -> "{" if (*p == '{') { @@ -197,13 +217,17 @@ void Formatter::operator()(Output& out) const { // Format string q = static_cast(memchr(p, '}', end - p)); - CHECK(q != end) << "missing ending '}'"; + if (q == nullptr) { + throw BadFormatArg("folly::format: missing ending '}'"); + } FormatArg arg(StringPiece(p, q)); p = q + 1; int argIndex = 0; auto piece = arg.splitKey(); // empty key component is okay if (containerMode) { // static + arg.enforce(arg.width != FormatArg::kDynamicWidth, + "dynamic field width not supported in vformat()"); if (piece.empty()) { arg.setNextIntKey(nextArg++); hasDefaultArgIndex = true; @@ -213,31 +237,46 @@ void Formatter::operator()(Output& out) const { } } else { if (piece.empty()) { + if (arg.width == FormatArg::kDynamicWidth) { + arg.enforce(arg.widthIndex == FormatArg::kNoIndex, + "cannot provide width arg index without value arg index"); + int sizeArg = nextArg++; + arg.width = getSizeArg(sizeArg, arg); + } + argIndex = nextArg++; hasDefaultArgIndex = true; } else { + if (arg.width == FormatArg::kDynamicWidth) { + arg.enforce(arg.widthIndex != FormatArg::kNoIndex, + "cannot provide value arg index without width arg index"); + arg.width = getSizeArg(arg.widthIndex, arg); + } + try { argIndex = to(piece); } catch (const std::out_of_range& e) { - LOG(FATAL) << "argument index must be integer"; + arg.error("argument index must be integer"); } - CHECK(argIndex >= 0) - << arg.errorStr("argument index must be non-negative"); + arg.enforce(argIndex >= 0, "argument index must be non-negative"); hasExplicitArgIndex = true; } } - CHECK(!hasDefaultArgIndex || !hasExplicitArgIndex) - << "may not have both default and explicit arg indexes"; + if (hasDefaultArgIndex && hasExplicitArgIndex) { + throw BadFormatArg( + "folly::format: may not have both default and explicit arg indexes"); + } doFormat(argIndex, arg, out); } } -template -void writeTo(FILE* fp, const Formatter& formatter) { +template +void writeTo(FILE* fp, + const BaseFormatter& formatter) { auto writer = [fp] (StringPiece sp) { - ssize_t n = fwrite(sp.data(), 1, sp.size(), fp); + size_t n = fwrite(sp.data(), 1, sp.size(), fp); if (n < sp.size()) { throwSystemError("Formatter writeTo", "fwrite failed"); } @@ -249,8 +288,19 @@ namespace format_value { template void formatString(StringPiece val, FormatArg& arg, FormatCallback& cb) { + if (arg.width != FormatArg::kDefaultWidth && arg.width < 0) { + throw BadFormatArg("folly::format: invalid width"); + } + if (arg.precision != FormatArg::kDefaultPrecision && arg.precision < 0) { + throw BadFormatArg("folly::format: invalid precision"); + } + + // XXX: clang should be smart enough to not need the two static_cast + // uses below given the above checks. If clang ever becomes that smart, we + // should remove the otherwise unnecessary warts. + if (arg.precision != FormatArg::kDefaultPrecision && - val.size() > arg.precision) { + val.size() > static_cast(arg.precision)) { val.reset(val.data(), arg.precision); } @@ -267,9 +317,10 @@ void formatString(StringPiece val, FormatArg& arg, FormatCallback& cb) { }; int padRemaining = 0; - if (arg.width != FormatArg::kDefaultWidth && val.size() < arg.width) { + if (arg.width != FormatArg::kDefaultWidth && + val.size() < static_cast(arg.width)) { char fill = arg.fill == FormatArg::kDefaultFill ? ' ' : arg.fill; - int padChars = arg.width - val.size(); + int padChars = static_cast (arg.width - val.size()); memset(padBuf, fill, std::min(padBufSize, padChars)); switch (arg.align) { @@ -314,10 +365,14 @@ void formatNumber(StringPiece val, int prefixLen, FormatArg& arg, format_value::formatString(val, arg, cb); } -template -void formatFormatter(const Formatter& formatter, - FormatArg& arg, - FormatCallback& cb) { +template +void formatFormatter( + const BaseFormatter& formatter, + FormatArg& arg, + FormatCallback& cb) { if (arg.width == FormatArg::kDefaultWidth && arg.precision == FormatArg::kDefaultPrecision) { // nothing to do @@ -363,6 +418,11 @@ class FormatValue< { public: explicit FormatValue(T val) : val_(val) { } + + T getValue() const { + return val_; + } + template void format(FormatArg& arg, FormatCallback& cb) const { arg.validate(FormatArg::Type::INTEGER); @@ -403,8 +463,8 @@ class FormatValue< uval = val_; sign = '\0'; - CHECK(arg.sign == FormatArg::Sign::DEFAULT) - << arg.errorStr("sign specifications not allowed for unsigned values"); + arg.enforce(arg.sign == FormatArg::Sign::DEFAULT, + "sign specifications not allowed for unsigned values"); } // max of: @@ -419,45 +479,70 @@ class FormatValue< char* valBufBegin = nullptr; char* valBufEnd = nullptr; - // Defer to sprintf - auto useSprintf = [&] (const char* format) mutable { - valBufBegin = valBuf + 3; // room for sign and base prefix - valBufEnd = valBufBegin + sprintf(valBufBegin, format, - static_cast(uval)); - }; - int prefixLen = 0; - switch (presentation) { - case 'n': // TODO(tudorb): locale awareness? + case 'n': { + arg.enforce(!arg.basePrefix, + "base prefix not allowed with '", presentation, + "' specifier"); + + arg.enforce(!arg.thousandsSeparator, + "cannot use ',' with the '", presentation, + "' specifier"); + + valBufBegin = valBuf + 3; // room for sign and base prefix +#ifdef _MSC_VER + char valBuf2[valBufSize]; + snprintf(valBuf2, valBufSize, "%ju", static_cast(uval)); + int len = GetNumberFormat( + LOCALE_USER_DEFAULT, + 0, + valBuf2, + nullptr, + valBufBegin, + (int)((valBuf + valBufSize) - valBufBegin) + ); +#elif defined(__ANDROID__) + int len = snprintf(valBufBegin, (valBuf + valBufSize) - valBufBegin, + "%" PRIuMAX, static_cast(uval)); +#else + int len = snprintf(valBufBegin, (valBuf + valBufSize) - valBufBegin, + "%'ju", static_cast(uval)); +#endif + // valBufSize should always be big enough, so this should never + // happen. + assert(len < valBuf + valBufSize - valBufBegin); + valBufEnd = valBufBegin + len; + break; + } case 'd': - CHECK(!arg.basePrefix) - << arg.errorStr("base prefix not allowed with '", presentation, - "' specifier"); + arg.enforce(!arg.basePrefix, + "base prefix not allowed with '", presentation, + "' specifier"); + valBufBegin = valBuf + 3; // room for sign and base prefix + + // Use uintToBuffer, faster than sprintf + valBufEnd = valBufBegin + uint64ToBufferUnsafe(uval, valBufBegin); if (arg.thousandsSeparator) { - useSprintf("%'ju"); - } else { - // Use uintToBuffer, faster than sprintf - valBufBegin = valBuf + 3; - valBufEnd = valBufBegin + uint64ToBufferUnsafe(uval, valBufBegin); + detail::insertThousandsGroupingUnsafe(valBufBegin, &valBufEnd); } break; case 'c': - CHECK(!arg.basePrefix) - << arg.errorStr("base prefix not allowed with '", presentation, - "' specifier"); - CHECK(!arg.thousandsSeparator) - << arg.errorStr("thousands separator (',') not allowed with '", - presentation, "' specifier"); + arg.enforce(!arg.basePrefix, + "base prefix not allowed with '", presentation, + "' specifier"); + arg.enforce(!arg.thousandsSeparator, + "thousands separator (',') not allowed with '", + presentation, "' specifier"); valBufBegin = valBuf + 3; *valBufBegin = static_cast(uval); valBufEnd = valBufBegin + 1; break; case 'o': case 'O': - CHECK(!arg.thousandsSeparator) - << arg.errorStr("thousands separator (',') not allowed with '", - presentation, "' specifier"); + arg.enforce(!arg.thousandsSeparator, + "thousands separator (',') not allowed with '", + presentation, "' specifier"); valBufEnd = valBuf + valBufSize - 1; valBufBegin = valBuf + detail::uintToOctal(valBuf, valBufSize - 1, uval); if (arg.basePrefix) { @@ -466,9 +551,9 @@ class FormatValue< } break; case 'x': - CHECK(!arg.thousandsSeparator) - << arg.errorStr("thousands separator (',') not allowed with '", - presentation, "' specifier"); + arg.enforce(!arg.thousandsSeparator, + "thousands separator (',') not allowed with '", + presentation, "' specifier"); valBufEnd = valBuf + valBufSize - 1; valBufBegin = valBuf + detail::uintToHexLower(valBuf, valBufSize - 1, uval); @@ -479,9 +564,9 @@ class FormatValue< } break; case 'X': - CHECK(!arg.thousandsSeparator) - << arg.errorStr("thousands separator (',') not allowed with '", - presentation, "' specifier"); + arg.enforce(!arg.thousandsSeparator, + "thousands separator (',') not allowed with '", + presentation, "' specifier"); valBufEnd = valBuf + valBufSize - 1; valBufBegin = valBuf + detail::uintToHexUpper(valBuf, valBufSize - 1, uval); @@ -493,9 +578,9 @@ class FormatValue< break; case 'b': case 'B': - CHECK(!arg.thousandsSeparator) - << arg.errorStr("thousands separator (',') not allowed with '", - presentation, "' specifier"); + arg.enforce(!arg.thousandsSeparator, + "thousands separator (',') not allowed with '", + presentation, "' specifier"); valBufEnd = valBuf + valBufSize - 1; valBufBegin = valBuf + detail::uintToBinary(valBuf, valBufSize - 1, uval); @@ -506,7 +591,7 @@ class FormatValue< } break; default: - LOG(FATAL) << arg.errorStr("invalid specifier '", presentation, "'"); + arg.error("invalid specifier '", presentation, "'"); } if (sign) { @@ -550,127 +635,15 @@ class FormatValue { template void format(FormatArg& arg, FormatCallback& cb) const { - using ::double_conversion::DoubleToStringConverter; - using ::double_conversion::StringBuilder; - - arg.validate(FormatArg::Type::FLOAT); - - if (arg.presentation == FormatArg::kDefaultPresentation) { - arg.presentation = 'g'; - } - - const char* infinitySymbol = isupper(arg.presentation) ? "INF" : "inf"; - const char* nanSymbol = isupper(arg.presentation) ? "NAN" : "nan"; - char exponentSymbol = isupper(arg.presentation) ? 'E' : 'e'; - - if (arg.precision == FormatArg::kDefaultPrecision) { - arg.precision = 6; - } - - // 2+: for null terminator and optional sign shenanigans. - char buf[2 + std::max({ - (2 + DoubleToStringConverter::kMaxFixedDigitsBeforePoint + - DoubleToStringConverter::kMaxFixedDigitsAfterPoint), - (8 + DoubleToStringConverter::kMaxExponentialDigits), - (7 + DoubleToStringConverter::kMaxPrecisionDigits)})]; - StringBuilder builder(buf + 1, sizeof(buf) - 1); - - char plusSign; - switch (arg.sign) { - case FormatArg::Sign::PLUS_OR_MINUS: - plusSign = '+'; - break; - case FormatArg::Sign::SPACE_OR_MINUS: - plusSign = ' '; - break; - default: - plusSign = '\0'; - break; - }; - - double val = val_; - switch (arg.presentation) { - case '%': - val *= 100; - case 'f': - case 'F': - { - if (arg.precision > - DoubleToStringConverter::kMaxFixedDigitsAfterPoint) { - arg.precision = DoubleToStringConverter::kMaxFixedDigitsAfterPoint; - } - DoubleToStringConverter conv( - DoubleToStringConverter::EMIT_POSITIVE_EXPONENT_SIGN, - infinitySymbol, - nanSymbol, - exponentSymbol, - -4, arg.precision, - 0, 0); - arg.enforce(conv.ToFixed(val, arg.precision, &builder), - "fixed double conversion failed"); - } - break; - case 'e': - case 'E': - { - if (arg.precision > DoubleToStringConverter::kMaxExponentialDigits) { - arg.precision = DoubleToStringConverter::kMaxExponentialDigits; - } - - DoubleToStringConverter conv( - DoubleToStringConverter::EMIT_POSITIVE_EXPONENT_SIGN, - infinitySymbol, - nanSymbol, - exponentSymbol, - -4, arg.precision, - 0, 0); - CHECK(conv.ToExponential(val, arg.precision, &builder)); - } - break; - case 'n': // should be locale-aware, but isn't - case 'g': - case 'G': - { - if (arg.precision < DoubleToStringConverter::kMinPrecisionDigits) { - arg.precision = DoubleToStringConverter::kMinPrecisionDigits; - } else if (arg.precision > - DoubleToStringConverter::kMaxPrecisionDigits) { - arg.precision = DoubleToStringConverter::kMaxPrecisionDigits; - } - DoubleToStringConverter conv( - DoubleToStringConverter::EMIT_POSITIVE_EXPONENT_SIGN, - infinitySymbol, - nanSymbol, - exponentSymbol, - -4, arg.precision, - 0, 0); - CHECK(conv.ToShortest(val, &builder)); - } - break; - default: - LOG(FATAL) << arg.errorStr("invalid specifier '", arg.presentation, "'"); - } - - int len = builder.position(); - builder.Finalize(); - DCHECK_GT(len, 0); - - // Add '+' or ' ' sign if needed - char* p = buf + 1; - // anything that's neither negative nor nan - int prefixLen = 0; - if (plusSign && (*p != '-' && *p != 'n' && *p != 'N')) { - *--p = plusSign; - ++len; - prefixLen = 1; - } else if (*p == '-') { - prefixLen = 1; - } - - format_value::formatNumber(StringPiece(p, len), prefixLen, arg, cb); + fbstring piece; + int prefixLen; + formatHelper(piece, prefixLen, arg); + format_value::formatNumber(piece, prefixLen, arg, cb); } private: + void formatHelper(fbstring& piece, int& prefixLen, FormatArg& arg) const; + double val_; }; @@ -705,9 +678,9 @@ class FormatValue< void format(FormatArg& arg, FormatCallback& cb) const { if (arg.keyEmpty()) { arg.validate(FormatArg::Type::OTHER); - CHECK(arg.presentation == FormatArg::kDefaultPresentation || - arg.presentation == 's') - << arg.errorStr("invalid specifier '", arg.presentation, "'"); + arg.enforce(arg.presentation == FormatArg::kDefaultPresentation || + arg.presentation == 's', + "invalid specifier '", arg.presentation, "'"); format_value::formatString(val_, arg, cb); } else { FormatValue(val_.at(arg.splitIntKey())).format(arg, cb); @@ -727,8 +700,8 @@ class FormatValue { template void format(FormatArg& arg, FormatCallback& cb) const { arg.validate(FormatArg::Type::OTHER); - CHECK(arg.presentation == FormatArg::kDefaultPresentation) - << arg.errorStr("invalid specifier '", arg.presentation, "'"); + arg.enforce(arg.presentation == FormatArg::kDefaultPresentation, + "invalid specifier '", arg.presentation, "'"); format_value::formatString("(null)", arg, cb); } }; @@ -778,8 +751,8 @@ class FormatValue< } else { // Print as a pointer, in hex. arg.validate(FormatArg::Type::OTHER); - CHECK(arg.presentation == FormatArg::kDefaultPresentation) - << arg.errorStr("invalid specifier '", arg.presentation, "'"); + arg.enforce(arg.presentation == FormatArg::kDefaultPresentation, + "invalid specifier '", arg.presentation, "'"); arg.basePrefix = true; arg.presentation = 'x'; if (arg.align == FormatArg::Align::DEFAULT) { @@ -799,7 +772,7 @@ class TryFormatValue { public: template static void formatOrFail(T& value, FormatArg& arg, FormatCallback& cb) { - LOG(FATAL) << arg.errorStr("No formatter available for this type"); + arg.error("No formatter available for this type"); } }; @@ -841,35 +814,6 @@ class FormatValue< namespace detail { -// Shortcut, so we don't have to use enable_if everywhere -struct FormatTraitsBase { - typedef void enabled; -}; - -// Traits that define enabled, value_type, and at() for anything -// indexable with integral keys: pointers, arrays, vectors, and maps -// with integral keys -template struct IndexableTraits; - -// Base class for sequences (vectors, deques) -template -struct IndexableTraitsSeq : public FormatTraitsBase { - typedef C container_type; - typedef typename C::value_type value_type; - static const value_type& at(const C& c, int idx) { - return c.at(idx); - } -}; - -// Base class for associative types (maps) -template -struct IndexableTraitsAssoc : public FormatTraitsBase { - typedef typename C::value_type::second_type value_type; - static const value_type& at(const C& c, int idx) { - return c.at(static_cast(idx)); - } -}; - // std::array template struct IndexableTraits> @@ -888,18 +832,6 @@ struct IndexableTraits> : public IndexableTraitsSeq> { }; -// fbvector -template -struct IndexableTraits> - : public IndexableTraitsSeq> { -}; - -// small_vector -template -struct IndexableTraits> - : public IndexableTraitsSeq> { -}; - // std::map with integral keys template struct IndexableTraits< @@ -938,6 +870,28 @@ class FormatValue< const T& val_; }; +template +class FormatValue< + detail::DefaultValueWrapper, + typename detail::IndexableTraits::enabled> { + public: + explicit FormatValue(const detail::DefaultValueWrapper& val) + : val_(val) { } + + template + void format(FormatArg& arg, FormatCallback& cb) const { + FormatValue::value_type>::type>( + detail::IndexableTraits::at( + val_.container, + arg.splitIntKey(), + val_.defaultValue)).format(arg, cb); + } + + private: + const detail::DefaultValueWrapper& val_; +}; + namespace detail { // Define enabled, key_type, convert from StringPiece to the key types @@ -979,6 +933,11 @@ template struct KeyableTraitsAssoc : public FormatTraitsBase { static const value_type& at(const T& map, StringPiece key) { return map.at(KeyFromStringPiece::convert(key)); } + static const value_type& at(const T& map, StringPiece key, + const value_type& dflt) { + auto pos = map.find(KeyFromStringPiece::convert(key)); + return pos != map.end() ? pos->second : dflt; + } }; // Define enabled, key_type, value_type, at() for supported string-keyed @@ -1023,6 +982,28 @@ class FormatValue< const T& val_; }; +template +class FormatValue< + detail::DefaultValueWrapper, + typename detail::KeyableTraits::enabled> { + public: + explicit FormatValue(const detail::DefaultValueWrapper& val) + : val_(val) { } + + template + void format(FormatArg& arg, FormatCallback& cb) const { + FormatValue::value_type>::type>( + detail::KeyableTraits::at( + val_.container, + arg.splitKey(), + val_.defaultValue)).format(arg, cb); + } + + private: + const detail::DefaultValueWrapper& val_; +}; + // Partial specialization of FormatValue for pairs template class FormatValue> { @@ -1040,7 +1021,7 @@ class FormatValue> { FormatValue::type>(val_.second).format(arg, cb); break; default: - LOG(FATAL) << arg.errorStr("invalid index for pair"); + arg.error("invalid index for pair"); } } @@ -1058,7 +1039,7 @@ class FormatValue> { template void format(FormatArg& arg, FormatCallback& cb) const { int key = arg.splitIntKey(); - CHECK(key >= 0) << arg.errorStr("tuple index must be non-negative"); + arg.enforce(key >= 0, "tuple index must be non-negative"); doFormat(key, arg, cb); } @@ -1068,7 +1049,7 @@ class FormatValue> { template typename std::enable_if::type doFormatFrom(size_t i, FormatArg& arg, Callback& cb) const { - LOG(FATAL) << arg.errorStr("tuple index out of range, max=", i); + arg.enforce("tuple index out of range, max=", i); } template @@ -1092,9 +1073,13 @@ class FormatValue> { }; // Partial specialization of FormatValue for nested Formatters -template -class FormatValue, void> { - typedef Formatter FormatterValue; +template class F> +class FormatValue, + typename std::enable_if>::value>::type> { + typedef typename F::BaseType FormatterValue; + public: explicit FormatValue(const FormatterValue& f) : f_(f) { } @@ -1110,11 +1095,12 @@ class FormatValue, void> { * Formatter objects can be appended to strings, and therefore they're * compatible with folly::toAppend and folly::to. */ -template -typename std::enable_if< - detail::IsSomeString::value>::type -toAppend(const Formatter& value, Tgt * result) { +template +typename std::enable_if::value>::type toAppend( + const BaseFormatter& value, Tgt* result) { value.appendTo(*result); } } // namespace folly + +#pragma GCC diagnostic pop