folly/dynamic.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 /**
  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"] = dynamic::array("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", dynamic::array("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 #pragma once
  64
  65 #include <cstdint>
  66 #include <initializer_list>
  67 #include <memory>
  68 #include <ostream>
  69 #include <string>
  70 #include <type_traits>
  71 #include <unordered_map>
  72 #include <utility>
  73 #include <vector>
  74
  75 #include <boost/operators.hpp>
  76
  77 #include <folly/Range.h>
  78 #include <folly/Traits.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   typedef dynamic value_type;
 114   struct const_key_iterator;
 115   struct const_value_iterator;
 116   struct const_item_iterator;
 117
 118   /*
 119    * Creation routines for making dynamic objects and arrays.  Objects
 120    * are maps from key to value (so named due to json-related origins
 121    * here).
 122    *
 123    * Example:
 124    *
 125    *   // Make a fairly complex dynamic:
 126    *   dynamic d = dynamic::object("key", "value1")
 127    *                              ("key2", dynamic::array("value",
 128    *                                                      "with",
 129    *                                                      4,
 130    *                                                      "words"));
 131    *
 132    *   // Build an object in a few steps:
 133    *   dynamic d = dynamic::object;
 134    *   d["key"] = 12;
 135    *   d["something_else"] = dynamic::array(1, 2, 3, nullptr);
 136    */
 137 private:
 138   struct PrivateTag {};
 139   struct EmptyArrayTag {};
 140   struct ObjectMaker;
 141
 142 public:
 143   static void array(EmptyArrayTag);
 144   template <class... Args>
 145   static dynamic array(Args&& ...args);
 146
 147   static ObjectMaker object();
 148   static ObjectMaker object(dynamic&&, dynamic&&);
 149   static ObjectMaker object(dynamic const&, dynamic&&);
 150   static ObjectMaker object(dynamic&&, dynamic const&);
 151   static ObjectMaker object(dynamic const&, dynamic const&);
 152
 153   /*
 154    * String compatibility constructors.
 155    */
 156   /* implicit */ dynamic(StringPiece val);
 157   /* implicit */ dynamic(char const* val);
 158   /* implicit */ dynamic(std::string const& val);
 159   /* implicit */ dynamic(std::string&& val);
 160
 161   /*
 162    * This is part of the plumbing for array() and object(), above.
 163    * Used to create a new array or object dynamic.
 164    */
 165   /* implicit */ dynamic(void (*)(EmptyArrayTag));
 166   /* implicit */ dynamic(ObjectMaker (*)());
 167   /* implicit */ dynamic(ObjectMaker const&) = delete;
 168   /* implicit */ dynamic(ObjectMaker&&);
 169
 170   /*
 171    * Create a new array from an initializer list.
 172    *
 173    * For example:
 174    *
 175    *   dynamic v = { 1, 2, 3, "foo" };
 176    */
 177   // TODO(ott, 10300209): Remove once all uses have been eradicated.
 178
 179   FOLLY_DEPRECATED(
 180       "Initializer list syntax is deprecated (#10300209). Use dynamic::array.")
 181   /* implicit */ dynamic(std::initializer_list<dynamic> il);
 182   FOLLY_DEPRECATED(
 183       "Initializer list syntax is deprecated (#10300209). Use dynamic::array.")
 184   dynamic& operator=(std::initializer_list<dynamic> il);
 185
 186   /*
 187    * Conversion constructors from most of the other types.
 188    */
 189   template<class T> /* implicit */ dynamic(T t);
 190
 191   /*
 192    * Create a dynamic that is an array of the values from the supplied
 193    * iterator range.
 194    */
 195   template<class Iterator> dynamic(Iterator first, Iterator last);
 196
 197   dynamic(dynamic const&);
 198   dynamic(dynamic&&) noexcept;
 199   ~dynamic() noexcept;
 200
 201   /*
 202    * "Deep" equality comparison.  This will compare all the way down
 203    * an object or array, and is potentially expensive.
 204    */
 205   bool operator==(dynamic const& o) const;
 206
 207   /*
 208    * For all types except object this returns the natural ordering on
 209    * those types.  For objects, we throw TypeError.
 210    */
 211   bool operator<(dynamic const& o) const;
 212
 213   /*
 214    * General operators.
 215    *
 216    * These throw TypeError when used with types or type combinations
 217    * that don't support them.
 218    *
 219    * These functions may also throw if you use 64-bit integers with
 220    * doubles when the integers are too big to fit in a double.
 221    */
 222   dynamic& operator+=(dynamic const&);
 223   dynamic& operator-=(dynamic const&);
 224   dynamic& operator*=(dynamic const&);
 225   dynamic& operator/=(dynamic const&);
 226   dynamic& operator%=(dynamic const&);
 227   dynamic& operator|=(dynamic const&);
 228   dynamic& operator&=(dynamic const&);
 229   dynamic& operator^=(dynamic const&);
 230   dynamic& operator++();
 231   dynamic& operator--();
 232
 233   /*
 234    * Assignment from other dynamics.  Because of the implicit conversion
 235    * to dynamic from its potential types, you can use this to change the
 236    * type pretty intuitively.
 237    *
 238    * Basic guarantee only.
 239    */
 240   dynamic& operator=(dynamic const&);
 241   dynamic& operator=(dynamic&&) noexcept;
 242
 243   /*
 244    * For simple dynamics (not arrays or objects), this prints the
 245    * value to an std::ostream in the expected way.  Respects the
 246    * formatting manipulators that have been sent to the stream
 247    * already.
 248    *
 249    * If the dynamic holds an object or array, this prints them in a
 250    * format very similar to JSON.  (It will in fact actually be JSON
 251    * as long as the dynamic validly represents a JSON object---i.e. it
 252    * can't have non-string keys.)
 253    */
 254   friend std::ostream& operator<<(std::ostream&, dynamic const&);
 255
 256   /*
 257    * Returns true if this dynamic is of the specified type.
 258    */
 259   bool isString() const;
 260   bool isObject() const;
 261   bool isBool() const;
 262   bool isNull() const;
 263   bool isArray() const;
 264   bool isDouble() const;
 265   bool isInt() const;
 266
 267   /*
 268    * Returns: isInt() || isDouble().
 269    */
 270   bool isNumber() const;
 271
 272   /*
 273    * Returns the type of this dynamic.
 274    */
 275   Type type() const;
 276
 277   /*
 278    * Returns the type of this dynamic as a printable string.
 279    */
 280   const char* typeName() const;
 281
 282   /*
 283    * Extract a value while trying to convert to the specified type.
 284    * Throws exceptions if we cannot convert from the real type to the
 285    * requested type.
 286    *
 287    * Note you can only use this to access integral types or strings,
 288    * since arrays and objects are generally best dealt with as a
 289    * dynamic.
 290    */
 291   std::string asString() const;
 292   double   asDouble() const;
 293   int64_t  asInt() const;
 294   bool     asBool() const;
 295
 296   /*
 297    * Extract the value stored in this dynamic without type conversion.
 298    *
 299    * These will throw a TypeError if the dynamic has a different type.
 300    */
 301   const std::string& getString() const&;
 302   double          getDouble() const&;
 303   int64_t         getInt() const&;
 304   bool            getBool() const&;
 305   std::string& getString() &;
 306   double&   getDouble() &;
 307   int64_t&  getInt() &;
 308   bool&     getBool() &;
 309   std::string getString() &&;
 310   double   getDouble() &&;
 311   int64_t  getInt() &&;
 312   bool     getBool() &&;
 313
 314   /*
 315    * It is occasionally useful to access a string's internal pointer
 316    * directly, without the type conversion of `asString()`.
 317    *
 318    * These will throw a TypeError if the dynamic is not a string.
 319    */
 320   const char* data()  const&;
 321   const char* data()  && = delete;
 322   const char* c_str() const&;
 323   const char* c_str() && = delete;
 324   StringPiece stringPiece() const;
 325
 326   /*
 327    * Returns: true if this dynamic is null, an empty array, an empty
 328    * object, or an empty string.
 329    */
 330   bool empty() const;
 331
 332   /*
 333    * If this is an array or an object, returns the number of elements
 334    * contained.  If it is a string, returns the length.  Otherwise
 335    * throws TypeError.
 336    */
 337   std::size_t size() const;
 338
 339   /*
 340    * You can iterate over the values of the array.  Calling these on
 341    * non-arrays will throw a TypeError.
 342    */
 343   const_iterator begin()  const;
 344   const_iterator end()    const;
 345
 346 private:
 347   /*
 348    * Helper object returned by keys(), values(), and items().
 349    */
 350   template <class T> struct IterableProxy;
 351
 352 public:
 353   /*
 354    * You can iterate over the keys, values, or items (std::pair of key and
 355    * value) in an object.  Calling these on non-objects will throw a TypeError.
 356    */
 357   IterableProxy<const_key_iterator> keys() const;
 358   IterableProxy<const_value_iterator> values() const;
 359   IterableProxy<const_item_iterator> items() const;
 360
 361   /*
 362    * AssociativeContainer-style find interface for objects.  Throws if
 363    * this is not an object.
 364    *
 365    * Returns: items().end() if the key is not present, or a
 366    * const_item_iterator pointing to the item.
 367    */
 368   const_item_iterator find(dynamic const&) const;
 369
 370   /*
 371    * If this is an object, returns whether it contains a field with
 372    * the given name.  Otherwise throws TypeError.
 373    */
 374   std::size_t count(dynamic const&) const;
 375
 376   /*
 377    * For objects or arrays, provides access to sub-fields by index or
 378    * field name.
 379    *
 380    * Using these with dynamic objects that are not arrays or objects
 381    * will throw a TypeError.  Using an index that is out of range or
 382    * object-element that's not present throws std::out_of_range.
 383    */
 384   dynamic const& at(dynamic const&) const&;
 385   dynamic&       at(dynamic const&) &;
 386   dynamic        at(dynamic const&) &&;
 387
 388   /*
 389    * Like 'at', above, except it returns either a pointer to the contained
 390    * object or nullptr if it wasn't found. This allows a key to be tested for
 391    * containment and retrieved in one operation. Example:
 392    *
 393    *   if (auto* found = d.get_ptr(key))
 394    *     // use *found;
 395    *
 396    * Using these with dynamic objects that are not arrays or objects
 397    * will throw a TypeError.
 398    */
 399   const dynamic* get_ptr(dynamic const&) const&;
 400   dynamic* get_ptr(dynamic const&) &;
 401   dynamic* get_ptr(dynamic const&) && = delete;
 402
 403   /*
 404    * This works for access to both objects and arrays.
 405    *
 406    * In the case of an array, the index must be an integer, and this will throw
 407    * std::out_of_range if it is less than zero or greater than size().
 408    *
 409    * In the case of an object, the non-const overload inserts a null
 410    * value if the key isn't present.  The const overload will throw
 411    * std::out_of_range if the key is not present.
 412    *
 413    * These functions do not invalidate iterators.
 414    */
 415   dynamic&       operator[](dynamic const&) &;
 416   dynamic const& operator[](dynamic const&) const&;
 417   dynamic        operator[](dynamic const&) &&;
 418
 419   /*
 420    * Only defined for objects, throws TypeError otherwise.
 421    *
 422    * getDefault will return the value associated with the supplied key, the
 423    * supplied default otherwise. setDefault will set the key to the supplied
 424    * default if it is not yet set, otherwise leaving it. setDefault returns
 425    * a reference to the existing value if present, the new value otherwise.
 426    */
 427   dynamic
 428   getDefault(const dynamic& k, const dynamic& v = dynamic::object) const&;
 429   dynamic getDefault(const dynamic& k, dynamic&& v) const&;
 430   dynamic getDefault(const dynamic& k, const dynamic& v = dynamic::object) &&;
 431   dynamic getDefault(const dynamic& k, dynamic&& v) &&;
 432   template<class K, class V = dynamic>
 433   dynamic& setDefault(K&& k, V&& v = dynamic::object);
 434
 435   /*
 436    * Resizes an array so it has at n elements, using the supplied
 437    * default to fill new elements.  Throws TypeError if this dynamic
 438    * is not an array.
 439    *
 440    * May invalidate iterators.
 441    *
 442    * Post: size() == n
 443    */
 444   void resize(std::size_t n, dynamic const& = nullptr);
 445
 446   /*
 447    * Inserts the supplied key-value pair to an object, or throws if
 448    * it's not an object.
 449    *
 450    * Invalidates iterators.
 451    */
 452   template<class K, class V> void insert(K&&, V&& val);
 453
 454   /*
 455    * These functions merge two folly dynamic objects.
 456    * The "update" and "update_missing" functions extend the object by
 457    *  inserting the key/value pairs of mergeObj into the current object.
 458    *  For update, if key is duplicated between the two objects, it
 459    *  will overwrite with the value of the object being inserted (mergeObj).
 460    *  For "update_missing", it will prefer the value in the original object
 461    *
 462    * The "merge" function creates a new object consisting of the key/value
 463    * pairs of both mergeObj1 and mergeObj2
 464    * If the key is duplicated between the two objects,
 465    *  it will prefer value in the second object (mergeObj2)
 466    */
 467   void update(const dynamic& mergeObj);
 468   void update_missing(const dynamic& other);
 469   static dynamic merge(const dynamic& mergeObj1, const dynamic& mergeObj2);
 470
 471   /*
 472    * Erase an element from a dynamic object, by key.
 473    *
 474    * Invalidates iterators to the element being erased.
 475    *
 476    * Returns the number of elements erased (i.e. 1 or 0).
 477    */
 478   std::size_t erase(dynamic const& key);
 479
 480   /*
 481    * Erase an element from a dynamic object or array, using an
 482    * iterator or an iterator range.
 483    *
 484    * In arrays, invalidates iterators to elements after the element
 485    * being erased.  In objects, invalidates iterators to the elements
 486    * being erased.
 487    *
 488    * Returns a new iterator to the first element beyond any elements
 489    * removed, or end() if there are none.  (The iteration order does
 490    * not change.)
 491    */
 492   const_iterator erase(const_iterator it);
 493   const_iterator erase(const_iterator first, const_iterator last);
 494
 495   const_key_iterator erase(const_key_iterator it);
 496   const_key_iterator erase(const_key_iterator first, const_key_iterator last);
 497
 498   const_value_iterator erase(const_value_iterator it);
 499   const_value_iterator erase(const_value_iterator first,
 500                              const_value_iterator last);
 501
 502   const_item_iterator erase(const_item_iterator it);
 503   const_item_iterator erase(const_item_iterator first,
 504                             const_item_iterator last);
 505   /*
 506    * Append elements to an array.  If this is not an array, throws
 507    * TypeError.
 508    *
 509    * Invalidates iterators.
 510    */
 511   void push_back(dynamic const&);
 512   void push_back(dynamic&&);
 513
 514   /*
 515    * Remove an element from the back of an array.  If this is not an array,
 516    * throws TypeError.
 517    *
 518    * Does not invalidate iterators.
 519    */
 520   void pop_back();
 521
 522   /*
 523    * Get a hash code.  This function is called by a std::hash<>
 524    * specialization, also.
 525    *
 526    * Throws TypeError if this is an object, array, or null.
 527    */
 528   std::size_t hash() const;
 529
 530 private:
 531   friend struct TypeError;
 532   struct ObjectImpl;
 533   template<class T> struct TypeInfo;
 534   template<class T> struct CompareOp;
 535   template<class T> struct GetAddrImpl;
 536   template<class T> struct PrintImpl;
 537
 538   dynamic(Array&& array, PrivateTag);
 539
 540   template<class T> T const& get() const;
 541   template<class T> T&       get();
 542   template<class T> T*       get_nothrow() & noexcept;
 543   template<class T> T const* get_nothrow() const& noexcept;
 544   template<class T> T*       get_nothrow() && noexcept = delete;
 545   template<class T> T*       getAddress() noexcept;
 546   template<class T> T const* getAddress() const noexcept;
 547
 548   template<class T> T asImpl() const;
 549
 550   static char const* typeName(Type);
 551   void destroy() noexcept;
 552   void print(std::ostream&) const;
 553   void print_as_pseudo_json(std::ostream&) const; // see json.cpp
 554
 555 private:
 556   Type type_;
 557   union Data {
 558     explicit Data() : nul(nullptr) {}
 559     ~Data() {}
 560
 561     // XXX: gcc does an ICE if we use std::nullptr_t instead of void*
 562     // here.  See http://gcc.gnu.org/bugzilla/show_bug.cgi?id=50361
 563     void* nul;
 564     Array array;
 565     bool boolean;
 566     double doubl;
 567     int64_t integer;
 568     std::string string;
 569
 570     /*
 571      * Objects are placement new'd here.  We have to use a char buffer
 572      * because we don't know the type here (std::unordered_map<> with
 573      * dynamic would be parameterizing a std:: template with an
 574      * incomplete type right now).  (Note that in contrast we know it
 575      * is ok to do this with fbvector because we own it.)
 576      */
 577     std::aligned_storage<
 578       sizeof(std::unordered_map<int,int>),
 579       alignof(std::unordered_map<int,int>)
 580     >::type objectBuffer;
 581   } u_;
 582 };
 583
 584 //////////////////////////////////////////////////////////////////////
 585
 586 }
 587
 588 #include <folly/dynamic-inl.h>