CUJsonReader.h

//
//  CUJsonReader.h
//  Cornell University Game Library (CUGL)
//
//  This module provides extends the basic TextReader to support JSON decoding.
//  It does not require that the entire file conform to JSON standards; it can
//  read a JSON string embedded in a larger text file.
//
//  By default, this module (and every module in the io package) accesses the
//  application save directory.  If you want to access another directory, you
//  will need to specify an absolute path for the file name.  Keep in mind that
//  absolute paths are very dangerous on mobile devices, because they do not
//  have proper file systems.  You should confine all files to either the asset
//  or the save directory.
//
//  This class uses our standard shared-pointer architecture.
//
//  1. The constructor does not perform any initialization; it just sets all
//     attributes to their defaults.
//
//  2. All initialization takes place via init methods, which can fail if an
//     object is initialized more than once.
//
//  3. All allocation takes place via static constructors which return a shared
//     pointer.
//
//  CUGL zlib License:
//      This software is provided 'as-is', without any express or implied
//      warranty.  In no event will the authors be held liable for any damages
//      arising from the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose,
//      including commercial applications, and to alter it and redistribute it
//      freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; you must not
//      claim that you wrote the original software. If you use this software
//      in a product, an acknowledgment in the product documentation would be
//      appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, and must not
//      be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//  Author: Walker White
//  Version: 11/28/16
//
#ifndef __CU_JSON_READER_H__
#define __CU_JSON_READER_H__
#include <cugl/io/CUTextReader.h>
#include <cugl/assets/CUJsonValue.h>

namespace  cugl {

class JsonReader : public TextReader {
    
#pragma mark -
#pragma mark Static Constructors
public:
    static std::shared_ptr<JsonReader> alloc(const std::string& file) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->init(file) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> alloc(const char* file) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->init(file) ? result : nullptr);
    }

    static std::shared_ptr<JsonReader> alloc(const Pathname& file) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->init(file) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> alloc(const std::string& file, unsigned int capacity) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->init(file,capacity) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> alloc(const char* file, unsigned int capacity) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->init(file,capacity) ? result : nullptr);
    }

    static std::shared_ptr<JsonReader> alloc(const Pathname& file, unsigned int capacity) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->init(file,capacity) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> allocWithAsset(const std::string& file) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->initWithAsset(file) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> allocWithAsset(const char* file) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->initWithAsset(file) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> allocWithAsset(const std::string& file, unsigned int capacity) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->initWithAsset(file,capacity) ? result : nullptr);
    }
    
    static std::shared_ptr<JsonReader> allocWithAsset(const char* file, unsigned int capacity) {
        std::shared_ptr<JsonReader> result = std::make_shared<JsonReader>();
        return (result->initWithAsset(file,capacity) ? result : nullptr);
    }
    
    
#pragma mark -
#pragma mark Read Methods

    std::string readJsonString();

    std::shared_ptr<JsonValue> readJson();
    
};

}
#endif /* __CU_JSON_READER_H__ */