XmlReader.h

/*
 * Copyright (C) 2009-2012 Marc Boris Duerner
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * 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 GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef Pt_Xml_XmlReader_h
#define Pt_Xml_XmlReader_h

#include <Pt/Xml/Api.h>
#include <Pt/Xml/Node.h>
#include <Pt/String.h>
#include <Pt/NonCopyable.h>
#include <iosfwd>

namespace Pt {

namespace Xml {

class Node;
class DocTypeDefinition;
class InputSource;
class XmlResolver;
class InputIterator;

class PT_XML_API XmlReader : private NonCopyable
{
    public:
        XmlReader();

        explicit XmlReader(InputSource& is);

        XmlReader(XmlResolver& r, InputSource& is);

        ~XmlReader();

        XmlResolver* resolver() const;

        InputSource* input();

        void addInput(InputSource& in);

        void reset();

        void reset(InputSource& is);

        void setChunkSize(std::size_t n);

        void setMaxInputDepth(std::size_t n);

        void setMaxSize(std::size_t n);

        std::size_t maxSize() const;

        std::size_t usedSize() const;

        void reportStartDocument(bool value);

        void reportDocType(bool value);

        void reportProcessingInstructions(bool value);

        void reportCData(bool value);
        
        void reportComments(bool value);

        void reportEntityReferences(bool value);

        DocTypeDefinition& dtd();

        const DocTypeDefinition& dtd() const;

        std::size_t depth() const;

        std::size_t line() const;

        InputIterator current();

        InputIterator end() const;

        Node& get();

        Node& next();

        Node* advance();

    private:
        class XmlReaderImpl* _impl;

    public:
        XmlReaderImpl* impl()
        { return _impl; }
};

class InputIterator
{
    public:
        InputIterator()
        : _stream(0)
        , _node(0)
        { }

        explicit InputIterator(XmlReader& xis)
        : _stream(&xis)
        , _node(0)
        { _node = &_stream->get(); }

        InputIterator(const InputIterator& it)
        : _stream(it._stream), _node(it._node)
        { }

        ~InputIterator()
        { }

        InputIterator& operator=(const InputIterator& it)
        {
            _stream = it._stream;
            _node = it._node;
            return *this;
        }

        inline Node& operator*()
        { return *_node; }

        inline Node* operator->()
        { return _node; }

        InputIterator& operator++()
        {
            if(_node->type() == Node::EndDocument)
                _node = 0;
            else
                _node = &_stream->next();

            return *this;
        }

        inline bool operator==(const InputIterator& it) const
        { return _node == it._node; }

        inline bool operator!=(const InputIterator& it) const
        { return _node != it._node; }

    private:
        XmlReader* _stream;
        Node* _node;
};


inline InputIterator XmlReader::current()
{
    return InputIterator(*this); 
}


inline InputIterator XmlReader::end() const
{
    return InputIterator(); 
}

} // namespace Xml

} // namespace Pt

#endif // Pt_Xml_XmlReader_h