attr_file.h 5.31 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3 4 5 6 7 8 9
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
#ifndef INCLUDE_attr_file_h__
#define INCLUDE_attr_file_h__

10 11
#include "common.h"

12
#include "git2/oid.h"
13 14
#include "git2/attr.h"
#include "vector.h"
15
#include "pool.h"
16
#include "buffer.h"
17
#include "futils.h"
18

Russell Belfer committed
19
#define GIT_ATTR_FILE			".gitattributes"
20
#define GIT_ATTR_FILE_INREPO	"attributes"
Russell Belfer committed
21
#define GIT_ATTR_FILE_SYSTEM	"gitattributes"
22
#define GIT_ATTR_FILE_XDG		"attributes"
Russell Belfer committed
23

24 25 26 27
#define GIT_ATTR_FNMATCH_NEGATIVE	(1U << 0)
#define GIT_ATTR_FNMATCH_DIRECTORY	(1U << 1)
#define GIT_ATTR_FNMATCH_FULLPATH	(1U << 2)
#define GIT_ATTR_FNMATCH_MACRO		(1U << 3)
28
#define GIT_ATTR_FNMATCH_IGNORE		(1U << 4)
29
#define GIT_ATTR_FNMATCH_HASWILD	(1U << 5)
30
#define GIT_ATTR_FNMATCH_ALLOWSPACE	(1U << 6)
31
#define GIT_ATTR_FNMATCH_ICASE		(1U << 7)
32
#define GIT_ATTR_FNMATCH_MATCH_ALL	(1U << 8)
33 34 35 36
#define GIT_ATTR_FNMATCH_ALLOWNEG   (1U << 9)
#define GIT_ATTR_FNMATCH_ALLOWMACRO (1U << 10)

#define GIT_ATTR_FNMATCH__INCOMING \
37
	(GIT_ATTR_FNMATCH_ALLOWSPACE | GIT_ATTR_FNMATCH_ALLOWNEG | GIT_ATTR_FNMATCH_ALLOWMACRO)
38

39
typedef enum {
40 41 42
	GIT_ATTR_FILE__IN_MEMORY   = 0,
	GIT_ATTR_FILE__FROM_FILE   = 1,
	GIT_ATTR_FILE__FROM_INDEX  = 2,
43

44
	GIT_ATTR_FILE_NUM_SOURCES  = 3
45 46
} git_attr_file_source;

47 48 49 50
extern const char *git_attr__true;
extern const char *git_attr__false;
extern const char *git_attr__unset;

51 52 53
typedef struct {
	char *pattern;
	size_t length;
54 55
	char *containing_dir;
	size_t containing_dir_length;
56
	unsigned int flags;
57 58
} git_attr_fnmatch;

59
typedef struct {
60 61
	git_attr_fnmatch match;
	git_vector assigns;		/* vector of <git_attr_assignment*> */
62
} git_attr_rule;
63 64

typedef struct {
65
	git_refcount unused;
66
	const char *name;
Linquize committed
67
	uint32_t name_hash;
68 69 70
} git_attr_name;

typedef struct {
71
	git_refcount rc;		/* for macros */
72
	char *name;
Linquize committed
73 74
	uint32_t name_hash;
	const char *value;
75 76
} git_attr_assignment;

77 78 79
typedef struct git_attr_file_entry git_attr_file_entry;

typedef struct {
80
	git_refcount rc;
81
	git_mutex lock;
82 83
	git_attr_file_entry *entry;
	git_attr_file_source source;
84 85
	git_vector rules;			/* vector of <rule*> or <fnmatch*> */
	git_pool pool;
86 87
	unsigned int nonexistent:1;
	int session_key;
88 89
	union {
		git_oid oid;
Vicent Marti committed
90
		git_futils_filestamp stamp;
91
	} cache_data;
92 93 94 95 96 97
} git_attr_file;

