Merge branch 'mh/write-refs-sooner-2.4' into maint
[git.git] / dir.h
blob72b73c65dcfc6f31004a032d0706626424ac2241
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 int flags;
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 */
71 struct exclude_list_group {
72 int nr, alloc;
73 struct exclude_list *el;
76 struct dir_struct {
77 int nr, alloc;
78 int ignored_nr, ignored_alloc;
79 enum {
80 DIR_SHOW_IGNORED = 1<<0,
81 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
82 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
83 DIR_NO_GITLINKS = 1<<3,
84 DIR_COLLECT_IGNORED = 1<<4,
85 DIR_SHOW_IGNORED_TOO = 1<<5,
86 DIR_COLLECT_KILLED_ONLY = 1<<6
87 } flags;
88 struct dir_entry **entries;
89 struct dir_entry **ignored;
91 /* Exclude info */
92 const char *exclude_per_dir;
95 * We maintain three groups of exclude pattern lists:
97 * EXC_CMDL lists patterns explicitly given on the command line.
98 * EXC_DIRS lists patterns obtained from per-directory ignore files.
99 * EXC_FILE lists patterns from fallback ignore files, e.g.
100 * - .git/info/exclude
101 * - core.excludesfile
103 * Each group contains multiple exclude lists, a single list
104 * per source.
106 #define EXC_CMDL 0
107 #define EXC_DIRS 1
108 #define EXC_FILE 2
109 struct exclude_list_group exclude_list_group[3];
112 * Temporary variables which are used during loading of the
113 * per-directory exclude lists.
115 * exclude_stack points to the top of the exclude_stack, and
116 * basebuf contains the full path to the current
117 * (sub)directory in the traversal. Exclude points to the
118 * matching exclude struct if the directory is excluded.
120 struct exclude_stack *exclude_stack;
121 struct exclude *exclude;
122 struct strbuf basebuf;
126 * The ordering of these constants is significant, with
127 * higher-numbered match types signifying "closer" (i.e. more
128 * specific) matches which will override lower-numbered match types
129 * when populating the seen[] array.
131 #define MATCHED_RECURSIVELY 1
132 #define MATCHED_FNMATCH 2
133 #define MATCHED_EXACTLY 3
134 extern int simple_length(const char *match);
135 extern int no_wildcard(const char *string);
136 extern char *common_prefix(const struct pathspec *pathspec);
137 extern int match_pathspec(const struct pathspec *pathspec,
138 const char *name, int namelen,
139 int prefix, char *seen, int is_dir);
140 extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
141 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
143 extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec);
144 extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec);
146 extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
147 int *dtype, struct exclude_list *el);
148 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
151 * these implement the matching logic for dir.c:excluded_from_list and
152 * attr.c:path_matches()
154 extern int match_basename(const char *, int,
155 const char *, int, int, int);
156 extern int match_pathname(const char *, int,
157 const char *, int,
158 const char *, int, int, int);
160 extern struct exclude *last_exclude_matching(struct dir_struct *dir,
161 const char *name, int *dtype);
163 extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
165 extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
166 int group_type, const char *src);
167 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
168 struct exclude_list *el, int check_index);
169 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
170 extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
171 extern void add_exclude(const char *string, const char *base,
172 int baselen, struct exclude_list *el, int srcpos);
173 extern void clear_exclude_list(struct exclude_list *el);
174 extern void clear_directory(struct dir_struct *dir);
175 extern int file_exists(const char *);
177 extern int is_inside_dir(const char *dir);
178 extern int dir_inside_of(const char *subdir, const char *dir);
180 static inline int is_dot_or_dotdot(const char *name)
182 return (name[0] == '.' &&
183 (name[1] == '\0' ||
184 (name[1] == '.' && name[2] == '\0')));
187 extern int is_empty_dir(const char *dir);
189 extern void setup_standard_excludes(struct dir_struct *dir);
191 #define REMOVE_DIR_EMPTY_ONLY 01
192 #define REMOVE_DIR_KEEP_NESTED_GIT 02
193 #define REMOVE_DIR_KEEP_TOPLEVEL 04
194 extern int remove_dir_recursively(struct strbuf *path, int flag);
196 /* tries to remove the path with empty directories along it, ignores ENOENT */
197 extern int remove_path(const char *path);
199 extern int strcmp_icase(const char *a, const char *b);
200 extern int strncmp_icase(const char *a, const char *b, size_t count);
201 extern int fnmatch_icase(const char *pattern, const char *string, int flags);
204 * The prefix part of pattern must not contains wildcards.
206 struct pathspec_item;
207 extern int git_fnmatch(const struct pathspec_item *item,
208 const char *pattern, const char *string,
209 int prefix);
211 static inline int ce_path_match(const struct cache_entry *ce,
212 const struct pathspec *pathspec,
213 char *seen)
215 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
216 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
219 static inline int dir_path_match(const struct dir_entry *ent,
220 const struct pathspec *pathspec,
221 int prefix, char *seen)
223 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
224 int len = has_trailing_dir ? ent->len - 1 : ent->len;
225 return match_pathspec(pathspec, ent->name, len, prefix, seen,
226 has_trailing_dir);
229 #endif