CZString

CommentInfo

CommentPlacement

DuplicationPolicy

Kind

Path

PathArgument

StaticString

Value

ValueAllocator

ValueConstIterator

ValueHolder

ValueIterator

ValueIteratorBase

ValueType

Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
#ifndef CPPTL_JSON_H_INCLUDED
#define CPPTL_JSON_H_INCLUDED

#include "forwards.h"
#include <string>
#include <vector>

#ifndef JSON_USE_CPPTL_SMALLMAP
#include <map>
#else
#include <cpptl/smallmap.h>
#endif
#ifdef JSON_USE_CPPTL
#include <cpptl/forwards.h>
#endif

/** \brief JSON (JavaScript Object Notation).
 */

namespace jsoncollector {
  namespace Json {

    /** \brief Type of the value held by a Value object.
    */
    enum ValueType {
      nullValue = 0,  ///< 'null' value
      intValue,       ///< signed integer value
      uintValue,      ///< unsigned integer value
      realValue,      ///< double value
      stringValue,    ///< UTF-8 string value
      booleanValue,   ///< bool value
      arrayValue,     ///< array value (ordered list)
      objectValue     ///< object value (collection of name/value pairs).
    };

    enum CommentPlacement {
      commentBefore = 0,       ///< a comment placed on the line before a value
      commentAfterOnSameLine,  ///< a comment just after a value on the same line
      commentAfter,            ///< a comment on the line after a value (only make sense for root value)
      numberOfCommentPlacement
    };

    //# ifdef JSON_USE_CPPTL
    //   typedef CppTL::AnyEnumerator<const char *> EnumMemberNames;
    //   typedef CppTL::AnyEnumerator<const Value &> EnumValues;
    //# endif

    /** \brief Lightweight wrapper to tag static string.
    *
    * Value constructor and objectValue member assignement takes advantage of the
    * StaticString and avoid the cost of string duplication when storing the
    * string or the member name.
    *
    * Example of usage:
    * \code
    * Json::Value aValue( StaticString("some text") );
    * Json::Value object;
    * static const StaticString code("code");
    * object[code] = 1234;
    * \endcode
    */
    class JSON_API StaticString {
    public:
      explicit StaticString(const char *czstring) : str_(czstring) {}

      operator const char *() const { return str_; }

      const char *c_str() const { return str_; }

    private:
      const char *str_;
    };

    /** \brief Represents a <a HREF="http://www.json.org">JSON</a> value.
    *
    * This class is a discriminated union wrapper that can represents a:
    * - signed integer [range: Value::minInt - Value::maxInt]
    * - unsigned integer (range: 0 - Value::maxUInt)
    * - double
    * - UTF-8 string
    * - boolean
    * - 'null'
    * - an ordered list of Value
    * - collection of name/value pairs (javascript object)
    *
    * The type of the held value is represented by a #ValueType and 
    * can be obtained using type().
    *
    * values of an #objectValue or #arrayValue can be accessed using operator[]() methods. 
    * Non const methods will automatically create the a #nullValue element 
    * if it does not exist. 
    * The sequence of an #arrayValue will be automatically resize and initialized 
    * with #nullValue. resize() can be used to enlarge or truncate an #arrayValue.
    *
    * The get() methods can be used to obtanis default value in the case the required element
    * does not exist.
    *
    * It is possible to iterate over the list of a #objectValue values using 
    * the getMemberNames() method.
    */
    class JSON_API Value {
      friend class ValueIteratorBase;
#ifdef JSON_VALUE_USE_INTERNAL_MAP
      friend class ValueInternalLink;
      friend class ValueInternalMap;
#endif
    public:
      typedef std::vector<std::string> Members;
      typedef ValueIterator iterator;
      typedef ValueConstIterator const_iterator;
      typedef Json::UInt UInt;
      typedef Json::Int Int;
      typedef UInt ArrayIndex;