struct git_attr_file_entry {
	git_attr_file *file[GIT_ATTR_FILE_NUM_SOURCES];
	const char *path; /* points into fullpath */
	char fullpath[GIT_FLEX_ARRAY];
98
};
99 100

typedef struct {
101 102 103 104
	git_buf  full;
	char    *path;
	char    *basename;
	int      is_dir;
105 106
} git_attr_path;

107 108 109 110 111 112
/* A git_attr_session can provide an "instance" of reading, to prevent cache
 * invalidation during a single operation instance (like checkout).
 */

typedef struct {
	int key;
113 114 115
	unsigned int init_setup:1,
		init_sysdir:1;
	git_buf sysdir;
116
	git_buf tmp;
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
} git_attr_session;

extern int git_attr_session__init(git_attr_session *attr_session, git_repository *repo);
extern void git_attr_session__free(git_attr_session *session);

extern int git_attr_get_many_with_session(
	const char **values_out,
	git_repository *repo,
	git_attr_session *attr_session,
	uint32_t flags,
	const char *path,
	size_t num_attr,
	const char **names);

typedef int (*git_attr_file_parser)(
	git_repository *repo,
	git_attr_file *file,
134 135
	const char *data,
	bool allow_macros);
136

137 138 139 140
/*
 * git_attr_file API
 */

141 142
int git_attr_file__new(
	git_attr_file **out,
143 144
	git_attr_file_entry *entry,
	git_attr_file_source source);
145 146 147 148 149 150

void git_attr_file__free(git_attr_file *file);

int git_attr_file__load(
	git_attr_file **out,
	git_repository *repo,
151
	git_attr_session *attr_session,
152 153
	git_attr_file_entry *ce,
	git_attr_file_source source,
154 155
	git_attr_file_parser parser,
	bool allow_macros);
156

157
int git_attr_file__load_standalone(
158
	git_attr_file **out, const char *path);
159

160
int git_attr_file__out_of_date(
161
	git_repository *repo, git_attr_session *session, git_attr_file *file);
162

163
int git_attr_file__parse_buffer(
164
	git_repository *repo, git_attr_file *attrs, const char *data, bool allow_macros);
165

166 167
int git_attr_file__clear_rules(
	git_attr_file *file, bool need_lock);
168

169
int git_attr_file__lookup_one(
170
	git_attr_file *file,
171
	git_attr_path *path,
172 173 174 175 176 177
	const char *attr,
	const char **value);

/* loop over rules in file from bottom to top */
#define git_attr_file__foreach_matching_rule(file, path, iter, rule)	\
	git_vector_rforeach(&(file)->rules, (iter), (rule)) \
178
		if (git_attr_rule__match((rule), (path)))
179

180
uint32_t git_attr_file__name_hash(const char *name);
181 182 183 184 185 186


/*
 * other utilities
 */

187
extern int git_attr_fnmatch__parse(
188
	git_attr_fnmatch *spec,
189
	git_pool *pool,
190
	const char *source,
191 192
	const char **base);

193
extern bool git_attr_fnmatch__match(
194
	git_attr_fnmatch *rule,
195
	git_attr_path *path);
196

197 198
extern void git_attr_rule__free(git_attr_rule *rule);

199
extern bool git_attr_rule__match(
200
	git_attr_rule *rule,
201
	git_attr_path *path);
202 203 204 205

extern git_attr_assignment *git_attr_rule__lookup_assignment(
	git_attr_rule *rule, const char *name);

206 207
typedef enum { GIT_DIR_FLAG_TRUE = 1, GIT_DIR_FLAG_FALSE = 0, GIT_DIR_FLAG_UNKNOWN = -1 } git_dir_flag;

208
extern int git_attr_path__init(
209
	git_attr_path *info, const char *path, const char *base, git_dir_flag is_dir);
210

211 212
extern void git_attr_path__free(git_attr_path *info);

213 214
extern int git_attr_assignment__parse(
	git_repository *repo, /* needed to expand macros */
215
	git_pool *pool,
216 217 218
	git_vector *assigns,
	const char **scan);

219
#endif