Merge branch 'jc/git-gui-has-maintainer'
[git/git.git] / attr.h
CommitLineData
d0bfd026
JH
1#ifndef ATTR_H
2#define ATTR_H
3
7a400a2c
NTND
4struct index_state;
5
d0bfd026
JH
6/* An attribute is a pointer to this opaque structure */
7struct git_attr;
8
dc81cf37 9/* opaque structures used internally for attribute collection */
685b2925 10struct all_attrs_item;
dc81cf37 11struct attr_stack;
ef3ca954 12struct index_state;
685b2925 13
a5e92abd
JH
14/*
15 * Given a string, return the gitattribute object that
16 * corresponds to it.
17 */
e810e063 18const struct git_attr *git_attr(const char *);
d0bfd026 19
515106fa 20/* Internal use */
a5e92abd
JH
21extern const char git_attr__true[];
22extern const char git_attr__false[];
515106fa
JH
23
24/* For public to check git_attr_check results */
a5e92abd
JH
25#define ATTR_TRUE(v) ((v) == git_attr__true)
26#define ATTR_FALSE(v) ((v) == git_attr__false)
27#define ATTR_UNSET(v) ((v) == NULL)
515106fa 28
a5e92abd 29/*
7bd18054 30 * Send one or more git_attr_check to git_check_attrs(), and
a5e92abd
JH
31 * each 'value' member tells what its value is.
32 * Unset one is returned as NULL.
33 */
7bd18054 34struct attr_check_item {
ec4d77aa 35 const struct git_attr *attr;
a5e92abd 36 const char *value;
d0bfd026
JH
37};
38
37293768
JH
39struct attr_check {
40 int nr;
41 int alloc;
42 struct attr_check_item *items;
685b2925
BW
43 int all_attrs_nr;
44 struct all_attrs_item *all_attrs;
dc81cf37 45 struct attr_stack *stack;
37293768
JH
46};
47
c30f2e20
NTND
48struct attr_check *attr_check_alloc(void);
49struct attr_check *attr_check_initl(const char *, ...);
50struct attr_check *attr_check_dup(const struct attr_check *check);
37293768 51
c30f2e20
NTND
52struct attr_check_item *attr_check_append(struct attr_check *check,
53 const struct git_attr *attr);
37293768 54
c30f2e20
NTND
55void attr_check_reset(struct attr_check *check);
56void attr_check_clear(struct attr_check *check);
57void attr_check_free(struct attr_check *check);
37293768 58
352404ac
MH
59/*
60 * Return the name of the attribute represented by the argument. The
61 * return value is a pointer to a null-delimited string that is part
62 * of the internal data structure; it should not be modified or freed.
63 */
c30f2e20 64const char *git_attr_name(const struct git_attr *);
352404ac 65
d64324cb
TB
66void git_check_attr(const struct index_state *istate,
67 const char *path, struct attr_check *check);
d0bfd026 68
ee548df3 69/*
7f864111
JH
70 * Retrieve all attributes that apply to the specified path.
71 * check holds the attributes and their values.
ee548df3 72 */
7a400a2c
NTND
73void git_all_attrs(const struct index_state *istate,
74 const char *path, struct attr_check *check);
ee548df3 75
06f33c17
JH
76enum git_attr_direction {
77 GIT_ATTR_CHECKIN,
4191e80a 78 GIT_ATTR_CHECKOUT,
4b05548f 79 GIT_ATTR_INDEX
06f33c17 80};
c4500e25 81void git_attr_set_direction(enum git_attr_direction new_direction);
06f33c17 82
c30f2e20 83void attr_start(void);
1a600b75 84
d0bfd026 85#endif /* ATTR_H */