folly/dynamic.h

   1 /*
   2  * Copyright 2013 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 /**
  18  * This is a runtime dynamically typed value.  It holds types from a
  19  * specific predetermined set of types (ints, bools, arrays, etc).  In
  20  * particular, it can be used as a convenient in-memory representation
  21  * for complete json objects.
  22  *
  23  * In general you can try to use these objects as if they were the
  24  * type they represent (although in some cases with a slightly less
  25  * complete interface than the raw type), and it'll just throw a
  26  * TypeError if it is used in an illegal way.
  27  *
  28  * Some examples:
  29  *
  30  *   dynamic twelve = 12;
  31  *   dynamic str = "string";
  32  *   dynamic map = dynamic::object;
  33  *   map[str] = twelve;
  34  *   map[str + "another_str"] = { "array", "of", 4, "elements" };
  35  *   map.insert("null_element", nullptr);
  36  *   ++map[str];
  37  *   assert(map[str] == 13);
  38  *
  39  *   // Building a complex object with a sub array inline:
  40  *   dynamic d = dynamic::object
  41  *     ("key", "value")
  42  *     ("key2", { "a", "array" })
  43  *     ;
  44  *
  45  * Also see folly/json.h for the serialization and deserialization
  46  * functions for JSON.
  47  *
  48  * Note: dynamic is not DefaultConstructible.  Rationale:
  49  *
  50  *   - The intuitive thing to initialize a defaulted dynamic to would
  51  *     be nullptr.
  52  *
  53  *   - However, the expression dynamic d = {} is required to call the
  54  *     default constructor by the standard, which is confusing
  55  *     behavior for dynamic unless the default constructor creates an
  56  *     empty array.
  57  *
  58  * Additional documentation is in folly/docs/Dynamic.md.
  59  *
  60  * @author Jordan DeLong <delong.j@fb.com>
  61  */
  62
  63 #ifndef FOLLY_DYNAMIC_H_
  64 #define FOLLY_DYNAMIC_H_
  65
  66 #include <unordered_map>
  67 #include <memory>
  68 #include <string>
  69 #include <utility>
  70 #include <ostream>
  71 #include <type_traits>
  72 #include <initializer_list>
  73 #include <vector>
  74 #include <cstdint>
  75 #include <boost/operators.hpp>
  76
  77 #include "folly/Traits.h"
  78 #include "folly/FBString.h"
  79
  80 namespace folly {
  81
  82 //////////////////////////////////////////////////////////////////////
  83
  84 struct dynamic;
  85 struct TypeError;
  86
  87 //////////////////////////////////////////////////////////////////////
  88
  89 struct dynamic : private boost::operators<dynamic> {
  90   enum Type {
  91     NULLT,
  92     ARRAY,
  93     BOOL,
  94     DOUBLE,
  95     INT64,
  96     OBJECT,
  97     STRING,
  98   };
  99
 100   /*
 101    * We support direct iteration of arrays, and indirect iteration of objects.
 102    * See begin(), end(), keys(), values(), and items() for more.
 103    *
 104    * Array iterators dereference as the elements in the array.
 105    * Object key iterators dereference as the keys in the object.
 106    * Object value iterators dereference as the values in the object.
 107    * Object item iterators dereference as pairs of (key, value).
 108    */
 109 private:
 110   typedef std::vector<dynamic> Array;
 111 public:
 112   typedef Array::const_iterator const_iterator;
 113   struct const_key_iterator;
 114   struct const_value_iterator;
 115   struct const_item_iterator;
 116
 117   /*
 118    * Creation routines for making dynamic objects.  Objects are maps
 119    * from key to value (so named due to json-related origins here).
 120    *
 121    * Example:
 122    *
 123    *   // Make a fairly complex dynamic:
 124    *   dynamic d = dynamic::object("key", "value1")
 125    *                              ("key2", { "value", "with", 4, "words" });
 126    *
 127    *   // Build an object in a few steps:
 128    *   dynamic d = dynamic::object;
 129    *   d["key"] = 12;
 130    *   d["something_else"] = { 1, 2, 3, nullptr };
 131    */
 132 private:
 133   struct ObjectMaker;
 134
 135 public:
 136   static ObjectMaker object();
 137   static ObjectMaker object(dynamic&&, dynamic&&);
 138   static ObjectMaker object(dynamic const&, dynamic&&);
 139   static ObjectMaker object(dynamic&&, dynamic const&);
 140   static ObjectMaker object(dynamic const&, dynamic const&);
 141
 142   /*
 143    * String compatibility constructors.
 144    */
 145   /* implicit */ dynamic(char const* val);
 146   /* implicit */ dynamic(std::string const& val);
 147
 148   /*
 149    * This is part of the plumbing for object(), above.  Used to create
 150    * a new object dynamic.
 151    */
 152   /* implicit */ dynamic(ObjectMaker (*)());
 153   /* implicit */ dynamic(ObjectMaker const&) = delete;
 154   /* implicit */ dynamic(ObjectMaker&&);
 155
 156   /*
 157    * Create a new array from an initializer list.
 158    *
 159    * For example:
 160    *
 161    *   dynamic v = { 1, 2, 3, "foo" };
 162    */
 163   /* implicit */ dynamic(std::initializer_list<dynamic> il);
 164
 165   /*
 166    * Conversion constructors from most of the other types.
 167    */
 168   template<class T> /* implicit */ dynamic(T t);
 169
 170   /*
 171    * Create a dynamic that is an array of the values from the supplied
 172    * iterator range.
 173    */
 174   template<class Iterator> dynamic(Iterator first, Iterator last);
 175
 176   dynamic(dynamic const&);
 177   dynamic(dynamic&&);
 178   ~dynamic();
 179
 180   /*
 181    * "Deep" equality comparison.  This will compare all the way down
 182    * an object or array, and is potentially expensive.
 183    */
 184   bool operator==(dynamic const& o) const;
 185
 186   /*
 187    * For all types except object this returns the natural ordering on
 188    * those types.  For objects, we throw TypeError.
 189    */
 190   bool operator<(dynamic const& o) const;
 191
 192   /*
 193    * General operators.
 194    *
 195    * These throw TypeError when used with types or type combinations
 196    * that don't support them.
 197    *
 198    * These functions may also throw if you use 64-bit integers with
 199    * doubles when the integers are too big to fit in a double.
 200    */
 201   dynamic& operator+=(dynamic const&);
 202   dynamic& operator-=(dynamic const&);
 203   dynamic& operator*=(dynamic const&);
 204   dynamic& operator/=(dynamic const&);
 205   dynamic& operator%=(dynamic const&);
 206   dynamic& operator|=(dynamic const&);
 207   dynamic& operator&=(dynamic const&);
 208   dynamic& operator^=(dynamic const&);
 209   dynamic& operator++();
 210   dynamic& operator--();
 211
 212   /*
 213    * Assignment from other dynamics.  Because of the implicit conversion
 214    * to dynamic from its potential types, you can use this to change the
 215    * type pretty intuitively.
 216    *
 217    * Basic guarantee only.
 218    */
 219   dynamic& operator=(dynamic const&);
 220   dynamic& operator=(dynamic&&);
 221
 222   /*
 223    * For simple dynamics (not arrays or objects), this prints the
 224    * value to an std::ostream in the expected way.  Respects the
 225    * formatting manipulators that have been sent to the stream
 226    * already.
 227    *
 228    * If the dynamic holds an object or array, this prints them in a
 229    * format very similar to JSON.  (It will in fact actually be JSON
 230    * as long as the dynamic validly represents a JSON object---i.e. it
 231    * can't have non-string keys.)
 232    */
 233   friend std::ostream& operator<<(std::ostream&, dynamic const&);
 234
 235   /*
 236    * Returns true if this dynamic is of the specified type.
 237    */
 238   bool isString() const;
 239   bool isObject() const;
 240   bool isBool() const;
 241   bool isNull() const;
 242   bool isArray() const;
 243   bool isDouble() const;
 244   bool isInt() const;
 245
 246   /*
 247    * Returns: isInt() || isDouble().
 248    */
 249   bool isNumber() const;
 250
 251   /*
 252    * Returns the type of this dynamic.
 253    */
 254   Type type() const;
 255
 256   /*
 257    * Returns the type of this dynamic as a printable string.
 258    */
 259   const char* typeName() const;
 260
 261   /*
 262    * Extract a value while trying to convert to the specified type.
 263    * Throws exceptions if we cannot convert from the real type to the
 264    * requested type.
 265    *
 266    * Note you can only use this to access integral types or strings,
 267    * since arrays and objects are generally best dealt with as a
 268    * dynamic.
 269    */
 270   fbstring asString() const;
 271   double   asDouble() const;
 272   int64_t  asInt() const;
 273   bool     asBool() const;
 274
 275   /*
 276    * It is occasionally useful to access a string's internal pointer
 277    * directly, without the type conversion of `asString()`.
 278    *
 279    * These will throw a TypeError if the dynamic is not a string.
 280    */
 281   const char* data()  const;
 282   const char* c_str() const;
 283
 284   /*
 285    * Returns: true if this dynamic is null, an empty array, an empty
 286    * object, or an empty string.
 287    */
 288   bool empty() const;
 289
 290   /*
 291    * If this is an array or an object, returns the number of elements
 292    * contained.  If it is a string, returns the length.  Otherwise
 293    * throws TypeError.
 294    */
 295   std::size_t size() const;
 296
 297   /*
 298    * You can iterate over the values of the array.  Calling these on
 299    * non-arrays will throw a TypeError.
 300    */
 301   const_iterator begin()  const;
 302   const_iterator end()    const;
 303
 304 private:
 305   /*
 306    * Helper object returned by keys(), values(), and items().
 307    */
 308   template <class T> struct IterableProxy;
 309
 310 public:
 311   /*
 312    * You can iterate over the keys, values, or items (std::pair of key and
 313    * value) in an object.  Calling these on non-objects will throw a TypeError.
 314    */
 315   IterableProxy<const_key_iterator> keys() const;
 316   IterableProxy<const_value_iterator> values() const;
 317   IterableProxy<const_item_iterator> items() const;
 318
 319   /*
 320    * AssociativeContainer-style find interface for objects.  Throws if
 321    * this is not an object.
 322    *
 323    * Returns: items().end() if the key is not present, or a
 324    * const_item_iterator pointing to the item.
 325    */
 326   const_item_iterator find(dynamic const&) const;
 327
 328
 329   /*
 330    * If this is an object, returns whether it contains a field with
 331    * the given name.  Otherwise throws TypeError.
 332    */
 333   std::size_t count(dynamic const&) const;
 334
 335   /*
 336    * For objects or arrays, provides access to sub-fields by index or
 337    * field name.
 338    *
 339    * Using these with dynamic objects that are not arrays or objects
 340    * will throw a TypeError.  Using an index that is out of range or
 341    * object-element that's not present throws std::out_of_range.
 342    */
 343   dynamic const& at(dynamic const&) const;
 344   dynamic&       at(dynamic const&);
 345
 346   /*
 347    * Like 'at', above, except it returns either a pointer to the contained
 348    * object or nullptr if it wasn't found. This allows a key to be tested for
 349    * containment and retrieved in one operation. Example:
 350    *
 351    *   if (auto* found = d.get_ptr(key))
 352    *     // use *found;
 353    *
 354    * Using these with dynamic objects that are not arrays or objects
 355    * will throw a TypeError.
 356    */
 357   const dynamic* get_ptr(dynamic const&) const;
 358   dynamic* get_ptr(dynamic const&);
 359
 360   /*
 361    * This works for access to both objects and arrays.
 362    *
 363    * In the case of an array, the index must be an integer, and this will throw
 364    * std::out_of_range if it is less than zero or greater than size().
 365    *
 366    * In the case of an object, the non-const overload inserts a null
 367    * value if the key isn't present.  The const overload will throw
 368    * std::out_of_range if the key is not present.
 369    *
 370    * These functions do not invalidate iterators.
 371    */
 372   dynamic&       operator[](dynamic const&);
 373   dynamic const& operator[](dynamic const&) const;
 374
 375   /*
 376    * Only defined for objects, throws TypeError otherwise.
 377    *
 378    * getDefault will return the value associated with the supplied key, the
 379    * supplied default otherwise. setDefault will set the key to the supplied
 380    * default if it is not yet set, otherwise leaving it. setDefault returns
 381    * a reference to the existing value if present, the new value otherwise.
 382    */
 383   dynamic
 384   getDefault(const dynamic& k, const dynamic& v = dynamic::object) const;
 385   dynamic&& getDefault(const dynamic& k, dynamic&& v) const;
 386   template<class K, class V = dynamic>
 387   dynamic& setDefault(K&& k, V&& v = dynamic::object);
 388
 389   /*
 390    * Resizes an array so it has at n elements, using the supplied
 391    * default to fill new elements.  Throws TypeError if this dynamic
 392    * is not an array.
 393    *
 394    * May invalidate iterators.
 395    *
 396    * Post: size() == n
 397    */
 398   void resize(std::size_t n, dynamic const& = nullptr);
 399
 400   /*
 401    * Inserts the supplied key-value pair to an object, or throws if
 402    * it's not an object.
 403    *
 404    * Invalidates iterators.
 405    */
 406   template<class K, class V> void insert(K&&, V&& val);
 407
 408   /*
 409    * Erase an element from a dynamic object, by key.
 410    *
 411    * Invalidates iterators to the element being erased.
 412    *
 413    * Returns the number of elements erased (i.e. 1 or 0).
 414    */
 415   std::size_t erase(dynamic const& key);
 416
 417   /*
 418    * Erase an element from a dynamic object or array, using an
 419    * iterator or an iterator range.
 420    *
 421    * In arrays, invalidates iterators to elements after the element
 422    * being erased.  In objects, invalidates iterators to the elements
 423    * being erased.
 424    *
 425    * Returns a new iterator to the first element beyond any elements
 426    * removed, or end() if there are none.  (The iteration order does
 427    * not change.)
 428    */
 429   const_iterator erase(const_iterator it);
 430   const_iterator erase(const_iterator first, const_iterator last);
 431
 432   const_key_iterator erase(const_key_iterator it);
 433   const_key_iterator erase(const_key_iterator first, const_key_iterator last);
 434
 435   const_value_iterator erase(const_value_iterator it);
 436   const_value_iterator erase(const_value_iterator first,
 437                              const_value_iterator last);
 438
 439   const_item_iterator erase(const_item_iterator it);
 440   const_item_iterator erase(const_item_iterator first,
 441                             const_item_iterator last);
 442   /*
 443    * Append elements to an array.  If this is not an array, throws
 444    * TypeError.
 445    *
 446    * Invalidates iterators.
 447    */
 448   void push_back(dynamic const&);
 449   void push_back(dynamic&&);
 450
 451   /*
 452    * Remove an element from the back of an array.  If this is not an array,
 453    * throws TypeError.
 454    *
 455    * Does not invalidate iterators.
 456    */
 457   void pop_back();
 458
 459   /*
 460    * Get a hash code.  This function is called by a std::hash<>
 461    * specialization, also.
 462    *
 463    * Throws TypeError if this is an object, array, or null.
 464    */
 465   std::size_t hash() const;
 466
 467 private:
 468   friend struct TypeError;
 469   struct ObjectImpl;
 470   struct ObjectMaker;
 471   template<class T> struct TypeInfo;
 472   template<class T> struct CompareOp;
 473   template<class T> struct GetAddrImpl;
 474   template<class T> struct PrintImpl;
 475
 476   template<class T> T const& get() const;
 477   template<class T> T&       get();
 478   template<class T> T*       get_nothrow();
 479   template<class T> T const* get_nothrow() const;
 480   template<class T> T*       getAddress();
 481   template<class T> T const* getAddress() const;
 482
 483   template<class T> T asImpl() const;
 484
 485   static char const* typeName(Type);
 486   void destroy();
 487   void print(std::ostream&) const;
 488   void print_as_pseudo_json(std::ostream&) const; // see json.cpp
 489
 490 private:
 491   Type type_;
 492   union Data {
 493     explicit Data() : nul(nullptr) {}
 494     ~Data() {}
 495
 496     // XXX: gcc does an ICE if we use std::nullptr_t instead of void*
 497     // here.  See http://gcc.gnu.org/bugzilla/show_bug.cgi?id=50361
 498     void* nul;
 499     Array array;
 500     bool boolean;
 501     double doubl;
 502     int64_t integer;
 503     fbstring string;
 504
 505     /*
 506      * Objects are placement new'd here.  We have to use a char buffer
 507      * because we don't know the type here (std::unordered_map<> with
 508      * dynamic would be parameterizing a std:: template with an
 509      * incomplete type right now).  (Note that in contrast we know it
 510      * is ok to do this with fbvector because we own it.)
 511      */
 512     typename std::aligned_storage<
 513       sizeof(std::unordered_map<int,int>),
 514       alignof(std::unordered_map<int,int>)
 515     >::type objectBuffer;
 516   } u_;
 517 };
 518
 519 //////////////////////////////////////////////////////////////////////
 520
 521 }
 522
 523 #include "folly/dynamic-inl.h"
 524
 525 #endif