uri.h

/* Copyright (c) 2013-2014, ahmet.bilgili@epfl.ch
 *                    2014, Stefan.Eilemann@epfl.ch
 *
 * This file is part of Servus <https://github.com/HBPVIS/Servus>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef SERVUS_URI_H
#define SERVUS_URI_H

#include <servus/api.h>
#include <servus/types.h>

#include <map>
#include <sstream>

namespace servus
{
namespace detail { class URI; }

class URI
{
public:
    typedef std::map< std::string, std::string > KVMap;
    typedef KVMap::const_iterator ConstKVIter;

    SERVUS_API URI();

    SERVUS_API explicit URI( const std::string& uri );

    SERVUS_API explicit URI( const char* uri );

    SERVUS_API URI( const URI& from );

    SERVUS_API ~URI();

    SERVUS_API URI& operator = ( const URI& rhs );

    SERVUS_API bool operator == ( const URI& rhs ) const;

    SERVUS_API bool operator != ( const URI& rhs ) const;

    SERVUS_API const std::string& getScheme() const;
    SERVUS_API const std::string& getUserinfo() const;
    SERVUS_API uint16_t getPort() const;
    SERVUS_API const std::string& getHost() const;
    SERVUS_API std::string getAuthority() const;
    SERVUS_API const std::string& getPath() const;
    SERVUS_API const std::string& getQuery() const;
    SERVUS_API const std::string& getFragment() const;

    SERVUS_API void setScheme( const std::string& scheme );
    SERVUS_API void setUserInfo( const std::string& userinfo );
    SERVUS_API void setHost( const std::string& host );
    SERVUS_API void setPort( uint16_t port );
    SERVUS_API void setPath( const std::string& path );
    SERVUS_API void setQuery( const std::string& query );
    SERVUS_API void setFragment( const std::string& fragment );

    SERVUS_API ConstKVIter queryBegin() const;

    SERVUS_API ConstKVIter queryEnd() const;

    SERVUS_API ConstKVIter findQuery( const std::string& key ) const;

    SERVUS_API void addQuery( const std::string& key,
                              const std::string& value );

private:
    detail::URI* const _impl;
};

inline std::ostream& operator << ( std::ostream& os, const URI& uri )
{
    if( !uri.getScheme().empty( ))
        os << uri.getScheme() << "://";
    // A valid URI can't contain the user info or port number alone, so if
    // the host name is empty the other two field are simply ignored.
    if( !uri.getHost().empty( ))
    {
        if( !uri.getUserinfo().empty( ))
            os << uri.getUserinfo() << "@";
        os << uri.getHost();
        if( uri.getPort( ))
            os << ':' << uri.getPort();
    }
    os << uri.getPath();
    if( !uri.getQuery().empty( ))
        os << '?' << uri.getQuery();
    if( !uri.getFragment().empty( ))
        os << '#' << uri.getFragment();
    return os;
}
}

namespace std
{
inline std::string to_string( const servus::URI& uri )
{
    ostringstream os;
    os << uri;
    return os.str();
}
}
#endif // SERVUS_URI_H