attr: change validity check for attribute names to use positive logic
[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
37293768
JH
32struct attr_check {
33 int nr;
34 int alloc;
35 struct attr_check_item *items;
36};
37
38extern struct attr_check *attr_check_alloc(void);
39extern struct attr_check *attr_check_initl(const char *, ...);
40
41extern struct attr_check_item *attr_check_append(struct attr_check *check,
42 const struct git_attr *attr);
43
44extern void attr_check_reset(struct attr_check *check);
45extern void attr_check_clear(struct attr_check *check);
46extern void attr_check_free(struct attr_check *check);
47
352404ac
MH
48/*
49 * Return the name of the attribute represented by the argument. The
50 * return value is a pointer to a null-delimited string that is part
51 * of the internal data structure; it should not be modified or freed.
52 */
ec4d77aa 53extern const char *git_attr_name(const struct git_attr *);
352404ac 54
37293768 55extern int git_check_attr(const char *path, struct attr_check *check);
d0bfd026 56
ee548df3 57/*
7f864111
JH
58 * Retrieve all attributes that apply to the specified path.
59 * check holds the attributes and their values.
ee548df3 60 */
7f864111 61extern void git_all_attrs(const char *path, struct attr_check *check);
ee548df3 62
06f33c17
JH
63enum git_attr_direction {
64 GIT_ATTR_CHECKIN,
4191e80a 65 GIT_ATTR_CHECKOUT,
4b05548f 66 GIT_ATTR_INDEX
06f33c17
JH
67};
68void git_attr_set_direction(enum git_attr_direction, struct index_state *);
69
d0bfd026 70#endif /* ATTR_H */