dir.h 11.9 KB
Newer Older
1 2 3
#ifndef DIR_H
#define DIR_H

4 5
/* See Documentation/technical/api-directory-listing.txt */

6
#include "cache.h"
7 8
#include "strbuf.h"

9
struct dir_entry {
10
	unsigned int len;
11 12 13
	char name[FLEX_ARRAY]; /* more */
};

14 15
#define EXC_FLAG_NODIR 1
#define EXC_FLAG_ENDSWITH 4
16
#define EXC_FLAG_MUSTBEDIR 8
17
#define EXC_FLAG_NEGATIVE 16
18

19 20 21 22 23 24 25 26 27 28 29 30
struct exclude {
	/*
	 * This allows callers of last_exclude_matching() etc.
	 * to determine the origin of the matching pattern.
	 */
	struct exclude_list *el;

	const char *pattern;
	int patternlen;
	int nowildcardlen;
	const char *base;
	int baselen;
31
	unsigned flags;		/* EXC_FLAG_* */
32 33 34 35 36 37 38 39

	/*
	 * Counting starts from 1 for line numbers in ignore files,
	 * and from -1 decrementing for patterns from CLI args.
	 */
	int srcpos;
};

40
/*
41 42 43 44 45
 * Each excludes file will be parsed into a fresh exclude_list which
 * is appended to the relevant exclude_list_group (either EXC_DIRS or
 * EXC_FILE).  An exclude_list within the EXC_CMDL exclude_list_group
 * can also be used to represent the list of --exclude values passed
 * via CLI args.
46
 */
47 48 49
struct exclude_list {
	int nr;
	int alloc;
50

51 52 53
	/* remember pointer to exclude file contents so we can free() */
	char *filebuf;

54 55 56
	/* origin of list, e.g. path to filename, or descriptive string */
	const char *src;

57
	struct exclude **excludes;
58 59
};

60 61 62 63 64 65
/*
 * The contents of the per-directory exclude files are lazily read on
 * demand and then cached in memory, one per exclude_stack struct, in
 * order to avoid opening and parsing each one every time that
 * directory is traversed.
 */
66
struct exclude_stack {
67
	struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
68
	int baselen;
69
	int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
70
	struct untracked_cache_dir *ucd;
71 72 73 74 75
};

struct exclude_list_group {
	int nr, alloc;
	struct exclude_list *el;
76 77
};

78
struct oid_stat {
79
	struct stat_data stat;
80
	struct object_id oid;
81 82 83
	int valid;
};

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/*
 *  Untracked cache
 *
 *  The following inputs are sufficient to determine what files in a
 *  directory are excluded:
 *
 *   - The list of files and directories of the directory in question
 *   - The $GIT_DIR/index
 *   - dir_struct flags
 *   - The content of $GIT_DIR/info/exclude
 *   - The content of core.excludesfile
 *   - The content (or the lack) of .gitignore of all parent directories
 *     from $GIT_WORK_TREE
 *   - The check_only flag in read_directory_recursive (for
 *     DIR_HIDE_EMPTY_DIRECTORIES)
 *
 *  The first input can be checked using directory mtime. In many
 *  filesystems, directory mtime (stat_data field) is updated when its
 *  files or direct subdirs are added or removed.
 *
 *  The second one can be hooked from cache_tree_invalidate_path().
 *  Whenever a file (or a submodule) is added or removed from a
 *  directory, we invalidate that directory.
 *
 *  The remaining inputs are easy, their SHA-1 could be used to verify
 *  their contents (exclude_sha1[], info_exclude_sha1[] and
 *  excludes_file_sha1[])
 */
struct untracked_cache_dir {
	struct untracked_cache_dir **dirs;
	char **untracked;
	struct stat_data stat_data;
	unsigned int untracked_alloc, dirs_nr, dirs_alloc;
	unsigned int untracked_nr;
	unsigned int check_only : 1;
119
	/* all data except 'dirs' in this struct are good */
120
	unsigned int valid : 1;
121
	unsigned int recurse : 1;
122 123
	/* null object ID means this directory does not have .gitignore */
	struct object_id exclude_oid;
124 125 126 127
	char name[FLEX_ARRAY];
};

struct untracked_cache {
128 129
	struct oid_stat ss_info_exclude;
	struct oid_stat ss_excludes_file;
130
	const char *exclude_per_dir;
131
	struct strbuf ident;
132 133 134 135 136 137 138 139
	/*
	 * dir_struct#flags must match dir_flags or the untracked
	 * cache is ignored.
	 */
	unsigned dir_flags;
	struct untracked_cache_dir *root;
	/* Statistics */
	int dir_created;
140
	int gitignore_invalidated;
141 142
	int dir_invalidated;
	int dir_opened;
143 144
	/* fsmonitor invalidation data */
	unsigned int use_fsmonitor : 1;
145 146
};

