Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

refactor: ship depreated things in a separate file #870

Merged
merged 3 commits into from
Feb 25, 2023
Merged

refactor: ship depreated things in a separate file #870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a387d1
refactor: ground work for shipping depreated things in a separate file
scop Dec 22, 2022
cdd8a15
feat(bash_completion.d): load from one relative to the main script
scop Feb 22, 2023
b9db024
fix(compat): checking non-empty `$BASH_COMPLETION_COMPAT_DIR`
scop Feb 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pkgdata_DATA = bash_completion

# Empty, but here just to get the compat dir created with install
compatdir = $(sysconfdir)/bash_completion.d
compat_DATA =
compat_DATA = bash_completion.d/000_bash_completion_compat

profiledir = $(sysconfdir)/profile.d
profile_DATA = bash_completion.sh
Expand All @@ -31,7 +31,8 @@ CLEANFILES = bash_completion.sh bash-completion.pc \
EXTRA_DIST = CHANGELOG.md $(pkgdata_DATA) bash_completion.sh.in .dir-locals.el \
.editorconfig README.md CONTRIBUTING.md pyproject.toml .perltidyrc \
.shellcheckrc bash-completion.pc.in bash-completion-config.cmake.in \
bash-completion-config-version.cmake.in setup-symlinks.sh
bash-completion-config-version.cmake.in setup-symlinks.sh \
$(compat_DATA)

install-data-hook:
tmpfile=`mktemp $${TMPDIR:-/tmp}/bash_completion.XXXXXX` && \
Expand Down
157 changes: 21 additions & 136 deletions bash_completion
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,6 @@ _comp_userland()
[[ $userland == "$1" ]]
}

_comp_deprecate_func _userland _comp_userland

# This function sets correct SysV init directories
#
_comp_sysvdirs()
Expand All @@ -112,8 +110,6 @@ _comp_sysvdirs()
return 0
}

_comp_deprecate_func _sysvdirs _comp_sysvdirs

# This function checks whether we have a given program on the system.
#
_comp_have_command()
Expand All @@ -123,18 +119,6 @@ _comp_have_command()
PATH=$PATH:/usr/sbin:/sbin:/usr/local/sbin type "$1" &>/dev/null
}

_comp_deprecate_func _have _comp_have_command

# Backwards compatibility for compat completions that use have().
# @deprecated should no longer be used; generally not needed with dynamically
# loaded completions, and _comp_have_command is suitable for runtime use.
# shellcheck disable=SC2317 # available at load time only
have()
{
unset -v have
_comp_have_command "$1" && have=yes
}

# This function checks whether a given readline variable
# is `on'.
#
Expand All @@ -143,8 +127,6 @@ _comp_readline_variable_on()
[[ $(bind -v) == *$1+([[:space:]])on* ]]
}

_comp_deprecate_func _rl_enabled _comp_readline_variable_on

# This function shell-quotes the argument
# @param $1 String to be quoted
# @var[out] ret Resulting string
Expand All @@ -153,15 +135,6 @@ _comp_quote()
ret=\'${1//\'/\'\\\'\'}\'
}

# This function shell-quotes the argument
# @deprecated Use `_comp_quote` instead. Note that `_comp_quote` stores
# the results in the variable `ret` instead of writing them to stdout.
quote()
{
local quoted=${1//\'/\'\\\'\'}
printf "'%s'" "$quoted"
}

# @see _quote_readline_by_ref()
quote_readline()
{
Expand Down Expand Up @@ -231,18 +204,6 @@ _comp_dequote()
eval "ret=($1)" 2>/dev/null # may produce failglob
}

# This function shell-dequotes the argument
# @deprecated Use `_comp_dequote' instead. Note that `_comp_dequote` stores
# the results in the array `ret` instead of writing them to stdout.
dequote()
{
local ret
_comp_dequote "$1"
local rc=$?
printf %s "$ret"
return $rc
}

# Unset the given variables across a scope boundary. Useful for unshadowing
# global scoped variables. Note that simply calling unset on a local variable
# will not unshadow the global variable. Rather, the result will be a local
Expand All @@ -260,29 +221,6 @@ _comp_unlocal()
fi
}

