zeroc-ice 3.7.10 → 3.8.0

data/dist/ice/cpp/include/Ice/StreamHelpers.h

@@ -0,0 +1,652 @@
+// Copyright (c) ZeroC, Inc.
+
+#ifndef ICE_STREAM_HELPERS_H
+#define ICE_STREAM_HELPERS_H
+
+#include "InputStream.h"
+#include "OutputStream.h"
+#include "StringConverter.h"
+
+#include <iterator>
+#include <ostream>
+
+#if defined(_MSC_VER)
+// With MSVC, __has_include(<span>) evaluates to 1 in c++17 mode and the <span> header then issues a warning that can't
+// be disabled. This is a permissible but impractical behavior. See https://github.com/microsoft/STL/issues/4010.
+#    if _MSVC_LANG >= 202002L
+#        include <span>
+#    endif
+#elif __has_include(<span>)
+#    include <span>
+#endif
+
+namespace Ice
+{
+    // StreamHelper templates used by streams to read, write and print data.
+
+#ifdef ICE_DOXYGEN
+    /// Prints a value to a stream.
+    /// @tparam T The type of the value. It's either built-in Slice type or a type generated by the Slice compiler.
+    /// @param stream The stream.
+    /// @param v The value to print.
+    /// @remarks Depending on the type, @p v is passed by value or by const reference.
+    template<typename T> void print(std::ostream& stream, T v);
+
+    // We only provide this declaration for Doxygen. This template is specialized for all types that we support, and
+    // we want the compilation (not linking) to fail if a specialization is missing.
+
+    /// A helper template class for writing (marshaling) and reading (unmarshaling) values to and from a stream of
+    /// Slice-encoded bytes. This helper also prints Slice-defined types.
+    /// @tparam T The type of the value.
+    /// @tparam st The stream helper category.
+    /// @headerfile Ice/Ice.h
+    template<typename T, StreamHelperCategory st> struct StreamHelper
+    {
+        /// Writes a value to the stream.
+        /// @param stream The stream.
+        /// @param v The value to write.
+        /// @remark Each specialization chooses whether @p v is passed by value or by const reference.
+        static void write(OutputStream* stream, T v);
+
+        /// Reads a value from the stream.
+        /// @param stream The stream.
+        /// @param[out] v A reference to the value to read into.
+        static void read(InputStream* stream, T& v);
+
+        /// Prints a value to the stream.
+        /// @param stream The stream.
+        /// @param v The value to print.
+        /// @remark Each specialization chooses whether @p v is passed by value or by const reference.
+        static void print(std::ostream& stream, T v);
+    };
+#endif
+
+    /// @cond INTERNAL
+
+    /// Prints a value with a pass-by-value type (such as `bool`, `int32`, or an enumeration) to a stream.
+    /// @tparam T The type of the value.
+    /// @param stream The stream.
+    /// @param v The value to print.
+    template<
+        typename T,
+        std::enable_if_t<
+            StreamableTraits<T>::helper == StreamHelperCategoryBuiltinValue ||
+                StreamableTraits<T>::helper == StreamHelperCategoryEnum,
+            bool> = true>
+    inline void print(std::ostream& stream, T v)
+    {
+        StreamHelper<T, StreamHelperCategoryBuiltinValue>::print(stream, v);
+    }
+
+    /// Prints an optional value with a pass-by-value type (such as `bool`, `int32`, or an enumeration) to a stream.
+    /// @tparam T The type of the value.
+    /// @param stream The stream.
+    /// @param v The value to print. nullopt is printed as "nullopt".
+    template<
+        typename T,
+        std::enable_if_t<
+            StreamableTraits<T>::helper == StreamHelperCategoryBuiltinValue ||
+                StreamableTraits<T>::helper == StreamHelperCategoryEnum,
+            bool> = true>
+    inline void print(std::ostream& stream, std::optional<T> v)
+    {
+        if (v)
+        {
+            Ice::print(stream, *v);
+        }
+        else
+        {
+            stream << "nullopt";
+        }
+    }
+
+    /// Prints a value with a pass-by-const-reference type to the stream.
+    /// @tparam T The type of the value.
+    /// @param stream The stream.
+    /// @param v The value to print.
+    template<
+        typename T,
+        std::enable_if_t<
+            StreamableTraits<T>::helper != StreamHelperCategoryBuiltinValue &&
+                StreamableTraits<T>::helper != StreamHelperCategoryEnum,
+            bool> = true>
+    inline void print(std::ostream& stream, const T& v)
+    {
+        StreamHelper<T, StreamableTraits<T>::helper>::print(stream, v);
+    }
+
+    /// Prints an optional value with a pass-by-const-reference type to the stream.
+    /// @tparam T The type of the value.
+    /// @param stream The stream.
+    /// @param v The value to print. nullopt is printed as "nullopt".
+    template<
+        typename T,
+        std::enable_if_t<
+            StreamableTraits<T>::helper != StreamHelperCategoryBuiltinValue &&
+                StreamableTraits<T>::helper != StreamHelperCategoryEnum &&
+                StreamableTraits<std::optional<T>>::helper != StreamHelperCategoryProxy,
+            bool> = true>
+    inline void print(std::ostream& stream, const std::optional<T>& v)
+    {
+        if (v)
+        {
+            Ice::print(stream, *v);
+        }
+        else
+        {
+            stream << "nullopt";
+        }
+    }
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryBuiltinValue>
+    {
+        static void write(OutputStream* stream, T v) { stream->write(v); }
+
+        static void read(InputStream* stream, T& v) { stream->read(v); }
+
+        static void print(std::ostream& stream, T v) { stream << v; }
+    };
+
+    template<> struct StreamHelper<bool, StreamHelperCategoryBuiltinValue>
+    {
+        static void print(std::ostream& stream, bool v) { stream << (v ? "true" : "false"); }
+    };
+
+    template<> struct StreamHelper<std::uint8_t, StreamHelperCategoryBuiltinValue>
+    {
+        static void print(std::ostream& stream, std::uint8_t v) { stream << static_cast<int>(v); }
+    };
+
+    template<> struct StreamHelper<std::byte, StreamHelperCategoryBuiltinValue>
+    {
+        static void print(std::ostream& stream, std::byte v) { stream << static_cast<int>(v); }
+    };
+
+    template<> struct StreamHelper<std::string_view, StreamHelperCategoryBuiltinValue>
+    {
+        static void write(OutputStream* stream, std::string_view v) { stream->write(v); }
+
+        // No read: we marshal string views but unmarshal strings.
+        // No print: we only print fields.
+    };
+
+    template<> struct StreamHelper<std::wstring_view, StreamHelperCategoryBuiltinValue>
+    {
+        static void write(OutputStream* stream, std::wstring_view v) { stream->write(v); }
+
+        // No read: we marshal wstring views but don't unmarshal wstrings.
+        // No print: we only print fields.
+    };
+
+    /// Helper for built-in types that are not passed by value.
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryBuiltin>
+    {
+        static void write(OutputStream* stream, const T& v) { stream->write(v); }
+
+        static void read(InputStream* stream, T& v) { stream->read(v); }
+
+        static void print(std::ostream& stream, const T& v) { stream << v; }
+    };
+
+    template<> struct StreamHelper<std::wstring, StreamHelperCategoryBuiltin>
+    {
+        static void print(std::ostream& stream, const std::wstring& v) { stream << Ice::wstringToString(v); }
+    };
+
+    template<> struct StreamHelper<std::vector<bool>, StreamHelperCategoryBuiltin>
+    {
+        static void print(std::ostream& stream, const std::vector<bool>& v)
+        {
+            stream << '[';
+            bool firstElement = true;
+            for (bool element : v)
+            {
+                if (!firstElement)
+                {
+                    stream << ", ";
+                }
+                firstElement = false;
+                Ice::print(stream, element);
+            }
+            stream << ']';
+        }
+    };
+
+    //
+    // "helpers" for the StreamHelper<T, StreamHelperCategoryStruct>. slice2cpp generates specializations as needed.
+    //
+
+    /// Reader used/generated for structs. Always specialized.
+    template<typename T> struct StreamReader;
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryStruct>
+    {
+        static void write(OutputStream* stream, const T& v) { stream->writeAll(v.ice_tuple()); }
+
+        static void read(InputStream* stream, T& v) { StreamReader<T>::read(stream, v); }
+
+        static void print(std::ostream& stream, const T& v) { stream << v; }
+    };
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryEnum>
+    {
+        static void write(OutputStream* stream, T v)
+        {
+            if (static_cast<std::int32_t>(v) < StreamableTraits<T>::minValue ||
+                static_cast<std::int32_t>(v) > StreamableTraits<T>::maxValue)
+            {
+                IceInternal::Ex::throwMarshalException(__FILE__, __LINE__, "enumerator out of range");
+            }
+            stream->writeEnum(static_cast<std::int32_t>(v), StreamableTraits<T>::maxValue);
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            std::int32_t value = stream->readEnum(StreamableTraits<T>::maxValue);
+            if (value < StreamableTraits<T>::minValue || value > StreamableTraits<T>::maxValue)
+            {
+                IceInternal::Ex::throwMarshalException(__FILE__, __LINE__, "enumerator out of range");
+            }
+            v = static_cast<T>(value); // NOLINT
+        }
+
+        static void print(std::ostream& stream, T v) { stream << v; }
+    };
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategorySequence>
+    {
+        static void write(OutputStream* stream, const T& v)
+        {
+            stream->writeSize(static_cast<std::int32_t>(v.size()));
+            for (const auto& element : v)
+            {
+                stream->write(element);
+            }
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            std::int32_t sz = stream->readAndCheckSeqSize(StreamableTraits<typename T::value_type>::minWireSize);
+            T(static_cast<size_t>(sz)).swap(v);
+            for (auto& element : v)
+            {
+                stream->read(element);
+            }
+        }
+
+        static void print(std::ostream& stream, const T& v)
+        {
+            stream << '[';
+            bool firstElement = true;
+            for (const auto& element : v)
+            {
+                if (!firstElement)
+                {
+                    stream << ", ";
+                }
+                firstElement = false;
+                Ice::print(stream, element);
+            }
+            stream << ']';
+        }
+    };
+
+    /// Helper the array custom sequence mapping.
+    template<typename T> struct StreamHelper<std::pair<const T*, const T*>, StreamHelperCategorySequence>
+    {
+        static void write(OutputStream* stream, std::pair<const T*, const T*> v) { stream->write(v.first, v.second); }
+
+        static void read(InputStream* stream, std::pair<const T*, const T*>& v) { stream->read(v); }
+
+        // No print: we only print fields.
+    };
+
+#ifdef __cpp_lib_span
+    /// Helper for span (C++20 or later).
+    template<typename T> struct StreamHelper<std::span<T>, StreamHelperCategorySequence>
+    {
+        static void write(OutputStream* stream, const std::span<T>& v) { stream->write(v.data(), v.data() + v.size()); }
+
+        // No read. span are only for view types.
+        // No print: we only print fields.
+    };
+#endif
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryDictionary>
+    {
+        static void write(OutputStream* stream, const T& v)
+        {
+            stream->writeSize(static_cast<std::int32_t>(v.size()));
+            for (const auto& entry : v)
+            {
+                stream->write(entry.first);
+                stream->write(entry.second);
+            }
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            std::int32_t sz = stream->readSize();
+            v.clear();
+            while (sz--)
+            {
+                typename T::value_type p;
+                stream->read(const_cast<typename T::key_type&>(p.first));
+                auto i = v.insert(v.end(), p);
+                stream->read(i->second);
+            }
+        }
+
+        static void print(std::ostream& stream, const T& v)
+        {
+            stream << '[';
+            bool firstEntry = true;
+            for (const auto& entry : v)
+            {
+                if (!firstEntry)
+                {
+                    stream << ", ";
+                }
+                firstEntry = false;
+                stream << '{';
+                Ice::print(stream, entry.first);
+                stream << " : ";
+                Ice::print(stream, entry.second);
+                stream << '}';
+            }
+            stream << ']';
+        }
+    };
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryUserException>
+    {
+        static void write(OutputStream* stream, const T& v) { stream->writeException(v); }
+
+        // no read: we don't use this helper for unmarshaling.
+
+        // We provide print for consistency even though user exceptions cannot appear in fields.
+        static void print(std::ostream& stream, const T& v) { stream << v; }
+    };
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryProxy>
+    {
+        static void write(OutputStream* stream, const T& v) { stream->write(v); }
+
+        static void read(InputStream* stream, T& v) { stream->read(v); }
+
+        static void print(std::ostream& stream, const T& v) { stream << v; }
+    };
+
+    template<typename T> struct StreamHelper<T, StreamHelperCategoryClass>
+    {
+        static void write(OutputStream* stream, const T& v) { stream->write(v); }
+
+        static void read(InputStream* stream, T& v) { stream->read(v); }
+
+        static void print(std::ostream& stream, const T& v) { stream << v; }
+    };
+
+    //
+    // Helpers to read/write optional fields and arguments.
+    //
+
+    /// Extracts / computes the optionalFormat.
+    // This is used _only_ for the base StreamOptionalHelper below.
+    // /!\ Do not use in StreamOptionalHelper specializations, and do not provide specialization not handled by the
+    // base StreamOptionalHelper.
+    template<StreamHelperCategory st, int minWireSize, bool fixedLength> struct GetOptionalFormat;
+
+    /// Specialization for 1-byte built-in fixed-length types.
+    template<> struct GetOptionalFormat<StreamHelperCategoryBuiltinValue, 1, true>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::F1;
+    };
+
+    /// Specialization for 2-byte built-in fixed-length types.
+    template<> struct GetOptionalFormat<StreamHelperCategoryBuiltinValue, 2, true>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::F2;
+    };
+
+    /// Specialization for 4-byte built-in fixed-length types.
+    template<> struct GetOptionalFormat<StreamHelperCategoryBuiltinValue, 4, true>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::F4;
+    };
+
+    /// Specialization for 8-byte built-in fixed-length types.
+    template<> struct GetOptionalFormat<StreamHelperCategoryBuiltinValue, 8, true>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::F8;
+    };
+
+    /// Specialization for built-in variable-length types.
+    template<> struct GetOptionalFormat<StreamHelperCategoryBuiltinValue, 1, false>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::VSize;
+    };
+
+    /// Specialization for built-in variable-length types.
+    template<> struct GetOptionalFormat<StreamHelperCategoryBuiltin, 1, false>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::VSize;
+    };
+
+    /// Specialization for enum types.
+    template<int minWireSize> struct GetOptionalFormat<StreamHelperCategoryEnum, minWireSize, false>
+    {
+        static constexpr OptionalFormat value = OptionalFormat::Size;
+    };
+
+    /// Base helper template for reading and writing optional values. The default implementations reads/writes the
+    /// value as-is.
+    template<typename T, StreamHelperCategory st, bool fixedLength> struct StreamOptionalHelper
+    {
+        using Traits = StreamableTraits<T>;
+
+        // If this optionalFormat fails to compile, you must either define your specialization
+        // for GetOptionalFormat (in which case the optional data will be marshaled/unmarshaled
+        // with straight calls to write/read on the stream), or define your own
+        // StreamOptionalHelper specialization (which gives you more control over marshaling)
+        //
+        static constexpr OptionalFormat optionalFormat = GetOptionalFormat<st, Traits::minWireSize, fixedLength>::value;
+
+        static void write(OutputStream* stream, const T& v) { stream->write(v); }
+
+        static void read(InputStream* stream, T& v) { stream->read(v); }
+    };
+
+    /// Helper to write fixed-size structs.
+    template<typename T> struct StreamOptionalHelper<T, StreamHelperCategoryStruct, true>
+    {
+        static constexpr OptionalFormat optionalFormat = OptionalFormat::VSize;
+
+        static void write(OutputStream* stream, const T& v)
+        {
+            stream->writeSize(StreamableTraits<T>::minWireSize);
+            stream->write(v);
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            stream->skipSize();
+            stream->read(v);
+        }
+    };
+
+    /// Helper to write variable-size structs.
+    template<typename T> struct StreamOptionalHelper<T, StreamHelperCategoryStruct, false>
+    {
+        static constexpr OptionalFormat optionalFormat = OptionalFormat::FSize;
+
+        static void write(OutputStream* stream, const T& v)
+        {
+            OutputStream::size_type pos = stream->startSize();
+            stream->write(v);
+            stream->endSize(pos);
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            stream->skip(4);
+            stream->read(v);
+        }
+    };
+
+    // InputStream and OutputStream have special logic for optional proxies that does not rely on the
+    // StreamOptional helpers.
+
+    /// Helper to read/write optional sequences or dictionaries.
+    template<typename T, bool fixedLength, int sz> struct StreamOptionalContainerHelper;
+
+    /// Encodes containers of variable-size elements with the FSize optional type, since we can't easily figure out
+    /// total number of bytes we're about to write.
+    // This is the same encoding as variable size structs so we just re-use its implementation.
+    template<typename T, int sz> struct StreamOptionalContainerHelper<T, false, sz>
+    {
+        static constexpr OptionalFormat optionalFormat = OptionalFormat::FSize;
+
+        static void write(OutputStream* stream, const T& v, std::int32_t)
+        {
+            StreamOptionalHelper<T, StreamHelperCategoryStruct, false>::write(stream, v);
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            StreamOptionalHelper<T, StreamHelperCategoryStruct, false>::read(stream, v);
+        }
+    };
+
+    /// Encodes containers of fixed-size elements with the VSize optional type since we can figure out the total number
+    /// of bytes we're about to write.
+    template<typename T, int sz> struct StreamOptionalContainerHelper<T, true, sz>
+    {
+        static constexpr OptionalFormat optionalFormat = OptionalFormat::VSize;
+
+        static void write(OutputStream* stream, const T& v, std::int32_t n)
+        {
+            // The total number of bytes is the number of elements * the size of an element and the size-encoded number
+            // of elements (1 or 5 depending on the number of elements).
+            stream->writeSize(sz * n + (n < 255 ? 1 : 5));
+            stream->write(v);
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            stream->skipSize();
+            stream->read(v);
+        }
+    };
+
+    // Optimization: containers of 1 byte elements are encoded with the VSize optional type. There's no need to encode
+    // an additional size for those, the number of elements of the container can be used to skip the optional.
+    template<typename T> struct StreamOptionalContainerHelper<T, true, 1>
+    {
+        static constexpr OptionalFormat optionalFormat = OptionalFormat::VSize;
+
+        static void write(OutputStream* stream, const T& v, std::int32_t) { stream->write(v); }
+
+        static void read(InputStream* stream, T& v) { stream->read(v); }
+    };
+
+    // Helper to write sequences, delegates to the optional container helper template partial specializations.
+    template<typename T> struct StreamOptionalHelper<T, StreamHelperCategorySequence, false>
+    {
+        using E = typename T::value_type;
+        static constexpr int size = StreamableTraits<E>::minWireSize;
+        static constexpr bool fixedLength = StreamableTraits<E>::fixedLength;
+
+        // The optional type of a sequence depends on whether or not elements are fixed
+        // or variable size elements and their size.
+        static constexpr OptionalFormat optionalFormat =
+            StreamOptionalContainerHelper<T, fixedLength, size>::optionalFormat;
+
+        static void write(OutputStream* stream, const T& v)
+        {
+            StreamOptionalContainerHelper<T, fixedLength, size>::write(stream, v, static_cast<std::int32_t>(v.size()));
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            StreamOptionalContainerHelper<T, fixedLength, size>::read(stream, v);
+        }
+    };
+
+    // Helper to write sequences, delegates to the optional container helper template partial specializations.
+    template<typename T> struct StreamOptionalHelper<std::pair<const T*, const T*>, StreamHelperCategorySequence, false>
+    {
+        using P = std::pair<const T*, const T*>;
+        static constexpr int size = StreamableTraits<T>::minWireSize;
+        static constexpr bool fixedLength = StreamableTraits<T>::fixedLength;
+
+        // The optional type of a sequence depends on whether or not elements are fixed
+        // or variable size elements and their size.
+        static constexpr OptionalFormat optionalFormat =
+            StreamOptionalContainerHelper<P, fixedLength, size>::optionalFormat;
+
+        static void write(OutputStream* stream, const P& v)
+        {
+            auto n = static_cast<std::int32_t>(v.second - v.first);
+            StreamOptionalContainerHelper<P, fixedLength, size>::write(stream, v, n);
+        }
+
+        static void read(InputStream* stream, P& v)
+        {
+            StreamOptionalContainerHelper<P, fixedLength, size>::read(stream, v);
+        }
+    };
+
+    // Helper to write dictionaries, delegates to the optional container helper template partial specializations.
+    template<typename T> struct StreamOptionalHelper<T, StreamHelperCategoryDictionary, false>
+    {
+        using K = typename T::key_type;
+        using V = typename T::mapped_type;
+
+        static constexpr int size = StreamableTraits<K>::minWireSize + StreamableTraits<V>::minWireSize;
+        static constexpr bool fixedLength = StreamableTraits<K>::fixedLength && StreamableTraits<V>::fixedLength;
+
+        // The optional type of a dictionary depends on whether or not elements are fixed
+        // or variable size elements.
+        static constexpr OptionalFormat optionalFormat =
+            StreamOptionalContainerHelper<T, fixedLength, size>::optionalFormat;
+
+        static void write(OutputStream* stream, const T& v)
+        {
+            StreamOptionalContainerHelper<T, fixedLength, size>::write(stream, v, static_cast<std::int32_t>(v.size()));
+        }
+
+        static void read(InputStream* stream, T& v)
+        {
+            StreamOptionalContainerHelper<T, fixedLength, size>::read(stream, v);
+        }
+    };
+
+    // Specializations for ProtocolVersion and EncodingVersion
+    template<> struct StreamableTraits<ProtocolVersion>
+    {
+        static constexpr StreamHelperCategory helper = StreamHelperCategoryStruct;
+        static constexpr int minWireSize = 2;
+        static constexpr bool fixedLength = true;
+    };
+
+    template<> struct StreamReader<ProtocolVersion>
+    {
+        static void read(InputStream* istr, ProtocolVersion& v) { istr->readAll(v.major, v.minor); }
+    };
+
+    template<> struct StreamableTraits<EncodingVersion>
+    {
+        static constexpr StreamHelperCategory helper = StreamHelperCategoryStruct;
+        static constexpr int minWireSize = 2;
+        static constexpr bool fixedLength = true;
+    };
+
+    template<> struct StreamReader<EncodingVersion>
+    {
+        static void read(InputStream* istr, EncodingVersion& v) { istr->readAll(v.major, v.minor); }
+    };
+
+    /// @endcond
+}
+
+#endif