tools: add zsh completion for RMLVO components

To spare parsing yaml output in zsh code, these completers rely on yq to parse
the xkbcli output.

If yq is not installed, the completion should fail silently (similar to no
available completions), or display a message that yq is required for completions
if the zsh user has messages enabled.

The model completer includes a fallback parser using sed, we could possibly add
more fallbacks for the other RMLVO completions.

Author: rpigott

meson.build

@@ -570,6 +570,18 @@ if build_tools
         install_data('tools/xkbcli-zsh-completion.zsh',
                      rename: '_xkbcli',
                      install_dir: zsh_completion_path)
+        install_data('tools/xkb-model-zsh-completion.zsh',
+                     rename: '_xkb_model',
+                     install_dir: zsh_completion_path)
+        install_data('tools/xkb-layout-zsh-completion.zsh',
+                     rename: '_xkb_layout',
+                     install_dir: zsh_completion_path)
+        install_data('tools/xkb-variant-zsh-completion.zsh',
+                     rename: '_xkb_variant',
+                     install_dir: zsh_completion_path)
+        install_data('tools/xkb-options-zsh-completion.zsh',
+                     rename: '_xkb_options',
+                     install_dir: zsh_completion_path)
     endif
 
     # Tool: compile-keymap

tools/xkb-layout-zsh-completion.zsh

@@ -0,0 +1,20 @@
+#compdef -value-,XKB_DEFAULT_LAYOUT,-default-
+
+local layouts_yaml
+layouts_yaml="$(_call_program -l xkb-yaml xkbcli list)"
+
+case $status in
+	127 ) _message "xkb layout completion requires xkbcli" && return 127 ;;
+	<1->) _message "error listing xkb layouts" && return 1 ;;
+esac
+
+local yq_prog='.layouts[] | select(.variant == "") | "\(.layout):\(.description)"'
+local -a layouts
+layouts=( ${(@f)"$(printf '%s\n' $layouts_yaml | _call_program -l xkb-parse-yaml yq ${(q)yq_prog})"} )
+
+case $status in
+	127 ) _message "xkb layout completion requires yq" && return 127 ;;
+	<1->) _message "error completing xkb layouts" && return 1 ;;
+esac
+
+_describe -t xkb-layout 'xkb layout' layouts "$@"

tools/xkb-model-zsh-completion.zsh

@@ -0,0 +1,26 @@
+#compdef -value-,XKB_DEFAULT_MODEL,-default-
+
+local models_yaml
+models_yaml="$(_call_program -l xkb-yaml xkbcli list)"
+
+case $status in
+	127 ) _message "xkb model completion requires xkbcli" && return 127 ;;
+	<1->) _message "error listing xkb models" && return 1 ;;
+esac
+
+local yq_prog='.models[] | "\(.name):\(.description)"'
+local -a models
+models=( ${(@f)"$(printf '%s\n' $models_yaml | _call_program -l xkb-parse-yaml yq ${(q)yq_prog})"} )
+case $status in
+	127)
+		local sed_models='/^models:/,/^$/p' sed_names='s/- name: //p' sed_descriptions='s/  description: //p'
+		local models_sed="$(printf '%s\n' $models_yaml | _call_program -l sed sed -n ${(q)sed_models})"
+		local -a model_names=( ${(@f)"$(printf '%s\n' $models_sed | _call_program -l sed-names sed -n ${(q)sed_names})"})
+		local -a model_descriptions=( ${(@f)"$(printf '%s\n' $models_sed | _call_program -l sed-models sed -n ${(q)sed_descriptions})"})
+		printf -v models '%s:%s' ${model_names:^model_descriptions}
+		;;
+
+	<1->) _message "error completing xkb models" && return 1 ;;
+esac
+
+_describe -t xkb-model 'xkb model' models "$@"

tools/xkb-options-zsh-completion.zsh

@@ -0,0 +1,30 @@
+#compdef -value-,XKB_DEFAULT_OPTIONS,-default-
+
+local options_yaml
+options_yaml="$(_call_program -l xkb-yaml xkbcli list)"
+
+case $status in
+	127 ) _message "xkb option completion requires xkbcli" && return 127 ;;
+	<1->) _message "error listing xkb options" && return 1 ;;
+esac
+
+local yq_prog='.option_groups[] | "\(.name)[\(.description)]: :->option-\(.name)"'
+local -a option_groups
+option_groups=( ${(@f)"$(printf '%s\n' $options_yaml | _call_program -l xkb-parse-yaml yq ${(q)yq_prog})"} )
+
+case $status in
+	127 ) _message "xkb option completion requires yq" && return 127 ;;
+	<1->) _message "error completing xkb options" && return 1 ;;
+esac
+
+local context state state_descr line
+typeset -A val_args
+
+_values -S: 'xkb option' ${option_groups:s/Compose key/compose}
+if [[ $state == option-* ]]; then
+	local -a xkb_options
+	yq_prog='.option_groups[] | select(.name == "'${state#option-}'").options[] | "\(.name):\(.description)"'
+	xkb_options=( ${(@f)"$(printf '%s\n' $options_yaml | _call_program -l xkb-parse-yaml yq ${(q)yq_prog})"} )
+	xkb_options=( ${xkb_options#*:} )
+	_describe -t xkb-option 'xkb option' xkb_options
+fi

tools/xkb-variant-zsh-completion.zsh

@@ -0,0 +1,22 @@
+#compdef -value-,XKB_DEFAULT_VARIANT,-default-
+
+local variants_yaml
+variants_yaml="$(_call_program -l xkb-yaml xkbcli list)"
+
+case $status in
+	127 ) _message "xkb model completion requires xkbcli" && return 127 ;;
+	<1->) _message "error listing xkb variants" && return 1 ;;
+esac
+
+local yq_prog1='.layouts[] | select(.variant != "") | "\(.layout)(\(.variant)):\(.description)"'
+local yq_prog2='.layouts[] | select(.variant != "") | "\(.variant):\(.description)"'
+local -a variants1 variants2
+variants1=( ${(@f)"$(printf '%s\n' $variants_yaml | _call_program -l xkb-parse-yaml yq ${(q)yq_prog1})"} )
+variants2=( ${(@f)"$(printf '%s\n' $variants_yaml | _call_program -l xkb-parse-yaml yq ${(q)yq_prog2})"} )
+
+case $status in
+	127 ) _message "xkb model completion requires yq" && return 127 ;;
+	<1->) _message "error completing xkb variants" && return 1 ;;
+esac
+
+_describe -t xkb-model 'xkb model' variants1 variants2 "$@"

tools/xkbcli-zsh-completion.zsh

@@ -23,11 +23,11 @@ _xkbcli_commands() {
 }
 
 local -a rmlvo_opts_common=(
-	'--rules=[the XKB ruleset]:rules:()'
-	'--model=[the XKB model]:model:()'
-	'--layout=[the XKB layout]:layout:()'
-	'--variant=[the XKB variant]:variant:()'
-	'--options=[the XKB options]:options:()'
+	'--rules=[the XKB ruleset]:rules:(base evdev)'
+	'--model=[the XKB model]:model:_xkb_model'
+	'--layout=[the XKB layout]:layout:_xkb_layout'
+	'--variant=[the XKB variant]:variant:_xkb_variant'
+	'--options=[the XKB options]:options:_xkb_options'
 	'--enable-environment-names[set the default RMLVO values from the environment]'
 )