remote.h

   1 #ifndef REMOTE_H
   2 #define REMOTE_H
   3
   4 #include "parse-options.h"
   5
   6 enum {
   7         REMOTE_CONFIG,
   8         REMOTE_REMOTES,
   9         REMOTE_BRANCHES
  10 };
  11
  12 struct remote {
  13         const char *name;
  14         int origin;
  15
  16         const char *foreign_vcs;
  17
  18         const char **url;
  19         int url_nr;
  20         int url_alloc;
  21
  22         const char **pushurl;
  23         int pushurl_nr;
  24         int pushurl_alloc;
  25
  26         const char **push_refspec;
  27         struct refspec *push;
  28         int push_refspec_nr;
  29         int push_refspec_alloc;
  30
  31         const char **fetch_refspec;
  32         struct refspec *fetch;
  33         int fetch_refspec_nr;
  34         int fetch_refspec_alloc;
  35
  36         /*
  37          * -1 to never fetch tags
  38          * 0 to auto-follow tags on heuristic (default)
  39          * 1 to always auto-follow tags
  40          * 2 to always fetch tags
  41          */
  42         int fetch_tags;
  43         int skip_default_update;
  44         int mirror;
  45
  46         const char *receivepack;
  47         const char *uploadpack;
  48
  49         /*
  50          * for curl remotes only
  51          */
  52         char *http_proxy;
  53 };
  54
  55 struct remote *remote_get(const char *name);
  56 struct remote *pushremote_get(const char *name);
  57 int remote_is_configured(const char *name);
  58
  59 typedef int each_remote_fn(struct remote *remote, void *priv);
  60 int for_each_remote(each_remote_fn fn, void *priv);
  61
  62 int remote_has_url(struct remote *remote, const char *url);
  63
  64 struct refspec {
  65         unsigned force : 1;
  66         unsigned pattern : 1;
  67         unsigned matching : 1;
  68         unsigned exact_sha1 : 1;
  69
  70         char *src;
  71         char *dst;
  72 };
  73
  74 extern const struct refspec *tag_refspec;
  75
  76 struct ref {
  77         struct ref *next;
  78         unsigned char old_sha1[20];
  79         unsigned char new_sha1[20];
  80         unsigned char old_sha1_expect[20]; /* used by expect-old */
  81         char *symref;
  82         unsigned int
  83                 force:1,
  84                 forced_update:1,
  85                 expect_old_sha1:1,
  86                 expect_old_no_trackback:1,
  87                 deletion:1,
  88                 matched:1;
  89
  90         /*
  91          * Order is important here, as we write to FETCH_HEAD
  92          * in numeric order. And the default NOT_FOR_MERGE
  93          * should be 0, so that xcalloc'd structures get it
  94          * by default.
  95          */
  96         enum {
  97                 FETCH_HEAD_MERGE = -1,
  98                 FETCH_HEAD_NOT_FOR_MERGE = 0,
  99                 FETCH_HEAD_IGNORE = 1
 100         } fetch_head_status;
 101
 102         enum {
 103                 REF_STATUS_NONE = 0,
 104                 REF_STATUS_OK,
 105                 REF_STATUS_REJECT_NONFASTFORWARD,
 106                 REF_STATUS_REJECT_ALREADY_EXISTS,
 107                 REF_STATUS_REJECT_NODELETE,
 108                 REF_STATUS_REJECT_FETCH_FIRST,
 109                 REF_STATUS_REJECT_NEEDS_FORCE,
 110                 REF_STATUS_UPTODATE,
 111                 REF_STATUS_REMOTE_REJECT,
 112                 REF_STATUS_EXPECTING_REPORT
 113         } status;
 114         char *remote_status;
 115         struct ref *peer_ref; /* when renaming */
 116         char name[FLEX_ARRAY]; /* more */
 117 };
 118
 119 #define REF_NORMAL      (1u << 0)
 120 #define REF_HEADS       (1u << 1)
 121 #define REF_TAGS        (1u << 2)
 122
 123 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
 124
 125 struct ref *alloc_ref(const char *name);
 126 struct ref *copy_ref(const struct ref *ref);
 127 struct ref *copy_ref_list(const struct ref *ref);
 128 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
 129 int ref_compare_name(const void *, const void *);
 130
 131 int check_ref_type(const struct ref *ref, int flags);
 132
 133 /*
 134  * Frees the entire list and peers of elements.
 135  */
 136 void free_refs(struct ref *ref);
 137
 138 struct extra_have_objects {
 139         int nr, alloc;
 140         unsigned char (*array)[20];
 141 };
 142 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
 143                                      struct ref **list, unsigned int flags,
 144                                      struct extra_have_objects *);
 145
 146 int resolve_remote_symref(struct ref *ref, struct ref *list);
 147 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
 148
 149 /*
 150  * Removes and frees any duplicate refs in the map.
 151  */
 152 void ref_remove_duplicates(struct ref *ref_map);
 153
 154 int valid_fetch_refspec(const char *refspec);
 155 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
 156
 157 void free_refspec(int nr_refspec, struct refspec *refspec);
 158
 159 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
 160                      const char *name);
 161
 162 int match_push_refs(struct ref *src, struct ref **dst,
 163                     int nr_refspec, const char **refspec, int all);
 164 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
 165         int force_update);
 166
 167 /*
 168  * Given a list of the remote refs and the specification of things to
 169  * fetch, makes a (separate) list of the refs to fetch and the local
 170  * refs to store into.
 171  *
 172  * *tail is the pointer to the tail pointer of the list of results
 173  * beforehand, and will be set to the tail pointer of the list of
 174  * results afterward.
 175  *
 176  * missing_ok is usually false, but when we are adding branch.$name.merge
 177  * it is Ok if the branch is not at the remote anymore.
 178  */
 179 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
 180                   struct ref ***tail, int missing_ok);
 181
 182 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
 183
 184 /*
 185  * For the given remote, reads the refspec's src and sets the other fields.
 186  */
 187 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
 188
 189 struct branch {
 190         const char *name;
 191         const char *refname;
 192
 193         const char *remote_name;
 194         struct remote *remote;
 195
 196         const char **merge_name;
 197         struct refspec **merge;
 198         int merge_nr;
 199         int merge_alloc;
 200 };
 201
 202 struct branch *branch_get(const char *name);
 203
 204 int branch_has_merge_config(struct branch *branch);
 205 int branch_merge_matches(struct branch *, int n, const char *);
 206
 207 /* Flags to match_refs. */
 208 enum match_refs_flags {
 209         MATCH_REFS_NONE         = 0,
 210         MATCH_REFS_ALL          = (1 << 0),
 211         MATCH_REFS_MIRROR       = (1 << 1),
 212         MATCH_REFS_PRUNE        = (1 << 2),
 213         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
 214 };
 215
 216 /* Reporting of tracking info */
 217 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
 218 int format_tracking_info(struct branch *branch, struct strbuf *sb);
 219
 220 struct ref *get_local_heads(void);
 221 /*
 222  * Find refs from a list which are likely to be pointed to by the given HEAD
 223  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
 224  * list of all candidate refs. If no match is found (or 'head' is NULL),
 225  * returns NULL. All returns are newly allocated and should be freed.
 226  */
 227 struct ref *guess_remote_head(const struct ref *head,
 228                               const struct ref *refs,
 229                               int all);
 230
 231 /* Return refs which no longer exist on remote */
 232 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
 233
 234 /*
 235  * Compare-and-swap
 236  */
 237 #define CAS_OPT_NAME "force-with-lease"
 238
 239 struct push_cas_option {
 240         unsigned use_tracking_for_rest:1;
 241         struct push_cas {
 242                 unsigned char expect[20];
 243                 unsigned use_tracking:1;
 244                 char *refname;
 245         } *entry;
 246         int nr;
 247         int alloc;
 248 };
 249
 250 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
 251 extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
 252 extern void clear_cas_option(struct push_cas_option *);
 253
 254 extern int is_empty_cas(const struct push_cas_option *);
 255 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
 256
 257 #endif