Merge tag 'v2.14.1'
[git/raj.git] / dir.h
blobe3717055d193366e6780b50d68f6a3c2360d32c4
1 #ifndef DIR_H
2 #define DIR_H
4 /* See Documentation/technical/api-directory-listing.txt */
6 #include "strbuf.h"
8 struct dir_entry {
9 unsigned int len;
10 char name[FLEX_ARRAY]; /* more */
13 #define EXC_FLAG_NODIR 1
14 #define EXC_FLAG_ENDSWITH 4
15 #define EXC_FLAG_MUSTBEDIR 8
16 #define EXC_FLAG_NEGATIVE 16
18 struct exclude {
20 * This allows callers of last_exclude_matching() etc.
21 * to determine the origin of the matching pattern.
23 struct exclude_list *el;
25 const char *pattern;
26 int patternlen;
27 int nowildcardlen;
28 const char *base;
29 int baselen;
30 unsigned flags; /* EXC_FLAG_* */
33 * Counting starts from 1 for line numbers in ignore files,
34 * and from -1 decrementing for patterns from CLI args.
36 int srcpos;
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.
46 struct exclude_list {
47 int nr;
48 int alloc;
50 /* remember pointer to exclude file contents so we can free() */
51 char *filebuf;
53 /* origin of list, e.g. path to filename, or descriptive string */
54 const char *src;
56 struct exclude **excludes;
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.
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;
72 struct exclude_list_group {
73 int nr, alloc;
74 struct exclude_list *el;
77 struct sha1_stat {
78 struct stat_data stat;
79 unsigned char sha1[20];
80 int valid;
84 * Untracked cache
86 * The following inputs are sufficient to determine what files in a
87 * directory are excluded:
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)
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.
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.
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[])
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];
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 struct strbuf ident;
132 * dir_struct#flags must match dir_flags or the untracked
133 * cache is ignored.
135 unsigned dir_flags;
136 struct untracked_cache_dir *root;
137 /* Statistics */
138 int dir_created;
139 int gitignore_invalidated;
140 int dir_invalidated;
141 int dir_opened;
144 struct dir_struct {
145 int nr, alloc;
146 int ignored_nr, ignored_alloc;
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,
152 DIR_COLLECT_IGNORED = 1<<4,
153 DIR_SHOW_IGNORED_TOO = 1<<5,
154 DIR_COLLECT_KILLED_ONLY = 1<<6,
155 DIR_KEEP_UNTRACKED_CONTENTS = 1<<7
156 } flags;
157 struct dir_entry **entries;
158 struct dir_entry **ignored;
160 /* Exclude info */
161 const char *exclude_per_dir;
164 * We maintain three groups of exclude pattern lists:
166 * EXC_CMDL lists patterns explicitly given on the command line.
167 * EXC_DIRS lists patterns obtained from per-directory ignore files.
168 * EXC_FILE lists patterns from fallback ignore files, e.g.
169 * - .git/info/exclude
170 * - core.excludesfile
172 * Each group contains multiple exclude lists, a single list
173 * per source.
175 #define EXC_CMDL 0
176 #define EXC_DIRS 1
177 #define EXC_FILE 2
178 struct exclude_list_group exclude_list_group[3];
181 * Temporary variables which are used during loading of the
182 * per-directory exclude lists.
184 * exclude_stack points to the top of the exclude_stack, and
185 * basebuf contains the full path to the current
186 * (sub)directory in the traversal. Exclude points to the
187 * matching exclude struct if the directory is excluded.
189 struct exclude_stack *exclude_stack;
190 struct exclude *exclude;
191 struct strbuf basebuf;
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;
197 unsigned unmanaged_exclude_files;
200 /*Count the number of slashes for string s*/
201 extern int count_slashes(const char *s);
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.
209 #define MATCHED_RECURSIVELY 1
210 #define MATCHED_FNMATCH 2
211 #define MATCHED_EXACTLY 3
212 extern int simple_length(const char *match);
213 extern int no_wildcard(const char *string);
214 extern char *common_prefix(const struct pathspec *pathspec);
215 extern int match_pathspec(const struct pathspec *pathspec,
216 const char *name, int namelen,
217 int prefix, char *seen, int is_dir);
218 extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
219 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
221 extern int fill_directory(struct dir_struct *dir,
222 struct index_state *istate,
223 const struct pathspec *pathspec);
224 extern int read_directory(struct dir_struct *, struct index_state *istate,
225 const char *path, int len,
226 const struct pathspec *pathspec);
228 extern 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);
232 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
233 struct index_state *istate,
234 const char *pathname, int len);
237 * these implement the matching logic for dir.c:excluded_from_list and
238 * attr.c:path_matches()
240 extern int match_basename(const char *, int,
241 const char *, int, int, unsigned);
242 extern int match_pathname(const char *, int,
243 const char *, int,
244 const char *, int, int, unsigned);
246 extern struct exclude *last_exclude_matching(struct dir_struct *dir,
247 struct index_state *istate,
248 const char *name, int *dtype);
250 extern int is_excluded(struct dir_struct *dir,
251 struct index_state *istate,
252 const char *name, int *dtype);
254 extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
255 int group_type, const char *src);
256 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
257 struct exclude_list *el, struct index_state *istate);
258 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
259 extern void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
260 extern void add_exclude(const char *string, const char *base,
261 int baselen, struct exclude_list *el, int srcpos);
262 extern void clear_exclude_list(struct exclude_list *el);
263 extern void clear_directory(struct dir_struct *dir);
264 extern int file_exists(const char *);
266 extern int is_inside_dir(const char *dir);
267 extern int dir_inside_of(const char *subdir, const char *dir);
269 static inline int is_dot_or_dotdot(const char *name)
271 return (name[0] == '.' &&
272 (name[1] == '\0' ||
273 (name[1] == '.' && name[2] == '\0')));
276 extern int is_empty_dir(const char *dir);
278 extern void setup_standard_excludes(struct dir_struct *dir);
281 /* Constants for remove_dir_recursively: */
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.)
288 #define REMOVE_DIR_EMPTY_ONLY 01
291 * If any Git work trees are found within path, skip them without
292 * considering it an error.
294 #define REMOVE_DIR_KEEP_NESTED_GIT 02
296 /* Remove the contents of path, but leave path itself. */
297 #define REMOVE_DIR_KEEP_TOPLEVEL 04
300 * Remove path and its contents, recursively. flags is a combination
301 * of the above REMOVE_DIR_* constants. Return 0 on success.
303 * This function uses path as temporary scratch space, but restores it
304 * before returning.
306 extern int remove_dir_recursively(struct strbuf *path, int flag);
308 /* tries to remove the path with empty directories along it, ignores ENOENT */
309 extern int remove_path(const char *path);
311 extern int fspathcmp(const char *a, const char *b);
312 extern int fspathncmp(const char *a, const char *b, size_t count);
315 * The prefix part of pattern must not contains wildcards.
317 struct pathspec_item;
318 extern int git_fnmatch(const struct pathspec_item *item,
319 const char *pattern, const char *string,
320 int prefix);
322 extern int submodule_path_match(const struct pathspec *ps,
323 const char *submodule_name,
324 char *seen);
326 static inline int ce_path_match(const struct cache_entry *ce,
327 const struct pathspec *pathspec,
328 char *seen)
330 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
331 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
334 static inline int dir_path_match(const struct dir_entry *ent,
335 const struct pathspec *pathspec,
336 int prefix, char *seen)
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);
344 int cmp_dir_entry(const void *p1, const void *p2);
345 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);
347 void untracked_cache_invalidate_path(struct index_state *, const char *);
348 void untracked_cache_remove_from_index(struct index_state *, const char *);
349 void untracked_cache_add_to_index(struct index_state *, const char *);
351 void free_untracked_cache(struct untracked_cache *);
352 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
353 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
354 void add_untracked_cache(struct index_state *istate);
355 void remove_untracked_cache(struct index_state *istate);
356 extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
357 extern void relocate_gitdir(const char *path,
358 const char *old_git_dir,
359 const char *new_git_dir);
360 #endif