      static const Value null;
      static const Int minInt;
      static const Int maxInt;
      static const UInt maxUInt;

    private:
#ifndef JSONCPP_DOC_EXCLUDE_IMPLEMENTATION
#ifndef JSON_VALUE_USE_INTERNAL_MAP
      class CZString {
      public:
        enum DuplicationPolicy { noDuplication = 0, duplicate, duplicateOnCopy };
        CZString(int index);
        CZString(const char *cstr, DuplicationPolicy allocate);
        CZString(const CZString &other);
        ~CZString();
        CZString &operator=(const CZString &other);
        bool operator<(const CZString &other) const;
        bool operator==(const CZString &other) const;
        int index() const;
        const char *c_str() const;
        bool isStaticString() const;

      private:
        void swap(CZString &other);
        const char *cstr_;
        int index_;
      };

    public:
#ifndef JSON_USE_CPPTL_SMALLMAP
      typedef std::map<CZString, Value> ObjectValues;
#else
      typedef CppTL::SmallMap<CZString, Value> ObjectValues;
#endif  // ifndef JSON_USE_CPPTL_SMALLMAP
#endif  // ifndef JSON_VALUE_USE_INTERNAL_MAP
#endif  // ifndef JSONCPP_DOC_EXCLUDE_IMPLEMENTATION

    public:
      /** \brief Create a default Value of the given type.

        This is a very useful constructor.
        To create an empty array, pass arrayValue.
        To create an empty object, pass objectValue.
        Another Value can then be set to this one by assignment.
	This is useful since clear() and resize() will not alter types.

        Examples:
	\code
	Json::Value null_value; // null
	Json::Value arr_value(Json::arrayValue); // []
	Json::Value obj_value(Json::objectValue); // {}
	\endcode
      */
      Value(ValueType type = nullValue);
      Value(Int value);
      Value(UInt value);
      Value(double value);
      Value(const char *value);
      Value(const char *beginValue, const char *endValue);
      /** \brief Constructs a value from a static string.

       * Like other value string constructor but do not duplicate the string for
       * internal storage. The given string must remain alive after the call to this
       * constructor.
       * Example of usage:
       * \code
       * Json::Value aValue( StaticString("some text") );
       * \endcode
       */
      Value(const StaticString &value);
      Value(const std::string &value);
#ifdef JSON_USE_CPPTL
      Value(const CppTL::ConstString &value);
#endif
      Value(bool value);
      Value(const Value &other);
      ~Value();

      Value &operator=(const Value &other);
      /// Swap values.
      /// \note Currently, comments are intentionally not swapped, for
      /// both logic and efficiency.
      void swap(Value &other);

      ValueType type() const;

      bool operator<(const Value &other) const;
      bool operator<=(const Value &other) const;
      bool operator>=(const Value &other) const;
      bool operator>(const Value &other) const;

      bool operator==(const Value &other) const;
      bool operator!=(const Value &other) const;

      int compare(const Value &other);

      const char *asCString() const;
      std::string asString() const;
#ifdef JSON_USE_CPPTL
      CppTL::ConstString asConstString() const;
#endif
      Int asInt() const;
      UInt asUInt() const;
      double asDouble() const;
      bool asBool() const;

      bool isNull() const;
      bool isBool() const;
      bool isInt() const;
      bool isUInt() const;
      bool isIntegral() const;
      bool isDouble() const;
      bool isNumeric() const;
      bool isString() const;
      bool isArray() const;
      bool isObject() const;

      bool isConvertibleTo(ValueType other) const;

      /// Number of values in array or object
      UInt size() const;

      /// \brief Return true if empty array, empty object, or null;
      /// otherwise, false.
      bool empty() const;

      /// Return isNull()
      bool operator!() const;

      /// Remove all object members and array elements.
      /// \pre type() is arrayValue, objectValue, or nullValue
      /// \post type() is unchanged
      void clear();

