Skip to contentSkip to conversation

mmc-utils: Add bash completion

PATCH In review Torstein Eide 3 participants 3 messages Aug 10 – Sep 4

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 mmc-utils: Add bash completion

Add a bash completion script in completion/mmc that completes subcommands and /dev/mmcblkN device paths for all mmc commands.

Subcommand completion is driven by parsing 'mmc help' output rather than maintaining a parallel hardcoded verb list, so it stays in sync as commands are added or removed.

The completion directory is named 'completion/' rather than 'bash-completion/' so shell-specific scripts for other shells (zsh, fish, etc.) can be placed alongside it without renaming.

Add bashcompletiondir variable to the Makefile (defaulting to the standard /usr/share/bash-completion/completions) and install the script as part of 'make install'. The install path can be overridden at build time with make bashcompletiondir=<path>.

---
Changes since v1:
- Makefile: use 'bashcompletiondir ?=' instead of '='.
- completion/mmc: match rpmb, bootN, and partition device nodes in addition to the base mmcblkN device.

 Makefile       |  3 +++
 completion/mmc | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/HOWTO.rst |  6 ++++++
 3 files changed, 63 insertions(+)
 create mode 100644 completion/mmc
Makefile +3 -0
index bf8c006..6eb584b 100644
@@ -7,6 +7,7 @@ AM_CFLAGS = -D_FILE_OFFSET_BITS=64 -D_FORTIFY_SOURCE=2 \
 	    -DSD_IDS_PATH=\"$(idsdir)/sdcard.ids\" \
 	    -DMMC_IDS_PATH=\"$(idsdir)/multimediacard.ids\"
 CFLAGS ?= -g -O2
+bashcompletiondir ?= /usr/share/bash-completion/completions
 objects = \
 	mmc.o \
 	mmc_cmds.o \
@@ -63,6 +64,8 @@ install: $(progs)
 	$(INSTALL) -m755 -d $(DESTDIR)$(idsdir)
 	$(INSTALL) -m 644 sdcard.ids $(DESTDIR)$(idsdir)
 	$(INSTALL) -m 644 multimediacard.ids $(DESTDIR)$(idsdir)
+	$(INSTALL) -m755 -d $(DESTDIR)$(bashcompletiondir)
+	$(INSTALL) -m 644 completion/mmc $(DESTDIR)$(bashcompletiondir)/mmc
 
 -include $(foreach obj,$(objects), $(dir $(obj))/.$(notdir $(obj)).d)
 
completion/mmc new file +54 -0

54 lines not on this page · raw message

docs/HOWTO.rst +6 -0
index 0b486e4..3aba86f 100644
@@ -2,6 +2,12 @@
 
 Running mmc-utils
 -----------------
+**Bash completion**
+    Source ``completion/mmc`` to enable tab-completion for all subcommands and
+    device paths. When installed via ``make install``, the file is placed in
+    ``$(bashcompletiondir)`` (default: ``/usr/share/bash-completion/completions/mmc``)
+    and loaded automatically by bash-completion.
+
 **Name**
     mmc - a tool for configuring MMC storage devices
 **Synopsis**
Signature · 1 line
2.53.0
Reviewed-by on v2 1/1
#1 lore raw
Quoted 11 lines

Add a bash completion script in completion/mmc that completes subcommands and /dev/mmcblkN device paths for all mmc commands.

Subcommand completion is driven by parsing 'mmc help' output rather than maintaining a parallel hardcoded verb list, so it stays in sync as commands are added or removed.

The completion directory is named 'completion/' rather than 'bash- completion/' so shell-specific scripts for other shells (zsh, fish, etc.) can be placed alongside it without renaming.

Quoted 6 lines

Add bashcompletiondir variable to the Makefile (defaulting to the standard /usr/share/bash-completion/completions) and install the script as part of 'make install'. The install path can be overridden at build time with make bashcompletiondir=<path>.

#2 lore raw
In reply to Torstein Eide
Quoted 12 lines · Torstein Eide

Add a bash completion script in completion/mmc that completes subcommands and /dev/mmcblkN device paths for all mmc commands.

Subcommand completion is driven by parsing 'mmc help' output rather than maintaining a parallel hardcoded verb list, so it stays in sync as commands are added or removed.

The completion directory is named 'completion/' rather than 'bash-completion/' so shell-specific scripts for other shells (zsh, fish, etc.) can be placed alongside it without renaming.

Quoted 6 lines

Add bashcompletiondir variable to the Makefile (defaulting to the standard /usr/share/bash-completion/completions) and install the script as part of 'make install'. The install path can be overridden at build time with make bashcompletiondir=<path>.

