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

#ifndef UNPACK_TREES_H
#define UNPACK_TREES_H

#include "cache.h"
#include "strvec.h"
#include "string-list.h"
#include "tree-walk.h"

#define MAX_UNPACK_TREES MAX_TRAVERSE_TREES

struct cache_entry;
struct unpack_trees_options;
struct pattern_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_CWD_IN_THE_WAY,
	ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN,
	ERROR_WOULD_LOSE_UNTRACKED_REMOVED,
	ERROR_BIND_OVERLAP,
	ERROR_WOULD_LOSE_SUBMODULE,

	NB_UNPACK_TREES_ERROR_TYPES,

	WARNING_SPARSE_NOT_UPTODATE_FILE,
	WARNING_SPARSE_UNMERGED_FILE,
	WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN,

	NB_UNPACK_TREES_WARNING_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);

enum unpack_trees_reset_type {
	UNPACK_RESET_NONE = 0,    /* traditional "false" value; still valid */
	UNPACK_RESET_INVALID = 1, /* "true" no longer valid; use below values */
	UNPACK_RESET_PROTECT_UNTRACKED,
	UNPACK_RESET_OVERWRITE_UNTRACKED
};

struct unpack_trees_options {
	unsigned int merge,
		     update,
		     preserve_ignored,
		     clone,
		     index_only,
		     nontrivial_merge,
		     trivial_merges_only,
		     verbose_update,
		     aggressive,
		     skip_unmerged,
		     initial_checkout,
		     diff_index_cached,
		     debug_unpack,
		     skip_sparse_checkout,
		     quiet,
		     exiting_early,
		     show_all_errors,
		     dry_run,
		     skip_cache_tree_update;
	enum unpack_trees_reset_type reset;
	const char *prefix;
	int cache_bottom;
	struct pathspec *pathspec;
	merge_fn_t fn;
	const char *msgs[NB_UNPACK_TREES_WARNING_TYPES];
	struct strvec 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_WARNING_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 pattern_list *pl; /* for internal use */
	struct dir_struct *dir; /* for internal use only */
	struct checkout_metadata meta;
};

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

enum update_sparsity_result {
	UPDATE_SPARSITY_SUCCESS = 0,
	UPDATE_SPARSITY_WARNINGS = 1,
	UPDATE_SPARSITY_INDEX_UPDATE_FAILURES = -1,
	UPDATE_SPARSITY_WORKTREE_UPDATE_FAILURES = -2
};

enum update_sparsity_result update_sparsity(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);
int stash_worktree_untracked_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
ef3ca954	4	#include "cache.h"
dbbcd44f	5	#include "strvec.h"
ef3ca954 EN	6	#include "string-list.h"
ef3ca954 EN	7	#include "tree-walk.h"
7980872d	8
5290d451	9	#define MAX_UNPACK_TREES MAX_TRAVERSE_TREES
ca885a4f	10
ef3ca954	11	struct cache_entry;
16da134b	12	struct unpack_trees_options;
caa3d554	13	struct pattern_list;
16da134b	14
5828e835	15	typedef int (merge_fn_t)(const struct cache_entry const *src,
34110cd4	16	struct unpack_trees_options *options);
16da134b	17
08353ebb MM	18	enum unpack_trees_error_types {
	19	ERROR_WOULD_OVERWRITE = 0,
	20	ERROR_NOT_UPTODATE_FILE,
	21	ERROR_NOT_UPTODATE_DIR,
b817e545	22	ERROR_CWD_IN_THE_WAY,
08402b04 MM	23	ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN,
08402b04 MM	24	ERROR_WOULD_LOSE_UNTRACKED_REMOVED,
08353ebb	25	ERROR_BIND_OVERLAP,
a7bc845a	26	ERROR_WOULD_LOSE_SUBMODULE,
1ac83f42	27
6271d77c EN	28	NB_UNPACK_TREES_ERROR_TYPES,
6271d77c EN	29
1ac83f42	30	WARNING_SPARSE_NOT_UPTODATE_FILE,
ebb568b9	31	WARNING_SPARSE_UNMERGED_FILE,
1ac83f42 EN	32	WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN,
1ac83f42 EN	33
6271d77c	34	NB_UNPACK_TREES_WARNING_TYPES,
8ccba008 JH	35	};
8ccba008 JH	36
dc1166e6 MM	37	/*
dc1166e6 MM	38	* Sets the list of user-friendly error messages to be used by the
5e65ee35	39	* command "cmd" (either merge or checkout), and show_all_errors to 1.
dc1166e6	40	*/
e294030f MM	41	void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
e294030f MM	42	const char *cmd);
dc1166e6	43
1c41d280 MÅ	44	/*
	45	* Frees resources allocated by setup_unpack_trees_porcelain().
	46	*/
	47	void clear_unpack_trees_porcelain(struct unpack_trees_options *opts);
	48
