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