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

Re: [PATCH] Add tcsh-completion support to contrib by using git-completion.bash

From
Marc Khouzam <marc.khouzam@gmail.com>
Date
Nov 14, 2012, 03:36 UTC
Message-ID
<CAFj1UpEB5TqQKmEDoPY-nH5d+Ki_0R70Jd=WXtkxEj-emHEfaA@mail.gmail.com>
In-Reply-To
<CAMP44s3imos4DksroRkZ3K6una5H916gvtqttJQna8yGG8XhsQ@mail.gmail.com>

Thanks for the review. I wasn't aware that you were doing a similar effort for zsh.

On Tue, Nov 13, 2012 at 1:31 PM, Felipe Contreras <felipe.contreras@gmail.com> wrote:

Show 7 quoted lines
> On Mon, Nov 12, 2012 at 9:07 PM, Marc Khouzam <marc.khouzam@gmail.com> wrote:
>
>> this patch allows tcsh-users to get the benefits of the awesome
>> git-completion.bash script.  It could also help other shells do the same.
>
> Maybe you can try to take a look at the same for zsh:
> http://article.gmane.org/gmane.comp.version-control.git/208173

Cool. The major difference is that (as Gábor mentioned) zsh understands bash syntax but tcsh does not. tcsh doesn't even allow to define functions. So we have to take a different approach to get the bash completion script to be used by tcsh.