Applied for mmc-utils master, thanks!

Kind regards
Uffe

Quoted 112 lines

---
Changes since v1:
- Makefile: use 'bashcompletiondir ?=' instead of '='.
- completion/mmc: match rpmb, bootN, and partition device nodes in addition to the base mmcblkN device.

 Makefile       |  3 +++
 completion/mmc | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/HOWTO.rst |  6 ++++++
 3 files changed, 63 insertions(+)
 create mode 100644 completion/mmc
Makefile +3 -0
index bf8c006..6eb584b 100644
@@ -7,6 +7,7 @@ AM_CFLAGS = -D_FILE_OFFSET_BITS=64 -D_FORTIFY_SOURCE=2 \
            -DSD_IDS_PATH=\"$(idsdir)/sdcard.ids\" \
            -DMMC_IDS_PATH=\"$(idsdir)/multimediacard.ids\"
 CFLAGS ?= -g -O2
+bashcompletiondir ?= /usr/share/bash-completion/completions
 objects = \
        mmc.o \
        mmc_cmds.o \
@@ -63,6 +64,8 @@ install: $(progs)
        $(INSTALL) -m755 -d $(DESTDIR)$(idsdir)
        $(INSTALL) -m 644 sdcard.ids $(DESTDIR)$(idsdir)
        $(INSTALL) -m 644 multimediacard.ids $(DESTDIR)$(idsdir)
+       $(INSTALL) -m755 -d $(DESTDIR)$(bashcompletiondir)
+       $(INSTALL) -m 644 completion/mmc $(DESTDIR)$(bashcompletiondir)/mmc
 
 -include $(foreach obj,$(objects), $(dir $(obj))/.$(notdir $(obj)).d)
 
completion/mmc new file +54 -0
new file mode 100644
index 0000000..1ac053b
@@ -0,0 +1,54 @@
+_mmc_complete() {
+       local cur prev words cword
+       _init_completion || return
+
+       local devices
+       # Include rpmb, bootN, and partition nodes alongside the base device.
+       devices=$(compgen -G "/dev/mmcblk*" 2>/dev/null | grep -E '^/dev/mmcblk[0-9]+(rpmb|boot[0-9]+|p[0-9]+)?$')
+
+       local mmcbin
+       mmcbin=$(type -P "${words[0]}") || return
+
+       # "mmc help" prints one "Usage for command\t<verb words...> <args...>"
+       # line per command. Argument placeholders always start with '<', so
+       # stripping from the first '<' onward leaves just the verb words.
+       local verbs
+       verbs=$("$mmcbin" help 2>/dev/null | sed -n 's/^Usage for command[[:space:]]*//p' | sed 's/<.*//')
+       [[ -z $verbs ]] && return
+
+       local -a typed=("${words[@]:1:cword-1}")
+       local -A next_words=()
+       local have_leaf=
+
+       local line i match
+       while IFS= read -r line; do
+               [[ -z $line ]] && continue
+               local -a w
+               read -ra w <<<"$line"
+               [[ ${#w[@]} -lt ${#typed[@]} ]] && continue
+
+               match=1
+               for ((i = 0; i < ${#typed[@]}; i++)); do
+                       if [[ ${w[i]} != "${typed[i]}" ]]; then
+                               match=0
+                               break
+                       fi
+               done
+               [[ $match -eq 0 ]] && continue
+
+               if [[ ${#w[@]} -gt ${#typed[@]} ]]; then
+                       next_words[${w[${#typed[@]}]}]=1
+               else
+                       have_leaf=1
+               fi
+       done <<<"$verbs"
+
+       if [[ ${#next_words[@]} -gt 0 ]]; then
+               COMPREPLY=($(compgen -W "${!next_words[*]}" -- "$cur"))
+       elif [[ -n $have_leaf ]]; then
+               COMPREPLY=($(compgen -W "$devices" -- "$cur"))
+       fi
+}
+
+complete -F _mmc_complete mmc
+complete -F _mmc_complete ./mmc
docs/HOWTO.rst +6 -1
index 0b486e4..3aba86f 100644
@@ -2,6 +2,12 @@
 
 Running mmc-utils
 -----------------
+**Bash completion**
+    Source ``completion/mmc`` to enable tab-completion for all subcommands and
+    device paths. When installed via ``make install``, the file is placed in
+    ``$(bashcompletiondir)`` (default: ``/usr/share/bash-completion/completions/mmc``)
+    and loaded automatically by bash-completion.
+
 **Name**
     mmc - a tool for configuring MMC storage devices
 **Synopsis**
--

2.53.0