builtin/push.c: use OPT_BOOL, not OPT_BOOLEAN
[git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 enum {
5         REMOTE_CONFIG,
6         REMOTE_REMOTES,
7         REMOTE_BRANCHES
8 };
9
10 struct remote {
11         const char *name;
12         int origin;
13
14         const char *foreign_vcs;
15
16         const char **url;
17         int url_nr;
18         int url_alloc;
19
20         const char **pushurl;
21         int pushurl_nr;
22         int pushurl_alloc;
23
24         const char **push_refspec;
25         struct refspec *push;
26         int push_refspec_nr;
27         int push_refspec_alloc;
28
29         const char **fetch_refspec;
30         struct refspec *fetch;
31         int fetch_refspec_nr;
32         int fetch_refspec_alloc;
33
34         /*
35          * -1 to never fetch tags
36          * 0 to auto-follow tags on heuristic (default)
37          * 1 to always auto-follow tags
38          * 2 to always fetch tags
39          */
40         int fetch_tags;
41         int skip_default_update;
42         int mirror;
43
44         const char *receivepack;
45         const char *uploadpack;
46
47         /*
48          * for curl remotes only
49          */
50         char *http_proxy;
51 };
52
53 struct remote *remote_get(const char *name);
54 struct remote *pushremote_get(const char *name);
55 int remote_is_configured(const char *name);
56
57 typedef int each_remote_fn(struct remote *remote, void *priv);
58 int for_each_remote(each_remote_fn fn, void *priv);
59
60 int remote_has_url(struct remote *remote, const char *url);
61
62 struct refspec {
63         unsigned force : 1;
64         unsigned pattern : 1;
65         unsigned matching : 1;
66         unsigned exact_sha1 : 1;
67
68         char *src;
69         char *dst;
70 };
71
72 extern const struct refspec *tag_refspec;
73
74 struct ref {
75         struct ref *next;
76         unsigned char old_sha1[20];
77         unsigned char new_sha1[20];
78         char *symref;
79         unsigned int
80                 force:1,
81                 forced_update:1,
82                 deletion:1,
83                 matched:1;
84
85         /*
86          * Order is important here, as we write to FETCH_HEAD
87          * in numeric order. And the default NOT_FOR_MERGE
88          * should be 0, so that xcalloc'd structures get it
89          * by default.
90          */
91         enum {
92                 FETCH_HEAD_MERGE = -1,
93                 FETCH_HEAD_NOT_FOR_MERGE = 0,
94                 FETCH_HEAD_IGNORE = 1
95         } fetch_head_status;
96
97         enum {
98                 REF_STATUS_NONE = 0,
99                 REF_STATUS_OK,
100                 REF_STATUS_REJECT_NONFASTFORWARD,
101                 REF_STATUS_REJECT_ALREADY_EXISTS,
102                 REF_STATUS_REJECT_NODELETE,
103                 REF_STATUS_REJECT_FETCH_FIRST,
104                 REF_STATUS_REJECT_NEEDS_FORCE,
105                 REF_STATUS_UPTODATE,
106                 REF_STATUS_REMOTE_REJECT,
107                 REF_STATUS_EXPECTING_REPORT
108         } status;
109         char *remote_status;
110         struct ref *peer_ref; /* when renaming */
111         char name[FLEX_ARRAY]; /* more */
112 };
113
114 #define REF_NORMAL      (1u << 0)
115 #define REF_HEADS       (1u << 1)
116 #define REF_TAGS        (1u << 2)
117
118 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
119
120 struct ref *alloc_ref(const char *name);
121 struct ref *copy_ref(const struct ref *ref);
122 struct ref *copy_ref_list(const struct ref *ref);
123 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
124 int ref_compare_name(const void *, const void *);
125
126 int check_ref_type(const struct ref *ref, int flags);
127
128 /*
129  * Frees the entire list and peers of elements.
130  */
131 void free_refs(struct ref *ref);
132
133 struct extra_have_objects {
134         int nr, alloc;
135         unsigned char (*array)[20];
136 };
137 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
138                                      struct ref **list, unsigned int flags,
139                                      struct extra_have_objects *);
140
141 int resolve_remote_symref(struct ref *ref, struct ref *list);
142 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
143
144 /*
145  * Removes and frees any duplicate refs in the map.
146  */
147 void ref_remove_duplicates(struct ref *ref_map);
148
149 int valid_fetch_refspec(const char *refspec);
150 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
151
152 void free_refspec(int nr_refspec, struct refspec *refspec);
153
154 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
155                      const char *name);
156
157 int match_push_refs(struct ref *src, struct ref **dst,
158                     int nr_refspec, const char **refspec, int all);
159 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
160         int force_update);
161
162 /*
163  * Given a list of the remote refs and the specification of things to
164  * fetch, makes a (separate) list of the refs to fetch and the local
165  * refs to store into.
166  *
167  * *tail is the pointer to the tail pointer of the list of results
168  * beforehand, and will be set to the tail pointer of the list of
169  * results afterward.
170  *
171  * missing_ok is usually false, but when we are adding branch.$name.merge
172  * it is Ok if the branch is not at the remote anymore.
173  */
174 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
175                   struct ref ***tail, int missing_ok);
176
177 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
178
179 /*
180  * For the given remote, reads the refspec's src and sets the other fields.
181  */
182 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
183
184 struct branch {
185         const char *name;
186         const char *refname;
187
188         const char *remote_name;
189         struct remote *remote;
190
191         const char **merge_name;
192         struct refspec **merge;
193         int merge_nr;
194         int merge_alloc;
195 };
196
197 struct branch *branch_get(const char *name);
198
199 int branch_has_merge_config(struct branch *branch);
200 int branch_merge_matches(struct branch *, int n, const char *);
201
202 /* Flags to match_refs. */
203 enum match_refs_flags {
204         MATCH_REFS_NONE         = 0,
205         MATCH_REFS_ALL          = (1 << 0),
206         MATCH_REFS_MIRROR       = (1 << 1),
207         MATCH_REFS_PRUNE        = (1 << 2),
208         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
209 };
210
211 /* Reporting of tracking info */
212 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
213 int format_tracking_info(struct branch *branch, struct strbuf *sb);
214
215 struct ref *get_local_heads(void);
216 /*
217  * Find refs from a list which are likely to be pointed to by the given HEAD
218  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
219  * list of all candidate refs. If no match is found (or 'head' is NULL),
220  * returns NULL. All returns are newly allocated and should be freed.
221  */
222 struct ref *guess_remote_head(const struct ref *head,
223                               const struct ref *refs,
224                               int all);
225
226 /* Return refs which no longer exist on remote */
227 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
228
229 #endif