tgupdate: merge girocco base into girocco
[git/gitweb.git] / dir.h
blob97c83bb383a6b1fb5ce58d5e81dead570b73ac43
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 } flags;
156 struct dir_entry **entries;
157 struct dir_entry **ignored;
159 /* Exclude info */
160 const char *exclude_per_dir;
163 * We maintain three groups of exclude pattern lists:
165 * EXC_CMDL lists patterns explicitly given on the command line.
166 * EXC_DIRS lists patterns obtained from per-directory ignore files.
167 * EXC_FILE lists patterns from fallback ignore files, e.g.
168 * - .git/info/exclude
169 * - core.excludesfile
171 * Each group contains multiple exclude lists, a single list
172 * per source.
174 #define EXC_CMDL 0
175 #define EXC_DIRS 1
176 #define EXC_FILE 2
177 struct exclude_list_group exclude_list_group[3];
180 * Temporary variables which are used during loading of the
181 * per-directory exclude lists.
183 * exclude_stack points to the top of the exclude_stack, and
184 * basebuf contains the full path to the current
185 * (sub)directory in the traversal. Exclude points to the
186 * matching exclude struct if the directory is excluded.
188 struct exclude_stack *exclude_stack;
189 struct exclude *exclude;
190 struct strbuf basebuf;
192 /* Enable untracked file cache if set */
193 struct untracked_cache *untracked;
194 struct sha1_stat ss_info_exclude;
195 struct sha1_stat ss_excludes_file;
196 unsigned unmanaged_exclude_files;
200 * The ordering of these constants is significant, with
201 * higher-numbered match types signifying "closer" (i.e. more
202 * specific) matches which will override lower-numbered match types
203 * when populating the seen[] array.
205 #define MATCHED_RECURSIVELY 1
206 #define MATCHED_FNMATCH 2
207 #define MATCHED_EXACTLY 3
208 extern int simple_length(const char *match);
209 extern int no_wildcard(const char *string);
210 extern char *common_prefix(const struct pathspec *pathspec);
211 extern int match_pathspec(const struct pathspec *pathspec,
212 const char *name, int namelen,
213 int prefix, char *seen, int is_dir);
214 extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
215 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
217 extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec);
218 extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec);
220 extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
221 int *dtype, struct exclude_list *el);
222 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
225 * these implement the matching logic for dir.c:excluded_from_list and
226 * attr.c:path_matches()
228 extern int match_basename(const char *, int,
229 const char *, int, int, unsigned);
230 extern int match_pathname(const char *, int,
231 const char *, int,
232 const char *, int, int, unsigned);
234 extern struct exclude *last_exclude_matching(struct dir_struct *dir,
235 const char *name, int *dtype);
237 extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
239 extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
240 int group_type, const char *src);
241 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
242 struct exclude_list *el, int check_index);
243 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
244 extern void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
245 extern void add_exclude(const char *string, const char *base,
246 int baselen, struct exclude_list *el, int srcpos);
247 extern void clear_exclude_list(struct exclude_list *el);
248 extern void clear_directory(struct dir_struct *dir);
249 extern int file_exists(const char *);
251 extern int is_inside_dir(const char *dir);
252 extern int dir_inside_of(const char *subdir, const char *dir);
254 static inline int is_dot_or_dotdot(const char *name)
256 return (name[0] == '.' &&
257 (name[1] == '\0' ||
258 (name[1] == '.' && name[2] == '\0')));
261 extern int is_empty_dir(const char *dir);
263 extern void setup_standard_excludes(struct dir_struct *dir);
266 /* Constants for remove_dir_recursively: */
269 * If a non-directory is found within path, stop and return an error.
270 * (In this case some empty directories might already have been
271 * removed.)
273 #define REMOVE_DIR_EMPTY_ONLY 01
276 * If any Git work trees are found within path, skip them without
277 * considering it an error.
279 #define REMOVE_DIR_KEEP_NESTED_GIT 02
281 /* Remove the contents of path, but leave path itself. */
282 #define REMOVE_DIR_KEEP_TOPLEVEL 04
285 * Remove path and its contents, recursively. flags is a combination
286 * of the above REMOVE_DIR_* constants. Return 0 on success.
288 * This function uses path as temporary scratch space, but restores it
289 * before returning.
291 extern int remove_dir_recursively(struct strbuf *path, int flag);
293 /* tries to remove the path with empty directories along it, ignores ENOENT */
294 extern int remove_path(const char *path);
296 extern int fspathcmp(const char *a, const char *b);
297 extern int fspathncmp(const char *a, const char *b, size_t count);
300 * The prefix part of pattern must not contains wildcards.
302 struct pathspec_item;
303 extern int git_fnmatch(const struct pathspec_item *item,
304 const char *pattern, const char *string,
305 int prefix);
307 extern int submodule_path_match(const struct pathspec *ps,
308 const char *submodule_name,
309 char *seen);
311 static inline int ce_path_match(const struct cache_entry *ce,
312 const struct pathspec *pathspec,
313 char *seen)
315 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
316 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
319 static inline int dir_path_match(const struct dir_entry *ent,
320 const struct pathspec *pathspec,
321 int prefix, char *seen)
323 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
324 int len = has_trailing_dir ? ent->len - 1 : ent->len;
325 return match_pathspec(pathspec, ent->name, len, prefix, seen,
326 has_trailing_dir);
329 void untracked_cache_invalidate_path(struct index_state *, const char *);
330 void untracked_cache_remove_from_index(struct index_state *, const char *);
331 void untracked_cache_add_to_index(struct index_state *, const char *);
333 void free_untracked_cache(struct untracked_cache *);
334 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
335 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
336 void add_untracked_cache(struct index_state *istate);
337 void remove_untracked_cache(struct index_state *istate);
338 #endif