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 18/* 19 * Each excludes file will be parsed into a fresh exclude_list which 20 * is appended to the relevant exclude_list_group (either EXC_DIRS or 21 * EXC_FILE). An exclude_list within the EXC_CMDL exclude_list_group 22 * can also be used to represent the list of --exclude values passed 23 * via CLI args. 24 */ 25struct exclude_list { 26 int nr; 27 int alloc; 28 29 /* remember pointer to exclude file contents so we can free() */ 30 char *filebuf; 31 32 /* origin of list, e.g. path to filename, or descriptive string */ 33 const char *src; 34 35 struct exclude { 36 /* 37 * This allows callers of last_exclude_matching() etc. 38 * to determine the origin of the matching pattern. 39 */ 40 struct exclude_list *el; 41 42 const char *pattern; 43 int patternlen; 44 int nowildcardlen; 45 const char *base; 46 int baselen; 47 int flags; 48 49 /* 50 * Counting starts from 1 for line numbers in ignore files, 51 * and from -1 decrementing for patterns from CLI args. 52 */ 53 int srcpos; 54 } **excludes; 55}; 56 57/* 58 * The contents of the per-directory exclude files are lazily read on 59 * demand and then cached in memory, one per exclude_stack struct, in 60 * order to avoid opening and parsing each one every time that 61 * directory is traversed. 62 */ 63struct exclude_stack { 64 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */ 65 int baselen; 66 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */ 67}; 68 69struct exclude_list_group { 70 int nr, alloc; 71 struct exclude_list *el; 72}; 73 74struct dir_struct { 75 int nr, alloc; 76 int ignored_nr, ignored_alloc; 77 enum { 78 DIR_SHOW_IGNORED = 1<<0, 79 DIR_SHOW_OTHER_DIRECTORIES = 1<<1, 80 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2, 81 DIR_NO_GITLINKS = 1<<3, 82 DIR_COLLECT_IGNORED = 1<<4, 83 DIR_SHOW_IGNORED_TOO = 1<<5 84 } flags; 85 struct dir_entry **entries; 86 struct dir_entry **ignored; 87 88 /* Exclude info */ 89 const char *exclude_per_dir; 90 91 /* 92 * We maintain three groups of exclude pattern lists: 93 * 94 * EXC_CMDL lists patterns explicitly given on the command line. 95 * EXC_DIRS lists patterns obtained from per-directory ignore files. 96 * EXC_FILE lists patterns from fallback ignore files, e.g. 97 * - .git/info/exclude 98 * - core.excludesfile 99 * 100 * Each group contains multiple exclude lists, a single list 101 * per source. 102 */ 103#define EXC_CMDL 0 104#define EXC_DIRS 1 105#define EXC_FILE 2 106 struct exclude_list_group exclude_list_group[3]; 107 108 /* 109 * Temporary variables which are used during loading of the 110 * per-directory exclude lists. 111 * 112 * exclude_stack points to the top of the exclude_stack, and 113 * basebuf contains the full path to the current 114 * (sub)directory in the traversal. Exclude points to the 115 * matching exclude struct if the directory is excluded. 116 */ 117 struct exclude_stack *exclude_stack; 118 struct exclude *exclude; 119 char basebuf[PATH_MAX]; 120}; 121 122/* 123 * The ordering of these constants is significant, with 124 * higher-numbered match types signifying "closer" (i.e. more 125 * specific) matches which will override lower-numbered match types 126 * when populating the seen[] array. 127 */ 128#define MATCHED_RECURSIVELY 1 129#define MATCHED_FNMATCH 2 130#define MATCHED_EXACTLY 3 131extern char *common_prefix(const char **pathspec); 132extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen); 133extern int match_pathspec_depth(const struct pathspec *pathspec, 134 const char *name, int namelen, 135 int prefix, char *seen); 136extern int within_depth(const char *name, int namelen, int depth, int max_depth); 137 138extern int fill_directory(struct dir_struct *dir, const char **pathspec); 139extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec); 140 141extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename, 142 int *dtype, struct exclude_list *el); 143struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len); 144 145/* 146 * these implement the matching logic for dir.c:excluded_from_list and 147 * attr.c:path_matches() 148 */ 149extern int match_basename(const char *, int, 150 const char *, int, int, int); 151extern int match_pathname(const char *, int, 152 const char *, int, 153 const char *, int, int, int); 154 155extern struct exclude *last_exclude_matching(struct dir_struct *dir, 156 const char *name, int *dtype); 157 158extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype); 159 160extern struct exclude_list *add_exclude_list(struct dir_struct *dir, 161 int group_type, const char *src); 162extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen, 163 struct exclude_list *el, int check_index); 164extern void add_excludes_from_file(struct dir_struct *, const char *fname); 165extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen); 166extern void add_exclude(const char *string, const char *base, 167 int baselen, struct exclude_list *el, int srcpos); 168extern void clear_exclude_list(struct exclude_list *el); 169extern void clear_directory(struct dir_struct *dir); 170extern int file_exists(const char *); 171 172extern int is_inside_dir(const char *dir); 173extern int dir_inside_of(const char *subdir, const char *dir); 174 175static inline int is_dot_or_dotdot(const char *name) 176{ 177 return (name[0] == '.' && 178 (name[1] == '\0' || 179 (name[1] == '.' && name[2] == '\0'))); 180} 181 182extern int is_empty_dir(const char *dir); 183 184extern void setup_standard_excludes(struct dir_struct *dir); 185 186#define REMOVE_DIR_EMPTY_ONLY 01 187#define REMOVE_DIR_KEEP_NESTED_GIT 02 188#define REMOVE_DIR_KEEP_TOPLEVEL 04 189extern int remove_dir_recursively(struct strbuf *path, int flag); 190 191/* tries to remove the path with empty directories along it, ignores ENOENT */ 192extern int remove_path(const char *path); 193 194extern int strcmp_icase(const char *a, const char *b); 195extern int strncmp_icase(const char *a, const char *b, size_t count); 196extern int fnmatch_icase(const char *pattern, const char *string, int flags); 197 198/* 199 * The prefix part of pattern must not contains wildcards. 200 */ 201#define GFNM_PATHNAME 1 /* similar to FNM_PATHNAME */ 202#define GFNM_ONESTAR 2 /* there is only _one_ wildcard, a star */ 203 204extern int git_fnmatch(const char *pattern, const char *string, 205 int flags, int prefix); 206 207#endif