ll-merge.c 9.09 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * Low level 3-way in-core file merge.
 *
 * Copyright (c) 2007 Junio C Hamano
 */

#include "cache.h"
#include "attr.h"
#include "xdiff-interface.h"
#include "run-command.h"
#include "ll-merge.h"

struct ll_merge_driver;

typedef int (*ll_merge_fn)(const struct ll_merge_driver *,
			   mmbuffer_t *result,
			   const char *path,
18
			   mmfile_t *orig, const char *orig_name,
19 20
			   mmfile_t *src1, const char *name1,
			   mmfile_t *src2, const char *name2,
21
			   int flag,
22
			   int marker_size);
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

struct ll_merge_driver {
	const char *name;
	const char *description;
	ll_merge_fn fn;
	const char *recursive;
	struct ll_merge_driver *next;
	char *cmdline;
};

/*
 * Built-in low-levels
 */
static int ll_binary_merge(const struct ll_merge_driver *drv_unused,
			   mmbuffer_t *result,
			   const char *path_unused,
39
			   mmfile_t *orig, const char *orig_name,
40 41
			   mmfile_t *src1, const char *name1,
			   mmfile_t *src2, const char *name2,
42
			   int flag, int marker_size)
43 44 45 46 47 48
{
	/*
	 * The tentative merge result is "ours" for the final round,
	 * or common ancestor for an internal merge.  Still return
	 * "conflicted merge" status.
	 */
Avery Pennarun's avatar
Avery Pennarun committed
49
	mmfile_t *stolen = (flag & 01) ? orig : src1;
50 51 52 53 54 55 56 57 58

	result->ptr = stolen->ptr;
	result->size = stolen->size;
	stolen->ptr = NULL;
	return 1;
}

static int ll_xdl_merge(const struct ll_merge_driver *drv_unused,
			mmbuffer_t *result,
59
			const char *path,
60
			mmfile_t *orig, const char *orig_name,
61 62
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
63
			int flag, int marker_size)
64
{
65
	xmparam_t xmp;
66 67 68 69

	if (buffer_is_binary(orig->ptr, orig->size) ||
	    buffer_is_binary(src1->ptr, src1->size) ||
	    buffer_is_binary(src2->ptr, src2->size)) {
70 71
		warning("Cannot merge binary files: %s (%s vs. %s)\n",
			path, name1, name2);
72
		return ll_binary_merge(drv_unused, result,
73
				       path,
74 75
				       orig, orig_name,
				       src1, name1,
76
				       src2, name2,
77
				       flag, marker_size);
78 79
	}

80
	memset(&xmp, 0, sizeof(xmp));
81 82
	xmp.level = XDL_MERGE_ZEALOUS;
	xmp.favor= (flag >> 1) & 03;
83
	if (git_xmerge_style >= 0)
84
		xmp.style = git_xmerge_style;
85 86
	if (marker_size > 0)
		xmp.marker_size = marker_size;
87
	xmp.ancestor = orig_name;
88 89 90
	xmp.file1 = name1;
	xmp.file2 = name2;
	return xdl_merge(orig, src1, src2, &xmp, result);
91 92 93 94 95
}

static int ll_union_merge(const struct ll_merge_driver *drv_unused,
			  mmbuffer_t *result,
			  const char *path_unused,
96
			  mmfile_t *orig, const char *orig_name,
97 98
			  mmfile_t *src1, const char *name1,
			  mmfile_t *src2, const char *name2,
99
			  int flag, int marker_size)
100
{
101 102 103
	/* Use union favor */
	flag = (flag & 1) | (XDL_MERGE_FAVOR_UNION << 1);
	return ll_xdl_merge(drv_unused, result, path_unused,
104
			    orig, NULL, src1, NULL, src2, NULL,
105
			    flag, marker_size);
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
	return 0;
}

#define LL_BINARY_MERGE 0
#define LL_TEXT_MERGE 1
#define LL_UNION_MERGE 2
static struct ll_merge_driver ll_merge_drv[] = {
	{ "binary", "built-in binary merge", ll_binary_merge },
	{ "text", "built-in 3-way text merge", ll_xdl_merge },
	{ "union", "built-in union merge", ll_union_merge },
};

