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