Merge branch 'esr/maint-doc-fast-import'
[git.git] / git-mergetool--lib.sh
blobf013a0350665e8c11b52853b5794631dcf7694d0
1 #!/bin/sh
2 # git-mergetool--lib is a library for common merge tool functions
3 diff_mode() {
4 test "$TOOL_MODE" = diff
7 merge_mode() {
8 test "$TOOL_MODE" = merge
11 translate_merge_tool_path () {
12 echo "$1"
15 check_unchanged () {
16 if test "$MERGED" -nt "$BACKUP"
17 then
18 status=0
19 else
20 while true
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
33 valid_tool_config () {
34 if test -n "$(get_merge_tool_cmd "$1")"
35 then
36 return 0
37 else
38 return 1
42 valid_tool () {
43 setup_tool "$1" || valid_tool_config "$1"
46 setup_tool () {
47 case "$1" in
48 vim*|gvim*)
49 tool=vim
52 tool="$1"
54 esac
55 mergetools="$(git --exec-path)/mergetools"
57 # Load the default definitions
58 . "$mergetools/defaults"
59 if ! test -f "$mergetools/$tool"
60 then
61 return 1
64 # Load the redefined functions
65 . "$mergetools/$tool"
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
76 return 0
79 get_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)"
91 # Entry point for running tools
92 run_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
98 merge_tool_path="$(get_merge_tool_path "$1")" || exit
99 base_present="$2"
100 status=0
102 # Bring tool-specific functions into scope
103 setup_tool "$1"
105 if merge_mode
106 then
107 run_merge_cmd "$1"
108 else
109 run_diff_cmd "$1"
111 return $status
114 # Run a either a configured or built-in diff tool
115 run_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"
127 # Run a either a configured or built-in merge tool
128 run_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=$?
144 return $status
145 else
146 merge_cmd "$1"
150 list_merge_tool_candidates () {
151 if merge_mode
152 then
153 tools="tortoisemerge"
154 else
155 tools="kompare"
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"
165 tools="$tools gvimdiff diffuse ecmerge p4merge araxis bc3 codecompare"
167 case "${VISUAL:-$EDITOR}" in
168 *vim*)
169 tools="$tools vimdiff emerge"
172 tools="$tools emerge vimdiff"
174 esac
177 guess_merge_tool () {
178 list_merge_tool_candidates
179 echo >&2 "merge tool candidates: $tools"
181 # Loop over each candidate and stop when a valid merge tool is found.
182 for i in $tools
184 merge_tool_path="$(translate_merge_tool_path "$i")"
185 if type "$merge_tool_path" >/dev/null 2>&1
186 then
187 echo "$i"
188 return 0
190 done
192 echo >&2 "No known merge resolution program available."
193 return 1
196 get_configured_merge_tool () {
197 # Diff mode first tries diff.tool and falls back to merge.tool.
198 # Merge mode only checks merge.tool
199 if diff_mode
200 then
201 merge_tool=$(git config diff.tool || git config merge.tool)
202 else
203 merge_tool=$(git config merge.tool)
205 if test -n "$merge_tool" && ! valid_tool "$merge_tool"
206 then
207 echo >&2 "git config option $TOOL_MODE.tool set to unknown tool: $merge_tool"
208 echo >&2 "Resetting to default..."
209 return 1
211 echo "$merge_tool"
214 get_merge_tool_path () {
215 # A merge tool has been set, so verify that it's valid.
216 merge_tool="$1"
217 if ! valid_tool "$merge_tool"
218 then
219 echo >&2 "Unknown merge tool $merge_tool"
220 exit 1
222 if diff_mode
223 then
224 merge_tool_path=$(git config difftool."$merge_tool".path ||
225 git config mergetool."$merge_tool".path)
226 else
227 merge_tool_path=$(git config mergetool."$merge_tool".path)
229 if test -z "$merge_tool_path"
230 then
231 merge_tool_path="$(translate_merge_tool_path "$merge_tool")"
233 if test -z "$(get_merge_tool_cmd "$merge_tool")" &&
234 ! type "$merge_tool_path" >/dev/null 2>&1
235 then
236 echo >&2 "The $TOOL_MODE tool $merge_tool is not available as"\
237 "'$merge_tool_path'"
238 exit 1
240 echo "$merge_tool_path"
243 get_merge_tool () {
244 # Check if a merge tool has been configured
245 merge_tool="$(get_configured_merge_tool)"
246 # Try to guess an appropriate merge tool if no tool has been set.
247 if test -z "$merge_tool"
248 then
249 merge_tool="$(guess_merge_tool)" || exit
251 echo "$merge_tool"