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