dir.c: use a single struct exclude_list per source of excludes
[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
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
25struct exclude_list {
26 int nr;
27 int alloc;
c082df24
AS
28 /* remember pointer to exclude file contents so we can free() */
29 char *filebuf;
30
453ec4bd
LT
31 struct exclude {
32 const char *pattern;
68492fc7 33 int patternlen;
f9f6e2ce 34 int nowildcardlen;
453ec4bd
LT
35 const char *base;
36 int baselen;
68492fc7 37 int flags;
453ec4bd
LT
38 } **excludes;
39};
40
95a68344
AS
41/*
42 * The contents of the per-directory exclude files are lazily read on
43 * demand and then cached in memory, one per exclude_stack struct, in
44 * order to avoid opening and parsing each one every time that
45 * directory is traversed.
46 */
63d285c8 47struct exclude_stack {
95a68344 48 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
63d285c8 49 int baselen;
c082df24
AS
50 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
51};
52
53struct exclude_list_group {
54 int nr, alloc;
55 struct exclude_list *el;
63d285c8
JH
56};
57
453ec4bd
LT
58struct dir_struct {
59 int nr, alloc;
2abd31b0 60 int ignored_nr, ignored_alloc;
7c4c97c0
JS
61 enum {
62 DIR_SHOW_IGNORED = 1<<0,
63 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
64 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
65 DIR_NO_GITLINKS = 1<<3,
66 DIR_COLLECT_IGNORED = 1<<4
67 } flags;
453ec4bd 68 struct dir_entry **entries;
2abd31b0 69 struct dir_entry **ignored;
453ec4bd
LT
70
71 /* Exclude info */
72 const char *exclude_per_dir;
c082df24 73
63d285c8 74 /*
c082df24
AS
75 * We maintain three groups of exclude pattern lists:
76 *
63d285c8
JH
77 * EXC_CMDL lists patterns explicitly given on the command line.
78 * EXC_DIRS lists patterns obtained from per-directory ignore files.
c082df24
AS
79 * EXC_FILE lists patterns from fallback ignore files, e.g.
80 * - .git/info/exclude
81 * - core.excludesfile
82 *
83 * Each group contains multiple exclude lists, a single list
84 * per source.
63d285c8
JH
85 */
86#define EXC_CMDL 0
87#define EXC_DIRS 1
88#define EXC_FILE 2
c082df24 89 struct exclude_list_group exclude_list_group[3];
63d285c8 90
95a68344
AS
91 /*
92 * Temporary variables which are used during loading of the
93 * per-directory exclude lists.
94 *
95 * exclude_stack points to the top of the exclude_stack, and
96 * basebuf contains the full path to the current
97 * (sub)directory in the traversal.
98 */
63d285c8
JH
99 struct exclude_stack *exclude_stack;
100 char basebuf[PATH_MAX];
453ec4bd
LT
101};
102
e813d50e
JH
103#define MATCHED_RECURSIVELY 1
104#define MATCHED_FNMATCH 2
105#define MATCHED_EXACTLY 3
f950eb95 106extern char *common_prefix(const char **pathspec);
3c6a370b 107extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
61cf2820
NTND
108extern int match_pathspec_depth(const struct pathspec *pathspec,
109 const char *name, int namelen,
110 int prefix, char *seen);
bc96cc87 111extern int within_depth(const char *name, int namelen, int depth, int max_depth);
3c6a370b 112
1d8842d9 113extern int fill_directory(struct dir_struct *dir, const char **pathspec);
dba2e203 114extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
f8a9d428 115
07958050
AS
116extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
117 int *dtype, struct exclude_list *el);
108da0db 118struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
eb41775e 119
82dce998
NTND
120/*
121 * these implement the matching logic for dir.c:excluded_from_list and
122 * attr.c:path_matches()
123 */
124extern int match_basename(const char *, int,
125 const char *, int, int, int);
126extern int match_pathname(const char *, int,
127 const char *, int,
128 const char *, int, int, int);
129
eb41775e 130/*
6d24e7a8
AS
131 * The is_excluded() API is meant for callers that check each level of leading
132 * directory hierarchies with is_excluded() to avoid recursing into excluded
eb41775e
JH
133 * directories. Callers that do not do so should use this API instead.
134 */
135struct path_exclude_check {
136 struct dir_struct *dir;
a35341a8 137 struct exclude *exclude;
eb41775e
JH
138 struct strbuf path;
139};
140extern void path_exclude_check_init(struct path_exclude_check *, struct dir_struct *);
141extern void path_exclude_check_clear(struct path_exclude_check *);
a35341a8
AS
142extern struct exclude *last_exclude_matching_path(struct path_exclude_check *, const char *,
143 int namelen, int *dtype);
9013089c 144extern int is_path_excluded(struct path_exclude_check *, const char *, int namelen, int *dtype);
782cd4c0 145
eb41775e 146
c082df24 147extern struct exclude_list *add_exclude_list(struct dir_struct *dir, int group_type);
cb097534 148extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
c082df24 149 struct exclude_list *el, int check_index);
453ec4bd 150extern void add_excludes_from_file(struct dir_struct *, const char *fname);
82dce998 151extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
453ec4bd 152extern void add_exclude(const char *string, const char *base,
840fc334 153 int baselen, struct exclude_list *el);
f6198812 154extern void clear_exclude_list(struct exclude_list *el);
c91f0d92 155extern int file_exists(const char *);
453ec4bd 156
e6636747 157extern int is_inside_dir(const char *dir);
9b125da4 158extern int dir_inside_of(const char *subdir, const char *dir);
e6636747 159
8ca12c0d
AP
160static inline int is_dot_or_dotdot(const char *name)
161{
162 return (name[0] == '.' &&
163 (name[1] == '\0' ||
164 (name[1] == '.' && name[2] == '\0')));
165}
166
55892d23
AP
167extern int is_empty_dir(const char *dir);
168
039bc64e 169extern void setup_standard_excludes(struct dir_struct *dir);
a0f4afbe
JH
170
171#define REMOVE_DIR_EMPTY_ONLY 01
172#define REMOVE_DIR_KEEP_NESTED_GIT 02
c844a803 173#define REMOVE_DIR_KEEP_TOPLEVEL 04
a0f4afbe 174extern int remove_dir_recursively(struct strbuf *path, int flag);
7155b727 175
4a92d1bf
AR
176/* tries to remove the path with empty directories along it, ignores ENOENT */
177extern int remove_path(const char *path);
178
8cf2a84e
JJ
179extern int strcmp_icase(const char *a, const char *b);
180extern int strncmp_icase(const char *a, const char *b, size_t count);
181extern int fnmatch_icase(const char *pattern, const char *string, int flags);
182
453ec4bd 183#endif