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 unsigned flags; /* EXC_FLAG_* */ 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 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]; 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; 130 struct strbuf ident; 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; 139 int gitignore_invalidated; 140 int dir_invalidated; 141 int dir_opened; 142}; 143 144struct 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; 158 159 /* Exclude info */ 160 const char *exclude_per_dir; 161 162 /* 163 * We maintain three groups of exclude pattern lists: 164 * 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 170 * 171 * Each group contains multiple exclude lists, a single list 172 * per source. 173 */ 174#define EXC_CMDL 0 175#define EXC_DIRS 1 176#define EXC_FILE 2 177 struct exclude_list_group exclude_list_group[3]; 178 179 /* 180 * Temporary variables which are used during loading of the 181 * per-directory exclude lists. 182 * 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. 187 */ 188 struct exclude_stack *exclude_stack; 189 struct exclude *exclude; 190 struct strbuf basebuf; 191 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; 197}; 198 199/* 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. 204 */ 205#define MATCHED_RECURSIVELY 1 206#define MATCHED_FNMATCH 2 207#define MATCHED_EXACTLY 3 208extern int simple_length(const char *match); 209extern int no_wildcard(const char *string); 210extern char *common_prefix(const struct pathspec *pathspec); 211extern int match_pathspec(const struct pathspec *pathspec, 212 const char *name, int namelen, 213 int prefix, char *seen, int is_dir); 214extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix); 215extern int within_depth(const char *name, int namelen, int depth, int max_depth); 216 217extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec); 218extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec); 219 220extern int is_excluded_from_list(const char *pathname, int pathlen, 221 const char *basename, int *dtype, 222 struct exclude_list *el, 223 struct index_state *istate); 224struct dir_entry *dir_add_ignored(struct dir_struct *dir, 225 struct index_state *istate, 226 const char *pathname, int len); 227 228/* 229 * these implement the matching logic for dir.c:excluded_from_list and 230 * attr.c:path_matches() 231 */ 232extern int match_basename(const char *, int, 233 const char *, int, int, unsigned); 234extern int match_pathname(const char *, int, 235 const char *, int, 236 const char *, int, int, unsigned); 237 238extern struct exclude *last_exclude_matching(struct dir_struct *dir, 239 const char *name, int *dtype); 240 241extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype); 242 243extern struct exclude_list *add_exclude_list(struct dir_struct *dir, 244 int group_type, const char *src); 245extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen, 246 struct exclude_list *el, int check_index); 247extern void add_excludes_from_file(struct dir_struct *, const char *fname); 248extern void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen); 249extern void add_exclude(const char *string, const char *base, 250 int baselen, struct exclude_list *el, int srcpos); 251extern void clear_exclude_list(struct exclude_list *el); 252extern void clear_directory(struct dir_struct *dir); 253extern int file_exists(const char *); 254 255extern int is_inside_dir(const char *dir); 256extern int dir_inside_of(const char *subdir, const char *dir); 257 258static inline int is_dot_or_dotdot(const char *name) 259{ 260 return (name[0] == '.' && 261 (name[1] == '\0' || 262 (name[1] == '.' && name[2] == '\0'))); 263} 264 265extern int is_empty_dir(const char *dir); 266 267extern void setup_standard_excludes(struct dir_struct *dir); 268 269 270/* Constants for remove_dir_recursively: */ 271 272/* 273 * If a non-directory is found within path, stop and return an error. 274 * (In this case some empty directories might already have been 275 * removed.) 276 */ 277#define REMOVE_DIR_EMPTY_ONLY 01 278 279/* 280 * If any Git work trees are found within path, skip them without 281 * considering it an error. 282 */ 283#define REMOVE_DIR_KEEP_NESTED_GIT 02 284 285/* Remove the contents of path, but leave path itself. */ 286#define REMOVE_DIR_KEEP_TOPLEVEL 04 287 288/* 289 * Remove path and its contents, recursively. flags is a combination 290 * of the above REMOVE_DIR_* constants. Return 0 on success. 291 * 292 * This function uses path as temporary scratch space, but restores it 293 * before returning. 294 */ 295extern int remove_dir_recursively(struct strbuf *path, int flag); 296 297/* tries to remove the path with empty directories along it, ignores ENOENT */ 298extern int remove_path(const char *path); 299 300extern int fspathcmp(const char *a, const char *b); 301extern int fspathncmp(const char *a, const char *b, size_t count); 302 303/* 304 * The prefix part of pattern must not contains wildcards. 305 */ 306struct pathspec_item; 307extern int git_fnmatch(const struct pathspec_item *item, 308 const char *pattern, const char *string, 309 int prefix); 310 311extern int submodule_path_match(const struct pathspec *ps, 312 const char *submodule_name, 313 char *seen); 314 315static inline int ce_path_match(const struct cache_entry *ce, 316 const struct pathspec *pathspec, 317 char *seen) 318{ 319 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen, 320 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode)); 321} 322 323static inline int dir_path_match(const struct dir_entry *ent, 324 const struct pathspec *pathspec, 325 int prefix, char *seen) 326{ 327 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/'; 328 int len = has_trailing_dir ? ent->len - 1 : ent->len; 329 return match_pathspec(pathspec, ent->name, len, prefix, seen, 330 has_trailing_dir); 331} 332 333void untracked_cache_invalidate_path(struct index_state *, const char *); 334void untracked_cache_remove_from_index(struct index_state *, const char *); 335void untracked_cache_add_to_index(struct index_state *, const char *); 336 337void free_untracked_cache(struct untracked_cache *); 338struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz); 339void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked); 340void add_untracked_cache(struct index_state *istate); 341void remove_untracked_cache(struct index_state *istate); 342extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir); 343extern void relocate_gitdir(const char *path, 344 const char *old_git_dir, 345 const char *new_git_dir); 346#endif