Merge branch 'jc/git-gui-has-maintainer'
[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 "cache.h"
7 #include "strbuf.h"
8
9 struct dir_entry {
10 unsigned int len;
11 char name[FLEX_ARRAY]; /* more */
12 };
13
14 #define PATTERN_FLAG_NODIR 1
15 #define PATTERN_FLAG_ENDSWITH 4
16 #define PATTERN_FLAG_MUSTBEDIR 8
17 #define PATTERN_FLAG_NEGATIVE 16
18
19 struct path_pattern {
20 /*
21 * This allows callers of last_matching_pattern() etc.
22 * to determine the origin of the matching pattern.
23 */
24 struct pattern_list *pl;
25
26 const char *pattern;
27 int patternlen;
28 int nowildcardlen;
29 const char *base;
30 int baselen;
31 unsigned flags; /* PATTERN_FLAG_* */
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
40 /*
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.
46 */
47 struct pattern_list {
48 int nr;
49 int alloc;
50
51 /* remember pointer to exclude file contents so we can free() */
52 char *filebuf;
53
54 /* origin of list, e.g. path to filename, or descriptive string */
55 const char *src;
56
57 struct path_pattern **patterns;
58 };
59
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 */
66 struct exclude_stack {
67 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
68 int baselen;
69 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
70 struct untracked_cache_dir *ucd;
71 };
72
73 struct exclude_list_group {
74 int nr, alloc;
75 struct pattern_list *pl;
76 };
77
78 struct oid_stat {
79 struct stat_data stat;
80 struct object_id oid;
81 int valid;
82 };
83
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;
119 /* all data except 'dirs' in this struct are good */
120 unsigned int valid : 1;
121 unsigned int recurse : 1;
122 /* null object ID means this directory does not have .gitignore */
123 struct object_id exclude_oid;
124 char name[FLEX_ARRAY];
125 };
126
127 struct untracked_cache {
128 struct oid_stat ss_info_exclude;
129 struct oid_stat ss_excludes_file;
130 const char *exclude_per_dir;
131 struct strbuf ident;
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;
140 int gitignore_invalidated;
141 int dir_invalidated;
142 int dir_opened;
143 /* fsmonitor invalidation data */
144 unsigned int use_fsmonitor : 1;
145 };
146
147 struct dir_struct {
148 int nr, alloc;
149 int ignored_nr, ignored_alloc;
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,
155 DIR_COLLECT_IGNORED = 1<<4,
156 DIR_SHOW_IGNORED_TOO = 1<<5,
157 DIR_COLLECT_KILLED_ONLY = 1<<6,
158 DIR_KEEP_UNTRACKED_CONTENTS = 1<<7,
159 DIR_SHOW_IGNORED_TOO_MODE_MATCHING = 1<<8
160 } flags;
161 struct dir_entry **entries;
162 struct dir_entry **ignored;
163
164 /* Exclude info */
165 const char *exclude_per_dir;
166
167 /*
168 * We maintain three groups of exclude pattern lists:
169 *
170 * EXC_CMDL lists patterns explicitly given on the command line.
171 * EXC_DIRS lists patterns obtained from per-directory ignore files.
172 * EXC_FILE lists patterns from fallback ignore files, e.g.
173 * - .git/info/exclude
174 * - core.excludesfile
175 *
176 * Each group contains multiple exclude lists, a single list
177 * per source.
178 */
179 #define EXC_CMDL 0
180 #define EXC_DIRS 1
181 #define EXC_FILE 2
182 struct exclude_list_group exclude_list_group[3];
183
184 /*
185 * Temporary variables which are used during loading of the
186 * per-directory exclude lists.
187 *
188 * exclude_stack points to the top of the exclude_stack, and
189 * basebuf contains the full path to the current
190 * (sub)directory in the traversal. Exclude points to the
191 * matching exclude struct if the directory is excluded.
192 */
193 struct exclude_stack *exclude_stack;
194 struct path_pattern *pattern;
195 struct strbuf basebuf;
196
197 /* Enable untracked file cache if set */
198 struct untracked_cache *untracked;
199 struct oid_stat ss_info_exclude;
200 struct oid_stat ss_excludes_file;
201 unsigned unmanaged_exclude_files;
202 };
203
204 /*Count the number of slashes for string s*/
205 int count_slashes(const char *s);
206
207 /*
208 * The ordering of these constants is significant, with
209 * higher-numbered match types signifying "closer" (i.e. more
210 * specific) matches which will override lower-numbered match types
211 * when populating the seen[] array.
212 */
213 #define MATCHED_RECURSIVELY 1
214 #define MATCHED_FNMATCH 2
215 #define MATCHED_EXACTLY 3
216 int simple_length(const char *match);
217 int no_wildcard(const char *string);
218 char *common_prefix(const struct pathspec *pathspec);
219 int match_pathspec(const struct index_state *istate,
220 const struct pathspec *pathspec,
221 const char *name, int namelen,
222 int prefix, char *seen, int is_dir);
223 int report_path_error(const char *ps_matched, const struct pathspec *pathspec);
224 int within_depth(const char *name, int namelen, int depth, int max_depth);
225
226 int fill_directory(struct dir_struct *dir,
227 struct index_state *istate,
228 const struct pathspec *pathspec);
229 int read_directory(struct dir_struct *, struct index_state *istate,
230 const char *path, int len,
231 const struct pathspec *pathspec);
232
233 enum pattern_match_result {
234 UNDECIDED = -1,
235 NOT_MATCHED = 0,
236 MATCHED = 1,
237 };
238
239 /*
240 * Scan the list of patterns to determine if the ordered list
241 * of patterns matches on 'pathname'.
242 *
243 * Return 1 for a match, 0 for not matched and -1 for undecided.
244 */
245 enum pattern_match_result path_matches_pattern_list(const char *pathname,
246 int pathlen,
247 const char *basename, int *dtype,
248 struct pattern_list *pl,
249 struct index_state *istate);
250 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
251 struct index_state *istate,
252 const char *pathname, int len);
253
254 /*
255 * these implement the matching logic for dir.c:excluded_from_list and
256 * attr.c:path_matches()
257 */
258 int match_basename(const char *, int,
259 const char *, int, int, unsigned);
260 int match_pathname(const char *, int,
261 const char *, int,
262 const char *, int, int, unsigned);
263
264 struct path_pattern *last_matching_pattern(struct dir_struct *dir,
265 struct index_state *istate,
266 const char *name, int *dtype);
267
268 int is_excluded(struct dir_struct *dir,
269 struct index_state *istate,
270 const char *name, int *dtype);
271
272 struct pattern_list *add_pattern_list(struct dir_struct *dir,
273 int group_type, const char *src);
274 int add_patterns_from_file_to_list(const char *fname, const char *base, int baselen,
275 struct pattern_list *pl, struct index_state *istate);
276 void add_patterns_from_file(struct dir_struct *, const char *fname);
277 int add_patterns_from_blob_to_list(struct object_id *oid,
278 const char *base, int baselen,
279 struct pattern_list *pl);
280 void parse_path_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
281 void add_pattern(const char *string, const char *base,
282 int baselen, struct pattern_list *pl, int srcpos);
283 void clear_pattern_list(struct pattern_list *pl);
284 void clear_directory(struct dir_struct *dir);
285
286 int repo_file_exists(struct repository *repo, const char *path);
287 int file_exists(const char *);
288
289 int is_inside_dir(const char *dir);
290 int dir_inside_of(const char *subdir, const char *dir);
291
292 static inline int is_dot_or_dotdot(const char *name)
293 {
294 return (name[0] == '.' &&
295 (name[1] == '\0' ||
296 (name[1] == '.' && name[2] == '\0')));
297 }
298
299 int is_empty_dir(const char *dir);
300
301 void setup_standard_excludes(struct dir_struct *dir);
302
303
304 /* Constants for remove_dir_recursively: */
305
306 /*
307 * If a non-directory is found within path, stop and return an error.
308 * (In this case some empty directories might already have been
309 * removed.)
310 */
311 #define REMOVE_DIR_EMPTY_ONLY 01
312
313 /*
314 * If any Git work trees are found within path, skip them without
315 * considering it an error.
316 */
317 #define REMOVE_DIR_KEEP_NESTED_GIT 02
318
319 /* Remove the contents of path, but leave path itself. */
320 #define REMOVE_DIR_KEEP_TOPLEVEL 04
321
322 /*
323 * Remove path and its contents, recursively. flags is a combination
324 * of the above REMOVE_DIR_* constants. Return 0 on success.
325 *
326 * This function uses path as temporary scratch space, but restores it
327 * before returning.
328 */
329 int remove_dir_recursively(struct strbuf *path, int flag);
330
331 /* tries to remove the path with empty directories along it, ignores ENOENT */
332 int remove_path(const char *path);
333
334 int fspathcmp(const char *a, const char *b);
335 int fspathncmp(const char *a, const char *b, size_t count);
336
337 /*
338 * The prefix part of pattern must not contains wildcards.
339 */
340 struct pathspec_item;
341 int git_fnmatch(const struct pathspec_item *item,
342 const char *pattern, const char *string,
343 int prefix);
344
345 int submodule_path_match(const struct index_state *istate,
346 const struct pathspec *ps,
347 const char *submodule_name,
348 char *seen);
349
350 static inline int ce_path_match(const struct index_state *istate,
351 const struct cache_entry *ce,
352 const struct pathspec *pathspec,
353 char *seen)
354 {
355 return match_pathspec(istate, pathspec, ce->name, ce_namelen(ce), 0, seen,
356 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
357 }
358
359 static inline int dir_path_match(const struct index_state *istate,
360 const struct dir_entry *ent,
361 const struct pathspec *pathspec,
362 int prefix, char *seen)
363 {
364 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
365 int len = has_trailing_dir ? ent->len - 1 : ent->len;
366 return match_pathspec(istate, pathspec, ent->name, len, prefix, seen,
367 has_trailing_dir);
368 }
369
370 int cmp_dir_entry(const void *p1, const void *p2);
371 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);
372
373 void untracked_cache_invalidate_path(struct index_state *, const char *, int safe_path);
374 void untracked_cache_remove_from_index(struct index_state *, const char *);
375 void untracked_cache_add_to_index(struct index_state *, const char *);
376
377 void free_untracked_cache(struct untracked_cache *);
378 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
379 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
380 void add_untracked_cache(struct index_state *istate);
381 void remove_untracked_cache(struct index_state *istate);
382
383 /*
384 * Connect a worktree to a git directory by creating (or overwriting) a
385 * '.git' file containing the location of the git directory. In the git
386 * directory set the core.worktree setting to indicate where the worktree is.
387 * When `recurse_into_nested` is set, recurse into any nested submodules,
388 * connecting them as well.
389 */
390 void connect_work_tree_and_git_dir(const char *work_tree,
391 const char *git_dir,
392 int recurse_into_nested);
393 void relocate_gitdir(const char *path,
394 const char *old_git_dir,
395 const char *new_git_dir);
396 #endif