Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit a2b80500d6.

boost/parser/transcode_view.hpp

// Copyright (C) 2020 T. Zachary Laine
//
// 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)
#ifndef BOOST_PARSER_TRANSCODE_VIEW_HPP
#define BOOST_PARSER_TRANSCODE_VIEW_HPP

#include <boost/parser/detail/text/transcode_view.hpp>


namespace boost::parser {

    using format = detail::text::format;

    /** A view that produces UTF-8 from an given sequence of UTF.

        \tparam V Constrained by `std::ranges::view<V>`.  Additionally, the
        value type of `V` must be `char`, `wchar_t`, `char8_t`, `char16_t`, or
        `char32_t`. */
#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS || defined(BOOST_PARSER_DOXYGEN)
    template<detail::text::utf_range V>
        requires std::ranges::view<V>
#else
    template<typename V>
#endif
    class utf8_view : public detail::text::utf_view<format::utf8, V>
    {
    public:
        constexpr utf8_view()
#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS || defined(BOOST_PARSER_DOXYGEN)
            requires std::default_initializable<V>
#endif
        = default;
        constexpr utf8_view(V base) :
            detail::text::utf_view<format::utf8, V>{std::move(base)}
        {}
    };

    /** A view that produces UTF-16 from an given sequence of UTF.

        \tparam V Constrained by `std::ranges::view<V>`.  Additionally, the
        value type of `V` must be `char`, `wchar_t`, `char8_t`, `char16_t`, or
        `char32_t`. */
#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS || defined(BOOST_PARSER_DOXYGEN)
    template<detail::text::utf_range V>
        requires std::ranges::view<V>
#else
    template<typename V>
#endif
    class utf16_view : public detail::text::utf_view<format::utf16, V>
    {
    public:
        constexpr utf16_view()
#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS || defined(BOOST_PARSER_DOXYGEN)
            requires std::default_initializable<V>
#endif
        = default;
        constexpr utf16_view(V base) :
            detail::text::utf_view<format::utf16, V>{std::move(base)}
        {}
    };

    /** A view that produces UTF-32 from an given sequence of UTF.

        \tparam V Constrained by `std::ranges::view<V>`.  Additionally, the
        value type of `V` must be `char`, `wchar_t`, `char8_t`, `char16_t`, or
        `char32_t`. */
#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS || defined(BOOST_PARSER_DOXYGEN)
    template<detail::text::utf_range V>
        requires std::ranges::view<V>
#else
    template<typename V>
#endif
    class utf32_view : public detail::text::utf_view<format::utf32, V>
    {
    public:
        constexpr utf32_view()
#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS || defined(BOOST_PARSER_DOXYGEN)
            requires std::default_initializable<V>
#endif
        = default;
        constexpr utf32_view(V base) :
            detail::text::utf_view<format::utf32, V>{std::move(base)}
        {}
    };

#if BOOST_PARSER_DETAIL_TEXT_USE_CONCEPTS
    template<class R>
    utf8_view(R &&) -> utf8_view<std::views::all_t<R>>;
    template<class R>
    utf16_view(R &&) -> utf16_view<std::views::all_t<R>>;
    template<class R>
    utf32_view(R &&) -> utf32_view<std::views::all_t<R>>;
#endif

    /** A view adaptor that produces a `utf8_view` of the given view. */
    inline constexpr auto as_utf8 = detail::text::as_utf8;
    /** A view adaptor that produces a `utf16_view` of the given view. */
    inline constexpr auto as_utf16 = detail::text::as_utf16;
    /** A view adaptor that produces a `utf32_view` of the given view. */
    inline constexpr auto as_utf32 = detail::text::as_utf32;

}

#endif