1#ifndef DIR_H 2#define DIR_H 3 4/* See Documentation/technical/api-directory-listing.txt */ 5 6#include "strbuf.h" 7 8struct dir_entry { 9 unsigned int len; 10 char name[FLEX_ARRAY]; /* more */ 11}; 12 13#define EXC_FLAG_NODIR 1 14#define EXC_FLAG_ENDSWITH 4 15#define EXC_FLAG_MUSTBEDIR 8 16#define EXC_FLAG_NEGATIVE 16 17 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; 30 int flags; 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 39/* 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. 45 */ 46struct exclude_list { 47 int nr; 48 int alloc; 49 50 /* remember pointer to exclude file contents so we can free() */ 51 char *filebuf; 52 53 /* origin of list, e.g. path to filename, or descriptive string */ 54 const char *src; 55 56 struct exclude **excludes; 57}; 58 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 */ 65struct 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; 70}; 71 72struct exclude_list_group { 73 int nr, alloc; 74 struct exclude_list *el; 75}; 76 77struct sha1_stat { 78 struct stat_data stat; 79 unsigned char sha1[20]; 80 int valid; 81}; 82 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; 118 /* all data in this struct are good */ 119 unsigned int valid : 1; 120 /* null SHA-1 means this directory does not have .gitignore */ 121 unsigned char exclude_sha1[20]; 122 char name[FLEX_ARRAY]; 123}; 124 125struct untracked_cache { 126 struct sha1_stat ss_info_exclude; 127 struct sha1_stat ss_excludes_file; 128 const char *exclude_per_dir; 129 /* 130 * dir_struct#flags must match dir_flags or the untracked 131 * cache is ignored. 132 */ 133 unsigned dir_flags; 134 struct untracked_cache_dir *root; 135 /* Statistics */ 136 int dir_created; 137 int gitignore_invalidated; 138}; 139 140struct dir_struct { 141 int nr, alloc; 142 int ignored_nr, ignored_alloc; 143 enum { 144 DIR_SHOW_IGNORED = 1<<0, 145 DIR_SHOW_OTHER_DIRECTORIES = 1<<1, 146 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2, 147 DIR_NO_GITLINKS = 1<<3, 148 DIR_COLLECT_IGNORED = 1<<4, 149 DIR_SHOW_IGNORED_TOO = 1<<5, 150 DIR_COLLECT_KILLED_ONLY = 1<<6 151 } flags; 152 struct dir_entry **entries; 153 struct dir_entry **ignored; 154 155 /* Exclude info */ 156 const char *exclude_per_dir; 157 158 /* 159 * We maintain three groups of exclude pattern lists: 160 * 161 * EXC_CMDL lists patterns explicitly given on the command line. 162 * EXC_DIRS lists patterns obtained from per-directory ignore files. 163 * EXC_FILE lists patterns from fallback ignore files, e.g. 164 * - .git/info/exclude 165 * - core.excludesfile 166 * 167 * Each group contains multiple exclude lists, a single list 168 * per source. 169 */ 170#define EXC_CMDL 0 171#define EXC_DIRS 1 172#define EXC_FILE 2 173 struct exclude_list_group exclude_list_group[3]; 174 175 /* 176 * Temporary variables which are used during loading of the 177 * per-directory exclude lists. 178 * 179 * exclude_stack points to the top of the exclude_stack, and 180 * basebuf contains the full path to the current 181 * (sub)directory in the traversal. Exclude points to the 182 * matching exclude struct if the directory is excluded. 183 */ 184 struct exclude_stack *exclude_stack; 185 struct exclude *exclude; 186 struct strbuf basebuf; 187 188 /* Enable untracked file cache if set */ 189 struct untracked_cache *untracked; 190 struct sha1_stat ss_info_exclude; 191 struct sha1_stat ss_excludes_file; 192 unsigned unmanaged_exclude_files; 193}; 194 195/* 196 * The ordering of these constants is significant, with 197 * higher-numbered match types signifying "closer" (i.e. more 198 * specific) matches which will override lower-numbered match types 199 * when populating the seen[] array. 200 */ 201#define MATCHED_RECURSIVELY 1 202#define MATCHED_FNMATCH 2 203#define MATCHED_EXACTLY 3 204extern int simple_length(const char *match); 205extern int no_wildcard(const char *string); 206extern char *common_prefix(const struct pathspec *pathspec); 207extern int match_pathspec(const struct pathspec *pathspec, 208 const char *name, int namelen, 209 int prefix, char *seen, int is_dir); 210extern int within_depth(const char *name, int namelen, int depth, int max_depth); 211 212extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec); 213extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec); 214 215extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename, 216 int *dtype, struct exclude_list *el); 217struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len); 218 219/* 220 * these implement the matching logic for dir.c:excluded_from_list and 221 * attr.c:path_matches() 222 */ 223extern int match_basename(const char *, int, 224 const char *, int, int, int); 225extern int match_pathname(const char *, int, 226 const char *, int, 227 const char *, int, int, int); 228 229extern struct exclude *last_exclude_matching(struct dir_struct *dir, 230 const char *name, int *dtype); 231 232extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype); 233 234extern struct exclude_list *add_exclude_list(struct dir_struct *dir, 235 int group_type, const char *src); 236extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen, 237 struct exclude_list *el, int check_index); 238extern void add_excludes_from_file(struct dir_struct *, const char *fname); 239extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen); 240extern void add_exclude(const char *string, const char *base, 241 int baselen, struct exclude_list *el, int srcpos); 242extern void clear_exclude_list(struct exclude_list *el); 243extern void clear_directory(struct dir_struct *dir); 244extern int file_exists(const char *); 245 246extern int is_inside_dir(const char *dir); 247extern int dir_inside_of(const char *subdir, const char *dir); 248 249static inline int is_dot_or_dotdot(const char *name) 250{ 251 return (name[0] == '.' && 252 (name[1] == '\0' || 253 (name[1] == '.' && name[2] == '\0'))); 254} 255 256extern int is_empty_dir(const char *dir); 257 258extern void setup_standard_excludes(struct dir_struct *dir); 259 260#define REMOVE_DIR_EMPTY_ONLY 01 261#define REMOVE_DIR_KEEP_NESTED_GIT 02 262#define REMOVE_DIR_KEEP_TOPLEVEL 04 263extern int remove_dir_recursively(struct strbuf *path, int flag); 264 265/* tries to remove the path with empty directories along it, ignores ENOENT */ 266extern int remove_path(const char *path); 267 268extern int strcmp_icase(const char *a, const char *b); 269extern int strncmp_icase(const char *a, const char *b, size_t count); 270extern int fnmatch_icase(const char *pattern, const char *string, int flags); 271 272/* 273 * The prefix part of pattern must not contains wildcards. 274 */ 275struct pathspec_item; 276extern int git_fnmatch(const struct pathspec_item *item, 277 const char *pattern, const char *string, 278 int prefix); 279 280static inline int ce_path_match(const struct cache_entry *ce, 281 const struct pathspec *pathspec, 282 char *seen) 283{ 284 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen, 285 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode)); 286} 287 288static inline int dir_path_match(const struct dir_entry *ent, 289 const struct pathspec *pathspec, 290 int prefix, char *seen) 291{ 292 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/'; 293 int len = has_trailing_dir ? ent->len - 1 : ent->len; 294 return match_pathspec(pathspec, ent->name, len, prefix, seen, 295 has_trailing_dir); 296} 297 298#endif