Stream.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 *
 * Part of this file comes from SFML, with the same license:
 * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
 */
#ifndef GF_STREAM_H
#define GF_STREAM_H

#include <cstddef>
#include <cstdint>

#include "CoreApi.h"
#include "Span.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class GF_CORE_API InputStream {
  public:
    InputStream() = default;

    InputStream(const InputStream&) = delete;

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

    virtual ~InputStream();

    virtual std::size_t read(Span<uint8_t> buffer) = 0; // Flawfinder: ignore

    std::size_t read(uint8_t& byte) {        // Flawfinder: ignore
      return read(Span<uint8_t>(&byte, 1));  // Flawfinder: ignore
    }

    virtual void seek(std::ptrdiff_t position) = 0;

    virtual void skip(std::ptrdiff_t position) = 0;

    virtual bool isFinished() = 0;

  };


  class GF_CORE_API OutputStream {
  public:
    OutputStream() = default;

    OutputStream(const OutputStream&) = delete;

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

    virtual ~OutputStream();

    virtual std::size_t write(Span<const uint8_t> buffer) = 0;

    std::size_t write(uint8_t byte) {
      return write(Span<const uint8_t>(&byte, 1));
    }

    virtual std::size_t getWrittenBytesCount() const = 0;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_STREAM_H