godot/core/io/stream_peer.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

155 lines
5.9 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* stream_peer.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef STREAM_PEER_H
#define STREAM_PEER_H
2021-06-04 16:03:15 +00:00
#include "core/object/ref_counted.h"
2014-02-10 01:10:30 +00:00
#include "core/extension/ext_wrappers.gen.inc"
2021-09-06 15:30:20 +00:00
#include "core/object/gdvirtual.gen.inc"
#include "core/variant/native_ptr.h"
2021-06-04 16:03:15 +00:00
class StreamPeer : public RefCounted {
GDCLASS(StreamPeer, RefCounted);
2014-02-10 01:10:30 +00:00
protected:
static void _bind_methods();
//bind helpers
Error _put_data(const Vector<uint8_t> &p_data);
Array _put_partial_data(const Vector<uint8_t> &p_data);
2014-02-10 01:10:30 +00:00
Array _get_data(int p_bytes);
Array _get_partial_data(int p_bytes);
bool big_endian = false;
2014-02-10 01:10:30 +00:00
public:
virtual Error put_data(const uint8_t *p_data, int p_bytes) = 0; ///< put a whole chunk of data, blocking until it sent
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.
virtual Error get_data(uint8_t *p_buffer, int p_bytes) = 0; ///< read p_bytes of data, if p_bytes > available, it will block
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
virtual int get_available_bytes() const = 0;
2021-09-06 15:30:20 +00:00
/* helpers */
void set_big_endian(bool p_big_endian);
bool is_big_endian_enabled() const;
void put_8(int8_t p_val);
void put_u8(uint8_t p_val);
void put_16(int16_t p_val);
void put_u16(uint16_t p_val);
void put_32(int32_t p_val);
void put_u32(uint32_t p_val);
void put_64(int64_t p_val);
void put_u64(uint64_t p_val);
void put_float(float p_val);
void put_double(double p_val);
void put_string(const String &p_string);
void put_utf8_string(const String &p_string);
void put_var(const Variant &p_variant, bool p_full_objects = false);
uint8_t get_u8();
int8_t get_8();
uint16_t get_u16();
int16_t get_16();
uint32_t get_u32();
int32_t get_32();
uint64_t get_u64();
int64_t get_64();
float get_float();
double get_double();
String get_string(int p_bytes = -1);
String get_utf8_string(int p_bytes = -1);
Variant get_var(bool p_allow_objects = false);
StreamPeer() {}
2014-02-10 01:10:30 +00:00
};
2021-09-06 15:30:20 +00:00
class StreamPeerExtension : public StreamPeer {
GDCLASS(StreamPeerExtension, StreamPeer);
protected:
static void _bind_methods();
public:
virtual Error put_data(const uint8_t *p_data, int p_bytes) override;
GDVIRTUAL3R(Error, _put_data, GDExtensionConstPtr<const uint8_t>, int, GDExtensionPtr<int>);
2021-09-06 15:30:20 +00:00
virtual Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) override;
GDVIRTUAL3R(Error, _put_partial_data, GDExtensionConstPtr<const uint8_t>, int, GDExtensionPtr<int>);
2021-09-06 15:30:20 +00:00
virtual Error get_data(uint8_t *p_buffer, int p_bytes) override;
GDVIRTUAL3R(Error, _get_data, GDExtensionPtr<uint8_t>, int, GDExtensionPtr<int>);
2021-09-06 15:30:20 +00:00
virtual Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) override;
GDVIRTUAL3R(Error, _get_partial_data, GDExtensionPtr<uint8_t>, int, GDExtensionPtr<int>);
2021-09-06 15:30:20 +00:00
EXBIND0RC(int, get_available_bytes);
2021-09-06 15:30:20 +00:00
};
class StreamPeerBuffer : public StreamPeer {
GDCLASS(StreamPeerBuffer, StreamPeer);
Vector<uint8_t> data;
int pointer = 0;
protected:
static void _bind_methods();
public:
2020-07-10 10:34:39 +00:00
Error put_data(const uint8_t *p_data, int p_bytes) override;
Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) override;
2020-07-10 10:34:39 +00:00
Error get_data(uint8_t *p_buffer, int p_bytes) override;
Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) override;
2020-07-10 10:34:39 +00:00
virtual int get_available_bytes() const override;
void seek(int p_pos);
int get_size() const;
int get_position() const;
void resize(int p_size);
void set_data_array(const Vector<uint8_t> &p_data);
Vector<uint8_t> get_data_array() const;
void clear();
Ref<StreamPeerBuffer> duplicate() const;
StreamPeerBuffer() {}
};
2014-02-10 01:10:30 +00:00
#endif // STREAM_PEER_H