Merge branch 'nd/fetch-pack-shallow-fix'
[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 *alloc_ref(const char *name);
75 struct ref *copy_ref(const struct ref *ref);
76 struct ref *copy_ref_list(const struct ref *ref);
77 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
78 int ref_compare_name(const void *, const void *);
79
80 int check_ref_type(const struct ref *ref, int flags);
81
82 /*
83  * Frees the entire list and peers of elements.
84  */
85 void free_refs(struct ref *ref);
86
87 int resolve_remote_symref(struct ref *ref, struct ref *list);
88 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
89
90 /*
91  * Removes and frees any duplicate refs in the map.
92  */
93 void ref_remove_duplicates(struct ref *ref_map);
94
95 int valid_fetch_refspec(const char *refspec);
96 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
97
98 void free_refspec(int nr_refspec, struct refspec *refspec);
99
100 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
101                      const char *name);
102
103 int match_push_refs(struct ref *src, struct ref **dst,
104                     int nr_refspec, const char **refspec, int all);
105 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
106         int force_update);
107
108 /*
109  * Given a list of the remote refs and the specification of things to
110  * fetch, makes a (separate) list of the refs to fetch and the local
111  * refs to store into.
112  *
113  * *tail is the pointer to the tail pointer of the list of results
114  * beforehand, and will be set to the tail pointer of the list of
115  * results afterward.
116  *
117  * missing_ok is usually false, but when we are adding branch.$name.merge
118  * it is Ok if the branch is not at the remote anymore.
119  */
120 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
121                   struct ref ***tail, int missing_ok);
122
123 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
124
125 /*
126  * For the given remote, reads the refspec's src and sets the other fields.
127  */
128 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
129
130 struct branch {
131         const char *name;
132         const char *refname;
133
134         const char *remote_name;
135         struct remote *remote;
136
137         const char **merge_name;
138         struct refspec **merge;
139         int merge_nr;
140         int merge_alloc;
141 };
142
143 struct branch *branch_get(const char *name);
144
145 int branch_has_merge_config(struct branch *branch);
146 int branch_merge_matches(struct branch *, int n, const char *);
147
148 /* Flags to match_refs. */
149 enum match_refs_flags {
150         MATCH_REFS_NONE         = 0,
151         MATCH_REFS_ALL          = (1 << 0),
152         MATCH_REFS_MIRROR       = (1 << 1),
153         MATCH_REFS_PRUNE        = (1 << 2),
154         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
155 };
156
157 /* Reporting of tracking info */
158 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
159 int format_tracking_info(struct branch *branch, struct strbuf *sb);
160
161 struct ref *get_local_heads(void);
162 /*
163  * Find refs from a list which are likely to be pointed to by the given HEAD
164  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
165  * list of all candidate refs. If no match is found (or 'head' is NULL),
166  * returns NULL. All returns are newly allocated and should be freed.
167  */
168 struct ref *guess_remote_head(const struct ref *head,
169                               const struct ref *refs,
170                               int all);
171
172 /* Return refs which no longer exist on remote */
173 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
174
175 #endif