Diff coverage report for

//

//

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

// Copyright (c) 2022 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_PCT_STRING_VIEW_HPP

#ifndef BOOST_URL_PCT_STRING_VIEW_HPP

#define BOOST_URL_PCT_STRING_VIEW_HPP

#define BOOST_URL_PCT_STRING_VIEW_HPP

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

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

#include <boost/url/encoding_opts.hpp>

#include <boost/url/encoding_opts.hpp>

#include <boost/url/error_types.hpp>

#include <boost/url/error_types.hpp>

#include <boost/core/detail/string_view.hpp>

#include <boost/core/detail/string_view.hpp>

#include <boost/url/grammar/string_token.hpp>

#include <boost/url/grammar/string_token.hpp>

#include <boost/url/grammar/string_view_base.hpp>

#include <boost/url/grammar/string_view_base.hpp>

#include <cstddef>

#include <cstddef>

#include <iterator>

#include <iterator>

#include <string>

#include <string>

#include <type_traits>

#include <type_traits>

#include <utility>

#include <utility>

namespace boost {

namespace boost {

namespace urls {

namespace urls {

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

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

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

class decode_view;

class decode_view;

class pct_string_view;

class pct_string_view;

BOOST_CXX14_CONSTEXPR

BOOST_CXX14_CONSTEXPR

pct_string_view

pct_string_view

make_pct_string_view_unsafe(

make_pct_string_view_unsafe(

    char const*, std::size_t,

    char const*, std::size_t,

        std::size_t) noexcept;

        std::size_t) noexcept;

namespace detail {

namespace detail {

core::string_view&

core::string_view&

ref(pct_string_view& s) noexcept;

ref(pct_string_view& s) noexcept;

} // detail

} // detail

#endif

#endif

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

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

/** A reference to a valid percent-encoded string

/** A reference to a valid percent-encoded string

    Objects of this type behave like a

    Objects of this type behave like a

    `core::string_view` and have the same interface,

    `core::string_view` and have the same interface,

    but offer an additional invariant: they can

    but offer an additional invariant: they can

    only be constructed from strings containing

    only be constructed from strings containing

    valid percent-escapes.

    valid percent-escapes.

    Attempting construction from a string

    Attempting construction from a string

    containing invalid or malformed percent

    containing invalid or malformed percent

    escapes results in an exception.

    escapes results in an exception.

*/

*/

class pct_string_view final

class pct_string_view final

    : public grammar::string_view_base

    : public grammar::string_view_base

{

{

    std::size_t dn_ = 0;

    std::size_t dn_ = 0;

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

    friend

    friend

    BOOST_CXX14_CONSTEXPR

    BOOST_CXX14_CONSTEXPR

    pct_string_view

    pct_string_view

    make_pct_string_view_unsafe(

    make_pct_string_view_unsafe(

        char const*, std::size_t,

        char const*, std::size_t,

            std::size_t) noexcept;

            std::size_t) noexcept;

    friend

    friend

    core::string_view&

    core::string_view&

    detail::ref(pct_string_view&) noexcept;

    detail::ref(pct_string_view&) noexcept;

#endif

#endif

    // unsafe

    // unsafe

    BOOST_CXX14_CONSTEXPR

    BOOST_CXX14_CONSTEXPR

        char const* data,

        char const* data,

        std::size_t size,

        std::size_t size,

        std::size_t dn) noexcept

        std::size_t dn) noexcept

