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