valentina/src/app/xml/vdomdocument.h

/************************************************************************
 **
 **  @file   vdomdocument.h
 **  @author Roman Telezhynskyi <dismine(at)gmail.com>
 **  @date   November 15, 2013
 **
 **  @brief
 **  @copyright
 **  This source code is part of the Valentina project, a pattern making
 **  program that allows creating and modelling patterns of clothing.
 **  Copyright (C) 2013 Valentina project
 **  <https://bitbucket.org/dismine/valentina> All Rights Reserved.
 **
 **  Valentina 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 3 of the License, or
 **  (at your option) any later version.
 **
 **  Valentina 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 Valentina.  If not, see <http://www.gnu.org/licenses/>.
 **
 *************************************************************************/

#ifndef VDOMDOCUMENT_H
#define VDOMDOCUMENT_H

#include "../container/vcontainer.h"

#include <QDomDocument>
#include <QDebug>
#include "../options.h"

/*
   can be used like #if (V_FORMAT_VERSION >= V_FORMAT_VERSION_CHECK(4, 4, 0))
*/
#define V_FORMAT_VERSION_CHECK(major, minor, patch) ((major<<16)|(minor<<8)|(patch))

#ifdef Q_CC_GNU
    #pragma GCC diagnostic push
    #pragma GCC diagnostic ignored "-Weffc++"
#endif

/**
 * @brief The VDomDocument class represents a Valentina document (.val file).
 *
 * A Valentina document describes the construction of a sewing pattern. The
 * information is stored in XML format. By parsing a VDomDocument, the contained
 * pattern is rendered to a Valentina graphics scene (VMainGraphicsScene).
 *
 * A sewing pattern consists of zero or more increments and one
 * or more pattern pieces.
 *
 * An increment is an auxiliary variable that is calculated from regular measurement
 * variables (that belong to the standard measurements table). Increments are used to
 * create a graduation schema for the sewing pattern.
 *
 * A pattern piece contains
 * 1) auxiliary pattern construction elements (calculation),
 * 2) pattern construction elements (modeling), and
 * 3) special markers, e.g. seam allowances (details).
 * Of these, 2) and 3) are visible in the final pattern (draw mode 'Modeling'),
 * 1) is only displayed when editing (draw mode 'Calculation') the pattern.
 */
class VDomDocument : public QDomDocument
{
    Q_DECLARE_TR_FUNCTIONS(VDomDocument)
public:
    static const QString    AttrId;
    static const QString    AttrUnit;
    static const QString    UnitMM;
    static const QString    UnitCM;
    static const QString    UnitINCH;
    static const QString    TagVersion;
    /**
    * @param data container with variables
    * @param comboBoxDraws pointer to the ComboBox that will hold the pattern piece names
    * @param mode draw mode
    * @param parent
    */
    VDomDocument(VContainer *data);
    virtual ~VDomDocument(){}
    /**
     * @brief Finds an element by id.
     * @param id value id attribute.
     * @return dom element.
     */
    QDomElement    elementById(const QString& id);
    /**
     * @brief Removes all children of a given element tag. RENAME: removeAllChildren
     * @param element tag
     */
    void           removeAllChilds(QDomElement &element);
    template <typename T>
    /**
     * @brief SetAttribute set attribute in pattern file. Replace "," by ".".
     * @param domElement element in xml tree.
     * @param name name of attribute.
     * @param value value of attribute.
     * @param parse parsing mode
     * @return list of tool pointers
     * @return list of history record lists
     * @return cursor
     * @throw VExceptionUniqueId
     */
    void SetAttribute(QDomElement &domElement, const QString &name, const T &value)
    {
        QString val = QString().setNum(value);
        val = val.replace(",", ".");
        domElement.setAttribute(name, val);
    }
    /**
     * @brief Returns the long long value of the given attribute. RENAME: GetParameterLongLong?
     * @param domElement tag in xml tree
     * @param name attribute name
     * @return long long value
     */
    quint32         GetParametrUInt(const QDomElement& domElement, const QString &name,
                                       const QString &defValue) const;
    /**
     * @brief Returns the string value of the given attribute. RENAME: see above
     *
     * if attribute empty return default value. If default value empty too throw exception.
     * @return attribute value
     * @throw VExceptionEmptyParameter when attribute is empty
     */
    QString        GetParametrString(const QDomElement& domElement, const QString &name,
                                     const QString &defValue = QString()) const;
    /**
     * @brief Returns the double value of the given attribute.
     * @param domElement tag in xml tree
     * @param name attribute name
     * @return double value
     */
    qreal          GetParametrDouble(const QDomElement& domElement, const QString &name, const QString &defValue) const;
    QString        UniqueTagText(const QString &tagName, const QString &defVal = QString()) const;
    /**
     * @brief ValidateXML validate xml file by xsd schema.
     * @param schema path to schema file.
     * @param fileName name of xml file.
     * @param errorMsg error message.
     * @param errorLine number error line.
     * @param errorColumn number error column.
     * @return true if validation successful.
     */
    static void    ValidateXML(const QString &schema, const QString &fileName);
    void           setContent(const QString &fileName);
    static Valentina::Units StrToUnits(const QString &unit);
    static QString UnitsToStr(const Valentina::Units &unit);
    virtual bool   SaveDocument(const QString &fileName);
    QString        Major() const;
    QString        Minor() const;
    QString        Patch() const;
protected:
    /**
     * @brief data container with data.
     */
    VContainer     *data;
    void setTagText(const QString &tag, const QString &text);

private:
    Q_DISABLE_COPY(VDomDocument)
    /**
     * @brief Map used for finding element by id.
     */
    QHash<QString, QDomElement> map;

    /**
     * @brief Find element by id.
     * @param node node
     * @param id id value
     * @return true if found
     */
    bool           find(const QDomElement &node, const QString& id);
};

template <>
inline void VDomDocument::SetAttribute<QString>(QDomElement &domElement, const QString &name, const QString &value)
{
    domElement.setAttribute(name, value);
}

template <>
inline void VDomDocument::SetAttribute<Pattern::Measurements>(QDomElement &domElement, const QString &name,
                                                              const Pattern::Measurements &value)
{
    if (value == Pattern::Standard)
    {
        domElement.setAttribute(name, "standard");
    }
    else
    {
        domElement.setAttribute(name, "individual");
    }
}

#ifdef Q_CC_GNU
    #pragma GCC diagnostic pop
#endif

#endif // VDOMDOCUMENT_H