]>
Commit | Line | Data |
---|---|---|
453ec4bd LT |
1 | #ifndef DIR_H |
2 | #define DIR_H | |
3 | ||
95a68344 AS |
4 | /* See Documentation/technical/api-directory-listing.txt */ |
5 | ||
70c369cd | 6 | #include "cache.h" |
eb41775e JH |
7 | #include "strbuf.h" |
8 | ||
453ec4bd | 9 | struct dir_entry { |
e96980ef | 10 | unsigned int len; |
453ec4bd LT |
11 | char name[FLEX_ARRAY]; /* more */ |
12 | }; | |
13 | ||
4ff89ee5 DS |
14 | #define PATTERN_FLAG_NODIR 1 |
15 | #define PATTERN_FLAG_ENDSWITH 4 | |
16 | #define PATTERN_FLAG_MUSTBEDIR 8 | |
17 | #define PATTERN_FLAG_NEGATIVE 16 | |
68492fc7 | 18 | |
ab8db613 | 19 | struct path_pattern { |
709359c8 | 20 | /* |
65edd96a | 21 | * This allows callers of last_matching_pattern() etc. |
709359c8 NTND |
22 | * to determine the origin of the matching pattern. |
23 | */ | |
caa3d554 | 24 | struct pattern_list *pl; |
709359c8 NTND |
25 | |
26 | const char *pattern; | |
27 | int patternlen; | |
28 | int nowildcardlen; | |
29 | const char *base; | |
30 | int baselen; | |
4ff89ee5 | 31 | unsigned flags; /* PATTERN_FLAG_* */ |
709359c8 NTND |
32 | |
33 | /* | |
34 | * Counting starts from 1 for line numbers in ignore files, | |
35 | * and from -1 decrementing for patterns from CLI args. | |
36 | */ | |
37 | int srcpos; | |
38 | }; | |
39 | ||
95a68344 | 40 | /* |
c082df24 AS |
41 | * Each excludes file will be parsed into a fresh exclude_list which |
42 | * is appended to the relevant exclude_list_group (either EXC_DIRS or | |
43 | * EXC_FILE). An exclude_list within the EXC_CMDL exclude_list_group | |
44 | * can also be used to represent the list of --exclude values passed | |
45 | * via CLI args. | |
95a68344 | 46 | */ |
caa3d554 | 47 | struct pattern_list { |
453ec4bd LT |
48 | int nr; |
49 | int alloc; | |
c04318e4 | 50 | |
c082df24 AS |
51 | /* remember pointer to exclude file contents so we can free() */ |
52 | char *filebuf; | |
53 | ||
c04318e4 AS |
54 | /* origin of list, e.g. path to filename, or descriptive string */ |
55 | const char *src; | |
56 | ||
ab8db613 | 57 | struct path_pattern **patterns; |
453ec4bd LT |
58 | }; |
59 | ||
95a68344 AS |
60 | /* |
61 | * The contents of the per-directory exclude files are lazily read on | |
62 | * demand and then cached in memory, one per exclude_stack struct, in | |
63 | * order to avoid opening and parsing each one every time that | |
64 | * directory is traversed. | |
65 | */ | |
63d285c8 | 66 | struct exclude_stack { |
95a68344 | 67 | struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */ |
63d285c8 | 68 | int baselen; |
c082df24 | 69 | int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */ |
0dcb8d7f | 70 | struct untracked_cache_dir *ucd; |
c082df24 AS |
71 | }; |
72 | ||
73 | struct exclude_list_group { | |
74 | int nr, alloc; | |
caa3d554 | 75 | struct pattern_list *pl; |
63d285c8 JH |
76 | }; |
77 | ||
4b33e602 | 78 | struct oid_stat { |
55fe6f51 | 79 | struct stat_data stat; |
4b33e602 | 80 | struct object_id oid; |
55fe6f51 NTND |
81 | int valid; |
82 | }; | |
83 | ||
0dcb8d7f NTND |
84 | /* |
85 | * Untracked cache | |
86 | * | |
87 | * The following inputs are sufficient to determine what files in a | |
88 | * directory are excluded: | |
89 | * | |
90 | * - The list of files and directories of the directory in question | |
91 | * - The $GIT_DIR/index | |
92 | * - dir_struct flags | |
93 | * - The content of $GIT_DIR/info/exclude | |
94 | * - The content of core.excludesfile | |
95 | * - The content (or the lack) of .gitignore of all parent directories | |
96 | * from $GIT_WORK_TREE | |
97 | * - The check_only flag in read_directory_recursive (for | |
98 | * DIR_HIDE_EMPTY_DIRECTORIES) | |
99 | * | |
100 | * The first input can be checked using directory mtime. In many | |
101 | * filesystems, directory mtime (stat_data field) is updated when its | |
102 | * files or direct subdirs are added or removed. | |
103 | * | |
104 | * The second one can be hooked from cache_tree_invalidate_path(). | |
105 | * Whenever a file (or a submodule) is added or removed from a | |
106 | * directory, we invalidate that directory. | |
107 | * | |
108 | * The remaining inputs are easy, their SHA-1 could be used to verify | |
109 | * their contents (exclude_sha1[], info_exclude_sha1[] and | |
110 | * excludes_file_sha1[]) | |
111 | */ | |
112 | struct untracked_cache_dir { | |
113 | struct untracked_cache_dir **dirs; | |
114 | char **untracked; | |
115 | struct stat_data stat_data; | |
116 | unsigned int untracked_alloc, dirs_nr, dirs_alloc; | |
117 | unsigned int untracked_nr; | |
118 | unsigned int check_only : 1; | |
26cb0182 | 119 | /* all data except 'dirs' in this struct are good */ |
ccad261f | 120 | unsigned int valid : 1; |
26cb0182 | 121 | unsigned int recurse : 1; |
70c369cd | 122 | /* null object ID means this directory does not have .gitignore */ |
123 | struct object_id exclude_oid; | |
0dcb8d7f NTND |
124 | char name[FLEX_ARRAY]; |
125 | }; | |
126 | ||
127 | struct untracked_cache { | |
4b33e602 PO |
128 | struct oid_stat ss_info_exclude; |
129 | struct oid_stat ss_excludes_file; | |
0dcb8d7f | 130 | const char *exclude_per_dir; |
1e8fef60 | 131 | struct strbuf ident; |
0dcb8d7f NTND |
132 | /* |
133 | * dir_struct#flags must match dir_flags or the untracked | |
134 | * cache is ignored. | |
135 | */ | |
136 | unsigned dir_flags; | |
137 | struct untracked_cache_dir *root; | |
138 | /* Statistics */ | |
139 | int dir_created; | |
ccad261f | 140 | int gitignore_invalidated; |
91a2288b NTND |
141 | int dir_invalidated; |
142 | int dir_opened; | |
883e248b BP |
143 | /* fsmonitor invalidation data */ |
144 | unsigned int use_fsmonitor : 1; | |
0dcb8d7f NTND |
145 | }; |
146 | ||
453ec4bd LT |
147 | struct dir_struct { |
148 | int nr, alloc; | |
2abd31b0 | 149 | int ignored_nr, ignored_alloc; |
7c4c97c0 JS |
150 | enum { |
151 | DIR_SHOW_IGNORED = 1<<0, | |
152 | DIR_SHOW_OTHER_DIRECTORIES = 1<<1, | |
153 | DIR_HIDE_EMPTY_DIRECTORIES = 1<<2, | |
154 | DIR_NO_GITLINKS = 1<<3, | |
0aaf62b6 | 155 | DIR_COLLECT_IGNORED = 1<<4, |
2eac2a4c | 156 | DIR_SHOW_IGNORED_TOO = 1<<5, |
fb898888 | 157 | DIR_COLLECT_KILLED_ONLY = 1<<6, |
eec0f7f2 | 158 | DIR_KEEP_UNTRACKED_CONTENTS = 1<<7, |
09487f2c EN |
159 | DIR_SHOW_IGNORED_TOO_MODE_MATCHING = 1<<8, |
160 | DIR_SKIP_NESTED_GIT = 1<<9 | |
7c4c97c0 | 161 | } flags; |
453ec4bd | 162 | struct dir_entry **entries; |
2abd31b0 | 163 | struct dir_entry **ignored; |
453ec4bd LT |
164 | |
165 | /* Exclude info */ | |
166 | const char *exclude_per_dir; | |
c082df24 | 167 | |
63d285c8 | 168 | /* |
c082df24 AS |
169 | * We maintain three groups of exclude pattern lists: |
170 | * | |
63d285c8 JH |
171 | * EXC_CMDL lists patterns explicitly given on the command line. |
172 | * EXC_DIRS lists patterns obtained from per-directory ignore files. | |
c082df24 AS |
173 | * EXC_FILE lists patterns from fallback ignore files, e.g. |
174 | * - .git/info/exclude | |
175 | * - core.excludesfile | |
176 | * | |
177 | * Each group contains multiple exclude lists, a single list | |
178 | * per source. | |
63d285c8 JH |
179 | */ |
180 | #define EXC_CMDL 0 | |
181 | #define EXC_DIRS 1 | |
182 | #define EXC_FILE 2 | |
c082df24 | 183 | struct exclude_list_group exclude_list_group[3]; |
63d285c8 | 184 | |
95a68344 AS |
185 | /* |
186 | * Temporary variables which are used during loading of the | |
187 | * per-directory exclude lists. | |
188 | * | |
189 | * exclude_stack points to the top of the exclude_stack, and | |
190 | * basebuf contains the full path to the current | |
95c6f271 KB |
191 | * (sub)directory in the traversal. Exclude points to the |
192 | * matching exclude struct if the directory is excluded. | |
95a68344 | 193 | */ |
63d285c8 | 194 | struct exclude_stack *exclude_stack; |
ab8db613 | 195 | struct path_pattern *pattern; |
aceb9429 | 196 | struct strbuf basebuf; |
0dcb8d7f NTND |
197 | |
198 | /* Enable untracked file cache if set */ | |
199 | struct untracked_cache *untracked; | |
4b33e602 PO |
200 | struct oid_stat ss_info_exclude; |
201 | struct oid_stat ss_excludes_file; | |
ccad261f | 202 | unsigned unmanaged_exclude_files; |
453ec4bd LT |
203 | }; |
204 | ||
e0556a92 | 205 | /*Count the number of slashes for string s*/ |
55454427 | 206 | int count_slashes(const char *s); |
e0556a92 | 207 | |
52ed1894 AS |
208 | /* |
209 | * The ordering of these constants is significant, with | |
210 | * higher-numbered match types signifying "closer" (i.e. more | |
211 | * specific) matches which will override lower-numbered match types | |
212 | * when populating the seen[] array. | |
213 | */ | |
e813d50e | 214 | #define MATCHED_RECURSIVELY 1 |
89a1f4aa EN |
215 | #define MATCHED_RECURSIVELY_LEADING_PATHSPEC 2 |
216 | #define MATCHED_FNMATCH 3 | |
217 | #define MATCHED_EXACTLY 4 | |
55454427 DL |
218 | int simple_length(const char *match); |
219 | int no_wildcard(const char *string); | |
220 | char *common_prefix(const struct pathspec *pathspec); | |
221 | int match_pathspec(const struct index_state *istate, | |
ad6dad09 DL |
222 | const struct pathspec *pathspec, |
223 | const char *name, int namelen, | |
224 | int prefix, char *seen, int is_dir); | |
4aeeef37 | 225 | int report_path_error(const char *ps_matched, const struct pathspec *pathspec); |
55454427 | 226 | int within_depth(const char *name, int namelen, int depth, int max_depth); |
3c6a370b | 227 | |
55454427 | 228 | int fill_directory(struct dir_struct *dir, |
ad6dad09 DL |
229 | struct index_state *istate, |
230 | const struct pathspec *pathspec); | |
55454427 | 231 | int read_directory(struct dir_struct *, struct index_state *istate, |
ad6dad09 DL |
232 | const char *path, int len, |
233 | const struct pathspec *pathspec); | |
f8a9d428 | 234 | |
468ce99b DS |
235 | enum pattern_match_result { |
236 | UNDECIDED = -1, | |
237 | NOT_MATCHED = 0, | |
238 | MATCHED = 1, | |
239 | }; | |
240 | ||
241 | /* | |
242 | * Scan the list of patterns to determine if the ordered list | |
243 | * of patterns matches on 'pathname'. | |
244 | * | |
245 | * Return 1 for a match, 0 for not matched and -1 for undecided. | |
246 | */ | |
247 | enum pattern_match_result path_matches_pattern_list(const char *pathname, | |
248 | int pathlen, | |
249 | const char *basename, int *dtype, | |
250 | struct pattern_list *pl, | |
251 | struct index_state *istate); | |
9e58beca BW |
252 | struct dir_entry *dir_add_ignored(struct dir_struct *dir, |
253 | struct index_state *istate, | |
254 | const char *pathname, int len); | |
eb41775e | 255 | |
82dce998 NTND |
256 | /* |
257 | * these implement the matching logic for dir.c:excluded_from_list and | |
258 | * attr.c:path_matches() | |
259 | */ | |
55454427 | 260 | int match_basename(const char *, int, |
ad6dad09 | 261 | const char *, int, int, unsigned); |
55454427 | 262 | int match_pathname(const char *, int, |
ad6dad09 DL |
263 | const char *, int, |
264 | const char *, int, int, unsigned); | |
82dce998 | 265 | |
65edd96a DS |
266 | struct path_pattern *last_matching_pattern(struct dir_struct *dir, |
267 | struct index_state *istate, | |
268 | const char *name, int *dtype); | |
782cd4c0 | 269 | |
55454427 | 270 | int is_excluded(struct dir_struct *dir, |
ad6dad09 DL |
271 | struct index_state *istate, |
272 | const char *name, int *dtype); | |
eb41775e | 273 | |
65edd96a | 274 | struct pattern_list *add_pattern_list(struct dir_struct *dir, |
ad6dad09 | 275 | int group_type, const char *src); |
65edd96a | 276 | int add_patterns_from_file_to_list(const char *fname, const char *base, int baselen, |
caa3d554 | 277 | struct pattern_list *pl, struct index_state *istate); |
65edd96a DS |
278 | void add_patterns_from_file(struct dir_struct *, const char *fname); |
279 | int add_patterns_from_blob_to_list(struct object_id *oid, | |
ad6dad09 | 280 | const char *base, int baselen, |
caa3d554 | 281 | struct pattern_list *pl); |
65edd96a DS |
282 | void parse_path_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen); |
283 | void add_pattern(const char *string, const char *base, | |
caa3d554 | 284 | int baselen, struct pattern_list *pl, int srcpos); |
65edd96a | 285 | void clear_pattern_list(struct pattern_list *pl); |
55454427 | 286 | void clear_directory(struct dir_struct *dir); |
0488481e NTND |
287 | |
288 | int repo_file_exists(struct repository *repo, const char *path); | |
289 | int file_exists(const char *); | |
453ec4bd | 290 | |
55454427 DL |
291 | int is_inside_dir(const char *dir); |
292 | int dir_inside_of(const char *subdir, const char *dir); | |
e6636747 | 293 | |
8ca12c0d AP |
294 | static inline int is_dot_or_dotdot(const char *name) |
295 | { | |
296 | return (name[0] == '.' && | |
297 | (name[1] == '\0' || | |
298 | (name[1] == '.' && name[2] == '\0'))); | |
299 | } | |
300 | ||
55454427 | 301 | int is_empty_dir(const char *dir); |
55892d23 | 302 | |
55454427 | 303 | void setup_standard_excludes(struct dir_struct *dir); |
a0f4afbe | 304 | |
728af283 MH |
305 | |
306 | /* Constants for remove_dir_recursively: */ | |
307 | ||
308 | /* | |
309 | * If a non-directory is found within path, stop and return an error. | |
310 | * (In this case some empty directories might already have been | |
311 | * removed.) | |
312 | */ | |
a0f4afbe | 313 | #define REMOVE_DIR_EMPTY_ONLY 01 |
728af283 MH |
314 | |
315 | /* | |
316 | * If any Git work trees are found within path, skip them without | |
317 | * considering it an error. | |
318 | */ | |
a0f4afbe | 319 | #define REMOVE_DIR_KEEP_NESTED_GIT 02 |
728af283 MH |
320 | |
321 | /* Remove the contents of path, but leave path itself. */ | |
c844a803 | 322 | #define REMOVE_DIR_KEEP_TOPLEVEL 04 |
728af283 MH |
323 | |
324 | /* | |
325 | * Remove path and its contents, recursively. flags is a combination | |
326 | * of the above REMOVE_DIR_* constants. Return 0 on success. | |
327 | * | |
328 | * This function uses path as temporary scratch space, but restores it | |
329 | * before returning. | |
330 | */ | |
55454427 | 331 | int remove_dir_recursively(struct strbuf *path, int flag); |
7155b727 | 332 | |
4a92d1bf | 333 | /* tries to remove the path with empty directories along it, ignores ENOENT */ |
55454427 | 334 | int remove_path(const char *path); |
4a92d1bf | 335 | |
55454427 DL |
336 | int fspathcmp(const char *a, const char *b); |
337 | int fspathncmp(const char *a, const char *b, size_t count); | |
8cf2a84e | 338 | |
5d74762d NTND |
339 | /* |
340 | * The prefix part of pattern must not contains wildcards. | |
341 | */ | |
bd30c2e4 | 342 | struct pathspec_item; |
55454427 | 343 | int git_fnmatch(const struct pathspec_item *item, |
ad6dad09 DL |
344 | const char *pattern, const char *string, |
345 | int prefix); | |
5d74762d | 346 | |
55454427 | 347 | int submodule_path_match(const struct index_state *istate, |
ad6dad09 DL |
348 | const struct pathspec *ps, |
349 | const char *submodule_name, | |
350 | char *seen); | |
75a6315f | 351 | |
6d2df284 NTND |
352 | static inline int ce_path_match(const struct index_state *istate, |
353 | const struct cache_entry *ce, | |
429bb40a NTND |
354 | const struct pathspec *pathspec, |
355 | char *seen) | |
356 | { | |
6d2df284 | 357 | return match_pathspec(istate, pathspec, ce->name, ce_namelen(ce), 0, seen, |
ae8d0824 | 358 | S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode)); |
429bb40a NTND |
359 | } |
360 | ||
6d2df284 NTND |
361 | static inline int dir_path_match(const struct index_state *istate, |
362 | const struct dir_entry *ent, | |
ebb32893 NTND |
363 | const struct pathspec *pathspec, |
364 | int prefix, char *seen) | |
365 | { | |
ae8d0824 NTND |
366 | int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/'; |
367 | int len = has_trailing_dir ? ent->len - 1 : ent->len; | |
6d2df284 | 368 | return match_pathspec(istate, pathspec, ent->name, len, prefix, seen, |
ae8d0824 | 369 | has_trailing_dir); |
ebb32893 NTND |
370 | } |
371 | ||
bbf504a9 SL |
372 | int cmp_dir_entry(const void *p1, const void *p2); |
373 | int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in); | |
374 | ||
0cacebf0 | 375 | void untracked_cache_invalidate_path(struct index_state *, const char *, int safe_path); |
e931371a NTND |
376 | void untracked_cache_remove_from_index(struct index_state *, const char *); |
377 | void untracked_cache_add_to_index(struct index_state *, const char *); | |
378 | ||
f9e6c649 NTND |
379 | void free_untracked_cache(struct untracked_cache *); |
380 | struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz); | |
83c094ad | 381 | void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked); |
4a4ca479 | 382 | void add_untracked_cache(struct index_state *istate); |
07b29bfd | 383 | void remove_untracked_cache(struct index_state *istate); |
da62f786 SB |
384 | |
385 | /* | |
386 | * Connect a worktree to a git directory by creating (or overwriting) a | |
387 | * '.git' file containing the location of the git directory. In the git | |
388 | * directory set the core.worktree setting to indicate where the worktree is. | |
389 | * When `recurse_into_nested` is set, recurse into any nested submodules, | |
390 | * connecting them as well. | |
391 | */ | |
55454427 | 392 | void connect_work_tree_and_git_dir(const char *work_tree, |
ad6dad09 DL |
393 | const char *git_dir, |
394 | int recurse_into_nested); | |
55454427 | 395 | void relocate_gitdir(const char *path, |
ad6dad09 DL |
396 | const char *old_git_dir, |
397 | const char *new_git_dir); | |
453ec4bd | 398 | #endif |