Skip to contentSkip to conversation

ui: Remove deprecated sdl parameters and switch to QAPI parser

PATCH Superseded Thomas Huth 5 participants 19 messages May 18, 2022 – May 19, 2022

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover ui: Remove deprecated sdl parameters and switch to QAPI parser

The "-display sdl" option still uses a hand-crafted parser for its parameters since some of them used underscores which is forbidden in QAPI. Now that they've been deprecated and the deprecation period is over, we can remove the problematic parameters and switch to use the QAPI parser instead.

While we're at it, also remove the deprecated "-sdl" and "-curses" options.

v2:
- Rebase to current master branch to resolve conflicts in docs/about/*.rst
- Use an enum for the grab-mod parameter instead of a unconstrained string

Thomas Huth (3):
ui: Remove deprecated parameters of the "-display sdl" option
ui: Switch "-display sdl" to use the QAPI parser
ui: Remove deprecated options "-sdl" and "-curses"

 docs/about/deprecated.rst       |  26 -------
 docs/about/removed-features.rst |  27 +++++++
 qapi/ui.json                    |  27 ++++++-
 include/sysemu/sysemu.h         |   2 -
 softmmu/globals.c               |   2 -
 softmmu/vl.c                    | 128 +-------------------------------
 ui/sdl2.c                       |  10 +++
 qemu-options.hx                 |  56 +-------------
 8 files changed, 68 insertions(+), 210 deletions(-)
Signature · 1 line
2.27.0
#1 lore raw

PATCH v2 1/3 ui: Remove deprecated parameters of the "-display sdl" option

These parameters are in the way for further refactoring (since they use an underscore in the name which is forbidden in QAPI), so let's remove these now that their deprecation period is over.

---
 docs/about/deprecated.rst       | 16 -------------
 docs/about/removed-features.rst | 17 ++++++++++++++
 softmmu/vl.c                    | 41 +--------------------------------
 qemu-options.hx                 | 32 ++-----------------------
 4 files changed, 20 insertions(+), 86 deletions(-)
docs/about/deprecated.rst +0 -16
index a92ae0f162..562a133f18 100644
@@ -81,22 +81,6 @@ the process listing. This is replaced by the new ``password-secret``
 option which lets the password be securely provided on the command
 line using a ``secret`` object instance.
 
-``-display sdl,window_close=...`` (since 6.1)
-'''''''''''''''''''''''''''''''''''''''''''''
-
-Use ``-display sdl,window-close=...`` instead (i.e. with a minus instead of
-an underscore between "window" and "close").
-
-``-alt-grab`` and ``-display sdl,alt_grab=on`` (since 6.2)
-''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-Use ``-display sdl,grab-mod=lshift-lctrl-lalt`` instead.
-
-``-ctrl-grab`` and ``-display sdl,ctrl_grab=on`` (since 6.2)
-''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-Use ``-display sdl,grab-mod=rctrl`` instead.
-
 ``-sdl`` (since 6.2)
 ''''''''''''''''''''
 
docs/about/removed-features.rst +17 -0
index eb76974347..4c9e001c35 100644
@@ -370,6 +370,23 @@ The ``opened=on`` option in the command line or QMP ``object-add`` either had
 no effect (if ``opened`` was the last option) or caused errors.  The property
 is therefore useless and should simply be removed.
 
+``-display sdl,window_close=...`` (removed in 7.1)
+''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Use ``-display sdl,window-close=...`` instead (i.e. with a minus instead of
+an underscore between "window" and "close").
+
+``-alt-grab`` and ``-display sdl,alt_grab=on`` (removed in 7.1)
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Use ``-display sdl,grab-mod=lshift-lctrl-lalt`` instead.
+
+``-ctrl-grab`` and ``-display sdl,ctrl_grab=on`` (removed in 7.1)
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Use ``-display sdl,grab-mod=rctrl`` instead.
+
+
 QEMU Machine Protocol (QMP) commands
 ------------------------------------
 
softmmu/vl.c +1 -40

59 lines not on this page · raw message

qemu-options.hx +2 -30
index b484640067..011caad530 100644
@@ -1938,8 +1938,8 @@ DEF("display", HAS_ARG, QEMU_OPTION_display,
     "-display spice-app[,gl=on|off]\n"
 #endif
 #if defined(CONFIG_SDL)
-    "-display sdl[,alt_grab=on|off][,ctrl_grab=on|off][,gl=on|core|es|off]\n"
-    "            [,grab-mod=<mod>][,show-cursor=on|off][,window-close=on|off]\n"
+    "-display sdl[,gl=on|core|es|off][,grab-mod=<mod>][,show-cursor=on|off]\n"
+    "            [,window-close=on|off]\n"
 #endif
 #if defined(CONFIG_GTK)
     "-display gtk[,full-screen=on|off][,gl=on|off][,grab-on-hover=on|off]\n"
@@ -2012,12 +2012,6 @@ SRST
         the mouse grabbing in conjunction with the "g" key. ``<mods>`` can be
         either ``lshift-lctrl-lalt`` or ``rctrl``.
 
-        ``alt_grab=on|off`` : Use Control+Alt+Shift-g to toggle mouse grabbing.
-        This parameter is deprecated - use ``grab-mod`` instead.
-
-        ``ctrl_grab=on|off`` : Use Right-Control-g to toggle mouse grabbing.
-        This parameter is deprecated - use ``grab-mod`` instead.
-
         ``gl=on|off|core|es`` : Use OpenGL for displaying
 
         ``show-cursor=on|off`` :  Force showing the mouse cursor
@@ -2103,28 +2097,6 @@ SRST
     is displayed in graphical mode.
 ERST
 
-DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
-    "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
-    QEMU_ARCH_ALL)
-SRST
-``-alt-grab``
-    Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that
-    this also affects the special keys (for fullscreen, monitor-mode
-    switching, etc). This option is deprecated - please use
-    ``-display sdl,grab-mod=lshift-lctrl-lalt`` instead.
-ERST
-
-DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
-    "-ctrl-grab      use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
-    QEMU_ARCH_ALL)
-SRST
-``-ctrl-grab``
-    Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this
-    also affects the special keys (for fullscreen, monitor-mode
-    switching, etc). This option is deprecated - please use
-    ``-display sdl,grab-mod=rctrl`` instead.
-ERST
-
 DEF("sdl", 0, QEMU_OPTION_sdl,
     "-sdl            shorthand for -display sdl\n", QEMU_ARCH_ALL)
 SRST
Signature · 1 line
2.27.0
Reviewed-by on v2 1/3
#2 lore raw

Re: [PATCH v2 1/3] ui: Remove deprecated parameters of the "-display sdl" option

Quoted 3 lines · Thomas Huth

These parameters are in the way for further refactoring (since they use an underscore in the name which is forbidden in QAPI), so let's remove these now that their deprecation period is over.

Forbidden, but there's an exception mechanism, so this reason isn't compelling. I believe the actual reason is they are "too ugly and inflexible to drag them along into the QAPI world" (your words).

Suggest:

Dropping these deprecated parameters now simplifies further refactoring.

Quoted 2 lines

Patch looks good to me, so

#3 lore raw

PATCH v2 2/3 ui: Switch "-display sdl" to use the QAPI parser

In reply to Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
 qapi/ui.json            | 27 +++++++++++++++-
 include/sysemu/sysemu.h |  2 --
 softmmu/globals.c       |  2 --
 softmmu/vl.c            | 70 +----------------------------------------
 ui/sdl2.c               | 10 ++++++
 5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +26 -1
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@
       '*swap-opt-cmd': 'bool'
   } }
 
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }
+
+##
+# @DisplaySDL:
+#
+# SDL2 display options.
+#
+# @grab-mod:  String with modifier keys that should be pressed together with
+#             the "G" key to release the mouse grab. Only "lshift-lctrl-lalt"
+#             and "rctrl" are currently supported.
+#
+# Since: 7.1
+##
+{ 'struct'  : 'DisplaySDL',
+  'data'    : { '*grab-mod'   : 'GrabMod' } }
+
 ##
 # @DisplayType:
 #
@@ -1374,7 +1398,8 @@
       'curses': { 'type': 'DisplayCurses', 'if': 'CONFIG_CURSES' },
       'egl-headless': { 'type': 'DisplayEGLHeadless',
                         'if': { 'all': ['CONFIG_OPENGL', 'CONFIG_GBM'] } },
-      'dbus': { 'type': 'DisplayDBus', 'if': 'CONFIG_DBUS_DISPLAY' }
+      'dbus': { 'type': 'DisplayDBus', 'if': 'CONFIG_DBUS_DISPLAY' },
+      'sdl': { 'type': 'DisplaySDL', 'if': 'CONFIG_SDL' }
   }
 }
 
include/sysemu/sysemu.h +0 -2
index b4030acd74..812f66a31a 100644
@@ -42,8 +42,6 @@ extern int graphic_depth;
 extern int display_opengl;
 extern const char *keyboard_layout;
 extern int win2k_install_hack;
-extern int alt_grab;
-extern int ctrl_grab;
 extern int graphic_rotate;
 extern int old_param;
 extern uint8_t *boot_splash_filedata;
softmmu/globals.c +0 -2
index 916bc12e2b..527edbefdd 100644
@@ -50,8 +50,6 @@ QEMUOptionRom option_rom[MAX_OPTION_ROMS];
 int nb_option_roms;
 int old_param;
 const char *qemu_name;
-int alt_grab;
-int ctrl_grab;
 unsigned int nb_prom_envs;
 const char *prom_envs[MAX_PROM_ENVS];
 uint8_t *boot_splash_filedata;
softmmu/vl.c +1 -69

76 lines not on this page · raw message

ui/sdl2.c +10 -0
index d3741f9b75..dc39b24a67 100644
@@ -40,6 +40,8 @@ static struct sdl2_console *sdl2_console;
 
 static SDL_Surface *guest_sprite_surface;
 static int gui_grab; /* if true, all keyboard/mouse events are grabbed */
