mirror of
https://github.com/containers/podman.git
synced 2025-09-28 17:25:31 +08:00

The new cobra v1.2.0 release brings a number of bug fixes for shell completion scripts. Regenerate the scripts with `make completions` to sync them with the upstream version, currently we have some custom ones to avoid some upstream bugs. Because the new cobra version has all fixes we should use the upstream scripts. Add a check to CI to ensure we always use the up to date scripts. [NO TESTS NEEDED] Signed-off-by: Paul Holzinger <pholzing@redhat.com>
180 lines
6.3 KiB
Bash
180 lines
6.3 KiB
Bash
#compdef _podman podman
|
|
|
|
# zsh completion for podman -*- shell-script -*-
|
|
|
|
__podman_debug()
|
|
{
|
|
local file="$BASH_COMP_DEBUG_FILE"
|
|
if [[ -n ${file} ]]; then
|
|
echo "$*" >> "${file}"
|
|
fi
|
|
}
|
|
|
|
_podman()
|
|
{
|
|
local shellCompDirectiveError=1
|
|
local shellCompDirectiveNoSpace=2
|
|
local shellCompDirectiveNoFileComp=4
|
|
local shellCompDirectiveFilterFileExt=8
|
|
local shellCompDirectiveFilterDirs=16
|
|
|
|
local lastParam lastChar flagPrefix requestComp out directive comp lastComp noSpace
|
|
local -a completions
|
|
|
|
__podman_debug "\n========= starting completion logic =========="
|
|
__podman_debug "CURRENT: ${CURRENT}, words[*]: ${words[*]}"
|
|
|
|
# The user could have moved the cursor backwards on the command-line.
|
|
# We need to trigger completion from the $CURRENT location, so we need
|
|
# to truncate the command-line ($words) up to the $CURRENT location.
|
|
# (We cannot use $CURSOR as its value does not work when a command is an alias.)
|
|
words=("${=words[1,CURRENT]}")
|
|
__podman_debug "Truncated words[*]: ${words[*]},"
|
|
|
|
lastParam=${words[-1]}
|
|
lastChar=${lastParam[-1]}
|
|
__podman_debug "lastParam: ${lastParam}, lastChar: ${lastChar}"
|
|
|
|
# For zsh, when completing a flag with an = (e.g., podman -n=<TAB>)
|
|
# completions must be prefixed with the flag
|
|
setopt local_options BASH_REMATCH
|
|
if [[ "${lastParam}" =~ '-.*=' ]]; then
|
|
# We are dealing with a flag with an =
|
|
flagPrefix="-P ${BASH_REMATCH}"
|
|
fi
|
|
|
|
# Prepare the command to obtain completions
|
|
requestComp="${words[1]} __complete ${words[2,-1]}"
|
|
if [ "${lastChar}" = "" ]; then
|
|
# If the last parameter is complete (there is a space following it)
|
|
# We add an extra empty parameter so we can indicate this to the go completion code.
|
|
__podman_debug "Adding extra empty parameter"
|
|
requestComp="${requestComp} \"\""
|
|
fi
|
|
|
|
__podman_debug "About to call: eval ${requestComp}"
|
|
|
|
# Use eval to handle any environment variables and such
|
|
out=$(eval ${requestComp} 2>/dev/null)
|
|
__podman_debug "completion output: ${out}"
|
|
|
|
# Extract the directive integer following a : from the last line
|
|
local lastLine
|
|
while IFS='\n' read -r line; do
|
|
lastLine=${line}
|
|
done < <(printf "%s\n" "${out[@]}")
|
|
__podman_debug "last line: ${lastLine}"
|
|
|
|
if [ "${lastLine[1]}" = : ]; then
|
|
directive=${lastLine[2,-1]}
|
|
# Remove the directive including the : and the newline
|
|
local suffix
|
|
(( suffix=${#lastLine}+2))
|
|
out=${out[1,-$suffix]}
|
|
else
|
|
# There is no directive specified. Leave $out as is.
|
|
__podman_debug "No directive found. Setting do default"
|
|
directive=0
|
|
fi
|
|
|
|
__podman_debug "directive: ${directive}"
|
|
__podman_debug "completions: ${out}"
|
|
__podman_debug "flagPrefix: ${flagPrefix}"
|
|
|
|
if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
|
|
__podman_debug "Completion received error. Ignoring completions."
|
|
return
|
|
fi
|
|
|
|
while IFS='\n' read -r comp; do
|
|
if [ -n "$comp" ]; then
|
|
# If requested, completions are returned with a description.
|
|
# The description is preceded by a TAB character.
|
|
# For zsh's _describe, we need to use a : instead of a TAB.
|
|
# We first need to escape any : as part of the completion itself.
|
|
comp=${comp//:/\\:}
|
|
|
|
local tab=$(printf '\t')
|
|
comp=${comp//$tab/:}
|
|
|
|
__podman_debug "Adding completion: ${comp}"
|
|
completions+=${comp}
|
|
lastComp=$comp
|
|
fi
|
|
done < <(printf "%s\n" "${out[@]}")
|
|
|
|
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
|
|
__podman_debug "Activating nospace."
|
|
noSpace="-S ''"
|
|
fi
|
|
|
|
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
|
# File extension filtering
|
|
local filteringCmd
|
|
filteringCmd='_files'
|
|
for filter in ${completions[@]}; do
|
|
if [ ${filter[1]} != '*' ]; then
|
|
# zsh requires a glob pattern to do file filtering
|
|
filter="\*.$filter"
|
|
fi
|
|
filteringCmd+=" -g $filter"
|
|
done
|
|
filteringCmd+=" ${flagPrefix}"
|
|
|
|
__podman_debug "File filtering command: $filteringCmd"
|
|
_arguments '*:filename:'"$filteringCmd"
|
|
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
|
|
# File completion for directories only
|
|
local subDir
|
|
subdir="${completions[1]}"
|
|
if [ -n "$subdir" ]; then
|
|
__podman_debug "Listing directories in $subdir"
|
|
pushd "${subdir}" >/dev/null 2>&1
|
|
else
|
|
__podman_debug "Listing directories in ."
|
|
fi
|
|
|
|
local result
|
|
_arguments '*:dirname:_files -/'" ${flagPrefix}"
|
|
result=$?
|
|
if [ -n "$subdir" ]; then
|
|
popd >/dev/null 2>&1
|
|
fi
|
|
return $result
|
|
else
|
|
__podman_debug "Calling _describe"
|
|
if eval _describe "completions" completions $flagPrefix $noSpace; then
|
|
__podman_debug "_describe found some completions"
|
|
|
|
# Return the success of having called _describe
|
|
return 0
|
|
else
|
|
__podman_debug "_describe did not find completions."
|
|
__podman_debug "Checking if we should do file completion."
|
|
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
|
__podman_debug "deactivating file completion"
|
|
|
|
# We must return an error code here to let zsh know that there were no
|
|
# completions found by _describe; this is what will trigger other
|
|
# matching algorithms to attempt to find completions.
|
|
# For example zsh can match letters in the middle of words.
|
|
return 1
|
|
else
|
|
# Perform file completion
|
|
__podman_debug "Activating file completion"
|
|
|
|
# We must return the result of this command, so it must be the
|
|
# last command, or else we must store its result to return it.
|
|
_arguments '*:filename:_files'" ${flagPrefix}"
|
|
fi
|
|
fi
|
|
fi
|
|
}
|
|
|
|
# don't run the completion function when being source-ed or eval-ed
|
|
if [ "$funcstack[1]" = "_podman" ]; then
|
|
_podman
|
|
fi
|
|
|
|
# This file is generated with "podman completion"; see: podman-completion(1)
|