    {

    {

    BOOST_URL_DECL

    BOOST_URL_DECL

    void

    void

    decode_impl(

    decode_impl(

        string_token::arg& dest,

        string_token::arg& dest,

        encoding_opts opt) const;

        encoding_opts opt) const;

public:

public:

    /** Constructor

    /** Constructor

        Default constructed string are empty.

        Default constructed string are empty.

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

    */

    */

    /** Constructor

    /** Constructor

        The copy references the same

        The copy references the same

        underlying character buffer.

        underlying character buffer.

        Ownership is not transferred.

        Ownership is not transferred.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->data() == other.data()

        this->data() == other.data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @param other The string to copy.

        @param other The string to copy.

    */

    */

    constexpr

    constexpr

    pct_string_view(

    pct_string_view(

        pct_string_view const& other) = default;

        pct_string_view const& other) = default;

    /** Constructor

    /** Constructor

        The newly constructed string references

        The newly constructed string references

        the specified character buffer.

        the specified character buffer.

        Ownership is not transferred.

        Ownership is not transferred.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->data() == core::string_view(s).data()

        this->data() == core::string_view(s).data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `core::string_view(s).size()`.

        Linear in `core::string_view(s).size()`.

        @par Exception Safety

        @par Exception Safety

        Exceptions thrown on invalid input.

        Exceptions thrown on invalid input.

        @throw system_error

        @throw system_error

        The string contains an invalid percent encoding.

        The string contains an invalid percent encoding.

        @tparam String A type convertible to `core::string_view`

        @tparam String A type convertible to `core::string_view`

        @param s The string to construct from.

        @param s The string to construct from.

    */

    */

    template<

    template<

        BOOST_URL_CONSTRAINT(std::convertible_to<core::string_view>) String

        BOOST_URL_CONSTRAINT(std::convertible_to<core::string_view>) String

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

        , class = typename std::enable_if<

        , class = typename std::enable_if<

            std::is_convertible<

            std::is_convertible<

                String,

                String,

                core::string_view

                core::string_view

                    >::value>::type

                    >::value>::type

#endif

#endif

    >

    >

    BOOST_CXX14_CONSTEXPR

    BOOST_CXX14_CONSTEXPR

        String const& s)

        String const& s)