+static bool alt_grab;
+static bool ctrl_grab;
 
 static int gui_saved_grab;
 static int gui_fullscreen;
@@ -853,6 +855,14 @@ static void sdl2_display_init(DisplayState *ds, DisplayOptions *o)
 
     gui_fullscreen = o->has_full_screen && o->full_screen;
 
+    if (o->u.sdl.has_grab_mod) {
+        if (o->u.sdl.grab_mod == GRAB_MOD_LSHIFT_LCTRL_LALT) {
+            alt_grab = true;
+        } else if (o->u.sdl.grab_mod == GRAB_MOD_RCTRL) {
+            ctrl_grab = true;
+        }
+    }
+
     for (i = 0;; i++) {
         QemuConsole *con = qemu_console_lookup_by_index(i);
         if (!con) {
Signature · 1 line
2.27.0
#4 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 26 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
 qapi/ui.json            | 27 +++++++++++++++-
 include/sysemu/sysemu.h |  2 --
 softmmu/globals.c       |  2 --
 softmmu/vl.c            | 70 +----------------------------------------
 ui/sdl2.c               | 10 ++++++
 5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@
       '*swap-opt-cmd': 'bool'
   } }

qapi/ui.json line 1306

Quoted 10 lines
qapi/ui.json +9 -0
 
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now. If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward. No objection from me.

