include/cinder/Json.h

Go to the documentation of this file.

/*
 Copyright (c) 2012, The Cinder Project
 All rights reserved.
 
 This code is designed for use with the Cinder C++ library, http://libcinder.org

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and
    the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
    the following disclaimer in the documentation and/or other materials provided with the distribution.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once

#include "cinder/DataSource.h"
#include "cinder/DataTarget.h"
#include "cinder/Exception.h"
#include "cinder/Utilities.h"

#include <string>
#include <boost/container/list.hpp>

namespace Json {
    class Value;
}

namespace cinder {

class JsonTree {
  public:
    
    typedef boost::container::list<JsonTree> Container;

    typedef Container::const_iterator ConstIter;
    typedef Container::iterator Iter;


  private:
    
    typedef enum 
    { 
        NODE_UNKNOWN, NODE_NULL, NODE_ARRAY, NODE_OBJECT, NODE_VALUE
    } NodeType;

    typedef enum 
    { 
        VALUE_BOOL, VALUE_DOUBLE, VALUE_INT, VALUE_STRING, VALUE_UINT
    } ValueType;


  public:

    class ParseOptions {
      public:
        ParseOptions();
        ParseOptions& ignoreErrors( bool ignore = true );
        bool    getIgnoreErrors() const;
        
      private:
        bool    mIgnoreErrors;
        
    };
    
    class WriteOptions {
    public:
        WriteOptions();
        WriteOptions& createDocument( bool createDocument = true );
        WriteOptions& indented( bool indent = true );
        bool    getCreateDocument() const;
        bool    getIndented() const;
        
    private:
        bool    mCreateDocument;
        bool    mIndented;
        
    };
    
    
    explicit JsonTree();
    JsonTree( const JsonTree &jsonTree );
    explicit JsonTree( DataSourceRef dataSource, ParseOptions parseOptions = ParseOptions() );
    explicit JsonTree( const std::string &jsonString, ParseOptions parseOptions = ParseOptions() );
    explicit JsonTree( const std::string &key, bool value );
    explicit JsonTree( const std::string &key, double value );
    explicit JsonTree( const std::string &key, float value );
    explicit JsonTree( const std::string &key, int value );
    explicit JsonTree( const std::string &key, const std::string &value );
    explicit JsonTree( const std::string &key, const char *value );
    explicit JsonTree( const std::string &key, uint32_t value );
    explicit JsonTree( const std::string &key, int64_t value );
    explicit JsonTree( const std::string &key, uint64_t value );
    
    static JsonTree                 makeArray( const std::string &key = "" );
    static JsonTree                 makeObject( const std::string &key = "" );
    

    std::string                     serialize() const;

    Iter                            begin();
    ConstIter                       begin() const;
    Iter                            end();
    ConstIter                       end() const;

    JsonTree&                       operator=( const JsonTree &jsonTree );
    
    JsonTree&                       operator[]( const std::string &relativePath );
    const JsonTree&                 operator[]( const std::string &relativePath ) const;
    JsonTree&                       operator[]( size_t index );
    const JsonTree&                 operator[]( size_t index ) const;
    friend std::ostream&            operator<<( std::ostream &out, const JsonTree &json );
    
    JsonTree&                       getChild( const std::string &relativePath, bool caseSensitive = false, char separator = '.' );
    const JsonTree&                 getChild( const std::string &relativePath, bool caseSensitive = false, char separator = '.' ) const;
    JsonTree&                       getChild( size_t index );
    const JsonTree&                 getChild( size_t index ) const;
    const Container&        getChildren() const;

    bool                            hasChild( const std::string &relativePath, bool caseSensitive = false, char separator = '.' ) const;
    bool                            hasChildren() const;

    JsonTree&                       getParent();
    const JsonTree&                 getParent() const;
    bool                            hasParent() const;

    void                            clear();
    void                            pushBack( const JsonTree &newChild );
    void                            removeChild( size_t index );
    Iter                            removeChild( Iter pos );
    void                            replaceChild( size_t index, const JsonTree &newChild );
    void                            replaceChild( Iter pos, const JsonTree &newChild );

    void                            write( const fs::path &path, WriteOptions writeOptions = WriteOptions() );
    void                            write( DataTargetRef target, WriteOptions writeOptions = WriteOptions() );

    const std::string&              getKey() const;
    
    std::string                     getPath( char separator = '.' ) const;
    
    template <typename T> 
    inline T                        getValue() const
    {
        try {
            return fromString<T>( mValue );
        } catch ( boost::bad_lexical_cast &) {
            throw ExcNonConvertible( * this );
        }
        return (T)0; // Unreachable. Prevents warning.
    }

    const std::string&              getValue() const { return mValue; }

private:

    explicit JsonTree( const std::string &key, const Json::Value &value );

    Json::Value                     createNativeDoc( WriteOptions writeOptions = WriteOptions() ) const;
    static Json::Value              deserializeNative( const std::string &jsonString, ParseOptions parseOptions );
    static std::string              serializeNative( const Json::Value &value );
   
    void                            init( const std::string &key, const Json::Value &value, bool setType = false, 
        NodeType nodeType = NODE_VALUE, ValueType valueType = VALUE_STRING );
    
    JsonTree*                       getNodePtr( const std::string &relativePath, bool caseSensitive, char separator ) const;
    static bool                     isIndex( const std::string &key );
    
    Container                       mChildren;
    std::string                     mKey;
    JsonTree                        *mParent;
    NodeType                        mNodeType;
    std::string                     mValue;
    ValueType                       mValueType;

  public:


    class Exception : public cinder::Exception 
    {
    };

    class ExcChildNotFound : public JsonTree::Exception {
      public:
        ExcChildNotFound( const JsonTree &node, const std::string &key ) throw();
        virtual const char* what() const throw() 
        { 
            return mMessage; 
        }

      private:
        char mMessage[ 2048 ];
    };

    class ExcNonConvertible : public JsonTree::Exception {
      public:
        ExcNonConvertible( const JsonTree &node ) throw();
        virtual const char* what() const throw() 
        { 
            return mMessage; 
        }

      private:
        char mMessage[ 2048 ];
    };

    class ExcJsonParserError : public JsonTree::Exception {
    public:
        ExcJsonParserError( const std::string &errorMessage ) throw();
        virtual const char* what() const throw() 
        { 
            return mMessage; 
        }
        
    private:
        char mMessage[ 2048 ];
    };

};

std::ostream&                       operator<<( std::ostream &out, const JsonTree &json );

}