git/merge-ll.h

/*
 * Low level 3-way in-core file merge.
 */

#ifndef LL_MERGE_H
#define LL_MERGE_H

#include "xdiff/xdiff.h"

/**
 *
 * Calling sequence:
 * ----------------
 *
 * - Prepare a `struct ll_merge_options` to record options.
 *   If you have no special requests, skip this and pass `NULL`
 *   as the `opts` parameter to use the default options.
 *
 * - Allocate an mmbuffer_t variable for the result.
 *
 * - Allocate and fill variables with the file's original content
 *   and two modified versions (using `read_mmfile`, for example).
 *
 * - Call `ll_merge()`.
 *
 * - Read the merged content from `result_buf.ptr` and `result_buf.size`.
 *
 * - Release buffers when finished.  A simple
 *   `free(ancestor.ptr); free(ours.ptr); free(theirs.ptr);
 *   free(result_buf.ptr);` will do.
 *
 * If the modifications do not merge cleanly, `ll_merge` will return a
 * nonzero value and `result_buf` will generally include a description of
 * the conflict bracketed by markers such as the traditional `<<<<<<<`
 * and `>>>>>>>`.
 *
 * The `ancestor_label`, `our_label`, and `their_label` parameters are
 * used to label the different sides of a conflict if the merge driver
 * supports this.
 */


struct index_state;

/**
 * This describes the set of options the calling program wants to affect
 * the operation of a low-level (single file) merge.
 */
struct ll_merge_options { … };

#define LL_MERGE_OPTIONS_INIT …

enum ll_merge_result { … };

/**
 * Perform a three-way single-file merge in core.  This is a thin wrapper
 * around `xdl_merge` that takes the path and any merge backend specified in
 * `.gitattributes` or `.git/info/attributes` into account.
 * Returns 0 for a clean merge.
 */
enum ll_merge_result ll_merge(mmbuffer_t *result_buf,
	     const char *path,
	     mmfile_t *ancestor, const char *ancestor_label,
	     mmfile_t *ours, const char *our_label,
	     mmfile_t *theirs, const char *their_label,
	     struct index_state *istate,
	     const struct ll_merge_options *opts);

int ll_merge_marker_size(struct index_state *istate, const char *path);
void reset_merge_attributes(void);

#endif