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