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