include/QtCore/qurlquery.h

0001 // Copyright (C) 2020 The Qt Company Ltd.
0002 // Copyright (C) 2016 Intel Corporation.
0003 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0004
0005 #ifndef QURLQUERY_H
0006 #define QURLQUERY_H
0007
0008 #include <QtCore/qcompare.h>
0009 #include <QtCore/qshareddata.h>
0010 #include <QtCore/qurl.h>
0011
0012 #include <initializer_list>
0013
0014 QT_BEGIN_NAMESPACE
0015
0016 Q_CORE_EXPORT size_t qHash(const QUrlQuery &key, size_t seed = 0) noexcept;
0017
0018 class QUrlQueryPrivate;
0019 class Q_CORE_EXPORT QUrlQuery
0020 {
0021 public:
0022     QUrlQuery();
0023     explicit QUrlQuery(const QUrl &url);
0024     explicit QUrlQuery(const QString &queryString);
0025     QUrlQuery(std::initializer_list<std::pair<QString, QString>> list)
0026         : QUrlQuery()
0027     {
0028         for (const std::pair<QString, QString> &item : list)
0029             addQueryItem(item.first, item.second);
0030     }
0031
0032     QUrlQuery(const QUrlQuery &other);
0033     QUrlQuery(QUrlQuery &&other) noexcept;
0034     QUrlQuery &operator=(const QUrlQuery &other);
0035     QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QUrlQuery)
0036     ~QUrlQuery();
0037
0038 #if QT_CORE_REMOVED_SINCE(6, 8)
0039     bool operator==(const QUrlQuery &other) const;
0040     bool operator!=(const QUrlQuery &other) const
0041     { return !operator==(other); }
0042 #endif
0043
0044     void swap(QUrlQuery &other) noexcept { d.swap(other.d); }
0045
0046     bool isEmpty() const;
0047     bool isDetached() const;
0048     void clear();
0049
0050     QString query(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const;
0051     void setQuery(const QString &queryString);
0052     QString toString(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const
0053     { return query(encoding); }
0054
0055     void setQueryDelimiters(QChar valueDelimiter, QChar pairDelimiter);
0056     QChar queryValueDelimiter() const;
0057     QChar queryPairDelimiter() const;
0058
0059     void setQueryItems(const QList<std::pair<QString, QString> > &query);
0060     QList<std::pair<QString, QString> > queryItems(QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const;
0061
0062     bool hasQueryItem(const QString &key) const;
0063     void addQueryItem(const QString &key, const QString &value);
0064     void removeQueryItem(const QString &key);
0065     QString queryItemValue(const QString &key, QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const;
0066     QStringList allQueryItemValues(const QString &key, QUrl::ComponentFormattingOptions encoding = QUrl::PrettyDecoded) const;
0067     void removeAllQueryItems(const QString &key);
0068
0069     static constexpr char16_t defaultQueryValueDelimiter() noexcept { return u'='; }
0070     static constexpr char16_t defaultQueryPairDelimiter() noexcept { return u'&'; }
0071
0072 private:
0073     friend Q_CORE_EXPORT bool comparesEqual(const QUrlQuery &lhs, const QUrlQuery &rhs);
0074     Q_DECLARE_EQUALITY_COMPARABLE_NON_NOEXCEPT(QUrlQuery)
0075     friend class QUrl;
0076     friend Q_CORE_EXPORT size_t qHash(const QUrlQuery &key, size_t seed) noexcept;
0077     QSharedDataPointer<QUrlQueryPrivate> d;
0078
0079 public:
0080     typedef QSharedDataPointer<QUrlQueryPrivate> DataPtr;
0081     inline DataPtr &data_ptr() { return d; }
0082 };
0083
0084 Q_DECLARE_SHARED(QUrlQuery)
0085
0086 QT_END_NAMESPACE
0087
0088 #endif // QURLQUERY_H