folly/Format-inl.h

   1 /*
   2  * Copyright 2016 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, '}', 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, '{', 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, '}', 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(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(arg.widthIndex, arg);
 255         }
 256
 257         try {
 258           argIndex = to<int>(piece);
 259         } catch (const std::out_of_range& e) {
 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(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(), 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, 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, 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, prefixLen));
 363     val.advance(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 = -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 = 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(valBufBegin, (valBuf + valBufSize) - valBufBegin,
 500                          "%ju", static_cast<uintmax_t>(uval));
 501 #endif
 502       // valBufSize should always be big enough, so this should never
 503       // happen.
 504       assert(len < valBuf + valBufSize - valBufBegin);
 505       valBufEnd = valBufBegin + len;
 506       break;
 507     }
 508     case 'd':
 509       arg.enforce(!arg.basePrefix,
 510                   "base prefix not allowed with '", presentation,
 511                   "' specifier");
 512       valBufBegin = valBuf + 3;  // room for sign and base prefix
 513
 514       // Use uintToBuffer, faster than sprintf
 515       valBufEnd = valBufBegin + uint64ToBufferUnsafe(uval, valBufBegin);
 516       if (arg.thousandsSeparator) {
 517         detail::insertThousandsGroupingUnsafe(valBufBegin, &valBufEnd);
 518       }
 519       break;
 520     case 'c':
 521       arg.enforce(!arg.basePrefix,
 522                   "base prefix not allowed with '", presentation,
 523                   "' specifier");
 524       arg.enforce(!arg.thousandsSeparator,
 525                   "thousands separator (',') not allowed with '",
 526                   presentation, "' specifier");
 527       valBufBegin = valBuf + 3;
 528       *valBufBegin = static_cast<char>(uval);
 529       valBufEnd = valBufBegin + 1;
 530       break;
 531     case 'o':
 532     case 'O':
 533       arg.enforce(!arg.thousandsSeparator,
 534                   "thousands separator (',') not allowed with '",
 535                   presentation, "' specifier");
 536       valBufEnd = valBuf + valBufSize - 1;
 537       valBufBegin = valBuf + detail::uintToOctal(valBuf, valBufSize - 1, uval);
 538       if (arg.basePrefix) {
 539         *--valBufBegin = '0';
 540         prefixLen = 1;
 541       }
 542       break;
 543     case 'x':
 544       arg.enforce(!arg.thousandsSeparator,
 545                   "thousands separator (',') not allowed with '",
 546                   presentation, "' specifier");
 547       valBufEnd = valBuf + valBufSize - 1;
 548       valBufBegin = valBuf + detail::uintToHexLower(valBuf, valBufSize - 1,
 549                                                     uval);
 550       if (arg.basePrefix) {
 551         *--valBufBegin = 'x';
 552         *--valBufBegin = '0';
 553         prefixLen = 2;
 554       }
 555       break;
 556     case 'X':
 557       arg.enforce(!arg.thousandsSeparator,
 558                   "thousands separator (',') not allowed with '",
 559                   presentation, "' specifier");
 560       valBufEnd = valBuf + valBufSize - 1;
 561       valBufBegin = valBuf + detail::uintToHexUpper(valBuf, valBufSize - 1,
 562                                                     uval);
 563       if (arg.basePrefix) {
 564         *--valBufBegin = 'X';
 565         *--valBufBegin = '0';
 566         prefixLen = 2;
 567       }
 568       break;
 569     case 'b':
 570     case 'B':
 571       arg.enforce(!arg.thousandsSeparator,
 572                   "thousands separator (',') not allowed with '",
 573                   presentation, "' specifier");
 574       valBufEnd = valBuf + valBufSize - 1;
 575       valBufBegin = valBuf + detail::uintToBinary(valBuf, valBufSize - 1,
 576                                                   uval);
 577       if (arg.basePrefix) {
 578         *--valBufBegin = presentation;  // 0b or 0B
 579         *--valBufBegin = '0';
 580         prefixLen = 2;
 581       }
 582       break;
 583     default:
 584       arg.error("invalid specifier '", presentation, "'");
 585     }
 586
 587     if (sign) {
 588       *--valBufBegin = sign;
 589       ++prefixLen;
 590     }
 591
 592     format_value::formatNumber(StringPiece(valBufBegin, valBufEnd), prefixLen,
 593                                arg, cb);
 594   }
 595
 596  private:
 597   T val_;
 598 };
 599
 600 // Bool
 601 template <>
 602 class FormatValue<bool> {
 603  public:
 604   explicit FormatValue(bool val) : val_(val) { }
 605
 606   template <class FormatCallback>
 607   void format(FormatArg& arg, FormatCallback& cb) const {
 608     if (arg.presentation == FormatArg::kDefaultPresentation) {
 609       arg.validate(FormatArg::Type::OTHER);
 610       format_value::formatString(val_ ? "true" : "false", arg, cb);
 611     } else {  // number
 612       FormatValue<int>(val_).format(arg, cb);
 613     }
 614   }
 615
 616  private:
 617   bool val_;
 618 };
 619
 620 // double
 621 template <>
 622 class FormatValue<double> {
 623  public:
 624   explicit FormatValue(double val) : val_(val) { }
 625
 626   template <class FormatCallback>
 627   void format(FormatArg& arg, FormatCallback& cb) const {
 628     fbstring piece;
 629     int prefixLen;
 630     formatHelper(piece, prefixLen, arg);
 631     format_value::formatNumber(piece, prefixLen, arg, cb);
 632   }
 633
 634  private:
 635   void formatHelper(fbstring& piece, int& prefixLen, FormatArg& arg) const;
 636
 637   double val_;
 638 };
 639
 640 // float (defer to double)
 641 template <>
 642 class FormatValue<float> {
 643  public:
 644   explicit FormatValue(float val) : val_(val) { }
 645
 646   template <class FormatCallback>
 647   void format(FormatArg& arg, FormatCallback& cb) const {
 648     FormatValue<double>(val_).format(arg, cb);
 649   }
 650
 651  private:
 652   float val_;
 653 };
 654
 655 // Sring-y types (implicitly convertible to StringPiece, except char*)
 656 template <class T>
 657 class FormatValue<
 658   T, typename std::enable_if<
 659       (!std::is_pointer<T>::value ||
 660        !std::is_same<char, typename std::decay<
 661           typename std::remove_pointer<T>::type>::type>::value) &&
 662       std::is_convertible<T, StringPiece>::value>::type>
 663   {
 664  public:
 665   explicit FormatValue(StringPiece val) : val_(val) { }
 666
 667   template <class FormatCallback>
 668   void format(FormatArg& arg, FormatCallback& cb) const {
 669     if (arg.keyEmpty()) {
 670       arg.validate(FormatArg::Type::OTHER);
 671       arg.enforce(arg.presentation == FormatArg::kDefaultPresentation ||
 672                   arg.presentation == 's',
 673                   "invalid specifier '", arg.presentation, "'");
 674       format_value::formatString(val_, arg, cb);
 675     } else {
 676       FormatValue<char>(val_.at(arg.splitIntKey())).format(arg, cb);
 677     }
 678   }
 679
 680  private:
 681   StringPiece val_;
 682 };
 683
 684 // Null
 685 template <>
 686 class FormatValue<std::nullptr_t> {
 687  public:
 688   explicit FormatValue(std::nullptr_t) { }
 689
 690   template <class FormatCallback>
 691   void format(FormatArg& arg, FormatCallback& cb) const {
 692     arg.validate(FormatArg::Type::OTHER);
 693     arg.enforce(arg.presentation == FormatArg::kDefaultPresentation,
 694                 "invalid specifier '", arg.presentation, "'");
 695     format_value::formatString("(null)", arg, cb);
 696   }
 697 };
 698
 699 // Partial specialization of FormatValue for char*
 700 template <class T>
 701 class FormatValue<
 702   T*,
 703   typename std::enable_if<
 704       std::is_same<char, typename std::decay<T>::type>::value>::type>
 705   {
 706  public:
 707   explicit FormatValue(T* val) : val_(val) { }
 708
 709   template <class FormatCallback>
 710   void format(FormatArg& arg, FormatCallback& cb) const {
 711     if (arg.keyEmpty()) {
 712       if (!val_) {
 713         FormatValue<std::nullptr_t>(nullptr).format(arg, cb);
 714       } else {
 715         FormatValue<StringPiece>(val_).format(arg, cb);
 716       }
 717     } else {
 718       FormatValue<typename std::decay<T>::type>(
 719           val_[arg.splitIntKey()]).format(arg, cb);
 720     }
 721   }
 722
 723  private:
 724   T* val_;
 725 };
 726
 727 // Partial specialization of FormatValue for void*
 728 template <class T>
 729 class FormatValue<
 730   T*,
 731   typename std::enable_if<
 732       std::is_same<void, typename std::decay<T>::type>::value>::type>
 733   {
 734  public:
 735   explicit FormatValue(T* val) : val_(val) { }
 736
 737   template <class FormatCallback>
 738   void format(FormatArg& arg, FormatCallback& cb) const {
 739     if (!val_) {
 740       FormatValue<std::nullptr_t>(nullptr).format(arg, cb);
 741     } else {
 742       // Print as a pointer, in hex.
 743       arg.validate(FormatArg::Type::OTHER);
 744       arg.enforce(arg.presentation == FormatArg::kDefaultPresentation,
 745                   "invalid specifier '", arg.presentation, "'");
 746       arg.basePrefix = true;
 747       arg.presentation = 'x';
 748       if (arg.align == FormatArg::Align::DEFAULT) {
 749         arg.align = FormatArg::Align::LEFT;
 750       }
 751       FormatValue<uintptr_t>(
 752           reinterpret_cast<uintptr_t>(val_)).doFormat(arg, cb);
 753     }
 754   }
 755
 756  private:
 757   T* val_;
 758 };
 759
 760 template <class T, class = void>
 761 class TryFormatValue {
 762  public:
 763   template <class FormatCallback>
 764   static void formatOrFail(T& /* value */,
 765                            FormatArg& arg,
 766                            FormatCallback& /* cb */) {
 767     arg.error("No formatter available for this type");
 768   }
 769 };
 770
 771 template <class T>
 772 class TryFormatValue<
 773   T,
 774   typename std::enable_if<
 775       0 < sizeof(FormatValue<typename std::decay<T>::type>)>::type>
 776   {
 777  public:
 778   template <class FormatCallback>
 779   static void formatOrFail(T& value, FormatArg& arg, FormatCallback& cb) {
 780     FormatValue<typename std::decay<T>::type>(value).format(arg, cb);
 781   }
 782 };
 783
 784 // Partial specialization of FormatValue for other pointers
 785 template <class T>
 786 class FormatValue<
 787   T*,
 788   typename std::enable_if<
 789       !std::is_same<char, typename std::decay<T>::type>::value &&
 790       !std::is_same<void, typename std::decay<T>::type>::value>::type>
 791   {
 792  public:
 793   explicit FormatValue(T* val) : val_(val) { }
 794
 795   template <class FormatCallback>
 796   void format(FormatArg& arg, FormatCallback& cb) const {
 797     if (arg.keyEmpty()) {
 798       FormatValue<void*>((void*)val_).format(arg, cb);
 799     } else {
 800       TryFormatValue<T>::formatOrFail(val_[arg.splitIntKey()], arg, cb);
 801     }
 802   }
 803  private:
 804   T* val_;
 805 };
 806
 807 namespace detail {
 808
 809 // std::array
 810 template <class T, size_t N>
 811 struct IndexableTraits<std::array<T, N>>
 812   : public IndexableTraitsSeq<std::array<T, N>> {
 813 };
 814
 815 // std::vector
 816 template <class T, class A>
 817 struct IndexableTraits<std::vector<T, A>>
 818   : public IndexableTraitsSeq<std::vector<T, A>> {
 819 };
 820
 821 // std::deque
 822 template <class T, class A>
 823 struct IndexableTraits<std::deque<T, A>>
 824   : public IndexableTraitsSeq<std::deque<T, A>> {
 825 };
 826
 827 // std::map with integral keys
 828 template <class K, class T, class C, class A>
 829 struct IndexableTraits<
 830   std::map<K, T, C, A>,
 831   typename std::enable_if<std::is_integral<K>::value>::type>
 832   : public IndexableTraitsAssoc<std::map<K, T, C, A>> {
 833 };
 834
 835 // std::unordered_map with integral keys
 836 template <class K, class T, class H, class E, class A>
 837 struct IndexableTraits<
 838   std::unordered_map<K, T, H, E, A>,
 839   typename std::enable_if<std::is_integral<K>::value>::type>
 840   : public IndexableTraitsAssoc<std::unordered_map<K, T, H, E, A>> {
 841 };
 842
 843 }  // namespace detail
 844
 845 // Partial specialization of FormatValue for integer-indexable containers
 846 template <class T>
 847 class FormatValue<
 848   T,
 849   typename detail::IndexableTraits<T>::enabled> {
 850  public:
 851   explicit FormatValue(const T& val) : val_(val) { }
 852
 853   template <class FormatCallback>
 854   void format(FormatArg& arg, FormatCallback& cb) const {
 855     FormatValue<typename std::decay<
 856       typename detail::IndexableTraits<T>::value_type>::type>(
 857         detail::IndexableTraits<T>::at(
 858             val_, arg.splitIntKey())).format(arg, cb);
 859   }
 860
 861  private:
 862   const T& val_;
 863 };
 864
 865 template <class Container, class Value>
 866 class FormatValue<
 867   detail::DefaultValueWrapper<Container, Value>,
 868   typename detail::IndexableTraits<Container>::enabled> {
 869  public:
 870   explicit FormatValue(const detail::DefaultValueWrapper<Container, Value>& val)
 871     : val_(val) { }
 872
 873   template <class FormatCallback>
 874   void format(FormatArg& arg, FormatCallback& cb) const {
 875     FormatValue<typename std::decay<
 876       typename detail::IndexableTraits<Container>::value_type>::type>(
 877           detail::IndexableTraits<Container>::at(
 878               val_.container,
 879               arg.splitIntKey(),
 880               val_.defaultValue)).format(arg, cb);
 881   }
 882
 883  private:
 884   const detail::DefaultValueWrapper<Container, Value>& val_;
 885 };
 886
 887 namespace detail {
 888
 889 // Define enabled, key_type, convert from StringPiece to the key types
 890 // that we support
 891 template <class T> struct KeyFromStringPiece;
 892
 893 // std::string
 894 template <>
 895 struct KeyFromStringPiece<std::string> : public FormatTraitsBase {
 896   typedef std::string key_type;
 897   static std::string convert(StringPiece s) {
 898     return s.toString();
 899   }
 900   typedef void enabled;
 901 };
 902
 903 // fbstring
 904 template <>
 905 struct KeyFromStringPiece<fbstring> : public FormatTraitsBase {
 906   typedef fbstring key_type;
 907   static fbstring convert(StringPiece s) {
 908     return s.toFbstring();
 909   }
 910 };
 911
 912 // StringPiece
 913 template <>
 914 struct KeyFromStringPiece<StringPiece> : public FormatTraitsBase {
 915   typedef StringPiece key_type;
 916   static StringPiece convert(StringPiece s) {
 917     return s;
 918   }
 919 };
 920
 921 // Base class for associative types keyed by strings
 922 template <class T> struct KeyableTraitsAssoc : public FormatTraitsBase {
 923   typedef typename T::key_type key_type;
 924   typedef typename T::value_type::second_type value_type;
 925   static const value_type& at(const T& map, StringPiece key) {
 926     return map.at(KeyFromStringPiece<key_type>::convert(key));
 927   }
 928   static const value_type& at(const T& map, StringPiece key,
 929                               const value_type& dflt) {
 930     auto pos = map.find(KeyFromStringPiece<key_type>::convert(key));
 931     return pos != map.end() ? pos->second : dflt;
 932   }
 933 };
 934
 935 // Define enabled, key_type, value_type, at() for supported string-keyed
 936 // types
 937 template <class T, class Enabled=void> struct KeyableTraits;
 938
 939 // std::map with string key
 940 template <class K, class T, class C, class A>
 941 struct KeyableTraits<
 942   std::map<K, T, C, A>,
 943   typename KeyFromStringPiece<K>::enabled>
 944   : public KeyableTraitsAssoc<std::map<K, T, C, A>> {
 945 };
 946
 947 // std::unordered_map with string key
 948 template <class K, class T, class H, class E, class A>
 949 struct KeyableTraits<
 950   std::unordered_map<K, T, H, E, A>,
 951   typename KeyFromStringPiece<K>::enabled>
 952   : public KeyableTraitsAssoc<std::unordered_map<K, T, H, E, A>> {
 953 };
 954
 955 }  // namespace detail
 956
 957 // Partial specialization of FormatValue for string-keyed containers
 958 template <class T>
 959 class FormatValue<
 960   T,
 961   typename detail::KeyableTraits<T>::enabled> {
 962  public:
 963   explicit FormatValue(const T& val) : val_(val) { }
 964
 965   template <class FormatCallback>
 966   void format(FormatArg& arg, FormatCallback& cb) const {
 967     FormatValue<typename std::decay<
 968       typename detail::KeyableTraits<T>::value_type>::type>(
 969         detail::KeyableTraits<T>::at(
 970             val_, arg.splitKey())).format(arg, cb);
 971   }
 972
 973  private:
 974   const T& val_;
 975 };
 976
 977 template <class Container, class Value>
 978 class FormatValue<
 979   detail::DefaultValueWrapper<Container, Value>,
 980   typename detail::KeyableTraits<Container>::enabled> {
 981  public:
 982   explicit FormatValue(const detail::DefaultValueWrapper<Container, Value>& val)
 983     : val_(val) { }
 984
 985   template <class FormatCallback>
 986   void format(FormatArg& arg, FormatCallback& cb) const {
 987     FormatValue<typename std::decay<
 988       typename detail::KeyableTraits<Container>::value_type>::type>(
 989           detail::KeyableTraits<Container>::at(
 990               val_.container,
 991               arg.splitKey(),
 992               val_.defaultValue)).format(arg, cb);
 993   }
 994
 995  private:
 996   const detail::DefaultValueWrapper<Container, Value>& val_;
 997 };
 998
 999 // Partial specialization of FormatValue for pairs
