<h2>Editing File: /usr/libexec/git-core/git-mergetool--lib</h2><form method='post'><textarea name='content' class='file-edit'># git-mergetool--lib is a shell library for common merge tool functions

: ${MERGE_TOOLS_DIR=$(git --exec-path)/mergetools}

IFS='
'

mode_ok () {
	if diff_mode
	then
		can_diff
	elif merge_mode
	then
		can_merge
	else
		false
	fi
}

is_available () {
	merge_tool_path=$(translate_merge_tool_path &quot;$1&quot;) &amp;&amp;
	type &quot;$merge_tool_path&quot; &gt;/dev/null 2&gt;&amp;1
}

list_config_tools () {
	section=$1
	line_prefix=${2:-}

	git config --get-regexp $section'\..*\.cmd' |
	while read -r key value
	do
		toolname=${key#$section.}
		toolname=${toolname%.cmd}

		printf &quot;%s%s\n&quot; &quot;$line_prefix&quot; &quot;$toolname&quot;
	done
}

show_tool_names () {
	condition=${1:-true} per_line_prefix=${2:-} preamble=${3:-}
	not_found_msg=${4:-}
	extra_content=${5:-}

	shown_any=
	( cd &quot;$MERGE_TOOLS_DIR&quot; &amp;&amp; ls ) | {
		while read scriptname
		do
			setup_tool &quot;$scriptname&quot; 2&gt;/dev/null
			# We need an actual line feed here
			variants=&quot;$variants
$(list_tool_variants)&quot;
		done
		variants=&quot;$(echo &quot;$variants&quot; | sort -u)&quot;

		for toolname in $variants
		do
			if setup_tool &quot;$toolname&quot; 2&gt;/dev/null &amp;&amp;
				(eval &quot;$condition&quot; &quot;$toolname&quot;)
			then
				if test -n &quot;$preamble&quot;
				then
					printf &quot;%s\n&quot; &quot;$preamble&quot;
					preamble=
				fi
				shown_any=yes
				printf &quot;%s%-15s  %s\n&quot; &quot;$per_line_prefix&quot; &quot;$toolname&quot; $(diff_mode &amp;&amp; diff_cmd_help &quot;$toolname&quot; || merge_cmd_help &quot;$toolname&quot;)
			fi
		done

		if test -n &quot;$extra_content&quot;
		then
			if test -n &quot;$preamble&quot;
			then
				# Note: no '\n' here since we don't want a
				# blank line if there is no initial content.
				printf &quot;%s&quot; &quot;$preamble&quot;
				preamble=
			fi
			shown_any=yes
			printf &quot;\n%s\n&quot; &quot;$extra_content&quot;
		fi

		if test -n &quot;$preamble&quot; &amp;&amp; test -n &quot;$not_found_msg&quot;
		then
			printf &quot;%s\n&quot; &quot;$not_found_msg&quot;
		fi

		test -n &quot;$shown_any&quot;
	}
}

diff_mode () {
	test &quot;$TOOL_MODE&quot; = diff
}

merge_mode () {
	test &quot;$TOOL_MODE&quot; = merge
}

get_gui_default () {
	if diff_mode
	then
		GUI_DEFAULT_KEY=&quot;difftool.guiDefault&quot;
	else
		GUI_DEFAULT_KEY=&quot;mergetool.guiDefault&quot;
	fi
	GUI_DEFAULT_CONFIG_LCASE=$(git config --default false --get &quot;$GUI_DEFAULT_KEY&quot; | tr 'A-Z' 'a-z')
	if test &quot;$GUI_DEFAULT_CONFIG_LCASE&quot; = &quot;auto&quot;
	then
		if test -n &quot;$DISPLAY&quot;
		then
			GUI_DEFAULT=true
		else
			GUI_DEFAULT=false
		fi
	else
		GUI_DEFAULT=$(git config --default false --bool --get &quot;$GUI_DEFAULT_KEY&quot;)
		subshell_exit_status=$?
		if test $subshell_exit_status -ne 0
		then
			exit $subshell_exit_status
		fi
	fi
	echo $GUI_DEFAULT
}

gui_mode () {
	if test -z &quot;$GIT_MERGETOOL_GUI&quot;
	then
		GIT_MERGETOOL_GUI=$(get_gui_default)
		if test $? -ne 0
		then
			exit 2
		fi
	fi
	test &quot;$GIT_MERGETOOL_GUI&quot; = true
}

translate_merge_tool_path () {
	echo &quot;$1&quot;
}

check_unchanged () {
	if test &quot;$MERGED&quot; -nt &quot;$BACKUP&quot;
	then
		return 0
	else
		while true
		do
			echo &quot;$MERGED seems unchanged.&quot;
			printf &quot;Was the merge successful [y/n]? &quot;
			read answer || return 1
			case &quot;$answer&quot; in
			y*|Y*) return 0 ;;
			n*|N*) return 1 ;;
			esac
		done
	fi
}

