untracked cache: record .gitignore information and dir hierarchy
[git/git.git] / dir.h
1 #ifndef DIR_H
2 #define DIR_H
3
4 /* See Documentation/technical/api-directory-listing.txt */
5
6 #include "strbuf.h"
7
8 struct dir_entry {
9 unsigned int len;
10 char name[FLEX_ARRAY]; /* more */
11 };
12
13 #define EXC_FLAG_NODIR 1
14 #define EXC_FLAG_ENDSWITH 4
15 #define EXC_FLAG_MUSTBEDIR 8
16 #define EXC_FLAG_NEGATIVE 16
17
18 struct exclude {
19 /*
20 * This allows callers of last_exclude_matching() etc.
21 * to determine the origin of the matching pattern.
22 */
23 struct exclude_list *el;
24
25 const char *pattern;
26 int patternlen;
27 int nowildcardlen;
28 const char *base;
29 int baselen;
30 int flags;
31
32 /*
33 * Counting starts from 1 for line numbers in ignore files,
34 * and from -1 decrementing for patterns from CLI args.
35 */
36 int srcpos;
37 };
38
39 /*
40 * Each excludes file will be parsed into a fresh exclude_list which
41 * is appended to the relevant exclude_list_group (either EXC_DIRS or
42 * EXC_FILE). An exclude_list within the EXC_CMDL exclude_list_group
43 * can also be used to represent the list of --exclude values passed
44 * via CLI args.
45 */
46 struct exclude_list {
47 int nr;
48 int alloc;
49
50 /* remember pointer to exclude file contents so we can free() */
51 char *filebuf;
52
53 /* origin of list, e.g. path to filename, or descriptive string */
54 const char *src;
55
56 struct exclude **excludes;
57 };
58
59 /*
60 * The contents of the per-directory exclude files are lazily read on
61 * demand and then cached in memory, one per exclude_stack struct, in
62 * order to avoid opening and parsing each one every time that
63 * directory is traversed.
64 */
65 struct exclude_stack {
66 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
67 int baselen;
68 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
69 struct untracked_cache_dir *ucd;
70 };
71
72 struct exclude_list_group {
73 int nr, alloc;
74 struct exclude_list *el;
75 };
76
77 struct sha1_stat {
78 struct stat_data stat;
79 unsigned char sha1[20];
80 int valid;
81 };
82
83 /*
84 * Untracked cache
85 *
86 * The following inputs are sufficient to determine what files in a
87 * directory are excluded:
88 *
89 * - The list of files and directories of the directory in question
90 * - The $GIT_DIR/index
91 * - dir_struct flags
92 * - The content of $GIT_DIR/info/exclude
93 * - The content of core.excludesfile
94 * - The content (or the lack) of .gitignore of all parent directories
95 * from $GIT_WORK_TREE
96 * - The check_only flag in read_directory_recursive (for
97 * DIR_HIDE_EMPTY_DIRECTORIES)
98 *
99 * The first input can be checked using directory mtime. In many
100 * filesystems, directory mtime (stat_data field) is updated when its
101 * files or direct subdirs are added or removed.
102 *
103 * The second one can be hooked from cache_tree_invalidate_path().
104 * Whenever a file (or a submodule) is added or removed from a
105 * directory, we invalidate that directory.
106 *
107 * The remaining inputs are easy, their SHA-1 could be used to verify
108 * their contents (exclude_sha1[], info_exclude_sha1[] and
109 * excludes_file_sha1[])
110 */
111 struct untracked_cache_dir {
112 struct untracked_cache_dir **dirs;
113 char **untracked;
114 struct stat_data stat_data;
115 unsigned int untracked_alloc, dirs_nr, dirs_alloc;
116 unsigned int untracked_nr;
117 unsigned int check_only : 1;
118 /* null SHA-1 means this directory does not have .gitignore */
119 unsigned char exclude_sha1[20];
120 char name[FLEX_ARRAY];
121 };
122
123 struct untracked_cache {
124 struct sha1_stat ss_info_exclude;
125 struct sha1_stat ss_excludes_file;
126 const char *exclude_per_dir;
127 /*
128 * dir_struct#flags must match dir_flags or the untracked
129 * cache is ignored.
130 */
131 unsigned dir_flags;
132 struct untracked_cache_dir *root;
133 /* Statistics */
134 int dir_created;
135 };
136
137 struct dir_struct {
138 int nr, alloc;
139 int ignored_nr, ignored_alloc;
140 enum {
141 DIR_SHOW_IGNORED = 1<<0,
142 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
143 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
144 DIR_NO_GITLINKS = 1<<3,
145 DIR_COLLECT_IGNORED = 1<<4,
146 DIR_SHOW_IGNORED_TOO = 1<<5,
147 DIR_COLLECT_KILLED_ONLY = 1<<6
148 } flags;
149 struct dir_entry **entries;
150 struct dir_entry **ignored;
151
152 /* Exclude info */
153 const char *exclude_per_dir;
154
155 /*
156 * We maintain three groups of exclude pattern lists:
157 *
158 * EXC_CMDL lists patterns explicitly given on the command line.
159 * EXC_DIRS lists patterns obtained from per-directory ignore files.
160 * EXC_FILE lists patterns from fallback ignore files, e.g.
161 * - .git/info/exclude
162 * - core.excludesfile
163 *
164 * Each group contains multiple exclude lists, a single list
165 * per source.
166 */
167 #define EXC_CMDL 0
168 #define EXC_DIRS 1
169 #define EXC_FILE 2
170 struct exclude_list_group exclude_list_group[3];
171
172 /*
173 * Temporary variables which are used during loading of the
174 * per-directory exclude lists.
175 *
176 * exclude_stack points to the top of the exclude_stack, and
177 * basebuf contains the full path to the current
178 * (sub)directory in the traversal. Exclude points to the
179 * matching exclude struct if the directory is excluded.
180 */
181 struct exclude_stack *exclude_stack;
182 struct exclude *exclude;
183 struct strbuf basebuf;
184
185 /* Enable untracked file cache if set */
186 struct untracked_cache *untracked;
187 struct sha1_stat ss_info_exclude;
188 struct sha1_stat ss_excludes_file;
189 };
190
191 /*
192 * The ordering of these constants is significant, with
193 * higher-numbered match types signifying "closer" (i.e. more
194 * specific) matches which will override lower-numbered match types
195 * when populating the seen[] array.
196 */
197 #define MATCHED_RECURSIVELY 1
198 #define MATCHED_FNMATCH 2
199 #define MATCHED_EXACTLY 3
200 extern int simple_length(const char *match);
201 extern int no_wildcard(const char *string);
202 extern char *common_prefix(const struct pathspec *pathspec);
203 extern int match_pathspec(const struct pathspec *pathspec,
204 const char *name, int namelen,
205 int prefix, char *seen, int is_dir);
206 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
207
208 extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec);
209 extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec);
210
211 extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
212 int *dtype, struct exclude_list *el);
213 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
214
215 /*
216 * these implement the matching logic for dir.c:excluded_from_list and
217 * attr.c:path_matches()
218 */
219 extern int match_basename(const char *, int,
220 const char *, int, int, int);
221 extern int match_pathname(const char *, int,
222 const char *, int,
223 const char *, int, int, int);
224
225 extern struct exclude *last_exclude_matching(struct dir_struct *dir,
226 const char *name, int *dtype);
227
228 extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
229
230 extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
231 int group_type, const char *src);
232 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
233 struct exclude_list *el, int check_index);
234 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
235 extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
236 extern void add_exclude(const char *string, const char *base,
237 int baselen, struct exclude_list *el, int srcpos);
238 extern void clear_exclude_list(struct exclude_list *el);
239 extern void clear_directory(struct dir_struct *dir);
240 extern int file_exists(const char *);
241
242 extern int is_inside_dir(const char *dir);
243 extern int dir_inside_of(const char *subdir, const char *dir);
244
245 static inline int is_dot_or_dotdot(const char *name)
246 {
247 return (name[0] == '.' &&
248 (name[1] == '\0' ||
249 (name[1] == '.' && name[2] == '\0')));
250 }
251
252 extern int is_empty_dir(const char *dir);
253
254 extern void setup_standard_excludes(struct dir_struct *dir);
255
256 #define REMOVE_DIR_EMPTY_ONLY 01
257 #define REMOVE_DIR_KEEP_NESTED_GIT 02
258 #define REMOVE_DIR_KEEP_TOPLEVEL 04
259 extern int remove_dir_recursively(struct strbuf *path, int flag);
260
261 /* tries to remove the path with empty directories along it, ignores ENOENT */
262 extern int remove_path(const char *path);
263
264 extern int strcmp_icase(const char *a, const char *b);
265 extern int strncmp_icase(const char *a, const char *b, size_t count);
266 extern int fnmatch_icase(const char *pattern, const char *string, int flags);
267
268 /*
269 * The prefix part of pattern must not contains wildcards.
270 */
271 struct pathspec_item;
272 extern int git_fnmatch(const struct pathspec_item *item,
273 const char *pattern, const char *string,
274 int prefix);
275
276 static inline int ce_path_match(const struct cache_entry *ce,
277 const struct pathspec *pathspec,
278 char *seen)
279 {
280 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
281 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
282 }
283
284 static inline int dir_path_match(const struct dir_entry *ent,
285 const struct pathspec *pathspec,
286 int prefix, char *seen)
287 {
288 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
289 int len = has_trailing_dir ? ent->len - 1 : ent->len;
290 return match_pathspec(pathspec, ent->name, len, prefix, seen,
291 has_trailing_dir);
292 }
293
294 #endif