147 148
struct dir_struct {
	int nr, alloc;
149
	int ignored_nr, ignored_alloc;
150 151 152 153 154
	enum {
		DIR_SHOW_IGNORED = 1<<0,
		DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
		DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
		DIR_NO_GITLINKS = 1<<3,
155
		DIR_COLLECT_IGNORED = 1<<4,
156
		DIR_SHOW_IGNORED_TOO = 1<<5,
157
		DIR_COLLECT_KILLED_ONLY = 1<<6,
158 159
		DIR_KEEP_UNTRACKED_CONTENTS = 1<<7,
		DIR_SHOW_IGNORED_TOO_MODE_MATCHING = 1<<8
160
	} flags;
161
	struct dir_entry **entries;
162
	struct dir_entry **ignored;
163 164 165

	/* Exclude info */
	const char *exclude_per_dir;
166

167
	/*
168 169
	 * We maintain three groups of exclude pattern lists:
	 *
170 171
	 * EXC_CMDL lists patterns explicitly given on the command line.
	 * EXC_DIRS lists patterns obtained from per-directory ignore files.
172 173 174 175 176 177
	 * EXC_FILE lists patterns from fallback ignore files, e.g.
	 *   - .git/info/exclude
	 *   - core.excludesfile
	 *
	 * Each group contains multiple exclude lists, a single list
	 * per source.
178 179 180 181
	 */
#define EXC_CMDL 0
#define EXC_DIRS 1
#define EXC_FILE 2
182
	struct exclude_list_group exclude_list_group[3];
183

184 185 186 187 188 189
	/*
	 * Temporary variables which are used during loading of the
	 * per-directory exclude lists.
	 *
	 * exclude_stack points to the top of the exclude_stack, and
	 * basebuf contains the full path to the current
190 191
	 * (sub)directory in the traversal. Exclude points to the
	 * matching exclude struct if the directory is excluded.
192
	 */
193
	struct exclude_stack *exclude_stack;
194
	struct exclude *exclude;
195
	struct strbuf basebuf;
196 197 198

	/* Enable untracked file cache if set */
	struct untracked_cache *untracked;
199 200
	struct oid_stat ss_info_exclude;
	struct oid_stat ss_excludes_file;
201
	unsigned unmanaged_exclude_files;
202 203
};

204 205 206
/*Count the number of slashes for string s*/
extern int count_slashes(const char *s);

207 208 209 210 211 212
/*
 * The ordering of these constants is significant, with
 * higher-numbered match types signifying "closer" (i.e. more
 * specific) matches which will override lower-numbered match types
 * when populating the seen[] array.
 */
213 214 215
#define MATCHED_RECURSIVELY 1
#define MATCHED_FNMATCH 2
#define MATCHED_EXACTLY 3
216 217
extern int simple_length(const char *match);
extern int no_wildcard(const char *string);
218
extern char *common_prefix(const struct pathspec *pathspec);
219 220
extern int match_pathspec(const struct index_state *istate,
			  const struct pathspec *pathspec,
221
			  const char *name, int namelen,
222
			  int prefix, char *seen, int is_dir);
223
extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec);
224
extern int within_depth(const char *name, int namelen, int depth, int max_depth);
225

226 227 228
extern int fill_directory(struct dir_struct *dir,
			  struct index_state *istate,
			  const struct pathspec *pathspec);
229 230 231
extern int read_directory(struct dir_struct *, struct index_state *istate,
			  const char *path, int len,
			  const struct pathspec *pathspec);
232

233 234 235 236
extern int is_excluded_from_list(const char *pathname, int pathlen,
				 const char *basename, int *dtype,
				 struct exclude_list *el,
				 struct index_state *istate);
237 238 239
struct dir_entry *dir_add_ignored(struct dir_struct *dir,
				  struct index_state *istate,
				  const char *pathname, int len);
240

241 242 243 244 245
/*
 * these implement the matching logic for dir.c:excluded_from_list and
 * attr.c:path_matches()
 */
extern int match_basename(const char *, int,
246
			  const char *, int, int, unsigned);
247 248
extern int match_pathname(const char *, int,
			  const char *, int,
249
			  const char *, int, int, unsigned);
250

251
extern struct exclude *last_exclude_matching(struct dir_struct *dir,
252
					     struct index_state *istate,
253
					     const char *name, int *dtype);
254

255 256 257
extern int is_excluded(struct dir_struct *dir,
		       struct index_state *istate,
		       const char *name, int *dtype);