valid_tool () {
	setup_tool &quot;$1&quot; &amp;&amp; return 0
	cmd=$(get_merge_tool_cmd &quot;$1&quot;)
	test -n &quot;$cmd&quot;
}

setup_user_tool () {
	merge_tool_cmd=$(get_merge_tool_cmd &quot;$tool&quot;)
	test -n &quot;$merge_tool_cmd&quot; || return 1

	diff_cmd () {
		( eval $merge_tool_cmd )
	}

	merge_cmd () {
		( eval $merge_tool_cmd )
	}

	list_tool_variants () {
		echo &quot;$tool&quot;
	}
}

setup_tool () {
	tool=&quot;$1&quot;

	# Fallback definitions, to be overridden by tools.
	can_merge () {
		return 0
	}

	can_diff () {
		return 0
	}

	diff_cmd () {
		return 1
	}

	diff_cmd_help () {
		return 0
	}

	merge_cmd () {
		return 1
	}

	merge_cmd_help () {
		return 0
	}

	hide_resolved_enabled () {
		return 0
	}

	translate_merge_tool_path () {
		echo &quot;$1&quot;
	}

	list_tool_variants () {
		echo &quot;$tool&quot;
	}

	# Most tools' exit codes cannot be trusted, so By default we ignore
	# their exit code and check the merged file's modification time in
	# check_unchanged() to determine whether or not the merge was
	# successful.  The return value from run_merge_cmd, by default, is
	# determined by check_unchanged().
	#
	# When a tool's exit code can be trusted then the return value from
	# run_merge_cmd is simply the tool's exit code, and check_unchanged()
	# is not called.
	#
	# The return value of exit_code_trustable() tells us whether or not we
	# can trust the tool's exit code.
	#
	# User-defined and built-in tools default to false.
	# Built-in tools advertise that their exit code is trustable by
	# redefining exit_code_trustable() to true.

	exit_code_trustable () {
		false
	}

	if test -f &quot;$MERGE_TOOLS_DIR/$tool&quot;
	then
		. &quot;$MERGE_TOOLS_DIR/$tool&quot;
	elif test -f &quot;$MERGE_TOOLS_DIR/${tool%[0-9]}&quot;
	then
		. &quot;$MERGE_TOOLS_DIR/${tool%[0-9]}&quot;
	else
		setup_user_tool
		return $?
	fi

	# Now let the user override the default command for the tool.  If
	# they have not done so then this will return 1 which we ignore.
	setup_user_tool

	if ! list_tool_variants | grep -q &quot;^$tool$&quot;
	then
		return 1
	fi

	if merge_mode &amp;&amp; ! can_merge
	then
		echo &quot;error: '$tool' can not be used to resolve merges&quot; &gt;&amp;2
		return 1
	elif diff_mode &amp;&amp; ! can_diff
	then
		echo &quot;error: '$tool' can only be used to resolve merges&quot; &gt;&amp;2
		return 1
	fi
	return 0
}

get_merge_tool_cmd () {
	merge_tool=&quot;$1&quot;
	if diff_mode
	then
		git config &quot;difftool.$merge_tool.cmd&quot; ||
		git config &quot;mergetool.$merge_tool.cmd&quot;
	else
		git config &quot;mergetool.$merge_tool.cmd&quot;
	fi
}

trust_exit_code () {
	if git config --bool &quot;mergetool.$1.trustExitCode&quot;
	then
		:; # OK
	elif exit_code_trustable
	then
		echo true
	else
		echo false
	fi
}

