[thirdparty/git.git] / unpack-trees.h

#ifndef UNPACK_TREES_H
#define UNPACK_TREES_H

#include "tree-walk.h"
#include "argv-array.h"

#define MAX_UNPACK_TREES 8

struct unpack_trees_options;
struct exclude_list;

typedef int (*merge_fn_t)(const struct cache_entry * const *src,
		struct unpack_trees_options *options);

enum unpack_trees_error_types {
	ERROR_WOULD_OVERWRITE = 0,
	ERROR_NOT_UPTODATE_FILE,
	ERROR_NOT_UPTODATE_DIR,
	ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN,
	ERROR_WOULD_LOSE_UNTRACKED_REMOVED,
	ERROR_BIND_OVERLAP,
	ERROR_SPARSE_NOT_UPTODATE_FILE,
	ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN,
	ERROR_WOULD_LOSE_ORPHANED_REMOVED,
	ERROR_WOULD_LOSE_SUBMODULE,
	NB_UNPACK_TREES_ERROR_TYPES
};

/*
 * Sets the list of user-friendly error messages to be used by the
 * command "cmd" (either merge or checkout), and show_all_errors to 1.
 */
void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
				  const char *cmd);

/*
 * Frees resources allocated by setup_unpack_trees_porcelain().
 */
void clear_unpack_trees_porcelain(struct unpack_trees_options *opts);

struct unpack_trees_options {
	unsigned int reset,
		     merge,
		     update,
		     index_only,
		     nontrivial_merge,
		     trivial_merges_only,
		     verbose_update,
		     aggressive,
		     skip_unmerged,
		     initial_checkout,
		     diff_index_cached,
		     debug_unpack,
		     skip_sparse_checkout,
		     gently,
		     exiting_early,
		     show_all_errors,
		     dry_run;
	const char *prefix;
	int cache_bottom;
	struct dir_struct *dir;
	struct pathspec *pathspec;
	merge_fn_t fn;
	const char *msgs[NB_UNPACK_TREES_ERROR_TYPES];
	struct argv_array msgs_to_free;
	/*
	 * Store error messages in an array, each case
	 * corresponding to a error message type
	 */
	struct string_list unpack_rejects[NB_UNPACK_TREES_ERROR_TYPES];

	int head_idx;
	int merge_size;

	struct cache_entry *df_conflict_entry;
	void *unpack_data;

	struct index_state *dst_index;
	struct index_state *src_index;
	struct index_state result;

	struct exclude_list *el; /* for internal use */
};

extern int unpack_trees(unsigned n, struct tree_desc *t,
		struct unpack_trees_options *options);

int verify_uptodate(const struct cache_entry *ce,
		    struct unpack_trees_options *o);

int threeway_merge(const struct cache_entry * const *stages,
		   struct unpack_trees_options *o);
int twoway_merge(const struct cache_entry * const *src,
		 struct unpack_trees_options *o);
int bind_merge(const struct cache_entry * const *src,
	       struct unpack_trees_options *o);
int oneway_merge(const struct cache_entry * const *src,
		 struct unpack_trees_options *o);

#endif
Commit	Line	Data
16da134b JS	1	#ifndef UNPACK_TREES_H
	2	#define UNPACK_TREES_H
	3
64b1abe9	4	#include "tree-walk.h"
1c41d280	5	#include "argv-array.h"
7980872d	6
ca885a4f JH	7	#define MAX_UNPACK_TREES 8
ca885a4f JH	8
16da134b	9	struct unpack_trees_options;
08aefc9e	10	struct exclude_list;
16da134b	11
5828e835	12	typedef int (merge_fn_t)(const struct cache_entry const *src,
34110cd4	13	struct unpack_trees_options *options);
16da134b	14
08353ebb MM	15	enum unpack_trees_error_types {
	16	ERROR_WOULD_OVERWRITE = 0,
	17	ERROR_NOT_UPTODATE_FILE,
	18	ERROR_NOT_UPTODATE_DIR,
08402b04 MM	19	ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN,
08402b04 MM	20	ERROR_WOULD_LOSE_UNTRACKED_REMOVED,
08353ebb MM	21	ERROR_BIND_OVERLAP,
08353ebb MM	22	ERROR_SPARSE_NOT_UPTODATE_FILE,
08402b04 MM	23	ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN,
08402b04 MM	24	ERROR_WOULD_LOSE_ORPHANED_REMOVED,
a7bc845a	25	ERROR_WOULD_LOSE_SUBMODULE,
08353ebb	26	NB_UNPACK_TREES_ERROR_TYPES
8ccba008 JH	27	};
8ccba008 JH	28
dc1166e6 MM	29	/*
dc1166e6 MM	30	* Sets the list of user-friendly error messages to be used by the
5e65ee35	31	* command "cmd" (either merge or checkout), and show_all_errors to 1.
dc1166e6	32	*/
e294030f MM	33	void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
e294030f MM	34	const char *cmd);
dc1166e6	35
1c41d280 MÅ	36	/*
	37	* Frees resources allocated by setup_unpack_trees_porcelain().
	38	*/
	39	void clear_unpack_trees_porcelain(struct unpack_trees_options *opts);
	40
16da134b	41	struct unpack_trees_options {
5a56da58 SB	42	unsigned int reset,
	43	merge,
	44	update,
	45	index_only,
	46	nontrivial_merge,
	47	trivial_merges_only,
	48	verbose_update,
	49	aggressive,
	50	skip_unmerged,
	51	initial_checkout,
	52	diff_index_cached,
ba655da5	53	debug_unpack,
08aefc9e	54	skip_sparse_checkout,
e6c111b4	55	gently,
b4194828	56	exiting_early,
2c9078d0 JL	57	show_all_errors,
2c9078d0 JL	58	dry_run;
16da134b	59	const char *prefix;
da165f47	60	int cache_bottom;
f8a9d428	61	struct dir_struct *dir;
40e37256	62	struct pathspec *pathspec;
16da134b	63	merge_fn_t fn;
08353ebb	64	const char *msgs[NB_UNPACK_TREES_ERROR_TYPES];
1c41d280	65	struct argv_array msgs_to_free;
e6c111b4 MM	66	/*
	67	* Store error messages in an array, each case
	68	* corresponding to a error message type
	69	*/
7980872d	70	struct string_list unpack_rejects[NB_UNPACK_TREES_ERROR_TYPES];
16da134b JS	71
	72	int head_idx;
	73	int merge_size;
	74
	75	struct cache_entry *df_conflict_entry;
d1f2d7e8	76	void *unpack_data;
34110cd4 LT	77
34110cd4 LT	78	struct index_state *dst_index;
32260ad5	79	struct index_state *src_index;
34110cd4	80	struct index_state result;
08aefc9e NTND	81
08aefc9e NTND	82	struct exclude_list el; / for internal use */
16da134b JS	83	};
16da134b JS	84
933bf40a	85	extern int unpack_trees(unsigned n, struct tree_desc *t,
16da134b JS	86	struct unpack_trees_options *options);
16da134b JS	87
64b1abe9 EN	88	int verify_uptodate(const struct cache_entry *ce,
	89	struct unpack_trees_options *o);
	90
5828e835 RS	91	int threeway_merge(const struct cache_entry * const *stages,
	92	struct unpack_trees_options *o);
	93	int twoway_merge(const struct cache_entry * const *src,
	94	struct unpack_trees_options *o);
	95	int bind_merge(const struct cache_entry * const *src,
	96	struct unpack_trees_options *o);
	97	int oneway_merge(const struct cache_entry * const *src,
	98	struct unpack_trees_options *o);
076b0adc	99
16da134b	100	#endif