folly/String.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_BASE_STRING_H_
  18 #define FOLLY_BASE_STRING_H_
  19
  20 #include <exception>
  21 #include <stdarg.h>
  22 #include <string>
  23 #include <boost/type_traits.hpp>
  24 #include <boost/regex/pending/unicode_iterator.hpp>
  25
  26 #ifdef FOLLY_HAVE_DEPRECATED_ASSOC
  27 #ifdef _GLIBCXX_SYMVER
  28 #include <ext/hash_set>
  29 #include <ext/hash_map>
  30 #endif
  31 #endif
  32
  33 #include <unordered_set>
  34 #include <unordered_map>
  35
  36 #include <folly/Conv.h>
  37 #include <folly/Demangle.h>
  38 #include <folly/FBString.h>
  39 #include <folly/FBVector.h>
  40 #include <folly/Portability.h>
  41 #include <folly/Range.h>
  42 #include <folly/ScopeGuard.h>
  43
  44 // Compatibility function, to make sure toStdString(s) can be called
  45 // to convert a std::string or fbstring variable s into type std::string
  46 // with very little overhead if s was already std::string
  47 namespace folly {
  48
  49 inline
  50 std::string toStdString(const folly::fbstring& s) {
  51   return std::string(s.data(), s.size());
  52 }
  53
  54 inline
  55 const std::string& toStdString(const std::string& s) {
  56   return s;
  57 }
  58
  59 // If called with a temporary, the compiler will select this overload instead
  60 // of the above, so we don't return a (lvalue) reference to a temporary.
  61 inline
  62 std::string&& toStdString(std::string&& s) {
  63   return std::move(s);
  64 }
  65
  66 /**
  67  * C-Escape a string, making it suitable for representation as a C string
  68  * literal.  Appends the result to the output string.
  69  *
  70  * Backslashes all occurrences of backslash and double-quote:
  71  *   "  ->  \"
  72  *   \  ->  \\
  73  *
  74  * Replaces all non-printable ASCII characters with backslash-octal
  75  * representation:
  76  *   <ASCII 254> -> \376
  77  *
  78  * Note that we use backslash-octal instead of backslash-hex because the octal
  79  * representation is guaranteed to consume no more than 3 characters; "\3760"
  80  * represents two characters, one with value 254, and one with value 48 ('0'),
  81  * whereas "\xfe0" represents only one character (with value 4064, which leads
  82  * to implementation-defined behavior).
  83  */
  84 template <class String>
  85 void cEscape(StringPiece str, String& out);
  86
  87 /**
  88  * Similar to cEscape above, but returns the escaped string.
  89  */
  90 template <class String>
  91 String cEscape(StringPiece str) {
  92   String out;
  93   cEscape(str, out);
  94   return out;
  95 }
  96
  97 /**
  98  * C-Unescape a string; the opposite of cEscape above.  Appends the result
  99  * to the output string.
 100  *
 101  * Recognizes the standard C escape sequences:
 102  *
 103  * \' \" \? \\ \a \b \f \n \r \t \v
 104  * \[0-7]+
 105  * \x[0-9a-fA-F]+
 106  *
 107  * In strict mode (default), throws std::invalid_argument if it encounters
 108  * an unrecognized escape sequence.  In non-strict mode, it leaves
 109  * the escape sequence unchanged.
 110  */
 111 template <class String>
 112 void cUnescape(StringPiece str, String& out, bool strict = true);
 113
 114 /**
 115  * Similar to cUnescape above, but returns the escaped string.
 116  */
 117 template <class String>
 118 String cUnescape(StringPiece str, bool strict = true) {
 119   String out;
 120   cUnescape(str, out, strict);
 121   return out;
 122 }
 123
 124 /**
 125  * URI-escape a string.  Appends the result to the output string.
 126  *
 127  * Alphanumeric characters and other characters marked as "unreserved" in RFC
 128  * 3986 ( -_.~ ) are left unchanged.  In PATH mode, the forward slash (/) is
 129  * also left unchanged.  In QUERY mode, spaces are replaced by '+'.  All other
 130  * characters are percent-encoded.
 131  */
 132 enum class UriEscapeMode : unsigned char {
 133   // The values are meaningful, see generate_escape_tables.py
 134   ALL = 0,
 135   QUERY = 1,
 136   PATH = 2
 137 };
 138 template <class String>
 139 void uriEscape(StringPiece str,
 140                String& out,
 141                UriEscapeMode mode = UriEscapeMode::ALL);
 142
 143 /**
 144  * Similar to uriEscape above, but returns the escaped string.
 145  */
 146 template <class String>
 147 String uriEscape(StringPiece str, UriEscapeMode mode = UriEscapeMode::ALL) {
 148   String out;
 149   uriEscape(str, out, mode);
 150   return out;
 151 }
 152
 153 /**
 154  * URI-unescape a string.  Appends the result to the output string.
 155  *
 156  * In QUERY mode, '+' are replaced by space.  %XX sequences are decoded if
 157  * XX is a valid hex sequence, otherwise we throw invalid_argument.
 158  */
 159 template <class String>
 160 void uriUnescape(StringPiece str,
 161                  String& out,
 162                  UriEscapeMode mode = UriEscapeMode::ALL);
 163
 164 /**
 165  * Similar to uriUnescape above, but returns the unescaped string.
 166  */
 167 template <class String>
 168 String uriUnescape(StringPiece str, UriEscapeMode mode = UriEscapeMode::ALL) {
 169   String out;
 170   uriUnescape(str, out, mode);
 171   return out;
 172 }
 173
 174 /**
 175  * stringPrintf is much like printf but deposits its result into a
 176  * string. Two signatures are supported: the first simply returns the
 177  * resulting string, and the second appends the produced characters to
 178  * the specified string and returns a reference to it.
 179  */
 180 std::string stringPrintf(FOLLY_PRINTF_FORMAT const char* format, ...)
 181   FOLLY_PRINTF_FORMAT_ATTR(1, 2);
 182
 183 /* Similar to stringPrintf, with different signature. */
 184 void stringPrintf(std::string* out, FOLLY_PRINTF_FORMAT const char* fmt, ...)
 185   FOLLY_PRINTF_FORMAT_ATTR(2, 3);
 186
 187 std::string& stringAppendf(std::string* output,
 188                           FOLLY_PRINTF_FORMAT const char* format, ...)
 189   FOLLY_PRINTF_FORMAT_ATTR(2, 3);
 190
 191 /**
 192  * Similar to stringPrintf, but accepts a va_list argument.
 193  *
 194  * As with vsnprintf() itself, the value of ap is undefined after the call.
 195  * These functions do not call va_end() on ap.
 196  */
 197 std::string stringVPrintf(const char* format, va_list ap);
 198 void stringVPrintf(std::string* out, const char* format, va_list ap);
 199 std::string& stringVAppendf(std::string* out, const char* format, va_list ap);
 200
 201 /**
 202  * Backslashify a string, that is, replace non-printable characters
 203  * with C-style (but NOT C compliant) "\xHH" encoding.  If hex_style
 204  * is false, then shorthand notations like "\0" will be used instead
 205  * of "\x00" for the most common backslash cases.
 206  *
 207  * There are two forms, one returning the input string, and one
 208  * creating output in the specified output string.
 209  *
 210  * This is mainly intended for printing to a terminal, so it is not
 211  * particularly optimized.
 212  *
 213  * Do *not* use this in situations where you expect to be able to feed
 214  * the string to a C or C++ compiler, as there are nuances with how C
 215  * parses such strings that lead to failures.  This is for display
 216  * purposed only.  If you want a string you can embed for use in C or
 217  * C++, use cEscape instead.  This function is for display purposes
 218  * only.
 219  */
 220 template <class String1, class String2>
 221 void backslashify(const String1& input, String2& output, bool hex_style=false);
 222
 223 template <class String>
 224 String backslashify(const String& input, bool hex_style=false) {
 225   String output;
 226   backslashify(input, output, hex_style);
 227   return output;
 228 }
 229
 230 /**
 231  * Take a string and "humanify" it -- that is, make it look better.
 232  * Since "better" is subjective, caveat emptor.  The basic approach is
 233  * to count the number of unprintable characters.  If there are none,
 234  * then the output is the input.  If there are relatively few, or if
 235  * there is a long "enough" prefix of printable characters, use
 236  * backslashify.  If it is mostly binary, then simply hex encode.
 237  *
 238  * This is an attempt to make a computer smart, and so likely is wrong
 239  * most of the time.
 240  */
 241 template <class String1, class String2>
 242 void humanify(const String1& input, String2& output);
 243
 244 template <class String>
 245 String humanify(const String& input) {
 246   String output;
 247   humanify(input, output);
 248   return output;
 249 }
 250
 251 /**
 252  * Same functionality as Python's binascii.hexlify.  Returns true
 253  * on successful conversion.
 254  *
 255  * If append_output is true, append data to the output rather than
 256  * replace it.
 257  */
 258 template<class InputString, class OutputString>
 259 bool hexlify(const InputString& input, OutputString& output,
 260              bool append=false);
 261
 262 /**
 263  * Same functionality as Python's binascii.unhexlify.  Returns true
 264  * on successful conversion.
 265  */
 266 template<class InputString, class OutputString>
 267 bool unhexlify(const InputString& input, OutputString& output);
 268
 269 /*
 270  * A pretty-printer for numbers that appends suffixes of units of the
 271  * given type.  It prints 4 sig-figs of value with the most
 272  * appropriate unit.
 273  *
 274  * If `addSpace' is true, we put a space between the units suffix and
 275  * the value.
 276  *
 277  * Current types are:
 278  *   PRETTY_TIME         - s, ms, us, ns, etc.
 279  *   PRETTY_BYTES_METRIC - kB, MB, GB, etc (goes up by 10^3 = 1000 each time)
 280  *   PRETTY_BYTES        - kB, MB, GB, etc (goes up by 2^10 = 1024 each time)
 281  *   PRETTY_BYTES_IEC    - KiB, MiB, GiB, etc
 282  *   PRETTY_UNITS_METRIC - k, M, G, etc (goes up by 10^3 = 1000 each time)
 283  *   PRETTY_UNITS_BINARY - k, M, G, etc (goes up by 2^10 = 1024 each time)
 284  *   PRETTY_UNITS_BINARY_IEC - Ki, Mi, Gi, etc
 285  *   PRETTY_SI           - full SI metric prefixes from yocto to Yotta
 286  *                         http://en.wikipedia.org/wiki/Metric_prefix
 287  * @author Mark Rabkin <mrabkin@fb.com>
 288  */
 289 enum PrettyType {
 290   PRETTY_TIME,
 291
 292   PRETTY_BYTES_METRIC,
 293   PRETTY_BYTES_BINARY,
 294   PRETTY_BYTES = PRETTY_BYTES_BINARY,
 295   PRETTY_BYTES_BINARY_IEC,
 296   PRETTY_BYTES_IEC = PRETTY_BYTES_BINARY_IEC,
 297
 298   PRETTY_UNITS_METRIC,
 299   PRETTY_UNITS_BINARY,
 300   PRETTY_UNITS_BINARY_IEC,
 301
 302   PRETTY_SI,
 303   PRETTY_NUM_TYPES,
 304 };
 305
 306 std::string prettyPrint(double val, PrettyType, bool addSpace = true);
 307
 308 /**
 309  * This utility converts StringPiece in pretty format (look above) to double,
 310  * with progress information. Alters the  StringPiece parameter
 311  * to get rid of the already-parsed characters.
 312  * Expects string in form <floating point number> {space}* [<suffix>]
 313  * If string is not in correct format, utility finds longest valid prefix and
 314  * if there at least one, returns double value based on that prefix and
 315  * modifies string to what is left after parsing. Throws and std::range_error
 316  * exception if there is no correct parse.
 317  * Examples(for PRETTY_UNITS_METRIC):
 318  * '10M' => 10 000 000
 319  * '10 M' => 10 000 000
 320  * '10' => 10
 321  * '10 Mx' => 10 000 000, prettyString == "x"
 322  * 'abc' => throws std::range_error
 323  */
 324 double prettyToDouble(folly::StringPiece *const prettyString,
 325                       const PrettyType type);
 326
 327 /*
 328  * Same as prettyToDouble(folly::StringPiece*, PrettyType), but
 329  * expects whole string to be correctly parseable. Throws std::range_error
 330  * otherwise
 331  */
 332 double prettyToDouble(folly::StringPiece prettyString, const PrettyType type);
 333
 334 /**
 335  * Write a hex dump of size bytes starting at ptr to out.
 336  *
 337  * The hex dump is formatted as follows:
 338  *
 339  * for the string "abcdefghijklmnopqrstuvwxyz\x02"
 340 00000000  61 62 63 64 65 66 67 68  69 6a 6b 6c 6d 6e 6f 70  |abcdefghijklmnop|
 341 00000010  71 72 73 74 75 76 77 78  79 7a 02                 |qrstuvwxyz.     |
 342  *
 343  * that is, we write 16 bytes per line, both as hex bytes and as printable
 344  * characters.  Non-printable characters are replaced with '.'
 345  * Lines are written to out one by one (one StringPiece at a time) without
 346  * delimiters.
 347  */
 348 template <class OutIt>
 349 void hexDump(const void* ptr, size_t size, OutIt out);
 350
 351 /**
 352  * Return the hex dump of size bytes starting at ptr as a string.
 353  */
 354 std::string hexDump(const void* ptr, size_t size);
 355
 356 /**
 357  * Return a fbstring containing the description of the given errno value.
 358  * Takes care not to overwrite the actual system errno, so calling
 359  * errnoStr(errno) is valid.
 360  */
 361 fbstring errnoStr(int err);
 362
 363 /**
 364  * Debug string for an exception: include type and what(), if
 365  * defined.
 366  */
 367 inline fbstring exceptionStr(const std::exception& e) {
 368 #ifdef FOLLY_HAS_RTTI
 369   return folly::to<fbstring>(demangle(typeid(e)), ": ", e.what());
 370 #else
 371   return folly::to<fbstring>("Exception (no RTTI available): ", e.what());
 372 #endif
 373 }
 374
 375 // Empirically, this indicates if the runtime supports
 376 // std::exception_ptr, as not all (arm, for instance) do.
 377 #if defined(__GNUC__) && defined(__GCC_ATOMIC_INT_LOCK_FREE) && \
 378   __GCC_ATOMIC_INT_LOCK_FREE > 1
 379 inline fbstring exceptionStr(std::exception_ptr ep) {
 380   try {
 381     std::rethrow_exception(ep);
 382   } catch (const std::exception& e) {
 383     return exceptionStr(e);
 384   } catch (...) {
 385     return "<unknown exception>";
 386   }
 387 }
 388 #endif
 389
 390 template<typename E>
 391 auto exceptionStr(const E& e)
 392   -> typename std::enable_if<!std::is_base_of<std::exception, E>::value,
 393                              fbstring>::type
 394 {
 395 #ifdef FOLLY_HAS_RTTI
 396   return folly::to<fbstring>(demangle(typeid(e)));
 397 #else
 398   return "Exception (no RTTI available)";
 399 #endif
 400 }
 401
 402 /*
 403  * Split a string into a list of tokens by delimiter.
 404  *
 405  * The split interface here supports different output types, selected
 406  * at compile time: StringPiece, fbstring, or std::string.  If you are
 407  * using a vector to hold the output, it detects the type based on
 408  * what your vector contains.  If the output vector is not empty, split
 409  * will append to the end of the vector.
 410  *
 411  * You can also use splitTo() to write the output to an arbitrary
 412  * OutputIterator (e.g. std::inserter() on a std::set<>), in which
 413  * case you have to tell the function the type.  (Rationale:
 414  * OutputIterators don't have a value_type, so we can't detect the
 415  * type in splitTo without being told.)
 416  *
 417  * Examples:
 418  *
 419  *   std::vector<folly::StringPiece> v;
 420  *   folly::split(":", "asd:bsd", v);
 421  *
 422  *   std::set<StringPiece> s;
 423  *   folly::splitTo<StringPiece>(":", "asd:bsd:asd:csd",
 424  *    std::inserter(s, s.begin()));
 425  *
 426  * Split also takes a flag (ignoreEmpty) that indicates whether adjacent
 427  * delimiters should be treated as one single separator (ignoring empty tokens)
 428  * or not (generating empty tokens).
 429  */
 430
 431 template<class Delim, class String, class OutputType>
 432 void split(const Delim& delimiter,
 433            const String& input,
 434            std::vector<OutputType>& out,
 435            bool ignoreEmpty = false);
 436
 437 template<class Delim, class String, class OutputType>
 438 void split(const Delim& delimiter,
 439            const String& input,
 440            folly::fbvector<OutputType>& out,
 441            bool ignoreEmpty = false);
 442
 443 template<class OutputValueType, class Delim, class String,
 444          class OutputIterator>
 445 void splitTo(const Delim& delimiter,
 446              const String& input,
 447              OutputIterator out,
 448              bool ignoreEmpty = false);
 449
 450 /*
 451  * Split a string into a fixed number of string pieces and/or numeric types
 452  * by delimiter. Any numeric type that folly::to<> can convert to from a
 453  * string piece is supported as a target. Returns 'true' if the fields were
 454  * all successfully populated.  Returns 'false' if there were too few fields
 455  * in the input, or too many fields if exact=true.  Casting exceptions will
 456  * not be caught.
 457  *
 458  * Examples:
 459  *
 460  *  folly::StringPiece name, key, value;
 461  *  if (folly::split('\t', line, name, key, value))
 462  *    ...
 463  *
 464  *  folly::StringPiece name;
 465  *  double value;
 466  *  int id;
 467  *  if (folly::split('\t', line, name, value, id))
 468  *    ...
 469  *
 470  * The 'exact' template parameter specifies how the function behaves when too
 471  * many fields are present in the input string. When 'exact' is set to its
 472  * default value of 'true', a call to split will fail if the number of fields in
 473  * the input string does not exactly match the number of output parameters
 474  * passed. If 'exact' is overridden to 'false', all remaining fields will be
 475  * stored, unsplit, in the last field, as shown below:
 476  *
 477  *  folly::StringPiece x, y.
 478  *  if (folly::split<false>(':', "a:b:c", x, y))
 479  *    assert(x == "a" && y == "b:c");
 480  *
 481  * Note that this will likely not work if the last field's target is of numeric
 482  * type, in which case folly::to<> will throw an exception.
 483  */
 484 template <class T>
 485 using IsSplitTargetType = std::integral_constant<bool,
 486   std::is_arithmetic<T>::value ||
 487   std::is_same<T, StringPiece>::value ||
 488   IsSomeString<T>::value>;
 489
 490 template<bool exact = true,
 491          class Delim,
 492          class OutputType,
 493          class... OutputTypes>
 494 typename std::enable_if<IsSplitTargetType<OutputType>::value, bool>::type
 495 split(const Delim& delimiter,
 496       StringPiece input,
 497       OutputType& outHead,
 498       OutputTypes&... outTail);
 499
 500 /*
 501  * Join list of tokens.
 502  *
 503  * Stores a string representation of tokens in the same order with
 504  * deliminer between each element.
 505  */
 506
 507 template <class Delim, class Iterator, class String>
 508 void join(const Delim& delimiter,
 509           Iterator begin,
 510           Iterator end,
 511           String& output);
 512
 513 template <class Delim, class Container, class String>
 514 void join(const Delim& delimiter,
 515           const Container& container,
 516           String& output) {
 517   join(delimiter, container.begin(), container.end(), output);
 518 }
 519
 520 template <class Delim, class Value, class String>
 521 void join(const Delim& delimiter,
 522           const std::initializer_list<Value>& values,
 523           String& output) {
 524   join(delimiter, values.begin(), values.end(), output);
 525 }
 526
 527 template <class Delim, class Container>
 528 std::string join(const Delim& delimiter,
 529                  const Container& container) {
 530   std::string output;
 531   join(delimiter, container.begin(), container.end(), output);
 532   return output;
 533 }
 534
 535 template <class Delim, class Value>
 536 std::string join(const Delim& delimiter,
 537                  const std::initializer_list<Value>& values) {
 538   std::string output;
 539   join(delimiter, values.begin(), values.end(), output);
 540   return output;
 541 }
 542
 543 template <class Delim,
 544           class Iterator,
 545           typename std::enable_if<std::is_same<
 546               typename std::iterator_traits<Iterator>::iterator_category,
 547               std::random_access_iterator_tag>::value>::type* = nullptr>
 548 std::string join(const Delim& delimiter, Iterator begin, Iterator end) {
 549   std::string output;
 550   join(delimiter, begin, end, output);
 551   return output;
 552 }
 553
 554 /**
 555  * Returns a subpiece with all whitespace removed from the front of @sp.
 556  * Whitespace means any of [' ', '\n', '\r', '\t'].
 557  */
 558 StringPiece ltrimWhitespace(StringPiece sp);
 559
 560 /**
 561  * Returns a subpiece with all whitespace removed from the back of @sp.
 562  * Whitespace means any of [' ', '\n', '\r', '\t'].
 563  */
 564 StringPiece rtrimWhitespace(StringPiece sp);
 565
 566 /**
 567  * Returns a subpiece with all whitespace removed from the back and front of @sp.
 568  * Whitespace means any of [' ', '\n', '\r', '\t'].
 569  */
 570 inline StringPiece trimWhitespace(StringPiece sp) {
 571   return ltrimWhitespace(rtrimWhitespace(sp));
 572 }
 573
 574 /**
 575  * Returns a subpiece with all whitespace removed from the front of @sp.
 576  * Whitespace means any of [' ', '\n', '\r', '\t'].
 577  * DEPRECATED: @see ltrimWhitespace @see rtrimWhitespace
 578  */
 579 inline StringPiece skipWhitespace(StringPiece sp) {
 580   return ltrimWhitespace(sp);
 581 }
 582
 583 /**
 584  *  Strips the leading and the trailing whitespace-only lines. Then looks for
 585  *  the least indented non-whitespace-only line and removes its amount of
 586  *  leading whitespace from every line. Assumes leading whitespace is either all
 587  *  spaces or all tabs.
 588  *
 589  *  Purpose: including a multiline string literal in source code, indented to
 590  *  the level expected from context.
 591  */
 592 std::string stripLeftMargin(std::string s);
 593
 594 /**
 595  * Fast, in-place lowercasing of ASCII alphabetic characters in strings.
 596  * Leaves all other characters unchanged, including those with the 0x80
 597  * bit set.
 598  * @param str String to convert
 599  * @param len Length of str, in bytes
 600  */
 601 void toLowerAscii(char* str, size_t length);
 602
 603 inline void toLowerAscii(MutableStringPiece str) {
 604   toLowerAscii(str.begin(), str.size());
 605 }
 606
 607 template <class Iterator = const char*,
 608           class Base = folly::Range<boost::u8_to_u32_iterator<Iterator>>>
 609 class UTF8Range : public Base {
 610  public:
 611   /* implicit */ UTF8Range(const folly::Range<Iterator> baseRange)
 612       : Base(boost::u8_to_u32_iterator<Iterator>(
 613                  baseRange.begin(), baseRange.begin(), baseRange.end()),
 614              boost::u8_to_u32_iterator<Iterator>(
 615                  baseRange.end(), baseRange.begin(), baseRange.end())) {}
 616 };
 617
 618 using UTF8StringPiece = UTF8Range<const char*>;
 619
 620 } // namespace folly
 621
 622 // Hook into boost's type traits
 623 namespace boost {
 624 template <class T>
 625 struct has_nothrow_constructor<folly::basic_fbstring<T> > : true_type {
 626   enum { value = true };
 627 };
 628 } // namespace boost
 629
 630 #include <folly/String-inl.h>
 631
 632 #endif