contrib/completion/git-completion.tcsh

   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
  27 set __git_tcsh_completion_original_script = ${HOME}/.git-completion.bash
  28 set __git_tcsh_completion_script = ${HOME}/.git-completion.tcsh.bash
  29
  30 # Check that the user put the script in the right place
  31 if ( ! -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
  34 endif
  35
  36 cat << 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
  43 source ${__git_tcsh_completion_original_script}
  44
  45 # Remove the colon as a completion separator because tcsh cannot handle it
  46 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
  47
  48 # For file completion, tcsh needs the '/' to be appended to directories.
  49 # By default, the bash script does not do that.
  50 # We can achieve this by using the below compatibility
  51 # method of the git-completion.bash script.
  52 __git_index_file_list_filter ()
  53 {
  54         __git_index_file_list_filter_compat
  55 }
  56
  57 # Set COMP_WORDS in a way that can be handled by the bash script.
  58 COMP_WORDS=(\$2)
  59
  60 # The cursor is at the end of parameter #1.
  61 # We must check for a space as the last character which will
  62 # tell us that the previous word is complete and the cursor
  63 # is on the next word.
  64 if [ "\${2: -1}" == " " ]; then
  65         # The last character is a space, so our location is at the end
  66         # of the command-line array
  67         COMP_CWORD=\${#COMP_WORDS[@]}
  68 else
  69         # The last character is not a space, so our location is on the
  70         # last word of the command-line array, so we must decrement the
  71         # count by 1
  72         COMP_CWORD=\$((\${#COMP_WORDS[@]}-1))
  73 fi
  74
  75 # Call _git() or _gitk() of the bash script, based on the first argument
  76 _\${1}
  77
  78 IFS=\$'\n'
  79 if [ \${#COMPREPLY[*]} -gt 0 ]; then
  80         echo "\${COMPREPLY[*]}" | sort | uniq
  81 else
  82         # No completions suggested.  In this case, we want tcsh to perform
  83         # standard file completion.  However, there does not seem to be way
  84         # to tell tcsh to do that.  To help the user, we try to simulate
  85         # file completion directly in this script.
  86         #
  87         # Known issues:
  88         #     - Possible completions are shown with their directory prefix.
  89         #     - Completions containing shell variables are not handled.
  90         #     - Completions with ~ as the first character are not handled.
  91
  92         # No file completion should be done unless we are completing beyond
  93         # the git sub-command.  An improvement on the bash completion :)
  94         if [ \${COMP_CWORD} -gt 1 ]; then
  95                 TO_COMPLETE="\${COMP_WORDS[\${COMP_CWORD}]}"
  96
  97                 # We don't support ~ expansion: too tricky.
  98                 if [ "\${TO_COMPLETE:0:1}" != "~" ]; then
  99                         # Use ls so as to add the '/' at the end of directories.
 100                         RESULT=(\`ls -dp \${TO_COMPLETE}* 2> /dev/null\`)
 101                         echo \${RESULT[*]}
 102
 103                         # If there is a single completion and it is a directory,
 104                         # we output it a second time to trick tcsh into not adding a space
 105                         # after it.
 106                         if [ \${#RESULT[*]} -eq 1 ] && [ "\${RESULT[0]: -1}" == "/" ]; then
 107                                 echo \${RESULT[*]}
 108                         fi
 109                 fi
 110         fi
 111 fi
 112
 113 EOF
 114
 115 # Don't need this variable anymore, so don't pollute the users environment
 116 unset __git_tcsh_completion_original_script
 117
 118 complete git  'p,*,`bash ${__git_tcsh_completion_script} git "${COMMAND_LINE}"`,'
 119 complete gitk 'p,*,`bash ${__git_tcsh_completion_script} gitk "${COMMAND_LINE}"`,'