YiUrl.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_URL_H_
#define _YI_URL_H_

#include "framework/YiPredef.h"
#include "utility/YiString.h"

class CYIUrlQuery;

class CYIUrl
{
public:
    enum PARTS
    {
        SCHEME = 0x1,
        USERNAME = 0x2,
        PASSWORD = 0x4,
        HOST = 0x8,
        PORT = 0x10,
        PATH = 0x20,
        QUERY = 0x40,
        FRAGMENT = 0x80,
        AUTHENTICATION = USERNAME | PASSWORD,
        AUTHORITY = AUTHENTICATION | HOST | PORT,
        AUTHORITY_AND_PATH = AUTHORITY | PATH,
        EVERYTHING = SCHEME | AUTHORITY_AND_PATH | QUERY | FRAGMENT,
        NO_SCHEME = EVERYTHING & (~SCHEME),
        NO_AUTHENTICATION = EVERYTHING & (~AUTHENTICATION)
    };

    enum ENCODING
    {
        ENCODED,
        DECODED
    };

    static const CYIUrl &EmptyUrl();

    CYIUrl();

    explicit CYIUrl(const CYIString &url, ENCODING eEncoding = ENCODED);


    bool operator==(const CYIUrl &other) const;
    bool operator!=(const CYIUrl &other) const;
    bool operator<(const CYIUrl &other) const;


    void SetScheme(const CYIString &scheme);

    void SetAuthority(const CYIString &authority, ENCODING eEncoding = DECODED);

    void SetAuthentication(const CYIString &authentication, ENCODING eEncoding = DECODED);

    void SetUsername(const CYIString &username, ENCODING eEncoding = DECODED);

    void SetPassword(const CYIString &password, ENCODING eEncoding = DECODED);

    void SetHost(const CYIString &host, ENCODING eEncoding = DECODED);

    void SetPort(int32_t nPort);

    void SetPort(const CYIString &port);

    void SetPath(const CYIString &path, CYIUrl::ENCODING eEncoding = DECODED);

    void SetQuery(const CYIString &query, CYIUrl::ENCODING eEncoding = DECODED);

    void SetQuery(const CYIUrlQuery &query);

    void SetFragment(const CYIString &fragment, CYIUrl::ENCODING eEncoding = DECODED);

    void SetString(const CYIString &url, ENCODING eEncoding = ENCODED);


    const CYIString &GetScheme() const;

    CYIString GetAuthority(ENCODING eEncoding = DECODED) const;

    CYIString GetAuthentication(ENCODING eEncoding = DECODED) const;

    CYIString GetUsername(ENCODING eEncoding = DECODED) const;

    CYIString GetPassword(ENCODING eEncoding = DECODED) const;

    CYIString GetHost(ENCODING eEncoding = DECODED) const;

    int32_t GetPort() const;

    const CYIString &GetPortString() const;


    CYIString GetPath(ENCODING eEncoding = DECODED) const;

    CYIString GetQuery(ENCODING eEncoding = DECODED) const;


    CYIString GetFragment(ENCODING eEncoding = DECODED) const;

    CYIUrlQuery GetQueryBuilder() const;

    CYIString ToString(PARTS eParts = EVERYTHING, ENCODING eEncoding = ENCODED) const;

    bool IsEmpty() const;


    void Clear();

    static CYIString Encode(const CYIString &input);

    static CYIString Decode(const CYIString &input);

private:
    CYIString m_scheme;

    CYIString m_username;
    CYIString m_password;
    CYIString m_host;
    CYIString m_port;

    CYIString m_path;
    CYIString m_query;
    CYIString m_fragment;
};

std::ostream &operator<<(std::ostream &stream, const CYIUrl &val);

#endif