Merge pull request #20028 from eska014/html5-refactor-os

Refactor HTML5 platform OS implementation

platform/javascript/dom_keys.h → platform/javascript/dom_keys.inc

@@ -1,5 +1,5 @@
 /*************************************************************************/
-/*  dom_keys.h                                                           */
+/*  dom_keys.inc                                                         */
 /*************************************************************************/
 /*                       This file is part of:                           */
 /*                           GODOT ENGINE                                */
@@ -28,9 +28,6 @@
 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
 /*************************************************************************/
 
-#ifndef DOM_KEYS_H
-#define DOM_KEYS_H
-
 #include "os/keyboard.h"
 
 // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode#Constants_for_keyCode_value
@@ -295,8 +292,8 @@ int dom2godot_scancode(int dom_keycode) {
 
 			//case DOM_VK_SELECT: return KEY_UNKNOWN;
 
-		case DOM_VK_PRINTSCREEN: // this is the usual printScreen key
-		case DOM_VK_PRINT: // maybe for alt+printScreen or physical printers?
+		case DOM_VK_PRINTSCREEN:
+		case DOM_VK_PRINT:
 			return KEY_PRINT;
 
 		//case DOM_VK_EXECUTE: return KEY_UNKNOWN;
@@ -311,11 +308,11 @@ int dom2godot_scancode(int dom_keycode) {
 		case DOM_VK_SLEEP:
 			return KEY_STANDBY;
 
-		// these are numpad keys according to MDN
+		// Numpad keys
 		case DOM_VK_MULTIPLY: return KEY_KP_MULTIPLY;
 		case DOM_VK_ADD: return KEY_KP_ADD;
 		case DOM_VK_SEPARATOR:
-			return KEY_KP_PERIOD; // good enough?
+			return KEY_KP_PERIOD; // Good enough?
 		case DOM_VK_SUBTRACT: return KEY_KP_SUBTRACT;
 		case DOM_VK_DECIMAL: return KEY_KP_PERIOD;
 		case DOM_VK_DIVIDE:
@@ -376,10 +373,8 @@ int dom2godot_scancode(int dom_keycode) {
 		case DOM_VK_QUOTE:
 			return KEY_APOSTROPHE;
 
-			// rest is OEM/unusual
+			// The rest is OEM/unusual.
 
 		default: return KEY_UNKNOWN;
 	};
 }
-
-#endif

platform/javascript/javascript_main.cpp

@@ -28,17 +28,11 @@
 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
 /*************************************************************************/
 
-#include "emscripten.h"
 #include "io/resource_loader.h"
 #include "main/main.h"
 #include "os_javascript.h"
 
-OS_JavaScript *os = NULL;
-
-static void main_loop() {
-
-	os->main_loop_iterate();
-}
+#include <emscripten/emscripten.h>
 
 extern "C" EMSCRIPTEN_KEEPALIVE void main_after_fs_sync(char *p_idbfs_err) {
 
@@ -46,18 +40,18 @@ extern "C" EMSCRIPTEN_KEEPALIVE void main_after_fs_sync(char *p_idbfs_err) {
 	if (!idbfs_err.empty()) {
 		print_line("IndexedDB not available: " + idbfs_err);
 	}
-	os->set_idbfs_available(idbfs_err.empty());
-	// Ease up compatibility
+	OS_JavaScript *os = OS_JavaScript::get_singleton();
+	os->set_idb_available(idbfs_err.empty());
+	// Ease up compatibility.
 	ResourceLoader::set_abort_on_missing_resources(false);
 	Main::start();
-	os->main_loop_begin();
-	emscripten_set_main_loop(main_loop, 0, false);
+	os->run_async();
 }
 
 int main(int argc, char *argv[]) {
 
-	// sync from persistent state into memory and then
-	// run the 'main_after_fs_sync' function
+	// Sync from persistent state into memory and then
+	// run the 'main_after_fs_sync' function.
 	/* clang-format off */
 	EM_ASM(
 		FS.mkdir('/userfs');
@@ -68,9 +62,10 @@ int main(int argc, char *argv[]) {
 	);
 	/* clang-format on */
 
-	os = new OS_JavaScript(argv[0], NULL);
-	Error err = Main::setup(argv[0], argc - 1, &argv[1]);
+	new OS_JavaScript(argc, argv);
+	// TODO: Check error return value.
+	Main::setup(argv[0], argc - 1, &argv[1]);
 
 	return 0;
-	// continued async in main_after_fs_sync() from syncfs() callback
+	// Continued async in main_after_fs_sync() from the syncfs() callback.
 }

platform/javascript/os_javascript.h

@@ -32,52 +32,56 @@
 #define OS_JAVASCRIPT_H
 
 #include "audio_driver_javascript.h"
-#include "drivers/unix/os_unix.h"
 #include "main/input_default.h"
-#include "os/input.h"
-#include "os/main_loop.h"
 #include "servers/audio_server.h"
 #include "servers/visual/rasterizer.h"
+#include "unix/os_unix.h"
 
 #include <emscripten/html5.h>
 
-typedef String (*GetUserDataDirFunc)();
-
 class OS_JavaScript : public OS_Unix {
 
-	bool idbfs_available;
-	int64_t time_to_save_sync;
-	int64_t last_sync_time;
-
-	VisualServer *visual_server;
-	AudioDriverJavaScript audio_driver_javascript;
-
-	InputDefault *input;
+	VideoMode video_mode;
 	Vector2 windowed_size;
 	bool window_maximized;
-	bool soft_fs_enabled;
+	bool soft_fullscreen_enabled;
 	bool canvas_size_adjustment_requested;
-	VideoMode video_mode;
+
+	InputDefault *input;
+	Ref<InputEventKey> deferred_key_event;
 	CursorShape cursor_shape;
+	Point2 touches[32];
+
 	MainLoop *main_loop;
+	AudioDriverJavaScript audio_driver_javascript;
 
-	GetUserDataDirFunc get_user_data_dir_func;
+	bool idb_available;
+	int64_t sync_wait_time;
+	int64_t last_sync_check_time;
 
-	static void _close_notification_funcs(const String &p_file, int p_flags);
+	static EM_BOOL browser_resize_callback(int p_event_type, const EmscriptenUiEvent *p_event, void *p_user_data);
+	static EM_BOOL fullscreen_change_callback(int p_event_type, const EmscriptenFullscreenChangeEvent *p_event, void *p_user_data);
 
-	void process_joypads();
+	static EM_BOOL keydown_callback(int p_event_type, const EmscriptenKeyboardEvent *p_event, void *p_user_data);
+	static EM_BOOL keypress_callback(int p_event_type, const EmscriptenKeyboardEvent *p_event, void *p_user_data);
+	static EM_BOOL keyup_callback(int p_event_type, const EmscriptenKeyboardEvent *p_event, void *p_user_data);
 
-	void set_css_cursor(const char *);
-	const char *get_css_cursor() const;
+	static EM_BOOL mousemove_callback(int p_event_type, const EmscriptenMouseEvent *p_event, void *p_user_data);
+	static EM_BOOL mouse_button_callback(int p_event_type, const EmscriptenMouseEvent *p_event, void *p_user_data);
 
-public:
-	// functions used by main to initialize/deintialize the OS
-	virtual int get_video_driver_count() const;
-	virtual const char *get_video_driver_name(int p_driver) const;
+	static EM_BOOL wheel_callback(int p_event_type, const EmscriptenWheelEvent *p_event, void *p_user_data);
 
-	virtual int get_audio_driver_count() const;
-	virtual const char *get_audio_driver_name(int p_driver) const;
+	static EM_BOOL touch_press_callback(int p_event_type, const EmscriptenTouchEvent *p_event, void *p_user_data);
+	static EM_BOOL touchmove_callback(int p_event_type, const EmscriptenTouchEvent *p_event, void *p_user_data);
+
+	static EM_BOOL gamepad_change_callback(int p_event_type, const EmscriptenGamepadEvent *p_event, void *p_user_data);
+	void process_joypads();
 
+	static void main_loop_callback();
+
+	static void file_access_close_callback(const String &p_file, int p_flags);
+
+protected:
 	virtual void initialize_core();
 	virtual Error initialize(const VideoMode &p_desired, int p_video_driver, int p_audio_driver);
 
@@ -86,77 +90,64 @@ public:
 
 	virtual void finalize();
 
-	typedef int64_t ProcessID;
-
-	//static OS* get_singleton();
-
-	virtual void alert(const String &p_alert, const String &p_title = "ALERT!");
-
-	virtual void set_mouse_mode(MouseMode p_mode);
-	virtual MouseMode get_mouse_mode() const;
-	virtual Point2 get_mouse_position() const;
-	virtual int get_mouse_button_state() const;
-	virtual void set_window_title(const String &p_title);
+	virtual bool _check_internal_feature_support(const String &p_feature);
 
-	//virtual void set_clipboard(const String& p_text);
-	//virtual String get_clipboard() const;
+public:
+	// Override return type to make writing static callbacks less tedious.
+	static OS_JavaScript *get_singleton();
 
 	virtual void set_video_mode(const VideoMode &p_video_mode, int p_screen = 0);
 	virtual VideoMode get_video_mode(int p_screen = 0) const;
 	virtual void get_fullscreen_mode_list(List<VideoMode> *p_list, int p_screen = 0) const;
 
-	virtual Size2 get_screen_size(int p_screen = -1) const;
-
 	virtual void set_window_size(const Size2);
 	virtual Size2 get_window_size() const;
 	virtual void set_window_maximized(bool p_enabled);
-	virtual bool is_window_maximized() const { return window_maximized; }
-	virtual void set_window_fullscreen(bool p_enable);
+	virtual bool is_window_maximized() const;
+	virtual void set_window_fullscreen(bool p_enabled);
 	virtual bool is_window_fullscreen() const;
+	virtual Size2 get_screen_size(int p_screen = -1) const;
 
-	void request_canvas_size_adjustment();
+	virtual Point2 get_mouse_position() const;
+	virtual int get_mouse_button_state() const;
+	virtual void set_cursor_shape(CursorShape p_shape);
+	virtual void set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot);
+	virtual void set_mouse_mode(MouseMode p_mode);
+	virtual MouseMode get_mouse_mode() const;
 
-	virtual String get_name();
-	virtual MainLoop *get_main_loop() const;
+	virtual bool has_touchscreen_ui_hint() const;
 
-	virtual bool can_draw() const;
+	virtual bool is_joy_known(int p_device);
+	virtual String get_joy_guid(int p_device) const;
 
-	virtual bool is_userfs_persistent() const;
+	virtual int get_video_driver_count() const;
+	virtual const char *get_video_driver_name(int p_driver) const;
 
-	virtual void set_cursor_shape(CursorShape p_shape);
-	virtual void set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot);
+	virtual int get_audio_driver_count() const;
+	virtual const char *get_audio_driver_name(int p_driver) const;
 
-	void main_loop_begin();
+	virtual MainLoop *get_main_loop() const;
+	void run_async();
 	bool main_loop_iterate();
-	void main_loop_request_quit();
-	void main_loop_end();
-	void main_loop_focusout();
-	void main_loop_focusin();
 
-	virtual bool has_touchscreen_ui_hint() const;
-
-	virtual Error shell_open(String p_uri);
-	virtual String get_user_data_dir() const;
+	virtual void alert(const String &p_alert, const String &p_title = "ALERT!");
+	virtual void set_window_title(const String &p_title);
 	String get_executable_path() const;
-	virtual String get_resource_dir() const;
-
-	void process_accelerometer(const Vector3 &p_accelerometer);
-	void push_input(const Ref<InputEvent> &p_ev);
+	virtual Error shell_open(String p_uri);
+	virtual String get_name();
+	virtual bool can_draw() const;
 
-	virtual bool is_joy_known(int p_device);
-	virtual String get_joy_guid(int p_device) const;
-	bool joy_connection_changed(int p_type, const EmscriptenGamepadEvent *p_event);
+	virtual String get_resource_dir() const;
+	virtual String get_user_data_dir() const;
 
 	virtual OS::PowerState get_power_state();
 	virtual int get_power_seconds_left();
 	virtual int get_power_percent_left();
 
-	virtual bool _check_internal_feature_support(const String &p_feature);
-
-	void set_idbfs_available(bool p_idbfs_available);
+	void set_idb_available(bool p_idb_available);
+	virtual bool is_userfs_persistent() const;
 
-	OS_JavaScript(const char *p_execpath, GetUserDataDirFunc p_get_user_data_dir_func);
-	~OS_JavaScript();
+	OS_JavaScript(int p_argc, char *p_argv[]);
 };
 
 #endif