KDSoapValue.h

/****************************************************************************
**
** This file is part of the KD Soap library.
**
** SPDX-FileCopyrightText: 2010-2021 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDAB-KDSoap OR LicenseRef-KDAB-KDSoap-US
**
** Licensees holding valid commercial KD Soap licenses may use this file in
** accordance with the KD Soap Commercial License Agreement provided with
** the Software.
**
** Contact info@kdab.com if any conditions of this licensing are not clear to you.
**
****************************************************************************/
#ifndef KDSOAPVALUE_H
#define KDSOAPVALUE_H
 
#include <QtCore/QString>
#include <QtCore/QVariant>
#include <QtCore/QList>
#include <QtCore/QPair>
#include <QtCore/QSet>
#include <QtCore/QVector>
#include <QtCore/QSharedDataPointer>
#include <QtCore/QXmlStreamNamespaceDeclarations>
#include "KDSoapGlobal.h"
 
#ifndef QT_NO_STL
#include <algorithm>
#endif
 
class KDSoapValueList;
class KDSoapNamespacePrefixes;
QT_BEGIN_NAMESPACE
class QXmlStreamWriter;
QT_END_NAMESPACE
 
namespace KDSoap {
enum SoapVersion
{
    SOAP1_1 = 1,
    SOAP1_2 = 2
};
}
 
class KDSOAP_EXPORT KDSoapValue
{
public:
    KDSoapValue();
    ~KDSoapValue();
 
    KDSoapValue(const QString &name, const QVariant &valueVariant, const QString &typeNameSpace = QString(), const QString &typeName = QString());
    KDSoapValue(const QString &name, const KDSoapValueList &childValues, const QString &typeNameSpace = QString(),
                const QString &typeName = QString());
 
    KDSoapValue(const KDSoapValue &other);
 
    KDSoapValue &operator=(const KDSoapValue &other)
    {
        if (this != &other) {
            KDSoapValue copy(other);
            swap(copy);
        }
        return *this;
    }
 
    void swap(KDSoapValue &other)
    {
        d.swap(other.d);
    }
 
    bool isNull() const;
 
    bool isNil() const;
 
    void setNillable(bool nillable);
 
    QString name() const;
 
    QString namespaceUri() const;
 
    void setNamespaceUri(const QString &ns);
 
    QVariant value() const;
 
    void setValue(const QVariant &value);
 
    bool isQualified() const;
 
    void setQualified(bool qualified);
 
    KDSoapValueList &childValues() const;
 
    bool operator==(const KDSoapValue &other) const;
 
    bool operator!=(const KDSoapValue &other) const;
 
    void setType(const QString &nameSpace, const QString &type);
    QString typeNs() const;
    QString type() const;
 
    void setNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &namespaceDeclarations);
 
    void addNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &namespaceDeclaration);
 
    QXmlStreamNamespaceDeclarations namespaceDeclarations() const;
 
    void setEnvironmentNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &environmentNamespaceDeclarations);
 
    QXmlStreamNamespaceDeclarations environmentNamespaceDeclarations() const;
 
    KDSoapValueList split() const;
 
    enum Use
    {
        LiteralUse, 
        EncodedUse 
    };
 
    QByteArray toXml(Use use = LiteralUse, const QString &messageNamespace = QString()) const;
 
protected: // for KDSoapMessage
    void setName(const QString &name);
 
private:
    // To catch mistakes
    KDSoapValue(QString, QString, QString);
 
    friend class KDSoapMessageWriter;
    void writeElement(KDSoapNamespacePrefixes &namespacePrefixes, QXmlStreamWriter &writer, KDSoapValue::Use use, const QString &messageNamespace,
                      bool forceQualified) const;
    void writeElementContents(KDSoapNamespacePrefixes &namespacePrefixes, QXmlStreamWriter &writer, KDSoapValue::Use use,
                              const QString &messageNamespace) const;
    void writeChildren(KDSoapNamespacePrefixes &namespacePrefixes, QXmlStreamWriter &writer, KDSoapValue::Use use, const QString &messageNamespace,
                       bool forceQualified) const;
 
    class Private;
    QSharedDataPointer<Private> d;
};
 
QT_BEGIN_NAMESPACE
Q_DECLARE_TYPEINFO(KDSoapValue, Q_MOVABLE_TYPE);
QT_END_NAMESPACE
 
KDSOAP_EXPORT QDebug operator<<(QDebug dbg, const KDSoapValue &value);
 
KDSOAP_EXPORT uint qHash(const KDSoapValue &value);
inline void qSwap(KDSoapValue &lhs, KDSoapValue &rhs)
{
    lhs.swap(rhs);
}
 
#ifndef QT_NO_STL
namespace std {
template<>
inline void swap<KDSoapValue>(KDSoapValue &lhs, KDSoapValue &rhs)
{
    lhs.swap(rhs);
}
}
#endif
 
class KDSOAP_EXPORT KDSoapValueList : public QList<KDSoapValue> // krazy:exclude=dpointer
{
public:
    void addArgument(const QString &argumentName, const QVariant &argumentValue, const QString &typeNameSpace = QString(),
                     const QString &typeName = QString());
 
    KDSoapValue child(const QString &name) const;
 
    void setArrayType(const QString &nameSpace, const QString &type);
    QString arrayTypeNs() const;
    QString arrayType() const;
 
    QList<KDSoapValue> &attributes()
    {
        return m_attributes;
    }
    const QList<KDSoapValue> &attributes() const
    {
        return m_attributes;
    }
 
private:
    QPair<QString, QString> m_arrayType;
    QList<KDSoapValue> m_attributes;
 
    QVariant d; // for extensions
};
 
typedef QListIterator<KDSoapValue> KDSoapValueListIterator;
 
// Q_DECLARE_METATYPE(KDSoapValueList)
 
#endif // KDSOAPVALUE_H