git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC/PATCH v4 1/6] completion: add new __git_complete helper

From
SZEDER Gábor <szeder@ira.uka.de>
Date
May 7, 2012, 09:51 UTC
Message-ID
<20120507095145.GP2164@goldbirke>
In-Reply-To
<1336353800-17323-2-git-send-email-felipe.contreras@gmail.com>
Hi,
On Mon, May 07, 2012 at 03:23:15AM +0200, Felipe Contreras wrote:
Show 23 quoted lines
> +__git_func_wrap ()
> +{
> +	if [[ -n ${ZSH_VERSION-} ]]; then
> +		emulate -L bash
> +		setopt KSH_TYPESET
> +
> +		# workaround zsh's bug that leaves 'words' as a special
> +		# variable in versions < 4.3.12
> +		typeset -h words
> +
> +		# workaround zsh's bug that quotes spaces in the COMPREPLY
> +		# array if IFS doesn't contain spaces.
> +		typeset -h IFS
> +	fi
> +	local cur words cword prev
> +	_get_comp_words_by_ref -n =: cur words cword prev
> +	_$1
> +}
> +
> +# this is NOT a public function; use at your own risk
> +__git_complete ()
> +{
> +	local name="${2-$1}"

Please add the underscore prefix here right away, so we don't need that "_$1" above in __git_func_wrap().

There is still no documentation about the parameters of __git_complete(), so...

It seems to set up completion for the command given as first argument to invoke the completion function given as second argument, right? But the completion function argument is optional, and if it's not specified, its name is derived from the command name by adding an underscore prefix (in __git_func_wrap()). So, in case of 'git', $name becomes 'git', hence the completion function to be invoked is _git(). So far so good.

> +	local wrapper="_${name}_wrap"
But then the wrapper function becomes _git_wrap().  Uh, oh.
> +	eval "$wrapper () { __git_func_wrap $name ; }"

... because this would then define the function _git_wrap(), which is not good, because that's supposed to be the completion function for the 'git wrap' command.

That's exactly why I wrote
  local wrapper="__git_wrap_$1"

in my earlier post, and it was not an unnecessary change that could be simplified away.

Show 32 quoted lines
> +	complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
> +		|| complete -o default -o nospace -F $wrapper $1
> +}
> +
> +__git_complete git
> +__git_complete gitk
>  
>  # The following are necessary only for Cygwin, and only are needed
>  # when the user has tab-completed the executable name and consequently
>  # included the '.exe' suffix.
>  #
>  if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
> -complete -o bashdefault -o default -o nospace -F _git git.exe 2>/dev/null \
> -	|| complete -o default -o nospace -F _git git.exe
> +__git_complete git.exe git
>  fi
> diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
> index 5bda6b6..331a5b9 100755
> --- a/t/t9902-completion.sh
> +++ b/t/t9902-completion.sh
> @@ -63,7 +63,7 @@ run_completion ()
>  	local _cword
>  	_words=( $1 )
>  	(( _cword = ${#_words[@]} - 1 ))
> -	_git && print_comp
> +	_git_wrap && print_comp
>  }
>  
>  test_completion ()
> -- 
> 1.7.10
> 
Previous: Felipe ContrerasNext: Junio C Hamano
Message 3 of 18 in “completion: __git_complete and other stuff”
  1. 0/6 completion: __git_complete and other stuffFelipe Contreras, May 7, 2012
  2. 1/6 completion: add new __git_complete helperFelipe Contreras, May 7, 2012
  3. SZEDER GáborMay 7, 2012
  4. Junio C HamanoMay 7, 2012
  5. Felipe ContrerasMay 7, 2012
  6. 2/6 tests: add more bash completion testsFelipe Contreras, May 7, 2012
  7. 3/6 completion: simplify _git_bundleFelipe Contreras, May 7, 2012
  8. 4/6 completion: simplify command stuffFelipe Contreras, May 7, 2012
  9. SZEDER GáborMay 7, 2012
  10. 5/6 completion: calculate argument position properlyFelipe Contreras, May 7, 2012
  11. Felipe ContrerasMay 7, 2012
  12. Junio C HamanoMay 7, 2012
  13. Felipe ContrerasMay 7, 2012
  14. Junio C HamanoMay 7, 2012
  15. Felipe ContrerasMay 8, 2012
  16. 6/6 completion: add public _GIT_complete helperFelipe Contreras, May 7, 2012
  17. Junio C HamanoMay 7, 2012
  18. Felipe ContrerasMay 7, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.