      /// Resize the array to size elements.
      /// New elements are initialized to null.
      /// May only be called on nullValue or arrayValue.
      /// \pre type() is arrayValue or nullValue
      /// \post type() is arrayValue
      void resize(UInt size);

      /// Access an array element (zero based index ).
      /// If the array contains less than index element, then null value are inserted
      /// in the array so that its size is index+1.
      /// (You may need to say 'value[0u]' to get your compiler to distinguish
      ///  this from the operator[] which takes a string.)
      Value &operator[](UInt index);
      /// Access an array element (zero based index )
      /// (You may need to say 'value[0u]' to get your compiler to distinguish
      ///  this from the operator[] which takes a string.)
      const Value &operator[](UInt index) const;
      /// If the array contains at least index+1 elements, returns the element value,
      /// otherwise returns defaultValue.
      Value get(UInt index, const Value &defaultValue) const;
      /// Return true if index < size().
      bool isValidIndex(UInt index) const;
      /// \brief Append value to array at the end.
      ///
      /// Equivalent to jsonvalue[jsonvalue.size()] = value;
      Value &append(const Value &value);

      /// Access an object value by name, create a null member if it does not exist.
      Value &operator[](const char *key);
      /// Access an object value by name, returns null if there is no member with that name.
      const Value &operator[](const char *key) const;
      /// Access an object value by name, create a null member if it does not exist.
      Value &operator[](const std::string &key);
      /// Access an object value by name, returns null if there is no member with that name.
      const Value &operator[](const std::string &key) const;
      /** \brief Access an object value by name, create a null member if it does not exist.

       * If the object as no entry for that name, then the member name used to store
       * the new entry is not duplicated.
       * Example of use:
       * \code
       * Json::Value object;
       * static const StaticString code("code");
       * object[code] = 1234;
       * \endcode
       */
      Value &operator[](const StaticString &key);
#ifdef JSON_USE_CPPTL
      /// Access an object value by name, create a null member if it does not exist.
      Value &operator[](const CppTL::ConstString &key);
      /// Access an object value by name, returns null if there is no member with that name.
      const Value &operator[](const CppTL::ConstString &key) const;
#endif
      /// Return the member named key if it exist, defaultValue otherwise.
      Value get(const char *key, const Value &defaultValue) const;
      /// Return the member named key if it exist, defaultValue otherwise.
      Value get(const std::string &key, const Value &defaultValue) const;
#ifdef JSON_USE_CPPTL
      /// Return the member named key if it exist, defaultValue otherwise.
      Value get(const CppTL::ConstString &key, const Value &defaultValue) const;
#endif
      /// \brief Remove and return the named member.
      ///
      /// Do nothing if it did not exist.
      /// \return the removed Value, or null.
      /// \pre type() is objectValue or nullValue
      /// \post type() is unchanged
      Value removeMember(const char *key);
      /// Same as removeMember(const char*)
      Value removeMember(const std::string &key);

      /// Return true if the object has a member named key.
      bool isMember(const char *key) const;
      /// Return true if the object has a member named key.
      bool isMember(const std::string &key) const;
#ifdef JSON_USE_CPPTL
      /// Return true if the object has a member named key.
      bool isMember(const CppTL::ConstString &key) const;
#endif

      /// \brief Return a list of the member names.
      ///
      /// If null, return an empty list.
      /// \pre type() is objectValue or nullValue
      /// \post if type() was nullValue, it remains nullValue
      Members getMemberNames() const;

      //# ifdef JSON_USE_CPPTL
      //      EnumMemberNames enumMemberNames() const;
      //      EnumValues enumValues() const;
      //# endif

      /// Comments must be //... or /* ... */
      void setComment(const char *comment, CommentPlacement placement);
      /// Comments must be //... or /* ... */
      void setComment(const std::string &comment, CommentPlacement placement);
      bool hasComment(CommentPlacement placement) const;
      /// Include delimiters and embedded newlines.
      std::string getComment(CommentPlacement placement) const;

