/src/pistache/include/pistache/stream.h

Source
/*
 * SPDX-FileCopyrightText: 2015 Mathieu Stefani
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/* stream.h
   Mathieu Stefani, 05 September 2015

   A set of classes to control input over a sequence of bytes
*/

#pragma once

#include <pistache/os.h>

#include <cstddef>
#include <cstring>
#include <iostream>
#include <limits>
#include <stdexcept>
#include <streambuf>
#include <string>
#include <vector>

namespace Pistache
{

    static constexpr char CR = 0xD;
    static constexpr char LF = 0xA;

    template <typename CharT = char>
    class StreamBuf : public std::basic_streambuf<CharT>
    {
    public:
        typedef std::basic_streambuf<CharT> Base;
        typedef typename Base::traits_type traits_type;

#ifdef __MINGW32__
        // As of Oct/2024, if we do not explicitly set the locale, as below,
        // the test http_parsing_test.parser_reset generates an exception in
        // the locale destructor when the Http::RequestParser (which inherits
        // from StreamBuf) that the test uses goes out of scope. The locale
        // instance that crashes on destruction is a component of
        // std::basic_streambuf, inheried by StreamBuf and thence by
        // Http::RequestParser. This may be a bug in the mingw standard
        // library; setting the std::basic_streambuf's locale explicitly works
        // around the issue.
        StreamBuf()
            {
                std::locale dummy_loc("C");
                Base::pubimbue(dummy_loc);
            }
#endif

        void setArea(char* begin, char* current, char* end)
        {
            this->setg(begin, current, end);
        }

        CharT* begptr() const { return this->eback(); }

        CharT* curptr() const { return this->gptr(); }

        CharT* endptr() const { return this->egptr(); }

        size_t position() const { return this->gptr() - this->eback(); }

        void reset() { this->setg(nullptr, nullptr, nullptr); }

        typename Base::int_type snext() const
        {
            if (this->gptr() == this->egptr())
            {
                return traits_type::eof();
            }

            const CharT* gptr = this->gptr();
            return *(gptr + 1);
        }
    };

    template <typename CharT = char>
    class RawStreamBuf : public StreamBuf<CharT>
    {
    public:
        typedef StreamBuf<CharT> Base;

        RawStreamBuf(char* begin, char* end) { Base::setg(begin, begin, end); }
        RawStreamBuf(char* begin, size_t len)
        {
            Base::setg(begin, begin, begin + len);
        }
    };

    // Make the buffer dynamic
    template <typename CharT = char>
    class ArrayStreamBuf : public StreamBuf<CharT>
    {
    public:
        using Base = StreamBuf<CharT>;

        explicit ArrayStreamBuf(size_t maxSize)
            : StreamBuf<CharT>()
            , bytes()
            , maxSize_(maxSize)
        {
            bytes.clear();
            Base::setg(bytes.data(), bytes.data(), bytes.data() + bytes.size());
        }

        template <size_t M>
        explicit ArrayStreamBuf(char (&arr)[M])
        {
            bytes.clear();
            std::copy(arr, arr + M, std::back_inserter(bytes));
            Base::setg(bytes.data(), bytes.data(), bytes.data() + bytes.size());
        }

        bool feed(const char* data, size_t len)
        {
            if (bytes.size() + len > maxSize_)
            {
                return false;
            }
            // persist current offset
            size_t readOffset = static_cast<size_t>(this->gptr() - this->eback());
            std::copy(data, data + len, std::back_inserter(bytes));
            Base::setg(bytes.data(), bytes.data() + readOffset,
                       bytes.data() + bytes.size());
            return true;
        }

        void reset()
        {
            std::vector<CharT> nbytes;
            bytes.swap(nbytes);
            Base::setg(bytes.data(), bytes.data(), bytes.data() + bytes.size());
        }

    private:
        std::vector<CharT> bytes;
        size_t maxSize_ = Const::MaxBuffer;
    };

    struct RawBuffer final
    {
        RawBuffer() = default;
        RawBuffer(std::string data, size_t length);
        RawBuffer(const char* data, size_t length);

        RawBuffer(const RawBuffer&)            = default;
        RawBuffer& operator=(const RawBuffer&) = default;
        RawBuffer(RawBuffer&&)                 = default;
        RawBuffer& operator=(RawBuffer&&)      = default;

        ~RawBuffer() = default;

