1/**************************************************************************/
2/* editor_debugger_server.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 EDITOR_DEBUGGER_SERVER_H
32#define EDITOR_DEBUGGER_SERVER_H
33
34#include "core/debugger/remote_debugger_peer.h"
35#include "core/object/ref_counted.h"
36
37class EditorDebuggerServer : public RefCounted {
38public:
39 typedef EditorDebuggerServer *(*CreateServerFunc)(const String &p_uri);
40
41private:
42 static HashMap<StringName, CreateServerFunc> protocols;
43
44public:
45 static void initialize();
46 static void deinitialize();
47
48 static void register_protocol_handler(const String &p_protocol, CreateServerFunc p_func);
49 static EditorDebuggerServer *create(const String &p_protocol);
50
51 virtual String get_uri() const = 0;
52 virtual void poll() = 0;
53 virtual Error start(const String &p_uri) = 0;
54 virtual void stop() = 0;
55 virtual bool is_active() const = 0;
56 virtual bool is_connection_available() const = 0;
57 virtual Ref<RemoteDebuggerPeer> take_connection() = 0;
58};
59
60#endif // EDITOR_DEBUGGER_SERVER_H
61