ui:ask: Move backend-interna to where they belong

Author: GB609

sources/fs-root/opt/batocera-emulationstation/lib/ui/backend-api.shl

@@ -38,7 +38,7 @@
 # - Abort: Status!=1
 #
 # @arg $1 string text to use
-# @arg $2 ref name of an array to use
+# @arg $2 ref name of the array containing choices
 # @arg $3 int offset to start at (default 0)
 # @stdout index number of selected choice
 function ui#requestChoiceImpl
@@ -81,6 +81,15 @@ function ui#requestDirectoryImpl
 function ui#requestFileImpl
 { echo "NOT SUPPORTED" >&2 && exit 1; }
 
+# @description
+# Ask user for arbitrary input with no specific requirement on form or structure whatsoever.
+# @arg $1 string question text
+# @arg $2 string inital value 
+# @stdout user input
+# @exitcode 0 when user input wasn't empy
+function ui#requestInputImpl
+{ echo "NOT SUPPORTED" >&2 && exit 1; }
+
 # @endsection
 
 # -----------

sources/fs-root/opt/batocera-emulationstation/lib/ui/gui.shl

@@ -100,4 +100,11 @@ function ui#requestFileImpl
     "${__typeFilter[@]}"
 }
 
+# @description GUI-style implementation of asking for arbitrary input.
+# @see [ui#requestInputImpl](./backend-api.shl.md#uirequestInputImpl)
+function ui#requestInputImpl
+{
+  'ui#baseDialog' --entry --text="$1" --entry-text="$2"
+}
+
 # @endsection

sources/fs-root/opt/batocera-emulationstation/lib/ui/tty.shl

@@ -62,7 +62,10 @@ function ui#requestDirectoryImpl
   echo -n "$REPLY"
 }
 
-# @description TTY-style implementation of asking for a file.
+# @description TTY-style implementation of asking for a file.  
+# **Note:** This function uses `()` instead of `{}` for the function body
+# because it heavily modifies the execution environment to configure `read`.
+#
 # @see [ui#requestFileImpl](./backend-api.shl.md#uirequestFileImpl)
 # TODO: add a note 'leave empty to cancel' to prompt message
 function ui#requestFileImpl
@@ -85,4 +88,15 @@ function ui#requestFileImpl
   echo -n "$REPLY"
 )
 
+# @description TTY-style implementation of asking for arbitrary input with `read`.
+# @see [ui#requestInputImpl](./backend-api.shl.md#uirequestInputImpl)
+function ui#requestInputImpl
+{
+  local REPLY
+  read -rep "$1"$'\n'": " -i "$2"
+  REPLY="${REPLY%%[[:space:]]}"
+  echo -n "$REPLY"
+  [ -n "$REPLY" ] || return 1
+}
+
 # @endsection

sources/fs-root/opt/batocera-emulationstation/lib/user-interface.shl

@@ -73,14 +73,11 @@ function ui:ask {
   local _default="$2"
 
   local _question=$(lc "%%msg%% (default: '%%_default%%')" msg _default)
-  if "ui#isGraphical"; then
-    REPLY="$('ui#baseDialog' --entry --text="$_question" --entry-text="$_default")"
-  else
-    echo '' >&2
-    IFS='' read -ri "$2" -e -p "$_question"$'\n'": "
+  if ! "ui#asReply" ui#requestInputImpl "$_question" "${__default}"; then
+    [ "$1" = "--optional" ] || ui errorAbort 'An answer is required for this question.'
   fi
 
-  "ui#resultOut" "${REPLY:-"$2"}"
+  "ui#resultOut" "${REPLY}"
 }
 
 # @description
@@ -240,6 +237,9 @@ function ui#verify_isDir
 # @description
 # Verify that a given string is a file path+name whose ending matches a pattern list.  
 # The check will automatically append `$` at the end of the pattern.  
+# **Note:** This function uses `()` instead of `{}` for the function body
+# because it changes shell options to configure case insensitive matching.
+#
 # @stdout empty in case of verification failure, the full file path otherwise.
 # @arg $1 regex OR pattern of expected file endings as accepted by `[[ =~ ]]` (`T1|T2`)
 # @arg $2 path supposed file path to check