attr: rename function and struct related to checking 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
a5e92abd
JH
7/*
8 * Given a string, return the gitattribute object that
9 * corresponds to it.
10 */
7fb0eaa2 11struct git_attr *git_attr(const char *);
d0bfd026 12
515106fa 13/* Internal use */
a5e92abd
JH
14extern const char git_attr__true[];
15extern const char git_attr__false[];
515106fa
JH
16
17/* For public to check git_attr_check results */
a5e92abd
JH
18#define ATTR_TRUE(v) ((v) == git_attr__true)
19#define ATTR_FALSE(v) ((v) == git_attr__false)
20#define ATTR_UNSET(v) ((v) == NULL)
515106fa 21
a5e92abd 22/*
7bd18054 23 * Send one or more git_attr_check to git_check_attrs(), and
a5e92abd
JH
24 * each 'value' member tells what its value is.
25 * Unset one is returned as NULL.
26 */
7bd18054 27struct attr_check_item {
ec4d77aa 28 const struct git_attr *attr;
a5e92abd 29 const char *value;
d0bfd026
JH
30};
31
352404ac
MH
32/*
33 * Return the name of the attribute represented by the argument. The
34 * return value is a pointer to a null-delimited string that is part
35 * of the internal data structure; it should not be modified or freed.
36 */
ec4d77aa 37extern const char *git_attr_name(const struct git_attr *);
352404ac 38
7bd18054 39int git_check_attrs(const char *path, int, struct attr_check_item *);
d0bfd026 40
ee548df3
MH
41/*
42 * Retrieve all attributes that apply to the specified path. *num
65c2b2b5 43 * will be set to the number of attributes on the path; **check will
ee548df3
MH
44 * be set to point at a newly-allocated array of git_attr_check
45 * objects describing the attributes and their values. *check must be
46 * free()ed by the caller.
47 */
7bd18054 48int git_all_attrs(const char *path, int *num, struct attr_check_item **check);
ee548df3 49
06f33c17
JH
50enum git_attr_direction {
51 GIT_ATTR_CHECKIN,
4191e80a 52 GIT_ATTR_CHECKOUT,
4b05548f 53 GIT_ATTR_INDEX
06f33c17
JH
54};
55void git_attr_set_direction(enum git_attr_direction, struct index_state *);
56
d0bfd026 57#endif /* ATTR_H */