---

VMapIterator.h

/*****************************************************************************
 * Author:   Valient Gough <vgough@pobox.com>
 *
 *****************************************************************************
 * Copyright (c) 2001, Valient Gough
 *
 * This library is free software; you can distribute it and/or modify it under
 * the terms of the GNU Lesser General Public License (LGPL), as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the LGPL in the file COPYING for more
 * details.
 *
 */

#ifndef _VMapIterator_incl_
#define _VMapIterator_incl_

#include <iterator>
#include <utility>
#include <string>

#include <rel/SmartPtr.h>

namespace rel
{

    class VMap;

    /*
        Iterator over VMap entries.  This should not be created directly - it is
        returned from VMap::begin() and VMap::end() methods.
     */
    class VMapIterator : public std::iterator<std::forward_iterator_tag, 
                                    std::pair<std::string,OpaqueValue> >
    {
    public:
        VMapIterator(VMap *map, const OpaqueValue &privateData);
        VMapIterator(const VMapIterator &src);
        ~VMapIterator();

        VMapIterator &operator = (const VMapIterator &src);

        // compare two iterators - returns true if they point to the same VMap,
        // and same part of the map.
        bool operator == (const VMapIterator &rhs) const;
        bool operator != (const VMapIterator &rhs) const;

        const std::pair<std::string,OpaqueValue> &operator*() const;
        const std::pair<std::string,OpaqueValue> *operator->() const;
        VMapIterator &operator++();
        VMapIterator operator++(int);

    private:
        VMap *fMap;
        bool fCached;  // if response has already been retrieved (and now cached)
        std::pair<std::string,OpaqueValue> fCachedValue;
        OpaqueValue fPrivateData;
    };


    inline bool VMapIterator::operator != (const VMapIterator &rhs) const
    { return !operator==(rhs); }


} // namespace rel


#endif

---