258

259 260
extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
					     int group_type, const char *src);
261
extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
262
					  struct exclude_list *el, struct  index_state *istate);
263
extern void add_excludes_from_file(struct dir_struct *, const char *fname);
264 265 266
extern int add_excludes_from_blob_to_list(struct object_id *oid,
					  const char *base, int baselen,
					  struct exclude_list *el);
267
extern void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
268
extern void add_exclude(const char *string, const char *base,
269
			int baselen, struct exclude_list *el, int srcpos);
270
extern void clear_exclude_list(struct exclude_list *el);
271
extern void clear_directory(struct dir_struct *dir);
272
extern int file_exists(const char *);
273

274
extern int is_inside_dir(const char *dir);
275
extern int dir_inside_of(const char *subdir, const char *dir);
276

277 278 279 280 281 282 283
static inline int is_dot_or_dotdot(const char *name)
{
	return (name[0] == '.' &&
		(name[1] == '\0' ||
		 (name[1] == '.' && name[2] == '\0')));
}

284 285
extern int is_empty_dir(const char *dir);

286
extern void setup_standard_excludes(struct dir_struct *dir);
287

288 289 290 291 292 293 294 295

/* Constants for remove_dir_recursively: */

/*
 * If a non-directory is found within path, stop and return an error.
 * (In this case some empty directories might already have been
 * removed.)
 */
296
#define REMOVE_DIR_EMPTY_ONLY 01
297 298 299 300 301

/*
 * If any Git work trees are found within path, skip them without
 * considering it an error.
 */
302
#define REMOVE_DIR_KEEP_NESTED_GIT 02
303 304

/* Remove the contents of path, but leave path itself. */
305
#define REMOVE_DIR_KEEP_TOPLEVEL 04
306 307 308 309 310 311 312 313

/*
 * Remove path and its contents, recursively. flags is a combination
 * of the above REMOVE_DIR_* constants. Return 0 on success.
 *
 * This function uses path as temporary scratch space, but restores it
 * before returning.
 */
314
extern int remove_dir_recursively(struct strbuf *path, int flag);
315

316 317 318
/* tries to remove the path with empty directories along it, ignores ENOENT */
extern int remove_path(const char *path);

319 320
extern int fspathcmp(const char *a, const char *b);
extern int fspathncmp(const char *a, const char *b, size_t count);
321

322 323 324
/*
 * The prefix part of pattern must not contains wildcards.
 */
325 326 327 328
struct pathspec_item;
extern int git_fnmatch(const struct pathspec_item *item,
		       const char *pattern, const char *string,
		       int prefix);
329

330 331
extern int submodule_path_match(const struct index_state *istate,
				const struct pathspec *ps,
332 333 334
				const char *submodule_name,
				char *seen);

335 336
static inline int ce_path_match(const struct index_state *istate,
				const struct cache_entry *ce,
337 338 339
				const struct pathspec *pathspec,
				char *seen)
{
340
	return match_pathspec(istate, pathspec, ce->name, ce_namelen(ce), 0, seen,
341
			      S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
342 343
}

344 345
static inline int dir_path_match(const struct index_state *istate,
				 const struct dir_entry *ent,
346 347 348
				 const struct pathspec *pathspec,
				 int prefix, char *seen)
{
349 350
	int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
	int len = has_trailing_dir ? ent->len - 1 : ent->len;
351
	return match_pathspec(istate, pathspec, ent->name, len, prefix, seen,
352
			      has_trailing_dir);
353 354
}

355 356 357
int cmp_dir_entry(const void *p1, const void *p2);
int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);

358
void untracked_cache_invalidate_path(struct index_state *, const char *, int safe_path);
359 360 361
void untracked_cache_remove_from_index(struct index_state *, const char *);
void untracked_cache_add_to_index(struct index_state *, const char *);

362 363
void free_untracked_cache(struct untracked_cache *);
struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
364
void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
365
void add_untracked_cache(struct index_state *istate);
366
void remove_untracked_cache(struct index_state *istate);
367 368 369 370 371 372 373 374 375 376 377

/*
 * Connect a worktree to a git directory by creating (or overwriting) a
 * '.git' file containing the location of the git directory. In the git
 * directory set the core.worktree setting to indicate where the worktree is.
 * When `recurse_into_nested` is set, recurse into any nested submodules,
 * connecting them as well.
 */
extern void connect_work_tree_and_git_dir(const char *work_tree,
					  const char *git_dir,
					  int recurse_into_nested);
378 379 380
extern void relocate_gitdir(const char *path,
			    const char *old_git_dir,
			    const char *new_git_dir);
381
#endif