Gamedev Framework (gf)  0.1.0
A C++11 framework for 2D games
InputStream.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016 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_INPUT_STREAM_H
25 #define GF_INPUT_STREAM_H
26 
27 #include <cstddef>
28 
29 #include "Portability.h"
30 
31 namespace gf {
32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
33 inline namespace v1 {
34 #endif
35 
36  /**
37  * @ingroup core
38  * @brief Abstract class for custom file input streams
39  *
40  * This class allows users to define their own file input sources from
41  * which Gamedev Framework can load resources.
42  *
43  * Gamedev Framework resource classes like gf::Texture and gf::Shader
44  * provide `loadFromFile()` and `loadFromMemory()` functions, which read
45  * data from conventional sources. However, if you have data coming from
46  * a different source (over a network, embedded, encrypted, compressed,
47  * etc) you can derive your own class from gf::InputStream and load SFML
48  * resources with their `loadFromStream()` function.
49  *
50  */
52  public:
53  /**
54  * @brief Default constructor
55  */
56  InputStream() = default;
57 
58  /**
59  * @brief Deleted copy constructor
60  */
61  InputStream(const InputStream&) = delete;
62 
63  /**
64  * @brief Deleted copy assignment
65  */
66  InputStream& operator=(const InputStream&) = delete;
67 
68  /**
69  * @brief Destructor
70  */
71  virtual ~InputStream();
72 
73  /**
74  * @brief Read data from the stream
75  *
76  * After reading, the stream's reading position must be
77  * advanced by the amount of bytes read.
78  *
79  * @param data Buffer where to copy the read data
80  * @param size Desired number of bytes to read
81  *
82  * @return The number of bytes actually read
83  */
84  virtual std::size_t read(void* data, std::size_t size) = 0;
85 
86  /**
87  * @brief Change the current reading position
88  *
89  * @param position The position to seek to, from the beginning
90  *
91  * @return The position actually sought to
92  */
93  virtual long seek(long position) = 0;
94 
95  /**
96  * @brief Get the current reading position in the stream
97  *
98  * @return The current position
99  */
100  virtual long tell() = 0;
101 
102  /**
103  * @brief Return the size of the stream
104  *
105  * @return The total number of bytes available in the stream
106  */
107  virtual std::size_t getSize() = 0;
108 
109  };
110 
111 
112 #ifndef DOXYGEN_SHOULD_SKIP_THIS
113 }
114 #endif
115 }
116 
117 #endif // GF_INPUT_STREAM_H
virtual long tell()=0
Get the current reading position in the stream.
InputStream & operator=(const InputStream &)=delete
Deleted copy assignment.
InputStream()=default
Default constructor.
Definition: Action.h:34
Abstract class for custom file input streams.
Definition: InputStream.h:51
virtual std::size_t read(void *data, std::size_t size)=0
Read data from the stream.
virtual std::size_t getSize()=0
Return the size of the stream.
virtual ~InputStream()
Destructor.
#define GF_API
Definition: Portability.h:35
InputStream(const InputStream &)=delete
Deleted copy constructor.
virtual long seek(long position)=0
Change the current reading position.