      std::string toStyledString() const;

      const_iterator begin() const;
      const_iterator end() const;

      iterator begin();
      iterator end();

    private:
      Value &resolveReference(const char *key, bool isStatic);

#ifdef JSON_VALUE_USE_INTERNAL_MAP
      inline bool isItemAvailable() const { return itemIsUsed_ == 0; }

      inline void setItemUsed(bool isUsed = true) { itemIsUsed_ = isUsed ? 1 : 0; }

      inline bool isMemberNameStatic() const { return memberNameIsStatic_ == 0; }

      inline void setMemberNameIsStatic(bool isStatic) { memberNameIsStatic_ = isStatic ? 1 : 0; }
#endif  // # ifdef JSON_VALUE_USE_INTERNAL_MAP

    private:
      struct CommentInfo {
        CommentInfo();
        ~CommentInfo();

        void setComment(const char *text);

        char *comment_;
      };

      //struct MemberNamesTransform
      //{
      //   typedef const char *result_type;
      //   const char *operator()( const CZString &name ) const
      //   {
      //      return name.c_str();
      //   }
      //};

      union ValueHolder {
        Int int_;
        UInt uint_;
        double real_;
        bool bool_;
        char *string_;
#ifdef JSON_VALUE_USE_INTERNAL_MAP
        ValueInternalArray *array_;
        ValueInternalMap *map_;
#else
        ObjectValues *map_;
#endif
      } value_;
      ValueType type_ : 8;
      int allocated_ : 1;  // Notes: if declared as bool, bitfield is useless.
#ifdef JSON_VALUE_USE_INTERNAL_MAP
      unsigned int itemIsUsed_ : 1;  // used by the ValueInternalMap container.
      int memberNameIsStatic_ : 1;   // used by the ValueInternalMap container.
#endif
      CommentInfo *comments_;
    };

    /** \brief Experimental and untested: represents an element of the "path" to access a node.
    */
    class PathArgument {
    public:
      friend class Path;

      PathArgument();
      PathArgument(UInt index);
      PathArgument(const char *key);
      PathArgument(const std::string &key);

    private:
      enum Kind { kindNone = 0, kindIndex, kindKey };
      std::string key_;
      UInt index_;
      Kind kind_;
    };

    /** \brief Experimental and untested: represents a "path" to access a node.
    *
    * Syntax:
    * - "." => root node
    * - ".[n]" => elements at index 'n' of root node (an array value)
    * - ".name" => member named 'name' of root node (an object value)
    * - ".name1.name2.name3"
    * - ".[0][1][2].name1[3]"
    * - ".%" => member name is provided as parameter
    * - ".[%]" => index is provied as parameter
    */
    class Path {
    public:
      Path(const std::string &path,
           const PathArgument &a1 = PathArgument(),
           const PathArgument &a2 = PathArgument(),
           const PathArgument &a3 = PathArgument(),
           const PathArgument &a4 = PathArgument(),
           const PathArgument &a5 = PathArgument());

      const Value &resolve(const Value &root) const;
      Value resolve(const Value &root, const Value &defaultValue) const;
      /// Creates the "path" to access the specified node and returns a reference on the node.
      Value &make(Value &root) const;

    private:
      typedef std::vector<const PathArgument *> InArgs;
      typedef std::vector<PathArgument> Args;

      void makePath(const std::string &path, const InArgs &in);
      void addPathInArg(const std::string &path,
                        const InArgs &in,
                        InArgs::const_iterator &itInArg,
                        PathArgument::Kind kind);
      void invalidPath(const std::string &path, int location);

      Args args_;
    };

    /** \brief Experimental do not use: Allocator to customize member name and string value memory management done by Value.
    *
    * - makeMemberName() and releaseMemberName() are called to respectively duplicate and
    *   free an Json::objectValue member name.
    * - duplicateStringValue() and releaseStringValue() are called similarly to
    *   duplicate and free a Json::stringValue value.
    */
    class ValueAllocator {
    public:
      enum { unknown = (unsigned)-1 };

