1// Copyright (C) 2017 Lorenz Haas
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QMQTTTOPICFILTER_H
6#define QMQTTTOPICFILTER_H
7
8#include <QtMqtt/qmqttglobal.h>
9#include <QtMqtt/qmqtttopicname.h>
10
11#include <QtCore/QExplicitlySharedDataPointer>
12#include <QtCore/QMetaType>
13#include <QtCore/QString>
14
15QT_BEGIN_NAMESPACE
16
17class QMqttTopicFilterPrivate;
18
19class QMqttTopicFilter;
20// qHash is a friend, but we can't use default arguments for friends (ยง8.3.6.4)
21Q_MQTT_EXPORT size_t qHash(const QMqttTopicFilter &name, size_t seed = 0) Q_DECL_NOTHROW;
22
23class Q_MQTT_EXPORT QMqttTopicFilter
24{
25public:
26 enum MatchOption {
27 NoMatchOption = 0x0000,
28 WildcardsDontMatchDollarTopicMatchOption = 0x0001
29 };
30 Q_DECLARE_FLAGS(MatchOptions, MatchOption)
31
32 QMqttTopicFilter(const QString &filter = QString());
33 QMqttTopicFilter(const QLatin1String &filter);
34 QMqttTopicFilter(const QMqttTopicFilter &filter);
35 ~QMqttTopicFilter();
36 QMqttTopicFilter &operator=(const QMqttTopicFilter &filter);
37
38#ifdef Q_COMPILER_RVALUE_REFS
39 QMqttTopicFilter &operator=(QMqttTopicFilter &&other) noexcept { swap(other); return *this; }
40#endif
41
42 void swap(QMqttTopicFilter &other) noexcept { d.swap(other&: other.d); }
43
44 QString filter() const;
45 void setFilter(const QString &filter);
46
47 QString sharedSubscriptionName() const;
48
49 Q_REQUIRED_RESULT bool isValid() const;
50 Q_REQUIRED_RESULT bool match(const QMqttTopicName &name, MatchOptions matchOptions = NoMatchOption) const;
51
52 friend Q_MQTT_EXPORT bool operator==(const QMqttTopicFilter &lhs, const QMqttTopicFilter &rhs) Q_DECL_NOTHROW;
53 friend inline bool operator!=(const QMqttTopicFilter &lhs, const QMqttTopicFilter &rhs) Q_DECL_NOTHROW { return !(lhs == rhs); }
54 friend Q_MQTT_EXPORT bool operator<(const QMqttTopicFilter &lhs, const QMqttTopicFilter &rhs) Q_DECL_NOTHROW;
55 friend Q_MQTT_EXPORT size_t qHash(const QMqttTopicFilter &filter, size_t seed) Q_DECL_NOTHROW;
56
57private:
58 QExplicitlySharedDataPointer<QMqttTopicFilterPrivate> d;
59};
60
61Q_DECLARE_SHARED(QMqttTopicFilter)
62Q_DECLARE_OPERATORS_FOR_FLAGS(QMqttTopicFilter::MatchOptions)
63
64#ifndef QT_NO_DATASTREAM
65Q_MQTT_EXPORT QDataStream &operator<<(QDataStream &, const QMqttTopicFilter &);
66Q_MQTT_EXPORT QDataStream &operator>>(QDataStream &, QMqttTopicFilter &);
67#endif
68
69#ifndef QT_NO_DEBUG_STREAM
70Q_MQTT_EXPORT QDebug operator<<(QDebug, const QMqttTopicFilter &);
71#endif
72
73QT_END_NAMESPACE
74
75Q_DECLARE_METATYPE(QMqttTopicFilter)
76
77#endif // QMQTTTOPICFILTER_H
78

source code of qtmqtt/src/mqtt/qmqtttopicfilter.h