1/**************************************************************************/
2/* stream_peer.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef STREAM_PEER_H
32#define STREAM_PEER_H
33
34#include "core/object/ref_counted.h"
35
36#include "core/extension/ext_wrappers.gen.inc"
37#include "core/object/gdvirtual.gen.inc"
38#include "core/variant/native_ptr.h"
39
40class StreamPeer : public RefCounted {
41 GDCLASS(StreamPeer, RefCounted);
42
43protected:
44 static void _bind_methods();
45
46 //bind helpers
47 Error _put_data(const Vector<uint8_t> &p_data);
48 Array _put_partial_data(const Vector<uint8_t> &p_data);
49
50 Array _get_data(int p_bytes);
51 Array _get_partial_data(int p_bytes);
52
53 bool big_endian = false;
54
55public:
56 virtual Error put_data(const uint8_t *p_data, int p_bytes) = 0; ///< put a whole chunk of data, blocking until it sent
57 virtual Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) = 0; ///< put as much data as possible, without blocking.
58
59 virtual Error get_data(uint8_t *p_buffer, int p_bytes) = 0; ///< read p_bytes of data, if p_bytes > available, it will block
60 virtual Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) = 0; ///< read as much data as p_bytes into buffer, if less was read, return in r_received
61
62 virtual int get_available_bytes() const = 0;
63
64 /* helpers */
65 void set_big_endian(bool p_big_endian);
66 bool is_big_endian_enabled() const;
67
68 void put_8(int8_t p_val);
69 void put_u8(uint8_t p_val);
70 void put_16(int16_t p_val);
71 void put_u16(uint16_t p_val);
72 void put_32(int32_t p_val);
73 void put_u32(uint32_t p_val);
74 void put_64(int64_t p_val);
75 void put_u64(uint64_t p_val);
76 void put_float(float p_val);
77 void put_double(double p_val);
78 void put_string(const String &p_string);
79 void put_utf8_string(const String &p_string);
80 void put_var(const Variant &p_variant, bool p_full_objects = false);
81
82 uint8_t get_u8();
83 int8_t get_8();
84 uint16_t get_u16();
85 int16_t get_16();
86 uint32_t get_u32();
87 int32_t get_32();
88 uint64_t get_u64();
89 int64_t get_64();
90 float get_float();
91 double get_double();
92 String get_string(int p_bytes = -1);
93 String get_utf8_string(int p_bytes = -1);
94 Variant get_var(bool p_allow_objects = false);
95
96 StreamPeer() {}
97};
98
99class StreamPeerExtension : public StreamPeer {
100 GDCLASS(StreamPeerExtension, StreamPeer);
101
102protected:
103 static void _bind_methods();
104
105public:
106 virtual Error put_data(const uint8_t *p_data, int p_bytes) override;
107 GDVIRTUAL3R(Error, _put_data, GDExtensionConstPtr<const uint8_t>, int, GDExtensionPtr<int>);
108
109 virtual Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) override;
110 GDVIRTUAL3R(Error, _put_partial_data, GDExtensionConstPtr<const uint8_t>, int, GDExtensionPtr<int>);
111
112 virtual Error get_data(uint8_t *p_buffer, int p_bytes) override;
113 GDVIRTUAL3R(Error, _get_data, GDExtensionPtr<uint8_t>, int, GDExtensionPtr<int>);
114
115 virtual Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) override;
116 GDVIRTUAL3R(Error, _get_partial_data, GDExtensionPtr<uint8_t>, int, GDExtensionPtr<int>);
117
118 EXBIND0RC(int, get_available_bytes);
119};
120
121class StreamPeerBuffer : public StreamPeer {
122 GDCLASS(StreamPeerBuffer, StreamPeer);
123
124 Vector<uint8_t> data;
125 int pointer = 0;
126
127protected:
128 static void _bind_methods();
129
130public:
131 Error put_data(const uint8_t *p_data, int p_bytes) override;
132 Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) override;
133
134 Error get_data(uint8_t *p_buffer, int p_bytes) override;
135 Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) override;
136
137 virtual int get_available_bytes() const override;
138
139 void seek(int p_pos);
140 int get_size() const;
141 int get_position() const;
142 void resize(int p_size);
143
144 void set_data_array(const Vector<uint8_t> &p_data);
145 Vector<uint8_t> get_data_array() const;
146
147 void clear();
148
149 Ref<StreamPeerBuffer> duplicate() const;
150
151 StreamPeerBuffer() {}
152};
153
154#endif // STREAM_PEER_H
155