remote.c: add command line option parser for "--force-with-lease"
[git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 #include "parse-options.h"
5
6 enum {
7         REMOTE_CONFIG,
8         REMOTE_REMOTES,
9         REMOTE_BRANCHES
10 };
11
12 struct remote {
13         const char *name;
14         int origin;
15
16         const char *foreign_vcs;
17
18         const char **url;
19         int url_nr;
20         int url_alloc;
21
22         const char **pushurl;
23         int pushurl_nr;
24         int pushurl_alloc;
25
26         const char **push_refspec;
27         struct refspec *push;
28         int push_refspec_nr;
29         int push_refspec_alloc;
30
31         const char **fetch_refspec;
32         struct refspec *fetch;
33         int fetch_refspec_nr;
34         int fetch_refspec_alloc;
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
46         const char *receivepack;
47         const char *uploadpack;
48
49         /*
50          * for curl remotes only
51          */
52         char *http_proxy;
53 };
54
55 struct remote *remote_get(const char *name);
56 struct remote *pushremote_get(const char *name);
57 int remote_is_configured(const char *name);
58
59 typedef int each_remote_fn(struct remote *remote, void *priv);
60 int for_each_remote(each_remote_fn fn, void *priv);
61
62 int remote_has_url(struct remote *remote, const char *url);
63
64 struct refspec {
65         unsigned force : 1;
66         unsigned pattern : 1;
67         unsigned matching : 1;
68         unsigned exact_sha1 : 1;
69
70         char *src;
71         char *dst;
72 };
73
74 extern const struct refspec *tag_refspec;
75
76 struct 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
120 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
121
122 struct ref *alloc_ref(const char *name);
123 struct ref *copy_ref(const struct ref *ref);
124 struct ref *copy_ref_list(const struct ref *ref);
125 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
126 int ref_compare_name(const void *, const void *);
127
128 int check_ref_type(const struct ref *ref, int flags);
129
130 /*
131  * Frees the entire list and peers of elements.
132  */
133 void free_refs(struct ref *ref);
134
135 struct extra_have_objects {
136         int nr, alloc;
137         unsigned char (*array)[20];
138 };
139 extern 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
143 int resolve_remote_symref(struct ref *ref, struct ref *list);
144 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
145
146 /*
147  * Removes and frees any duplicate refs in the map.
148  */
149 void ref_remove_duplicates(struct ref *ref_map);
150
151 int valid_fetch_refspec(const char *refspec);
152 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
153
154 void free_refspec(int nr_refspec, struct refspec *refspec);
155
156 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
157                      const char *name);
158
159 int match_push_refs(struct ref *src, struct ref **dst,
160                     int nr_refspec, const char **refspec, int all);
161 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
162         int force_update);
163
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.
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.
175  */
176 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
177                   struct ref ***tail, int missing_ok);
178
179 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
180
181 /*
182  * For the given remote, reads the refspec's src and sets the other fields.
183  */
184 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
185
186 struct 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;
196         int merge_alloc;
197 };
198
199 struct branch *branch_get(const char *name);
200
201 int branch_has_merge_config(struct branch *branch);
202 int branch_merge_matches(struct branch *, int n, const char *);
203
204 /* Flags to match_refs. */
205 enum match_refs_flags {
206         MATCH_REFS_NONE         = 0,
207         MATCH_REFS_ALL          = (1 << 0),
208         MATCH_REFS_MIRROR       = (1 << 1),
209         MATCH_REFS_PRUNE        = (1 << 2),
210         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
211 };
212
213 /* Reporting of tracking info */
214 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
215 int format_tracking_info(struct branch *branch, struct strbuf *sb);
216
217 struct ref *get_local_heads(void);
218 /*
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.
223  */
224 struct ref *guess_remote_head(const struct ref *head,
225                               const struct ref *refs,
226                               int all);
227
228 /* Return refs which no longer exist on remote */
229 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
230
231 /*
232  * Compare-and-swap
233  */
234 #define CAS_OPT_NAME "force-with-lease"
235
236 struct 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
247 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
248 extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
249 extern void clear_cas_option(struct push_cas_option *);
250
251 #endif