qapi/ui.json line 1313

Quoted 7 lines
qapi/ui.json +7 -0
+
+##
+# @DisplaySDL:
+#
+# SDL2 display options.
+#
+# @grab-mod:  String with modifier keys that should be pressed together with

s/String with modifier keys/Modifier keys/

qapi/ui.json line 1315

Quoted 2 lines
qapi/ui.json +2 -0
+#             the "G" key to release the mouse grab. Only "lshift-lctrl-lalt"
+#             and "rctrl" are currently supported.

Why do we define lctrl-lalt if it's not supported?

Quoted 18 lines
qapi/ui.json +8 -1
+#
+# Since: 7.1
+##
+{ 'struct'  : 'DisplaySDL',
+  'data'    : { '*grab-mod'   : 'GrabMod' } }
+
 ##
 # @DisplayType:
 #
@@ -1374,7 +1398,8 @@
       'curses': { 'type': 'DisplayCurses', 'if': 'CONFIG_CURSES' },
       'egl-headless': { 'type': 'DisplayEGLHeadless',
                         'if': { 'all': ['CONFIG_OPENGL', 'CONFIG_GBM'] } },
-      'dbus': { 'type': 'DisplayDBus', 'if': 'CONFIG_DBUS_DISPLAY' }
+      'dbus': { 'type': 'DisplayDBus', 'if': 'CONFIG_DBUS_DISPLAY' },
+      'sdl': { 'type': 'DisplaySDL', 'if': 'CONFIG_SDL' }
   }
 }

