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