You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
289 lines
9.8 KiB
289 lines
9.8 KiB
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
|
** All rights reserved.
|
|
** Contact: Nokia Corporation (qt-info@nokia.com)
|
|
**
|
|
** This file is part of the QtCore module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** Commercial Usage
|
|
** Licensees holding valid Qt Commercial licenses may use this file in
|
|
** accordance with the Qt Commercial License Agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and Nokia.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 2.1 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 2.1 requirements
|
|
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|
**
|
|
** In addition, as a special exception, Nokia gives you certain additional
|
|
** rights. These rights are described in the Nokia Qt LGPL Exception
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3.0 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.GPL included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU General Public License version 3.0 requirements will be
|
|
** met: http://www.gnu.org/copyleft/gpl.html.
|
|
**
|
|
** If you have questions regarding the use of this file, please contact
|
|
** Nokia at qt-info@nokia.com.
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef QURL_H
|
|
#define QURL_H
|
|
|
|
#include <QtCore/qbytearray.h>
|
|
#include <QtCore/qobjectdefs.h>
|
|
#include <QtCore/qpair.h>
|
|
#include <QtCore/qstring.h>
|
|
|
|
QT_BEGIN_HEADER
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
QT_MODULE(Core)
|
|
|
|
class QUrlPrivate;
|
|
class QDataStream;
|
|
|
|
class Q_CORE_EXPORT QUrl
|
|
{
|
|
public:
|
|
enum ParsingMode {
|
|
TolerantMode,
|
|
StrictMode
|
|
};
|
|
|
|
// encoding / toString values
|
|
enum FormattingOption {
|
|
None = 0x0,
|
|
RemoveScheme = 0x1,
|
|
RemovePassword = 0x2,
|
|
RemoveUserInfo = RemovePassword | 0x4,
|
|
RemovePort = 0x8,
|
|
RemoveAuthority = RemoveUserInfo | RemovePort | 0x10,
|
|
RemovePath = 0x20,
|
|
RemoveQuery = 0x40,
|
|
RemoveFragment = 0x80,
|
|
|
|
StripTrailingSlash = 0x10000
|
|
};
|
|
Q_DECLARE_FLAGS(FormattingOptions, FormattingOption)
|
|
|
|
QUrl();
|
|
#ifdef QT_NO_URL_CAST_FROM_STRING
|
|
explicit
|
|
#endif
|
|
QUrl(const QString &url);
|
|
QUrl(const QString &url, ParsingMode mode);
|
|
// ### Qt 5: merge the two constructors, with mode = TolerantMode
|
|
QUrl(const QUrl ©);
|
|
QUrl &operator =(const QUrl ©);
|
|
#ifndef QT_NO_URL_CAST_FROM_STRING
|
|
QUrl &operator =(const QString &url);
|
|
#endif
|
|
~QUrl();
|
|
|
|
void setUrl(const QString &url);
|
|
void setUrl(const QString &url, ParsingMode mode);
|
|
// ### Qt 5: merge the two setUrl() functions, with mode = TolerantMode
|
|
void setEncodedUrl(const QByteArray &url);
|
|
void setEncodedUrl(const QByteArray &url, ParsingMode mode);
|
|
// ### Qt 5: merge the two setEncodedUrl() functions, with mode = TolerantMode
|
|
|
|
bool isValid() const;
|
|
|
|
bool isEmpty() const;
|
|
|
|
void clear();
|
|
|
|
void setScheme(const QString &scheme);
|
|
QString scheme() const;
|
|
|
|
void setAuthority(const QString &authority);
|
|
QString authority() const;
|
|
|
|
void setUserInfo(const QString &userInfo);
|
|
QString userInfo() const;
|
|
|
|
void setUserName(const QString &userName);
|
|
QString userName() const;
|
|
void setEncodedUserName(const QByteArray &userName);
|
|
QByteArray encodedUserName() const;
|
|
|
|
void setPassword(const QString &password);
|
|
QString password() const;
|
|
void setEncodedPassword(const QByteArray &password);
|
|
QByteArray encodedPassword() const;
|
|
|
|
void setHost(const QString &host);
|
|
QString host() const;
|
|
void setEncodedHost(const QByteArray &host);
|
|
QByteArray encodedHost() const;
|
|
|
|
void setPort(int port);
|
|
int port() const;
|
|
int port(int defaultPort) const;
|
|
// ### Qt 5: merge the two port() functions, with defaultPort = -1
|
|
|
|
void setPath(const QString &path);
|
|
QString path() const;
|
|
void setEncodedPath(const QByteArray &path);
|
|
QByteArray encodedPath() const;
|
|
|
|
bool hasQuery() const;
|
|
|
|
void setEncodedQuery(const QByteArray &query);
|
|
QByteArray encodedQuery() const;
|
|
|
|
void setQueryDelimiters(char valueDelimiter, char pairDelimiter);
|
|
char queryValueDelimiter() const;
|
|
char queryPairDelimiter() const;
|
|
|
|
void setQueryItems(const QList<QPair<QString, QString> > &query);
|
|
void addQueryItem(const QString &key, const QString &value);
|
|
QList<QPair<QString, QString> > queryItems() const;
|
|
bool hasQueryItem(const QString &key) const;
|
|
QString queryItemValue(const QString &key) const;
|
|
QStringList allQueryItemValues(const QString &key) const;
|
|
void removeQueryItem(const QString &key);
|
|
void removeAllQueryItems(const QString &key);
|
|
|
|
void setEncodedQueryItems(const QList<QPair<QByteArray, QByteArray> > &query);
|
|
void addEncodedQueryItem(const QByteArray &key, const QByteArray &value);
|
|
QList<QPair<QByteArray, QByteArray> > encodedQueryItems() const;
|
|
bool hasEncodedQueryItem(const QByteArray &key) const;
|
|
QByteArray encodedQueryItemValue(const QByteArray &key) const;
|
|
QList<QByteArray> allEncodedQueryItemValues(const QByteArray &key) const;
|
|
void removeEncodedQueryItem(const QByteArray &key);
|
|
void removeAllEncodedQueryItems(const QByteArray &key);
|
|
|
|
void setFragment(const QString &fragment);
|
|
QString fragment() const;
|
|
void setEncodedFragment(const QByteArray &fragment);
|
|
QByteArray encodedFragment() const;
|
|
bool hasFragment() const;
|
|
|
|
QUrl resolved(const QUrl &relative) const;
|
|
|
|
bool isRelative() const;
|
|
bool isParentOf(const QUrl &url) const;
|
|
|
|
static QUrl fromLocalFile(const QString &localfile);
|
|
QString toLocalFile() const;
|
|
|
|
QString toString(FormattingOptions options = None) const;
|
|
|
|
QByteArray toEncoded(FormattingOptions options = None) const;
|
|
static QUrl fromEncoded(const QByteArray &url);
|
|
static QUrl fromEncoded(const QByteArray &url, ParsingMode mode);
|
|
// ### Qt 5: merge the two fromEncoded() functions, with mode = TolerantMode
|
|
|
|
static QUrl fromUserInput(const QString &userInput);
|
|
|
|
void detach();
|
|
bool isDetached() const;
|
|
|
|
bool operator <(const QUrl &url) const;
|
|
bool operator ==(const QUrl &url) const;
|
|
bool operator !=(const QUrl &url) const;
|
|
|
|
static QString fromPercentEncoding(const QByteArray &);
|
|
static QByteArray toPercentEncoding(const QString &,
|
|
const QByteArray &exclude = QByteArray(),
|
|
const QByteArray &include = QByteArray());
|
|
static QString fromPunycode(const QByteArray &);
|
|
static QByteArray toPunycode(const QString &);
|
|
static QString fromAce(const QByteArray &);
|
|
static QByteArray toAce(const QString &);
|
|
static QStringList idnWhitelist();
|
|
static void setIdnWhitelist(const QStringList &);
|
|
|
|
#if defined QT3_SUPPORT
|
|
inline QT3_SUPPORT QString protocol() const { return scheme(); }
|
|
inline QT3_SUPPORT void setProtocol(const QString &s) { setScheme(s); }
|
|
inline QT3_SUPPORT void setUser(const QString &s) { setUserName(s); }
|
|
inline QT3_SUPPORT QString user() const { return userName(); }
|
|
inline QT3_SUPPORT bool hasUser() const { return !userName().isEmpty(); }
|
|
inline QT3_SUPPORT bool hasPassword() const { return !password().isEmpty(); }
|
|
inline QT3_SUPPORT bool hasHost() const { return !host().isEmpty(); }
|
|
inline QT3_SUPPORT bool hasPort() const { return port() != -1; }
|
|
inline QT3_SUPPORT bool hasPath() const { return !path().isEmpty(); }
|
|
inline QT3_SUPPORT void setQuery(const QString &txt)
|
|
{
|
|
setEncodedQuery(txt.toLatin1());
|
|
}
|
|
inline QT3_SUPPORT QString query() const
|
|
{
|
|
return QString::fromLatin1(encodedQuery().constData());
|
|
}
|
|
inline QT3_SUPPORT QString ref() const { return fragment(); }
|
|
inline QT3_SUPPORT void setRef(const QString &txt) { setFragment(txt); }
|
|
inline QT3_SUPPORT bool hasRef() const { return !fragment().isEmpty(); }
|
|
inline QT3_SUPPORT void addPath(const QString &p) { setPath(path() + QLatin1Char('/') + p); }
|
|
QT3_SUPPORT void setFileName(const QString &txt);
|
|
QT3_SUPPORT QString fileName() const;
|
|
QT3_SUPPORT QString dirPath() const;
|
|
static inline QT3_SUPPORT void decode(QString &url)
|
|
{
|
|
url = QUrl::fromPercentEncoding(url.toLatin1());
|
|
}
|
|
static inline QT3_SUPPORT void encode(QString &url)
|
|
{
|
|
url = QString::fromLatin1(QUrl::toPercentEncoding(url).constData());
|
|
}
|
|
inline QT3_SUPPORT operator QString() const { return toString(); }
|
|
inline QT3_SUPPORT bool cdUp()
|
|
{
|
|
*this = resolved(QUrl(QLatin1String("..")));
|
|
return true;
|
|
}
|
|
static inline QT3_SUPPORT bool isRelativeUrl(const QString &url)
|
|
{
|
|
return QUrl(url).isRelative();
|
|
}
|
|
#endif
|
|
|
|
QString errorString() const;
|
|
|
|
protected:
|
|
#if defined (QT3_SUPPORT)
|
|
inline QT3_SUPPORT void reset() { clear(); }
|
|
#endif
|
|
|
|
private:
|
|
QUrlPrivate *d;
|
|
public:
|
|
typedef QUrlPrivate * DataPtr;
|
|
inline DataPtr &data_ptr() { return d; }
|
|
};
|
|
|
|
Q_DECLARE_TYPEINFO(QUrl, Q_MOVABLE_TYPE);
|
|
Q_DECLARE_SHARED(QUrl)
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(QUrl::FormattingOptions)
|
|
|
|
#ifndef QT_NO_DATASTREAM
|
|
Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QUrl &);
|
|
Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QUrl &);
|
|
#endif
|
|
|
|
#ifndef QT_NO_DEBUG_STREAM
|
|
Q_CORE_EXPORT QDebug operator<<(QDebug, const QUrl &);
|
|
#endif
|
|
|
|
QT_END_NAMESPACE
|
|
|
|
QT_END_HEADER
|
|
|
|
#endif // QURL_H
|