[...]

#5 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 52 lines · Markus Armbruster
Quoted 26 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
  qapi/ui.json            | 27 +++++++++++++++-
  include/sysemu/sysemu.h |  2 --
  softmmu/globals.c       |  2 --
  softmmu/vl.c            | 70 +----------------------------------------
  ui/sdl2.c               | 10 ++++++
  5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@
        '*swap-opt-cmd': 'bool'
    } }

qapi/ui.json line 1306

Quoted 10 lines
qapi/ui.json +9 -0
 
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now. If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward. No objection from me.

qapi/ui.json line 1313

Quoted 7 lines
qapi/ui.json +7 -0
+
+##
+# @DisplaySDL:
+#
+# SDL2 display options.
+#
+# @grab-mod:  String with modifier keys that should be pressed together with

s/String with modifier keys/Modifier keys/

Quoted 4 lines

qapi/ui.json line 1315

Quoted 2 lines
qapi/ui.json +2 -0
+#             the "G" key to release the mouse grab. Only "lshift-lctrl-lalt"
+#             and "rctrl" are currently supported.

Why do we define lctrl-lalt if it's not supported?

It's the default value if you don't specify the grab-mod parameter. So it's supported, you get this mode if you use "grab-mod=lctrl-lalt" or no grab-mod parameter at all.

Thomas

#6 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 53 lines · Thomas Huth
Quoted 52 lines · Markus Armbruster
Quoted 26 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
  qapi/ui.json            | 27 +++++++++++++++- include/sysemu/sysemu.h |  2 --
  softmmu/globals.c       |  2 --
  softmmu/vl.c            | 70 +---------------------------------------- ui/sdl2.c               | 10 ++++++

  5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@

        '*swap-opt-cmd': 'bool'
    } }

qapi/ui.json line 1306

Quoted 9 lines
qapi/ui.json +9 -0
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now.  If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward.  No objection from me.

Quoted 8 lines
qapi/ui.json +7 -0
+
+##
+# @DisplaySDL:
+#
+# SDL2 display options.
+#
+# @grab-mod:  String with modifier keys that should be pressed together 

with

s/String with modifier keys/Modifier keys/

Quoted 7 lines
Quoted 5 lines
Quoted 3 lines

+#             the "G" key to release the mouse grab. Only "lshift-lctrl-lalt"
+#             and "rctrl" are currently supported.

Why do we define lctrl-lalt if it's not supported?

It's the default value if you don't specify the grab-mod parameter. So it's supported, you get this mode if you use "grab-mod=lctrl-lalt" or no grab-mod parameter at all.

