iodevice.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
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 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Mark Page
28 */
29 
30 
31 #pragma once
32 
33 #include "../System/cl_platform.h"
34 #include <memory>
35 #include <string>
36 
37 namespace clan
38 {
41 
42 class IODeviceProvider;
43 class IODevice_Impl;
44 
50 class IODevice
51 {
54 
55 public:
57  enum SeekMode
58  {
61 
64 
66  seek_end
67  };
68 
72 
73 public:
76 
81 
83 
87 
88 public:
90  bool is_null() const { return !impl; }
91 
93  void throw_if_null() const;
94 
96 
98  int get_size() const;
99 
101 
103  int get_position() const;
104 
106 
107  bool is_little_endian() const;
108 
111 
114 
118 
119 public:
121 
126  int send(const void *data, int len, bool send_all = true);
127 
135  int receive(void *data, int len, bool receive_all = true);
136 
142  int peek(void *data, int len);
143 
149  bool seek(int position, SeekMode mode = seek_set);
150 
158  int read(void *data, int len, bool receive_all = true);
159 
167  int write(const void *data, int len, bool send_all = true);
168 
171 
174 
177 
181  void write_int64(int64_t data);
182 
186  void write_uint64(uint64_t data);
187 
191  void write_int32(int32_t data);
192 
196  void write_uint32(uint32_t data);
197 
201  void write_int16(int16_t data);
202 
206  void write_uint16(uint16_t data);
207 
211  void write_int8(int8_t data);
212 
216  void write_uint8(uint8_t data);
217 
223  void write_float(float data);
224 
231  void write_string_a(const std::string &str);
232 
238  void write_string_nul(const std::string &str);
239 
247  void write_string_text(const std::string &str);
248 
250 
251  int64_t read_int64();
252 
254 
255  uint64_t read_uint64();
256 
258 
259  int32_t read_int32();
260 
262 
263  uint32_t read_uint32();
264 
266 
267  int16_t read_int16();
268 
270 
271  uint16_t read_uint16();
272 
274 
275  int8_t read_int8();
276 
278 
279  uint8_t read_uint8();
280 
282 
284  float read_float();
285 
287 
290  std::string read_string_a();
291 
293 
296  std::string read_string_nul();
297 
307  std::string read_string_text(const char *skip_initial_chars, const char *read_until_chars, bool allow_eof = true);
308 
311 
315 
316 protected:
317  std::shared_ptr<IODevice_Impl> impl;
319 };
320 
321 }
322 
void write_float(float data)
Writes a float to output source.
bool is_little_endian() const
Returns true if the input source is in little endian mode.
void set_big_endian_mode()
Changes input data endianess to big endian mode. (Default is little endian)
int write(const void *data, int len, bool send_all=true)
Alias for send(data, len, send_all)
@ seek_set
Set to a specific value from the start.
Definition: iodevice.h:60
void write_uint16(uint16_t data)
Writes an unsigned 16 bit integer to output source.
int send(const void *data, int len, bool send_all=true)
Send data to device.
int get_size() const
Returns the size of data stream.
void write_string_text(const std::string &str)
Writes a text string to the output source.
void write_int16(int16_t data)
Writes a signed 16 bit integer to output source.
int64_t read_int64()
Reads a signed 64 bit integer from input source.
IODevice duplicate()
Create a new IODevice referencing the same resource.
int8_t read_int8()
Reads a signed 8 bit integer from input source.
void write_int64(int64_t data)
Writes a signed 64 bit integer to output source.
int peek(void *data, int len)
Peek data from device (data is left in the buffer).
void write_string_a(const std::string &str)
Writes a string to the output source.
IODevice(IODeviceProvider *provider)
Constructs a IODevice.
I/O Device interface.
Definition: iodevice.h:51
void write_int32(int32_t data)
Writes a signed 32 bit integer to output source.
int read(void *data, int len, bool receive_all=true)
Alias for receive(data, len, receive_all)
const IODeviceProvider * get_provider() const
Returns the provider for this object.
void write_uint32(uint32_t data)
Writes an unsigned 32 bit integer to output source.
void write_uint8(uint8_t data)
Writes an unsigned 8 bit integer to output source.
@ seek_end
Set to a specific value from the end (use negative position)
Definition: iodevice.h:66
uint8_t read_uint8()
Reads an unsigned 8 bit integer from input source.
std::string read_string_a()
Reads a string from the input source.
bool is_null() const
Returns true if this object is invalid.
Definition: iodevice.h:90
bool seek(int position, SeekMode mode=seek_set)
Seek in data stream.
float read_float()
Reads a float from input source.
int16_t read_int16()
Reads a signed 16 bit integer from input source.
std::string read_string_text(const char *skip_initial_chars, const char *read_until_chars, bool allow_eof=true)
Reads a string from the input source where the source is a text file.
IODeviceProvider * get_provider()
Returns the provider for this object.
@ seek_cur
Set relative to the current position.
Definition: iodevice.h:63
I/O device provider interface.
Definition: iodevice_provider.h:41
IODevice()
Constructs a null instance.
std::string read_string_nul()
Reads a nul terminated string from the input source.
void set_system_mode()
Changes input data endianess to the local systems mode.
uint32_t read_uint32()
Reads an unsigned 32 bit integer from input source.
uint64_t read_uint64()
Reads an unsigned 64 bit integer from input source.
void set_little_endian_mode()
Changes input data endianess to little endian mode. This is the default setting.
std::shared_ptr< IODevice_Impl > impl
Definition: iodevice.h:317
Definition: clanapp.h:36
SeekMode
Seeking modes.
Definition: iodevice.h:58
void throw_if_null() const
Throw an exception if this object is invalid.
void write_uint64(uint64_t data)
Writes an unsigned 64 bit integer to output source.
void write_int8(int8_t data)
Writes a signed 8 bit integer to output source.
int32_t read_int32()
Reads a signed 32 bit integer from input source.
int receive(void *data, int len, bool receive_all=true)
Receive data from device.
uint16_t read_uint16()
Reads an unsigned 16 bit integer from input source.
void write_string_nul(const std::string &str)
Writes a nul terminated string to the output source.
int get_position() const
Returns the position in the data stream.