dir.h 6.92 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 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
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;
	int flags;

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

39
/*
40 41 42 43 44
 * 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.
45
 */
46 47 48
struct exclude_list {
	int nr;
	int alloc;
49

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

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

56
	struct exclude **excludes;
57 58
};

59 60 61 62 63 64
/*
 * 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.
 */
65
struct exclude_stack {
66
	struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
67
	int baselen;
68 69 70 71 72 73
	int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
};

struct exclude_list_group {
	int nr, alloc;
	struct exclude_list *el;
74 75
};

76 77
struct dir_struct {
	int nr, alloc;
78
	int ignored_nr, ignored_alloc;
79 80 81 82 83
	enum {
		DIR_SHOW_IGNORED = 1<<0,
		DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
		DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
		DIR_NO_GITLINKS = 1<<3,
84
		DIR_COLLECT_IGNORED = 1<<4,
85 86
		DIR_SHOW_IGNORED_TOO = 1<<5,
		DIR_COLLECT_KILLED_ONLY = 1<<6
87
	} flags;
88
	struct dir_entry **entries;
89
	struct dir_entry **ignored;
90 91 92

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

94
	/*
95 96
	 * We maintain three groups of exclude pattern lists:
	 *
97 98
	 * EXC_CMDL lists patterns explicitly given on the command line.
	 * EXC_DIRS lists patterns obtained from per-directory ignore files.
99 100 101 102 103 104
	 * 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.
105 106 107 108
	 */
#define EXC_CMDL 0
#define EXC_DIRS 1
#define EXC_FILE 2
109
	struct exclude_list_group exclude_list_group[3];
110

111 112 113 114 115 116
	/*
	 * 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
117 118
	 * (sub)directory in the traversal. Exclude points to the
	 * matching exclude struct if the directory is excluded.
119
	 */
120
	struct exclude_stack *exclude_stack;
121
	struct exclude *exclude;
122
	struct strbuf basebuf;
123 124
};

125 126 127 128 129 130
/*
 * 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.
 */
131 132 133
#define MATCHED_RECURSIVELY 1
#define MATCHED_FNMATCH 2
#define MATCHED_EXACTLY 3
134 135
extern int simple_length(const char *match);
extern int no_wildcard(const char *string);
136
extern char *common_prefix(const struct pathspec *pathspec);
137 138
extern int match_pathspec(const struct pathspec *pathspec,
			  const char *name, int namelen,
139
			  int prefix, char *seen, int is_dir);
140
extern int within_depth(const char *name, int namelen, int depth, int max_depth);
141

142 143
extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec);
extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec);
144

145 146
extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
				 int *dtype, struct exclude_list *el);
147
struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
148

149 150 151 152 153 154 155 156 157 158
/*
 * 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);

159 160
extern struct exclude *last_exclude_matching(struct dir_struct *dir,
					     const char *name, int *dtype);
161

162
extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
163

164 165
extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
					     int group_type, const char *src);
166
extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
167
					  struct exclude_list *el, int check_index);
168
extern void add_excludes_from_file(struct dir_struct *, const char *fname);
169
extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
170
extern void add_exclude(const char *string, const char *base,
171
			int baselen, struct exclude_list *el, int srcpos);
172
extern void clear_exclude_list(struct exclude_list *el);
173
extern void clear_directory(struct dir_struct *dir);
174
extern int file_exists(const char *);
175

176
extern int is_inside_dir(const char *dir);
177
extern int dir_inside_of(const char *subdir, const char *dir);
178

179 180 181 182 183 184 185
static inline int is_dot_or_dotdot(const char *name)
{
	return (name[0] == '.' &&
		(name[1] == '\0' ||
		 (name[1] == '.' && name[2] == '\0')));
}

186 187
extern int is_empty_dir(const char *dir);

Junio C Hamano's avatar
Junio C Hamano committed
188
extern void setup_standard_excludes(struct dir_struct *dir);
189 190 191

#define REMOVE_DIR_EMPTY_ONLY 01
#define REMOVE_DIR_KEEP_NESTED_GIT 02
192
#define REMOVE_DIR_KEEP_TOPLEVEL 04
193
extern int remove_dir_recursively(struct strbuf *path, int flag);
194

195 196 197
/* tries to remove the path with empty directories along it, ignores ENOENT */
extern int remove_path(const char *path);

198 199 200 201
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);

202 203 204
/*
 * The prefix part of pattern must not contains wildcards.
 */
205 206 207 208
struct pathspec_item;
extern int git_fnmatch(const struct pathspec_item *item,
		       const char *pattern, const char *string,
		       int prefix);
209

210 211 212 213
static inline int ce_path_match(const struct cache_entry *ce,
				const struct pathspec *pathspec,
				char *seen)
{
214 215
	return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
			      S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
216 217
}

218 219 220 221
static inline int dir_path_match(const struct dir_entry *ent,
				 const struct pathspec *pathspec,
				 int prefix, char *seen)
{
222 223 224 225
	int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
	int len = has_trailing_dir ? ent->len - 1 : ent->len;
	return match_pathspec(pathspec, ent->name, len, prefix, seen,
			      has_trailing_dir);
226 227
}

228
#endif