Forgot to mention: I'll drop that sentence in v3. Since there is the enum now, people can look up the valid combinations there instead.

Thomas

#7 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 34 lines · Thomas Huth
Quoted 33 lines · Thomas Huth
Quoted 32 lines · Markus Armbruster
Quoted 30 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
  qapi/ui.json            | 27 +++++++++++++++- include/sysemu/sysemu.h |  2 --
  softmmu/globals.c       |  2 --
  softmmu/vl.c            | 70 +---------------------------------------- ui/sdl2.c               | 10 ++++++

  5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@

        '*swap-opt-cmd': 'bool'
    } }

qapi/ui.json +4 -0
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

qapi/ui.json line 1306

Quoted 5 lines
qapi/ui.json +5 -0
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now.  If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward.  No objection from me.

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

Thomas

#8 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 44 lines · Thomas Huth
Quoted 34 lines · Thomas Huth
Quoted 33 lines · Thomas Huth
Quoted 32 lines · Markus Armbruster
Quoted 30 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
  qapi/ui.json            | 27 +++++++++++++++- include/sysemu/sysemu.h |  2 --
  softmmu/globals.c       |  2 --
  softmmu/vl.c            | 70 +---------------------------------------- ui/sdl2.c               | 10 ++++++

  5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@

        '*swap-opt-cmd': 'bool'
    } }

qapi/ui.json +4 -0
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

qapi/ui.json line 1306

Quoted 5 lines
qapi/ui.json +5 -0
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now.  If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward.  No objection from me.

Quoted 4 lines

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

It also doesn't distinguish left & right control/alt/shift keys for some reason. So you would end up having to add more enum entries for SDL, none of which overlap with existing enum entries. Rather a pity, as the consistency would have been nice

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#9 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 50 lines · Daniel P. Berrangé
Quoted 44 lines · Thomas Huth
Quoted 34 lines · Thomas Huth
Quoted 33 lines · Thomas Huth
Quoted 32 lines · Markus Armbruster
Quoted 30 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
  qapi/ui.json            | 27 +++++++++++++++- include/sysemu/sysemu.h |  2 --
  softmmu/globals.c       |  2 --
  softmmu/vl.c            | 70 +---------------------------------------- ui/sdl2.c               | 10 ++++++

  5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@

        '*swap-opt-cmd': 'bool'
    } }

qapi/ui.json +4 -0
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

qapi/ui.json line 1306

Quoted 5 lines
qapi/ui.json +5 -0
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now.  If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward.  No objection from me.

Quoted 4 lines

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

Quoted 4 lines

It also doesn't distinguish left & right control/alt/shift keys for some reason. So you would end up having to add more enum entries for SDL, none of which overlap with existing enum entries. Rather a pity, as the consistency would have been nice

Speaking of consistency: stick to the key names we use in QKeyCode? Sadly, they contain '_'.

#10 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 52 lines · Markus Armbruster
Quoted 50 lines · Daniel P. Berrangé
Quoted 48 lines · Thomas Huth
Quoted 34 lines · Thomas Huth
Quoted 33 lines · Thomas Huth
Quoted 32 lines · Markus Armbruster
Quoted 30 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
   qapi/ui.json            | 27 +++++++++++++++-
   include/sysemu/sysemu.h |  2 --
   softmmu/globals.c       |  2 --
   softmmu/vl.c            | 70 +----------------------------------------
   ui/sdl2.c               | 10 ++++++
   5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +4 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@
         '*swap-opt-cmd': 'bool'
     } }
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

qapi/ui.json line 1305

Quoted 5 lines
qapi/ui.json +5 -0
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now.  If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward.  No objection from me.

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

Quoted 7 lines
Quoted 4 lines

It also doesn't distinguish left & right control/alt/shift keys for some reason. So you would end up having to add more enum entries for SDL, none of which overlap with existing enum entries. Rather a pity, as the consistency would have been nice

