joy2key - split out into standalone module and rework helper code

Move much of the helpers.sh start/stop logic and default parameters to a joy2key wrapper script.

Switch runcommand.sh to use new wrapper script

Add tab button to "y" key for use in edit dialogs

Remove runcommand $md_inst on update. If old joy2key is present in runcommand install, trigger joy2key module install.

Remove system.sh python3-sdl2 dependency check - moved to joy2key_depends

Author: joolswills

scriptmodules/admin/joy2key.sh

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+# This file is part of The RetroPie Project
+#
+# The RetroPie Project is the legal property of its developers, whose names are
+# too numerous to list here. Please refer to the COPYRIGHT.md file distributed with this source.
+#
+# See the LICENSE.md file at the top-level directory of this distribution and
+# at https://raw.githubusercontent.com/RetroPie/RetroPie-Setup/master/LICENSE.md
+#
+
+rp_module_id="joy2key"
+rp_module_desc="Provides joystick to keyboard conversion for navigation of RetroPie dialog menus"
+rp_module_section="core"
+
+function _update_hook_joy2key() {
+    # make sure joy2key is always updated when updating retropie-setup
+    rp_isInstalled "$md_id" && install_bin_joy2key
+}
+
+function depends_joy2key() {
+    local depends=()
+    # 'python3-sdl2' might not be available
+    # it's packaged in Debian starting with version 11 (Bullseye)
+    local p_ver
+    p_ver="$(apt-cache madison python3-sdl2 | cut -d" " -f3 | head -n1)"
+    if [[ -n "$p_ver" ]]; then
+        depends+=(python3-sdl2)
+    fi
+
+    getDepends "${depends[@]}"
+}
+
+function install_bin_joy2key() {
+    local file
+    for file in "joy2key.py" "joy2key_sdl.py"; do
+        cp "$md_data/$file" "$md_inst/"
+        chmod +x "$md_inst/$file"
+        python3 -m compileall "$md_inst/$file"
+    done
+
+    local wrapper="$md_inst/joy2key"
+    cat >"$wrapper" <<_EOF_
+#!/bin/bash
+mode="\$1"
+[[ -z "\$mode" ]] && mode="start"
+shift
+
+# allow overriding joystick device via __joy2key_dev env (by default will use /dev/input/jsX which will scan all)
+device="/dev/input/jsX"
+[[ -n "\$__joy2key_dev" ]] && device="\$__joy2key_dev"
+
+params=("\$@")
+if [[ "\${#params[@]}" -eq 0 ]]; then
+    # Default button-to-keyboard mappings:
+    # * cursor keys for axis/dpad
+    # * enter, space, esc and tab for buttons 'a', 'b', 'x' and 'y'
+    # * page up/page down for buttons 5,6 (shoulder buttons)
+    params=(kcub1 kcuf1 kcuu1 kcud1 0x0a 0x20 0x1b 0x09 kpp knp)
+fi
+
+source "$rootdir/lib/inifuncs.sh"
+iniConfig " = " '"' "$configdir/all/runcommand.cfg"
+iniGet "joy2key_version"
+script="joy2key_sdl.py"
+[[ "\$ini_value" == "0" ]] && script="joy2key.py"
+! python3 -c "import sdl2" 2>/dev/null && script="joy2key.py"
+
+case "\$mode" in
+    start)
+        if pgrep -f "\$script" &>/dev/null; then
+            "\$0" stop
+        fi
+        "$md_inst/\$script" "\$device" "\${params[@]}" || exit 1
+        ;;
+    stop)
+        pkill -f "\$script"
+        sleep 1
+        ;;
+esac
+exit 0
+_EOF_
+    chmod +x "$wrapper"
+}

scriptmodules/supplementary/runcommand/joy2key.py renamed to scriptmodules/admin/joy2key/joy2key.py

