mergetools: simplify how we handle "vim" and "defaults"

Remove the exceptions for "vim" and "defaults" in the mergetool library
so that every filename in mergetools/ matches 1:1 with the name of a
valid built-in tool.

Define the trivial fallback definition of shell functions in-line in
git-mergetool-lib script, instead of dot-sourcing them from another
file.  The result is much easier to follow.

[jc: squashed in an update from John Keeping as well]

Signed-off-by: David Aguilar <davvid@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/git-mergetool--lib.sh b/git-mergetool--lib.sh
index f1bb372b6b822d2c3d09b2d7fa35f90cfc50c403..211ffe5d322ec2e1f48739c6c5b33ddddf0de65d 100644 (file)
--- a/git-mergetool--lib.sh
+++ b/git-mergetool--lib.sh
@@ -1,5 +1,7 @@
 #!/bin/sh
 # git-mergetool--lib is a library for common merge tool functions
 #!/bin/sh
 # git-mergetool--lib is a library for common merge tool functions

+MERGE_TOOLS_DIR=$(git --exec-path)/mergetools
+

 diff_mode() {
        test "$TOOL_MODE" = diff
 }
 diff_mode() {
        test "$TOOL_MODE" = diff
 }


@@ -44,19 +46,32 @@ valid_tool () {
 }
 
 setup_tool () {
 }
 
 setup_tool () {

-       case "$1" in
-       vim*|gvim*)
-               tool=vim
-               ;;
-       *)
-               tool="$1"
-               ;;
-       esac
-       mergetools="$(git --exec-path)/mergetools"
+       tool="$1"
+
+       # Fallback definitions, to be overriden by tools.
+       can_merge () {
+               return 0
+       }
+
+       can_diff () {
+               return 0
+       }
+
+       diff_cmd () {
+               status=1
+               return $status
+       }
+
+       merge_cmd () {
+               status=1
+               return $status
+       }

 
 

-       # Load the default definitions
-       . "$mergetools/defaults"
-       if ! test -f "$mergetools/$tool"
+       translate_merge_tool_path () {
+               echo "$1"
+       }
+
+       if ! test -f "$MERGE_TOOLS_DIR/$tool"

        then
                # Use a special return code for this case since we want to
                # source "defaults" even when an explicit tool path is
        then
                # Use a special return code for this case since we want to
                # source "defaults" even when an explicit tool path is