        : pct_string_view(

        : pct_string_view(

    {

    {

    /** Constructor (deleted)

    /** Constructor (deleted)

    */

    */

    pct_string_view(

    pct_string_view(

        std::nullptr_t) = delete;

        std::nullptr_t) = delete;

    /** Constructor

    /** Constructor

        The newly constructed string references

        The newly constructed string references

        the specified character buffer. Ownership

        the specified character buffer. Ownership

        is not transferred.

        is not transferred.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->data() == s && this->size() == len

        this->data() == s && this->size() == len

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `len`.

        Linear in `len`.

        @par Exception Safety

        @par Exception Safety

        Exceptions thrown on invalid input.

        Exceptions thrown on invalid input.

        @throw system_error

        @throw system_error

         The string contains an invalid percent encoding.

         The string contains an invalid percent encoding.

        @param s The string to construct from.

        @param s The string to construct from.

        @param len The length of the string.

        @param len The length of the string.

    */

    */

        char const* s,

        char const* s,

        std::size_t len)

        std::size_t len)

    {

    {

    /** Constructor

    /** Constructor

        The newly constructed string references

        The newly constructed string references

        the specified character buffer. Ownership

        the specified character buffer. Ownership

        is not transferred.

        is not transferred.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->data() == s.data() && this->size() == s.size()

        this->data() == s.data() && this->size() == s.size()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `s.size()`.

        Linear in `s.size()`.

        @par Exception Safety

        @par Exception Safety

        Exceptions thrown on invalid input.

        Exceptions thrown on invalid input.

        @throw system_error

        @throw system_error

        The string contains an invalid percent encoding.

        The string contains an invalid percent encoding.

        @param s The string to construct from.

        @param s The string to construct from.

    */

    */

    BOOST_URL_DECL

    BOOST_URL_DECL

    pct_string_view(

    pct_string_view(

        core::string_view s);

        core::string_view s);

    /** Assignment

    /** Assignment

        The copy references the same

        The copy references the same

        underlying character buffer.

        underlying character buffer.

        Ownership is not transferred.

        Ownership is not transferred.

        @par Postconditions

        @par Postconditions

        @code

        @code

        this->data() == other.data()

        this->data() == other.data()

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @param other The string to copy.

        @param other The string to copy.

        @return A reference to this object.

        @return A reference to this object.

    */

    */

    pct_string_view& operator=(

    pct_string_view& operator=(

        pct_string_view const& other) = default;

        pct_string_view const& other) = default;

    friend

    friend

    BOOST_URL_DECL

    BOOST_URL_DECL

    system::result<pct_string_view>

    system::result<pct_string_view>

    make_pct_string_view(

    make_pct_string_view(

        core::string_view s) noexcept;

        core::string_view s) noexcept;

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

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

    /** Return the decoded size

    /** Return the decoded size

        This function returns the number of

        This function returns the number of

        characters in the resulting string if

        characters in the resulting string if

        percent escapes were converted into

        percent escapes were converted into

        ordinary characters.

        ordinary characters.

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @return The number of characters in the decoded string.

        @return The number of characters in the decoded string.

    */

    */

    BOOST_CXX14_CONSTEXPR

    BOOST_CXX14_CONSTEXPR

    std::size_t

    std::size_t

    {

    {

    }

    }

    /** Return the string as a range of decoded characters

    /** Return the string as a range of decoded characters

        @par Complexity

        @par Complexity

        Constant.

        Constant.

        @par Exception Safety

        @par Exception Safety

        Throws nothing.

        Throws nothing.

        @see

        @see

            @ref decode_view.

            @ref decode_view.

        @return A range of decoded characters.

        @return A range of decoded characters.

    */

    */

    decode_view

    decode_view

    operator*() const noexcept;

    operator*() const noexcept;

    /** Return the string with percent-decoding

    /** Return the string with percent-decoding

        This function converts percent escapes

        This function converts percent escapes

        in the string into ordinary characters

        in the string into ordinary characters

        and returns the result.

        and returns the result.

        When called with no arguments, the

        When called with no arguments, the

        return type is `std::string`.

        return type is `std::string`.

        Otherwise, the return type and style

        Otherwise, the return type and style

        of output is determined by which string

        of output is determined by which string

        token is passed.

        token is passed.

        @par Example

        @par Example

        @code

        @code

        assert( pct_string_view( "Program%20Files" ).decode() == "Program Files" );

        assert( pct_string_view( "Program%20Files" ).decode() == "Program Files" );

        @endcode

        @endcode

        @par Complexity

        @par Complexity

        Linear in `this->size()`.

        Linear in `this->size()`.

        @par Exception Safety

        @par Exception Safety

        Calls to allocate may throw.

        Calls to allocate may throw.

        String tokens may throw exceptions.

        String tokens may throw exceptions.

        @param opt The options for encoding. If

        @param opt The options for encoding. If

        this parameter is omitted, the default

        this parameter is omitted, the default

        options are used.

        options are used.

        @param token An optional string token.

        @param token An optional string token.

        If this parameter is omitted, then

        If this parameter is omitted, then

        a new `std::string` is returned.

        a new `std::string` is returned.

        Otherwise, the function return type

        Otherwise, the function return type

        is the result type of the token.

        is the result type of the token.

        @return The decoded string.

        @return The decoded string.

        @see

        @see

            @ref encoding_opts,

            @ref encoding_opts,

            @ref string_token::return_string.

            @ref string_token::return_string.

    */

    */

    template<BOOST_URL_STRTOK_TPARAM>

    template<BOOST_URL_STRTOK_TPARAM>

    BOOST_URL_STRTOK_RETURN

    BOOST_URL_STRTOK_RETURN

        encoding_opts opt = {},

        encoding_opts opt = {},

        BOOST_URL_STRTOK_ARG(token)) const

        BOOST_URL_STRTOK_ARG(token)) const

    {

    {

/*      If you get a compile error here, it

/*      If you get a compile error here, it

        means that the token you passed does

        means that the token you passed does

        not meet the requirements stated

        not meet the requirements stated

        in the documentation.

        in the documentation.

*/

*/

        static_assert(

        static_assert(

            string_token::is_token<

            string_token::is_token<

                StringToken>::value,

                StringToken>::value,

            "Type requirements not met");

            "Type requirements not met");

    }

    }

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

    /** Arrow support

    /** Arrow support

        @return A pointer to this object.

        @return A pointer to this object.

    */

    */

    pct_string_view const*

    pct_string_view const*

    {

    {

    }

    }

#endif

#endif

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

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

    // VFALCO No idea why this fails in msvc

    // VFALCO No idea why this fails in msvc

    /** Swap

    /** Swap

        @param s The object to swap with

        @param s The object to swap with

    */

    */

    /*BOOST_CXX14_CONSTEXPR*/ void swap(

    /*BOOST_CXX14_CONSTEXPR*/ void swap(

        pct_string_view& s ) noexcept

        pct_string_view& s ) noexcept

    {

    {

        string_view_base::swap(s);

        string_view_base::swap(s);

        std::swap(dn_, s.dn_);

        std::swap(dn_, s.dn_);

    }

    }

};

};

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

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

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

namespace detail {

namespace detail {

// obtain modifiable reference to

// obtain modifiable reference to

// underlying string, to handle

// underlying string, to handle

// self-intersection on modifiers.

// self-intersection on modifiers.

inline

inline

core::string_view&

core::string_view&

{

{

}

}

} // detail

} // detail

#endif

#endif

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

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

/** Return a valid percent-encoded string

/** Return a valid percent-encoded string

    If `s` is a valid percent-encoded string,

    If `s` is a valid percent-encoded string,

    the function returns the buffer as a valid

    the function returns the buffer as a valid

    view which may be used to perform decoding

    view which may be used to perform decoding

    or measurements.

    or measurements.

    Otherwise the result contains an error code.

    Otherwise the result contains an error code.

    Upon success, the returned view references

    Upon success, the returned view references

    the original character buffer;

    the original character buffer;

    Ownership is not transferred.

    Ownership is not transferred.

    @par Complexity

    @par Complexity

    Linear in `s.size()`.

    Linear in `s.size()`.

    @par Exception Safety

    @par Exception Safety

    Throws nothing.

    Throws nothing.

    @param s The string to validate.

    @param s The string to validate.

    @return On success, the valid percent-encoded string.

    @return On success, the valid percent-encoded string.

*/

*/

BOOST_URL_DECL

BOOST_URL_DECL

system::result<pct_string_view>

system::result<pct_string_view>

make_pct_string_view(

make_pct_string_view(

    core::string_view s) noexcept;

    core::string_view s) noexcept;

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

// VFALCO semi-private for now

// VFALCO semi-private for now

inline

inline

BOOST_CXX14_CONSTEXPR

BOOST_CXX14_CONSTEXPR

pct_string_view

pct_string_view

