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