      virtual ~ValueAllocator();

      virtual char *makeMemberName(const char *memberName) const = 0;
      virtual void releaseMemberName(char *memberName) const = 0;
      virtual char *duplicateStringValue(const char *value, unsigned int length = unknown) const = 0;
      virtual void releaseStringValue(char *value) const = 0;
    };

#ifdef JSON_VALUE_USE_INTERNAL_MAP
    /** \brief Allocator to customize Value internal map.
    * Below is an example of a simple implementation (default implementation actually
    * use memory pool for speed).
    * \code
      class DefaultValueMapAllocator : public ValueMapAllocator
      {
      public: // overridden from ValueMapAllocator
         virtual ValueInternalMap *newMap()
         {
            return new ValueInternalMap();
         }

         virtual ValueInternalMap *newMapCopy( const ValueInternalMap &other )
         {
            return new ValueInternalMap( other );
         }

         virtual void destructMap( ValueInternalMap *map )
         {
            delete map;
         }

         virtual ValueInternalLink *allocateMapBuckets( unsigned int size )
         {
            return new ValueInternalLink[size];
         }

         virtual void releaseMapBuckets( ValueInternalLink *links )
         {
            delete [] links;
         }

         virtual ValueInternalLink *allocateMapLink()
         {
            return new ValueInternalLink();
         }

         virtual void releaseMapLink( ValueInternalLink *link )
         {
            delete link;
         }
      };
    * \endcode
    */
    class JSON_API ValueMapAllocator {
    public:
      virtual ~ValueMapAllocator();
      virtual ValueInternalMap *newMap() = 0;
      virtual ValueInternalMap *newMapCopy(const ValueInternalMap &other) = 0;
      virtual void destructMap(ValueInternalMap *map) = 0;
      virtual ValueInternalLink *allocateMapBuckets(unsigned int size) = 0;
      virtual void releaseMapBuckets(ValueInternalLink *links) = 0;
      virtual ValueInternalLink *allocateMapLink() = 0;
      virtual void releaseMapLink(ValueInternalLink *link) = 0;
    };

    /** \brief ValueInternalMap hash-map bucket chain link (for internal use only).
    * \internal previous_ & next_ allows for bidirectional traversal.
    */
    class JSON_API ValueInternalLink {
    public:
      enum { itemPerLink = 6 };  // sizeof(ValueInternalLink) = 128 on 32 bits architecture.
      enum InternalFlags { flagAvailable = 0, flagUsed = 1 };

      ValueInternalLink();

      ~ValueInternalLink();

      Value items_[itemPerLink];
      char *keys_[itemPerLink];
      ValueInternalLink *previous_;
      ValueInternalLink *next_;
    };

    /** \brief A linked page based hash-table implementation used internally by Value.
    * \internal ValueInternalMap is a tradional bucket based hash-table, with a linked
    * list in each bucket to handle collision. There is an addional twist in that
    * each node of the collision linked list is a page containing a fixed amount of
    * value. This provides a better compromise between memory usage and speed.
    * 
    * Each bucket is made up of a chained list of ValueInternalLink. The last
    * link of a given bucket can be found in the 'previous_' field of the following bucket.
    * The last link of the last bucket is stored in tailLink_ as it has no following bucket.
    * Only the last link of a bucket may contains 'available' item. The last link always
    * contains at least one element unless is it the bucket one very first link.
    */
    class JSON_API ValueInternalMap {
      friend class ValueIteratorBase;
      friend class Value;

    public:
      typedef unsigned int HashKey;
      typedef unsigned int BucketIndex;

#ifndef JSONCPP_DOC_EXCLUDE_IMPLEMENTATION
      struct IteratorState {
        IteratorState() : map_(0), link_(0), itemIndex_(0), bucketIndex_(0) {}
        ValueInternalMap *map_;
        ValueInternalLink *link_;
        BucketIndex itemIndex_;
        BucketIndex bucketIndex_;
      };
#endif  // ifndef JSONCPP_DOC_EXCLUDE_IMPLEMENTATION

