petalnode.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2006-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef PETALNODE__H
#define PETALNODE__H
 
#include <QList>
#include <QPair>
#include <QString>
#include <QStringList>
 
class PetalNode
{
public:
    struct StringOrNode {
        QString string;
        PetalNode *node;
        StringOrNode() { node = 0; }
        virtual ~StringOrNode() { }
        bool isEmpty() const { return (string.isEmpty() && node == 0); }
    };
    typedef QPair<QString, StringOrNode> NameValue;
    typedef QList<NameValue> NameValueList;
 
    enum NodeType { nt_object, nt_list };
 
    explicit PetalNode(NodeType nt);
    virtual ~PetalNode();
 
    // getters
    NodeType type() const;
    QStringList initialArgs() const;  // name and other initial args
    QString name() const;     // convenience function: equal to initialArgs().first()
    QString viewTag() const;  // convenience function: equal to initialArgs().last()
    QString documentation() const;
    NameValueList attributes() const;
 
    // setters
    //void setType(NodeType nt);   see constructor
    void setInitialArgs(const QStringList& args);
    void setAttributes(NameValueList vl);
 
    // utilities
    StringOrNode findAttribute(const QString& name) const;
 
private:
    NodeType m_type;
    QStringList m_initialArgs;
    NameValueList m_attributes;
 
    friend QDebug operator<<(QDebug out, const PetalNode &p);
};
 
QDebug operator<<(QDebug out, const PetalNode::StringOrNode &p);
QDebug operator<<(QDebug out, const PetalNode::NameValue &p);
QDebug operator<<(QDebug out, const PetalNode::NameValueList &p);
QDebug operator<<(QDebug out, const PetalNode &p);
#endif