url.hpp

Go to the documentation of this file.

//  Copyright (c) 2005-2011 Hartmut Kaiser
//  Copyright (c) 2007 Ole Weidner (oweidner@cct.lsu.edu)
// 
//  Distributed under the Boost Software License, Version 1.0. (See accompanying 
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#include <string>
#include <iosfwd>

#include <saga/saga/util.hpp>
#include <saga/saga/base.hpp>
#include <saga/saga/call.hpp>

#include <saga/saga/object.hpp>
#include <saga/saga/session.hpp>

#if !defined(SAGA_SAGA_URL_HPP)
#define SAGA_SAGA_URL_HPP

// suppress warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(push)
#pragma warning(disable: 4251 4231 4275 4660)
#endif

namespace saga 
{

  SAGA_EXPORT std::ostream& operator<< (std::ostream& os, url const& u);

  SAGA_EXPORT std::istream& operator>> (std::istream& is, url& u);

  SAGA_EXPORT bool operator== (saga::url const& lhs, saga::url const& rhs);

  SAGA_EXPORT bool operator!= (saga::url const& lhs, saga::url const& rhs);

  SAGA_EXPORT bool operator< (saga::url const& lhs, saga::url const& rhs);

  class SAGA_EXPORT url 
    : public saga::object
  {
    private:
      friend class saga::impl::url;
      friend struct saga::impl::runtime;

      SAGA_CALL_CONST_PRIV_1(translate, std::string)
      SAGA_CALL_CONST_PRIV_2(translate, saga::session, std::string)

      std::string get_url_escaped(bool hide_password = false) const;

      friend SAGA_EXPORT std::ostream& operator<< (std::ostream& os, url const& u);
      friend SAGA_EXPORT std::istream& operator>> (std::istream& is, url& u);
      friend SAGA_EXPORT bool operator== (saga::url const& lhs, saga::url const& rhs);
      friend SAGA_EXPORT bool operator!= (saga::url const& lhs, saga::url const& rhs);
      friend SAGA_EXPORT bool operator< (saga::url const& lhs, saga::url const& rhs);

   protected:

     TR1::shared_ptr <impl::url> get_impl_sp() const;
     impl::url* get_impl() const;

     url (impl::url *impl);
//      url (adaptors::nocheck);
//      url (saga::object rhs, adaptors::nocheck);
     url (std::string const & urlstr, adaptors::nocheck);

   public:
     url();
     explicit url (saga::object rhs);
     url(saga::url const& rhs);
     url(std::string const& urlstr);
     url(char const * urlstr);
    ~url(void);

    url& operator=(char const * urlstr);
    url& operator=(std::string const & urlstr);
    url& operator=(saga::url const& rhs);
    url& operator=(saga::object const& rhs);
    
    saga::object clone() const;
    
     std::string get_string(void) const;
     
     void set_string(std::string const & url);
     
     std::string get_scheme (void) const;
     
     void set_scheme (std::string const & scheme);
     
     std::string get_host (void) const;
     
     void set_host (std::string const & host);
     
     int get_port (void) const;

     void set_port (int port);

     std::string get_fragment  (void) const;
     
     void set_fragment (std::string const & fragment);
     
     std::string get_path (void) const;
     
     void set_path (std::string const & path);
     
     std::string get_userinfo (void) const;
     
     void set_userinfo (std::string const & userinfo);

    saga::url translate(std::string scheme) const
    {
        saga::task t = translatepriv(scheme, saga::task_base::Sync());
        return t.get_result<saga::url>();
    }
    SAGA_CALL_CONST_PUB_1_DEF_0(translate, std::string)

    
    saga::url translate(saga::session s, std::string scheme) const
    {
        saga::task t = translatepriv(s, scheme, saga::task_base::Sync());
        return t.get_result<saga::url>();
    }
    SAGA_CALL_CONST_PUB_2_DEF_0(translate, saga::session, std::string)

    
    // The API functions below are not part of the SAGA specification
    // we provide these as convenience helpers
    
    
     std::string get_url       (void) const;
     
     void set_url(std::string const & url);
     
     std::string get_authority (void) const;
     
     void set_authority (std::string const & auth);
     
     std::string get_query (void) const;
     
     void set_query (std::string const & query);

     void set_scheme_specific_part (std::string const & scheme_specific_part);
     
     std::string get_username  (void) const;
     
     void set_username (std::string const & username);
     
     std::string get_password  (void) const;
     
     void set_password (std::string const & passwd);

    static std::string unescape(std::string const&in);
  
    static std::string escape(std::string const&in);
  
  };
} // namespace saga

// re-enable warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif

#endif // SAGA_SAGA_URL_HPP