# Assign variable one scope above the caller
# Usage: local "$1" && _upvar $1 "value(s)"
# @param $1 Variable name to assign value to
# @param $* Value(s) to assign. If multiple values, an array is
# assigned, otherwise a single value is assigned.
# NOTE: For assigning multiple variables, use '_upvars'. Do NOT
# use multiple '_upvar' calls, since one '_upvar' call might
# reassign a variable to be used by another '_upvar' call.
# @see https://fvue.nl/wiki/Bash:_Passing_variables_by_reference
_upvar()
{
echo "bash_completion: $FUNCNAME: deprecated function," \
"use _upvars instead" >&2
if unset -v "$1"; then # Unset & validate varname
# shellcheck disable=SC2140 # TODO
if (($# == 2)); then
eval "$1"=\"\$2\" # Return single value
else
eval "$1"=\(\"\$"{@:2}"\"\) # Return array
fi
fi
}

# Assign variables one scope above the caller
# Usage: local varname [varname ...] &&
# _upvars [-v varname value] | [-aN varname [value ...]] ...
Expand Down Expand Up @@ -648,66 +586,6 @@ _get_comp_words_by_ref()
((${#upvars[@]})) && local "${upvars[@]}" && _upvars "${upargs[@]}"
}

# Get the word to complete.
# This is nicer than ${COMP_WORDS[COMP_CWORD]}, since it handles cases
# where the user is completing in the middle of a word.
# (For example, if the line is "ls foobar",
# and the cursor is here --------> ^
# @param $1 string Characters out of $COMP_WORDBREAKS which should NOT be
# considered word breaks. This is useful for things like scp where
# we want to return host:path and not only path, so we would pass the
# colon (:) as $1 in this case.
# @param $2 integer Index number of word to return, negatively offset to the
# current word (default is 0, previous is 1), respecting the exclusions
# given at $1. For example, `_get_cword "=:" 1' returns the word left of
# the current word, respecting the exclusions "=:".
# @deprecated Use `_get_comp_words_by_ref cur' instead
# @see _get_comp_words_by_ref()
_get_cword()
{
local LC_CTYPE=C
local cword words
__reassemble_comp_words_by_ref "${1-}" words cword

# return previous word offset by $2
if [[ ${2-} && ${2//[^0-9]/} ]]; then
printf "%s" "${words[cword - $2]}"
elif ((${#words[cword]} == 0 && COMP_POINT == ${#COMP_LINE})); then
: # nothing
else
local i
local cur=$COMP_LINE
local index=$COMP_POINT
for ((i = 0; i <= cword; ++i)); do
# Current word fits in $cur, and $cur doesn't match cword?
while [[ ${#cur} -ge ${#words[i]} &&
${cur:0:${#words[i]}} != "${words[i]}" ]]; do
# Strip first character
cur=${cur:1}
# Decrease cursor position, staying >= 0
((index > 0)) && ((index--))
done

# Does found word match cword?
if ((i < cword)); then
# No, cword lies further;
local old_size=${#cur}
cur=${cur#"${words[i]}"}
local new_size=${#cur}
((index -= old_size - new_size))
fi
done

if [[ ${words[cword]:0:${#cur}} != "$cur" ]]; then
# We messed up! At least return the whole word so things
# keep working
printf "%s" "${words[cword]}"
else
printf "%s" "${cur:0:index}"
fi
fi
} # _get_cword()

# Get word previous to the current word.
# This is a good alternative to `prev=${COMP_WORDS[COMP_CWORD-1]}' because bash4
# will properly return the previous word with respect to any given exclusions to
Expand Down Expand Up @@ -1127,7 +1005,6 @@ _comp_initialize()

return 0
}
_comp_deprecate_func _init_completion _comp_initialize

# Helper function for _parse_help and _parse_usage.
# @return True (0) if an option was found, False (> 0) otherwise
Expand Down Expand Up @@ -1582,10 +1459,6 @@ _gids()
#
_comp_backup_glob='@(#*#|*@(~|.@(bak|orig|rej|swp|dpkg*|rpm@(orig|new|save))))'

# @deprecated Use the variable `_comp_backup_glob` instead. This is the
# backward-compatibility name.
_backup_glob=$_comp_backup_glob

# Complete on xinetd services
#
_xinetd_services()
Expand Down Expand Up @@ -2387,7 +2260,6 @@ _comp_command_offset()
done
fi
}
_comp_deprecate_func _command_offset _comp_command_offset

# A _comp_command_offset wrapper function for use when the offset is unknown.
# Only intended to be used as a completion function directly associated
Expand All @@ -2407,7 +2279,6 @@ _comp_command()
done
_comp_command_offset $offset
}
_comp_deprecate_func _command _comp_command
complete -F _comp_command aoss command "do" else eval exec ltrace nice nohup padsp \
"then" time tsocks vsound xargs

Expand All @@ -2417,7 +2288,6 @@ _comp_root_command()
local root_command=$1
_comp_command
}
_comp_deprecate_func _root_command _comp_root_command
complete -F _comp_root_command fakeroot gksu gksudo kdesudo really

# Return true if the completion should be treated as running as root
Expand Down Expand Up @@ -2739,17 +2609,32 @@ _comp_xfunc()
"$xfunc_name" "${@:3}"
}

_comp_deprecate_func _xfunc _comp_xfunc

# source compat completion directory definitions
_comp__init_compat_dir=${BASH_COMPLETION_COMPAT_DIR:-/etc/bash_completion.d}
if [[ -d $_comp__init_compat_dir && -r $_comp__init_compat_dir && -x $_comp__init_compat_dir ]]; then
_comp__init_compat_dirs=()
if [[ ${BASH_COMPLETION_COMPAT_DIR-} ]]; then
_comp__init_compat_dirs+=("$BASH_COMPLETION_COMPAT_DIR")
else
_comp__init_compat_dirs+=(/etc/bash_completion.d)
# Similarly as for the "completions" dir, look up from relative to
# bash_completion, primarily for run-in-place-from-git-clone setups.
# Notably we do it after the system location here, in order to
# prefer in-tree variables and functions.
if [[ $BASH_SOURCE == */* ]]; then
_comp__init_compat_dir="${BASH_SOURCE%/*}/bash_completion.d"
[[ ${_comp__init_compat_dirs[0]} == "$_comp__init_compat_dir" ]] ||
_comp__init_compat_dirs+=("$_comp__init_compat_dir")
else
_comp__init_compat_dirs+=(./bash_completion.d)
fi
fi
for _comp__init_compat_dir in "${_comp__init_compat_dirs[@]}"; do
[[ -d $_comp__init_compat_dir && -r $_comp__init_compat_dir && -x $_comp__init_compat_dir ]] || continue
for _comp__init_file in "$_comp__init_compat_dir"/*; do
[[ ${_comp__init_file##*/} != @($_comp_backup_glob|Makefile*|${BASH_COMPLETION_COMPAT_IGNORE-}) &&
-f $_comp__init_file && -r $_comp__init_file ]] && . "$_comp__init_file"
done
fi
unset -v _comp__init_compat_dir _comp__init_file
done
unset -v _comp__init_compat_dirs _comp__init_compat_dir _comp__init_file

# source user completion file
#
Expand Down
Loading