ttkabstractxml.h

Go to the documentation of this file.

#ifndef TTKABSTRACTXML_H
#define TTKABSTRACTXML_H

/***************************************************************************
 * This file is part of the TTK Library Module project
 * Copyright (C) 2015 - 2026 Greedysky Studio

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

 * You should have received a copy of the GNU Lesser General Public License along
 * with this program; If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

#include <QFile>
#include <QTextStream>
#include <QtXml/QDomDocument>

#include "ttktime.h"
#include "ttkabstractbufferinterface.h"

struct TTK_MODULE_EXPORT TTKXmlAttr
{
    QString m_key;
    QVariant m_value;

    TTKXmlAttr() = default;
    TTKXmlAttr(const QString &key, const QVariant &value) noexcept
        : m_key(key),
          m_value(value)
    {

    }
};
TTK_DECLARE_LIST(TTKXmlAttr);


struct TTK_MODULE_EXPORT TTKXmlNode
{
    TTKXmlAttrList m_attrs;
    QString m_text;

    TTKXmlNode() noexcept
        : m_attrs(),
          m_text()
    {

    }
};
TTK_DECLARE_LIST(TTKXmlNode);


class TTK_MODULE_EXPORT TTKXmlHelper
{
public:
    explicit TTKXmlHelper(const QDomNode &root) noexcept;

    void load();
    bool hasNext();

    QDomNode next() const noexcept;
    QString nodeName(const QString &name) const noexcept;

private:
    QDomNode m_root, m_current;
    QSet<QString> m_nodeNames;

};


class TTK_MODULE_EXPORT TTKAbstractXml
{
public:
    TTKAbstractXml();
    virtual ~TTKAbstractXml();

    bool load(const QString &name);
    void save() const;
    void close();
    bool reset();

    bool fromFile(const QString &name);
    bool fromString(const QString &data);
    bool fromByteArray(const QByteArray &data);

    QString toString() const;
    QByteArray toByteArray() const;

public:
    QString readAttributeByTagName(const QString &node, const QString &attrName = "value") const;
    QString readTextByTagName(const QString &node) const;
    TTKXmlNode readNodeByTagName(const QString &node) const;

    QStringList readMultiAttributeByTagName(const QString &node, const QString &attrName = "value") const;
    QStringList readMultiTextByTagName(const QString &node) const;
    TTKXmlNodeList readMultiNodeByTagName(const QString &node) const;

public:
    QDomElement createRoot(const QString &node) const;
    QDomElement createRoot(const QString &node, const TTKXmlAttr &attr) const;
    QDomElement createRoot(const QString &node, const TTKXmlAttrList &attrs) const;

    QDomElement writeDomElement(QDomElement &element, const QString &node) const;
    QDomElement writeDomElement(QDomElement &element, const QString &node, const QString &text) const;
    QDomElement writeDomElement(QDomElement &element, const QString &node, const TTKXmlNode &attr) const;
    QDomElement writeDomElement(QDomElement &element, const QString &node, const TTKXmlAttr &attr) const;
    QDomElement writeDomElement(QDomElement &element, const QString &node, const TTKXmlAttr &attr, const QString &text) const;

    QDomElement writeDomMultiElement(QDomElement &element, const QString &node, const TTKXmlNode &attrs) const;
    QDomElement writeDomMultiElement(QDomElement &element, const QString &node, const TTKXmlAttrList &attrs) const;
    QDomElement writeDomMultiElement(QDomElement &element, const QString &node, const TTKXmlAttrList &attrs, const QString &text) const;

    QDomNodeList findDomNodes(const QString &node) const;

    void createProcessingInstruction() const;

    void writeAttribute(QDomElement &element, const TTKXmlAttr &attr) const;
    void writeAttribute(QDomElement &element, const TTKXmlAttrList &attr) const;

protected:
    QFile *m_file;
    QDomDocument *m_document;

};

#endif // TTKABSTRACTXML_H