]>
Commit | Line | Data |
---|---|---|
453ec4bd LT |
1 | #ifndef DIR_H |
2 | #define DIR_H | |
3 | ||
95a68344 AS |
4 | /* See Documentation/technical/api-directory-listing.txt */ |
5 | ||
eb41775e JH |
6 | #include "strbuf.h" |
7 | ||
453ec4bd | 8 | struct dir_entry { |
e96980ef | 9 | unsigned int len; |
453ec4bd LT |
10 | char name[FLEX_ARRAY]; /* more */ |
11 | }; | |
12 | ||
68492fc7 | 13 | #define EXC_FLAG_NODIR 1 |
68492fc7 | 14 | #define EXC_FLAG_ENDSWITH 4 |
d6b8fc30 | 15 | #define EXC_FLAG_MUSTBEDIR 8 |
84460eec | 16 | #define EXC_FLAG_NEGATIVE 16 |
68492fc7 | 17 | |
95a68344 | 18 | /* |
c082df24 AS |
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. | |
95a68344 | 24 | */ |
453ec4bd LT |
25 | struct exclude_list { |
26 | int nr; | |
27 | int alloc; | |
c04318e4 | 28 | |
c082df24 AS |
29 | /* remember pointer to exclude file contents so we can free() */ |
30 | char *filebuf; | |
31 | ||
c04318e4 AS |
32 | /* origin of list, e.g. path to filename, or descriptive string */ |
33 | const char *src; | |
34 | ||
453ec4bd | 35 | struct exclude { |
c04318e4 AS |
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 | ||
453ec4bd | 42 | const char *pattern; |
68492fc7 | 43 | int patternlen; |
f9f6e2ce | 44 | int nowildcardlen; |
453ec4bd LT |
45 | const char *base; |
46 | int baselen; | |
68492fc7 | 47 | int flags; |
c04318e4 AS |
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; | |
453ec4bd LT |
54 | } **excludes; |
55 | }; | |
56 | ||
95a68344 AS |
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 | */ | |
63d285c8 | 63 | struct exclude_stack { |
95a68344 | 64 | struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */ |
63d285c8 | 65 | int baselen; |
c082df24 AS |
66 | int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */ |
67 | }; | |
68 | ||
69 | struct exclude_list_group { | |
70 | int nr, alloc; | |
71 | struct exclude_list *el; | |
63d285c8 JH |
72 | }; |
73 | ||
453ec4bd LT |
74 | struct dir_struct { |
75 | int nr, alloc; | |
2abd31b0 | 76 | int ignored_nr, ignored_alloc; |
7c4c97c0 JS |
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, | |
0aaf62b6 | 82 | DIR_COLLECT_IGNORED = 1<<4, |
2eac2a4c JH |
83 | DIR_SHOW_IGNORED_TOO = 1<<5, |
84 | DIR_COLLECT_KILLED_ONLY = 1<<6 | |
7c4c97c0 | 85 | } flags; |
453ec4bd | 86 | struct dir_entry **entries; |
2abd31b0 | 87 | struct dir_entry **ignored; |
453ec4bd LT |
88 | |
89 | /* Exclude info */ | |
90 | const char *exclude_per_dir; | |
c082df24 | 91 | |
63d285c8 | 92 | /* |
c082df24 AS |
93 | * We maintain three groups of exclude pattern lists: |
94 | * | |
63d285c8 JH |
95 | * EXC_CMDL lists patterns explicitly given on the command line. |
96 | * EXC_DIRS lists patterns obtained from per-directory ignore files. | |
c082df24 AS |
97 | * EXC_FILE lists patterns from fallback ignore files, e.g. |
98 | * - .git/info/exclude | |
99 | * - core.excludesfile | |
100 | * | |
101 | * Each group contains multiple exclude lists, a single list | |
102 | * per source. | |
63d285c8 JH |
103 | */ |
104 | #define EXC_CMDL 0 | |
105 | #define EXC_DIRS 1 | |
106 | #define EXC_FILE 2 | |
c082df24 | 107 | struct exclude_list_group exclude_list_group[3]; |
63d285c8 | 108 | |
95a68344 AS |
109 | /* |
110 | * Temporary variables which are used during loading of the | |
111 | * per-directory exclude lists. | |
112 | * | |
113 | * exclude_stack points to the top of the exclude_stack, and | |
114 | * basebuf contains the full path to the current | |
95c6f271 KB |
115 | * (sub)directory in the traversal. Exclude points to the |
116 | * matching exclude struct if the directory is excluded. | |
95a68344 | 117 | */ |
63d285c8 | 118 | struct exclude_stack *exclude_stack; |
95c6f271 | 119 | struct exclude *exclude; |
63d285c8 | 120 | char basebuf[PATH_MAX]; |
453ec4bd LT |
121 | }; |
122 | ||
52ed1894 AS |
123 | /* |
124 | * The ordering of these constants is significant, with | |
125 | * higher-numbered match types signifying "closer" (i.e. more | |
126 | * specific) matches which will override lower-numbered match types | |
127 | * when populating the seen[] array. | |
128 | */ | |
e813d50e JH |
129 | #define MATCHED_RECURSIVELY 1 |
130 | #define MATCHED_FNMATCH 2 | |
131 | #define MATCHED_EXACTLY 3 | |
f950eb95 | 132 | extern char *common_prefix(const char **pathspec); |
3c6a370b | 133 | extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen); |
61cf2820 NTND |
134 | extern int match_pathspec_depth(const struct pathspec *pathspec, |
135 | const char *name, int namelen, | |
136 | int prefix, char *seen); | |
bc96cc87 | 137 | extern int within_depth(const char *name, int namelen, int depth, int max_depth); |
3c6a370b | 138 | |
1d8842d9 | 139 | extern int fill_directory(struct dir_struct *dir, const char **pathspec); |
dba2e203 | 140 | extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec); |
f8a9d428 | 141 | |
07958050 AS |
142 | extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename, |
143 | int *dtype, struct exclude_list *el); | |
108da0db | 144 | struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len); |
eb41775e | 145 | |
82dce998 NTND |
146 | /* |
147 | * these implement the matching logic for dir.c:excluded_from_list and | |
148 | * attr.c:path_matches() | |
149 | */ | |
150 | extern int match_basename(const char *, int, | |
151 | const char *, int, int, int); | |
152 | extern int match_pathname(const char *, int, | |
153 | const char *, int, | |
154 | const char *, int, int, int); | |
155 | ||
b07bc8c8 KB |
156 | extern struct exclude *last_exclude_matching(struct dir_struct *dir, |
157 | const char *name, int *dtype); | |
782cd4c0 | 158 | |
b07bc8c8 | 159 | extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype); |
eb41775e | 160 | |
c04318e4 AS |
161 | extern struct exclude_list *add_exclude_list(struct dir_struct *dir, |
162 | int group_type, const char *src); | |
cb097534 | 163 | extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen, |
c082df24 | 164 | struct exclude_list *el, int check_index); |
453ec4bd | 165 | extern void add_excludes_from_file(struct dir_struct *, const char *fname); |
82dce998 | 166 | extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen); |
453ec4bd | 167 | extern void add_exclude(const char *string, const char *base, |
c04318e4 | 168 | int baselen, struct exclude_list *el, int srcpos); |
f6198812 | 169 | extern void clear_exclude_list(struct exclude_list *el); |
270be816 | 170 | extern void clear_directory(struct dir_struct *dir); |
c91f0d92 | 171 | extern int file_exists(const char *); |
453ec4bd | 172 | |
e6636747 | 173 | extern int is_inside_dir(const char *dir); |
9b125da4 | 174 | extern int dir_inside_of(const char *subdir, const char *dir); |
e6636747 | 175 | |
8ca12c0d AP |
176 | static inline int is_dot_or_dotdot(const char *name) |
177 | { | |
178 | return (name[0] == '.' && | |
179 | (name[1] == '\0' || | |
180 | (name[1] == '.' && name[2] == '\0'))); | |
181 | } | |
182 | ||
55892d23 AP |
183 | extern int is_empty_dir(const char *dir); |
184 | ||
039bc64e | 185 | extern void setup_standard_excludes(struct dir_struct *dir); |
a0f4afbe JH |
186 | |
187 | #define REMOVE_DIR_EMPTY_ONLY 01 | |
188 | #define REMOVE_DIR_KEEP_NESTED_GIT 02 | |
c844a803 | 189 | #define REMOVE_DIR_KEEP_TOPLEVEL 04 |
a0f4afbe | 190 | extern int remove_dir_recursively(struct strbuf *path, int flag); |
7155b727 | 191 | |
4a92d1bf AR |
192 | /* tries to remove the path with empty directories along it, ignores ENOENT */ |
193 | extern int remove_path(const char *path); | |
194 | ||
8cf2a84e JJ |
195 | extern int strcmp_icase(const char *a, const char *b); |
196 | extern int strncmp_icase(const char *a, const char *b, size_t count); | |
197 | extern int fnmatch_icase(const char *pattern, const char *string, int flags); | |
198 | ||
5d74762d NTND |
199 | /* |
200 | * The prefix part of pattern must not contains wildcards. | |
201 | */ | |
202 | #define GFNM_PATHNAME 1 /* similar to FNM_PATHNAME */ | |
8c6abbcd | 203 | #define GFNM_ONESTAR 2 /* there is only _one_ wildcard, a star */ |
5d74762d NTND |
204 | |
205 | extern int git_fnmatch(const char *pattern, const char *string, | |
206 | int flags, int prefix); | |
207 | ||
453ec4bd | 208 | #endif |