remote.c: add command line option parser for "--force-with-lease"
[git/git.git] / remote.h
CommitLineData
5751f490
DB
1#ifndef REMOTE_H
2#define REMOTE_H
3
28f5d176
JH
4#include "parse-options.h"
5
89cf4c70
MV
6enum {
7 REMOTE_CONFIG,
8 REMOTE_REMOTES,
9 REMOTE_BRANCHES
10};
11
5751f490
DB
12struct remote {
13 const char *name;
89cf4c70 14 int origin;
5751f490 15
c578f51d
DB
16 const char *foreign_vcs;
17
28b91f8a
SP
18 const char **url;
19 int url_nr;
2d31347b 20 int url_alloc;
5751f490 21
20346234
MG
22 const char **pushurl;
23 int pushurl_nr;
24 int pushurl_alloc;
25
5751f490 26 const char **push_refspec;
6b62816c 27 struct refspec *push;
5751f490 28 int push_refspec_nr;
2d31347b 29 int push_refspec_alloc;
5751f490 30
5d46c9d4
DB
31 const char **fetch_refspec;
32 struct refspec *fetch;
33 int fetch_refspec_nr;
2d31347b 34 int fetch_refspec_alloc;
5d46c9d4 35
d71ab174
DB
36 /*
37 * -1 to never fetch tags
38 * 0 to auto-follow tags on heuristic (default)
39 * 1 to always auto-follow tags
40 * 2 to always fetch tags
41 */
42 int fetch_tags;
211c8968 43 int skip_default_update;
84bb2dfd 44 int mirror;
d71ab174 45
5751f490 46 const char *receivepack;
0012ba21 47 const char *uploadpack;
14c98218
SV
48
49 /*
50 * for curl remotes only
51 */
52 char *http_proxy;
5751f490
DB
53};
54
55struct remote *remote_get(const char *name);
f24f715e 56struct remote *pushremote_get(const char *name);
9a23ba33 57int remote_is_configured(const char *name);
5751f490 58
b42f6927
JS
59typedef int each_remote_fn(struct remote *remote, void *priv);
60int for_each_remote(each_remote_fn fn, void *priv);
61
28b91f8a 62int remote_has_url(struct remote *remote, const char *url);
5d46c9d4 63
6b62816c
DB
64struct refspec {
65 unsigned force : 1;
66 unsigned pattern : 1;
a83619d6 67 unsigned matching : 1;
6e7b66ee 68 unsigned exact_sha1 : 1;
6b62816c 69
b42f6927 70 char *src;
6b62816c
DB
71 char *dst;
72};
73
e0aaa29f
DB
74extern const struct refspec *tag_refspec;
75
47a59185
JH
76struct ref {
77 struct ref *next;
78 unsigned char old_sha1[20];
79 unsigned char new_sha1[20];
80 char *symref;
81 unsigned int
82 force:1,
83 forced_update:1,
84 deletion:1,
85 matched:1;
86
87 /*
88 * Order is important here, as we write to FETCH_HEAD
89 * in numeric order. And the default NOT_FOR_MERGE
90 * should be 0, so that xcalloc'd structures get it
91 * by default.
92 */
93 enum {
94 FETCH_HEAD_MERGE = -1,
95 FETCH_HEAD_NOT_FOR_MERGE = 0,
96 FETCH_HEAD_IGNORE = 1
97 } fetch_head_status;
98
99 enum {
100 REF_STATUS_NONE = 0,
101 REF_STATUS_OK,
102 REF_STATUS_REJECT_NONFASTFORWARD,
103 REF_STATUS_REJECT_ALREADY_EXISTS,
104 REF_STATUS_REJECT_NODELETE,
105 REF_STATUS_REJECT_FETCH_FIRST,
106 REF_STATUS_REJECT_NEEDS_FORCE,
107 REF_STATUS_UPTODATE,
108 REF_STATUS_REMOTE_REJECT,
109 REF_STATUS_EXPECTING_REPORT
110 } status;
111 char *remote_status;
112 struct ref *peer_ref; /* when renaming */
113 char name[FLEX_ARRAY]; /* more */
114};
115
116#define REF_NORMAL (1u << 0)
117#define REF_HEADS (1u << 1)
118#define REF_TAGS (1u << 2)
119
120extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
121
59c69c0c 122struct ref *alloc_ref(const char *name);
59a57757 123struct ref *copy_ref(const struct ref *ref);
4577370e 124struct ref *copy_ref_list(const struct ref *ref);
ed81c76b
JK
125void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
126int ref_compare_name(const void *, const void *);
4577370e
DB
127
128int check_ref_type(const struct ref *ref, int flags);
129
dfd255dd
DB
130/*
131 * Frees the entire list and peers of elements.
132 */
133void free_refs(struct ref *ref);
134
47a59185
JH
135struct extra_have_objects {
136 int nr, alloc;
137 unsigned char (*array)[20];
138};
139extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
140 struct ref **list, unsigned int flags,
141 struct extra_have_objects *);
142
be885d96 143int resolve_remote_symref(struct ref *ref, struct ref *list);
ec8452d5 144int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
be885d96 145
2467a4fa
DB
146/*
147 * Removes and frees any duplicate refs in the map.
148 */
149void ref_remove_duplicates(struct ref *ref_map);
150
24b6177e 151int valid_fetch_refspec(const char *refspec);
46220ca1 152struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
d71ab174 153
72ff8943
DB
154void free_refspec(int nr_refspec, struct refspec *refspec);
155
156char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
157 const char *name);
158
29753cdd
JH
159int match_push_refs(struct ref *src, struct ref **dst,
160 int nr_refspec, const char **refspec, int all);
20e8b465
TRC
161void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
162 int force_update);
6b62816c 163
d71ab174
DB
164/*
165 * Given a list of the remote refs and the specification of things to
166 * fetch, makes a (separate) list of the refs to fetch and the local
167 * refs to store into.
168 *
169 * *tail is the pointer to the tail pointer of the list of results
170 * beforehand, and will be set to the tail pointer of the list of
171 * results afterward.
9ad7c5ae
JH
172 *
173 * missing_ok is usually false, but when we are adding branch.$name.merge
174 * it is Ok if the branch is not at the remote anymore.
d71ab174 175 */
4577370e 176int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
9ad7c5ae 177 struct ref ***tail, int missing_ok);
d71ab174 178
4577370e 179struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
d71ab174 180
5d46c9d4
DB
181/*
182 * For the given remote, reads the refspec's src and sets the other fields.
183 */
184int remote_find_tracking(struct remote *remote, struct refspec *refspec);
185
cf818348
DB
186struct branch {
187 const char *name;
188 const char *refname;
189
190 const char *remote_name;
191 struct remote *remote;
192
193 const char **merge_name;
194 struct refspec **merge;
195 int merge_nr;
2d31347b 196 int merge_alloc;
cf818348
DB
197};
198
199struct branch *branch_get(const char *name);
200
201int branch_has_merge_config(struct branch *branch);
85682c19 202int branch_merge_matches(struct branch *, int n, const char *);
cf818348 203
28b9d6e5
AW
204/* Flags to match_refs. */
205enum match_refs_flags {
206 MATCH_REFS_NONE = 0,
207 MATCH_REFS_ALL = (1 << 0),
6ddba5e2 208 MATCH_REFS_MIRROR = (1 << 1),
c2aba155
JH
209 MATCH_REFS_PRUNE = (1 << 2),
210 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
28b9d6e5
AW
211};
212
6d21bf96
JH
213/* Reporting of tracking info */
214int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
215int format_tracking_info(struct branch *branch, struct strbuf *sb);
216
454e2025 217struct ref *get_local_heads(void);
8ef51733 218/*
4229f1fa
JS
219 * Find refs from a list which are likely to be pointed to by the given HEAD
220 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
221 * list of all candidate refs. If no match is found (or 'head' is NULL),
222 * returns NULL. All returns are newly allocated and should be freed.
8ef51733 223 */
4229f1fa
JS
224struct ref *guess_remote_head(const struct ref *head,
225 const struct ref *refs,
226 int all);
227
f2ef6075 228/* Return refs which no longer exist on remote */
ed43de6e 229struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
f2ef6075 230
28f5d176
JH
231/*
232 * Compare-and-swap
233 */
234#define CAS_OPT_NAME "force-with-lease"
235
236struct push_cas_option {
237 unsigned use_tracking_for_rest:1;
238 struct push_cas {
239 unsigned char expect[20];
240 unsigned use_tracking:1;
241 char *refname;
242 } *entry;
243 int nr;
244 int alloc;
245};
246
247extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
248extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
249extern void clear_cas_option(struct push_cas_option *);
250
5751f490 251#endif