Git 2.15
[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
eb41775e
JH
6#include "strbuf.h"
7
453ec4bd 8struct dir_entry {
e96980ef 9 unsigned int len;
453ec4bd
LT
10 char name[FLEX_ARRAY]; /* more */
11};
12
68492fc7 13#define EXC_FLAG_NODIR 1
68492fc7 14#define EXC_FLAG_ENDSWITH 4
d6b8fc30 15#define EXC_FLAG_MUSTBEDIR 8
84460eec 16#define EXC_FLAG_NEGATIVE 16
68492fc7 17
709359c8
NTND
18struct 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;
f8708998 30 unsigned flags; /* EXC_FLAG_* */
709359c8
NTND
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
95a68344 39/*
c082df24
AS
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.
95a68344 45 */
453ec4bd
LT
46struct exclude_list {
47 int nr;
48 int alloc;
c04318e4 49
c082df24
AS
50 /* remember pointer to exclude file contents so we can free() */
51 char *filebuf;
52
c04318e4
AS
53 /* origin of list, e.g. path to filename, or descriptive string */
54 const char *src;
55
709359c8 56 struct exclude **excludes;
453ec4bd
LT
57};
58
95a68344
AS
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 */
63d285c8 65struct exclude_stack {
95a68344 66 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
63d285c8 67 int baselen;
c082df24 68 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
0dcb8d7f 69 struct untracked_cache_dir *ucd;
c082df24
AS
70};
71
72struct exclude_list_group {
73 int nr, alloc;
74 struct exclude_list *el;
63d285c8
JH
75};
76
55fe6f51
NTND
77struct sha1_stat {
78 struct stat_data stat;
79 unsigned char sha1[20];
80 int valid;
81};
82
0dcb8d7f
NTND
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 */
111struct 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;
26cb0182 118 /* all data except 'dirs' in this struct are good */
ccad261f 119 unsigned int valid : 1;
26cb0182 120 unsigned int recurse : 1;
0dcb8d7f
NTND
121 /* null SHA-1 means this directory does not have .gitignore */
122 unsigned char exclude_sha1[20];
123 char name[FLEX_ARRAY];
124};
125
126struct untracked_cache {
127 struct sha1_stat ss_info_exclude;
128 struct sha1_stat ss_excludes_file;
129 const char *exclude_per_dir;
1e8fef60 130 struct strbuf ident;
0dcb8d7f
NTND
131 /*
132 * dir_struct#flags must match dir_flags or the untracked
133 * cache is ignored.
134 */
135 unsigned dir_flags;
136 struct untracked_cache_dir *root;
137 /* Statistics */
138 int dir_created;
ccad261f 139 int gitignore_invalidated;
91a2288b
NTND
140 int dir_invalidated;
141 int dir_opened;
0dcb8d7f
NTND
142};
143
453ec4bd
LT
144struct dir_struct {
145 int nr, alloc;
2abd31b0 146 int ignored_nr, ignored_alloc;
7c4c97c0
JS
147 enum {
148 DIR_SHOW_IGNORED = 1<<0,
149 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
150 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
151 DIR_NO_GITLINKS = 1<<3,
0aaf62b6 152 DIR_COLLECT_IGNORED = 1<<4,
2eac2a4c 153 DIR_SHOW_IGNORED_TOO = 1<<5,
fb898888
SL
154 DIR_COLLECT_KILLED_ONLY = 1<<6,
155 DIR_KEEP_UNTRACKED_CONTENTS = 1<<7
7c4c97c0 156 } flags;
453ec4bd 157 struct dir_entry **entries;
2abd31b0 158 struct dir_entry **ignored;
453ec4bd
LT
159
160 /* Exclude info */
161 const char *exclude_per_dir;
c082df24 162
63d285c8 163 /*
c082df24
AS
164 * We maintain three groups of exclude pattern lists:
165 *
63d285c8
JH
166 * EXC_CMDL lists patterns explicitly given on the command line.
167 * EXC_DIRS lists patterns obtained from per-directory ignore files.
c082df24
AS
168 * EXC_FILE lists patterns from fallback ignore files, e.g.
169 * - .git/info/exclude
170 * - core.excludesfile
171 *
172 * Each group contains multiple exclude lists, a single list
173 * per source.
63d285c8
JH
174 */
175#define EXC_CMDL 0
176#define EXC_DIRS 1
177#define EXC_FILE 2
c082df24 178 struct exclude_list_group exclude_list_group[3];
63d285c8 179
95a68344
AS
180 /*
181 * Temporary variables which are used during loading of the
182 * per-directory exclude lists.
183 *
184 * exclude_stack points to the top of the exclude_stack, and
185 * basebuf contains the full path to the current
95c6f271
KB
186 * (sub)directory in the traversal. Exclude points to the
187 * matching exclude struct if the directory is excluded.
95a68344 188 */
63d285c8 189 struct exclude_stack *exclude_stack;
95c6f271 190 struct exclude *exclude;
aceb9429 191 struct strbuf basebuf;
0dcb8d7f
NTND
192
193 /* Enable untracked file cache if set */
194 struct untracked_cache *untracked;
195 struct sha1_stat ss_info_exclude;
196 struct sha1_stat ss_excludes_file;
ccad261f 197 unsigned unmanaged_exclude_files;
453ec4bd
LT
198};
199
e0556a92
PC
200/*Count the number of slashes for string s*/
201extern int count_slashes(const char *s);
202
52ed1894
AS
203/*
204 * The ordering of these constants is significant, with
205 * higher-numbered match types signifying "closer" (i.e. more
206 * specific) matches which will override lower-numbered match types
207 * when populating the seen[] array.
208 */
e813d50e
JH
209#define MATCHED_RECURSIVELY 1
210#define MATCHED_FNMATCH 2
211#define MATCHED_EXACTLY 3
87323bda
NTND
212extern int simple_length(const char *match);
213extern int no_wildcard(const char *string);
827f4d6c 214extern char *common_prefix(const struct pathspec *pathspec);
854b0959
NTND
215extern int match_pathspec(const struct pathspec *pathspec,
216 const char *name, int namelen,
ae8d0824 217 int prefix, char *seen, int is_dir);
777c55a6 218extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
bc96cc87 219extern int within_depth(const char *name, int namelen, int depth, int max_depth);
3c6a370b 220
0d32c183
BW
221extern int fill_directory(struct dir_struct *dir,
222 struct index_state *istate,
223 const struct pathspec *pathspec);
2c1eb104
BW
224extern int read_directory(struct dir_struct *, struct index_state *istate,
225 const char *path, int len,
226 const struct pathspec *pathspec);
f8a9d428 227
fba92be8
BW
228extern int is_excluded_from_list(const char *pathname, int pathlen,
229 const char *basename, int *dtype,
230 struct exclude_list *el,
231 struct index_state *istate);
9e58beca
BW
232struct dir_entry *dir_add_ignored(struct dir_struct *dir,
233 struct index_state *istate,
234 const char *pathname, int len);
eb41775e 235
82dce998
NTND
236/*
237 * these implement the matching logic for dir.c:excluded_from_list and
238 * attr.c:path_matches()
239 */
240extern int match_basename(const char *, int,
f8708998 241 const char *, int, int, unsigned);
82dce998
NTND
242extern int match_pathname(const char *, int,
243 const char *, int,
f8708998 244 const char *, int, int, unsigned);
82dce998 245
b07bc8c8 246extern struct exclude *last_exclude_matching(struct dir_struct *dir,
a0bba65b 247 struct index_state *istate,
b07bc8c8 248 const char *name, int *dtype);
782cd4c0 249
a0bba65b
BW
250extern int is_excluded(struct dir_struct *dir,
251 struct index_state *istate,
252 const char *name, int *dtype);
eb41775e 253
c04318e4
AS
254extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
255 int group_type, const char *src);
cb097534 256extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
473e3930 257 struct exclude_list *el, struct index_state *istate);
453ec4bd 258extern void add_excludes_from_file(struct dir_struct *, const char *fname);
f8708998 259extern void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
453ec4bd 260extern void add_exclude(const char *string, const char *base,
c04318e4 261 int baselen, struct exclude_list *el, int srcpos);
f6198812 262extern void clear_exclude_list(struct exclude_list *el);
270be816 263extern void clear_directory(struct dir_struct *dir);
c91f0d92 264extern int file_exists(const char *);
453ec4bd 265
e6636747 266extern int is_inside_dir(const char *dir);
9b125da4 267extern int dir_inside_of(const char *subdir, const char *dir);
e6636747 268
8ca12c0d
AP
269static inline int is_dot_or_dotdot(const char *name)
270{
271 return (name[0] == '.' &&
272 (name[1] == '\0' ||
273 (name[1] == '.' && name[2] == '\0')));
274}
275
55892d23
AP
276extern int is_empty_dir(const char *dir);
277
039bc64e 278extern void setup_standard_excludes(struct dir_struct *dir);
a0f4afbe 279
728af283
MH
280
281/* Constants for remove_dir_recursively: */
282
283/*
284 * If a non-directory is found within path, stop and return an error.
285 * (In this case some empty directories might already have been
286 * removed.)
287 */
a0f4afbe 288#define REMOVE_DIR_EMPTY_ONLY 01
728af283
MH
289
290/*
291 * If any Git work trees are found within path, skip them without
292 * considering it an error.
293 */
a0f4afbe 294#define REMOVE_DIR_KEEP_NESTED_GIT 02
728af283
MH
295
296/* Remove the contents of path, but leave path itself. */
c844a803 297#define REMOVE_DIR_KEEP_TOPLEVEL 04
728af283
MH
298
299/*
300 * Remove path and its contents, recursively. flags is a combination
301 * of the above REMOVE_DIR_* constants. Return 0 on success.
302 *
303 * This function uses path as temporary scratch space, but restores it
304 * before returning.
305 */
a0f4afbe 306extern int remove_dir_recursively(struct strbuf *path, int flag);
7155b727 307
4a92d1bf
AR
308/* tries to remove the path with empty directories along it, ignores ENOENT */
309extern int remove_path(const char *path);
310
ba0897e6
NTND
311extern int fspathcmp(const char *a, const char *b);
312extern int fspathncmp(const char *a, const char *b, size_t count);
8cf2a84e 313
5d74762d
NTND
314/*
315 * The prefix part of pattern must not contains wildcards.
316 */
bd30c2e4
NTND
317struct pathspec_item;
318extern int git_fnmatch(const struct pathspec_item *item,
319 const char *pattern, const char *string,
320 int prefix);
5d74762d 321
75a6315f
BW
322extern int submodule_path_match(const struct pathspec *ps,
323 const char *submodule_name,
324 char *seen);
325
429bb40a
NTND
326static inline int ce_path_match(const struct cache_entry *ce,
327 const struct pathspec *pathspec,
328 char *seen)
329{
ae8d0824
NTND
330 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
331 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
429bb40a
NTND
332}
333
ebb32893
NTND
334static inline int dir_path_match(const struct dir_entry *ent,
335 const struct pathspec *pathspec,
336 int prefix, char *seen)
337{
ae8d0824
NTND
338 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
339 int len = has_trailing_dir ? ent->len - 1 : ent->len;
340 return match_pathspec(pathspec, ent->name, len, prefix, seen,
341 has_trailing_dir);
ebb32893
NTND
342}
343
bbf504a9
SL
344int cmp_dir_entry(const void *p1, const void *p2);
345int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);
346
e931371a
NTND
347void untracked_cache_invalidate_path(struct index_state *, const char *);
348void untracked_cache_remove_from_index(struct index_state *, const char *);
349void untracked_cache_add_to_index(struct index_state *, const char *);
350
f9e6c649
NTND
351void free_untracked_cache(struct untracked_cache *);
352struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
83c094ad 353void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
4a4ca479 354void add_untracked_cache(struct index_state *istate);
07b29bfd 355void remove_untracked_cache(struct index_state *istate);
47e83eb3 356extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
f6f85861
SB
357extern void relocate_gitdir(const char *path,
358 const char *old_git_dir,
359 const char *new_git_dir);
453ec4bd 360#endif