Uri.h

Go to the documentation of this file.

/*

Copyright (C) 2006-2007 by Peter Dimov.

This file is part of Calitko (http://www.calitko.org).

Calitko is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

Calitko is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Calitko; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

*/

#ifndef UTILS__URI_H
#define UTILS__URI_H

namespace Utils {


class Uri
{
public:
    VALUE_OBJECT (Uri)

public:
    typedef QPair <QByteArray, QByteArray>  QueryItem;
    typedef QList <QueryItem>               QueryItemList;

    enum Field
    {
        Scheme          = 0x01,
        UserInfo        = 0x02,
        Host            = 0x04,
        Port            = 0x08,
        Authority       = UserInfo | Host | Port,
        Path            = 0x10,
        Query           = 0x20,
        Fragment        = 0x40,
        AllFields       = Scheme | Authority | Path | Query | Fragment
    };
    Q_DECLARE_FLAGS (Fields, Field);

                        Uri();
    QByteArray          scheme() const;
    QByteArray          userInfo() const;
    QByteArray          host() const;
    QByteArray          port() const;
    QByteArray          authority() const;
    QByteArray          path() const;
    QByteArray          query() const;
    QByteArray          queryItemValue (const QByteArray &key) const;
    QueryItemList       queryItems() const;
    QByteArray          fragment() const;

    QByteArray          unencoded (Fields fields = AllFields) const;
    QByteArray          encoded (Fields fields = AllFields) const;

    void                setScheme (const QByteArray &);
    void                setAuthority (const QByteArray &);
    void                setAuthority (const QByteArray &userInfo,
                                      const QByteArray &host,
                                      const QByteArray &port);
    void                setPath (const QByteArray &);
    void                setQuery (const QByteArray &);
    void                appendQuery (const QByteArray &bytes);
    void                appendQueryItem (const QByteArray &key,
                                         const QByteArray &value);
    void                appendQueryItem (const QueryItem &item);
    void                appendQueryItems (const QueryItemList &itemList);
    void                setFragment (const QByteArray &);

    static Uri          fromUnencoded (const QByteArray &);
    static Uri          fromEncoded (const QByteArray &);

private:
    QByteArray          toQByteArray (Fields fields, bool encode) const;
    static QByteArray   doEncode (const QByteArray &bytes, bool encode,
                                  const QByteArray &charsToExclude);
    static bool         shouldEncode (char ch,
                                      const QByteArray &charsToExclude);
    static char         hex (char);
    static QByteArray   quoted (char);
    bool                parse (const QByteArray &bytes, bool decode);
    bool                parseAuthority (const QByteArray &authority,
                                        bool decode);
    static bool         doDecode (QByteArray &bytes, bool decode);
    static bool         fromHex (char &);
    static char         unquoted (char hex1, char hex2);
    static void         ensureNotNull (QByteArray &bytes);

    static const QByteArray     UserInfoEncodeExcludeChars;
    static const QByteArray     HostEncodeExcludeChars;
    static const QByteArray     PathEncodeExcludeChars;
    static const QByteArray     QueryEncodeExcludeChars;
    static const QByteArray     QueryItemEncodeExcludeChars;
    static const QByteArray     FragmentEncodeExcludeChars;

    struct PrivateData : public QSharedData
    {
        QByteArray      scheme;
        QByteArray      userInfo;
        QByteArray      host;
        QByteArray      port;
        QByteArray      path;
        QByteArray      query;
        QByteArray      fragment;
    };

    QSharedDataPointer <PrivateData> d; 
};

uint qHash (const Uri &);

Q_DECLARE_OPERATORS_FOR_FLAGS (Uri::Fields)


inline QByteArray Uri::scheme() const
{ return d->scheme; }

inline QByteArray Uri::userInfo() const
{ return d->userInfo; }

inline QByteArray Uri::host() const
{ return d->host; }

inline QByteArray Uri::port() const
{ return d->port; }

inline QByteArray Uri::path() const
{ return d->path; }

inline QByteArray Uri::fragment() const
{ return d->fragment; }

inline void Uri::setScheme (const QByteArray &scheme)
{ d->scheme = scheme; }

inline void Uri::setPath (const QByteArray &path)
{ d->path = path; }

inline void Uri::setFragment (const QByteArray &fragment)
{ d->fragment = fragment; }

} // namespace Utils

#endif // UTILS__URI_H

Copyright © 2006 Peter Dimov.
Powered by Doxygen.