Merge branch 'mh/notes-duplicate-entries'
[git/git.git] / dir.h
CommitLineData
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 9struct dir_entry {
e96980ef 10 unsigned int len;
453ec4bd
LT
11 char name[FLEX_ARRAY]; /* more */
12};
13
68492fc7 14#define EXC_FLAG_NODIR 1
68492fc7 15#define EXC_FLAG_ENDSWITH 4
d6b8fc30 16#define EXC_FLAG_MUSTBEDIR 8
84460eec 17#define EXC_FLAG_NEGATIVE 16
68492fc7 18
709359c8
NTND
19struct exclude {
20 /*
21 * This allows callers of last_exclude_matching() etc.
22 * to determine the origin of the matching pattern.
23 */
24 struct exclude_list *el;
25
26 const char *pattern;
27 int patternlen;
28 int nowildcardlen;
29 const char *base;
30 int baselen;
f8708998 31 unsigned flags; /* EXC_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 */
453ec4bd
LT
47struct exclude_list {
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
709359c8 57 struct exclude **excludes;
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 66struct 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
73struct exclude_list_group {
74 int nr, alloc;
75 struct exclude_list *el;
63d285c8
JH
76};
77
4b33e602 78struct 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 */
112struct 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
127struct 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
147struct 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
JM
158 DIR_KEEP_UNTRACKED_CONTENTS = 1<<7,
159 DIR_SHOW_IGNORED_TOO_MODE_MATCHING = 1<<8
7c4c97c0 160 } flags;
453ec4bd 161 struct dir_entry **entries;
2abd31b0 162 struct dir_entry **ignored;
453ec4bd
LT
163
164 /* Exclude info */
165 const char *exclude_per_dir;
c082df24 166
63d285c8 167 /*
c082df24
AS
168 * We maintain three groups of exclude pattern lists:
169 *
63d285c8
JH
170 * EXC_CMDL lists patterns explicitly given on the command line.
171 * EXC_DIRS lists patterns obtained from per-directory ignore files.
c082df24
AS
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.
63d285c8
JH
178 */
179#define EXC_CMDL 0
180#define EXC_DIRS 1
181#define EXC_FILE 2
c082df24 182 struct exclude_list_group exclude_list_group[3];
63d285c8 183
95a68344
AS
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
95c6f271
KB
190 * (sub)directory in the traversal. Exclude points to the
191 * matching exclude struct if the directory is excluded.
95a68344 192 */
63d285c8 193 struct exclude_stack *exclude_stack;
95c6f271 194 struct exclude *exclude;
aceb9429 195 struct strbuf basebuf;
0dcb8d7f
NTND
196
197 /* Enable untracked file cache if set */
198 struct untracked_cache *untracked;
4b33e602
PO
199 struct oid_stat ss_info_exclude;
200 struct oid_stat ss_excludes_file;
ccad261f 201 unsigned unmanaged_exclude_files;
453ec4bd
LT
202};
203
e0556a92 204/*Count the number of slashes for string s*/
55454427 205int count_slashes(const char *s);
e0556a92 206
52ed1894
AS
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 */
e813d50e
JH
213#define MATCHED_RECURSIVELY 1
214#define MATCHED_FNMATCH 2
215#define MATCHED_EXACTLY 3
55454427
DL
216int simple_length(const char *match);
217int no_wildcard(const char *string);
218char *common_prefix(const struct pathspec *pathspec);
219int match_pathspec(const struct index_state *istate,
ad6dad09
DL
220 const struct pathspec *pathspec,
221 const char *name, int namelen,
222 int prefix, char *seen, int is_dir);
4aeeef37 223int report_path_error(const char *ps_matched, const struct pathspec *pathspec);
55454427 224int within_depth(const char *name, int namelen, int depth, int max_depth);
3c6a370b 225
55454427 226int fill_directory(struct dir_struct *dir,
ad6dad09
DL
227 struct index_state *istate,
228 const struct pathspec *pathspec);
55454427 229int read_directory(struct dir_struct *, struct index_state *istate,
ad6dad09
DL
230 const char *path, int len,
231 const struct pathspec *pathspec);
f8a9d428 232
55454427 233int is_excluded_from_list(const char *pathname, int pathlen,
ad6dad09
DL
234 const char *basename, int *dtype,
235 struct exclude_list *el,
236 struct index_state *istate);
9e58beca
BW
237struct dir_entry *dir_add_ignored(struct dir_struct *dir,
238 struct index_state *istate,
239 const char *pathname, int len);
eb41775e 240
82dce998
NTND
241/*
242 * these implement the matching logic for dir.c:excluded_from_list and
243 * attr.c:path_matches()
244 */
55454427 245int match_basename(const char *, int,
ad6dad09 246 const char *, int, int, unsigned);
55454427 247int match_pathname(const char *, int,
ad6dad09
DL
248 const char *, int,
249 const char *, int, int, unsigned);
82dce998 250
55454427 251struct exclude *last_exclude_matching(struct dir_struct *dir,
ad6dad09
DL
252 struct index_state *istate,
253 const char *name, int *dtype);
782cd4c0 254
55454427 255int is_excluded(struct dir_struct *dir,
ad6dad09
DL
256 struct index_state *istate,
257 const char *name, int *dtype);
eb41775e 258
55454427 259struct exclude_list *add_exclude_list(struct dir_struct *dir,
ad6dad09 260 int group_type, const char *src);
55454427 261int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
ad6dad09 262 struct exclude_list *el, struct index_state *istate);
55454427
DL
263void add_excludes_from_file(struct dir_struct *, const char *fname);
264int add_excludes_from_blob_to_list(struct object_id *oid,
ad6dad09
DL
265 const char *base, int baselen,
266 struct exclude_list *el);
55454427
DL
267void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
268void add_exclude(const char *string, const char *base,
ad6dad09 269 int baselen, struct exclude_list *el, int srcpos);
55454427
DL
270void clear_exclude_list(struct exclude_list *el);
271void clear_directory(struct dir_struct *dir);
0488481e
NTND
272
273int repo_file_exists(struct repository *repo, const char *path);
274int file_exists(const char *);
453ec4bd 275
55454427
DL
276int is_inside_dir(const char *dir);
277int dir_inside_of(const char *subdir, const char *dir);
e6636747 278
8ca12c0d
AP
279static inline int is_dot_or_dotdot(const char *name)
280{
281 return (name[0] == '.' &&
282 (name[1] == '\0' ||
283 (name[1] == '.' && name[2] == '\0')));
284}
285
55454427 286int is_empty_dir(const char *dir);
55892d23 287
55454427 288void setup_standard_excludes(struct dir_struct *dir);
a0f4afbe 289
728af283
MH
290
291/* Constants for remove_dir_recursively: */
292
293/*
294 * If a non-directory is found within path, stop and return an error.
295 * (In this case some empty directories might already have been
296 * removed.)
297 */
a0f4afbe 298#define REMOVE_DIR_EMPTY_ONLY 01
728af283
MH
299
300/*
301 * If any Git work trees are found within path, skip them without
302 * considering it an error.
303 */
a0f4afbe 304#define REMOVE_DIR_KEEP_NESTED_GIT 02
728af283
MH
305
306/* Remove the contents of path, but leave path itself. */
c844a803 307#define REMOVE_DIR_KEEP_TOPLEVEL 04
728af283
MH
308
309/*
310 * Remove path and its contents, recursively. flags is a combination
311 * of the above REMOVE_DIR_* constants. Return 0 on success.
312 *
313 * This function uses path as temporary scratch space, but restores it
314 * before returning.
315 */
55454427 316int remove_dir_recursively(struct strbuf *path, int flag);
7155b727 317
4a92d1bf 318/* tries to remove the path with empty directories along it, ignores ENOENT */
55454427 319int remove_path(const char *path);
4a92d1bf 320
55454427
DL
321int fspathcmp(const char *a, const char *b);
322int fspathncmp(const char *a, const char *b, size_t count);
8cf2a84e 323
5d74762d
NTND
324/*
325 * The prefix part of pattern must not contains wildcards.
326 */
bd30c2e4 327struct pathspec_item;
55454427 328int git_fnmatch(const struct pathspec_item *item,
ad6dad09
DL
329 const char *pattern, const char *string,
330 int prefix);
5d74762d 331
55454427 332int submodule_path_match(const struct index_state *istate,
ad6dad09
DL
333 const struct pathspec *ps,
334 const char *submodule_name,
335 char *seen);
75a6315f 336
6d2df284
NTND
337static inline int ce_path_match(const struct index_state *istate,
338 const struct cache_entry *ce,
429bb40a
NTND
339 const struct pathspec *pathspec,
340 char *seen)
341{
6d2df284 342 return match_pathspec(istate, pathspec, ce->name, ce_namelen(ce), 0, seen,
ae8d0824 343 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
429bb40a
NTND
344}
345
6d2df284
NTND
346static inline int dir_path_match(const struct index_state *istate,
347 const struct dir_entry *ent,
ebb32893
NTND
348 const struct pathspec *pathspec,
349 int prefix, char *seen)
350{
ae8d0824
NTND
351 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
352 int len = has_trailing_dir ? ent->len - 1 : ent->len;
6d2df284 353 return match_pathspec(istate, pathspec, ent->name, len, prefix, seen,
ae8d0824 354 has_trailing_dir);
ebb32893
NTND
355}
356
bbf504a9
SL
357int cmp_dir_entry(const void *p1, const void *p2);
358int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);
359
0cacebf0 360void untracked_cache_invalidate_path(struct index_state *, const char *, int safe_path);
e931371a
NTND
361void untracked_cache_remove_from_index(struct index_state *, const char *);
362void untracked_cache_add_to_index(struct index_state *, const char *);
363
f9e6c649
NTND
364void free_untracked_cache(struct untracked_cache *);
365struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
83c094ad 366void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
4a4ca479 367void add_untracked_cache(struct index_state *istate);
07b29bfd 368void remove_untracked_cache(struct index_state *istate);
da62f786
SB
369
370/*
371 * Connect a worktree to a git directory by creating (or overwriting) a
372 * '.git' file containing the location of the git directory. In the git
373 * directory set the core.worktree setting to indicate where the worktree is.
374 * When `recurse_into_nested` is set, recurse into any nested submodules,
375 * connecting them as well.
376 */
55454427 377void connect_work_tree_and_git_dir(const char *work_tree,
ad6dad09
DL
378 const char *git_dir,
379 int recurse_into_nested);
55454427 380void relocate_gitdir(const char *path,
ad6dad09
DL
381 const char *old_git_dir,
382 const char *new_git_dir);
453ec4bd 383#endif