Show 81 quoted lines
>> ---
>>  contrib/completion/git-completion.bash |   53 +++++++++++++++++++++++++++++++-
>>  contrib/completion/git-completion.tcsh |   34 ++++++++++++++++++++
>>  2 files changed, 86 insertions(+), 1 deletions(-)
>>  create mode 100755 contrib/completion/git-completion.tcsh
>>
>> diff --git a/contrib/completion/git-completion.bash
>> b/contrib/completion/git-completion.bash
>> index be800e0..6d4b57a 100644
>> --- a/contrib/completion/git-completion.bash
>> +++ b/contrib/completion/git-completion.bash
>> @@ -1,4 +1,6 @@
>> -#!bash
>> +#!/bin/bash
>> +# The above line is important as this script can be executed when used
>> +# with another shell such as tcsh
>>  #
>>  # bash/zsh completion support for core Git.
>>  #
>> @@ -2481,3 +2483,52 @@ __git_complete gitk __gitk_main
>>  if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
>>  __git_complete git.exe __git_main
>>  fi
>> +
>> +# Method that will output the result of the completion done by
>> +# the bash completion script, so that it can be re-used in another
>> +# context than the bash complete command.
>> +# It accepts 1 to 2 arguments:
>> +# 1: The command-line to complete
>> +# 2: The index of the word within argument #1 in which the cursor is
>> +#    located (optional). If parameter 2 is not provided, it will be
>> +#    determined as best possible using parameter 1.
>> +_git_complete_with_output ()
>> +{
>> +       # Set COMP_WORDS to the command-line as bash would.
>> +       COMP_WORDS=($1)
>> +
>> +       # Set COMP_CWORD to the cursor location as bash would.
>> +       if [ -n "$2" ]; then
>> +               COMP_CWORD=$2
>> +       else
>> +               # Assume the cursor is at the end of parameter #1.
>> +               # We must check for a space as the last character which will
>> +               # tell us that the previous word is complete and the cursor
>> +               # is on the next word.
>> +               if [ "${1: -1}" == " " ]; then
>> +                       # The last character is a space, so our
>> location is at the end
>> +                       # of the command-line array
>> +                       COMP_CWORD=${#COMP_WORDS[@]}
>> +               else
>> +                       # The last character is not a space, so our
>> location is on the
>> +                       # last word of the command-line array, so we
>> must decrement the
>> +                       # count by 1
>> +                       COMP_CWORD=$((${#COMP_WORDS[@]}-1))
>> +               fi
>> +       fi
>> +
>> +       # Call _git() or _gitk() of the bash script, based on the first
>> +       # element of the command-line
>> +       _${COMP_WORDS[0]}
>
> You might want to use __${COMP_WORDS[0]}_main instead.
>
>> +
>> +       # Print the result that is stored in the bash variable ${COMPREPLY}
>> +       for i in ${COMPREPLY[@]}; do
>> +               echo "$i"
>> +       done
>> +}
>> +
>> +if [ -n "$1" ] ; then
>> +  # If there is an argument, we know the script is being executed
>> +  # so go ahead and run the _git_complete_with_output function
>> +  _git_complete_with_output "$1" "$2"
>> +fi
>
> Why do you need this function in this file? You can very easily add
> this function to git-completion.tcsh.

tcsh does not allow to define functions, so it is not aware of any of the git-completion.bash functions. So, git-completion.tcsh cannot call anything from git-completion.bash.

Show 52 quoted lines
>> diff --git a/contrib/completion/git-completion.tcsh
>> b/contrib/completion/git-completion.tcsh
>> new file mode 100755
>> index 0000000..7b7baea
>> --- /dev/null
>> +++ b/contrib/completion/git-completion.tcsh
>> @@ -0,0 +1,34 @@
>> +#!tcsh
>> +#
>> +# tcsh completion support for core Git.
>> +#
>> +# Copyright (C) 2012 Marc Khouzam <marc.khouzam@gmail.com>
>> +# Distributed under the GNU General Public License, version 2.0.
>> +#
>> +# This script makes use of the git-completion.bash script to
>> +# determine the proper completion for git commands under tcsh.
>> +#
>> +# To use this completion script:
>> +#
>> +#    1) Copy both this file and the bash completion script to your
>> ${HOME} directory
>> +#       using the names ${HOME}/.git-completion.tcsh and
>> ${HOME}/.git-completion.bash.
>> +#    2) Add the following line to your .tcshrc/.cshrc:
>> +#        source ${HOME}/.git-completion.tcsh
>> +
>> +# One can change the below line to use a different location
>> +set __git_tcsh_completion_script = ${HOME}/.git-completion.bash
>> +
>> +# Check that the user put the script in the right place
>> +if ( ! -e ${__git_tcsh_completion_script} ) then
>> +       echo "ERROR in git-completion.tcsh script.  Cannot find:
>> ${__git_tcsh_completion_script}.  Git completion will not work."
>> +       exit
>> +endif
>> +
>> +# Make the script executable if it is not
>> +if ( ! -x ${__git_tcsh_completion_script} ) then
>> +       chmod u+x ${__git_tcsh_completion_script}
>> +endif
>
> Why not just source it?
>
>> +complete git  'p/*/`${__git_tcsh_completion_script} "${COMMAND_LINE}"
>> | sort | uniq`/'
>> +complete gitk 'p/*/`${__git_tcsh_completion_script} "${COMMAND_LINE}"
>> | sort | uniq`/'
>
> This seems to be very different from bash's 'complete'. I wonder if
> the 'complete' commands in the original script cause any problems.
> Maybe only if you source it, but then again, I would expect a warning
> or something when you run it.

If you source the script under tcsh it will fail miserably because the bash syntax is very different. But when you run it, it runs under the bash shell so everything will work fine. The 'complete' command in the bash script will run, but will only affect the temporary bash shell that was started to run the script. Useless but harmless.

Show 9 quoted lines
> But you can use the trick I did with zsh so you can source it:
>
> complete ()
> {
>         # do nothing
>         return 0
> }
>
> . "$script"

This is pretty cool. Function overriding in shell scripts! tcsh doesn't even have functions, so that trick is out of its league :)

Thanks
Marc
Previous: Felipe ContrerasNext: SZEDER Gábor
Message 38 of 39 in “Fwd: [PATCH] Add tcsh-completion support to contrib by using git-completion.bash”
  1. Marc KhouzamNov 12, 2012
  2. SZEDER GáborNov 13, 2012
  3. Marc KhouzamNov 13, 2012
  4. SZEDER GáborNov 13, 2012
  5. completion: remove 'help' duplicate from porcelain commandsSZEDER Gábor, Nov 14, 2012
  6. Marc KhouzamNov 14, 2012
  7. tcsh-completion re-using git-completion.bashMarc Khouzam, Nov 15, 2012
  8. Felipe ContrerasNov 16, 2012
  9. Marc KhouzamNov 16, 2012
  10. Felipe ContrerasNov 16, 2012
  11. Marc KhouzamNov 16, 2012
  12. tcsh-completion re-using git-completion.bashMarc Khouzam, Nov 16, 2012
  13. Felipe ContrerasNov 16, 2012
  14. tcsh-completion re-using git-completion.bashMarc Khouzam, Nov 16, 2012
  15. Junio C HamanoNov 16, 2012
  16. Felipe ContrerasNov 16, 2012
  17. Felipe ContrerasNov 16, 2012
  18. Marc KhouzamNov 16, 2012
  19. Felipe ContrerasNov 16, 2012
  20. SZEDER GáborNov 16, 2012
  21. Felipe ContrerasNov 16, 2012
  22. SZEDER GáborNov 16, 2012
  23. Felipe ContrerasNov 16, 2012
  24. SZEDER GáborNov 17, 2012
  25. Felipe ContrerasNov 17, 2012
  26. SZEDER GáborNov 17, 2012
  27. Junio C HamanoNov 16, 2012
  28. Felipe ContrerasNov 16, 2012
  29. Marc KhouzamNov 17, 2012
  30. Felipe ContrerasNov 17, 2012
  31. Marc KhouzamNov 20, 2012
  32. Felipe ContrerasNov 20, 2012
  33. Marc KhouzamNov 20, 2012
  34. Junio C HamanoNov 20, 2012
  35. Felipe ContrerasNov 13, 2012
  36. SZEDER GáborNov 14, 2012
  37. Felipe ContrerasNov 15, 2012
  38. Marc KhouzamNov 14, 2012
  39. SZEDER GáborNov 14, 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.