domUtils.h

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

 Copyright (C) 2002-2013 Gilles Debunne. All rights reserved.

 This file is part of the QGLViewer library version 2.5.2.

 http://www.libqglviewer.com - contact@libqglviewer.com

 This file may be used under the terms of the GNU General Public License 
 versions 2.0 or 3.0 as published by the Free Software Foundation and
 appearing in the LICENSE file included in the packaging of this file.
 In addition, as a special exception, Gilles Debunne gives you certain 
 additional rights, described in the file GPL_EXCEPTION in this package.

 libQGLViewer uses dual licensing. Commercial/proprietary software must
 purchase a libQGLViewer Commercial License.

 This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

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

#include "config.h"

#include <QDomElement>
#include <QString>
#include <QStringList>
#include <QColor>

#include <math.h>

#ifndef DOXYGEN

// QDomElement loading with syntax checking.
class DomUtils
{
private:
    static void warning(const QString& message)
    {
        qWarning("%s", message.toLatin1().constData());
    }

public:
    static float floatFromDom(const QDomElement& e, const QString& attribute, float defValue)
    {
        float value = defValue;
        if (e.hasAttribute(attribute)) {
            const QString s = e.attribute(attribute);
            bool ok;
            value = s.toFloat(&ok);
            if (!ok) {
                warning(QString("'%1' is not a valid float syntax for attribute \"%2\" in initialization of \"%3\". Setting value to %4.")
                        .arg(s).arg(attribute).arg(e.tagName()).arg(QString::number(defValue)));
                value = defValue;
            }
        } else {
            warning(QString("\"%1\" attribute missing in initialization of \"%2\". Setting value to %3.")
                    .arg(attribute).arg(e.tagName()).arg(QString::number(value)));
        }

#if defined(isnan)
        // The "isnan" method may not be available on all platforms.
        // Find its equivalent or simply remove these two lines
        if (isnan(value))
            warning(QString("Warning, attribute \"%1\" initialized to Not a Number in \"%2\"")
                    .arg(attribute).arg(e.tagName()));
#endif

        return value;
    }

    static double doubleFromDom(const QDomElement& e, const QString& attribute, double defValue)
    {
        double value = defValue;
        if (e.hasAttribute(attribute)) {
            const QString s = e.attribute(attribute);
            bool ok;
            value = s.toDouble(&ok);
            if (!ok) {
                warning(QString("'%1' is not a valid double syntax for attribute \"%2\" in initialization of \"%3\". Setting value to %4.")
                        .arg(s).arg(attribute).arg(e.tagName()).arg(QString::number(defValue)));
                value = defValue;
            }
        } else {
            warning(QString("\"%1\" attribute missing in initialization of \"%2\". Setting value to %3.")
                    .arg(attribute).arg(e.tagName()).arg(QString::number(value)));
        }

#if defined(isnan)
        // The "isnan" method may not be available on all platforms.
        // Find its equivalent or simply remove these two lines
        if (isnan(value))
            warning(QString("Warning, attribute \"%1\" initialized to Not a Number in \"%2\"")
                    .arg(attribute).arg(e.tagName()));
#endif

        return value;
    }

    static int intFromDom(const QDomElement& e, const QString& attribute, int defValue)
    {
        int value = defValue;
        if (e.hasAttribute(attribute))
        {
            const QString s = e.attribute(attribute);
            bool ok;
            value = s.toInt(&ok);
            if (!ok) {
                warning(QString("'%1' is not a valid integer syntax for attribute \"%2\" in initialization of \"%3\". Setting value to %4.")
                        .arg(s).arg(attribute).arg(e.tagName()).arg(QString::number(defValue)));
                value = defValue;
            }
        } else {
            warning(QString("\"%1\" attribute missing in initialization of \"%2\". Setting value to %3.")
                    .arg(attribute).arg(e.tagName()).arg(QString::number(value)));
        }

        return value;
    }

    static bool boolFromDom(const QDomElement& e, const QString& attribute, bool defValue)
    {
        bool value = defValue;
        if (e.hasAttribute(attribute))
        {
            const QString s = e.attribute(attribute);
            if (s.toLower() == QString("true"))
                value = true;
            else if (s.toLower() == QString("false"))
                value = false;
            else
            {
                warning(QString("'%1' is not a valid boolean syntax for attribute \"%2\" in initialization of \"%3\". Setting value to %4.")
                        .arg(s).arg(attribute).arg(e.tagName()).arg(defValue?"true":"false"));
            }
        } else {
            warning(QString("\"%1\" attribute missing in initialization of \"%2\". Setting value to %3.")
                    .arg(attribute).arg(e.tagName()).arg(value?"true":"false"));
        }

        return value;
    }

    static void setBoolAttribute(QDomElement& element, const QString& attribute, bool value) {
        element.setAttribute(attribute, (value ? "true" : "false"));
    }

    static QDomElement QColorDomElement(const QColor& color, const QString& name, QDomDocument& doc)
    {
        QDomElement de = doc.createElement(name);
        de.setAttribute("red", QString::number(color.red()));
        de.setAttribute("green", QString::number(color.green()));
        de.setAttribute("blue", QString::number(color.blue()));
        return de;
    }

    static QColor QColorFromDom(const QDomElement& e)
    {
        int color[3];
        QStringList attribute;
        attribute << "red" << "green" << "blue";
        for (int i=0; i<attribute.count(); ++i)
            color[i] = DomUtils::intFromDom(e, attribute[i], 0);
        return QColor(color[0], color[1], color[2]);
    }
};

#endif // DOXYGEN