Rename PubSubItem -> PubSubBaseItem to be able to include old PubSubItem

11 files changed, 56 insertions, 59 deletions

diff --git a/src/base/QXmppGeolocItem.cpp b/src/base/QXmppGeolocItem.cpp
index b6bf0b85..32e08189 100644
--- a/src/base/QXmppGeolocItem.cpp
+++ b/src/base/QXmppGeolocItem.cpp
@@ -146,7 +146,7 @@ bool QXmppGeolocItem::isItem(const QDomElement &itemElement)
             payload.namespaceURI() == ns_geoloc;

     };

 

-    return QXmppPubSubItem::isItem(itemElement, isPayloadValid);

+    return QXmppPubSubBaseItem::isItem(itemElement, isPayloadValid);

 }

 

 /// \cond

diff --git a/src/base/QXmppGeolocItem.h b/src/base/QXmppGeolocItem.h
index 05d42dba..58914b1b 100644
--- a/src/base/QXmppGeolocItem.h
+++ b/src/base/QXmppGeolocItem.h
@@ -5,7 +5,7 @@
 #ifndef QXMPPGEOLOCITEM_H
 #define QXMPPGEOLOCITEM_H
 
-#include "QXmppPubSubItem.h"
+#include "QXmppPubSubBaseItem.h"
 
 #include <optional>
 
@@ -13,7 +13,7 @@
 
 class QXmppGeolocItemPrivate;
 
