Value.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_SYSTEM_PTREE_VALUE_HPP
#define NOMLIB_SYSTEM_PTREE_VALUE_HPP
 
#include <string>
#include <vector>
 
#include "nomlib/config.hpp"
#include "nomlib/ptree/ptree_config.hpp"
#include "nomlib/ptree/ptree_types.hpp"
 
namespace nom {

class Value
{
  public:
    typedef Value SelfType;
    typedef Value* RawPtr;
    typedef Value& Reference;
 
    // TODO: Rename to const_iterator?
    typedef ValueConstIterator ConstIterator;
 
    // TODO: Rename to iterator?
    typedef ValueIterator Iterator;
 
    typedef std::vector<std::string> Members;

    enum ValueType
    {
      Null = 0,         // Type 0 (default)
      SignedInteger,    // Type 1
      UnsignedInteger,  // Type 2
      RealNumber,       // Type 3
      String,           // Type 4
      Boolean,          // Type 5
      ArrayValues,      // Type 6
      ObjectValues      // Type 7
    };

    static const Value& null;

    Value(); // type 0
 
    ~Value();

    Value(int val);

    Value(uint val);

    Value(real64 val);

    Value(const char* str);

    Value(const std::string& str);

    Value(bool val);

    Value(const Object& obj);

    Value(ValueType type);

    Value(const Value& rhs);

    Value::SelfType& operator =(const SelfType& rhs);

    void swap(Value& rhs);

    bool operator <(const Value& rhs) const;

    bool operator <=(const Value& rhs) const;

    bool operator >=(const Value& rhs) const;

    bool operator >(const Value& rhs) const;

    bool operator ==(const Value& rhs) const;

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

    bool operator!() const;

    int compare(const Value& rhs) const;

    Value::RawPtr get();

    Value::Reference ref();

    enum Value::ValueType type() const;

    const std::string type_name() const;

    bool null_type() const;

    bool int_type() const;

    bool uint_type() const;

    bool double_type() const;

    bool float_type() const;

    bool string_type() const;

    bool bool_type() const;

    bool array_type() const;

    bool object_type() const;
 
    const std::string stringify() const;

    int get_int() const;

    uint get_uint() const;

    real64 get_double() const;

    real32 get_float() const;

    const char* get_cstring() const;

    std::string get_string() const;

    bool get_bool() const;
 
    bool array_valid() const;
    bool object_valid() const;

    const Object array() const;

    const Object object() const;

    nom::size_type size() const;

    bool empty() const;

    void clear();

    Value& operator[](ArrayIndex index);

    Value& operator[](int index);

    const Value& operator[](ArrayIndex index) const;

    const Value& operator[](int index) const;

    Value& operator[](const char* key);
 
    Value& operator[](const std::string& key);
 
    const Value& operator[](const char* key) const;
    const Value& operator[](const std::string& key) const;

    Value& push_back(const Value& val);

    const Value& find(const std::string& key) const;

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

    // Value erase( int index );

    Members member_names() const;
 
    Value::ConstIterator begin() const;
 
    Value::ConstIterator end() const;

    Value::Iterator begin();

    Value::Iterator end();

    const std::string dump(const Value& object, int depth = 0) const;
 
  private:
    const std::string dump_key(const Value& key) const;

    const std::string dump_value(const Value& val) const;

    const std::string print_key(const std::string& type, uint size) const;

    const std::string print_value(const std::string& val) const;

    union ValueHolder
    {
      int int_;             // Type 1
      uint uint_;           // Type 2
      real64 real_;         // Type 3
      bool bool_;           // Type 4
      // NOTE: Instance-owned pointer.
      const char* string_;  // Type 5
      // NOTE: Instance-owned pointer.
      Object* object_;      // Type 6 and 7
    };

    enum ValueType type_;

    ValueHolder value_;
};

std::ostream& operator <<(std::ostream& os, const Value& val);
 
} // namespace nom
 
#endif // include guard defined