submodule, repack: migrate to git-sh-setup's say()
[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 **url;
15         int url_nr;
16         int url_alloc;
17
18         const char **push_refspec;
19         struct refspec *push;
20         int push_refspec_nr;
21         int push_refspec_alloc;
22
23         const char **fetch_refspec;
24         struct refspec *fetch;
25         int fetch_refspec_nr;
26         int fetch_refspec_alloc;
27
28         /*
29          * -1 to never fetch tags
30          * 0 to auto-follow tags on heuristic (default)
31          * 1 to always auto-follow tags
32          * 2 to always fetch tags
33          */
34         int fetch_tags;
35         int skip_default_update;
36         int mirror;
37
38         const char *receivepack;
39         const char *uploadpack;
40
41         /*
42          * for curl remotes only
43          */
44         char *http_proxy;
45 };
46
47 struct remote *remote_get(const char *name);
48 int remote_is_configured(const char *name);
49
50 typedef int each_remote_fn(struct remote *remote, void *priv);
51 int for_each_remote(each_remote_fn fn, void *priv);
52
53 int remote_has_url(struct remote *remote, const char *url);
54
55 struct refspec {
56         unsigned force : 1;
57         unsigned pattern : 1;
58         unsigned matching : 1;
59
60         char *src;
61         char *dst;
62 };
63
64 extern const struct refspec *tag_refspec;
65
66 struct ref *alloc_ref(const char *name);
67
68 struct ref *copy_ref_list(const struct ref *ref);
69
70 int check_ref_type(const struct ref *ref, int flags);
71
72 /*
73  * Frees the entire list and peers of elements.
74  */
75 void free_refs(struct ref *ref);
76
77 int resolve_remote_symref(struct ref *ref, struct ref *list);
78 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
79
80 /*
81  * Removes and frees any duplicate refs in the map.
82  */
83 void ref_remove_duplicates(struct ref *ref_map);
84
85 int valid_fetch_refspec(const char *refspec);
86 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
87
88 int match_refs(struct ref *src, struct ref **dst,
89                int nr_refspec, const char **refspec, int all);
90
91 /*
92  * Given a list of the remote refs and the specification of things to
93  * fetch, makes a (separate) list of the refs to fetch and the local
94  * refs to store into.
95  *
96  * *tail is the pointer to the tail pointer of the list of results
97  * beforehand, and will be set to the tail pointer of the list of
98  * results afterward.
99  *
100  * missing_ok is usually false, but when we are adding branch.$name.merge
101  * it is Ok if the branch is not at the remote anymore.
102  */
103 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
104                   struct ref ***tail, int missing_ok);
105
106 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
107
108 /*
109  * For the given remote, reads the refspec's src and sets the other fields.
110  */
111 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
112
113 struct branch {
114         const char *name;
115         const char *refname;
116
117         const char *remote_name;
118         struct remote *remote;
119
120         const char **merge_name;
121         struct refspec **merge;
122         int merge_nr;
123         int merge_alloc;
124 };
125
126 struct branch *branch_get(const char *name);
127
128 int branch_has_merge_config(struct branch *branch);
129 int branch_merge_matches(struct branch *, int n, const char *);
130
131 /* Flags to match_refs. */
132 enum match_refs_flags {
133         MATCH_REFS_NONE         = 0,
134         MATCH_REFS_ALL          = (1 << 0),
135         MATCH_REFS_MIRROR       = (1 << 1),
136 };
137
138 /* Reporting of tracking info */
139 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
140 int format_tracking_info(struct branch *branch, struct strbuf *sb);
141
142 struct ref *get_local_heads(void);
143 /*
144  * Find refs from a list which are likely to be pointed to by the given HEAD
145  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
146  * list of all candidate refs. If no match is found (or 'head' is NULL),
147  * returns NULL. All returns are newly allocated and should be freed.
148  */
149 struct ref *guess_remote_head(const struct ref *head,
150                               const struct ref *refs,
151                               int all);
152
153 #endif