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

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

6 7
#include "strbuf.h"

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

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

18 19 20 21 22 23
/*
 * Each .gitignore file will be parsed into patterns which are then
 * appended to the relevant exclude_list (either EXC_DIRS or
 * EXC_FILE).  exclude_lists are also used to represent the list of
 * --exclude values passed via CLI args (EXC_CMDL).
 */
24 25 26 27 28
struct exclude_list {
	int nr;
	int alloc;
	struct exclude {
		const char *pattern;
29
		int patternlen;
30
		int nowildcardlen;
31 32
		const char *base;
		int baselen;
33
		int flags;
34 35 36
	} **excludes;
};

37 38 39 40 41 42
/*
 * 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.
 */
43
struct exclude_stack {
44 45
	struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
	char *filebuf; /* remember pointer to per-directory exclude file contents so we can free() */
46 47 48 49
	int baselen;
	int exclude_ix;
};

50 51
struct dir_struct {
	int nr, alloc;
52
	int ignored_nr, ignored_alloc;
53 54 55 56 57 58 59
	enum {
		DIR_SHOW_IGNORED = 1<<0,
		DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
		DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
		DIR_NO_GITLINKS = 1<<3,
		DIR_COLLECT_IGNORED = 1<<4
	} flags;
60
	struct dir_entry **entries;
61
	struct dir_entry **ignored;
62 63 64 65

	/* Exclude info */
	const char *exclude_per_dir;
	struct exclude_list exclude_list[3];
66 67 68 69 70 71 72 73 74 75
	/*
	 * We maintain three exclude pattern lists:
	 * EXC_CMDL lists patterns explicitly given on the command line.
	 * EXC_DIRS lists patterns obtained from per-directory ignore files.
	 * EXC_FILE lists patterns from fallback ignore files.
	 */
#define EXC_CMDL 0
#define EXC_DIRS 1
#define EXC_FILE 2

76 77 78 79 80 81 82 83
	/*
	 * 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
	 * (sub)directory in the traversal.
	 */
84 85
	struct exclude_stack *exclude_stack;
	char basebuf[PATH_MAX];
86 87
};

88 89 90
#define MATCHED_RECURSIVELY 1
#define MATCHED_FNMATCH 2
#define MATCHED_EXACTLY 3
91
extern char *common_prefix(const char **pathspec);
92
extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
93 94 95
extern int match_pathspec_depth(const struct pathspec *pathspec,
				const char *name, int namelen,
				int prefix, char *seen);
96
extern int within_depth(const char *name, int namelen, int depth, int max_depth);
97

98
extern int fill_directory(struct dir_struct *dir, const char **pathspec);
99
extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
100

101 102
extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
				 int *dtype, struct exclude_list *el);
103
struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
104

105 106 107 108 109 110 111 112 113 114
/*
 * these implement the matching logic for dir.c:excluded_from_list and
 * attr.c:path_matches()
 */
extern int match_basename(const char *, int,
			  const char *, int, int, int);
extern int match_pathname(const char *, int,
			  const char *, int,
			  const char *, int, int, int);

115
/*
116 117
 * The is_excluded() API is meant for callers that check each level of leading
 * directory hierarchies with is_excluded() to avoid recursing into excluded
118 119 120 121
 * directories.  Callers that do not do so should use this API instead.
 */
struct path_exclude_check {
	struct dir_struct *dir;
122
	struct exclude *exclude;
123 124 125 126
	struct strbuf path;
};
extern void path_exclude_check_init(struct path_exclude_check *, struct dir_struct *);
extern void path_exclude_check_clear(struct path_exclude_check *);
127 128
extern struct exclude *last_exclude_matching_path(struct path_exclude_check *, const char *,
						  int namelen, int *dtype);
129
extern int is_path_excluded(struct path_exclude_check *, const char *, int namelen, int *dtype);
130

131

132
extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
133
					  char **buf_p, struct exclude_list *el, int check_index);
134
extern void add_excludes_from_file(struct dir_struct *, const char *fname);
135
extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
136
extern void add_exclude(const char *string, const char *base,
137
			int baselen, struct exclude_list *el);
Duy Nguyen's avatar
Duy Nguyen committed
138
extern void free_excludes(struct exclude_list *el);
139
extern int file_exists(const char *);
140

141
extern int is_inside_dir(const char *dir);
142
extern int dir_inside_of(const char *subdir, const char *dir);
143

144 145 146 147 148 149 150
static inline int is_dot_or_dotdot(const char *name)
{
	return (name[0] == '.' &&
		(name[1] == '\0' ||
		 (name[1] == '.' && name[2] == '\0')));
}

151 152
extern int is_empty_dir(const char *dir);

Junio C Hamano's avatar
Junio C Hamano committed
153
extern void setup_standard_excludes(struct dir_struct *dir);
154 155 156

#define REMOVE_DIR_EMPTY_ONLY 01
#define REMOVE_DIR_KEEP_NESTED_GIT 02
157
#define REMOVE_DIR_KEEP_TOPLEVEL 04
158
extern int remove_dir_recursively(struct strbuf *path, int flag);
159

160 161 162
/* tries to remove the path with empty directories along it, ignores ENOENT */
extern int remove_path(const char *path);

163 164 165 166
extern int strcmp_icase(const char *a, const char *b);
extern int strncmp_icase(const char *a, const char *b, size_t count);
extern int fnmatch_icase(const char *pattern, const char *string, int flags);

167
#endif