      ValueInternalMap();
      ValueInternalMap(const ValueInternalMap &other);
      ValueInternalMap &operator=(const ValueInternalMap &other);
      ~ValueInternalMap();

      void swap(ValueInternalMap &other);

      BucketIndex size() const;

      void clear();

      bool reserveDelta(BucketIndex growth);

      bool reserve(BucketIndex newItemCount);

      const Value *find(const char *key) const;

      Value *find(const char *key);

      Value &resolveReference(const char *key, bool isStatic);

      void remove(const char *key);

      void doActualRemove(ValueInternalLink *link, BucketIndex index, BucketIndex bucketIndex);

      ValueInternalLink *&getLastLinkInBucket(BucketIndex bucketIndex);

      Value &setNewItem(const char *key, bool isStatic, ValueInternalLink *link, BucketIndex index);

      Value &unsafeAdd(const char *key, bool isStatic, HashKey hashedKey);

      HashKey hash(const char *key) const;

      int compare(const ValueInternalMap &other) const;

    private:
      void makeBeginIterator(IteratorState &it) const;
      void makeEndIterator(IteratorState &it) const;
      static bool equals(const IteratorState &x, const IteratorState &other);
      static void increment(IteratorState &iterator);
      static void incrementBucket(IteratorState &iterator);
      static void decrement(IteratorState &iterator);
      static const char *key(const IteratorState &iterator);
      static const char *key(const IteratorState &iterator, bool &isStatic);
      static Value &value(const IteratorState &iterator);
      static int distance(const IteratorState &x, const IteratorState &y);

    private:
      ValueInternalLink *buckets_;
      ValueInternalLink *tailLink_;
      BucketIndex bucketsSize_;
      BucketIndex itemCount_;
    };

    /** \brief A simplified deque implementation used internally by Value.
   * \internal
   * It is based on a list of fixed "page", each page contains a fixed number of items.
   * Instead of using a linked-list, a array of pointer is used for fast item look-up.
   * Look-up for an element is as follow:
   * - compute page index: pageIndex = itemIndex / itemsPerPage
   * - look-up item in page: pages_[pageIndex][itemIndex % itemsPerPage]
   *
   * Insertion is amortized constant time (only the array containing the index of pointers
   * need to be reallocated when items are appended).
   */
    class JSON_API ValueInternalArray {
      friend class Value;
      friend class ValueIteratorBase;

    public:
      enum { itemsPerPage = 8 };  // should be a power of 2 for fast divide and modulo.
      typedef Value::ArrayIndex ArrayIndex;
      typedef unsigned int PageIndex;

#ifndef JSONCPP_DOC_EXCLUDE_IMPLEMENTATION
      struct IteratorState  // Must be a POD
      {
        IteratorState() : array_(0), currentPageIndex_(0), currentItemIndex_(0) {}
        ValueInternalArray *array_;
        Value **currentPageIndex_;
        unsigned int currentItemIndex_;
      };
#endif  // ifndef JSONCPP_DOC_EXCLUDE_IMPLEMENTATION

      ValueInternalArray();
      ValueInternalArray(const ValueInternalArray &other);
      ValueInternalArray &operator=(const ValueInternalArray &other);
      ~ValueInternalArray();
      void swap(ValueInternalArray &other);

      void clear();
      void resize(ArrayIndex newSize);

      Value &resolveReference(ArrayIndex index);

      Value *find(ArrayIndex index) const;

      ArrayIndex size() const;

      int compare(const ValueInternalArray &other) const;