    char const* data,

    char const* data,

    std::size_t size,

    std::size_t size,

    std::size_t decoded_size) noexcept

    std::size_t decoded_size) noexcept

{

{

#if 0

#if 0

    BOOST_ASSERT(! make_pct_string_view(

    BOOST_ASSERT(! make_pct_string_view(

        core::string_view(data, size)).has_error());

        core::string_view(data, size)).has_error());

#endif

#endif

    return pct_string_view(

    return pct_string_view(

}

}

#endif

#endif

#ifndef BOOST_URL_DOCS

#ifndef BOOST_URL_DOCS

namespace detail {

namespace detail {

template <>

template <>

inline

inline

BOOST_CXX14_CONSTEXPR

BOOST_CXX14_CONSTEXPR

core::string_view

core::string_view

{

{

}

}

} // detail

} // detail

#endif

#endif

} // urls

} // urls

} // boost

} // boost

// Ensure decode_view is complete for operator*()

// Ensure decode_view is complete for operator*()

#include <boost/url/decode_view.hpp>

#include <boost/url/decode_view.hpp>

#ifdef BOOST_URL_HAS_CONCEPTS

#ifdef BOOST_URL_HAS_CONCEPTS

#include <ranges>

#include <ranges>

namespace std::ranges {

namespace std::ranges {

    template<>

    template<>

    inline constexpr bool

    inline constexpr bool

        enable_borrowed_range<

        enable_borrowed_range<

            boost::urls::pct_string_view> = true;

            boost::urls::pct_string_view> = true;

} // std::ranges

} // std::ranges

#endif

#endif

#endif

#endif