b8ddaf9c33
EngineDebugger is the new interface to access the debugger.
It tries to be as agnostic as possible on the data that various
subsystems can expose.
It allows 2 types of interactions:
- Profilers:
A subsystem can register a profiler, assigning it a unique name.
That name can be used to activate the profiler or add data to it.
The registered profiler can be composed of up to 3 functions:
- Toggle: called when the profiler is activated/deactivated.
- Add: called whenever data is added to the debugger
(via `EngineDebugger::profiler_add_frame_data`)
- Tick: called every frame (during idle), receives frame times.
- Captures: (Only relevant in remote debugger for now)
A subsystem can register a capture, assigning it a unique name.
When receiving a message, the remote debugger will check if it starts
with `[prefix]:` and call the associated capture with name `prefix`.
Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new
profiler system.
Port SceneDebugger and RemoteDebugger to the new capture system.
The LocalDebugger also uses the new profiler system for scripts
profiling.
94 lines
3.6 KiB
C++
94 lines
3.6 KiB
C++
/*************************************************************************/
|
|
/* remote_debugger_peer.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef REMOTE_DEBUGGER_PEER_H
|
|
#define REMOTE_DEBUGGER_PEER_H
|
|
|
|
#include "core/io/stream_peer_tcp.h"
|
|
#include "core/os/mutex.h"
|
|
#include "core/os/thread.h"
|
|
#include "core/reference.h"
|
|
#include "core/ustring.h"
|
|
|
|
class RemoteDebuggerPeer : public Reference {
|
|
protected:
|
|
int max_queued_messages = 4096;
|
|
|
|
public:
|
|
static Ref<RemoteDebuggerPeer> create_from_uri(const String p_uri);
|
|
virtual bool is_peer_connected() = 0;
|
|
virtual bool has_message() = 0;
|
|
virtual Error put_message(const Array &p_arr) = 0;
|
|
virtual Array get_message() = 0;
|
|
virtual void close() = 0;
|
|
virtual void poll() = 0;
|
|
virtual int get_max_message_size() const = 0;
|
|
|
|
RemoteDebuggerPeer();
|
|
};
|
|
|
|
class RemoteDebuggerPeerTCP : public RemoteDebuggerPeer {
|
|
private:
|
|
Ref<StreamPeerTCP> tcp_client;
|
|
Mutex mutex;
|
|
Thread *thread = NULL;
|
|
List<Array> in_queue;
|
|
List<Array> out_queue;
|
|
int out_left = 0;
|
|
int out_pos = 0;
|
|
Vector<uint8_t> out_buf;
|
|
int in_left = 0;
|
|
int in_pos = 0;
|
|
Vector<uint8_t> in_buf;
|
|
bool connected = false;
|
|
bool running = false;
|
|
|
|
static void _thread_func(void *p_ud);
|
|
|
|
void _poll();
|
|
void _write_out();
|
|
void _read_in();
|
|
|
|
public:
|
|
Error connect_to_host(const String &p_host, uint16_t p_port);
|
|
|
|
void poll();
|
|
bool is_peer_connected();
|
|
bool has_message();
|
|
Array get_message();
|
|
Error put_message(const Array &p_arr);
|
|
int get_max_message_size() const;
|
|
void close();
|
|
|
|
RemoteDebuggerPeerTCP(Ref<StreamPeerTCP> p_stream = Ref<StreamPeerTCP>());
|
|
~RemoteDebuggerPeerTCP();
|
|
};
|
|
|
|
#endif // REMOTE_DEBUGGER_PEER_H
|