folly/Format-inl.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_FORMAT_H_
  18 #error This file may only be included from Format.h.
  19 #endif
  20
  21 #include <array>
  22 #include <cinttypes>
  23 #include <deque>
  24 #include <map>
  25 #include <unordered_map>
  26 #include <vector>
  27
  28 #include <folly/Exception.h>
  29 #include <folly/FormatTraits.h>
  30 #include <folly/Traits.h>
  31 #include <folly/portability/Windows.h>
  32
  33 // Ignore -Wformat-nonliteral warnings within this file
  34 #pragma GCC diagnostic push
  35 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
  36
  37 namespace folly {
  38
  39 namespace detail {
  40
  41 // Updates the end of the buffer after the comma separators have been added.
  42 void insertThousandsGroupingUnsafe(char* start_buffer, char** end_buffer);
  43
  44 extern const char formatHexUpper[256][2];
  45 extern const char formatHexLower[256][2];
  46 extern const char formatOctal[512][3];
  47 extern const char formatBinary[256][8];
  48
  49 const size_t kMaxHexLength = 2 * sizeof(uintmax_t);
  50 const size_t kMaxOctalLength = 3 * sizeof(uintmax_t);
  51 const size_t kMaxBinaryLength = 8 * sizeof(uintmax_t);
  52
  53 /**
  54  * Convert an unsigned to hex, using repr (which maps from each possible
  55  * 2-hex-bytes value to the 2-character representation).
  56  *
  57  * Just like folly::detail::uintToBuffer in Conv.h, writes at the *end* of
  58  * the supplied buffer and returns the offset of the beginning of the string
  59  * from the start of the buffer.  The formatted string will be in range
  60  * [buf+begin, buf+bufLen).
  61  */
  62 template <class Uint>
  63 size_t uintToHex(char* buffer, size_t bufLen, Uint v,
  64                  const char (&repr)[256][2]) {
  65   // 'v >>= 7, v >>= 1' is no more than a work around to get rid of shift size
  66   // warning when Uint = uint8_t (it's false as v >= 256 implies sizeof(v) > 1).
  67   for (; !less_than<unsigned, 256>(v); v >>= 7, v >>= 1) {
  68     auto b = v & 0xff;
  69     bufLen -= 2;
  70     buffer[bufLen] = repr[b][0];
  71     buffer[bufLen + 1] = repr[b][1];
  72   }
  73   buffer[--bufLen] = repr[v][1];
  74   if (v >= 16) {
  75     buffer[--bufLen] = repr[v][0];
  76   }
  77   return bufLen;
  78 }
  79
  80 /**
  81  * Convert an unsigned to hex, using lower-case letters for the digits
  82  * above 9.  See the comments for uintToHex.
  83  */
  84 template <class Uint>
  85 inline size_t uintToHexLower(char* buffer, size_t bufLen, Uint v) {
  86   return uintToHex(buffer, bufLen, v, formatHexLower);
  87 }
  88
  89 /**
  90  * Convert an unsigned to hex, using upper-case letters for the digits
  91  * above 9.  See the comments for uintToHex.
  92  */
  93 template <class Uint>
  94 inline size_t uintToHexUpper(char* buffer, size_t bufLen, Uint v) {
  95   return uintToHex(buffer, bufLen, v, formatHexUpper);
  96 }
  97
  98 /**
  99  * Convert an unsigned to octal.
 100  *
 101  * Just like folly::detail::uintToBuffer in Conv.h, writes at the *end* of
 102  * the supplied buffer and returns the offset of the beginning of the string
 103  * from the start of the buffer.  The formatted string will be in range
 104  * [buf+begin, buf+bufLen).
 105  */
 106 template <class Uint>
 107 size_t uintToOctal(char* buffer, size_t bufLen, Uint v) {
 108   auto& repr = formatOctal;
 109   // 'v >>= 7, v >>= 2' is no more than a work around to get rid of shift size
 110   // warning when Uint = uint8_t (it's false as v >= 512 implies sizeof(v) > 1).
 111   for (; !less_than<unsigned, 512>(v); v >>= 7, v >>= 2) {
 112     auto b = v & 0x1ff;
 113     bufLen -= 3;
 114     buffer[bufLen] = repr[b][0];
 115     buffer[bufLen + 1] = repr[b][1];
 116     buffer[bufLen + 2] = repr[b][2];
 117   }
 118   buffer[--bufLen] = repr[v][2];
 119   if (v >= 8) {
 120     buffer[--bufLen] = repr[v][1];
 121   }
 122   if (v >= 64) {
 123     buffer[--bufLen] = repr[v][0];
 124   }
 125   return bufLen;
 126 }
 127
 128 /**
 129  * Convert an unsigned to binary.
 130  *
 131  * Just like folly::detail::uintToBuffer in Conv.h, writes at the *end* of
 132  * the supplied buffer and returns the offset of the beginning of the string
 133  * from the start of the buffer.  The formatted string will be in range
 134  * [buf+begin, buf+bufLen).
 135  */
 136 template <class Uint>
 137 size_t uintToBinary(char* buffer, size_t bufLen, Uint v) {
 138   auto& repr = formatBinary;
 139   if (v == 0) {
 140     buffer[--bufLen] = '0';
 141     return bufLen;
 142   }
 143   for (; v; v >>= 7, v >>= 1) {
 144     auto b = v & 0xff;
 145     bufLen -= 8;
 146     memcpy(buffer + bufLen, &(repr[b][0]), 8);
 147   }
 148   while (buffer[bufLen] == '0') {
 149     ++bufLen;
 150   }
 151   return bufLen;
 152 }
 153
 154 }  // namespace detail
 155
 156 template <class Derived, bool containerMode, class... Args>
 157 BaseFormatter<Derived, containerMode, Args...>::BaseFormatter(StringPiece str,
 158                                                               Args&&... args)
 159     : str_(str),
 160       values_(FormatValue<typename std::decay<Args>::type>(
 161           std::forward<Args>(args))...) {
 162   static_assert(!containerMode || sizeof...(Args) == 1,
 163                 "Exactly one argument required in container mode");
 164 }
 165
 166 template <class Derived, bool containerMode, class... Args>
 167 template <class Output>
 168 void BaseFormatter<Derived, containerMode, Args...>::operator()(Output& out)
 169     const {
 170   // Copy raw string (without format specifiers) to output;
 171   // not as simple as we'd like, as we still need to translate "}}" to "}"
 172   // and throw if we see any lone "}"
 173   auto outputString = [&out] (StringPiece s) {
 174     auto p = s.begin();
 175     auto end = s.end();
 176     while (p != end) {
 177       auto q = static_cast<const char*>(memchr(p, '}', size_t(end - p)));
 178       if (!q) {
 179         out(StringPiece(p, end));
 180         break;
 181       }
 182       ++q;
 183       out(StringPiece(p, q));
 184       p = q;
 185
 186       if (p == end || *p != '}') {
 187         throw BadFormatArg("folly::format: single '}' in format string");
 188       }
 189       ++p;
 190     }
 191   };
 192
 193   auto p = str_.begin();
 194   auto end = str_.end();
 195
 196   int nextArg = 0;
 197   bool hasDefaultArgIndex = false;
 198   bool hasExplicitArgIndex = false;
 199   while (p != end) {
 200     auto q = static_cast<const char*>(memchr(p, '{', size_t(end - p)));
 201     if (!q) {
 202       outputString(StringPiece(p, end));
 203       break;
 204     }
 205     outputString(StringPiece(p, q));
 206     p = q + 1;
 207
 208     if (p == end) {
 209       throw BadFormatArg("folly::format: '}' at end of format string");
 210     }
 211
 212     // "{{" -> "{"
 213     if (*p == '{') {
 214       out(StringPiece(p, 1));
 215       ++p;
 216       continue;
 217     }
 218
 219     // Format string
 220     q = static_cast<const char*>(memchr(p, '}', size_t(end - p)));
 221     if (q == nullptr) {
 222       throw BadFormatArg("folly::format: missing ending '}'");
 223     }
 224     FormatArg arg(StringPiece(p, q));
 225     p = q + 1;
 226
 227     int argIndex = 0;
 228     auto piece = arg.splitKey<true>();  // empty key component is okay
 229     if (containerMode) {  // static
 230       arg.enforce(arg.width != FormatArg::kDynamicWidth,
 231                   "dynamic field width not supported in vformat()");
 232       if (piece.empty()) {
 233         arg.setNextIntKey(nextArg++);
 234         hasDefaultArgIndex = true;
 235       } else {
 236         arg.setNextKey(piece);
 237         hasExplicitArgIndex = true;
 238       }
 239     } else {
 240       if (piece.empty()) {
 241         if (arg.width == FormatArg::kDynamicWidth) {
 242           arg.enforce(arg.widthIndex == FormatArg::kNoIndex,
 243                       "cannot provide width arg index without value arg index");
 244           int sizeArg = nextArg++;
 245           arg.width = getSizeArg(size_t(sizeArg), arg);
 246         }
 247
 248         argIndex = nextArg++;
 249         hasDefaultArgIndex = true;
 250       } else {
 251         if (arg.width == FormatArg::kDynamicWidth) {
 252           arg.enforce(arg.widthIndex != FormatArg::kNoIndex,
 253                       "cannot provide value arg index without width arg index");
 254           arg.width = getSizeArg(size_t(arg.widthIndex), arg);
 255         }
 256
 257         try {
 258           argIndex = to<int>(piece);
 259         } catch (const std::out_of_range&) {
 260           arg.error("argument index must be integer");
 261         }
 262         arg.enforce(argIndex >= 0, "argument index must be non-negative");
 263         hasExplicitArgIndex = true;
 264       }
 265     }
 266
 267     if (hasDefaultArgIndex && hasExplicitArgIndex) {
 268       throw BadFormatArg(
 269           "folly::format: may not have both default and explicit arg indexes");
 270     }
 271
 272     doFormat(size_t(argIndex), arg, out);
 273   }
 274 }
 275
 276 template <class Derived, bool containerMode, class... Args>
 277 void writeTo(FILE* fp,
 278              const BaseFormatter<Derived, containerMode, Args...>& formatter) {
 279   auto writer = [fp] (StringPiece sp) {
 280     size_t n = fwrite(sp.data(), 1, sp.size(), fp);
 281     if (n < sp.size()) {
 282       throwSystemError("Formatter writeTo", "fwrite failed");
 283     }
 284   };
 285   formatter(writer);
 286 }
 287
 288 namespace format_value {
 289
 290 template <class FormatCallback>
 291 void formatString(StringPiece val, FormatArg& arg, FormatCallback& cb) {
 292   if (arg.width != FormatArg::kDefaultWidth && arg.width < 0) {
 293     throw BadFormatArg("folly::format: invalid width");
 294   }
 295   if (arg.precision != FormatArg::kDefaultPrecision && arg.precision < 0) {
 296     throw BadFormatArg("folly::format: invalid precision");
 297   }
 298
 299   // XXX: clang should be smart enough to not need the two static_cast<size_t>
 300   // uses below given the above checks. If clang ever becomes that smart, we
 301   // should remove the otherwise unnecessary warts.
 302
 303   if (arg.precision != FormatArg::kDefaultPrecision &&
 304       val.size() > static_cast<size_t>(arg.precision)) {
 305     val.reset(val.data(), size_t(arg.precision));
 306   }
 307
 308   constexpr int padBufSize = 128;
 309   char padBuf[padBufSize];
 310
 311   // Output padding, no more than padBufSize at once
 312   auto pad = [&padBuf, &cb, padBufSize] (int chars) {
 313     while (chars) {
 314       int n = std::min(chars, padBufSize);
 315       cb(StringPiece(padBuf, size_t(n)));
 316       chars -= n;
 317     }
 318   };
 319
 320   int padRemaining = 0;
 321   if (arg.width != FormatArg::kDefaultWidth &&
 322       val.size() < static_cast<size_t>(arg.width)) {
 323     char fill = arg.fill == FormatArg::kDefaultFill ? ' ' : arg.fill;
 324     int padChars = static_cast<int> (arg.width - val.size());
 325     memset(padBuf, fill, size_t(std::min(padBufSize, padChars)));
 326
 327     switch (arg.align) {
 328     case FormatArg::Align::DEFAULT:
 329     case FormatArg::Align::LEFT:
 330       padRemaining = padChars;
 331       break;
 332     case FormatArg::Align::CENTER:
 333       pad(padChars / 2);
 334       padRemaining = padChars - padChars / 2;
 335       break;
 336     case FormatArg::Align::RIGHT:
 337     case FormatArg::Align::PAD_AFTER_SIGN:
 338       pad(padChars);
 339       break;
 340     default:
 341       abort();
 342       break;
 343     }
 344   }
 345
 346   cb(val);
 347
 348   if (padRemaining) {
 349     pad(padRemaining);
 350   }
 351 }
 352
 353 template <class FormatCallback>
 354 void formatNumber(StringPiece val, int prefixLen, FormatArg& arg,
 355                   FormatCallback& cb) {
 356   // precision means something different for numbers
 357   arg.precision = FormatArg::kDefaultPrecision;
 358   if (arg.align == FormatArg::Align::DEFAULT) {
 359     arg.align = FormatArg::Align::RIGHT;
 360   } else if (prefixLen && arg.align == FormatArg::Align::PAD_AFTER_SIGN) {
 361     // Split off the prefix, then do any padding if necessary
 362     cb(val.subpiece(0, size_t(prefixLen)));
 363     val.advance(size_t(prefixLen));
 364     arg.width = std::max(arg.width - prefixLen, 0);
 365   }
 366   format_value::formatString(val, arg, cb);
 367 }
 368
 369 template <class FormatCallback,
 370           class Derived,
 371           bool containerMode,
 372           class... Args>
 373 void formatFormatter(
 374     const BaseFormatter<Derived, containerMode, Args...>& formatter,
 375     FormatArg& arg,
 376     FormatCallback& cb) {
 377   if (arg.width == FormatArg::kDefaultWidth &&
 378       arg.precision == FormatArg::kDefaultPrecision) {
 379     // nothing to do
 380     formatter(cb);
 381   } else if (arg.align != FormatArg::Align::LEFT &&
 382              arg.align != FormatArg::Align::DEFAULT) {
 383     // We can only avoid creating a temporary string if we align left,
 384     // as we'd need to know the size beforehand otherwise
 385     format_value::formatString(formatter.fbstr(), arg, cb);
 386   } else {
 387     auto fn = [&arg, &cb] (StringPiece sp) mutable {
 388       int sz = static_cast<int>(sp.size());
 389       if (arg.precision != FormatArg::kDefaultPrecision) {
 390         sz = std::min(arg.precision, sz);
 391         sp.reset(sp.data(), sz);
 392         arg.precision -= sz;
 393       }
 394       if (!sp.empty()) {
 395         cb(sp);
 396         if (arg.width != FormatArg::kDefaultWidth) {
 397           arg.width = std::max(arg.width - sz, 0);
 398         }
 399       }
 400     };
 401     formatter(fn);
 402     if (arg.width != FormatArg::kDefaultWidth && arg.width != 0) {
 403       // Rely on formatString to do appropriate padding
 404       format_value::formatString(StringPiece(), arg, cb);
 405     }
 406   }
 407 }
 408
 409 }  // namespace format_value
 410
 411 // Definitions for default FormatValue classes
 412
 413 // Integral types (except bool)
 414 template <class T>
 415 class FormatValue<
 416   T, typename std::enable_if<
 417     std::is_integral<T>::value &&
 418     !std::is_same<T, bool>::value>::type>
 419   {
 420  public:
 421   explicit FormatValue(T val) : val_(val) { }
 422
 423   T getValue() const {
 424     return val_;
 425   }
 426
 427   template <class FormatCallback>
 428   void format(FormatArg& arg, FormatCallback& cb) const {
 429     arg.validate(FormatArg::Type::INTEGER);
 430     doFormat(arg, cb);
 431   }
 432
 433   template <class FormatCallback>
 434   void doFormat(FormatArg& arg, FormatCallback& cb) const {
 435     char presentation = arg.presentation;
 436     if (presentation == FormatArg::kDefaultPresentation) {
 437       presentation = std::is_same<T, char>::value ? 'c' : 'd';
 438     }
 439
 440     // Do all work as unsigned, we'll add the prefix ('0' or '0x' if necessary)
 441     // and sign ourselves.
 442     typedef typename std::make_unsigned<T>::type UT;
 443     UT uval;
 444     char sign;
 445     if (std::is_signed<T>::value) {
 446       if (folly::is_negative(val_)) {
 447         uval = UT(-static_cast<UT>(val_));
 448         sign = '-';
 449       } else {
 450         uval = static_cast<UT>(val_);
 451         switch (arg.sign) {
 452         case FormatArg::Sign::PLUS_OR_MINUS:
 453           sign = '+';
 454           break;
 455         case FormatArg::Sign::SPACE_OR_MINUS:
 456           sign = ' ';
 457           break;
 458         default:
 459           sign = '\0';
 460           break;
 461         }
 462       }
 463     } else {
 464       uval = static_cast<UT>(val_);
 465       sign = '\0';
 466
 467       arg.enforce(arg.sign == FormatArg::Sign::DEFAULT,
 468                   "sign specifications not allowed for unsigned values");
 469     }
 470
 471     // max of:
 472     // #x: 0x prefix + 16 bytes = 18 bytes
 473     // #o: 0 prefix + 22 bytes = 23 bytes
 474     // #b: 0b prefix + 64 bytes = 65 bytes
 475     // ,d: 26 bytes (including thousands separators!)
 476     // + nul terminator
 477     // + 3 for sign and prefix shenanigans (see below)
 478     constexpr size_t valBufSize = 69;
 479     char valBuf[valBufSize];
 480     char* valBufBegin = nullptr;
 481     char* valBufEnd = nullptr;
 482
 483     int prefixLen = 0;
 484     switch (presentation) {
 485     case 'n': {
 486       arg.enforce(!arg.basePrefix,
 487                   "base prefix not allowed with '", presentation,
 488                   "' specifier");
 489
 490       arg.enforce(!arg.thousandsSeparator,
 491                   "cannot use ',' with the '", presentation,
 492                   "' specifier");
 493
 494       valBufBegin = valBuf + 3;  // room for sign and base prefix
 495 #if defined(__ANDROID__)
 496       int len = snprintf(valBufBegin, (valBuf + valBufSize) - valBufBegin,
 497                          "%" PRIuMAX, static_cast<uintmax_t>(uval));
 498 #else
 499       int len = snprintf(
 500           valBufBegin,
 501           size_t((valBuf + valBufSize) - valBufBegin),
 502           "%ju",
 503           static_cast<uintmax_t>(uval));
 504 #endif
 505       // valBufSize should always be big enough, so this should never
 506       // happen.
 507       assert(len < valBuf + valBufSize - valBufBegin);
 508       valBufEnd = valBufBegin + len;
 509       break;
 510     }
 511     case 'd':
 512       arg.enforce(!arg.basePrefix,
 513                   "base prefix not allowed with '", presentation,
 514                   "' specifier");
 515       valBufBegin = valBuf + 3;  // room for sign and base prefix
 516
 517       // Use uintToBuffer, faster than sprintf
 518       valBufEnd = valBufBegin + uint64ToBufferUnsafe(uval, valBufBegin);
 519       if (arg.thousandsSeparator) {
 520         detail::insertThousandsGroupingUnsafe(valBufBegin, &valBufEnd);
 521       }
 522       break;
 523     case 'c':
 524       arg.enforce(!arg.basePrefix,
 525                   "base prefix not allowed with '", presentation,
 526                   "' specifier");
 527       arg.enforce(!arg.thousandsSeparator,
 528                   "thousands separator (',') not allowed with '",
 529                   presentation, "' specifier");
 530       valBufBegin = valBuf + 3;
 531       *valBufBegin = static_cast<char>(uval);
 532       valBufEnd = valBufBegin + 1;
 533       break;
 534     case 'o':
 535     case 'O':
 536       arg.enforce(!arg.thousandsSeparator,
 537                   "thousands separator (',') not allowed with '",
 538                   presentation, "' specifier");
 539       valBufEnd = valBuf + valBufSize - 1;
 540       valBufBegin = valBuf + detail::uintToOctal(valBuf, valBufSize - 1, uval);
 541       if (arg.basePrefix) {
 542         *--valBufBegin = '0';
 543         prefixLen = 1;
 544       }
 545       break;
 546     case 'x':
 547       arg.enforce(!arg.thousandsSeparator,
 548                   "thousands separator (',') not allowed with '",
 549                   presentation, "' specifier");
 550       valBufEnd = valBuf + valBufSize - 1;
 551       valBufBegin = valBuf + detail::uintToHexLower(valBuf, valBufSize - 1,
 552                                                     uval);
 553       if (arg.basePrefix) {
 554         *--valBufBegin = 'x';
 555         *--valBufBegin = '0';
 556         prefixLen = 2;
 557       }
 558       break;
 559     case 'X':
 560       arg.enforce(!arg.thousandsSeparator,
 561                   "thousands separator (',') not allowed with '",
 562                   presentation, "' specifier");
 563       valBufEnd = valBuf + valBufSize - 1;
 564       valBufBegin = valBuf + detail::uintToHexUpper(valBuf, valBufSize - 1,
 565                                                     uval);
 566       if (arg.basePrefix) {
 567         *--valBufBegin = 'X';
 568         *--valBufBegin = '0';
 569         prefixLen = 2;
 570       }
 571       break;
 572     case 'b':
 573     case 'B':
 574       arg.enforce(!arg.thousandsSeparator,
 575                   "thousands separator (',') not allowed with '",
 576                   presentation, "' specifier");
 577       valBufEnd = valBuf + valBufSize - 1;
 578       valBufBegin = valBuf + detail::uintToBinary(valBuf, valBufSize - 1,
 579                                                   uval);
 580       if (arg.basePrefix) {
 581         *--valBufBegin = presentation;  // 0b or 0B
 582         *--valBufBegin = '0';
 583         prefixLen = 2;
 584       }
 585       break;
 586     default:
 587       arg.error("invalid specifier '", presentation, "'");
 588     }
 589
 590     if (sign) {
 591       *--valBufBegin = sign;
 592       ++prefixLen;
 593     }
 594
 595     format_value::formatNumber(StringPiece(valBufBegin, valBufEnd), prefixLen,
 596                                arg, cb);
 597   }
 598
 599  private:
 600   T val_;
 601 };
 602
 603 // Bool
 604 template <>
 605 class FormatValue<bool> {
 606  public:
 607   explicit FormatValue(bool val) : val_(val) { }
 608
 609   template <class FormatCallback>
 610   void format(FormatArg& arg, FormatCallback& cb) const {
 611     if (arg.presentation == FormatArg::kDefaultPresentation) {
 612       arg.validate(FormatArg::Type::OTHER);
 613       format_value::formatString(val_ ? "true" : "false", arg, cb);
 614     } else {  // number
 615       FormatValue<int>(val_).format(arg, cb);
 616     }
 617   }
 618
 619  private:
 620   bool val_;
 621 };
 622
 623 // double
 624 template <>
 625 class FormatValue<double> {
 626  public:
 627   explicit FormatValue(double val) : val_(val) { }
 628
 629   template <class FormatCallback>
 630   void format(FormatArg& arg, FormatCallback& cb) const {
 631     fbstring piece;
 632     int prefixLen;
 633     formatHelper(piece, prefixLen, arg);
 634     format_value::formatNumber(piece, prefixLen, arg, cb);
 635   }
 636
 637  private:
 638   void formatHelper(fbstring& piece, int& prefixLen, FormatArg& arg) const;
 639
 640   double val_;
 641 };
 642
 643 // float (defer to double)
 644 template <>
 645 class FormatValue<float> {
 646  public:
 647   explicit FormatValue(float val) : val_(val) { }
 648
 649   template <class FormatCallback>
 650   void format(FormatArg& arg, FormatCallback& cb) const {
 651     FormatValue<double>(val_).format(arg, cb);
 652   }
 653
 654  private:
 655   float val_;
 656 };
 657
 658 // Sring-y types (implicitly convertible to StringPiece, except char*)
 659 template <class T>
 660 class FormatValue<
 661   T, typename std::enable_if<
 662       (!std::is_pointer<T>::value ||
 663        !std::is_same<char, typename std::decay<
 664           typename std::remove_pointer<T>::type>::type>::value) &&
 665       std::is_convertible<T, StringPiece>::value>::type>
 666   {
 667  public:
 668   explicit FormatValue(StringPiece val) : val_(val) { }
 669
 670   template <class FormatCallback>
 671   void format(FormatArg& arg, FormatCallback& cb) const {
 672     if (arg.keyEmpty()) {
 673       arg.validate(FormatArg::Type::OTHER);
 674       arg.enforce(arg.presentation == FormatArg::kDefaultPresentation ||
 675                   arg.presentation == 's',
 676                   "invalid specifier '", arg.presentation, "'");
 677       format_value::formatString(val_, arg, cb);
 678     } else {
 679       FormatValue<char>(val_.at(size_t(arg.splitIntKey()))).format(arg, cb);
 680     }
 681   }
 682
 683  private:
 684   StringPiece val_;
 685 };
 686
 687 // Null
 688 template <>
 689 class FormatValue<std::nullptr_t> {
 690  public:
 691   explicit FormatValue(std::nullptr_t) { }
 692
 693   template <class FormatCallback>
 694   void format(FormatArg& arg, FormatCallback& cb) const {
 695     arg.validate(FormatArg::Type::OTHER);
 696     arg.enforce(arg.presentation == FormatArg::kDefaultPresentation,
 697                 "invalid specifier '", arg.presentation, "'");
 698     format_value::formatString("(null)", arg, cb);
 699   }
 700 };
 701
 702 // Partial specialization of FormatValue for char*
 703 template <class T>
 704 class FormatValue<
 705   T*,
 706   typename std::enable_if<
 707       std::is_same<char, typename std::decay<T>::type>::value>::type>
 708   {
 709  public:
 710   explicit FormatValue(T* val) : val_(val) { }
 711
 712   template <class FormatCallback>
 713   void format(FormatArg& arg, FormatCallback& cb) const {
 714     if (arg.keyEmpty()) {
 715       if (!val_) {
 716         FormatValue<std::nullptr_t>(nullptr).format(arg, cb);
 717       } else {
 718         FormatValue<StringPiece>(val_).format(arg, cb);
 719       }
 720     } else {
 721       FormatValue<typename std::decay<T>::type>(
 722           val_[arg.splitIntKey()]).format(arg, cb);
 723     }
 724   }
 725
 726  private:
 727   T* val_;
 728 };
 729
 730 // Partial specialization of FormatValue for void*
 731 template <class T>
 732 class FormatValue<
 733   T*,
 734   typename std::enable_if<
 735       std::is_same<void, typename std::decay<T>::type>::value>::type>
 736   {
 737  public:
 738   explicit FormatValue(T* val) : val_(val) { }
 739
 740   template <class FormatCallback>
 741   void format(FormatArg& arg, FormatCallback& cb) const {
 742     if (!val_) {
 743       FormatValue<std::nullptr_t>(nullptr).format(arg, cb);
 744     } else {
 745       // Print as a pointer, in hex.
 746       arg.validate(FormatArg::Type::OTHER);
 747       arg.enforce(arg.presentation == FormatArg::kDefaultPresentation,
 748                   "invalid specifier '", arg.presentation, "'");
 749       arg.basePrefix = true;
 750       arg.presentation = 'x';
 751       if (arg.align == FormatArg::Align::DEFAULT) {
 752         arg.align = FormatArg::Align::LEFT;
 753       }
 754       FormatValue<uintptr_t>(
 755           reinterpret_cast<uintptr_t>(val_)).doFormat(arg, cb);
 756     }
 757   }
 758
 759  private:
 760   T* val_;
 761 };
 762
 763 template <class T, class = void>
 764 class TryFormatValue {
 765  public:
 766   template <class FormatCallback>
 767   static void formatOrFail(T& /* value */,
 768                            FormatArg& arg,
 769                            FormatCallback& /* cb */) {
 770     arg.error("No formatter available for this type");
 771   }
 772 };
 773
 774 template <class T>
 775 class TryFormatValue<
 776   T,
 777   typename std::enable_if<
 778       0 < sizeof(FormatValue<typename std::decay<T>::type>)>::type>
 779   {
 780  public:
 781   template <class FormatCallback>
 782   static void formatOrFail(T& value, FormatArg& arg, FormatCallback& cb) {
 783     FormatValue<typename std::decay<T>::type>(value).format(arg, cb);
 784   }
 785 };
 786
 787 // Partial specialization of FormatValue for other pointers
 788 template <class T>
 789 class FormatValue<
 790   T*,
 791   typename std::enable_if<
 792       !std::is_same<char, typename std::decay<T>::type>::value &&
 793       !std::is_same<void, typename std::decay<T>::type>::value>::type>
 794   {
 795  public:
 796   explicit FormatValue(T* val) : val_(val) { }
 797
 798   template <class FormatCallback>
 799   void format(FormatArg& arg, FormatCallback& cb) const {
 800     if (arg.keyEmpty()) {
 801       FormatValue<void*>((void*)val_).format(arg, cb);
 802     } else {
 803       TryFormatValue<T>::formatOrFail(val_[arg.splitIntKey()], arg, cb);
 804     }
 805   }
 806  private:
 807   T* val_;
 808 };
 809
 810 namespace detail {
 811
 812 // std::array
 813 template <class T, size_t N>
 814 struct IndexableTraits<std::array<T, N>>
 815   : public IndexableTraitsSeq<std::array<T, N>> {
 816 };
 817
 818 // std::vector
 819 template <class T, class A>
 820 struct IndexableTraits<std::vector<T, A>>
 821   : public IndexableTraitsSeq<std::vector<T, A>> {
 822 };
 823
 824 // std::deque
 825 template <class T, class A>
 826 struct IndexableTraits<std::deque<T, A>>
 827   : public IndexableTraitsSeq<std::deque<T, A>> {
 828 };
 829
 830 // std::map with integral keys
 831 template <class K, class T, class C, class A>
 832 struct IndexableTraits<
 833   std::map<K, T, C, A>,
 834   typename std::enable_if<std::is_integral<K>::value>::type>
 835   : public IndexableTraitsAssoc<std::map<K, T, C, A>> {
 836 };
 837
 838 // std::unordered_map with integral keys
 839 template <class K, class T, class H, class E, class A>
 840 struct IndexableTraits<
 841   std::unordered_map<K, T, H, E, A>,
 842   typename std::enable_if<std::is_integral<K>::value>::type>
 843   : public IndexableTraitsAssoc<std::unordered_map<K, T, H, E, A>> {
 844 };
 845
 846 }  // namespace detail
 847
 848 // Partial specialization of FormatValue for integer-indexable containers
 849 template <class T>
 850 class FormatValue<
 851   T,
 852   typename detail::IndexableTraits<T>::enabled> {
 853  public:
 854   explicit FormatValue(const T& val) : val_(val) { }
 855
 856   template <class FormatCallback>
 857   void format(FormatArg& arg, FormatCallback& cb) const {
 858     FormatValue<typename std::decay<
 859       typename detail::IndexableTraits<T>::value_type>::type>(
 860         detail::IndexableTraits<T>::at(
 861             val_, arg.splitIntKey())).format(arg, cb);
 862   }
 863
 864  private:
 865   const T& val_;
 866 };
 867
 868 template <class Container, class Value>
 869 class FormatValue<
 870   detail::DefaultValueWrapper<Container, Value>,
 871   typename detail::IndexableTraits<Container>::enabled> {
 872  public:
 873   explicit FormatValue(const detail::DefaultValueWrapper<Container, Value>& val)
 874     : val_(val) { }
 875
 876   template <class FormatCallback>
 877   void format(FormatArg& arg, FormatCallback& cb) const {
 878     FormatValue<typename std::decay<
 879       typename detail::IndexableTraits<Container>::value_type>::type>(
 880           detail::IndexableTraits<Container>::at(
 881               val_.container,
 882               arg.splitIntKey(),
 883               val_.defaultValue)).format(arg, cb);
 884   }
 885
 886  private:
 887   const detail::DefaultValueWrapper<Container, Value>& val_;
 888 };
 889
 890 namespace detail {
 891
 892 // Define enabled, key_type, convert from StringPiece to the key types
 893 // that we support
 894 template <class T> struct KeyFromStringPiece;
 895
 896 // std::string
 897 template <>
 898 struct KeyFromStringPiece<std::string> : public FormatTraitsBase {
 899   typedef std::string key_type;
 900   static std::string convert(StringPiece s) {
 901     return s.toString();
 902   }
 903   typedef void enabled;
 904 };
 905
 906 // fbstring
 907 template <>
 908 struct KeyFromStringPiece<fbstring> : public FormatTraitsBase {
 909   typedef fbstring key_type;
 910   static fbstring convert(StringPiece s) {
 911     return s.toFbstring();
 912   }
 913 };
 914
 915 // StringPiece
 916 template <>
 917 struct KeyFromStringPiece<StringPiece> : public FormatTraitsBase {
 918   typedef StringPiece key_type;
 919   static StringPiece convert(StringPiece s) {
 920     return s;
 921   }
 922 };
 923
 924 // Base class for associative types keyed by strings
 925 template <class T> struct KeyableTraitsAssoc : public FormatTraitsBase {
 926   typedef typename T::key_type key_type;
 927   typedef typename T::value_type::second_type value_type;
 928   static const value_type& at(const T& map, StringPiece key) {
 929     return map.at(KeyFromStringPiece<key_type>::convert(key));
 930   }
 931   static const value_type& at(const T& map, StringPiece key,
 932                               const value_type& dflt) {
 933     auto pos = map.find(KeyFromStringPiece<key_type>::convert(key));
 934     return pos != map.end() ? pos->second : dflt;
 935   }
 936 };
 937
 938 // Define enabled, key_type, value_type, at() for supported string-keyed
 939 // types
 940 template <class T, class Enabled=void> struct KeyableTraits;
 941
 942 // std::map with string key
 943 template <class K, class T, class C, class A>
 944 struct KeyableTraits<
 945   std::map<K, T, C, A>,
 946   typename KeyFromStringPiece<K>::enabled>
 947   : public KeyableTraitsAssoc<std::map<K, T, C, A>> {
 948 };
 949
 950 // std::unordered_map with string key
 951 template <class K, class T, class H, class E, class A>
 952 struct KeyableTraits<
 953   std::unordered_map<K, T, H, E, A>,
 954   typename KeyFromStringPiece<K>::enabled>
 955   : public KeyableTraitsAssoc<std::unordered_map<K, T, H, E, A>> {
 956 };
 957
 958 }  // namespace detail
 959
 960 // Partial specialization of FormatValue for string-keyed containers
 961 template <class T>
 962 class FormatValue<
 963   T,
 964   typename detail::KeyableTraits<T>::enabled> {
 965  public:
 966   explicit FormatValue(const T& val) : val_(val) { }
 967
 968   template <class FormatCallback>
 969   void format(FormatArg& arg, FormatCallback& cb) const {
 970     FormatValue<typename std::decay<
 971       typename detail::KeyableTraits<T>::value_type>::type>(
 972         detail::KeyableTraits<T>::at(
 973             val_, arg.splitKey())).format(arg, cb);
 974   }
 975
 976  private:
 977   const T& val_;
 978 };
 979
 980 template <class Container, class Value>
 981 class FormatValue<
 982   detail::DefaultValueWrapper<Container, Value>,
 983   typename detail::KeyableTraits<Container>::enabled> {
 984  public:
 985   explicit FormatValue(const detail::DefaultValueWrapper<Container, Value>& val)
 986     : val_(val) { }
 987
 988   template <class FormatCallback>
 989   void format(FormatArg& arg, FormatCallback& cb) const {
 990     FormatValue<typename std::decay<
 991       typename detail::KeyableTraits<Container>::value_type>::type>(
 992           detail::KeyableTraits<Container>::at(
 993               val_.container,
 994               arg.splitKey(),
 995               val_.defaultValue)).format(arg, cb);
 996   }
 997
 998  private:
 999   const detail::DefaultValueWrapper<Container, Value>& val_;
1000 };
1001
1002 // Partial specialization of FormatValue for pairs
1003 template <class A, class B>
1004 class FormatValue<std::pair<A, B>> {
1005  public:
1006   explicit FormatValue(const std::pair<A, B>& val) : val_(val) { }
1007
1008   template <class FormatCallback>
1009   void format(FormatArg& arg, FormatCallback& cb) const {
1010     int key = arg.splitIntKey();
1011     switch (key) {
1012     case 0:
1013       FormatValue<typename std::decay<A>::type>(val_.first).format(arg, cb);
1014       break;
1015     case 1:
1016       FormatValue<typename std::decay<B>::type>(val_.second).format(arg, cb);
1017       break;
1018     default:
1019       arg.error("invalid index for pair");
1020     }
1021   }
1022
1023  private:
1024   const std::pair<A, B>& val_;
1025 };
1026
1027 // Partial specialization of FormatValue for tuples
1028 template <class... Args>
1029 class FormatValue<std::tuple<Args...>> {
1030   typedef std::tuple<Args...> Tuple;
1031  public:
1032   explicit FormatValue(const Tuple& val) : val_(val) { }
1033
1034   template <class FormatCallback>
1035   void format(FormatArg& arg, FormatCallback& cb) const {
1036     int key = arg.splitIntKey();
1037     arg.enforce(key >= 0, "tuple index must be non-negative");
1038     doFormat(key, arg, cb);
1039   }
1040
1041  private:
1042   static constexpr size_t valueCount = std::tuple_size<Tuple>::value;
1043
1044   template <size_t K, class Callback>
1045   typename std::enable_if<K == valueCount>::type doFormatFrom(
1046       size_t i, FormatArg& arg, Callback& /* cb */) const {
1047     arg.enforce("tuple index out of range, max=", i);
1048   }
1049
1050   template <size_t K, class Callback>
1051   typename std::enable_if<(K < valueCount)>::type
1052   doFormatFrom(size_t i, FormatArg& arg, Callback& cb) const {
1053     if (i == K) {
1054       FormatValue<typename std::decay<
1055         typename std::tuple_element<K, Tuple>::type>::type>(
1056           std::get<K>(val_)).format(arg, cb);
1057     } else {
1058       doFormatFrom<K+1>(i, arg, cb);
1059     }
1060   }
1061
1062   template <class Callback>
1063   void doFormat(size_t i, FormatArg& arg, Callback& cb) const {
1064     return doFormatFrom<0>(i, arg, cb);
1065   }
1066
1067   const Tuple& val_;
1068 };
1069
1070 // Partial specialization of FormatValue for nested Formatters
1071 template <bool containerMode, class... Args,
1072           template <bool, class...> class F>
1073 class FormatValue<F<containerMode, Args...>,
1074                   typename std::enable_if<detail::IsFormatter<
1075                       F<containerMode, Args...>>::value>::type> {
1076   typedef typename F<containerMode, Args...>::BaseType FormatterValue;
1077
1078  public:
1079   explicit FormatValue(const FormatterValue& f) : f_(f) { }
1080
1081   template <class FormatCallback>
1082   void format(FormatArg& arg, FormatCallback& cb) const {
1083     format_value::formatFormatter(f_, arg, cb);
1084   }
1085  private:
1086   const FormatterValue& f_;
1087 };
1088
1089 /**
1090  * Formatter objects can be appended to strings, and therefore they're
1091  * compatible with folly::toAppend and folly::to.
1092  */
1093 template <class Tgt, class Derived, bool containerMode, class... Args>
1094 typename std::enable_if<IsSomeString<Tgt>::value>::type toAppend(
1095     const BaseFormatter<Derived, containerMode, Args...>& value, Tgt* result) {
1096   value.appendTo(*result);
1097 }
1098
1099 }  // namespace folly
1100
1101 #pragma GCC diagnostic pop