contrib / completion / git-completion.tcshon commit Merge branch 'mh/ceiling' into maint (ce956fc)
   1#!tcsh
   2#
   3# tcsh completion support for core Git.
   4#
   5# Copyright (C) 2012 Marc Khouzam <marc.khouzam@gmail.com>
   6# Distributed under the GNU General Public License, version 2.0.
   7#
   8# When sourced, this script will generate a new script that uses
   9# the git-completion.bash script provided by core Git.  This new
  10# script can be used by tcsh to perform git completion.
  11# The current script also issues the necessary tcsh 'complete'
  12# commands.
  13#
  14# To use this completion script:
  15#
  16#    1) Copy both this file and the bash completion script to ${HOME}.
  17#       You _must_ use the name ${HOME}/.git-completion.bash for the
  18#       bash script.
  19#       (e.g. ~/.git-completion.tcsh and ~/.git-completion.bash).
  20#    2) Add the following line to your .tcshrc/.cshrc:
  21#        source ~/.git-completion.tcsh
  22#    3) For completion similar to bash, it is recommended to also
  23#       add the following line to your .tcshrc/.cshrc:
  24#        set autolist=ambiguous
  25#       It will tell tcsh to list the possible completion choices.
  26
  27set __git_tcsh_completion_original_script = ${HOME}/.git-completion.bash
  28set __git_tcsh_completion_script = ${HOME}/.git-completion.tcsh.bash
  29
  30# Check that the user put the script in the right place
  31if ( ! -e ${__git_tcsh_completion_original_script} ) then
  32        echo "git-completion.tcsh: Cannot find: ${__git_tcsh_completion_original_script}.  Git completion will not work."
  33        exit
  34endif
  35
  36cat << EOF > ${__git_tcsh_completion_script}
  37#!bash
  38#
  39# This script is GENERATED and will be overwritten automatically.
  40# Do not modify it directly.  Instead, modify git-completion.tcsh
  41# and source it again.
  42
  43source ${__git_tcsh_completion_original_script}
  44
  45# Set COMP_WORDS in a way that can be handled by the bash script.
  46COMP_WORDS=(\$2)
  47
  48# The cursor is at the end of parameter #1.
  49# We must check for a space as the last character which will
  50# tell us that the previous word is complete and the cursor
  51# is on the next word.
  52if [ "\${2: -1}" == " " ]; then
  53        # The last character is a space, so our location is at the end
  54        # of the command-line array
  55        COMP_CWORD=\${#COMP_WORDS[@]}
  56else
  57        # The last character is not a space, so our location is on the
  58        # last word of the command-line array, so we must decrement the
  59        # count by 1
  60        COMP_CWORD=\$((\${#COMP_WORDS[@]}-1))
  61fi
  62
  63# Call _git() or _gitk() of the bash script, based on the first argument
  64_\${1}
  65
  66IFS=\$'\n'
  67if [ \${#COMPREPLY[*]} -gt 0 ]; then
  68        echo "\${COMPREPLY[*]}" | sort | uniq
  69else
  70        # No completions suggested.  In this case, we want tcsh to perform
  71        # standard file completion.  However, there does not seem to be way
  72        # to tell tcsh to do that.  To help the user, we try to simulate
  73        # file completion directly in this script.
  74        #
  75        # Known issues:
  76        #     - Possible completions are shown with their directory prefix.
  77        #     - Completions containing shell variables are not handled.
  78        #     - Completions with ~ as the first character are not handled.
  79
  80        # No file completion should be done unless we are completing beyond
  81        # the git sub-command.  An improvement on the bash completion :)
  82        if [ \${COMP_CWORD} -gt 1 ]; then
  83                TO_COMPLETE="\${COMP_WORDS[\${COMP_CWORD}]}"
  84
  85                # We don't support ~ expansion: too tricky.
  86                if [ "\${TO_COMPLETE:0:1}" != "~" ]; then
  87                        # Use ls so as to add the '/' at the end of directories.
  88                        RESULT=(\`ls -dp \${TO_COMPLETE}* 2> /dev/null\`)
  89                        echo \${RESULT[*]}
  90
  91                        # If there is a single completion and it is a directory,
  92                        # we output it a second time to trick tcsh into not adding a space
  93                        # after it.
  94                        if [ \${#RESULT[*]} -eq 1 ] && [ "\${RESULT[0]: -1}" == "/" ]; then
  95                                echo \${RESULT[*]}
  96                        fi
  97                fi
  98        fi
  99fi
 100
 101EOF
 102
 103# Don't need this variable anymore, so don't pollute the users environment
 104unset __git_tcsh_completion_original_script
 105
 106complete git  'p,*,`bash ${__git_tcsh_completion_script} git "${COMMAND_LINE}"`,'
 107complete gitk 'p,*,`bash ${__git_tcsh_completion_script} gitk "${COMMAND_LINE}"`,'