Diff coverage report for

//

//

// Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)

// Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)

// Copyright (c) 2022 Alan de Freitas (alandefreitas@gmail.com)

// Copyright (c) 2022 Alan de Freitas (alandefreitas@gmail.com)

//

//

// Distributed under the Boost Software License, Version 1.0. (See accompanying

// 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)

// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

//

//

// Official repository: https://github.com/boostorg/url

// Official repository: https://github.com/boostorg/url

//

//

#ifndef BOOST_URL_URL_HPP

#ifndef BOOST_URL_URL_HPP

#define BOOST_URL_URL_HPP

#define BOOST_URL_URL_HPP

#include <boost/url/detail/config.hpp>

#include <boost/url/detail/config.hpp>

#include <boost/url/url_base.hpp>

#include <boost/url/url_base.hpp>

#include <boost/assert.hpp>

#include <boost/assert.hpp>

#include <utility>

#include <utility>

namespace boost {

namespace boost {

namespace urls {

namespace urls {

/** A modifiable container for a URL.

/** A modifiable container for a URL.

    This container owns a url, represented

    This container owns a url, represented

    by a null-terminated character buffer

    by a null-terminated character buffer

    which is managed by performing dymamic

    which is managed by performing dymamic

    memory allocations as needed.

    memory allocations as needed.

    The contents may be inspected and modified,

    The contents may be inspected and modified,

    and the implementation maintains a useful

    and the implementation maintains a useful

    invariant: changes to the url always

    invariant: changes to the url always

    leave it in a valid state.

    leave it in a valid state.

    @par Exception Safety

    @par Exception Safety

    @li Functions marked `noexcept` provide the

    @li Functions marked `noexcept` provide the

    no-throw guarantee, otherwise:

    no-throw guarantee, otherwise:

    @li Functions which throw offer the strong

    @li Functions which throw offer the strong

    exception safety guarantee.

    exception safety guarantee.

    @par BNF

    @par BNF

    @code

    @code

    URI-reference = URI / relative-ref

    URI-reference = URI / relative-ref

    URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

    URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

    relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

    relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

    absolute-URI  = scheme ":" hier-part [ "?" query ]

    absolute-URI  = scheme ":" hier-part [ "?" query ]

    @endcode

    @endcode

    @par Specification

    @par Specification

    @li <a href="https://tools.ietf.org/html/rfc3986"

    @li <a href="https://tools.ietf.org/html/rfc3986"

        >Uniform Resource Identifier (URI): Generic Syntax (rfc3986)</a>

        >Uniform Resource Identifier (URI): Generic Syntax (rfc3986)</a>

    @see

    @see

        @ref parse_absolute_uri,

        @ref parse_absolute_uri,

        @ref parse_relative_ref,

        @ref parse_relative_ref,

        @ref parse_uri,

        @ref parse_uri,

        @ref parse_uri_reference,

        @ref parse_uri_reference,

        @ref resolve.

        @ref resolve.

*/

*/

class BOOST_URL_DECL url

class BOOST_URL_DECL url

    : public url_base

