vos/corelibs/vos/url.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001-2003 Peter Amstutz

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

    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., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <tetron@interreality.org>
*/
#ifndef _URL_HH_
#define _URL_HH_

/** @file
    Defines URL.
*/

#include <vos/corelibs/vos/vosdefs.hh>

#include <string>
#include <stdexcept>


namespace VOS
{
/** @class URL url.hh vos/corelibs/vos/url.hh
 * A class implementing basic handling of Uniform Resource Locator
    (URL) expressions.
 */
class VOS_API URL
{
private:
    string protocol;
    string host;
    string port;
    string path;
    string urlstr;
    string hostandport;
    static URL defaults;
    void makeURLstr();
public:
    class BadURLError : public runtime_error {
    public:
        BadURLError(const string& s) : runtime_error(s) { }
    };

    /** Construct a URL using the default fields.
     */
    URL();

    /** Construct a URL using the supplied fields
        @param protocol the protocol field
        @param host the host field
        @param port the port field
        @param path everything after the port
     */
    URL(const string& protocol,
        const string& host,
        const string& port,
        const string& path);

    /** Construct a URL by parsing the supplied URL string.
        Empty fields will be filled
        in using the default if they are not found!
        @param url a URL in the usual form ("protocol://host:port/path")
        @throws BadURLError if
    */
    URL(const string& url) throw (BadURLError);


    /** Get a string representation of the URL in the usual form
        ("protocol://host:port/path")
        @return the URL string
     */
    const string& getString() const;

    /** Set a URL object used to supply default fields used by the constructors.
        @param url an already-initialized URL object
    */
    static void setDefaults(const URL& url);

    /** @return the protocol field */
    const string& getProtocol() const;

    /** @return the host field */
    const string& getHost() const;

    /** @return the port field */
    const string& getPort() const;

    /** @return the path field */
    const string& getPath() const;

    /** @return the host and port in the form "host:port" */
    const string& getHostAndPort() const;

    /** @param p set the protocol field */
    void setProtocol(const string& p);

    /** @param h set the host field */
    void setHost(const string& h);

    /** @param p set the port field */
    void setPort(const string& p);

    /** @param p set the path field */
    void setPath(const string& p);

    /** @param hp set the host and port fields together, supplied in
        the form "host:port" */
    void setHostAndPort(const string& hp);
};
}

#endif

---