Speaking of consistency: stick to the key names we use in QKeyCode? Sadly, they contain '_'.

The "grab-mod" with the current name already exists, so if we want to switch to those names, we need to deprecate the current ones again ... and the enums would really look ugly in the code, too, e.g. CTRL_L_ALT_L ... hard to tell where the "L" really belongs to ... so I'd rather stick with the current names, I think.

Thomas

#11 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

In reply to Daniel P. Berrangé
Quoted 45 lines · Daniel P. Berrangé
Quoted 44 lines · Thomas Huth
Quoted 42 lines · Thomas Huth
Quoted 41 lines · Thomas Huth
Quoted 40 lines · Markus Armbruster
Quoted 25 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
   qapi/ui.json            | 27 +++++++++++++++-
   include/sysemu/sysemu.h |  2 --
   softmmu/globals.c       |  2 --
   softmmu/vl.c            | 70 +----------------------------------------
   ui/sdl2.c               | 10 ++++++
   5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@
         '*swap-opt-cmd': 'bool'

qapi/ui.json line 1305

Quoted 10 lines
qapi/ui.json +9 -0
     } }
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now.  If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward.  No objection from me.

Quoted 8 lines
Quoted 4 lines

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

It also doesn't distinguish left & right control/alt/shift keys for some reason. So you would end up having to add more enum entries for SDL, none of which overlap with existing enum entries.

We could also extend the SDL code to work with the other combos from GrabToggleKeys, I guess.

Quoted 1 line

Rather a pity, as the consistency would have been nice

I wonder which way would cause less "WTF?" situations in the future ... if we have one enum with slightly different naming between the entries, or if we have two enums that seems to be there for the same or at least very similar things, which still have still inconsistent namings between the entries... I'm slightly inclined to go for the unified GrabToggleKeys enum, I think...

Thomas

#12 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

In reply to Thomas Huth

Hi,

Quoted 4 lines

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

qemu/ui/input-linux.c

Those switch the input routing between host and guest, and they act on their own (i.e. by default both control keys without anything else).

For SDL it defines the modifiers to press in addition to the hotkeys (i.e. ctrl + shift + 'G' for grab release, IIRC there a are more, 'F' for fullscreen?).

So I don't think it makes sense to merge them.

take care,
Gerd

#13 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 9 lines · Gerd Hoffmann
   Hi,
Quoted 4 lines

Oh well, I just noticed that we already have a GrabToggleKeys enum in qapi/common.json ... I wonder whether I should try to use that instead? It seems to be used in a slightly different context, though, if I get that right ...?

qemu/ui/input-linux.c

Quoted 8 lines

Those switch the input routing between host and guest, and they act on their own (i.e. by default both control keys without anything else).

For SDL it defines the modifiers to press in addition to the hotkeys (i.e. ctrl + shift + 'G' for grab release, IIRC there a are more, 'F' for fullscreen?).

So I don't think it makes sense to merge them.

Hmm, ok ... but maybe I should call the new enum HotKeyMod instead of GrabMod to make it more obvious that it is something different?

Thomas

#14 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Hi,

Quoted 2 lines

Hmm, ok ... but maybe I should call the new enum HotKeyMod instead of GrabMod to make it more obvious that it is something different?

Looks good to me.

take care,
Gerd

#15 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

In reply to Thomas Huth
Quoted 53 lines · Thomas Huth
Quoted 52 lines · Markus Armbruster
Quoted 26 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---
  qapi/ui.json            | 27 +++++++++++++++-
  include/sysemu/sysemu.h |  2 --
  softmmu/globals.c       |  2 --
  softmmu/vl.c            | 70 +----------------------------------------
  ui/sdl2.c               | 10 ++++++
  5 files changed, 37 insertions(+), 74 deletions(-)