static void create_temp(mmfile_t *src, char *path)
{
	int fd;

	strcpy(path, ".merge_file_XXXXXX");
	fd = xmkstemp(path);
	if (write_in_full(fd, src->ptr, src->size) != src->size)
125
		die_errno("unable to write temp-file");
126 127 128 129 130 131 132 133 134
	close(fd);
}

/*
 * User defined low-level merge driver support.
 */
static int ll_ext_merge(const struct ll_merge_driver *fn,
			mmbuffer_t *result,
			const char *path,
135
			mmfile_t *orig, const char *orig_name,
136 137
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
138
			int flag, int marker_size)
139
{
140
	char temp[4][50];
141 142 143 144 145
	struct strbuf cmd = STRBUF_INIT;
	struct strbuf_expand_dict_entry dict[] = {
		{ "O", temp[0] },
		{ "A", temp[1] },
		{ "B", temp[2] },
146
		{ "L", temp[3] },
147
		{ NULL }
148
	};
149
	const char *args[] = { NULL, NULL };
150 151 152 153 154 155 156 157 158 159 160
	int status, fd, i;
	struct stat st;

	if (fn->cmdline == NULL)
		die("custom merge driver %s lacks command line.", fn->name);

	result->ptr = NULL;
	result->size = 0;
	create_temp(orig, temp[0]);
	create_temp(src1, temp[1]);
	create_temp(src2, temp[2]);
161
	sprintf(temp[3], "%d", marker_size);
162

163
	strbuf_expand(&cmd, fn->cmdline, strbuf_expand_dict_cb, &dict);
164

165 166
	args[0] = cmd.buf;
	status = run_command_v_opt(args, RUN_USING_SHELL);
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
	fd = open(temp[1], O_RDONLY);
	if (fd < 0)
		goto bad;
	if (fstat(fd, &st))
		goto close_bad;
	result->size = st.st_size;
	result->ptr = xmalloc(result->size + 1);
	if (read_in_full(fd, result->ptr, result->size) != result->size) {
		free(result->ptr);
		result->ptr = NULL;
		result->size = 0;
	}
 close_bad:
	close(fd);
 bad:
	for (i = 0; i < 3; i++)
183
		unlink_or_warn(temp[i]);
184
	strbuf_release(&cmd);
185 186 187 188 189 190 191 192 193
	return status;
}

/*
 * merge.default and merge.driver configuration items
 */
static struct ll_merge_driver *ll_user_merge, **ll_user_merge_tail;
static const char *default_ll_merge;

194
static int read_merge_config(const char *var, const char *value, void *cb)
195 196 197 198 199 200 201
{
	struct ll_merge_driver *fn;
	const char *ep, *name;
	int namelen;

	if (!strcmp(var, "merge.default")) {
		if (value)
202
			default_ll_merge = xstrdup(value);
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
		return 0;
	}

	/*
	 * We are not interested in anything but "merge.<name>.variable";
	 * especially, we do not want to look at variables such as
	 * "merge.summary", "merge.tool", and "merge.verbosity".
	 */
	if (prefixcmp(var, "merge.") || (ep = strrchr(var, '.')) == var + 5)
		return 0;

	/*
	 * Find existing one as we might be processing merge.<name>.var2
	 * after seeing merge.<name>.var1.
	 */
	name = var + 6;
	namelen = ep - name;
	for (fn = ll_user_merge; fn; fn = fn->next)
		if (!strncmp(fn->name, name, namelen) && !fn->name[namelen])
			break;
	if (!fn) {
		fn = xcalloc(1, sizeof(struct ll_merge_driver));
		fn->name = xmemdupz(name, namelen);
		fn->fn = ll_ext_merge;
		*ll_user_merge_tail = fn;
		ll_user_merge_tail = &(fn->next);
	}

	ep++;

	if (!strcmp("name", ep)) {
		if (!value)
			return error("%s: lacks value", var);
236
		fn->description = xstrdup(value);
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
		return 0;
	}

	if (!strcmp("driver", ep)) {
		if (!value)
			return error("%s: lacks value", var);
		/*
		 * merge.<name>.driver specifies the command line:
		 *
		 *	command-line
		 *
		 * The command-line will be interpolated with the following
		 * tokens and is given to the shell:
		 *
		 *    %O - temporary file name for the merge base.
		 *    %A - temporary file name for our version.
		 *    %B - temporary file name for the other branches' version.
254
		 *    %L - conflict marker length
255 256 257 258 259
		 *
		 * The external merge driver should write the results in the
		 * file named by %A, and signal that it has done with zero exit
		 * status.
		 */
260
		fn->cmdline = xstrdup(value);
261 262 263 264 265 266
		return 0;
	}

	if (!strcmp("recursive", ep)) {
		if (!value)
			return error("%s: lacks value", var);
267
		fn->recursive = xstrdup(value);
268 269 270 271 272 273 274 275 276 277 278
		return 0;
	}

	return 0;
}

