Merge branch 'ss/t7401-modernize'
[git] / refspec.h
1 #ifndef REFSPEC_H
2 #define REFSPEC_H
3
4 #define TAG_REFSPEC "refs/tags/*:refs/tags/*"
5 extern const struct refspec_item *tag_refspec;
6
7 /**
8  * A struct refspec_item holds the parsed interpretation of a refspec.  If it will
9  * force updates (starts with a '+'), force is true.  If it is a pattern
10  * (sides end with '*') pattern is true.  src and dest are the two sides
11  * (including '*' characters if present); if there is only one side, it is src,
12  * and dst is NULL; if sides exist but are empty (i.e., the refspec either
13  * starts or ends with ':'), the corresponding side is "".
14  *
15  * remote_find_tracking(), given a remote and a struct refspec_item with either src
16  * or dst filled out, will fill out the other such that the result is in the
17  * "fetch" specification for the remote (note that this evaluates patterns and
18  * returns a single result).
19  */
20 struct refspec_item {
21         unsigned force : 1;
22         unsigned pattern : 1;
23         unsigned matching : 1;
24         unsigned exact_sha1 : 1;
25
26         char *src;
27         char *dst;
28 };
29
30 #define REFSPEC_FETCH 1
31 #define REFSPEC_PUSH 0
32
33 #define REFSPEC_INIT_FETCH { .fetch = REFSPEC_FETCH }
34 #define REFSPEC_INIT_PUSH { .fetch = REFSPEC_PUSH }
35
36 /**
37  * An array of strings can be parsed into a struct refspec using
38  * parse_fetch_refspec() or parse_push_refspec().
39  */
40 struct refspec {
41         struct refspec_item *items;
42         int alloc;
43         int nr;
44
45         const char **raw;
46         int raw_alloc;
47         int raw_nr;
48
49         int fetch;
50 };
51
52 int refspec_item_init(struct refspec_item *item, const char *refspec,
53                       int fetch);
54 void refspec_item_init_or_die(struct refspec_item *item, const char *refspec,
55                               int fetch);
56 void refspec_item_clear(struct refspec_item *item);
57 void refspec_init(struct refspec *rs, int fetch);
58 void refspec_append(struct refspec *rs, const char *refspec);
59 void refspec_appendn(struct refspec *rs, const char **refspecs, int nr);
60 void refspec_clear(struct refspec *rs);
61
62 int valid_fetch_refspec(const char *refspec);
63
64 struct strvec;
65 /*
66  * Determine what <prefix> values to pass to the peer in ref-prefix lines
67  * (see Documentation/technical/protocol-v2.txt).
68  */
69 void refspec_ref_prefixes(const struct refspec *rs,
70                           struct strvec *ref_prefixes);
71
72 #endif /* REFSPEC_H */