    private:
      static bool equals(const IteratorState &x, const IteratorState &other);
      static void increment(IteratorState &iterator);
      static void decrement(IteratorState &iterator);
      static Value &dereference(const IteratorState &iterator);
      static Value &unsafeDereference(const IteratorState &iterator);
      static int distance(const IteratorState &x, const IteratorState &y);
      static ArrayIndex indexOf(const IteratorState &iterator);
      void makeBeginIterator(IteratorState &it) const;
      void makeEndIterator(IteratorState &it) const;
      void makeIterator(IteratorState &it, ArrayIndex index) const;

      void makeIndexValid(ArrayIndex index);

      Value **pages_;
      ArrayIndex size_;
      PageIndex pageCount_;
    };

    /** \brief Experimental: do not use. Allocator to customize Value internal array.
    * Below is an example of a simple implementation (actual implementation use
    * memory pool).
      \code
class DefaultValueArrayAllocator : public ValueArrayAllocator
{
public: // overridden from ValueArrayAllocator
   virtual ~DefaultValueArrayAllocator()
   {
   }

   virtual ValueInternalArray *newArray()
   {
      return new ValueInternalArray();
   }

   virtual ValueInternalArray *newArrayCopy( const ValueInternalArray &other )
   {
      return new ValueInternalArray( other );
   }

   virtual void destruct( ValueInternalArray *array )
   {
      delete array;
   }

   virtual void reallocateArrayPageIndex( Value **&indexes, 
                                          ValueInternalArray::PageIndex &indexCount,
                                          ValueInternalArray::PageIndex minNewIndexCount )
   {
      ValueInternalArray::PageIndex newIndexCount = (indexCount*3)/2 + 1;
      if ( minNewIndexCount > newIndexCount )
         newIndexCount = minNewIndexCount;
      void *newIndexes = realloc( indexes, sizeof(Value*) * newIndexCount );
      if ( !newIndexes )
         throw std::bad_alloc();
      indexCount = newIndexCount;
      indexes = static_cast<Value **>( newIndexes );
   }
   virtual void releaseArrayPageIndex( Value **indexes, 
                                       ValueInternalArray::PageIndex indexCount )
   {
      if ( indexes )
         free( indexes );
   }

   virtual Value *allocateArrayPage()
   {
      return static_cast<Value *>( malloc( sizeof(Value) * ValueInternalArray::itemsPerPage ) );
   }

   virtual void releaseArrayPage( Value *value )
   {
      if ( value )
         free( value );
   }
};
      \endcode
    */
    class JSON_API ValueArrayAllocator {
    public:
      virtual ~ValueArrayAllocator();
      virtual ValueInternalArray *newArray() = 0;
      virtual ValueInternalArray *newArrayCopy(const ValueInternalArray &other) = 0;
      virtual void destructArray(ValueInternalArray *array) = 0;
      /** \brief Reallocate array page index.
       * Reallocates an array of pointer on each page.
       * \param indexes [input] pointer on the current index. May be \c NULL.
       *                [output] pointer on the new index of at least 
       *                         \a minNewIndexCount pages. 
       * \param indexCount [input] current number of pages in the index.
       *                   [output] number of page the reallocated index can handle.
       *                            \b MUST be >= \a minNewIndexCount.
       * \param minNewIndexCount Minimum number of page the new index must be able to
       *                         handle.
       */
      virtual void reallocateArrayPageIndex(Value **&indexes,
                                            ValueInternalArray::PageIndex &indexCount,
                                            ValueInternalArray::PageIndex minNewIndexCount) = 0;
      virtual void releaseArrayPageIndex(Value **indexes, ValueInternalArray::PageIndex indexCount) = 0;
      virtual Value *allocateArrayPage() = 0;
      virtual void releaseArrayPage(Value *value) = 0;
    };
#endif  // #ifdef JSON_VALUE_USE_INTERNAL_MAP

    /** \brief base class for Value iterators.
    *
    */
    class ValueIteratorBase {
    public:
      typedef unsigned int size_t;
      typedef int difference_type;
      typedef ValueIteratorBase SelfType;