static void initialize_ll_merge(void)
{
	if (ll_user_merge_tail)
		return;
	ll_user_merge_tail = &ll_user_merge;
279
	git_config(read_merge_config, NULL);
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
}

static const struct ll_merge_driver *find_ll_merge_driver(const char *merge_attr)
{
	struct ll_merge_driver *fn;
	const char *name;
	int i;

	initialize_ll_merge();

	if (ATTR_TRUE(merge_attr))
		return &ll_merge_drv[LL_TEXT_MERGE];
	else if (ATTR_FALSE(merge_attr))
		return &ll_merge_drv[LL_BINARY_MERGE];
	else if (ATTR_UNSET(merge_attr)) {
		if (!default_ll_merge)
			return &ll_merge_drv[LL_TEXT_MERGE];
		else
			name = default_ll_merge;
	}
	else
		name = merge_attr;

	for (fn = ll_user_merge; fn; fn = fn->next)
		if (!strcmp(fn->name, name))
			return fn;

	for (i = 0; i < ARRAY_SIZE(ll_merge_drv); i++)
		if (!strcmp(ll_merge_drv[i].name, name))
			return &ll_merge_drv[i];

	/* default to the 3-way */
	return &ll_merge_drv[LL_TEXT_MERGE];
}

315
static int git_path_check_merge(const char *path, struct git_attr_check check[2])
316
{
317 318 319 320 321
	if (!check[0].attr) {
		check[0].attr = git_attr("merge");
		check[1].attr = git_attr("conflict-marker-size");
	}
	return git_checkattr(path, 2, check);
322 323 324 325
}

int ll_merge(mmbuffer_t *result_buf,
	     const char *path,
326
	     mmfile_t *ancestor, const char *ancestor_label,
327 328
	     mmfile_t *ours, const char *our_label,
	     mmfile_t *theirs, const char *their_label,
Avery Pennarun's avatar
Avery Pennarun committed
329
	     int flag)
330
{
331 332 333
	static struct git_attr_check check[2];
	const char *ll_driver_name = NULL;
	int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
334
	const struct ll_merge_driver *driver;
Avery Pennarun's avatar
Avery Pennarun committed
335
	int virtual_ancestor = flag & 01;
336

337 338 339 340 341 342 343 344
	if (!git_path_check_merge(path, check)) {
		ll_driver_name = check[0].value;
		if (check[1].value) {
			marker_size = atoi(check[1].value);
			if (marker_size <= 0)
				marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
		}
	}
345 346 347
	driver = find_ll_merge_driver(ll_driver_name);
	if (virtual_ancestor && driver->recursive)
		driver = find_ll_merge_driver(driver->recursive);
348
	return driver->fn(driver, result_buf, path, ancestor, ancestor_label,
349
			  ours, our_label, theirs, their_label,
350
			  flag, marker_size);
351
}
352 353 354 355 356 357 358 359 360 361 362 363 364 365

int ll_merge_marker_size(const char *path)
{
	static struct git_attr_check check;
	int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;

	if (!check.attr)
		check.attr = git_attr("conflict-marker-size");
	if (!git_checkattr(path, 1, &check) && check.value) {
		marker_size = atoi(check.value);
		if (marker_size <= 0)
			marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
	}
	return marker_size;
366
}