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