Andrew's git / gitweb.git / git-mergetool--lib.sh
?
git-mergetool--lib.shon commit git-difftool: use git-mergetool--lib for "--tool-help" (abaf175)
   1#!/bin/sh
   2# git-mergetool--lib is a library for common merge tool functions
   3diff_mode() {
   4        test "$TOOL_MODE" = diff
   5}
   6
   7merge_mode() {
   8        test "$TOOL_MODE" = merge
   9}
  10
  11translate_merge_tool_path () {
  12        echo "$1"
  13}
  14
  15check_unchanged () {
  16        if test "$MERGED" -nt "$BACKUP"
  17        then
  18                status=0
  19        else
  20                while true
  21                do
  22                        echo "$MERGED seems unchanged."
  23                        printf "Was the merge successful? [y/n] "
  24                        read answer || return 1
  25                        case "$answer" in
  26                        y*|Y*) status=0; break ;;
  27                        n*|N*) status=1; break ;;
  28                        esac
  29                done
  30        fi
  31}
  32
  33valid_tool_config () {
  34        if test -n "$(get_merge_tool_cmd "$1")"
  35        then
  36                return 0
  37        else
  38                return 1
  39        fi
  40}
  41
  42valid_tool () {
  43        setup_tool "$1" || valid_tool_config "$1"
  44}
  45
  46setup_tool () {
  47        case "$1" in
  48        vim*|gvim*)
  49                tool=vim
  50                ;;
  51        *)
  52                tool="$1"
  53                ;;
  54        esac
  55        mergetools="$(git --exec-path)/mergetools"
  56
  57        # Load the default definitions
  58        . "$mergetools/defaults"
  59        if ! test -f "$mergetools/$tool"
  60        then
  61                return 1
  62        fi
  63
  64        # Load the redefined functions
  65        . "$mergetools/$tool"
  66
  67        if merge_mode && ! can_merge
  68        then
  69                echo "error: '$tool' can not be used to resolve merges" >&2
  70                exit 1
  71        elif diff_mode && ! can_diff
  72        then
  73                echo "error: '$tool' can only be used to resolve merges" >&2
  74                exit 1
  75        fi
  76        return 0
  77}
  78
  79get_merge_tool_cmd () {
  80        # Prints the custom command for a merge tool
  81        merge_tool="$1"
  82        if diff_mode
  83        then
  84                echo "$(git config difftool.$merge_tool.cmd ||
  85                        git config mergetool.$merge_tool.cmd)"
  86        else
  87                echo "$(git config mergetool.$merge_tool.cmd)"
  88        fi
  89}
  90
  91# Entry point for running tools
  92run_merge_tool () {
  93        # If GIT_PREFIX is empty then we cannot use it in tools
  94        # that expect to be able to chdir() to its value.
  95        GIT_PREFIX=${GIT_PREFIX:-.}
  96        export GIT_PREFIX
  97
  98        merge_tool_path="$(get_merge_tool_path "$1")" || exit
  99        base_present="$2"
 100        status=0
 101
 102        # Bring tool-specific functions into scope
 103        setup_tool "$1"
 104
 105        if merge_mode
 106        then
 107                run_merge_cmd "$1"
 108        else
 109                run_diff_cmd "$1"
 110        fi
 111        return $status
 112}
 113
 114# Run a either a configured or built-in diff tool
 115run_diff_cmd () {
 116        merge_tool_cmd="$(get_merge_tool_cmd "$1")"
 117        if test -n "$merge_tool_cmd"
 118        then
 119                ( eval $merge_tool_cmd )
 120                status=$?
 121                return $status
 122        else
 123                diff_cmd "$1"
 124        fi
 125}
 126
 127# Run a either a configured or built-in merge tool
 128run_merge_cmd () {
 129        merge_tool_cmd="$(get_merge_tool_cmd "$1")"
 130        if test -n "$merge_tool_cmd"
 131        then
 132                trust_exit_code="$(git config --bool \
 133                        mergetool."$1".trustExitCode || echo false)"
 134                if test "$trust_exit_code" = "false"
 135                then
 136                        touch "$BACKUP"
 137                        ( eval $merge_tool_cmd )
 138                        status=$?
 139                        check_unchanged
 140                else
 141                        ( eval $merge_tool_cmd )
 142                        status=$?
 143                fi
 144                return $status
 145        else
 146                merge_cmd "$1"
 147        fi
 148}
 149
 150list_merge_tool_candidates () {
 151        if merge_mode
 152        then
 153                tools="tortoisemerge"
 154        else
 155                tools="kompare"
 156        fi
 157        if test -n "$DISPLAY"
 158        then
 159                if test -n "$GNOME_DESKTOP_SESSION_ID"
 160                then
 161                        tools="meld opendiff kdiff3 tkdiff xxdiff $tools"
 162                else
 163                        tools="opendiff kdiff3 tkdiff xxdiff meld $tools"
 164                fi
 165                tools="$tools gvimdiff diffuse ecmerge p4merge araxis bc3 codecompare"
 166        fi
 167        case "${VISUAL:-$EDITOR}" in
 168        *vim*)
 169                tools="$tools vimdiff emerge"
 170                ;;
 171        *)
 172                tools="$tools emerge vimdiff"
 173                ;;
 174        esac
 175}
 176
 177show_tool_help () {
 178        list_merge_tool_candidates
 179        unavailable= available= LF='
 180'
 181        for i in $tools
 182        do
 183                merge_tool_path=$(translate_merge_tool_path "$i")
 184                if type "$merge_tool_path" >/dev/null 2>&1
 185                then
 186                        available="$available$i$LF"
 187                else
 188                        unavailable="$unavailable$i$LF"
 189                fi
 190        done
 191
 192        cmd_name=${TOOL_MODE}tool
 193        if test -n "$available"
 194        then
 195                echo "'git $cmd_name --tool=<tool>' may be set to one of the following:"
 196                echo "$available" | sort | sed -e 's/^/ /'
 197        else
 198                echo "No suitable tool for 'git $cmd_name --tool=<tool>' found."
 199        fi
 200        if test -n "$unavailable"
 201        then
 202                echo
 203                echo 'The following tools are valid, but not currently available:'
 204                echo "$unavailable" | sort | sed -e 's/^/       /'
 205        fi
 206        if test -n "$unavailable$available"
 207        then
 208                echo
 209                echo "Some of the tools listed above only work in a windowed"
 210                echo "environment. If run in a terminal-only session, they will fail."
 211        fi
 212        exit 0
 213}
 214
 215guess_merge_tool () {
 216        list_merge_tool_candidates
 217        echo >&2 "merge tool candidates: $tools"
 218
 219        # Loop over each candidate and stop when a valid merge tool is found.
 220        for i in $tools
 221        do
 222                merge_tool_path="$(translate_merge_tool_path "$i")"
 223                if type "$merge_tool_path" >/dev/null 2>&1
 224                then
 225                        echo "$i"
 226                        return 0
 227                fi
 228        done
 229
 230        echo >&2 "No known merge resolution program available."
 231        return 1
 232}
 233
 234get_configured_merge_tool () {
 235        # Diff mode first tries diff.tool and falls back to merge.tool.
 236        # Merge mode only checks merge.tool
 237        if diff_mode
 238        then
 239                merge_tool=$(git config diff.tool || git config merge.tool)
 240        else
 241                merge_tool=$(git config merge.tool)
 242        fi
 243        if test -n "$merge_tool" && ! valid_tool "$merge_tool"
 244        then
 245                echo >&2 "git config option $TOOL_MODE.tool set to unknown tool: $merge_tool"
 246                echo >&2 "Resetting to default..."
 247                return 1
 248        fi
 249        echo "$merge_tool"
 250}
 251
 252get_merge_tool_path () {
 253        # A merge tool has been set, so verify that it's valid.
 254        merge_tool="$1"
 255        if ! valid_tool "$merge_tool"
 256        then
 257                echo >&2 "Unknown merge tool $merge_tool"
 258                exit 1
 259        fi
 260        if diff_mode
 261        then
 262                merge_tool_path=$(git config difftool."$merge_tool".path ||
 263                                  git config mergetool."$merge_tool".path)
 264        else
 265                merge_tool_path=$(git config mergetool."$merge_tool".path)
 266        fi
 267        if test -z "$merge_tool_path"
 268        then
 269                merge_tool_path="$(translate_merge_tool_path "$merge_tool")"
 270        fi
 271        if test -z "$(get_merge_tool_cmd "$merge_tool")" &&
 272                ! type "$merge_tool_path" >/dev/null 2>&1
 273        then
 274                echo >&2 "The $TOOL_MODE tool $merge_tool is not available as"\
 275                         "'$merge_tool_path'"
 276                exit 1
 277        fi
 278        echo "$merge_tool_path"
 279}
 280
 281get_merge_tool () {
 282        # Check if a merge tool has been configured
 283        merge_tool="$(get_configured_merge_tool)"
 284        # Try to guess an appropriate merge tool if no tool has been set.
 285        if test -z "$merge_tool"
 286        then
 287                merge_tool="$(guess_merge_tool)" || exit
 288        fi
 289        echo "$merge_tool"
 290}