summaryrefslogtreecommitdiff
path: root/unpack-trees.h
blob: 5867e26e17777483f3fc5df0084deb7a4dd135da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
#ifndef UNPACK_TREES_H
#define UNPACK_TREES_H
 
#include "convert.h"
#include "read-cache-ll.h"
#include "strvec.h"
#include "string-list.h"
#include "tree-walk.h"
 
#define MAX_UNPACK_TREES 8
 
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,
		     trivial_merges_only,
		     verbose_update,
		     aggressive,
		     skip_unmerged,
		     initial_checkout,
		     diff_index_cached,
		     skip_sparse_checkout,
		     quiet,
		     exiting_early,
		     dry_run,
		     skip_cache_tree_update;
	enum unpack_trees_reset_type reset;
	const char *prefix;
	const char *super_prefix;
	struct pathspec *pathspec;
	merge_fn_t fn;
 
	int head_idx;
 
	struct cache_entry *df_conflict_entry; /* output only */
	void *unpack_data;
 
	struct index_state *dst_index;
	struct index_state *src_index;
 
	struct checkout_metadata meta;
 
	struct unpack_trees_options_internal {
		unsigned int nontrivial_merge,
			     show_all_errors,
			     debug_unpack; /* used by read-tree debugging */
 
		int merge_size; /* used by read-tree debugging */
		int cache_bottom;
		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];
 
		struct index_state result;
 
		struct pattern_list *pl;
		struct dir_struct *dir;
	} internal;
};
 
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,
					    struct pattern_list *pl);
 
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