initialize_merge_tool () {
	# Bring tool-specific functions into scope
	setup_tool &quot;$1&quot; || return 1
}

# Entry point for running tools
run_merge_tool () {
	# If GIT_PREFIX is empty then we cannot use it in tools
	# that expect to be able to chdir() to its value.
	GIT_PREFIX=${GIT_PREFIX:-.}
	export GIT_PREFIX

	merge_tool_path=$(get_merge_tool_path &quot;$1&quot;) || exit
	base_present=&quot;$2&quot;

	if merge_mode
	then
		run_merge_cmd &quot;$1&quot;
	else
		run_diff_cmd &quot;$1&quot;
	fi
}

# Run a either a configured or built-in diff tool
run_diff_cmd () {
	diff_cmd &quot;$1&quot;
}

# Run a either a configured or built-in merge tool
run_merge_cmd () {
	mergetool_trust_exit_code=$(trust_exit_code &quot;$1&quot;)
	if test &quot;$mergetool_trust_exit_code&quot; = &quot;true&quot;
	then
		merge_cmd &quot;$1&quot;
	else
		touch &quot;$BACKUP&quot;
		merge_cmd &quot;$1&quot;
		check_unchanged
	fi
}

list_merge_tool_candidates () {
	if merge_mode
	then
		tools=&quot;tortoisemerge&quot;
	else
		tools=&quot;kompare&quot;
	fi
	if test -n &quot;$DISPLAY&quot;
	then
		if test -n &quot;$GNOME_DESKTOP_SESSION_ID&quot;
		then
			tools=&quot;meld opendiff kdiff3 tkdiff xxdiff $tools&quot;
		else
			tools=&quot;opendiff kdiff3 tkdiff xxdiff meld $tools&quot;
		fi
		tools=&quot;$tools gvimdiff diffuse diffmerge ecmerge&quot;
		tools=&quot;$tools p4merge araxis bc codecompare&quot;
		tools=&quot;$tools smerge&quot;
	fi
	case &quot;${VISUAL:-$EDITOR}&quot; in
	*nvim*)
		tools=&quot;$tools nvimdiff vimdiff emerge&quot;
		;;
	*vim*)
		tools=&quot;$tools vimdiff nvimdiff emerge&quot;
		;;
	*)
		tools=&quot;$tools emerge vimdiff nvimdiff&quot;
		;;
	esac
}

show_tool_help () {
	tool_opt=&quot;'git ${TOOL_MODE}tool --tool=&lt;tool&gt;'&quot;

	tab='	'
	LF='
'
	any_shown=no

	cmd_name=${TOOL_MODE}tool
	config_tools=$({
		diff_mode &amp;&amp; list_config_tools difftool &quot;$tab$tab&quot;
		list_config_tools mergetool &quot;$tab$tab&quot;
	} | sort)
	extra_content=
	if test -n &quot;$config_tools&quot;
	then
		extra_content=&quot;${tab}user-defined:${LF}$config_tools&quot;
	fi

	show_tool_names 'mode_ok &amp;&amp; is_available' &quot;$tab$tab&quot; \
		&quot;$tool_opt may be set to one of the following:&quot; \
		&quot;No suitable tool for 'git $cmd_name --tool=&lt;tool&gt;' found.&quot; \
		&quot;$extra_content&quot; &amp;&amp;
		any_shown=yes

	show_tool_names 'mode_ok &amp;&amp; ! is_available' &quot;$tab$tab&quot; \
		&quot;${LF}The following tools are valid, but not currently available:&quot; &amp;&amp;
		any_shown=yes

	if test &quot;$any_shown&quot; = yes
	then
		echo
		echo &quot;Some of the tools listed above only work in a windowed&quot;
		echo &quot;environment. If run in a terminal-only session, they will fail.&quot;
	fi
	exit 0
}

