IConfigFile.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. 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 OWNER 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.
 
******************************************************************************/
#ifndef NOMLIB_SERIALIZERS_ICONFIG_FILE_HPP
#define NOMLIB_SERIALIZERS_ICONFIG_FILE_HPP
 
#include <memory>
#include <map>
 
#include "nomlib/config.hpp"
#include "nomlib/ptree/Value.hpp"
 
#include "nomlib/math/Point2.hpp"
 
// #define NOM_DEBUG_SERIALIZERS_ICONFIG_FILE
 
namespace nom {
 
// Forward declarations
class IValueDeserializer;
class IValueSerializer;

class IConfigFile
{
  public:
    typedef IConfigFile self_type;
 
    typedef self_type* raw_ptr;
    typedef std::unique_ptr<self_type> unique_ptr;
    typedef std::shared_ptr<self_type> shared_ptr;
 
    typedef std::pair<std::string, Value> Pair;
    typedef std::map<std::string, Value> value_type;

    friend class JsonConfigFile;

    IConfigFile( void );

    virtual ~IConfigFile( void );

    virtual IValueDeserializer* deserializer( void ) const = 0;

    virtual IValueSerializer* serializer( void ) const = 0;

    virtual bool flush( void ) = 0;

    virtual bool load( void ) = 0;

    virtual bool save( void ) = 0;

    const std::string& filename( void ) const;

    bool exists( const std::string& key ) const;

    int get_int( const std::string& key, int default_value ) const;

    uint get_uint( const std::string& key, uint default_value ) const;

    double get_double( const std::string& key, double default_value ) const;

    const std::string get_string( const std::string& key, const std::string& default_value ) const;

    bool get_bool( const std::string& key, bool default_value ) const;

    void set_property( const std::string& key, const Value& value );

    bool erase( const std::string& key );

    void set_filename( const std::string& filename );
 
  private:
    const value_type& get( void ) const;

    std::string filename_;

    value_type config_;
};
 
} // namespace nom
 
#endif // include guard defined