blob: 8b08d33af84ebbb376a69d85f3db6c03eeb78a63 [file] [log] [blame]
Junio C Hamanod0bfd022007-04-12 01:07:32 -07001#ifndef ATTR_H
2#define ATTR_H
3
4/* An attribute is a pointer to this opaque structure */
5struct git_attr;
6
Junio C Hamanoa5e92ab2007-04-18 16:16:37 -07007/*
8 * Given a string, return the gitattribute object that
9 * corresponds to it.
10 */
Junio C Hamano7fb0eaa2010-01-16 20:39:59 -080011struct git_attr *git_attr(const char *);
Junio C Hamanod0bfd022007-04-12 01:07:32 -070012
Junio C Hamano515106f2007-04-16 21:33:31 -070013/* Internal use */
Junio C Hamanoa5e92ab2007-04-18 16:16:37 -070014extern const char git_attr__true[];
15extern const char git_attr__false[];
Junio C Hamano515106f2007-04-16 21:33:31 -070016
17/* For public to check git_attr_check results */
Junio C Hamanoa5e92ab2007-04-18 16:16:37 -070018#define ATTR_TRUE(v) ((v) == git_attr__true)
19#define ATTR_FALSE(v) ((v) == git_attr__false)
20#define ATTR_UNSET(v) ((v) == NULL)
Junio C Hamano515106f2007-04-16 21:33:31 -070021
Junio C Hamanoa5e92ab2007-04-18 16:16:37 -070022/*
Michael Haggertyd932f4e2011-08-04 06:36:33 +020023 * Send one or more git_attr_check to git_check_attr(), and
Junio C Hamanoa5e92ab2007-04-18 16:16:37 -070024 * each 'value' member tells what its value is.
25 * Unset one is returned as NULL.
26 */
Junio C Hamanod0bfd022007-04-12 01:07:32 -070027struct git_attr_check {
28 struct git_attr *attr;
Junio C Hamanoa5e92ab2007-04-18 16:16:37 -070029 const char *value;
Junio C Hamanod0bfd022007-04-12 01:07:32 -070030};
31
Michael Haggerty352404a2011-08-04 06:36:17 +020032/*
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 */
37char *git_attr_name(struct git_attr *);
38
Michael Haggertyd932f4e2011-08-04 06:36:33 +020039int git_check_attr(const char *path, int, struct git_attr_check *);
Junio C Hamanod0bfd022007-04-12 01:07:32 -070040
Michael Haggertyee548df2011-08-04 06:36:23 +020041/*
42 * Retrieve all attributes that apply to the specified path. *num
Jim Meyering65c2b2b2012-03-28 10:45:36 +020043 * will be set to the number of attributes on the path; **check will
Michael Haggertyee548df2011-08-04 06:36:23 +020044 * 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 */
48int git_all_attrs(const char *path, int *num, struct git_attr_check **check);
49
Junio C Hamano06f33c12009-03-13 21:24:08 -070050enum git_attr_direction {
51 GIT_ATTR_CHECKIN,
Nguyễn Thái Ngọc Duy4191e802009-04-18 00:17:58 +020052 GIT_ATTR_CHECKOUT,
Gary V. Vaughan4b055482010-05-14 09:31:35 +000053 GIT_ATTR_INDEX
Junio C Hamano06f33c12009-03-13 21:24:08 -070054};
55void git_attr_set_direction(enum git_attr_direction, struct index_state *);
56
Junio C Hamanod0bfd022007-04-12 01:07:32 -070057#endif /* ATTR_H */