untracked cache: save to an index extension
[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 /* all data except 'dirs' in this struct are good */
119 unsigned int valid : 1;
120 unsigned int recurse : 1;
121 /* null SHA-1 means this directory does not have .gitignore */
122 unsigned char exclude_sha1[20];
123 char name[FLEX_ARRAY];
124 };
125
126 struct untracked_cache {
127 struct sha1_stat ss_info_exclude;
128 struct sha1_stat ss_excludes_file;
129 const char *exclude_per_dir;
130 /*
131 * dir_struct#flags must match dir_flags or the untracked
132 * cache is ignored.
133 */
134 unsigned dir_flags;
135 struct untracked_cache_dir *root;
136 /* Statistics */
137 int dir_created;
138 int gitignore_invalidated;
139 int dir_invalidated;
140 int dir_opened;
141 };
142
143 struct dir_struct {
144 int nr, alloc;
145 int ignored_nr, ignored_alloc;
146 enum {
147 DIR_SHOW_IGNORED = 1<<0,
148 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
149 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
150 DIR_NO_GITLINKS = 1<<3,
151 DIR_COLLECT_IGNORED = 1<<4,
152 DIR_SHOW_IGNORED_TOO = 1<<5,
153 DIR_COLLECT_KILLED_ONLY = 1<<6
154 } flags;
155 struct dir_entry **entries;
156 struct dir_entry **ignored;
157
158 /* Exclude info */
159 const char *exclude_per_dir;
160
161 /*
162 * We maintain three groups of exclude pattern lists:
163 *
164 * EXC_CMDL lists patterns explicitly given on the command line.
165 * EXC_DIRS lists patterns obtained from per-directory ignore files.
166 * EXC_FILE lists patterns from fallback ignore files, e.g.
167 * - .git/info/exclude
168 * - core.excludesfile
169 *
170 * Each group contains multiple exclude lists, a single list
171 * per source.
172 */
173 #define EXC_CMDL 0
174 #define EXC_DIRS 1
175 #define EXC_FILE 2
176 struct exclude_list_group exclude_list_group[3];
177
178 /*
179 * Temporary variables which are used during loading of the
180 * per-directory exclude lists.
181 *
182 * exclude_stack points to the top of the exclude_stack, and
183 * basebuf contains the full path to the current
184 * (sub)directory in the traversal. Exclude points to the
185 * matching exclude struct if the directory is excluded.
186 */
187 struct exclude_stack *exclude_stack;
188 struct exclude *exclude;
189 struct strbuf basebuf;
190
191 /* Enable untracked file cache if set */
192 struct untracked_cache *untracked;
193 struct sha1_stat ss_info_exclude;
194 struct sha1_stat ss_excludes_file;
195 unsigned unmanaged_exclude_files;
196 };
197
198 /*
199 * The ordering of these constants is significant, with
200 * higher-numbered match types signifying "closer" (i.e. more
201 * specific) matches which will override lower-numbered match types
202 * when populating the seen[] array.
203 */
204 #define MATCHED_RECURSIVELY 1
205 #define MATCHED_FNMATCH 2
206 #define MATCHED_EXACTLY 3
207 extern int simple_length(const char *match);
208 extern int no_wildcard(const char *string);
209 extern char *common_prefix(const struct pathspec *pathspec);
210 extern int match_pathspec(const struct pathspec *pathspec,
211 const char *name, int namelen,
212 int prefix, char *seen, int is_dir);
213 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
214
215 extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec);
216 extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec);
217
218 extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
219 int *dtype, struct exclude_list *el);
220 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
221
222 /*
223 * these implement the matching logic for dir.c:excluded_from_list and
224 * attr.c:path_matches()
225 */
226 extern int match_basename(const char *, int,
227 const char *, int, int, int);
228 extern int match_pathname(const char *, int,
229 const char *, int,
230 const char *, int, int, int);
231
232 extern struct exclude *last_exclude_matching(struct dir_struct *dir,
233 const char *name, int *dtype);
234
235 extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
236
237 extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
238 int group_type, const char *src);
239 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
240 struct exclude_list *el, int check_index);
241 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
242 extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
243 extern void add_exclude(const char *string, const char *base,
244 int baselen, struct exclude_list *el, int srcpos);
245 extern void clear_exclude_list(struct exclude_list *el);
246 extern void clear_directory(struct dir_struct *dir);
247 extern int file_exists(const char *);
248
249 extern int is_inside_dir(const char *dir);
250 extern int dir_inside_of(const char *subdir, const char *dir);
251
252 static inline int is_dot_or_dotdot(const char *name)
253 {
254 return (name[0] == '.' &&
255 (name[1] == '\0' ||
256 (name[1] == '.' && name[2] == '\0')));
257 }
258
259 extern int is_empty_dir(const char *dir);
260
261 extern void setup_standard_excludes(struct dir_struct *dir);
262
263 #define REMOVE_DIR_EMPTY_ONLY 01
264 #define REMOVE_DIR_KEEP_NESTED_GIT 02
265 #define REMOVE_DIR_KEEP_TOPLEVEL 04
266 extern int remove_dir_recursively(struct strbuf *path, int flag);
267
268 /* tries to remove the path with empty directories along it, ignores ENOENT */
269 extern int remove_path(const char *path);
270
271 extern int strcmp_icase(const char *a, const char *b);
272 extern int strncmp_icase(const char *a, const char *b, size_t count);
273 extern int fnmatch_icase(const char *pattern, const char *string, int flags);
274
275 /*
276 * The prefix part of pattern must not contains wildcards.
277 */
278 struct pathspec_item;
279 extern int git_fnmatch(const struct pathspec_item *item,
280 const char *pattern, const char *string,
281 int prefix);
282
283 static inline int ce_path_match(const struct cache_entry *ce,
284 const struct pathspec *pathspec,
285 char *seen)
286 {
287 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
288 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
289 }
290
291 static inline int dir_path_match(const struct dir_entry *ent,
292 const struct pathspec *pathspec,
293 int prefix, char *seen)
294 {
295 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
296 int len = has_trailing_dir ? ent->len - 1 : ent->len;
297 return match_pathspec(pathspec, ent->name, len, prefix, seen,
298 has_trailing_dir);
299 }
300
301 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
302 #endif