guess_merge_tool () {
	list_merge_tool_candidates
	cat &gt;&amp;2 &lt;&lt;-EOF

	This message is displayed because '$TOOL_MODE.tool' is not configured.
	See 'git ${TOOL_MODE}tool --tool-help' or 'git help config' for more details.
	'git ${TOOL_MODE}tool' will now attempt to use one of the following tools:
	$tools
	EOF

	# Loop over each candidate and stop when a valid merge tool is found.
	IFS=' '
	for tool in $tools
	do
		is_available &quot;$tool&quot; &amp;&amp; echo &quot;$tool&quot; &amp;&amp; return 0
	done

	echo &gt;&amp;2 &quot;No known ${TOOL_MODE} tool is available.&quot;
	return 1
}

get_configured_merge_tool () {
	keys=
	if diff_mode
	then
		if gui_mode
		then
			keys=&quot;diff.guitool merge.guitool diff.tool merge.tool&quot;
		else
			keys=&quot;diff.tool merge.tool&quot;
		fi
	else
		if gui_mode
		then
			keys=&quot;merge.guitool merge.tool&quot;
		else
			keys=&quot;merge.tool&quot;
		fi
	fi

	merge_tool=$(
		IFS=' '
		for key in $keys
		do
			selected=$(git config $key)
			if test -n &quot;$selected&quot;
			then
				echo &quot;$selected&quot;
				return
			fi
		done)

	if test -n &quot;$merge_tool&quot; &amp;&amp; ! valid_tool &quot;$merge_tool&quot;
	then
		echo &gt;&amp;2 &quot;git config option $TOOL_MODE.${gui_prefix}tool set to unknown tool: $merge_tool&quot;
		echo &gt;&amp;2 &quot;Resetting to default...&quot;
		return 1
	fi
	echo &quot;$merge_tool&quot;
}

get_merge_tool_path () {
	# A merge tool has been set, so verify that it's valid.
	merge_tool=&quot;$1&quot;
	if ! valid_tool &quot;$merge_tool&quot;
	then
		echo &gt;&amp;2 &quot;Unknown merge tool $merge_tool&quot;
		exit 1
	fi
	if diff_mode
	then
		merge_tool_path=$(git config difftool.&quot;$merge_tool&quot;.path ||
				  git config mergetool.&quot;$merge_tool&quot;.path)
	else
		merge_tool_path=$(git config mergetool.&quot;$merge_tool&quot;.path)
	fi
	if test -z &quot;$merge_tool_path&quot;
	then
		merge_tool_path=$(translate_merge_tool_path &quot;$merge_tool&quot;)
	fi
	if test -z &quot;$(get_merge_tool_cmd &quot;$merge_tool&quot;)&quot; &amp;&amp;
		! type &quot;$merge_tool_path&quot; &gt;/dev/null 2&gt;&amp;1
	then
		echo &gt;&amp;2 &quot;The $TOOL_MODE tool $merge_tool is not available as&quot;\
			 &quot;'$merge_tool_path'&quot;
		exit 1
	fi
	echo &quot;$merge_tool_path&quot;
}

get_merge_tool () {
	is_guessed=false
	# Check if a merge tool has been configured
	merge_tool=$(get_configured_merge_tool)
	subshell_exit_status=$?
	if test $subshell_exit_status -gt &quot;1&quot;
	then
		exit $subshell_exit_status
	fi
	# Try to guess an appropriate merge tool if no tool has been set.
	if test -z &quot;$merge_tool&quot;
	then
		merge_tool=$(guess_merge_tool) || exit
		is_guessed=true
	fi
	echo &quot;$merge_tool&quot;
	test &quot;$is_guessed&quot; = false
}

mergetool_find_win32_cmd () {
	executable=$1
	sub_directory=$2

	# Use $executable if it exists in $PATH
	if type -p &quot;$executable&quot; &gt;/dev/null 2&gt;&amp;1
	then
		printf '%s' &quot;$executable&quot;
		return
	fi

	# Look for executable in the typical locations
	for directory in $(env | grep -Ei '^PROGRAM(FILES(\(X86\))?|W6432)=' |
		cut -d '=' -f 2- | sort -u)
	do
		if test -n &quot;$directory&quot; &amp;&amp; test -x &quot;$directory/$sub_directory/$executable&quot;
		then
			printf '%s' &quot;$directory/$sub_directory/$executable&quot;
			return
		fi
	done

	printf '%s' &quot;$executable&quot;
}
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flibexec%2Fgit-core'>Back to Directory</a>