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