ll-merge.c 10.1 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
			   const struct ll_merge_options *opts,
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 43
			   const struct ll_merge_options *opts,
			   int marker_size)
44
{
45 46 47
	mmfile_t *stolen;
	assert(opts);

48 49 50 51 52
	/*
	 * The tentative merge result is "ours" for the final round,
	 * or common ancestor for an internal merge.  Still return
	 * "conflicted merge" status.
	 */
53
	stolen = opts->virtual_ancestor ? orig : src1;
54 55 56 57 58 59 60 61 62

	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,
63
			const char *path,
64
			mmfile_t *orig, const char *orig_name,
65 66
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
67 68
			const struct ll_merge_options *opts,
			int marker_size)
69
{
70
	xmparam_t xmp;
71
	assert(opts);
72 73 74 75

	if (buffer_is_binary(orig->ptr, orig->size) ||
	    buffer_is_binary(src1->ptr, src1->size) ||
	    buffer_is_binary(src2->ptr, src2->size)) {
76 77
		warning("Cannot merge binary files: %s (%s vs. %s)\n",
			path, name1, name2);
78
		return ll_binary_merge(drv_unused, result,
79
				       path,
80 81
				       orig, orig_name,
				       src1, name1,
82
				       src2, name2,
83
				       opts, marker_size);
84 85
	}

86
	memset(&xmp, 0, sizeof(xmp));
87
	xmp.level = XDL_MERGE_ZEALOUS;
88
	xmp.favor = opts->variant;
Justin Frankel's avatar
Justin Frankel committed
89
	xmp.xpp.flags = opts->xdl_opts;
90
	if (git_xmerge_style >= 0)
91
		xmp.style = git_xmerge_style;
92 93
	if (marker_size > 0)
		xmp.marker_size = marker_size;
94
	xmp.ancestor = orig_name;
95 96 97
	xmp.file1 = name1;
	xmp.file2 = name2;
	return xdl_merge(orig, src1, src2, &xmp, result);
98 99 100 101 102
}

static int ll_union_merge(const struct ll_merge_driver *drv_unused,
			  mmbuffer_t *result,
			  const char *path_unused,
103
			  mmfile_t *orig, const char *orig_name,
104 105
			  mmfile_t *src1, const char *name1,
			  mmfile_t *src2, const char *name2,
106 107
			  const struct ll_merge_options *opts,
			  int marker_size)
108
{
109
	/* Use union favor */
110 111 112 113
	struct ll_merge_options o;
	assert(opts);
	o = *opts;
	o.variant = XDL_MERGE_FAVOR_UNION;
114
	return ll_xdl_merge(drv_unused, result, path_unused,
115
			    orig, NULL, src1, NULL, src2, NULL,
116
			    &o, marker_size);
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
}

#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)
135
		die_errno("unable to write temp-file");
136 137 138 139 140 141 142 143 144
	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,
145
			mmfile_t *orig, const char *orig_name,
146 147
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
148 149
			const struct ll_merge_options *opts,
			int marker_size)
150
{
151
	char temp[4][50];
152
	struct strbuf cmd = STRBUF_INIT;
153
	struct strbuf_expand_dict_entry dict[5];
154
	const char *args[] = { NULL, NULL };
155 156
	int status, fd, i;
	struct stat st;
157
	assert(opts);
158

159 160 161 162 163 164
	dict[0].placeholder = "O"; dict[0].value = temp[0];
	dict[1].placeholder = "A"; dict[1].value = temp[1];
	dict[2].placeholder = "B"; dict[2].value = temp[2];
	dict[3].placeholder = "L"; dict[3].value = temp[3];
	dict[4].placeholder = NULL; dict[4].value = NULL;

165 166 167 168 169 170 171 172
	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]);
173
	sprintf(temp[3], "%d", marker_size);
174

175
	strbuf_expand(&cmd, fn->cmdline, strbuf_expand_dict_cb, &dict);
176

177 178
	args[0] = cmd.buf;
	status = run_command_v_opt(args, RUN_USING_SHELL);
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
	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++)
195
		unlink_or_warn(temp[i]);
196
	strbuf_release(&cmd);
197 198 199 200 201 202 203 204 205
	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;

206
static int read_merge_config(const char *var, const char *value, void *cb)
207 208 209 210 211 212 213
{
	struct ll_merge_driver *fn;
	const char *ep, *name;
	int namelen;

	if (!strcmp(var, "merge.default")) {
		if (value)
214
			default_ll_merge = xstrdup(value);
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
		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);
248
		fn->description = xstrdup(value);
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
		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.
266
		 *    %L - conflict marker length
267 268 269 270 271
		 *
		 * The external merge driver should write the results in the
		 * file named by %A, and signal that it has done with zero exit
		 * status.
		 */
272
		fn->cmdline = xstrdup(value);
273 274 275 276 277 278
		return 0;
	}

	if (!strcmp("recursive", ep)) {
		if (!value)
			return error("%s: lacks value", var);
279
		fn->recursive = xstrdup(value);
280 281 282 283 284 285 286 287 288 289 290
		return 0;
	}

	return 0;
}

static void initialize_ll_merge(void)
{
	if (ll_user_merge_tail)
		return;
	ll_user_merge_tail = &ll_user_merge;
291
	git_config(read_merge_config, NULL);
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
}

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];
}

327
static int git_path_check_merge(const char *path, struct git_attr_check check[2])
328
{
329 330 331 332 333
	if (!check[0].attr) {
		check[0].attr = git_attr("merge");
		check[1].attr = git_attr("conflict-marker-size");
	}
	return git_checkattr(path, 2, check);
334 335
}

336 337 338 339 340 341 342 343 344 345
static void normalize_file(mmfile_t *mm, const char *path)
{
	struct strbuf strbuf = STRBUF_INIT;
	if (renormalize_buffer(path, mm->ptr, mm->size, &strbuf)) {
		free(mm->ptr);
		mm->size = strbuf.len;
		mm->ptr = strbuf_detach(&strbuf, NULL);
	}
}

346 347
int ll_merge(mmbuffer_t *result_buf,
	     const char *path,
348
	     mmfile_t *ancestor, const char *ancestor_label,
349 350
	     mmfile_t *ours, const char *our_label,
	     mmfile_t *theirs, const char *their_label,
351
	     const struct ll_merge_options *opts)
352
{
353 354 355
	static struct git_attr_check check[2];
	const char *ll_driver_name = NULL;
	int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
356 357
	const struct ll_merge_driver *driver;

358 359 360 361 362 363 364 365
	if (!opts) {
		struct ll_merge_options default_opts = {0};
		return ll_merge(result_buf, path, ancestor, ancestor_label,
				ours, our_label, theirs, their_label,
				&default_opts);
	}

	if (opts->renormalize) {
366 367 368 369
		normalize_file(ancestor, path);
		normalize_file(ours, path);
		normalize_file(theirs, path);
	}
370 371 372 373 374 375 376 377
	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;
		}
	}
378
	driver = find_ll_merge_driver(ll_driver_name);
379
	if (opts->virtual_ancestor && driver->recursive)
380
		driver = find_ll_merge_driver(driver->recursive);
381
	return driver->fn(driver, result_buf, path, ancestor, ancestor_label,
382
			  ours, our_label, theirs, their_label,
383
			  opts, marker_size);
384
}
385 386 387 388 389 390 391 392 393 394 395 396 397 398

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;
399
}