Merge pull request #5934 from BenAckerley/keyboard_capture

joncampbell123 · web-flow · commit 5df1375ebf61 · 2025-11-04T08:32:10.000-08:00
Utilize SDL2's keyboard capture logic to inhibit window manager shortcuts
diff --git a/contrib/translations/de/de_DE.lng b/contrib/translations/de/de_DE.lng
@@ -2619,6 +2619,9 @@ Schnellstartprogramm...
 :MENU:mapper_shutdown
 Beende DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Maus einfangen
 .
diff --git a/contrib/translations/de/de_pc98.lng b/contrib/translations/de/de_pc98.lng
@@ -2609,6 +2609,9 @@ Schnellstartprogramm...
 :MENU:mapper_shutdown
 Beende DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Maus einfangen
 .
diff --git a/contrib/translations/en/en_US.lng b/contrib/translations/en/en_US.lng
@@ -2406,6 +2406,9 @@ Quick launch program...
 :MENU:mapper_shutdown
 Quit from DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Capture mouse
 .
diff --git a/contrib/translations/es/es_ES.lng b/contrib/translations/es/es_ES.lng
@@ -2433,6 +2433,9 @@ Inicio rápido de programa...
 :MENU:mapper_shutdown
 Salir de DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Capturar ratón
 .
diff --git a/contrib/translations/fr/fr_FR.lng b/contrib/translations/fr/fr_FR.lng
@@ -2421,6 +2421,9 @@ Programme de lancement rapide...
 :MENU:mapper_shutdown
 Quitter
 .
+:MENU:mapper_capkeyboard
+Capturer le clavier
+.
 :MENU:mapper_capmouse
 Capturer la souris
 .
diff --git a/contrib/translations/hu/hu_HU.lng b/contrib/translations/hu/hu_HU.lng
@@ -2414,6 +2414,9 @@ Gyors program indítás...
 :MENU:mapper_shutdown
 Kilépés a DOSBox-X-ből
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Az egér DOSBOX-X-hez rendelése (ALT+Tab a feloldáshoz)
 .
diff --git a/contrib/translations/it/it_IT.lng b/contrib/translations/it/it_IT.lng
@@ -2425,6 +2425,9 @@ Avvio rapido programma...
 :MENU:mapper_shutdown
 Esci da DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Cattura mouse
 .
diff --git a/contrib/translations/ja/ja_JP.lng b/contrib/translations/ja/ja_JP.lng
@@ -2414,6 +2414,9 @@ DOSBox-X コマンド・シェルの起動
 :MENU:mapper_shutdown
 DOSBox-Xを終了する
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 マウスをキャプチャ
 .
diff --git a/contrib/translations/ko/ko_KR.lng b/contrib/translations/ko/ko_KR.lng
@@ -2424,6 +2424,9 @@ DOSBox-X 명령 쉘을 시작합니다.
 :MENU:mapper_shutdown
 DOSBox-X를 종료
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 마우스를 갈무리
 .
diff --git a/contrib/translations/nl/nl_NL.lng b/contrib/translations/nl/nl_NL.lng
@@ -2411,6 +2411,9 @@ Snelstartprogramma...
 :MENU:mapper_shutdown
 Afsluiten van DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Muis vastleggen
 .
diff --git a/contrib/translations/pt/pt_BR.lng b/contrib/translations/pt/pt_BR.lng
@@ -2446,6 +2446,9 @@ Início rápido de programa...
 :MENU:mapper_shutdown
 Sair do DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Capturar mouse
 .
diff --git a/contrib/translations/ru/ru_RU.lng b/contrib/translations/ru/ru_RU.lng
@@ -2558,6 +2558,9 @@ DEBUGBOX [команда] [опции]
 :MENU:mapper_shutdown
 Выйти из DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Захват мыши
 .
diff --git a/contrib/translations/tr/tr_TR.lng b/contrib/translations/tr/tr_TR.lng
@@ -2433,6 +2433,9 @@ Hızlı program başlat...
 :MENU:mapper_shutdown
 DOSBox-X'ten çık
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 Fareyi yakala
 .