        RawBuffer copy(size_t fromIndex = 0u) const;
        const std::string& data() const;
        size_t size() const;

    private:
        std::string data_;
        size_t length_ = 0;
    };

    struct FileBuffer
    {
        explicit FileBuffer(const std::string& fileName);

        int fd() const;
        size_t size() const;

    private:
        std::string fileName_;
        int fd_; // regular old file descriptor ("int") even in libevent case
        size_t size_;
    };

    class DynamicStreamBuf : public StreamBuf<char>
    {
    public:
        using Base        = StreamBuf<char>;
        using traits_type = typename Base::traits_type;
        using int_type    = typename Base::int_type;

        DynamicStreamBuf(size_t size, size_t maxSize);

        DynamicStreamBuf(const DynamicStreamBuf& other)            = delete;
        DynamicStreamBuf& operator=(const DynamicStreamBuf& other) = delete;

        DynamicStreamBuf(DynamicStreamBuf&& other);
        DynamicStreamBuf& operator=(DynamicStreamBuf&& other);

        RawBuffer buffer() const;

        void clear();

        size_t maxSize() const;

    protected:
        int_type overflow(int_type ch) override;

    private:
        void reserve(size_t size);

        std::vector<char> data_;
        size_t maxSize_ = Const::MaxBuffer;
    };

    class StreamCursor
    {
    public:
        explicit StreamCursor(StreamBuf<char>* _buf, size_t initialPos = 0)
            : buf(_buf)
        {
            advance(initialPos);
        }

        static constexpr int Eof = -1;

        struct Token
        {
            explicit Token(StreamCursor& _cursor)
                : cursor(_cursor)
                , position(cursor.buf->position())
                , eback(cursor.buf->begptr())
                , gptr(cursor.buf->curptr())
                , egptr(cursor.buf->endptr())
            { }

            size_t start() const { return position; }

            size_t end() const { return cursor.buf->position(); }

            size_t size() const { return end() - start(); }

            std::string text() const { return std::string(gptr, size()); }

            const char* rawText() const { return gptr; }

        private:
            StreamCursor& cursor;
            size_t position;
            char* eback;
            char* gptr;
            char* egptr;
        };

        struct Revert
        {
            explicit Revert(StreamCursor& _cursor)
                : cursor(_cursor)
                , eback(cursor.buf->begptr())
                , gptr(cursor.buf->curptr())
                , egptr(cursor.buf->endptr())
                , active(true)
            { }

            Revert(const Revert&)            = delete;
            Revert& operator=(const Revert&) = delete;

            ~Revert()
            {
                if (active)
                    revert();
            }

            void revert() { cursor.buf->setArea(eback, gptr, egptr); }

            void ignore() { active = false; }

        private:
            StreamCursor& cursor;
            char* eback;
            char* gptr;
            char* egptr;
            bool active;
        };

        bool advance(size_t count);
        operator size_t() const { return buf->position(); }

        bool eol() const;
        bool eof() const;
        int next() const;
        char current() const;

        const char* offset() const;
        const char* offset(size_t off) const;

        size_t diff(size_t other) const;
        size_t diff(const StreamCursor& other) const;

        size_t remaining() const;

        void reset();

    public:
        StreamBuf<char>* buf;
    };

    enum class CaseSensitivity { Sensitive,
                                 Insensitive };

    bool match_raw(const void* buf, size_t len, StreamCursor& cursor);
    bool match_string(const char* str, size_t len, StreamCursor& cursor,
                      CaseSensitivity cs = CaseSensitivity::Insensitive);
    template <size_t N>
    bool match_string(const char (&str)[N], StreamCursor& cursor,
                      CaseSensitivity cs = CaseSensitivity::Insensitive)
    {
        return match_string(str, N - 1, cursor, cs);
    }

    bool match_literal(char c, StreamCursor& cursor,
                       CaseSensitivity cs = CaseSensitivity::Insensitive);
    bool match_until(char c, StreamCursor& cursor,
                     CaseSensitivity cs = CaseSensitivity::Insensitive);
    bool match_until(std::initializer_list<char> chars, StreamCursor& cursor,
                     CaseSensitivity cs = CaseSensitivity::Insensitive);
    bool match_double(double* val, StreamCursor& cursor);

    void skip_whitespaces(StreamCursor& cursor);

} // namespace Pistache

Coverage Report

Created: 2026-09-03 06:57