pathspec: allow querying for attributes
[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;
685b2925 10
a5e92abd
JH
11/*
12 * Given a string, return the gitattribute object that
13 * corresponds to it.
14 */
e810e063 15const struct git_attr *git_attr(const char *);
d0bfd026 16
515106fa 17/* Internal use */
a5e92abd
JH
18extern const char git_attr__true[];
19extern const char git_attr__false[];
515106fa
JH
20
21/* For public to check git_attr_check results */
a5e92abd
JH
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)
515106fa 25
a5e92abd 26/*
7bd18054 27 * Send one or more git_attr_check to git_check_attrs(), and
a5e92abd
JH
28 * each 'value' member tells what its value is.
29 * Unset one is returned as NULL.
30 */
7bd18054 31struct attr_check_item {
ec4d77aa 32 const struct git_attr *attr;
a5e92abd 33 const char *value;
d0bfd026
JH
34};
35
37293768
JH
36struct attr_check {
37 int nr;
38 int alloc;
39 struct attr_check_item *items;
685b2925
BW
40 int all_attrs_nr;
41 struct all_attrs_item *all_attrs;
dc81cf37 42 struct attr_stack *stack;
37293768
JH
43};
44
45extern struct attr_check *attr_check_alloc(void);
46extern struct attr_check *attr_check_initl(const char *, ...);
b0db7046 47extern struct attr_check *attr_check_dup(const struct attr_check *check);
37293768
JH
48
49extern struct attr_check_item *attr_check_append(struct attr_check *check,
50 const struct git_attr *attr);
51
52extern void attr_check_reset(struct attr_check *check);
53extern void attr_check_clear(struct attr_check *check);
54extern void attr_check_free(struct attr_check *check);
55
352404ac
MH
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 */
ec4d77aa 61extern const char *git_attr_name(const struct git_attr *);
352404ac 62
37293768 63extern int git_check_attr(const char *path, struct attr_check *check);
d0bfd026 64
ee548df3 65/*
7f864111
JH
66 * Retrieve all attributes that apply to the specified path.
67 * check holds the attributes and their values.
ee548df3 68 */
7f864111 69extern void git_all_attrs(const char *path, struct attr_check *check);
ee548df3 70
06f33c17
JH
71enum git_attr_direction {
72 GIT_ATTR_CHECKIN,
4191e80a 73 GIT_ATTR_CHECKOUT,
4b05548f 74 GIT_ATTR_INDEX
06f33c17 75};
f0dd0421
BW
76void git_attr_set_direction(enum git_attr_direction new_direction,
77 struct index_state *istate);
06f33c17 78
1a600b75
BW
79extern void attr_start(void);
80
d0bfd026 81#endif /* ATTR_H */