      ValueIteratorBase();
#ifndef JSON_VALUE_USE_INTERNAL_MAP
      explicit ValueIteratorBase(const Value::ObjectValues::iterator &current);
#else
      ValueIteratorBase(const ValueInternalArray::IteratorState &state);
      ValueIteratorBase(const ValueInternalMap::IteratorState &state);
#endif

      bool operator==(const SelfType &other) const { return isEqual(other); }

      bool operator!=(const SelfType &other) const { return !isEqual(other); }

      difference_type operator-(const SelfType &other) const { return computeDistance(other); }

      /// Return either the index or the member name of the referenced value as a Value.
      Value key() const;

      /// Return the index of the referenced Value. -1 if it is not an arrayValue.
      UInt index() const;

      /// Return the member name of the referenced Value. "" if it is not an objectValue.
      const char *memberName() const;

    protected:
      Value &deref() const;

      void increment();

      void decrement();

      difference_type computeDistance(const SelfType &other) const;

      bool isEqual(const SelfType &other) const;

      void copy(const SelfType &other);

    private:
#ifndef JSON_VALUE_USE_INTERNAL_MAP
      Value::ObjectValues::iterator current_;
      // Indicates that iterator is for a null value.
      bool isNull_;
#else
      union {
        ValueInternalArray::IteratorState array_;
        ValueInternalMap::IteratorState map_;
      } iterator_;
      bool isArray_;
#endif
    };

    /** \brief const iterator for object and array value.
    *
    */
    class ValueConstIterator : public ValueIteratorBase {
      friend class Value;

    public:
      typedef unsigned int size_t;
      typedef int difference_type;
      typedef const Value &reference;
      typedef const Value *pointer;
      typedef ValueConstIterator SelfType;

      ValueConstIterator();

    private:
      /*! \internal Use by Value to create an iterator.
       */
#ifndef JSON_VALUE_USE_INTERNAL_MAP
      explicit ValueConstIterator(const Value::ObjectValues::iterator &current);
#else
      ValueConstIterator(const ValueInternalArray::IteratorState &state);
      ValueConstIterator(const ValueInternalMap::IteratorState &state);
#endif
    public:
      SelfType &operator=(const ValueIteratorBase &other);

      SelfType operator++(int) {
        SelfType temp(*this);
        ++*this;
        return temp;
      }

      SelfType operator--(int) {
        SelfType temp(*this);
        --*this;
        return temp;
      }

      SelfType &operator--() {
        decrement();
        return *this;
      }

      SelfType &operator++() {
        increment();
        return *this;
      }

      reference operator*() const { return deref(); }
    };

    /** \brief Iterator for object and array value.
    */
    class ValueIterator : public ValueIteratorBase {
      friend class Value;

    public:
      typedef unsigned int size_t;
      typedef int difference_type;
      typedef Value &reference;
      typedef Value *pointer;
      typedef ValueIterator SelfType;

      ValueIterator();
      ValueIterator(const ValueConstIterator &other);
      ValueIterator(const ValueIterator &other);

    private:
      /*! \internal Use by Value to create an iterator.
       */
#ifndef JSON_VALUE_USE_INTERNAL_MAP
      explicit ValueIterator(const Value::ObjectValues::iterator &current);
#else
      ValueIterator(const ValueInternalArray::IteratorState &state);
      ValueIterator(const ValueInternalMap::IteratorState &state);
#endif
    public:
      SelfType &operator=(const SelfType &other);

      SelfType operator++(int) {
        SelfType temp(*this);
        ++*this;
        return temp;
      }

      SelfType operator--(int) {
        SelfType temp(*this);
        --*this;
        return temp;
      }

      SelfType &operator--() {
        decrement();
        return *this;
      }

      SelfType &operator++() {
        increment();
        return *this;
      }

      reference operator*() const { return deref(); }
    };

  }  // namespace Json
}  // namespace jsoncollector
#endif  // CPPTL_JSON_H_INCLUDED