-class QXMPP_EXPORT QXmppGeolocItem : public QXmppPubSubItem
+class QXMPP_EXPORT QXmppGeolocItem : public QXmppPubSubBaseItem
 {
 public:
     QXmppGeolocItem();
diff --git a/src/base/QXmppMixInfoItem.h b/src/base/QXmppMixInfoItem.h
index 9a28decb..313c3e14 100644
--- a/src/base/QXmppMixInfoItem.h
+++ b/src/base/QXmppMixInfoItem.h
@@ -5,11 +5,11 @@
 #ifndef QXMPPMIXINFOITEM_H
 #define QXMPPMIXINFOITEM_H
 
-#include "QXmppPubSubItem.h"
+#include "QXmppPubSubBaseItem.h"
 
 class QXmppMixInfoItemPrivate;
 
-class QXMPP_EXPORT QXmppMixInfoItem : public QXmppPubSubItem
+class QXMPP_EXPORT QXmppMixInfoItem : public QXmppPubSubBaseItem
 {
 public:
     QXmppMixInfoItem();
diff --git a/src/base/QXmppMixItems.cpp b/src/base/QXmppMixItems.cpp
index e08dd3f2..a19edbb0 100644
--- a/src/base/QXmppMixItems.cpp
+++ b/src/base/QXmppMixItems.cpp
@@ -138,7 +138,7 @@ void QXmppMixInfoItem::setContactJids(QStringList contactJids)
 ///
 bool QXmppMixInfoItem::isItem(const QDomElement &element)
 {
-    return QXmppPubSubItem::isItem(element, [](const QDomElement &payload) {
+    return QXmppPubSubBaseItem::isItem(element, [](const QDomElement &payload) {
         // check FORM_TYPE without parsing a full QXmppDataForm
         if (payload.tagName() != u'x' || payload.namespaceURI() != ns_data) {
             return false;
@@ -264,7 +264,7 @@ void QXmppMixParticipantItem::serializePayload(QXmlStreamWriter *writer) const
 ///
 bool QXmppMixParticipantItem::isItem(const QDomElement &element)
 {
-    return QXmppPubSubItem::isItem(element, [](const QDomElement &payload) {
+    return QXmppPubSubBaseItem::isItem(element, [](const QDomElement &payload) {
         return payload.tagName() == QStringLiteral("participant") &&
             payload.namespaceURI() == ns_mix;
     });
diff --git a/src/base/QXmppMixParticipantItem.h b/src/base/QXmppMixParticipantItem.h
index f0f2abaa..ce179fbe 100644
--- a/src/base/QXmppMixParticipantItem.h
+++ b/src/base/QXmppMixParticipantItem.h
@@ -5,11 +5,11 @@
 #ifndef QXMPPMIXPARTICIPANTITEM_H
 #define QXMPPMIXPARTICIPANTITEM_H
 
-#include "QXmppPubSubItem.h"
+#include "QXmppPubSubBaseItem.h"
 
 class QXmppMixParticipantItemPrivate;
 
-class QXMPP_EXPORT QXmppMixParticipantItem : public QXmppPubSubItem
+class QXMPP_EXPORT QXmppMixParticipantItem : public QXmppPubSubBaseItem
 {
 public:
     QXmppMixParticipantItem();
diff --git a/src/base/QXmppPubSubItem.cpp b/src/base/QXmppPubSubBaseItem.cpp
index f87c5d6e..43b1aa88 100644
--- a/src/base/QXmppPubSubItem.cpp
+++ b/src/base/QXmppPubSubBaseItem.cpp
@@ -3,47 +3,47 @@
 //
 // SPDX-License-Identifier: LGPL-2.1-or-later
 
-#include "QXmppPubSubItem.h"
+#include "QXmppPubSubBaseItem.h"
 
 #include "QXmppElement.h"
 #include "QXmppUtils.h"
 
 #include <QDomElement>
 
-class QXmppPubSubItemPrivate : public QSharedData
+class QXmppPubSubBaseItemPrivate : public QSharedData
 {
 public:
-    QXmppPubSubItemPrivate(const QString &id, const QString &publisher);
+    QXmppPubSubBaseItemPrivate(const QString &id, const QString &publisher);
 
     QString id;
     QString publisher;
 };
 
-QXmppPubSubItemPrivate::QXmppPubSubItemPrivate(const QString &id, const QString &publisher)
+QXmppPubSubBaseItemPrivate::QXmppPubSubBaseItemPrivate(const QString &id, const QString &publisher)
     : id(id), publisher(publisher)
 {
 }
 
 ///
-/// \class QXmppPubSubItem
+/// \class QXmppPubSubBaseItem
 ///
-/// The QXmppPubSubItem class represents a publish-subscribe item as defined by
+/// The QXmppPubSubBaseItem class represents a publish-subscribe item as defined by
 /// \xep{0060, Publish-Subscribe}.
 ///
 /// To access the payload of an item, you need to create a derived class of this
-/// and override QXmppPubSubItem::parsePayload() and
-/// QXmppPubSubItem::serializePayload().
+/// and override QXmppPubSubBaseItem::parsePayload() and
+/// QXmppPubSubBaseItem::serializePayload().
 ///
-/// It is also required that you override QXmppPubSubItem::isItem() and also
+/// It is also required that you override QXmppPubSubBaseItem::isItem() and also
 /// check for the correct payload of the PubSub item. This can be easily done by
 /// using the protected overload of isItem() with an function that checks the
 /// tag name and namespace of the payload. The function is only called if a
 /// payload exists.
 ///
 /// In short, you need to reimplement these methods:
-///  * QXmppPubSubItem::parsePayload()
-///  * QXmppPubSubItem::serializePayload()
-///  * QXmppPubSubItem::isItem()
+///  * QXmppPubSubBaseItem::parsePayload()
+///  * QXmppPubSubBaseItem::serializePayload()
+///  * QXmppPubSubBaseItem::isItem()
 ///
 /// \since QXmpp 1.5
 ///
@@ -54,25 +54,25 @@ QXmppPubSubItemPrivate::QXmppPubSubItemPrivate(const QString &id, const QString
 /// \param id
 /// \param publisher
 ///
-QXmppPubSubItem::QXmppPubSubItem(const QString &id, const QString &publisher)
-    : d(new QXmppPubSubItemPrivate(id, publisher))
+QXmppPubSubBaseItem::QXmppPubSubBaseItem(const QString &id, const QString &publisher)
+    : d(new QXmppPubSubBaseItemPrivate(id, publisher))
 {
 }
 
 /// Default copy-constructor
-QXmppPubSubItem::QXmppPubSubItem(const QXmppPubSubItem &iq) = default;
+QXmppPubSubBaseItem::QXmppPubSubBaseItem(const QXmppPubSubBaseItem &iq) = default;
 /// Default move-constructor
-QXmppPubSubItem::QXmppPubSubItem(QXmppPubSubItem &&) = default;
-QXmppPubSubItem::~QXmppPubSubItem() = default;
+QXmppPubSubBaseItem::QXmppPubSubBaseItem(QXmppPubSubBaseItem &&) = default;
+QXmppPubSubBaseItem::~QXmppPubSubBaseItem() = default;
 /// Default assignment operator
-QXmppPubSubItem &QXmppPubSubItem::operator=(const QXmppPubSubItem &iq) = default;
+QXmppPubSubBaseItem &QXmppPubSubBaseItem::operator=(const QXmppPubSubBaseItem &iq) = default;
 /// Default move-assignment operator
-QXmppPubSubItem &QXmppPubSubItem::operator=(QXmppPubSubItem &&iq) = default;
+QXmppPubSubBaseItem &QXmppPubSubBaseItem::operator=(QXmppPubSubBaseItem &&iq) = default;
 
 ///
 /// Returns the ID of the PubSub item.
 ///
-QString QXmppPubSubItem::id() const
+QString QXmppPubSubBaseItem::id() const
 {
     return d->id;
 }
@@ -82,7 +82,7 @@ QString QXmppPubSubItem::id() const
 ///
 /// \param id
 ///
-void QXmppPubSubItem::setId(const QString &id)
+void QXmppPubSubBaseItem::setId(const QString &id)
 {
     d->id = id;
 }
@@ -90,7 +90,7 @@ void QXmppPubSubItem::setId(const QString &id)
 ///
 /// Returns the JID of the publisher of the item.
 ///
-QString QXmppPubSubItem::publisher() const
+QString QXmppPubSubBaseItem::publisher() const
 {
     return d->publisher;
 }
@@ -98,13 +98,13 @@ QString QXmppPubSubItem::publisher() const
 ///
 /// Sets the JID of the publisher of the item.
 ///
-void QXmppPubSubItem::setPublisher(const QString &publisher)
+void QXmppPubSubBaseItem::setPublisher(const QString &publisher)
 {
     d->publisher = publisher;
 }
 
 /// \cond
-void QXmppPubSubItem::parse(const QDomElement &element)
+void QXmppPubSubBaseItem::parse(const QDomElement &element)
 {
     d->id = element.attribute(QStringLiteral("id"));
     d->publisher = element.attribute(QStringLiteral("publisher"));
@@ -112,7 +112,7 @@ void QXmppPubSubItem::parse(const QDomElement &element)
     parsePayload(element.firstChildElement());
 }
 
-void QXmppPubSubItem::toXml(QXmlStreamWriter *writer) const
+void QXmppPubSubBaseItem::toXml(QXmlStreamWriter *writer) const
 {
     writer->writeStartElement(QStringLiteral("item"));
     helperToXmlAddAttribute(writer, QStringLiteral("id"), d->id);
@@ -127,7 +127,7 @@ void QXmppPubSubItem::toXml(QXmlStreamWriter *writer) const
 ///
 /// Returns true, if the element is possibly a PubSub item.
 ///
-bool QXmppPubSubItem::isItem(const QDomElement &element)
+bool QXmppPubSubBaseItem::isItem(const QDomElement &element)
 {
     return element.tagName() == QStringLiteral("item");
 }
@@ -137,7 +137,7 @@ bool QXmppPubSubItem::isItem(const QDomElement &element)
 ///
 /// This method needs to be overriden to perform the payload-specific parsing.
 ///
-void QXmppPubSubItem::parsePayload(const QDomElement &)
+void QXmppPubSubBaseItem::parsePayload(const QDomElement &)
 {
 }
 
@@ -147,6 +147,6 @@ void QXmppPubSubItem::parsePayload(const QDomElement &)
 /// This method needs to be overriden to perform the payload-specific
 /// serialization.
 ///
-void QXmppPubSubItem::serializePayload(QXmlStreamWriter *) const
+void QXmppPubSubBaseItem::serializePayload(QXmlStreamWriter *) const
 {
 }
diff --git a/src/base/QXmppPubSubItem.h b/src/base/QXmppPubSubBaseItem.h
index e585de9d..20702662 100644
--- a/src/base/QXmppPubSubItem.h
+++ b/src/base/QXmppPubSubBaseItem.h
@@ -3,8 +3,7 @@
 //
 // SPDX-License-Identifier: LGPL-2.1-or-later
 
-#ifndef QXMPPPUBSUBITEM_H
-#define QXMPPPUBSUBITEM_H
+#pragma once
 
 #include "QXmppGlobal.h"
 
@@ -13,18 +12,18 @@
 #include <QSharedDataPointer>
 
 class QXmlStreamWriter;
-class QXmppPubSubItemPrivate;
+class QXmppPubSubBaseItemPrivate;
 
-class QXMPP_EXPORT QXmppPubSubItem
+class QXMPP_EXPORT QXmppPubSubBaseItem
 {
 public:
-    QXmppPubSubItem(const QString &id = {}, const QString &publisher = {});
-    QXmppPubSubItem(const QXmppPubSubItem &);
-    QXmppPubSubItem(QXmppPubSubItem &&);
-    virtual ~QXmppPubSubItem();
+    QXmppPubSubBaseItem(const QString &id = {}, const QString &publisher = {});
+    QXmppPubSubBaseItem(const QXmppPubSubBaseItem &);
+    QXmppPubSubBaseItem(QXmppPubSubBaseItem &&);
+    virtual ~QXmppPubSubBaseItem();
 
-    QXmppPubSubItem &operator=(const QXmppPubSubItem &);
-    QXmppPubSubItem &operator=(QXmppPubSubItem &&);
+    QXmppPubSubBaseItem &operator=(const QXmppPubSubBaseItem &);
+    QXmppPubSubBaseItem &operator=(QXmppPubSubBaseItem &&);
 
     QString id() const;
     void setId(const QString &id);
@@ -47,7 +46,7 @@ protected:
     static bool isItem(const QDomElement &element, PayloadChecker isPayloadValid);
 
 private:
-    QSharedDataPointer<QXmppPubSubItemPrivate> d;
+    QSharedDataPointer<QXmppPubSubBaseItemPrivate> d;
 };
 
 ///
@@ -70,7 +69,7 @@ private:
 /// \endcode
 ///
 template<typename PayloadChecker>
-bool QXmppPubSubItem::isItem(const QDomElement &element, PayloadChecker isPayloadValid)
+bool QXmppPubSubBaseItem::isItem(const QDomElement &element, PayloadChecker isPayloadValid)
 {
     if (!isItem(element)) {
         return false;
@@ -85,6 +84,4 @@ bool QXmppPubSubItem::isItem(const QDomElement &element, PayloadChecker isPayloa
     return true;
 }
 
-Q_DECLARE_METATYPE(QXmppPubSubItem)
-
-#endif  // QXMPPPUBSUBITEM_H
+Q_DECLARE_METATYPE(QXmppPubSubBaseItem)
diff --git a/src/base/QXmppPubSubEvent.h b/src/base/QXmppPubSubEvent.h
index 0faf62b6..3625c8aa 100644
--- a/src/base/QXmppPubSubEvent.h
+++ b/src/base/QXmppPubSubEvent.h
@@ -15,7 +15,7 @@
 
 class QXmppDataForm;
 class QXmppPubSubEventPrivate;
-class QXmppPubSubItem;
+class QXmppPubSubBaseItem;
 
 class QXMPP_EXPORT QXmppPubSubEventBase : public QXmppMessage
 {
@@ -73,7 +73,7 @@ private:
     QSharedDataPointer<QXmppPubSubEventPrivate> d;
 };
 
-template<typename T = QXmppPubSubItem>
+template<typename T = QXmppPubSubBaseItem>
 class QXmppPubSubEvent : public QXmppPubSubEventBase
 {
 public:
diff --git a/src/base/QXmppPubSubIq_p.h b/src/base/QXmppPubSubIq_p.h
index eb5ed43f..6868eb84 100644
--- a/src/base/QXmppPubSubIq_p.h
+++ b/src/base/QXmppPubSubIq_p.h
@@ -15,7 +15,7 @@
 
 class QXmppDataForm;
 class QXmppPubSubIqPrivate;
-class QXmppPubSubItem;
+class QXmppPubSubBaseItem;
 class QXmppPubSubSubscription;
 class QXmppPubSubAffiliation;
 class QXmppResultSetReply;
@@ -103,7 +103,7 @@ private:
     QSharedDataPointer<QXmppPubSubIqPrivate> d;
 };
 
-template<typename T = QXmppPubSubItem>
+template<typename T = QXmppPubSubBaseItem>
 class PubSubIq : public PubSubIqBase
 {
 public:
diff --git a/src/base/QXmppUserTuneItem.cpp b/src/base/QXmppUserTuneItem.cpp
index 6d8fb8bf..55d30333 100644
--- a/src/base/QXmppUserTuneItem.cpp
+++ b/src/base/QXmppUserTuneItem.cpp
@@ -224,7 +224,7 @@ bool QXmppTuneItem::isItem(const QDomElement &itemElement)
             payload.namespaceURI() == ns_tune;
     };
 
-    return QXmppPubSubItem::isItem(itemElement, isPayloadValid);
+    return QXmppPubSubBaseItem::isItem(itemElement, isPayloadValid);
 }
 
 /// \cond
diff --git a/src/base/QXmppUserTuneItem.h b/src/base/QXmppUserTuneItem.h
index 03bafb1e..c4b1f0a8 100644
--- a/src/base/QXmppUserTuneItem.h
+++ b/src/base/QXmppUserTuneItem.h
@@ -5,7 +5,7 @@
 #ifndef QXMPPUSERTUNEITEM_H
 #define QXMPPUSERTUNEITEM_H
 
-#include "QXmppPubSubItem.h"
+#include "QXmppPubSubBaseItem.h"
 
 #include <chrono>
 #include <optional>
@@ -16,7 +16,7 @@
 class QXmppTuneItemPrivate;
 class QUrl;
 
-class QXMPP_EXPORT QXmppTuneItem : public QXmppPubSubItem
+class QXMPP_EXPORT QXmppTuneItem : public QXmppPubSubBaseItem
 {
 public:
     QXmppTuneItem();