OSD/OSK: quality of life improvements #435

* Android "back" button can exit from OSK, exit from menu and back in
  the menu system
* "Zoomed" version of the current key hovered is displayed to be able
  to use OSK without an eagle-eyesight

Author: lgblgblgb

xemu/emutools.c

@@ -1300,6 +1300,10 @@ int xemu_post_init (
 #if defined(SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK) && defined(XEMU_ARCH_MAC)
 #	warning "Activating workaround for lame newer Apple notebooks (no right click on touchpads)"
 	SDL_SetHint(SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK, "1");			// 1 = enable CTRL + click = right click (needed for modern Mac touchpads, it seems)
+#endif
+#if defined(SDL_HINT_ANDROID_TRAP_BACK_BUTTON) && defined(XEMU_ARCH_ANDROID)
+#	warning "BACK button trap has been activated."
+	SDL_SetHint(SDL_HINT_ANDROID_TRAP_BACK_BUTTON, "1");
 #endif
 	/* end of SDL hints section */
 	if (sdl_default_win_x_pos == SDL_WINDOWPOS_UNDEFINED && sdl_default_win_y_pos == SDL_WINDOWPOS_UNDEFINED)

xemu/emutools_hid.c

@@ -22,6 +22,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 #endif
 #include "xemu/emutools_osk.h"
 
+#if defined(XEMU_ARCH_ANDROID) && !defined(XEMU_OSK_SUPPORT)
+#error "Android builds needs XEMU_OSK_SUPPORT to be enabled."
+#endif
+
 
 /* Note: HID stands for "Human Input Devices" or something like that :)
    That is: keyboard, joystick, mouse.
@@ -589,6 +593,12 @@ int hid_handle_one_sdl_event ( SDL_Event *event )
 			break;
 		case SDL_KEYUP:
 		case SDL_KEYDOWN:
+#ifdef XEMU_ARCH_ANDROID
+			if (event->type == SDL_KEYDOWN && event->key.keysym.sym == SDLK_AC_BACK) {	// Android "back" button
+				osk_show(!osk_status());
+				break;
+			}
+#endif
 			if (
 				event->key.keysym.scancode != SDL_SCANCODE_UNKNOWN
 #ifdef CONFIG_KBD_SELECT_FOCUS

xemu/emutools_osk.c

@@ -22,19 +22,24 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 #include "xemu/emutools_osk.h"
 #include "xemu/emutools_hid.h"
 
+// Do not change these, identifiers
 #define OSK_KEY_HIDE	-100
 #define OSK_KEY_MENU	-101
 
-#define AUTO_RELEASE_MS	20
+// Release key after this amount of milliseconds (unless it's a toogle key)
+#define AUTO_RELEASE_MS	50
+// Zoom factor (>=1 integer) of the current key shown. Set to zero, to disable this feature
+#define ZOOM_FACTOR	3
 
+// Colours (R,G,B,A) - 'A' being the alpha channel
 #define	COLOUR_OUTLINE	0xFF, 0xFF, 0xFF, 0xFF
 #define COLOUR_TEXT	0xFF, 0xFF, 0xFF, 0xFF
 #define COLOUR_BG	0xFF, 0xFF, 0xFF, 0x80
 #define COLOUR_BGHOVER	0xFF, 0x00, 0x00, 0xFF
 #define COLOUR_BGPRESS	0x00, 0xFF, 0x00, 0xFF
 #define COLOUR_BGLOCKED	0x00, 0x00, 0xFF, 0xFF
 
-#define RETURN_IF_NO_OSK()		\
+#define RETURN_IF_NO_OSK()	\
 	if (!in_use || !tex)	\
 		return false;
 
@@ -55,25 +60,38 @@ static int all_keys = 0;
 static int hovered = -1;
 static int last_pressed = -1;
 static Uint32 press_time;
+static struct { int x1, y1, x2, y2; } last_zoomed;
 
 
 
-static void draw_text ( const char *s, int len, int xo, int yo, bool clear_too )
+static void draw_text ( const char *s, int len, int xo, int yo, int scale, bool clear_too )
 {
 	while (len > 0) {
 		const Uint8 *f = vga_font_8x8 + (*s) * 8;
-		for (int y = yo; y < yo + 8; y++) {
-			Uint32 *p = osk + y * size_x + xo;
-			Uint8 c = *(f++);
-			for (int x = 0; x < 8; x++, c <<= 1, p++)
-				if (c & 0x80)
-					*p = colour.text;
-				else if (clear_too)
-					*p = colour.bg;
-		}
+		for (int y = 0; y < 8; y++, f++)
+			for (int ysc = 0; ysc < scale; ysc++) {
+				Uint32 *p = osk + (y * scale + ysc + yo) * size_x + xo;
+				Uint8 c = *f;
+				for (int x = 0; x < 8; x++, c <<= 1)
+					for (int xsc = 0; xsc < scale; xsc++, p++)
+						if (c & 0x80)
+							*p = colour.text;
+						else if (clear_too)
+							*p = colour.bg;
+			}
 		s++;
 		len--;
-		xo += 8;
+		xo += 8 * scale;
+	}
+}
+
+
+static void fill_rectangle ( const int x1, const int y1, const int x2, const int y2, const Uint32 sdl_colour )
+{
+	for (int y = y1; y <= y2; y++) {
+		Uint32 *p = osk + size_x * y + x1;
+		for (int x = x1; x <= x2; x++)
+			*p++ = sdl_colour;
 	}
 }
 
@@ -104,8 +122,26 @@ static void draw_key ( const int i, const bool active )
 		s, l,
 		(keys[i].x2 - keys[i].x1 - l * 8) / 2 + keys[i].x1,
 		(keys[i].y2 - keys[i].y1 - 4    ) / 2 + keys[i].y1,
-		false
+		1, false
 	);
+	// Clearing/showing a "zoomed" version of the current key
+	if (ZOOM_FACTOR > 0) {
+		if (last_zoomed.x1 >= 0) {
+			fill_rectangle(last_zoomed.x1, last_zoomed.y1, last_zoomed.x2, last_zoomed.y2, 0);
+			last_zoomed.x1 = -1;
+		}
+		if (active) {
+			// Also add 4 pix "border" (y will be 4 where text is positioned, etc)
+			last_zoomed.x1 = (size_x - l * ZOOM_FACTOR * 8 - 2*4) / 2;
+			last_zoomed.y1 = 0;
+			last_zoomed.x2 = last_zoomed.x1 + l * ZOOM_FACTOR * 8 + 4;
+			last_zoomed.y2 = ZOOM_FACTOR * 8 + 8;
+			if (last_zoomed.x1 >= 0) {
+				fill_rectangle(last_zoomed.x1, last_zoomed.y1, last_zoomed.x2, last_zoomed.y2, colour.bg);
+				draw_text(s, l, last_zoomed.x1 + 4, last_zoomed.y1 + 4, ZOOM_FACTOR, false);
+			}
+		}
+	}
 }
 
 
@@ -136,7 +172,7 @@ bool osk_mouse_movement_event ( const int x, const int y )
 #if 0
 	char debug[100];
 	sprintf(debug, "Mouse: %04d %04d", x, y);
-	draw_text(debug, strlen(debug), 0, 40, true);
+	draw_text(debug, strlen(debug), 0, 40, 2, true);
 #endif
 	const int k = get_key_at_mouse(x, y);
 	if (k != hovered) {
@@ -228,7 +264,7 @@ bool osk_render ( void )
 	if (last_pressed >= 0 && SDL_GetTicks() - press_time >= AUTO_RELEASE_MS) {
 		hid_sdl_synth_key_event(keys[last_pressed].p->key_id, 0);
 		keys[last_pressed].pressed = false;
-		//draw_key(last_pressed, false);
+		draw_key(last_pressed, false);	// so pressed key won't remain highlighted forever
 		last_pressed = -1;
 	}
 	SDL_UpdateTexture(tex, NULL, osk, size_x * 4);
@@ -335,6 +371,7 @@ bool osk_init ( const struct osk_desc_st *desc, const int sx, const int sy, cons
 	colour.bgpress	= SDL_MapRGBA(sdl_pix_fmt, COLOUR_BGPRESS);
 	colour.bglocked	= SDL_MapRGBA(sdl_pix_fmt, COLOUR_BGLOCKED);
 	calc_osk(desc);
+	last_zoomed.x1 = -1;
 	redraw_kbd();
 	return true;
 error:

xemu/gui/gui_osd.c

@@ -1,5 +1,5 @@
 /* Part of the Xemu project, please visit: https://github.com/lgblgblgb/xemu
-   Copyright (C)2016-2022 LGB (Gábor Lénárt) <[email protected]>
+   Copyright (C)2016-2022,2025 LGB (Gábor Lénárt) <[email protected]>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -165,6 +165,11 @@ static int _osdgui_sdl_loop ( int need_rendering, SDL_Point *mousepos )
 				case SDL_KEYUP:
 					break;
 				case SDL_KEYDOWN:
+#ifdef					XEMU_ARCH_ANDROID
+					if (event.key.keysym.sym == SDLK_AC_BACK) {	// Android "BACK" button
+						return OSDGUIKEY_LEFT;	// means "back" in the menu structure
+					}
+#endif
 					for (int a = 0; scan2osdfunc[a].func >= 0; a++)
 						if (scan2osdfunc[a].scan == event.key.keysym.scancode)
 							return scan2osdfunc[a].func;
@@ -582,7 +587,8 @@ static void _osdgui_process_menu ( void )
 	//space = 3;
 	for (int need_rendering = 1;;) {
 		int retev;
-		const int options = (osdgui.menudepth ? OSDGUI_ITEMBROWSER_ALLOW_LEFT : 0) | OSDGUI_ITEMBROWSER_ALLOW_RIGHT | OSDGUI_ITEMBROWSER_ALLOW_F1;
+		//const int options = (osdgui.menudepth ? OSDGUI_ITEMBROWSER_ALLOW_LEFT : 0) | OSDGUI_ITEMBROWSER_ALLOW_RIGHT | OSDGUI_ITEMBROWSER_ALLOW_F1;
+		const int options = OSDGUI_ITEMBROWSER_ALLOW_LEFT | OSDGUI_ITEMBROWSER_ALLOW_RIGHT | OSDGUI_ITEMBROWSER_ALLOW_F1;
 		int *selectedptr = &osdgui.menuselected[osdgui.menudepth];
 		//static int _osdgui_do_browse_list_loop ( const char *textbuf[], const int all_items, const int page_items, int active_item, const int y, int need_rendering, int options, int *ev )
 		*selectedptr = _osdgui_do_browse_list_loop(chooseptrs, attribs, items, space, *selectedptr, OSDGUI_MENU_Y, need_rendering, options, &retev);
@@ -604,9 +610,14 @@ static void _osdgui_process_menu ( void )
 				return;
 			}
 		}
-		if (retev == OSDGUIKEY_LEFT && osdgui.menudepth) {	// previous menu
-			osdgui.menudepth--;
-			goto restart;
+		if (retev == OSDGUIKEY_LEFT) {	// previous menu
+			if (osdgui.menudepth) {
+				osdgui.menudepth--;
+				goto restart;
+			}
+#ifdef			XEMU_ARCH_ANDROID
+			retev = OSDGUIKEY_ESC;	// trying to go to previous menu while in the main menu means leaving the menu
+#endif
 		}
 		if (retev == OSDGUIKEY_F1) {	// go to main menu
 			if (osdgui.menudepth) {