1000 template <class A, class B>
1001 class FormatValue<std::pair<A, B>> {
1002  public:
1003   explicit FormatValue(const std::pair<A, B>& val) : val_(val) { }
1004
1005   template <class FormatCallback>
1006   void format(FormatArg& arg, FormatCallback& cb) const {
1007     int key = arg.splitIntKey();
1008     switch (key) {
1009     case 0:
1010       FormatValue<typename std::decay<A>::type>(val_.first).format(arg, cb);
1011       break;
1012     case 1:
1013       FormatValue<typename std::decay<B>::type>(val_.second).format(arg, cb);
1014       break;
1015     default:
1016       arg.error("invalid index for pair");
1017     }
1018   }
1019
1020  private:
1021   const std::pair<A, B>& val_;
1022 };
1023
1024 // Partial specialization of FormatValue for tuples
1025 template <class... Args>
1026 class FormatValue<std::tuple<Args...>> {
1027   typedef std::tuple<Args...> Tuple;
1028  public:
1029   explicit FormatValue(const Tuple& val) : val_(val) { }
1030
1031   template <class FormatCallback>
1032   void format(FormatArg& arg, FormatCallback& cb) const {
1033     int key = arg.splitIntKey();
1034     arg.enforce(key >= 0, "tuple index must be non-negative");
1035     doFormat(key, arg, cb);
1036   }
1037
1038  private:
1039   static constexpr size_t valueCount = std::tuple_size<Tuple>::value;
1040
1041   template <size_t K, class Callback>
1042   typename std::enable_if<K == valueCount>::type doFormatFrom(
1043       size_t i, FormatArg& arg, Callback& /* cb */) const {
1044     arg.enforce("tuple index out of range, max=", i);
1045   }
1046
1047   template <size_t K, class Callback>
1048   typename std::enable_if<(K < valueCount)>::type
1049   doFormatFrom(size_t i, FormatArg& arg, Callback& cb) const {
1050     if (i == K) {
1051       FormatValue<typename std::decay<
1052         typename std::tuple_element<K, Tuple>::type>::type>(
1053           std::get<K>(val_)).format(arg, cb);
1054     } else {
1055       doFormatFrom<K+1>(i, arg, cb);
1056     }
1057   }
1058
1059   template <class Callback>
1060   void doFormat(size_t i, FormatArg& arg, Callback& cb) const {
1061     return doFormatFrom<0>(i, arg, cb);
1062   }
1063
1064   const Tuple& val_;
1065 };
1066
1067 // Partial specialization of FormatValue for nested Formatters
1068 template <bool containerMode, class... Args,
1069           template <bool, class...> class F>
1070 class FormatValue<F<containerMode, Args...>,
1071                   typename std::enable_if<detail::IsFormatter<
1072                       F<containerMode, Args...>>::value>::type> {
1073   typedef typename F<containerMode, Args...>::BaseType FormatterValue;
1074
1075  public:
1076   explicit FormatValue(const FormatterValue& f) : f_(f) { }
1077
1078   template <class FormatCallback>
1079   void format(FormatArg& arg, FormatCallback& cb) const {
1080     format_value::formatFormatter(f_, arg, cb);
1081   }
1082  private:
1083   const FormatterValue& f_;
1084 };
1085
1086 /**
1087  * Formatter objects can be appended to strings, and therefore they're
1088  * compatible with folly::toAppend and folly::to.
1089  */
1090 template <class Tgt, class Derived, bool containerMode, class... Args>
1091 typename std::enable_if<IsSomeString<Tgt>::value>::type toAppend(
1092     const BaseFormatter<Derived, containerMode, Args...>& value, Tgt* result) {
1093   value.appendTo(*result);
1094 }
1095
1096 }  // namespace folly
1097
1098 #pragma GCC diagnostic pop