ValueIteratorBase.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_ITERATOR_BASE_HPP
#define NOMLIB_SYSTEM_PTREE_VALUE_ITERATOR_BASE_HPP
 
#include <vector>
#include <iterator>
 
#include "nomlib/config.hpp"
#include "nomlib/ptree/ptree_config.hpp"
#include "nomlib/ptree/ptree_types.hpp"
#include "nomlib/ptree/ptree_forwards.hpp"
#include "nomlib/ptree/Value.hpp"
 
namespace nom {
 
class ValueIteratorBase
{
  public:
    typedef ValueIteratorBase SelfType;
    typedef ValueIteratorBase* RawPtr;
    typedef nom::size_type DifferenceType;
    typedef Value& ValueTypeReference;
    typedef Value* ValueTypePointer;
 
    enum IteratorType
    {
      Null = 0,         // Type 0 (default)
      ObjectValues      // Type 7
    };

    ValueIteratorBase();

    virtual ~ValueIteratorBase();
 
    ValueIteratorBase(const ObjectIterator& rhs);

    bool valid() const;

    ArrayIndex index() const;

    const char* key() const;

    bool key(const std::string& member) const;
 
    bool operator ==(const SelfType& rhs) const;
 
    bool operator !=(const SelfType& rhs) const;
 
    DifferenceType operator -(const SelfType& rhs) const;
 
  protected:
    void copy(const SelfType& rhs);
    ValueTypeReference dereference() const;
    ValueTypePointer pointer() const;
    void increment();
    void decrement();
    DifferenceType distance(const SelfType& rhs) const;
 
  private:
    enum IteratorType type() const;

    ObjectIterator object_;
 
    enum IteratorType type_;
};
 
} // namespace nom
 
#endif // include guard defined