4 /* See Documentation/technical/api-directory-listing.txt */
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
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
28 /* remember pointer to exclude file contents so we can free() */
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.
47 struct exclude_stack
{
48 struct exclude_stack
*prev
; /* the struct exclude_stack for the parent directory */
50 int exclude_ix
; /* index of exclude_list within EXC_DIRS exclude_list_group */
53 struct exclude_list_group
{
55 struct exclude_list
*el
;
60 int ignored_nr
, ignored_alloc
;
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
68 struct dir_entry
**entries
;
69 struct dir_entry
**ignored
;
72 const char *exclude_per_dir
;
75 * We maintain three groups of exclude pattern lists:
77 * EXC_CMDL lists patterns explicitly given on the command line.
78 * EXC_DIRS lists patterns obtained from per-directory ignore files.
79 * EXC_FILE lists patterns from fallback ignore files, e.g.
83 * Each group contains multiple exclude lists, a single list
89 struct exclude_list_group exclude_list_group
[3];
92 * Temporary variables which are used during loading of the
93 * per-directory exclude lists.
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.
99 struct exclude_stack
*exclude_stack
;
100 char basebuf
[PATH_MAX
];
103 #define MATCHED_RECURSIVELY 1
104 #define MATCHED_FNMATCH 2
105 #define MATCHED_EXACTLY 3
106 extern char *common_prefix(const char **pathspec
);
107 extern int match_pathspec(const char **pathspec
, const char *name
, int namelen
, int prefix
, char *seen
);
108 extern int match_pathspec_depth(const struct pathspec
*pathspec
,
109 const char *name
, int namelen
,
110 int prefix
, char *seen
);
111 extern int within_depth(const char *name
, int namelen
, int depth
, int max_depth
);
113 extern int fill_directory(struct dir_struct
*dir
, const char **pathspec
);
114 extern int read_directory(struct dir_struct
*, const char *path
, int len
, const char **pathspec
);
116 extern int is_excluded_from_list(const char *pathname
, int pathlen
, const char *basename
,
117 int *dtype
, struct exclude_list
*el
);
118 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
, const char *pathname
, int len
);
121 * these implement the matching logic for dir.c:excluded_from_list and
122 * attr.c:path_matches()
124 extern int match_basename(const char *, int,
125 const char *, int, int, int);
126 extern int match_pathname(const char *, int,
128 const char *, int, int, int);
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
133 * directories. Callers that do not do so should use this API instead.
135 struct path_exclude_check
{
136 struct dir_struct
*dir
;
137 struct exclude
*exclude
;
140 extern void path_exclude_check_init(struct path_exclude_check
*, struct dir_struct
*);
141 extern void path_exclude_check_clear(struct path_exclude_check
*);
142 extern struct exclude
*last_exclude_matching_path(struct path_exclude_check
*, const char *,
143 int namelen
, int *dtype
);
144 extern int is_path_excluded(struct path_exclude_check
*, const char *, int namelen
, int *dtype
);
147 extern struct exclude_list
*add_exclude_list(struct dir_struct
*dir
, int group_type
);
148 extern int add_excludes_from_file_to_list(const char *fname
, const char *base
, int baselen
,
149 struct exclude_list
*el
, int check_index
);
150 extern void add_excludes_from_file(struct dir_struct
*, const char *fname
);
151 extern void parse_exclude_pattern(const char **string
, int *patternlen
, int *flags
, int *nowildcardlen
);
152 extern void add_exclude(const char *string
, const char *base
,
153 int baselen
, struct exclude_list
*el
);
154 extern void clear_exclude_list(struct exclude_list
*el
);
155 extern int file_exists(const char *);
157 extern int is_inside_dir(const char *dir
);
158 extern int dir_inside_of(const char *subdir
, const char *dir
);
160 static inline int is_dot_or_dotdot(const char *name
)
162 return (name
[0] == '.' &&
164 (name
[1] == '.' && name
[2] == '\0')));
167 extern int is_empty_dir(const char *dir
);
169 extern void setup_standard_excludes(struct dir_struct
*dir
);
171 #define REMOVE_DIR_EMPTY_ONLY 01
172 #define REMOVE_DIR_KEEP_NESTED_GIT 02
173 #define REMOVE_DIR_KEEP_TOPLEVEL 04
174 extern int remove_dir_recursively(struct strbuf
*path
, int flag
);
176 /* tries to remove the path with empty directories along it, ignores ENOENT */
177 extern int remove_path(const char *path
);
179 extern int strcmp_icase(const char *a
, const char *b
);
180 extern int strncmp_icase(const char *a
, const char *b
, size_t count
);
181 extern int fnmatch_icase(const char *pattern
, const char *string
, int flags
);