qapi/ui.json +0 -0
index 11a827d10f..a244e26e0f 100644
@@ -1295,6 +1295,30 @@
        '*swap-opt-cmd': 'bool'
    } }

qapi/ui.json line 1306

Quoted 10 lines
qapi/ui.json +9 -0
 
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.
+#
+# Since: 7.1
+##
+{ 'enum'  : 'GrabMod',
+  'data'  : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }

This is fine now. If we ever generalize to "arbitrary set of modifier keys", it'll become somewhat awkward. No objection from me.

qapi/ui.json line 1313

Quoted 7 lines
qapi/ui.json +7 -0
+
+##
+# @DisplaySDL:
+#
+# SDL2 display options.
+#
+# @grab-mod:  String with modifier keys that should be pressed together with

s/String with modifier keys/Modifier keys/

Quoted 8 lines
Quoted 4 lines

qapi/ui.json line 1315

Quoted 2 lines
qapi/ui.json +2 -0
+#             the "G" key to release the mouse grab. Only "lshift-lctrl-lalt"
+#             and "rctrl" are currently supported.

Why do we define lctrl-lalt if it's not supported?

It's the default value if you don't specify the grab-mod parameter. So it's supported, you get this mode if you use "grab-mod=lctrl-lalt" or no grab-mod parameter at all.

That's not how I understood the comment...

Suggest

# @grab-mod: Modifier keys that should be pressed together with the "G"
# key to release the mouse grab (default "lctrl-lalt")

#16 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

In reply to Thomas Huth
Quoted 15 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---

+++ b/qapi/ui.json

qapi/ui.json line 1301

Quoted 7 lines
qapi/ui.json +4 -0
@@ -1295,6 +1295,30 @@
       '*swap-opt-cmd': 'bool'
   } }
 
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.

s/hold/held/

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org
#17 lore raw

Re: [PATCH v2 2/3] ui: Switch "-display sdl" to use the QAPI parser

Quoted 19 lines · Eric Blake
Quoted 18 lines · Thomas Huth

The "-display sdl" option still uses a hand-crafted parser for its parameters since we didn't want to drag an interface we considered somewhat flawed into the QAPI schema. Since the flaws are gone now, it's time to QAPIfy.

This introduces the new "DisplaySDL" QAPI struct that is used to hold the parameters that are unique to the SDL display. The only specific parameter is currently "grab-mod" that is used to specify the required modifier keys to escape from the mouse grabbing mode.

---

+++ b/qapi/ui.json

qapi/ui.json +0 -0
@@ -1295,6 +1295,30 @@
        '*swap-opt-cmd': 'bool'
    } }
 
Quoted 6 lines

qapi/ui.json line 1301

Quoted 4 lines
qapi/ui.json +4 -0
+##
+# @GrabMod:
+#
+# Set of modifier keys that need to be hold for shortcut key actions.

s/hold/held/

Thanks, I'll send a v3 with this (and the nits found by Markus) fixed.

Thomas

#18 lore raw

PATCH v2 3/3 ui: Remove deprecated options "-sdl" and "-curses"

In reply to Thomas Huth

We have "-sdl" and "-curses", but no "-gtk" and no "-cocoa" ... these old-style options are rather confusing than helpful nowadays. Now that the deprecation period is over, let's remove them, so we get a cleaner interface (where "-display" is the only way to select the user interface).

---
 docs/about/deprecated.rst       | 10 ----------
 docs/about/removed-features.rst | 10 ++++++++++
 softmmu/vl.c                    | 19 -------------------
 qemu-options.hx                 | 24 ++----------------------
 4 files changed, 12 insertions(+), 51 deletions(-)
docs/about/deprecated.rst +0 -10
index 562a133f18..e19bcba242 100644
@@ -81,16 +81,6 @@ the process listing. This is replaced by the new ``password-secret``
 option which lets the password be securely provided on the command
 line using a ``secret`` object instance.
 