diff --git a/contrib/translations/zh/zh_CN.lng b/contrib/translations/zh/zh_CN.lng
@@ -2395,6 +2395,9 @@ To adjust the emulated CPU speed, use [31mhost+Plus[37m and [31mhost+Minus[3
 :MENU:mapper_shutdown
 退出 DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 捕获鼠标
 .
diff --git a/contrib/translations/zh/zh_TW.lng b/contrib/translations/zh/zh_TW.lng
@@ -2385,6 +2385,9 @@ DEBUGBOX [命令] [選項]
 :MENU:mapper_shutdown
 結束 DOSBox-X
 .
+:MENU:mapper_capkeyboard
+Capture keyboard
+.
 :MENU:mapper_capmouse
 擷取滑鼠
 .
diff --git a/include/sdlmain.h b/include/sdlmain.h
@@ -174,6 +174,9 @@ struct SDL_Block {
         int ysensitivity = 0;
         MOUSE_EMULATION emulation = (MOUSE_EMULATION)0;
     } mouse;
+#if defined(C_SDL2)
+    bool capture_keyboard = false;
+#endif
     SDL_Rect updateRects[1024] = {};
     Bitu overscan_color = 0;
     Bitu overscan_width = 0;
@@ -240,6 +243,10 @@ SDL_Window* GFX_SetSDLWindowMode(uint16_t width, uint16_t height, SCREEN_TYPES s
 void SDL_GL_SwapBuffers(void);
 #endif
 
+#if defined(C_SDL2)
+void GFX_KeyboardCapture(bool enabled);
+#endif
+
 #if defined(WIN32) && !defined(HX_DOS)
 extern int curscreen;
 extern RECT monrect;
diff --git a/src/gui/menu.cpp b/src/gui/menu.cpp
@@ -149,6 +149,9 @@ static const char *def_menu_main[] =
     "MainHostKey",
     "SharedClipboard",
     "--",
+#if defined(C_SDL2)
+    "mapper_capkeyboard",
+#endif
     "mapper_capmouse",
     "auto_lock_mouse",
     "WheelToArrow",
diff --git a/src/gui/sdlmain.cpp b/src/gui/sdlmain.cpp
@@ -2686,6 +2686,14 @@ static void CaptureMouse(bool pressed) {
     GFX_CaptureMouse();
 }
 
+#if defined(C_SDL2)
+static void CaptureKeyboard(bool pressed) {
+    if (pressed) {
+        GFX_KeyboardCapture(!sdl.capture_keyboard);
+    }
+}
+#endif
+
 #if defined (WIN32)
 STICKYKEYS stick_keys = {sizeof(STICKYKEYS), 0};
 void sticky_keys(bool restore){
@@ -3770,6 +3778,11 @@ static void GUI_StartUp() {
     sdl.mouse.ysensitivity = p3->GetSection()->Get_int("ysens");
 
 #if defined(C_SDL2)
+    // Because we have the option of a dedicated keyboard shortcut to exit
+    // fullscreen, we don't need an Alt+Tab escape hatch. This lets us
+    // block it along with everything else, so you can use it in Windows etc.
+    SDL_SetHint(SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED, "0");
+
     // Apply raw mouse input setting
     SDL_SetHintWithPriority(SDL_HINT_MOUSE_RELATIVE_MODE_WARP, section->Get_bool("raw_mouse_input") ? "0" : "1", SDL_HINT_OVERRIDE);
 #endif
@@ -3815,6 +3828,11 @@ static void GUI_StartUp() {
         item->set_text("Capture mouse");
     }
 
+#if defined(C_SDL2)
+    MAPPER_AddHandler(CaptureKeyboard,MK_f11,MMOD1,"capkeyboard","Capture keyboard", &item);
+    item->set_text("Capture keyboard");
+#endif
+
 #if defined(C_SDL2) || defined(WIN32) || defined(MACOSX)
     MAPPER_AddHandler(QuickEdit,MK_nothing, 0,"fastedit", "Quick edit mode", &item);
     item->set_text("Quick edit: copy on select and paste text");
@@ -4144,6 +4162,10 @@ static void GUI_StartUp() {
     SDL_WM_SetCaption("DOSBox-X",VERSION);
 #endif
 
+#if defined(C_SDL2)
+    GFX_KeyboardCapture(section->Get_bool("keyboard_capture"));
+#endif
+
     /* Please leave the Splash screen stuff in working order in DOSBox-X. We spend a lot of time making DOSBox-X. */
     //ShowSplashScreen();   /* I will keep the splash screen alive. But now, the BIOS will do it --J.C. */
 
@@ -4180,6 +4202,28 @@ bool Mouse_IsLocked()
     return sdl.mouse.locked;
 }
 
+#if defined(C_SDL2)
+void GFX_KeyboardCapture(bool enable) {
+    if (sdl.window) {
+        SDL_SetWindowKeyboardGrab(sdl.window, enable ? SDL_TRUE : SDL_FALSE);
+
+        // Make sure we're using the true value of the current grabbed state.
+        bool grabbed = SDL_GetWindowKeyboardGrab(sdl.window) == SDL_TRUE;
+        sdl.capture_keyboard = grabbed;
+
+        if (grabbed)
+            LOG_MSG("Capturing keyboard");
+        else
+            LOG_MSG("Releasing keyboard");
+    }
+
+    // Make sure our menu item is refreshed, to ensure the checkmark value next
+    // to the item is up-to-date.
+    if (mainMenu.item_exists("mapper_capkeyboard"))
+            mainMenu.get_item("mapper_capkeyboard").check(sdl.capture_keyboard).refresh_item(mainMenu);
+}
+#endif
+
 static void RedrawScreen(uint32_t nWidth, uint32_t nHeight) {
     (void)nWidth;//UNUSED
     (void)nHeight;//UNUSED
@@ -6693,6 +6737,18 @@ void SDL_SetupConfigSection() {
         "Putting a minus sign in front will disable the conversion for guest systems.");
     Pint->SetBasic(true);
 
+#if defined(C_SDL2)
+    Pbool = sdl_sec->Add_bool("keyboard_capture", Property::Changeable::Always, false);
+    Pbool->Set_help("Capture the keyboard, inhibiting window manager shortcuts.\n"
+        "Be warned, enabling this runs the risk of getting trapped inside "
+        "DOSBox-X, however it can be useful for passing combinations like Alt+F4 "
+        "through to DOS applications that use them, like WordPerfect.\n"
+        "Note that if another application attempts to grab the keyboard, DOSBox-X "
+        "will lose its grab over the keyboard. Additionally, not all shortcuts "
+        "can be inhibited on all platforms, for example Ctrl+Alt+Del on Windows.");
+    Pbool->SetBasic(true);
+#endif
+
     Pbool = sdl_sec->Add_bool("waitonerror",Property::Changeable::Always, true);
     Pbool->Set_help("Wait before closing the console if DOSBox-X has an error.");
     Pbool->SetBasic(true);

Original file line number	Diff line number	Diff line change
`@@ -2619,6 +2619,9 @@ Schnellstartprogramm...`
`2619`	`2619`	`:MENU:mapper_shutdown`
`2620`	`2620`	`Beende DOSBox-X`
`2621`	`2621`	`.`
	`2622`	`+:MENU:mapper_capkeyboard`
	`2623`	`+Capture keyboard`
	`2624`	`+.`
`2622`	`2625`	`:MENU:mapper_capmouse`
`2623`	`2626`	`Maus einfangen`
`2624`	`2627`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2609,6 +2609,9 @@ Schnellstartprogramm...`
`2609`	`2609`	`:MENU:mapper_shutdown`
`2610`	`2610`	`Beende DOSBox-X`
`2611`	`2611`	`.`
	`2612`	`+:MENU:mapper_capkeyboard`
	`2613`	`+Capture keyboard`
	`2614`	`+.`
`2612`	`2615`	`:MENU:mapper_capmouse`
`2613`	`2616`	`Maus einfangen`
`2614`	`2617`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2406,6 +2406,9 @@ Quick launch program...`
`2406`	`2406`	`:MENU:mapper_shutdown`
`2407`	`2407`	`Quit from DOSBox-X`
`2408`	`2408`	`.`
	`2409`	`+:MENU:mapper_capkeyboard`
	`2410`	`+Capture keyboard`
	`2411`	`+.`
`2409`	`2412`	`:MENU:mapper_capmouse`
`2410`	`2413`	`Capture mouse`
`2411`	`2414`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2433,6 +2433,9 @@ Inicio rápido de programa...`
`2433`	`2433`	`:MENU:mapper_shutdown`
`2434`	`2434`	`Salir de DOSBox-X`
`2435`	`2435`	`.`
	`2436`	`+:MENU:mapper_capkeyboard`
	`2437`	`+Capture keyboard`
	`2438`	`+.`
`2436`	`2439`	`:MENU:mapper_capmouse`
`2437`	`2440`	`Capturar ratón`
`2438`	`2441`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2421,6 +2421,9 @@ Programme de lancement rapide...`
`2421`	`2421`	`:MENU:mapper_shutdown`
`2422`	`2422`	`Quitter`
`2423`	`2423`	`.`
	`2424`	`+:MENU:mapper_capkeyboard`
	`2425`	`+Capturer le clavier`
	`2426`	`+.`
`2424`	`2427`	`:MENU:mapper_capmouse`
`2425`	`2428`	`Capturer la souris`
`2426`	`2429`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2414,6 +2414,9 @@ Gyors program indítás...`
`2414`	`2414`	`:MENU:mapper_shutdown`
`2415`	`2415`	`Kilépés a DOSBox-X-ből`
`2416`	`2416`	`.`
	`2417`	`+:MENU:mapper_capkeyboard`
	`2418`	`+Capture keyboard`
	`2419`	`+.`
`2417`	`2420`	`:MENU:mapper_capmouse`
`2418`	`2421`	`Az egér DOSBOX-X-hez rendelése (ALT+Tab a feloldáshoz)`
`2419`	`2422`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2425,6 +2425,9 @@ Avvio rapido programma...`
`2425`	`2425`	`:MENU:mapper_shutdown`
`2426`	`2426`	`Esci da DOSBox-X`
`2427`	`2427`	`.`
	`2428`	`+:MENU:mapper_capkeyboard`
	`2429`	`+Capture keyboard`
	`2430`	`+.`
`2428`	`2431`	`:MENU:mapper_capmouse`
`2429`	`2432`	`Cattura mouse`
`2430`	`2433`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2414,6 +2414,9 @@ DOSBox-X コマンド・シェルの起動`
`2414`	`2414`	`:MENU:mapper_shutdown`
`2415`	`2415`	`DOSBox-Xを終了する`
`2416`	`2416`	`.`
	`2417`	`+:MENU:mapper_capkeyboard`
	`2418`	`+Capture keyboard`
	`2419`	`+.`
`2417`	`2420`	`:MENU:mapper_capmouse`
`2418`	`2421`	`マウスをキャプチャ`
`2419`	`2422`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2424,6 +2424,9 @@ DOSBox-X 명령 쉘을 시작합니다.`
`2424`	`2424`	`:MENU:mapper_shutdown`
`2425`	`2425`	`DOSBox-X를 종료`
`2426`	`2426`	`.`
	`2427`	`+:MENU:mapper_capkeyboard`
	`2428`	`+Capture keyboard`
	`2429`	`+.`
`2427`	`2430`	`:MENU:mapper_capmouse`
`2428`	`2431`	`마우스를 갈무리`
`2429`	`2432`	`.`
Original file line number	Diff line number	Diff line change
`@@ -2411,6 +2411,9 @@ Snelstartprogramma...`
`2411`	`2411`	`:MENU:mapper_shutdown`
`2412`	`2412`	`Afsluiten van DOSBox-X`
`2413`	`2413`	`.`
	`2414`	`+:MENU:mapper_capkeyboard`
	`2415`	`+Capture keyboard`
	`2416`	`+.`
`2414`	`2417`	`:MENU:mapper_capmouse`
`2415`	`2418`	`Muis vastleggen`
`2416`	`2419`	`.`