Gamedev Framework (gf)  0.10.0
A C++14 framework for 2D games
Stream.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2018 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  *
21  * Part of this file comes from SFML, with the same license:
22  * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
23  */
24 #ifndef GF_STREAM_H
25 #define GF_STREAM_H
26 
27 #include <cstddef>
28 
29 #include "ArrayRef.h"
30 #include "BufferRef.h"
31 #include "Portability.h"
32 
33 namespace gf {
34 #ifndef DOXYGEN_SHOULD_SKIP_THIS
35 inline namespace v1 {
36 #endif
37 
54  class GF_API InputStream {
55  public:
59  InputStream() = default;
60 
64  InputStream(const InputStream&) = delete;
65 
69  InputStream& operator=(const InputStream&) = delete;
70 
74  virtual ~InputStream();
75 
86  virtual std::size_t read(BufferRef<uint8_t> buffer) = 0;
87 
98  std::size_t read(uint8_t& byte) {
99  return read(BufferRef<uint8_t>(&byte, 1));
100  }
101 
107  virtual void seek(std::ptrdiff_t position) = 0;
108 
114  virtual void skip(std::ptrdiff_t position) = 0;
115 
121  virtual bool isFinished() = 0;
122 
123  };
124 
125 
135  class GF_API OutputStream {
136  public:
140  OutputStream() = default;
141 
145  OutputStream(const InputStream&) = delete;
146 
150  OutputStream& operator=(const InputStream&) = delete;
151 
155  virtual ~OutputStream();
156 
164  virtual std::size_t write(ArrayRef<uint8_t> buffer) = 0;
165 
173  std::size_t write(uint8_t byte) {
174  return write(ArrayRef<uint8_t>(&byte, 1));
175  }
176 
177  };
178 
179 #ifndef DOXYGEN_SHOULD_SKIP_THIS
180 }
181 #endif
182 }
183 
184 #endif // GF_STREAM_H
Abstract class for custom file output streams.
Definition: Stream.h:135
std::size_t read(uint8_t &byte)
Read a single byte from the stream.
Definition: Stream.h:98
std::size_t write(uint8_t byte)
Write a single byte to the stream.
Definition: Stream.h:173
The namespace for gf classes.
Definition: Action.h:34
Abstract class for custom file input streams.
Definition: Stream.h:54