refspec: rename struct refspec to struct refspec_item
[git/git.git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 #include "parse-options.h"
5 #include "hashmap.h"
6
7 enum {
8 REMOTE_UNCONFIGURED = 0,
9 REMOTE_CONFIG,
10 REMOTE_REMOTES,
11 REMOTE_BRANCHES
12 };
13
14 struct remote {
15 struct hashmap_entry ent; /* must be first */
16
17 const char *name;
18 int origin, configured_in_repo;
19
20 const char *foreign_vcs;
21
22 const char **url;
23 int url_nr;
24 int url_alloc;
25
26 const char **pushurl;
27 int pushurl_nr;
28 int pushurl_alloc;
29
30 const char **push_refspec;
31 struct refspec_item *push;
32 int push_refspec_nr;
33 int push_refspec_alloc;
34
35 const char **fetch_refspec;
36 struct refspec_item *fetch;
37 int fetch_refspec_nr;
38 int fetch_refspec_alloc;
39
40 /*
41 * -1 to never fetch tags
42 * 0 to auto-follow tags on heuristic (default)
43 * 1 to always auto-follow tags
44 * 2 to always fetch tags
45 */
46 int fetch_tags;
47 int skip_default_update;
48 int mirror;
49 int prune;
50 int prune_tags;
51
52 const char *receivepack;
53 const char *uploadpack;
54
55 /*
56 * for curl remotes only
57 */
58 char *http_proxy;
59 char *http_proxy_authmethod;
60 };
61
62 struct remote *remote_get(const char *name);
63 struct remote *pushremote_get(const char *name);
64 int remote_is_configured(struct remote *remote, int in_repo);
65
66 typedef int each_remote_fn(struct remote *remote, void *priv);
67 int for_each_remote(each_remote_fn fn, void *priv);
68
69 int remote_has_url(struct remote *remote, const char *url);
70
71 struct ref {
72 struct ref *next;
73 struct object_id old_oid;
74 struct object_id new_oid;
75 struct object_id old_oid_expect; /* used by expect-old */
76 char *symref;
77 unsigned int
78 force:1,
79 forced_update:1,
80 expect_old_sha1:1,
81 deletion:1;
82
83 enum {
84 REF_NOT_MATCHED = 0, /* initial value */
85 REF_MATCHED,
86 REF_UNADVERTISED_NOT_ALLOWED
87 } match_status;
88
89 /*
90 * Order is important here, as we write to FETCH_HEAD
91 * in numeric order. And the default NOT_FOR_MERGE
92 * should be 0, so that xcalloc'd structures get it
93 * by default.
94 */
95 enum {
96 FETCH_HEAD_MERGE = -1,
97 FETCH_HEAD_NOT_FOR_MERGE = 0,
98 FETCH_HEAD_IGNORE = 1
99 } fetch_head_status;
100
101 enum {
102 REF_STATUS_NONE = 0,
103 REF_STATUS_OK,
104 REF_STATUS_REJECT_NONFASTFORWARD,
105 REF_STATUS_REJECT_ALREADY_EXISTS,
106 REF_STATUS_REJECT_NODELETE,
107 REF_STATUS_REJECT_FETCH_FIRST,
108 REF_STATUS_REJECT_NEEDS_FORCE,
109 REF_STATUS_REJECT_STALE,
110 REF_STATUS_REJECT_SHALLOW,
111 REF_STATUS_UPTODATE,
112 REF_STATUS_REMOTE_REJECT,
113 REF_STATUS_EXPECTING_REPORT,
114 REF_STATUS_ATOMIC_PUSH_FAILED
115 } status;
116 char *remote_status;
117 struct ref *peer_ref; /* when renaming */
118 char name[FLEX_ARRAY]; /* more */
119 };
120
121 #define REF_NORMAL (1u << 0)
122 #define REF_HEADS (1u << 1)
123 #define REF_TAGS (1u << 2)
124
125 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
126
127 struct ref *alloc_ref(const char *name);
128 struct ref *copy_ref(const struct ref *ref);
129 struct ref *copy_ref_list(const struct ref *ref);
130 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
131 extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
132 int ref_compare_name(const void *, const void *);
133
134 int check_ref_type(const struct ref *ref, int flags);
135
136 /*
137 * Frees the entire list and peers of elements.
138 */
139 void free_refs(struct ref *ref);
140
141 struct oid_array;
142 struct packet_reader;
143 struct argv_array;
144 extern struct ref **get_remote_heads(struct packet_reader *reader,
145 struct ref **list, unsigned int flags,
146 struct oid_array *extra_have,
147 struct oid_array *shallow_points);
148
149 /* Used for protocol v2 in order to retrieve refs from a remote */
150 extern struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
151 struct ref **list, int for_push,
152 const struct argv_array *ref_prefixes);
153
154 int resolve_remote_symref(struct ref *ref, struct ref *list);
155 int ref_newer(const struct object_id *new_oid, const struct object_id *old_oid);
156
157 /*
158 * Remove and free all but the first of any entries in the input list
159 * that map the same remote reference to the same local reference. If
160 * there are two entries that map different remote references to the
161 * same local reference, emit an error message and die. Return a
162 * pointer to the head of the resulting list.
163 */
164 struct ref *ref_remove_duplicates(struct ref *ref_map);
165
166 extern int query_refspecs(struct refspec_item *specs, int nr, struct refspec_item *query);
167 char *apply_refspecs(struct refspec_item *refspecs, int nr_refspec,
168 const char *name);
169
170 int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
171 int match_push_refs(struct ref *src, struct ref **dst,
172 int nr_refspec, const char **refspec, int all);
173 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
174 int force_update);
175
176 /*
177 * Given a list of the remote refs and the specification of things to
178 * fetch, makes a (separate) list of the refs to fetch and the local
179 * refs to store into.
180 *
181 * *tail is the pointer to the tail pointer of the list of results
182 * beforehand, and will be set to the tail pointer of the list of
183 * results afterward.
184 *
185 * missing_ok is usually false, but when we are adding branch.$name.merge
186 * it is Ok if the branch is not at the remote anymore.
187 */
188 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
189 struct ref ***tail, int missing_ok);
190
191 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
192
193 /*
194 * For the given remote, reads the refspec's src and sets the other fields.
195 */
196 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
197
198 struct branch {
199 const char *name;
200 const char *refname;
201
202 const char *remote_name;
203 const char *pushremote_name;
204
205 const char **merge_name;
206 struct refspec_item **merge;
207 int merge_nr;
208 int merge_alloc;
209
210 const char *push_tracking_ref;
211 };
212
213 struct branch *branch_get(const char *name);
214 const char *remote_for_branch(struct branch *branch, int *explicit);
215 const char *pushremote_for_branch(struct branch *branch, int *explicit);
216 const char *remote_ref_for_branch(struct branch *branch, int for_push,
217 int *explicit);
218
219 int branch_has_merge_config(struct branch *branch);
220 int branch_merge_matches(struct branch *, int n, const char *);
221
222 /**
223 * Return the fully-qualified refname of the tracking branch for `branch`.
224 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
225 * upstream is defined.
226 *
227 * If `err` is not NULL and no upstream is defined, a more specific error
228 * message is recorded there (if the function does not return NULL, then
229 * `err` is not touched).
230 */
231 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
232
233 /**
234 * Return the tracking branch that corresponds to the ref we would push to
235 * given a bare `git push` while `branch` is checked out.
236 *
237 * The return value and `err` conventions match those of `branch_get_upstream`.
238 */
239 const char *branch_get_push(struct branch *branch, struct strbuf *err);
240
241 /* Flags to match_refs. */
242 enum match_refs_flags {
243 MATCH_REFS_NONE = 0,
244 MATCH_REFS_ALL = (1 << 0),
245 MATCH_REFS_MIRROR = (1 << 1),
246 MATCH_REFS_PRUNE = (1 << 2),
247 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
248 };
249
250 /* Flags for --ahead-behind option. */
251 enum ahead_behind_flags {
252 AHEAD_BEHIND_UNSPECIFIED = -1,
253 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
254 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
255 };
256
257 /* Reporting of tracking info */
258 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
259 const char **upstream_name, enum ahead_behind_flags abf);
260 int format_tracking_info(struct branch *branch, struct strbuf *sb,
261 enum ahead_behind_flags abf);
262
263 struct ref *get_local_heads(void);
264 /*
265 * Find refs from a list which are likely to be pointed to by the given HEAD
266 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
267 * list of all candidate refs. If no match is found (or 'head' is NULL),
268 * returns NULL. All returns are newly allocated and should be freed.
269 */
270 struct ref *guess_remote_head(const struct ref *head,
271 const struct ref *refs,
272 int all);
273
274 /* Return refs which no longer exist on remote */
275 struct ref *get_stale_heads(struct refspec_item *refs, int ref_count, struct ref *fetch_map);
276
277 /*
278 * Compare-and-swap
279 */
280 #define CAS_OPT_NAME "force-with-lease"
281
282 struct push_cas_option {
283 unsigned use_tracking_for_rest:1;
284 struct push_cas {
285 struct object_id expect;
286 unsigned use_tracking:1;
287 char *refname;
288 } *entry;
289 int nr;
290 int alloc;
291 };
292
293 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
294
295 extern int is_empty_cas(const struct push_cas_option *);
296 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
297
298 void add_prune_tags_to_fetch_refspec(struct remote *remote);
299
300 #endif