[thirdparty/git.git] / attr.h

#ifndef ATTR_H
#define ATTR_H

/* An attribute is a pointer to this opaque structure */
struct git_attr;

/*
 * Given a string, return the gitattribute object that
 * corresponds to it.
 */
struct git_attr *git_attr(const char *);

/* Internal use */
extern const char git_attr__true[];
extern const char git_attr__false[];

/* For public to check git_attr_check results */
#define ATTR_TRUE(v) ((v) == git_attr__true)
#define ATTR_FALSE(v) ((v) == git_attr__false)
#define ATTR_UNSET(v) ((v) == NULL)

/*
 * Send one or more git_attr_check to git_check_attr(), and
 * each 'value' member tells what its value is.
 * Unset one is returned as NULL.
 */
struct git_attr_check {
	struct git_attr *attr;
	const char *value;
};

/*
 * Return the name of the attribute represented by the argument.  The
 * return value is a pointer to a null-delimited string that is part
 * of the internal data structure; it should not be modified or freed.
 */
char *git_attr_name(struct git_attr *);

int git_check_attr(const char *path, int, struct git_attr_check *);

/*
 * Retrieve all attributes that apply to the specified path.  *num
 * will be set the the number of attributes on the path; **check will
 * be set to point at a newly-allocated array of git_attr_check
 * objects describing the attributes and their values.  *check must be
 * free()ed by the caller.
 */
int git_all_attrs(const char *path, int *num, struct git_attr_check **check);

enum git_attr_direction {
	GIT_ATTR_CHECKIN,
	GIT_ATTR_CHECKOUT,
	GIT_ATTR_INDEX
};
void git_attr_set_direction(enum git_attr_direction, struct index_state *);

#endif /* ATTR_H */
Commit	Line	Data
	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	/*
	8	* Given a string, return the gitattribute object that
	9	* corresponds to it.
	10	*/
	11	struct git_attr git_attr(const char );
	12
	13	/* Internal use */
	14	extern const char git_attr__true[];
	15	extern const char git_attr__false[];
	16
	17	/* For public to check git_attr_check results */
	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)
	21
	22	/*
	23	* Send one or more git_attr_check to git_check_attr(), and
	24	* each 'value' member tells what its value is.
	25	* Unset one is returned as NULL.
	26	*/
	27	struct git_attr_check {
	28	struct git_attr *attr;
	29	const char *value;
	30	};
	31
	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	*/
	37	char git_attr_name(struct git_attr );
	38
	39	int git_check_attr(const char path, int, struct git_attr_check );
	40
	41	/*
	42	* Retrieve all attributes that apply to the specified path. *num
	43	* will be set the the number of attributes on the path; **check will
	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	*/
	48	int git_all_attrs(const char path, int num, struct git_attr_check **check);
	49
	50	enum git_attr_direction {
	51	GIT_ATTR_CHECKIN,
	52	GIT_ATTR_CHECKOUT,
	53	GIT_ATTR_INDEX
	54	};
	55	void git_attr_set_direction(enum git_attr_direction, struct index_state *);
	56
	57	#endif /* ATTR_H */