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