Webmaster  |  Imprint 

C++ Server Pages

Main  |  License  |  Documentation  |  Download 

/home/tommi/cxxtools/include/cxxtools/xml/xmlreader.h

/*
 * Copyright (C) 2009 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 cxxtools_Xml_XmlReader_h
#define cxxtools_Xml_XmlReader_h

#include <cxxtools/string.h>
#include <cxxtools/textstream.h>
#include <cxxtools/xml/api.h>
#include <cxxtools/xml/node.h>
#include <cxxtools/xml/enddocument.h>
#include <iosfwd>

namespace cxxtools {

namespace xml {

    class Node;
    class StartElement;
    class EntityResolver;

class CXXTOOLS_XML_API XmlReader
{
    public:
        class Iterator
        {
            public:
                Iterator()
                : _stream(0)
                , _node(0)
                { }

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

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

                ~Iterator()
                { }

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

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

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

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

                    return *this;
                }

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

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

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

    public:
        /* TODO: Consider the following processing flags:
                     - ReportProcessingInstructions
                     - IgnoreWhitespace
                     - ReportComments
                     - ReportDocumentStart
        */
        XmlReader(std::istream& is, int flags = 0);

        XmlReader(std::basic_istream<Char>& is, int flags = 0);

        ~XmlReader();

        void reset(std::basic_istream<Char>& is, int flags = 0);

        void reset(std::istream& is, int flags = 0);

        const cxxtools::String& documentVersion() const;

        const cxxtools::String& documentEncoding() const;

        bool standaloneDocument() const;

        EntityResolver& entityResolver();

        const EntityResolver& entityResolver() const;

        size_t depth() const;

        Iterator current()
        {
            return Iterator(*this);
        }

        Iterator end() const
        {
            return Iterator();
        }

        const Node& get();

        const Node& next();

        bool advance();

        const StartElement& nextElement();

        const Node& nextTag();

        std::size_t line() const;

    private:
        class XmlReaderImpl* _impl;
};

}

}

#endif

Copyright © 2008 The Tntnet Development Team

Tntnet 1.6