dir.h 5.77 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 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.
24
 */
25 26 27
struct exclude_list {
	int nr;
	int alloc;
28 29 30
	/* remember pointer to exclude file contents so we can free() */
	char *filebuf;

31 32
	struct exclude {
		const char *pattern;
33
		int patternlen;
34
		int nowildcardlen;
35 36
		const char *base;
		int baselen;
37
		int flags;
38 39 40
	} **excludes;
};

41 42 43 44 45 46
/*
 * 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.
 */
47
struct exclude_stack {
48
	struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
49
	int baselen;
50 51 52 53 54 55
	int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
};

struct exclude_list_group {
	int nr, alloc;
	struct exclude_list *el;
56 57
};

58 59
struct dir_struct {
	int nr, alloc;
60
	int ignored_nr, ignored_alloc;
61 62 63 64 65 66 67
	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;
68
	struct dir_entry **entries;
69
	struct dir_entry **ignored;
70 71 72

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

74
	/*
75 76
	 * We maintain three groups of exclude pattern lists:
	 *
77 78
	 * EXC_CMDL lists patterns explicitly given on the command line.
	 * EXC_DIRS lists patterns obtained from per-directory ignore files.
79 80 81 82 83 84
	 * 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.
85 86 87 88
	 */
#define EXC_CMDL 0
#define EXC_DIRS 1
#define EXC_FILE 2
89
	struct exclude_list_group exclude_list_group[3];
90

91 92 93 94 95 96 97 98
	/*
	 * 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.
	 */
99 100
	struct exclude_stack *exclude_stack;
	char basebuf[PATH_MAX];
101 102
};

103 104 105
#define MATCHED_RECURSIVELY 1
#define MATCHED_FNMATCH 2
#define MATCHED_EXACTLY 3
106
extern char *common_prefix(const char **pathspec);
107
extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
108 109 110
extern int match_pathspec_depth(const struct pathspec *pathspec,
				const char *name, int namelen,
				int prefix, char *seen);
111
extern int within_depth(const char *name, int namelen, int depth, int max_depth);
112

113
extern int fill_directory(struct dir_struct *dir, const char **pathspec);
114
extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
115

116 117
extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
				 int *dtype, struct exclude_list *el);
118
struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
119

120 121 122 123 124 125 126 127 128 129
/*
 * 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);

130
/*
131 132
 * The is_excluded() API is meant for callers that check each level of leading
 * directory hierarchies with is_excluded() to avoid recursing into excluded
133 134 135 136
 * directories.  Callers that do not do so should use this API instead.
 */
struct path_exclude_check {
	struct dir_struct *dir;
137
	struct exclude *exclude;
138 139 140 141
	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 *);
142 143
extern struct exclude *last_exclude_matching_path(struct path_exclude_check *, const char *,
						  int namelen, int *dtype);
144
extern int is_path_excluded(struct path_exclude_check *, const char *, int namelen, int *dtype);
145

146

147
extern struct exclude_list *add_exclude_list(struct dir_struct *dir, int group_type);
148
extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
149
					  struct exclude_list *el, int check_index);
150
extern void add_excludes_from_file(struct dir_struct *, const char *fname);
151
extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
152
extern void add_exclude(const char *string, const char *base,
153
			int baselen, struct exclude_list *el);
154
extern void clear_exclude_list(struct exclude_list *el);
155
extern int file_exists(const char *);
156

157
extern int is_inside_dir(const char *dir);
158
extern int dir_inside_of(const char *subdir, const char *dir);
159

160 161 162 163 164 165 166
static inline int is_dot_or_dotdot(const char *name)
{
	return (name[0] == '.' &&
		(name[1] == '\0' ||
		 (name[1] == '.' && name[2] == '\0')));
}

167 168
extern int is_empty_dir(const char *dir);

Junio C Hamano's avatar
Junio C Hamano committed
169
extern void setup_standard_excludes(struct dir_struct *dir);
170 171 172

#define REMOVE_DIR_EMPTY_ONLY 01
#define REMOVE_DIR_KEEP_NESTED_GIT 02
173
#define REMOVE_DIR_KEEP_TOPLEVEL 04
174
extern int remove_dir_recursively(struct strbuf *path, int flag);
175

176 177 178
/* tries to remove the path with empty directories along it, ignores ENOENT */
extern int remove_path(const char *path);

179 180 181 182
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);

183
#endif