Gamedev Framework (gf)  0.4.0
A C++11 framework for 2D games
InputStreams.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2017 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_STREAMS_H
25 #define GF_INPUT_STREAMS_H
26 
27 #include <cstddef>
28 #include <cstdio>
29 
30 #include "InputStream.h"
31 #include "Path.h"
32 #include "Portability.h"
33 
34 namespace gf {
35 #ifndef DOXYGEN_SHOULD_SKIP_THIS
36 inline namespace v1 {
37 #endif
38 
39  /**
40  * @ingroup core
41  * @brief File based input stream
42  */
44  public:
45  /**
46  * @brief Constructor
47  *
48  * The constructor opens the file. If the file is not opened, the
49  * operations will return default values.
50  *
51  * @param path The path to the file
52  */
53  explicit FileInputStream(const Path& path);
54 
55  /**
56  * @brief Destructor
57  *
58  * The destructor closes the file.
59  */
60  ~FileInputStream();
61 
62  virtual std::size_t read(void* data, std::size_t size) override;
63 
64  virtual long seek(long position) override;
65 
66  virtual long tell() override;
67 
68  virtual std::size_t getSize() override;
69 
70  private:
71  std::FILE *m_file;
72  std::size_t m_size;
73  };
74 
75 
76  /**
77  * @ingroup core
78  * @brief Memory based input stream
79  */
81  public:
82  /**
83  * @brief Constructor
84  *
85  * This class does not own the memory. The user must keep the memory
86  * available when the stream is active.
87  *
88  * @param data Pointer to the data
89  * @param size Size of the data
90  */
91  MemoryInputStream(const void *data, std::size_t size);
92 
93  virtual std::size_t read(void* data, std::size_t size) override;
94 
95  virtual long seek(long position) override;
96 
97  virtual long tell() override;
98 
99  virtual std::size_t getSize() override;
100 
101  private:
102  const char *m_data;
103  std::size_t m_size;
104  long m_offset;
105  };
106 
107 #ifndef DOXYGEN_SHOULD_SKIP_THIS
108 }
109 #endif
110 }
111 
112 #endif // GF_INPUT_STREAMS_H
virtual std::size_t getSize() override
Return the size of the stream.
virtual std::size_t read(void *data, std::size_t size) override
Read data from the stream.
virtual long seek(long position) override
Change the current reading position.
File based input stream.
Definition: InputStreams.h:43
virtual long tell() override
Get the current reading position in the stream.
virtual std::size_t read(void *data, std::size_t size) override
Read data from the stream.
virtual long tell() override
Get the current reading position in the stream.
~FileInputStream()
Destructor.
The namespace for gf classes.
Definition: Action.h:34
Abstract class for custom file input streams.
Definition: InputStream.h:51
Memory based input stream.
Definition: InputStreams.h:80
MemoryInputStream(const void *data, std::size_t size)
Constructor.
virtual std::size_t getSize() override
Return the size of the stream.
#define GF_API
Definition: Portability.h:35
virtual long seek(long position) override
Change the current reading position.
FileInputStream(const Path &path)
Constructor.