Merge branch 'fr_quickfix' of github.com:jnavila/git
[alt-git.git] / git-mergetool--lib.sh
blob9f99201bcca1eada84c3f19d1ca44cb41b3f3c59
1 # git-mergetool--lib is a shell library for common merge tool functions
3 : ${MERGE_TOOLS_DIR=$(git --exec-path)/mergetools}
5 IFS='
8 mode_ok () {
9 if diff_mode
10 then
11 can_diff
12 elif merge_mode
13 then
14 can_merge
15 else
16 false
20 is_available () {
21 merge_tool_path=$(translate_merge_tool_path "$1") &&
22 type "$merge_tool_path" >/dev/null 2>&1
25 list_config_tools () {
26 section=$1
27 line_prefix=${2:-}
29 git config --get-regexp $section'\..*\.cmd' |
30 while read -r key value
32 toolname=${key#$section.}
33 toolname=${toolname%.cmd}
35 printf "%s%s\n" "$line_prefix" "$toolname"
36 done
39 show_tool_names () {
40 condition=${1:-true} per_line_prefix=${2:-} preamble=${3:-}
41 not_found_msg=${4:-}
42 extra_content=${5:-}
44 shown_any=
45 ( cd "$MERGE_TOOLS_DIR" && ls ) | {
46 while read scriptname
48 setup_tool "$scriptname" 2>/dev/null
49 # We need an actual line feed here
50 variants="$variants
51 $(list_tool_variants)"
52 done
53 variants="$(echo "$variants" | sort -u)"
55 for toolname in $variants
57 if setup_tool "$toolname" 2>/dev/null &&
58 (eval "$condition" "$toolname")
59 then
60 if test -n "$preamble"
61 then
62 printf "%s\n" "$preamble"
63 preamble=
65 shown_any=yes
66 printf "%s%-15s %s\n" "$per_line_prefix" "$toolname" $(diff_mode && diff_cmd_help "$toolname" || merge_cmd_help "$toolname")
68 done
70 if test -n "$extra_content"
71 then
72 if test -n "$preamble"
73 then
74 # Note: no '\n' here since we don't want a
75 # blank line if there is no initial content.
76 printf "%s" "$preamble"
77 preamble=
79 shown_any=yes
80 printf "\n%s\n" "$extra_content"
83 if test -n "$preamble" && test -n "$not_found_msg"
84 then
85 printf "%s\n" "$not_found_msg"
88 test -n "$shown_any"
92 diff_mode () {
93 test "$TOOL_MODE" = diff
96 merge_mode () {
97 test "$TOOL_MODE" = merge
100 gui_mode () {
101 test "$GIT_MERGETOOL_GUI" = true
104 translate_merge_tool_path () {
105 echo "$1"
108 check_unchanged () {
109 if test "$MERGED" -nt "$BACKUP"
110 then
111 return 0
112 else
113 while true
115 echo "$MERGED seems unchanged."
116 printf "Was the merge successful [y/n]? "
117 read answer || return 1
118 case "$answer" in
119 y*|Y*) return 0 ;;
120 n*|N*) return 1 ;;
121 esac
122 done
126 valid_tool () {
127 setup_tool "$1" && return 0
128 cmd=$(get_merge_tool_cmd "$1")
129 test -n "$cmd"
132 setup_user_tool () {
133 merge_tool_cmd=$(get_merge_tool_cmd "$tool")
134 test -n "$merge_tool_cmd" || return 1
136 diff_cmd () {
137 ( eval $merge_tool_cmd )
140 merge_cmd () {
141 ( eval $merge_tool_cmd )
144 list_tool_variants () {
145 echo "$tool"
149 setup_tool () {
150 tool="$1"
152 # Fallback definitions, to be overridden by tools.
153 can_merge () {
154 return 0
157 can_diff () {
158 return 0
161 diff_cmd () {
162 return 1
165 diff_cmd_help () {
166 return 0
169 merge_cmd () {
170 return 1
173 merge_cmd_help () {
174 return 0
177 hide_resolved_enabled () {
178 return 0
181 translate_merge_tool_path () {
182 echo "$1"
185 list_tool_variants () {
186 echo "$tool"
189 # Most tools' exit codes cannot be trusted, so By default we ignore
190 # their exit code and check the merged file's modification time in
191 # check_unchanged() to determine whether or not the merge was
192 # successful. The return value from run_merge_cmd, by default, is
193 # determined by check_unchanged().
195 # When a tool's exit code can be trusted then the return value from
196 # run_merge_cmd is simply the tool's exit code, and check_unchanged()
197 # is not called.
199 # The return value of exit_code_trustable() tells us whether or not we
200 # can trust the tool's exit code.
202 # User-defined and built-in tools default to false.
203 # Built-in tools advertise that their exit code is trustable by
204 # redefining exit_code_trustable() to true.
206 exit_code_trustable () {
207 false
210 if test -f "$MERGE_TOOLS_DIR/$tool"
211 then
212 . "$MERGE_TOOLS_DIR/$tool"
213 elif test -f "$MERGE_TOOLS_DIR/${tool%[0-9]}"
214 then
215 . "$MERGE_TOOLS_DIR/${tool%[0-9]}"
216 else
217 setup_user_tool
218 return $?
221 # Now let the user override the default command for the tool. If
222 # they have not done so then this will return 1 which we ignore.
223 setup_user_tool
225 if ! list_tool_variants | grep -q "^$tool$"
226 then
227 return 1
230 if merge_mode && ! can_merge
231 then
232 echo "error: '$tool' can not be used to resolve merges" >&2
233 return 1
234 elif diff_mode && ! can_diff
235 then
236 echo "error: '$tool' can only be used to resolve merges" >&2
237 return 1
239 return 0
242 get_merge_tool_cmd () {
243 merge_tool="$1"
244 if diff_mode
245 then
246 git config "difftool.$merge_tool.cmd" ||
247 git config "mergetool.$merge_tool.cmd"
248 else
249 git config "mergetool.$merge_tool.cmd"
253 trust_exit_code () {
254 if git config --bool "mergetool.$1.trustExitCode"
255 then
256 :; # OK
257 elif exit_code_trustable
258 then
259 echo true
260 else
261 echo false
265 initialize_merge_tool () {
266 # Bring tool-specific functions into scope
267 setup_tool "$1" || return 1
270 # Entry point for running tools
271 run_merge_tool () {
272 # If GIT_PREFIX is empty then we cannot use it in tools
273 # that expect to be able to chdir() to its value.
274 GIT_PREFIX=${GIT_PREFIX:-.}
275 export GIT_PREFIX
277 merge_tool_path=$(get_merge_tool_path "$1") || exit
278 base_present="$2"
280 if merge_mode
281 then
282 run_merge_cmd "$1"
283 else
284 run_diff_cmd "$1"
288 # Run a either a configured or built-in diff tool
289 run_diff_cmd () {
290 diff_cmd "$1"
293 # Run a either a configured or built-in merge tool
294 run_merge_cmd () {
295 mergetool_trust_exit_code=$(trust_exit_code "$1")
296 if test "$mergetool_trust_exit_code" = "true"
297 then
298 merge_cmd "$1"
299 else
300 touch "$BACKUP"
301 merge_cmd "$1"
302 check_unchanged
306 list_merge_tool_candidates () {
307 if merge_mode
308 then
309 tools="tortoisemerge"
310 else
311 tools="kompare"
313 if test -n "$DISPLAY"
314 then
315 if test -n "$GNOME_DESKTOP_SESSION_ID"
316 then
317 tools="meld opendiff kdiff3 tkdiff xxdiff $tools"
318 else
319 tools="opendiff kdiff3 tkdiff xxdiff meld $tools"
321 tools="$tools gvimdiff diffuse diffmerge ecmerge"
322 tools="$tools p4merge araxis bc codecompare"
323 tools="$tools smerge"
325 case "${VISUAL:-$EDITOR}" in
326 *nvim*)
327 tools="$tools nvimdiff vimdiff emerge"
329 *vim*)
330 tools="$tools vimdiff nvimdiff emerge"
333 tools="$tools emerge vimdiff nvimdiff"
335 esac
338 show_tool_help () {
339 tool_opt="'git ${TOOL_MODE}tool --tool=<tool>'"
341 tab=' '
342 LF='
344 any_shown=no
346 cmd_name=${TOOL_MODE}tool
347 config_tools=$({
348 diff_mode && list_config_tools difftool "$tab$tab"
349 list_config_tools mergetool "$tab$tab"
350 } | sort)
351 extra_content=
352 if test -n "$config_tools"
353 then
354 extra_content="${tab}user-defined:${LF}$config_tools"
357 show_tool_names 'mode_ok && is_available' "$tab$tab" \
358 "$tool_opt may be set to one of the following:" \
359 "No suitable tool for 'git $cmd_name --tool=<tool>' found." \
360 "$extra_content" &&
361 any_shown=yes
363 show_tool_names 'mode_ok && ! is_available' "$tab$tab" \
364 "${LF}The following tools are valid, but not currently available:" &&
365 any_shown=yes
367 if test "$any_shown" = yes
368 then
369 echo
370 echo "Some of the tools listed above only work in a windowed"
371 echo "environment. If run in a terminal-only session, they will fail."
373 exit 0
376 guess_merge_tool () {
377 list_merge_tool_candidates
378 cat >&2 <<-EOF
380 This message is displayed because '$TOOL_MODE.tool' is not configured.
381 See 'git ${TOOL_MODE}tool --tool-help' or 'git help config' for more details.
382 'git ${TOOL_MODE}tool' will now attempt to use one of the following tools:
383 $tools
386 # Loop over each candidate and stop when a valid merge tool is found.
387 IFS=' '
388 for tool in $tools
390 is_available "$tool" && echo "$tool" && return 0
391 done
393 echo >&2 "No known ${TOOL_MODE} tool is available."
394 return 1
397 get_configured_merge_tool () {
398 keys=
399 if diff_mode
400 then
401 if gui_mode
402 then
403 keys="diff.guitool merge.guitool diff.tool merge.tool"
404 else
405 keys="diff.tool merge.tool"
407 else
408 if gui_mode
409 then
410 keys="merge.guitool merge.tool"
411 else
412 keys="merge.tool"
416 merge_tool=$(
417 IFS=' '
418 for key in $keys
420 selected=$(git config $key)
421 if test -n "$selected"
422 then
423 echo "$selected"
424 return
426 done)
428 if test -n "$merge_tool" && ! valid_tool "$merge_tool"
429 then
430 echo >&2 "git config option $TOOL_MODE.${gui_prefix}tool set to unknown tool: $merge_tool"
431 echo >&2 "Resetting to default..."
432 return 1
434 echo "$merge_tool"
437 get_merge_tool_path () {
438 # A merge tool has been set, so verify that it's valid.
439 merge_tool="$1"
440 if ! valid_tool "$merge_tool"
441 then
442 echo >&2 "Unknown merge tool $merge_tool"
443 exit 1
445 if diff_mode
446 then
447 merge_tool_path=$(git config difftool."$merge_tool".path ||
448 git config mergetool."$merge_tool".path)
449 else
450 merge_tool_path=$(git config mergetool."$merge_tool".path)
452 if test -z "$merge_tool_path"
453 then
454 merge_tool_path=$(translate_merge_tool_path "$merge_tool")
456 if test -z "$(get_merge_tool_cmd "$merge_tool")" &&
457 ! type "$merge_tool_path" >/dev/null 2>&1
458 then
459 echo >&2 "The $TOOL_MODE tool $merge_tool is not available as"\
460 "'$merge_tool_path'"
461 exit 1
463 echo "$merge_tool_path"
466 get_merge_tool () {
467 is_guessed=false
468 # Check if a merge tool has been configured
469 merge_tool=$(get_configured_merge_tool)
470 # Try to guess an appropriate merge tool if no tool has been set.
471 if test -z "$merge_tool"
472 then
473 merge_tool=$(guess_merge_tool) || exit
474 is_guessed=true
476 echo "$merge_tool"
477 test "$is_guessed" = false
480 mergetool_find_win32_cmd () {
481 executable=$1
482 sub_directory=$2
484 # Use $executable if it exists in $PATH
485 if type -p "$executable" >/dev/null 2>&1
486 then
487 printf '%s' "$executable"
488 return
491 # Look for executable in the typical locations
492 for directory in $(env | grep -Ei '^PROGRAM(FILES(\(X86\))?|W6432)=' |
493 cut -d '=' -f 2- | sort -u)
495 if test -n "$directory" && test -x "$directory/$sub_directory/$executable"
496 then
497 printf '%s' "$directory/$sub_directory/$executable"
498 return
500 done
502 printf '%s' "$executable"