~valavanisalex/ubuntu/maverick/scidavis/fix-604811

/***************************************************************************

    File                 : XmlStreamReader.h

    Project              : SciDAVis

    Description          : XML stream parser that supports errors as well as warnings

    --------------------------------------------------------------------

    Copyright            : (C) 2008-2009 Tilman Benkert (thzs*gmx.net)

                           (replace * with @ in the email addresses) 

                           

 ***************************************************************************/

 

/***************************************************************************

 *                                                                         *

 *  This program is free software; you can redistribute it and/or modify   *

 *  it under the terms of the GNU General Public License as published by   *

 *  the Free Software Foundation; either version 2 of the License, or      *

 *  (at your option) any later version.                                    *

 *                                                                         *

 *  This program 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 General Public License for more details.                           *

 *                                                                         *

 *   You should have received a copy of the GNU General Public License     *

 *   along with this program; if not, write to the Free Software           *

 *   Foundation, Inc., 51 Franklin Street, Fifth Floor,                    *

 *   Boston, MA  02110-1301  USA                                           *

 *                                                                         *

 ***************************************************************************/

#ifndef XML_STREAM_READER_H

#define XML_STREAM_READER_H

 

#include <QXmlStreamReader>

#include <QString>

#include <QStringList>

#include "lib/macros.h"

 

//! XML stream parser that supports errors as well as warnings

/**

 * This class also adds line and column numbers to the error message.

 */

class XmlStreamReader : public QXmlStreamReader

{

        public:

                XmlStreamReader();

                XmlStreamReader(QIODevice * device);

                XmlStreamReader(const QByteArray & data);

                XmlStreamReader(const QString & data);

                XmlStreamReader(const char * data);

 

                QStringList warningStrings() const;

                bool hasWarnings() const;

                void raiseWarning(const QString & message = QString());

                void raiseError(const QString & message = QString());

                CLASS_ACCESSOR(QString, d_error_prefix, errorPrefix, ErrorPrefix);

                CLASS_ACCESSOR(QString, d_error_postfix, errorPostfix, ErrorPostfix);

                CLASS_ACCESSOR(QString, d_warning_prefix, warningPrefix, WarningPrefix);

                CLASS_ACCESSOR(QString, d_warning_postfix, warningPostfix, WarningPostfix);

 

                //! Go to the next start or end element tag

                /**

                 *      If the end of the document is reached, an error is raised.

                 *

                 * \return false if end of document reached, otherwise true

                 */

                bool skipToNextTag();

                //! Go to the end element tag of the current element

                /**

                 *      If the end of the document is reached, an error is raised.

                 *

                 * \return false if end of document reached, otherwise true

                 */

                bool skipToEndElement();

                

                //! Read an XML attribute and convert it to int

                /**

                 * \param name attribute name

                 * \param ok pointer to report back whether the attribute value could be determined (may be NULL)

                 * \return the attriute value if found and converted, otherwise zero (in this case *ok is false)

                 */

                int readAttributeInt(const QString & name, bool * ok);

 

        private:

                QStringList d_warnings;

                QString d_error_prefix;

                QString d_error_postfix;

                QString d_warning_prefix;

                QString d_warning_postfix;

 

                void init();

};

 

#endif // XML_STREAM_READER_H