folly/String.h

   1 /*
   2  * Copyright 2012 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 <string>
  21 #include <boost/type_traits.hpp>
  22
  23 #ifdef __GNUC__
  24 # include <ext/hash_set>
  25 # include <ext/hash_map>
  26 #endif
  27
  28 #include "folly/Conv.h"
  29 #include "folly/FBString.h"
  30 #include "folly/FBVector.h"
  31 #include "folly/Range.h"
  32 #include "folly/ScopeGuard.h"
  33
  34 // Compatibility function, to make sure toStdString(s) can be called
  35 // to convert a std::string or fbstring variable s into type std::string
  36 // with very little overhead if s was already std::string
  37 namespace folly {
  38
  39 inline
  40 std::string toStdString(const folly::fbstring& s) {
  41   return std::string(s.data(), s.size());
  42 }
  43
  44 inline
  45 const std::string& toStdString(const std::string& s) {
  46   return s;
  47 }
  48
  49 // If called with a temporary, the compiler will select this overload instead
  50 // of the above, so we don't return a (lvalue) reference to a temporary.
  51 inline
  52 std::string&& toStdString(std::string&& s) {
  53   return std::move(s);
  54 }
  55
  56 /**
  57  * C-Escape a string, making it suitable for representation as a C string
  58  * literal.  Appends the result to the output string.
  59  *
  60  * Backslashes all occurrences of backslash and double-quote:
  61  *   "  ->  \"
  62  *   \  ->  \\
  63  *
  64  * Replaces all non-printable ASCII characters with backslash-octal
  65  * representation:
  66  *   <ASCII 254> -> \376
  67  *
  68  * Note that we use backslash-octal instead of backslash-hex because the octal
  69  * representation is guaranteed to consume no more than 3 characters; "\3760"
  70  * represents two characters, one with value 254, and one with value 48 ('0'),
  71  * whereas "\xfe0" represents only one character (with value 4064, which leads
  72  * to implementation-defined behavior).
  73  */
  74 template <class String>
  75 void cEscape(StringPiece str, String& out);
  76
  77 /**
  78  * Similar to cEscape above, but returns the escaped string.
  79  */
  80 template <class String>
  81 String cEscape(StringPiece str) {
  82   String out;
  83   cEscape(str, out);
  84   return out;
  85 }
  86
  87 /**
  88  * C-Unescape a string; the opposite of cEscape above.  Appends the result
  89  * to the output string.
  90  *
  91  * Recognizes the standard C escape sequences:
  92  *
  93  * \' \" \? \\ \a \b \f \n \r \t \v
  94  * \[0-7]+
  95  * \x[0-9a-fA-F]+
  96  *
  97  * In strict mode (default), throws std::invalid_argument if it encounters
  98  * an unrecognized escape sequence.  In non-strict mode, it leaves
  99  * the escape sequence unchanged.
 100  */
 101 template <class String>
 102 void cUnescape(StringPiece str, String& out, bool strict = true);
 103
 104 /**
 105  * Similar to cUnescape above, but returns the escaped string.
 106  */
 107 template <class String>
 108 String cUnescape(StringPiece str, bool strict = true) {
 109   String out;
 110   cUnescape(str, out, strict);
 111   return out;
 112 }
 113
 114 /**
 115  * stringPrintf is much like printf but deposits its result into a
 116  * string. Two signatures are supported: the first simply returns the
 117  * resulting string, and the second appends the produced characters to
 118  * the specified string and returns a reference to it.
 119  */
 120 std::string stringPrintf(const char* format, ...)
 121   __attribute__ ((format (printf, 1, 2)));
 122
 123 /** Similar to stringPrintf, with different signiture.
 124   */
 125 void stringPrintf(std::string* out, const char* fmt, ...)
 126   __attribute__ ((format (printf, 2, 3)));
 127
 128 std::string& stringAppendf(std::string* output, const char* format, ...)
 129   __attribute__ ((format (printf, 2, 3)));
 130
 131 /*
 132  * A pretty-printer for numbers that appends suffixes of units of the
 133  * given type.  It prints 4 sig-figs of value with the most
 134  * appropriate unit.
 135  *
 136  * If `addSpace' is true, we put a space between the units suffix and
 137  * the value.
 138  *
 139  * Current types are:
 140  *   PRETTY_TIME         - s, ms, us, ns, etc.
 141  *   PRETTY_BYTES        - kb, MB, GB, etc (goes up by 2^10 = 1024 each time)
 142  *   PRETTY_BYTES_METRIC - kb, MB, GB, etc (goes up by 10^3 = 1000 each time)
 143  *   PRETTY_UNITS_METRIC - k, M, G, etc (goes up by 10^3 = 1000 each time)
 144  *   PRETTY_UNITS_BINARY - k, M, G, etc (goes up by 2^10 = 1024 each time)
 145  *
 146  * @author Mark Rabkin <mrabkin@fb.com>
 147  */
 148 enum PrettyType {
 149   PRETTY_TIME,
 150   PRETTY_BYTES,
 151   PRETTY_BYTES_METRIC,
 152   PRETTY_UNITS_METRIC,
 153   PRETTY_UNITS_BINARY,
 154
 155   PRETTY_NUM_TYPES
 156 };
 157
 158 std::string prettyPrint(double val, PrettyType, bool addSpace = true);
 159
 160 /**
 161  * Write a hex dump of size bytes starting at ptr to out.
 162  *
 163  * The hex dump is formatted as follows:
 164  *
 165  * for the string "abcdefghijklmnopqrstuvwxyz\x02"
 166 00000000  61 62 63 64 65 66 67 68  69 6a 6b 6c 6d 6e 6f 70  |abcdefghijklmnop|
 167 00000010  71 72 73 74 75 76 77 78  79 7a 02                 |qrstuvwxyz.     |
 168  *
 169  * that is, we write 16 bytes per line, both as hex bytes and as printable
 170  * characters.  Non-printable characters are replaced with '.'
 171  * Lines are written to out one by one (one StringPiece at a time) without
 172  * delimiters.
 173  */
 174 template <class OutIt>
 175 void hexDump(const void* ptr, size_t size, OutIt out);
 176
 177 /**
 178  * Return the hex dump of size bytes starting at ptr as a string.
 179  */
 180 std::string hexDump(const void* ptr, size_t size);
 181
 182 /**
 183  * Return a fbstring containing the description of the given errno value.
 184  * Takes care not to overwrite the actual system errno, so calling
 185  * errnoStr(errno) is valid.
 186  */
 187 fbstring errnoStr(int err);
 188
 189 /**
 190  * Return the demangled (prettyfied) version of a C++ type.
 191  *
 192  * This function tries to produce a human-readable type, but the type name will
 193  * be returned unchanged in case of error or if demangling isn't supported on
 194  * your system.
 195  *
 196  * Use for debugging -- do not rely on demangle() returning anything useful.
 197  *
 198  * This function may allocate memory (and therefore throw).
 199  */
 200 fbstring demangle(const char* name);
 201 inline fbstring demangle(const std::type_info& type) {
 202   return demangle(type.name());
 203 }
 204
 205 /**
 206  * Debug string for an exception: include type and what().
 207  */
 208 inline fbstring exceptionStr(const std::exception& e) {
 209   return folly::to<fbstring>(demangle(typeid(e)), ": ", e.what());
 210 }
 211
 212 /*
 213  * Split a string into a list of tokens by delimiter.
 214  *
 215  * The split interface here supports different output types, selected
 216  * at compile time: StringPiece, fbstring, or std::string.  If you are
 217  * using a vector to hold the output, it detects the type based on
 218  * what your vector contains.
 219  *
 220  * You can also use splitTo() to write the output to an arbitrary
 221  * OutputIterator (e.g. std::inserter() on a std::set<>), in which
 222  * case you have to tell the function the type.  (Rationale:
 223  * OutputIterators don't have a value_type, so we can't detect the
 224  * type in split without being told.)
 225  *
 226  * Examples:
 227  *
 228  *   std::vector<folly::StringPiece> v;
 229  *   folly::split(":", "asd:bsd", v);
 230  *
 231  *   std::set<StringPiece> s;
 232  *   folly::splitTo<StringPiece>(":", "asd:bsd:asd:csd",
 233  *    std::inserter(s, s.begin()));
 234  *
 235  * Split also takes a flag (ignoreEmpty) that indicates whether
 236  * adjacent tokens should be treated as one separator or not.  Note
 237  * that unlikely strtok() the default is to treat them as separators.
 238  */
 239
 240 template<class Delim, class String, class OutputType>
 241 void split(const Delim& delimiter,
 242            const String& input,
 243            std::vector<OutputType>& out,
 244            bool ignoreEmpty = false);
 245
 246 template<class Delim, class String, class OutputType>
 247 void split(const Delim& delimiter,
 248            const String& input,
 249            folly::fbvector<OutputType>& out,
 250            bool ignoreEmpty = false);
 251
 252 template<class OutputValueType, class Delim, class String,
 253          class OutputIterator>
 254 void splitTo(const Delim& delimiter,
 255              const String& input,
 256              OutputIterator out,
 257              bool ignoreEmpty = false);
 258
 259 } // namespace folly
 260
 261 // Hash functions for string and fbstring usable with e.g. hash_map
 262 #ifdef __GNUC__
 263 namespace __gnu_cxx {
 264
 265 template <class C>
 266 struct hash<folly::basic_fbstring<C> > : private hash<const C*> {
 267   size_t operator()(const folly::basic_fbstring<C> & s) const {
 268     return hash<const C*>::operator()(s.c_str());
 269   }
 270 };
 271
 272 template <class C>
 273 struct hash<std::basic_string<C> > : private hash<const C*> {
 274   size_t operator()(const std::basic_string<C> & s) const {
 275     return hash<const C*>::operator()(s.c_str());
 276   }
 277 };
 278
 279 } // namespace __gnu_cxx
 280 #endif
 281
 282 // Hook into boost's type traits
 283 namespace boost {
 284 template <class T>
 285 struct has_nothrow_constructor<folly::basic_fbstring<T> > : true_type {
 286   enum { value = true };
 287 };
 288 } // namespace boost
 289
 290 #include "folly/String-inl.h"
 291
 292 #endif