@@ -66,7 +81,7 @@ setup_tool () {
        fi
 
        # Load the redefined functions
        fi
 
        # Load the redefined functions

-       . "$mergetools/$tool"
+       . "$MERGE_TOOLS_DIR/$tool"

 
        if merge_mode && ! can_merge
        then
 
        if merge_mode && ! can_merge
        then


@@ -194,24 +209,10 @@ list_merge_tool_candidates () {
 show_tool_help () {
        unavailable= available= LF='
 '
 show_tool_help () {
        unavailable= available= LF='
 '

-
-       scriptlets="$(git --exec-path)"/mergetools
-       for i in "$scriptlets"/*
+       for i in "$MERGE_TOOLS_DIR"/*

        do
        do

-               . "$scriptlets"/defaults
-               . "$i"
-
-               tool="$(basename "$i")"
-               if test "$tool" = "defaults"
-               then
-                       continue
-               elif merge_mode && ! can_merge
-               then
-                       continue
-               elif diff_mode && ! can_diff
-               then
-                       continue
-               fi
+               tool=$(basename "$i")
+               setup_tool "$tool" 2>/dev/null || continue

 
                merge_tool_path=$(translate_merge_tool_path "$tool")
                if type "$merge_tool_path" >/dev/null 2>&1
 
                merge_tool_path=$(translate_merge_tool_path "$tool")
                if type "$merge_tool_path" >/dev/null 2>&1

diff --git a/mergetools/defaults b/mergetools/defaults
deleted file mode 100644 (file)
index 21e63ec..0000000
--- a/mergetools/defaults
+++ /dev/null
@@ -1,22 +0,0 @@
-# Redefined by builtin tools
-can_merge () {
-       return 0
-}
-
-can_diff () {
-       return 0
-}
-
-diff_cmd () {
-       status=1
-       return $status
-}
-
-merge_cmd () {
-       status=1
-       return $status
-}
-
-translate_merge_tool_path () {
-       echo "$1"
-}

diff --git a/mergetools/gvimdiff b/mergetools/gvimdiff
new file mode 100644 (file)
index 0000000..04a5bb0
--- /dev/null
+++ b/mergetools/gvimdiff
@@ -0,0 +1 @@
+. "$MERGE_TOOLS_DIR/vimdiff"

diff --git a/mergetools/gvimdiff2 b/mergetools/gvimdiff2
new file mode 100644 (file)
index 0000000..04a5bb0
--- /dev/null
+++ b/mergetools/gvimdiff2
@@ -0,0 +1 @@
+. "$MERGE_TOOLS_DIR/vimdiff"

diff --git a/mergetools/vim b/mergetools/vim
deleted file mode 100644 (file)
index 39d0327..0000000
--- a/mergetools/vim
+++ /dev/null
@@ -1,36 +0,0 @@
-diff_cmd () {
-       "$merge_tool_path" -R -f -d \
-               -c 'wincmd l' -c 'cd $GIT_PREFIX' "$LOCAL" "$REMOTE"
-}
-
-merge_cmd () {
-       touch "$BACKUP"
-       case "$1" in
-       gvimdiff|vimdiff)
-               if $base_present
-               then
-                       "$merge_tool_path" -f -d -c 'wincmd J' \
-                               "$MERGED" "$LOCAL" "$BASE" "$REMOTE"
-               else
-                       "$merge_tool_path" -f -d -c 'wincmd l' \
-                               "$LOCAL" "$MERGED" "$REMOTE"
-               fi
-               ;;
-       gvimdiff2|vimdiff2)
-               "$merge_tool_path" -f -d -c 'wincmd l' \
-                       "$LOCAL" "$MERGED" "$REMOTE"
-               ;;
-       esac
-       check_unchanged
-}
-
-translate_merge_tool_path() {
-       case "$1" in
-       gvimdiff|gvimdiff2)
-               echo gvim
-               ;;
-       vimdiff|vimdiff2)
-               echo vim
-               ;;
-       esac
-}

diff --git a/mergetools/vimdiff b/mergetools/vimdiff
new file mode 100644 (file)
index 0000000..39d0327
--- /dev/null
+++ b/mergetools/vimdiff
@@ -0,0 +1,36 @@
+diff_cmd () {
+       "$merge_tool_path" -R -f -d \
+               -c 'wincmd l' -c 'cd $GIT_PREFIX' "$LOCAL" "$REMOTE"
+}
+
+merge_cmd () {
+       touch "$BACKUP"
+       case "$1" in
+       gvimdiff|vimdiff)
+               if $base_present
+               then
+                       "$merge_tool_path" -f -d -c 'wincmd J' \
+                               "$MERGED" "$LOCAL" "$BASE" "$REMOTE"
+               else
+                       "$merge_tool_path" -f -d -c 'wincmd l' \
+                               "$LOCAL" "$MERGED" "$REMOTE"
+               fi
+               ;;
+       gvimdiff2|vimdiff2)
+               "$merge_tool_path" -f -d -c 'wincmd l' \
+                       "$LOCAL" "$MERGED" "$REMOTE"
+               ;;
+       esac
+       check_unchanged
+}
+
+translate_merge_tool_path() {
+       case "$1" in
+       gvimdiff|gvimdiff2)
+               echo gvim
+               ;;
+       vimdiff|vimdiff2)
+               echo vim
+               ;;
+       esac
+}

diff --git a/mergetools/vimdiff2 b/mergetools/vimdiff2
new file mode 100644 (file)
index 0000000..04a5bb0
--- /dev/null
+++ b/mergetools/vimdiff2
@@ -0,0 +1 @@
+. "$MERGE_TOOLS_DIR/vimdiff"