@@ -1248,44 +1248,21 @@ function joy2keyStart() {
     [[ "$(who -m)" == *\(* ]] && return
 
     local params=("$@")
-    if [[ "${#params[@]}" -eq 0 ]]; then
-        # Default button-to-keyboard mappings:
-        # * cursor keys for axis/dpad
-        # * enter, space and esc for buttons 'a', 'b' and 'x'
-        # * page up/page down for buttons 5,6 (shoulder buttons)
-        params=(kcub1 kcuf1 kcuu1 kcud1 0x0a 0x20 0x1b 0x00 kpp knp)
-    fi
-
-    # Choose the joy2key implementation here, since `runcommand` may not be installed
-    local joy2key="joy2key.py"
-    if hasPackage "python3-sdl2"; then
-        iniConfig " =" '"' "$configdir/all/runcommand.cfg"
-        iniGet "joy2key_version"
-        [[ $ini_value != "0" ]] && joy2key="joy2key_sdl.py"
-    fi
-
-    # get the first joystick device (if not already set)
-    [[ -c "$__joy2key_dev" ]] || __joy2key_dev="/dev/input/jsX"
-
-    # if no joystick device, or joy2key is already running exit
-    [[ -z "$__joy2key_dev" ]] || pgrep -f "$joy2key" >/dev/null && return 1
 
     # if joy2key is installed, run it
-    if "$scriptdir/scriptmodules/supplementary/runcommand/$joy2key" "$__joy2key_dev" "${params[@]}" 2>/dev/null; then
-        __joy2key_pid=$(pgrep -f "$joy2key")
-        return 0
+    if rp_isInstalled "joy2key"; then
+        "$(rp_getInstallPath joy2key)/joy2key" start "${params[@]}" 2>/dev/null && return 0
     fi
 
     return 1
 }
 
 ## @fn joy2keyStop()
-## @brief Stop previously started joy2key.py process.
+## @brief Stop previously started joy2key process.
 function joy2keyStop() {
-    if [[ -n $__joy2key_pid ]]; then
-        kill $__joy2key_pid 2>/dev/null
-        __joy2key_pid=""
-        sleep 1
+    # if joy2key is installed, stop it
+    if rp_isInstalled "joy2key"; then
+        "$(rp_getInstallPath joy2key)/joy2key" stop
     fi
 }
 

scriptmodules/supplementary/runcommand/joy2key_sdl.py renamed to scriptmodules/admin/joy2key/joy2key_sdl.py

@@ -17,6 +17,7 @@ rp_module_flags="nonet"
 function _update_hook_runcommand() {
     # make sure runcommand is always updated when updating retropie-setup
     rp_isInstalled "$md_id" && install_bin_runcommand
+    [[ -f "$md_inst/joy2key.py" ]] && rp_callModule "joy2key"
 }
 
 function depends_runcommand() {
@@ -28,11 +29,9 @@ function depends_runcommand() {
 }
 
 function install_bin_runcommand() {
-    for file in "runcommand.sh" "joy2key.py" "joy2key_sdl.py"; do
-        cp "$md_data/$file" "$md_inst/"
-        chmod +x "$md_inst/$file"
-    done
-    python3 -m compileall "$md_inst/joy2key.py" "$md_inst/joy2key_sdl.py"
+    rm -rf "$md_inst"
+    mkdir -p "$md_inst"
+    cp "$md_data/runcommand.sh" "$md_inst/"
     if [[ ! -f "$configdir/all/runcommand.cfg" ]]; then
         mkUserDir "$configdir/all"
         iniConfig " = " '"' "$configdir/all/runcommand.cfg"
@@ -41,16 +40,8 @@ function install_bin_runcommand() {
         iniSet "governor" ""
         iniSet "disable_menu" "0"
         iniSet "image_delay" "2"
-        if hasPackage "python3-sdl2"; then
-            iniSet "joy2key_version" "1"
-        fi
         chown $user:$user "$configdir/all/runcommand.cfg"
     fi
-    # if PySDL2 is not installed, force the udev version of joy2key
-    if ! hasPackage "python3-sdl2"; then
-        iniConfig " = " '"' "$configdir/all/runcommand.cfg"
-        iniSet "joy2key_version" "0"
-    fi
     if [[ ! -f "$configdir/all/runcommand-launch-dialog.cfg" ]]; then
         dialog --create-rc "$configdir/all/runcommand-launch-dialog.cfg"
         chown $user:$user "$configdir/all/runcommand-launch-dialog.cfg"

scriptmodules/helpers.sh

@@ -86,7 +86,7 @@ VIDEO_CONF="$CONFIGDIR/all/videomodes.cfg"
 EMU_CONF="$CONFIGDIR/all/emulators.cfg"
 BACKENDS_CONF="$CONFIGDIR/all/backends.cfg"
 RETRONETPLAY_CONF="$CONFIGDIR/all/retronetplay.cfg"
-JOY2KEY="joy2key_sdl.py"
+JOY2KEY="$ROOTDIR/admin/joy2key/joy2key"
 
 # modesetting tools
 TVSERVICE="/opt/vc/bin/tvservice"
@@ -119,8 +119,6 @@ function get_config() {
         iniGet "image_delay"
         IMAGE_DELAY="$ini_value"
         [[ -z "$IMAGE_DELAY" ]] && IMAGE_DELAY=2
-        iniGet "joy2key_version"
-        [[ "$ini_value" == "0" ]] && JOY2KEY="joy2key.py"
     fi
 
     if [[ -n "$DISPLAY" ]] && $XRANDR &>/dev/null; then
@@ -134,32 +132,15 @@ function get_config() {
 }
 
 function start_joy2key() {
-    [[ "$DISABLE_JOYSTICK" -eq 1 ]] && return
-    # get the first joystick device (if not already set)
-    if [[ -c "$__joy2key_dev" ]]; then
-        JOY2KEY_DEV="$__joy2key_dev"
-    else
-        JOY2KEY_DEV="/dev/input/jsX"
-    fi
-    # if joy2key is installed run it with cursor keys for axis, and enter + tab for buttons 0 and 1
-    if [[ -f "$ROOTDIR/supplementary/runcommand/$JOY2KEY" && -n "$JOY2KEY_DEV" ]] && ! pgrep -f "$JOY2KEY" >/dev/null; then
-
-        # call joy2key.py: arguments are curses capability names or hex values starting with '0x'
-        # see: http://pubs.opengroup.org/onlinepubs/7908799/xcurses/terminfo.html
-        "$ROOTDIR/supplementary/runcommand/$JOY2KEY" "$JOY2KEY_DEV" kcub1 kcuf1 kcuu1 kcud1 0x0a 0x09
-        JOY2KEY_PID=$(pgrep -f "$JOY2KEY")
+    # check if joystick support is enabled and joy2key is available
+    [[ "$DISABLE_JOYSTICK" -eq 1 || ! -f "$JOY2KEY" ]] && return
 
-    # ensure coherency between on-screen prompts and actual button mapping functionality
-    sleep 0.3
-    fi
+    "$JOY2KEY" start 2>/dev/null && return 0
 }
 
 function stop_joy2key() {
-    if [[ -n "$JOY2KEY_PID" ]]; then
-        kill "$JOY2KEY_PID"
-        JOY2KEY_PID=""
-        sleep 1
-    fi
+    # if joy2key is installed, stop it
+    [[ -f "$JOY2KEY" ]] && "$JOY2KEY" stop
 }
 
 function get_params() {

scriptmodules/supplementary/runcommand.sh

@@ -304,14 +304,6 @@ function get_retropie_depends() {
 
     [[ "$__use_ccache" -eq 1 ]] && depends+=(ccache)
 
-    # 'python3-sdl2' might not be available
-    # it's packaged in Debian starting with version 11 (Bullseye)
-    local p_ver
-    p_ver="$(apt-cache madison python3-sdl2 | cut -d" " -f3 | head -n1)"
-    if [[ -n "$p_ver" ]]; then
-        depends+=(python3-sdl2)
-    fi
-
     if ! getDepends "${depends[@]}"; then
         fatalError "Unable to install packages required by $0 - ${md_ret_errors[@]}"
     fi