480d3d6b EN	49	enum unpack_trees_reset_type {
	50	UNPACK_RESET_NONE = 0, /* traditional "false" value; still valid */
	51	UNPACK_RESET_INVALID = 1, /* "true" no longer valid; use below values */
	52	UNPACK_RESET_PROTECT_UNTRACKED,
	53	UNPACK_RESET_OVERWRITE_UNTRACKED
	54	};
	55
16da134b	56	struct unpack_trees_options {
480d3d6b	57	unsigned int merge,
5a56da58	58	update,
04988c8d	59	preserve_ignored,
b878579a	60	clone,
5a56da58 SB	61	index_only,
	62	nontrivial_merge,
	63	trivial_merges_only,
	64	verbose_update,
	65	aggressive,
	66	skip_unmerged,
	67	initial_checkout,
	68	diff_index_cached,
ba655da5	69	debug_unpack,
08aefc9e	70	skip_sparse_checkout,
b165fac8	71	quiet,
b4194828	72	exiting_early,
2c9078d0	73	show_all_errors,
68fcd48b VD	74	dry_run,
68fcd48b VD	75	skip_cache_tree_update;
480d3d6b	76	enum unpack_trees_reset_type reset;
16da134b	77	const char *prefix;
da165f47	78	int cache_bottom;
40e37256	79	struct pathspec *pathspec;
16da134b	80	merge_fn_t fn;
6271d77c	81	const char *msgs[NB_UNPACK_TREES_WARNING_TYPES];
c972bf4c	82	struct strvec msgs_to_free;
e6c111b4 MM	83	/*
	84	* Store error messages in an array, each case
	85	* corresponding to a error message type
	86	*/
6271d77c	87	struct string_list unpack_rejects[NB_UNPACK_TREES_WARNING_TYPES];
16da134b JS	88
	89	int head_idx;
	90	int merge_size;
	91
	92	struct cache_entry *df_conflict_entry;
d1f2d7e8	93	void *unpack_data;
34110cd4 LT	94
34110cd4 LT	95	struct index_state *dst_index;
32260ad5	96	struct index_state *src_index;
34110cd4	97	struct index_state result;
08aefc9e	98
caa3d554	99	struct pattern_list pl; / for internal use */
c42e0b64	100	struct dir_struct dir; / for internal use only */
13e7ed6a	101	struct checkout_metadata meta;
16da134b JS	102	};
16da134b JS	103
340f4bc9 NTND	104	int unpack_trees(unsigned n, struct tree_desc *t,
340f4bc9 NTND	105	struct unpack_trees_options *options);
16da134b	106
7af7a258 EN	107	enum update_sparsity_result {
	108	UPDATE_SPARSITY_SUCCESS = 0,
	109	UPDATE_SPARSITY_WARNINGS = 1,
	110	UPDATE_SPARSITY_INDEX_UPDATE_FAILURES = -1,
	111	UPDATE_SPARSITY_WORKTREE_UPDATE_FAILURES = -2
	112	};
	113
	114	enum update_sparsity_result update_sparsity(struct unpack_trees_options *options);
	115
64b1abe9 EN	116	int verify_uptodate(const struct cache_entry *ce,
	117	struct unpack_trees_options *o);
	118
5828e835 RS	119	int threeway_merge(const struct cache_entry * const *stages,
	120	struct unpack_trees_options *o);
	121	int twoway_merge(const struct cache_entry * const *src,
	122	struct unpack_trees_options *o);
	123	int bind_merge(const struct cache_entry * const *src,
	124	struct unpack_trees_options *o);
	125	int oneway_merge(const struct cache_entry * const *src,
	126	struct unpack_trees_options *o);
d3c7bf73 DL	127	int stash_worktree_untracked_merge(const struct cache_entry * const *src,
d3c7bf73 DL	128	struct unpack_trees_options *o);
076b0adc	129
16da134b	130	#endif