-``-sdl`` (since 6.2)
-''''''''''''''''''''
-
-Use ``-display sdl`` instead.
-
-``-curses`` (since 6.2)
-'''''''''''''''''''''''
-
-Use ``-display curses`` instead.
-
 ``-watchdog`` (since 6.2)
 '''''''''''''''''''''''''
 
docs/about/removed-features.rst +10 -0
index 4c9e001c35..c7b9dadd5d 100644
@@ -386,6 +386,16 @@ Use ``-display sdl,grab-mod=lshift-lctrl-lalt`` instead.
 
 Use ``-display sdl,grab-mod=rctrl`` instead.
 
+``-sdl`` (removed in 7.1)
+'''''''''''''''''''''''''
+
+Use ``-display sdl`` instead.
+
+``-curses`` (removed in 7.1)
+''''''''''''''''''''''''''''
+
+Use ``-display curses`` instead.
+
 
 QEMU Machine Protocol (QMP) commands
 ------------------------------------
softmmu/vl.c +0 -19
index 484e9d9921..4c1e94b00e 100644
@@ -2800,16 +2800,6 @@ void qemu_init(int argc, char **argv, char **envp)
                 nographic = true;
                 dpy.type = DISPLAY_TYPE_NONE;
                 break;
-            case QEMU_OPTION_curses:
-                warn_report("-curses is deprecated, "
-                            "use -display curses instead.");
-#ifdef CONFIG_CURSES
-                dpy.type = DISPLAY_TYPE_CURSES;
-#else
-                error_report("curses or iconv support is disabled");
-                exit(1);
-#endif
-                break;
             case QEMU_OPTION_portrait:
                 graphic_rotate = 90;
                 break;
@@ -3176,15 +3166,6 @@ void qemu_init(int argc, char **argv, char **envp)
                 dpy.has_full_screen = true;
                 dpy.full_screen = true;
                 break;
-            case QEMU_OPTION_sdl:
-                warn_report("-sdl is deprecated, use -display sdl instead.");
-#ifdef CONFIG_SDL
-                dpy.type = DISPLAY_TYPE_SDL;
-                break;
-#else
-                error_report("SDL support is disabled");
-                exit(1);
-#endif
             case QEMU_OPTION_pidfile:
                 pid_file = optarg;
                 break;
qemu-options.hx +2 -22
index 011caad530..3efca0e7f9 100644
@@ -1981,9 +1981,8 @@ DEF("display", HAS_ARG, QEMU_OPTION_display,
     , QEMU_ARCH_ALL)
 SRST
 ``-display type``
-    Select type of display to use. This option is a replacement for the
-    old style -sdl/-curses/... options. Use ``-display help`` to list
-    the available display types. Valid values for type are
+    Select type of display to use. Use ``-display help`` to list the available
+    display types. Valid values for type are
 
     ``spice-app[,gl=on|off]``
         Start QEMU as a Spice server and launch the default Spice client
@@ -2085,25 +2084,6 @@ SRST
     Use C-a h for help on switching between the console and monitor.
 ERST
 
-DEF("curses", 0, QEMU_OPTION_curses,
-    "-curses         shorthand for -display curses\n",
-    QEMU_ARCH_ALL)
-SRST
-``-curses``
-    Normally, if QEMU is compiled with graphical window support, it
-    displays output such as guest graphics, guest console, and the QEMU
-    monitor in a window. With this option, QEMU can display the VGA
-    output when in text mode using a curses/ncurses interface. Nothing
-    is displayed in graphical mode.
-ERST
-
-DEF("sdl", 0, QEMU_OPTION_sdl,
-    "-sdl            shorthand for -display sdl\n", QEMU_ARCH_ALL)
-SRST
-``-sdl``
-    Enable SDL.
-ERST
-
 #ifdef CONFIG_SPICE
 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
     "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
Signature · 1 line
2.27.0