dir.h 6.74 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 31
	/* remember pointer to exclude file contents so we can free() */
	char *filebuf;

32 33 34
	/* origin of list, e.g. path to filename, or descriptive string */
	const char *src;

35
	struct exclude {
36 37 38 39 40 41
		/*
		 * This allows callers of last_exclude_matching() etc.
		 * to determine the origin of the matching pattern.
		 */
		struct exclude_list *el;

42
		const char *pattern;
43
		int patternlen;
44
		int nowildcardlen;
45 46
		const char *base;
		int baselen;
47
		int flags;
48 49 50 51 52 53

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

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

struct exclude_list_group {
	int nr, alloc;
	struct exclude_list *el;
72 73
};

74 75
struct dir_struct {
	int nr, alloc;
76
	int ignored_nr, ignored_alloc;
77 78 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,
		DIR_COLLECT_IGNORED = 1<<4
	} flags;
84
	struct dir_entry **entries;
85
	struct dir_entry **ignored;
86 87 88

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

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

107 108 109 110 111 112 113 114
	/*
	 * 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.
	 */
115 116
	struct exclude_stack *exclude_stack;
	char basebuf[PATH_MAX];
117 118
};

119 120 121 122 123 124
/*
 * 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.
 */
125 126 127
#define MATCHED_RECURSIVELY 1
#define MATCHED_FNMATCH 2
#define MATCHED_EXACTLY 3
128
extern char *common_prefix(const char **pathspec);
129
extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
130 131 132
extern int match_pathspec_depth(const struct pathspec *pathspec,
				const char *name, int namelen,
				int prefix, char *seen);
133
extern int within_depth(const char *name, int namelen, int depth, int max_depth);
134

135
extern int fill_directory(struct dir_struct *dir, const char **pathspec);
136
extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
137

138 139
extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
				 int *dtype, struct exclude_list *el);
140
struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
141

142 143 144 145 146 147 148 149 150 151
/*
 * 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);

152
/*
153 154
 * The is_excluded() API is meant for callers that check each level of leading
 * directory hierarchies with is_excluded() to avoid recursing into excluded
155 156 157 158
 * directories.  Callers that do not do so should use this API instead.
 */
struct path_exclude_check {
	struct dir_struct *dir;
159
	struct exclude *exclude;
160 161 162 163
	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 *);
164 165
extern struct exclude *last_exclude_matching_path(struct path_exclude_check *, const char *,
						  int namelen, int *dtype);
166
extern int is_path_excluded(struct path_exclude_check *, const char *, int namelen, int *dtype);
167

168

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

181
extern int is_inside_dir(const char *dir);
182
extern int dir_inside_of(const char *subdir, const char *dir);
183

184 185 186 187 188 189 190
static inline int is_dot_or_dotdot(const char *name)
{
	return (name[0] == '.' &&
		(name[1] == '\0' ||
		 (name[1] == '.' && name[2] == '\0')));
}

191 192
extern int is_empty_dir(const char *dir);

Junio C Hamano's avatar
Junio C Hamano committed
193
extern void setup_standard_excludes(struct dir_struct *dir);
194 195 196

#define REMOVE_DIR_EMPTY_ONLY 01
#define REMOVE_DIR_KEEP_NESTED_GIT 02
197
#define REMOVE_DIR_KEEP_TOPLEVEL 04
198
extern int remove_dir_recursively(struct strbuf *path, int flag);
199

200 201 202
/* tries to remove the path with empty directories along it, ignores ENOENT */
extern int remove_path(const char *path);

203 204 205 206
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);

207 208 209 210
/*
 * The prefix part of pattern must not contains wildcards.
 */
#define GFNM_PATHNAME 1		/* similar to FNM_PATHNAME */
211
#define GFNM_ONESTAR  2		/* there is only _one_ wildcard, a star */
212 213 214 215

extern int git_fnmatch(const char *pattern, const char *string,
		       int flags, int prefix);

216
#endif