Post 2.3 cycle (batch #9)
[git/git.git] / dir.h
CommitLineData
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 8struct 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
709359c8
NTND
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
95a68344 39/*
c082df24
AS
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.
95a68344 45 */
453ec4bd
LT
46struct exclude_list {
47 int nr;
48 int alloc;
c04318e4 49
c082df24
AS
50 /* remember pointer to exclude file contents so we can free() */
51 char *filebuf;
52
c04318e4
AS
53 /* origin of list, e.g. path to filename, or descriptive string */
54 const char *src;
55
709359c8 56 struct exclude **excludes;
453ec4bd
LT
57};
58
95a68344
AS
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 */
63d285c8 65struct exclude_stack {
95a68344 66 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
63d285c8 67 int baselen;
c082df24
AS
68 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
69};
70
71struct exclude_list_group {
72 int nr, alloc;
73 struct exclude_list *el;
63d285c8
JH
74};
75
453ec4bd
LT
76struct dir_struct {
77 int nr, alloc;
2abd31b0 78 int ignored_nr, ignored_alloc;
7c4c97c0
JS
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,
0aaf62b6 84 DIR_COLLECT_IGNORED = 1<<4,
2eac2a4c
JH
85 DIR_SHOW_IGNORED_TOO = 1<<5,
86 DIR_COLLECT_KILLED_ONLY = 1<<6
7c4c97c0 87 } flags;
453ec4bd 88 struct dir_entry **entries;
2abd31b0 89 struct dir_entry **ignored;
453ec4bd
LT
90
91 /* Exclude info */
92 const char *exclude_per_dir;
c082df24 93
63d285c8 94 /*
c082df24
AS
95 * We maintain three groups of exclude pattern lists:
96 *
63d285c8
JH
97 * EXC_CMDL lists patterns explicitly given on the command line.
98 * EXC_DIRS lists patterns obtained from per-directory ignore files.
c082df24
AS
99 * EXC_FILE lists patterns from fallback ignore files, e.g.
100 * - .git/info/exclude
101 * - core.excludesfile
102 *
103 * Each group contains multiple exclude lists, a single list
104 * per source.
63d285c8
JH
105 */
106#define EXC_CMDL 0
107#define EXC_DIRS 1
108#define EXC_FILE 2
c082df24 109 struct exclude_list_group exclude_list_group[3];
63d285c8 110
95a68344
AS
111 /*
112 * Temporary variables which are used during loading of the
113 * per-directory exclude lists.
114 *
115 * exclude_stack points to the top of the exclude_stack, and
116 * basebuf contains the full path to the current
95c6f271
KB
117 * (sub)directory in the traversal. Exclude points to the
118 * matching exclude struct if the directory is excluded.
95a68344 119 */
63d285c8 120 struct exclude_stack *exclude_stack;
95c6f271 121 struct exclude *exclude;
aceb9429 122 struct strbuf basebuf;
453ec4bd
LT
123};
124
52ed1894
AS
125/*
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.
130 */
e813d50e
JH
131#define MATCHED_RECURSIVELY 1
132#define MATCHED_FNMATCH 2
133#define MATCHED_EXACTLY 3
87323bda
NTND
134extern int simple_length(const char *match);
135extern int no_wildcard(const char *string);
827f4d6c 136extern char *common_prefix(const struct pathspec *pathspec);
854b0959
NTND
137extern int match_pathspec(const struct pathspec *pathspec,
138 const char *name, int namelen,
ae8d0824 139 int prefix, char *seen, int is_dir);
bc96cc87 140extern int within_depth(const char *name, int namelen, int depth, int max_depth);
3c6a370b 141
7327d3d1
NTND
142extern int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec);
143extern int read_directory(struct dir_struct *, const char *path, int len, const struct pathspec *pathspec);
f8a9d428 144
07958050
AS
145extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
146 int *dtype, struct exclude_list *el);
108da0db 147struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
eb41775e 148
82dce998
NTND
149/*
150 * these implement the matching logic for dir.c:excluded_from_list and
151 * attr.c:path_matches()
152 */
153extern int match_basename(const char *, int,
154 const char *, int, int, int);
155extern int match_pathname(const char *, int,
156 const char *, int,
157 const char *, int, int, int);
158
b07bc8c8
KB
159extern struct exclude *last_exclude_matching(struct dir_struct *dir,
160 const char *name, int *dtype);
782cd4c0 161
b07bc8c8 162extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
eb41775e 163
c04318e4
AS
164extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
165 int group_type, const char *src);
cb097534 166extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
c082df24 167 struct exclude_list *el, int check_index);
453ec4bd 168extern void add_excludes_from_file(struct dir_struct *, const char *fname);
82dce998 169extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
453ec4bd 170extern void add_exclude(const char *string, const char *base,
c04318e4 171 int baselen, struct exclude_list *el, int srcpos);
f6198812 172extern void clear_exclude_list(struct exclude_list *el);
270be816 173extern void clear_directory(struct dir_struct *dir);
c91f0d92 174extern int file_exists(const char *);
453ec4bd 175
e6636747 176extern int is_inside_dir(const char *dir);
9b125da4 177extern int dir_inside_of(const char *subdir, const char *dir);
e6636747 178
8ca12c0d
AP
179static inline int is_dot_or_dotdot(const char *name)
180{
181 return (name[0] == '.' &&
182 (name[1] == '\0' ||
183 (name[1] == '.' && name[2] == '\0')));
184}
185
55892d23
AP
186extern int is_empty_dir(const char *dir);
187
039bc64e 188extern void setup_standard_excludes(struct dir_struct *dir);
a0f4afbe
JH
189
190#define REMOVE_DIR_EMPTY_ONLY 01
191#define REMOVE_DIR_KEEP_NESTED_GIT 02
c844a803 192#define REMOVE_DIR_KEEP_TOPLEVEL 04
a0f4afbe 193extern int remove_dir_recursively(struct strbuf *path, int flag);
7155b727 194
4a92d1bf
AR
195/* tries to remove the path with empty directories along it, ignores ENOENT */
196extern int remove_path(const char *path);
197
8cf2a84e
JJ
198extern int strcmp_icase(const char *a, const char *b);
199extern int strncmp_icase(const char *a, const char *b, size_t count);
200extern int fnmatch_icase(const char *pattern, const char *string, int flags);
201
5d74762d
NTND
202/*
203 * The prefix part of pattern must not contains wildcards.
204 */
bd30c2e4
NTND
205struct pathspec_item;
206extern int git_fnmatch(const struct pathspec_item *item,
207 const char *pattern, const char *string,
208 int prefix);
5d74762d 209
429bb40a
NTND
210static inline int ce_path_match(const struct cache_entry *ce,
211 const struct pathspec *pathspec,
212 char *seen)
213{
ae8d0824
NTND
214 return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
215 S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
429bb40a
NTND
216}
217
ebb32893
NTND
218static inline int dir_path_match(const struct dir_entry *ent,
219 const struct pathspec *pathspec,
220 int prefix, char *seen)
221{
ae8d0824
NTND
222 int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
223 int len = has_trailing_dir ? ent->len - 1 : ent->len;
224 return match_pathspec(pathspec, ent->name, len, prefix, seen,
225 has_trailing_dir);
ebb32893
NTND
226}
227
453ec4bd 228#endif