    : public url_base

{

{

    friend std::hash<url>;

    friend std::hash<url>;

    using url_view_base::digest;

    using url_view_base::digest;

public:

public:

    //--------------------------------------------

    //--------------------------------------------

    //

    //

    // Special Members

    // Special Members

    //

    //

    //--------------------------------------------

    //--------------------------------------------

    /** Destructor

    /** Destructor

        Any params, segments, iterators, or

        Any params, segments, iterators, or

        views which reference this object are

        views which reference this object are

        invalidated. The underlying character

        invalidated. The underlying character

        buffer is destroyed, invalidating all

        buffer is destroyed, invalidating all

        references to it.

        references to it.

    */

    */

    virtual ~url();

    virtual ~url();

    /** Constructor

    /** Constructor

        Default constructed urls contain

        Default constructed urls contain

        a zero-length string. This matches

        a zero-length string. This matches

        the grammar for a relative-ref with

        the grammar for a relative-ref with

        an empty path and no query or

        an empty path and no query or

        fragment.

        fragment.

        @par Example

        @par Example

        @code

        @code

        url u;

        url u;

        @endcode

        @endcode

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->empty() == true

        this->empty() == true

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @par BNF

        @par BNF

        @code

        @code

        relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

        relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

        @endcode

        @endcode

        @par Specification

        @par Specification

        <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.2"

        <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.2"

            >4.2. Relative Reference (rfc3986)</a>

            >4.2. Relative Reference (rfc3986)</a>

    */

    */

    url() noexcept;

    url() noexcept;

    /** Constructor

    /** Constructor

        This function constructs a URL from

        This function constructs a URL from

        the string `s`, which must contain a

        the string `s`, which must contain a

        valid <em>URI</em> or <em>relative-ref</em>

        valid <em>URI</em> or <em>relative-ref</em>

        or else an exception is thrown.

        or else an exception is thrown.

        The new url retains ownership by

        The new url retains ownership by

        allocating a copy of the passed string.

        allocating a copy of the passed string.

        @par Example

        @par Example

        @code

        @code

        url u( "https://www.example.com" );

        url u( "https://www.example.com" );

        @endcode

        @endcode

        @par Effects

        @par Effects

        @code

        @code

        return url( parse_uri_reference( s ).value() );

        return url( parse_uri_reference( s ).value() );

        @endcode

        @endcode

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->buffer().data() != s.data()

        this->buffer().data() != s.data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `s.size()`.

        Linear in `s.size()`.

        @par Exception Safety

        @par Exception Safety

        Calls to allocate may throw.

        Calls to allocate may throw.

        Exceptions thrown on invalid input.

        Exceptions thrown on invalid input.

        @throw system_error

        @throw system_error

        The input does not contain a valid url.

        The input does not contain a valid url.

        @param s The string to parse.

        @param s The string to parse.

        @par BNF

        @par BNF

        @code

        @code

        URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

        URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

        relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

        relative-ref  = relative-part [ "?" query ] [ "#" fragment ]

        @endcode

        @endcode

        @par Specification

        @par Specification

        @li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.1"

        @li <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-4.1"

            >4.1. URI Reference</a>

            >4.1. URI Reference</a>

    */

    */

    explicit

    explicit

    url(core::string_view s);

    url(core::string_view s);

    /** Constructor

    /** Constructor

        The contents of `u` are transferred

        The contents of `u` are transferred

        to the newly constructed object,

        to the newly constructed object,

        which includes the underlying

        which includes the underlying

        character buffer.

        character buffer.

        After construction, the moved-from

        After construction, the moved-from

        object is as if default constructed.

        object is as if default constructed.

        @par Postconditions

        @par Postconditions

        @code

        @code

        u.empty() == true

        u.empty() == true

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @param u The url to move from.

        @param u The url to move from.

    */

    */

    url(url&& u) noexcept;

    url(url&& u) noexcept;

    /** Constructor

    /** Constructor

        The newly constructed object

        The newly constructed object

        contains a copy of `u`.

        contains a copy of `u`.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `u.size()`.

        Linear in `u.size()`.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        Calls to allocate may throw.

        Calls to allocate may throw.

        @throw std::length_error `u.size() > max_size()`.

        @throw std::length_error `u.size() > max_size()`.

        @param u The url to copy.

        @param u The url to copy.

    */

    */

    /** Constructor

    /** Constructor

        The newly constructed object

        The newly constructed object

        contains a copy of `u`.

        contains a copy of `u`.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `u.size()`.

        Linear in `u.size()`.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        Calls to allocate may throw.

        Calls to allocate may throw.

        @throw std::length_error `u.size() > max_size()`.

        @throw std::length_error `u.size() > max_size()`.

        @param u The url to copy.

        @param u The url to copy.

    */

    */

    {

    {

    /** Assignment

    /** Assignment

        The contents of `u` are transferred to

        The contents of `u` are transferred to

        `this`, including the underlying

        `this`, including the underlying

        character buffer. The previous contents

        character buffer. The previous contents

        of `this` are destroyed.

        of `this` are destroyed.

        After assignment, the moved-from

        After assignment, the moved-from

        object is as if default constructed.

        object is as if default constructed.

        @par Postconditions

        @par Postconditions

        @code

        @code

        u.empty() == true

        u.empty() == true

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @param u The url to assign from.

        @param u The url to assign from.

        @return A reference to this object.

        @return A reference to this object.

    */

    */

    url&

    url&

    operator=(url&& u) noexcept;

    operator=(url&& u) noexcept;

    /** Assignment

    /** Assignment

        The contents of `u` are copied and

        The contents of `u` are copied and

        the previous contents of `this` are

        the previous contents of `this` are

        destroyed.

        destroyed.

        Capacity is preserved, or increases.

        Capacity is preserved, or increases.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `u.size()`.

        Linear in `u.size()`.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        Calls to allocate may throw.

        Calls to allocate may throw.

        @throw std::length_error `u.size() > max_size()`.

        @throw std::length_error `u.size() > max_size()`.

        @param u The url to copy.

        @param u The url to copy.

        @return A reference to this object.

        @return A reference to this object.

    */

    */

    url&

    url&

        url_view_base const& u)

        url_view_base const& u)

    {

    {

    }

    }

    /** Assignment

    /** Assignment

        The contents of `u` are copied and

        The contents of `u` are copied and

        the previous contents of `this` are

        the previous contents of `this` are

        destroyed.

        destroyed.

        Capacity is preserved, or increases.

        Capacity is preserved, or increases.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        this->buffer() == u.buffer() && this->buffer().data() != u.buffer().data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `u.size()`.

        Linear in `u.size()`.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        Calls to allocate may throw.

        Calls to allocate may throw.

        @param u The url to copy.

        @param u The url to copy.

        @return A reference to this object.

        @return A reference to this object.

    */

    */

    url&

    url&

    {

    {

        return (*this)=static_cast<

        return (*this)=static_cast<

    }

    }

    //--------------------------------------------

    //--------------------------------------------

    /** Swap the contents.

    /** Swap the contents.

        Exchanges the contents of this url with another

        Exchanges the contents of this url with another

        url. All views, iterators and references remain valid.

        url. All views, iterators and references remain valid.

        If `this == &other`, this function call has no effect.

        If `this == &other`, this function call has no effect.

        @par Example

        @par Example

        @code

        @code

        url u1( "https://www.example.com" );

        url u1( "https://www.example.com" );

        url u2( "https://www.boost.org" );

        url u2( "https://www.boost.org" );

        u1.swap(u2);

        u1.swap(u2);

        assert(u1 == "https://www.boost.org" );

        assert(u1 == "https://www.boost.org" );

        assert(u2 == "https://www.example.com" );

        assert(u2 == "https://www.example.com" );

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant

        Constant

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @param other The object to swap with

        @param other The object to swap with

    */

    */

    void

    void

    swap(url& other) noexcept;

    swap(url& other) noexcept;

    /** Swap

    /** Swap

        Exchanges the contents of `v0` with another `v1`.

        Exchanges the contents of `v0` with another `v1`.

        All views, iterators and references remain

        All views, iterators and references remain

        valid.

        valid.

        If `&v0 == &v1`, this function call has no effect.

        If `&v0 == &v1`, this function call has no effect.

        @par Example

        @par Example

        @code

        @code

        url u1( "https://www.example.com" );

        url u1( "https://www.example.com" );

        url u2( "https://www.boost.org" );

        url u2( "https://www.boost.org" );

        std::swap(u1, u2);

        std::swap(u1, u2);

        assert(u1 == "https://www.boost.org" );

        assert(u1 == "https://www.boost.org" );

        assert(u2 == "https://www.example.com" );

        assert(u2 == "https://www.example.com" );

        @endcode

        @endcode

        @par Effects

        @par Effects

        @code

        @code

        v0.swap( v1 );

        v0.swap( v1 );

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant

        Constant

        @par Exception Safety

        @par Exception Safety

        Throws nothing

        Throws nothing

        @param v0 The first object to swap

        @param v0 The first object to swap

        @param v1 The second object to swap

        @param v1 The second object to swap

        @see

        @see

            @ref url::swap

            @ref url::swap

    */

    */

    friend

    friend

    void

    void

    {

    {

    //--------------------------------------------

    //--------------------------------------------

    //

    //

    // fluent api

    // fluent api

    //

    //

    /// @copydoc url_base::set_scheme

    /// @copydoc url_base::set_scheme

    /// @copydoc url_base::set_scheme_id

    /// @copydoc url_base::set_scheme_id

    /// @copydoc url_base::remove_scheme

    /// @copydoc url_base::remove_scheme

    /// @copydoc url_base::set_encoded_authority

    /// @copydoc url_base::set_encoded_authority

    /// @copydoc url_base::remove_authority

    /// @copydoc url_base::remove_authority

    /// @copydoc url_base::set_userinfo

    /// @copydoc url_base::set_userinfo

    /// @copydoc url_base::set_encoded_userinfo

    /// @copydoc url_base::set_encoded_userinfo

    /// @copydoc url_base::remove_userinfo

    /// @copydoc url_base::remove_userinfo

    /// @copydoc url_base::set_user

    /// @copydoc url_base::set_user

    /// @copydoc url_base::set_encoded_user

    /// @copydoc url_base::set_encoded_user

    /// @copydoc url_base::set_password

    /// @copydoc url_base::set_password

    /// @copydoc url_base::set_encoded_password

    /// @copydoc url_base::set_encoded_password

    /// @copydoc url_base::remove_password

    /// @copydoc url_base::remove_password

    /// @copydoc url_base::set_host

    /// @copydoc url_base::set_host

    /// @copydoc url_base::set_encoded_host

    /// @copydoc url_base::set_encoded_host

    /// @copydoc url_base::set_host_address

    /// @copydoc url_base::set_host_address

    /// @copydoc url_base::set_encoded_host_address

    /// @copydoc url_base::set_encoded_host_address

    /// @copydoc url_base::set_host_ipv4

    /// @copydoc url_base::set_host_ipv4

    /// @copydoc url_base::set_host_ipv6

    /// @copydoc url_base::set_host_ipv6

    /// @copydoc url_base::set_zone_id

    /// @copydoc url_base::set_zone_id

    /// @copydoc url_base::set_encoded_zone_id

    /// @copydoc url_base::set_encoded_zone_id

    /// @copydoc url_base::set_host_ipvfuture

    /// @copydoc url_base::set_host_ipvfuture

    /// @copydoc url_base::set_host_name

    /// @copydoc url_base::set_host_name

    /// @copydoc url_base::set_encoded_host_name

    /// @copydoc url_base::set_encoded_host_name

    /// @copydoc url_base::set_port_number

    /// @copydoc url_base::set_port_number

    /// @copydoc url_base::set_port

    /// @copydoc url_base::set_port

    /// @copydoc url_base::remove_port

    /// @copydoc url_base::remove_port

    /// @copydoc url_base::set_path_absolute

    /// @copydoc url_base::set_path_absolute

    //bool set_path_absolute(bool absolute);

    //bool set_path_absolute(bool absolute);

    /// @copydoc url_base::set_path

    /// @copydoc url_base::set_path

    /// @copydoc url_base::set_encoded_path

    /// @copydoc url_base::set_encoded_path

    /// @copydoc url_base::set_query

    /// @copydoc url_base::set_query

    /// @copydoc url_base::set_encoded_query

    /// @copydoc url_base::set_encoded_query

    /// @copydoc url_base::set_params

    /// @copydoc url_base::set_params

    /// @copydoc url_base::set_encoded_params

    /// @copydoc url_base::set_encoded_params

    /// @copydoc url_base::remove_query

    /// @copydoc url_base::remove_query

    /// @copydoc url_base::remove_fragment

    /// @copydoc url_base::remove_fragment

    /// @copydoc url_base::set_fragment

    /// @copydoc url_base::set_fragment

    /// @copydoc url_base::set_encoded_fragment

    /// @copydoc url_base::set_encoded_fragment

    /// @copydoc url_base::remove_origin

    /// @copydoc url_base::remove_origin

    /// @copydoc url_base::normalize

    /// @copydoc url_base::normalize

    /// @copydoc url_base::normalize_scheme

    /// @copydoc url_base::normalize_scheme

    /// @copydoc url_base::normalize_authority

    /// @copydoc url_base::normalize_authority

    /// @copydoc url_base::normalize_path

    /// @copydoc url_base::normalize_path

    /// @copydoc url_base::normalize_query

    /// @copydoc url_base::normalize_query

    /// @copydoc url_base::normalize_fragment

    /// @copydoc url_base::normalize_fragment

    //--------------------------------------------

    //--------------------------------------------

private:

private:

    char* allocate(std::size_t);

    char* allocate(std::size_t);

    void deallocate(char* s);

    void deallocate(char* s);

    void clear_impl() noexcept override;

    void clear_impl() noexcept override;

    void reserve_impl(std::size_t, op_t&) override;

    void reserve_impl(std::size_t, op_t&) override;

    void cleanup(op_t&) override;

    void cleanup(op_t&) override;

};

};

} // urls

} // urls

} // boost

} // boost

//------------------------------------------------

//------------------------------------------------

// std::hash specialization

// std::hash specialization

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

namespace std {

namespace std {

template<>

template<>

struct hash< ::boost::urls::url >

struct hash< ::boost::urls::url >

{

{

    hash() = default;

    hash() = default;