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
29 /* remember pointer to exclude file contents so we can free() */
32 /* origin of list, e.g. path to filename, or descriptive string */
37 * This allows callers of last_exclude_matching() etc.
38 * to determine the origin of the matching pattern.
40 struct exclude_list
*el
;
50 * Counting starts from 1 for line numbers in ignore files,
51 * and from -1 decrementing for patterns from CLI args.
58 * The contents of the per-directory exclude files are lazily read on
59 * demand and then cached in memory, one per exclude_stack struct, in
60 * order to avoid opening and parsing each one every time that
61 * directory is traversed.
63 struct exclude_stack
{
64 struct exclude_stack
*prev
; /* the struct exclude_stack for the parent directory */
66 int exclude_ix
; /* index of exclude_list within EXC_DIRS exclude_list_group */
69 struct exclude_list_group
{
71 struct exclude_list
*el
;
76 int ignored_nr
, ignored_alloc
;
78 DIR_SHOW_IGNORED
= 1<<0,
79 DIR_SHOW_OTHER_DIRECTORIES
= 1<<1,
80 DIR_HIDE_EMPTY_DIRECTORIES
= 1<<2,
81 DIR_NO_GITLINKS
= 1<<3,
82 DIR_COLLECT_IGNORED
= 1<<4,
83 DIR_SHOW_IGNORED_TOO
= 1<<5,
84 DIR_COLLECT_KILLED_ONLY
= 1<<6
86 struct dir_entry
**entries
;
87 struct dir_entry
**ignored
;
90 const char *exclude_per_dir
;
93 * We maintain three groups of exclude pattern lists:
95 * EXC_CMDL lists patterns explicitly given on the command line.
96 * EXC_DIRS lists patterns obtained from per-directory ignore files.
97 * EXC_FILE lists patterns from fallback ignore files, e.g.
101 * Each group contains multiple exclude lists, a single list
107 struct exclude_list_group exclude_list_group
[3];
110 * Temporary variables which are used during loading of the
111 * per-directory exclude lists.
113 * exclude_stack points to the top of the exclude_stack, and
114 * basebuf contains the full path to the current
115 * (sub)directory in the traversal. Exclude points to the
116 * matching exclude struct if the directory is excluded.
118 struct exclude_stack
*exclude_stack
;
119 struct exclude
*exclude
;
120 char basebuf
[PATH_MAX
];
124 * The ordering of these constants is significant, with
125 * higher-numbered match types signifying "closer" (i.e. more
126 * specific) matches which will override lower-numbered match types
127 * when populating the seen[] array.
129 #define MATCHED_RECURSIVELY 1
130 #define MATCHED_FNMATCH 2
131 #define MATCHED_EXACTLY 3
132 extern int simple_length(const char *match
);
133 extern int no_wildcard(const char *string
);
134 extern char *common_prefix(const struct pathspec
*pathspec
);
135 extern int match_pathspec(const struct pathspec
*pathspec
,
136 const char *name
, int namelen
,
137 int prefix
, char *seen
, int is_dir
);
138 extern int report_path_error(const char *ps_matched
, const struct pathspec
*pathspec
, const char *prefix
);
139 extern int within_depth(const char *name
, int namelen
, int depth
, int max_depth
);
141 extern int fill_directory(struct dir_struct
*dir
, const struct pathspec
*pathspec
);
142 extern int read_directory(struct dir_struct
*, const char *path
, int len
, const struct pathspec
*pathspec
);
144 extern int is_excluded_from_list(const char *pathname
, int pathlen
, const char *basename
,
145 int *dtype
, struct exclude_list
*el
);
146 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
, const char *pathname
, int len
);
149 * these implement the matching logic for dir.c:excluded_from_list and
150 * attr.c:path_matches()
152 extern int match_basename(const char *, int,
153 const char *, int, int, int);
154 extern int match_pathname(const char *, int,
156 const char *, int, int, int);
158 extern struct exclude
*last_exclude_matching(struct dir_struct
*dir
,
159 const char *name
, int *dtype
);
161 extern int is_excluded(struct dir_struct
*dir
, const char *name
, int *dtype
);
163 extern struct exclude_list
*add_exclude_list(struct dir_struct
*dir
,
164 int group_type
, const char *src
);
165 extern int add_excludes_from_file_to_list(const char *fname
, const char *base
, int baselen
,
166 struct exclude_list
*el
, int check_index
);
167 extern void add_excludes_from_file(struct dir_struct
*, const char *fname
);
168 extern void parse_exclude_pattern(const char **string
, int *patternlen
, int *flags
, int *nowildcardlen
);
169 extern void add_exclude(const char *string
, const char *base
,
170 int baselen
, struct exclude_list
*el
, int srcpos
);
171 extern void clear_exclude_list(struct exclude_list
*el
);
172 extern void clear_directory(struct dir_struct
*dir
);
173 extern int file_exists(const char *);
175 extern int is_inside_dir(const char *dir
);
176 extern int dir_inside_of(const char *subdir
, const char *dir
);
178 static inline int is_dot_or_dotdot(const char *name
)
180 return (name
[0] == '.' &&
182 (name
[1] == '.' && name
[2] == '\0')));
185 extern int is_empty_dir(const char *dir
);
187 extern void setup_standard_excludes(struct dir_struct
*dir
);
189 #define REMOVE_DIR_EMPTY_ONLY 01
190 #define REMOVE_DIR_KEEP_NESTED_GIT 02
191 #define REMOVE_DIR_KEEP_TOPLEVEL 04
192 extern int remove_dir_recursively(struct strbuf
*path
, int flag
);
194 /* tries to remove the path with empty directories along it, ignores ENOENT */
195 extern int remove_path(const char *path
);
197 extern int strcmp_icase(const char *a
, const char *b
);
198 extern int strncmp_icase(const char *a
, const char *b
, size_t count
);
199 extern int fnmatch_icase(const char *pattern
, const char *string
, int flags
);
202 * The prefix part of pattern must not contains wildcards.
204 struct pathspec_item
;
205 extern int git_fnmatch(const struct pathspec_item
*item
,
206 const char *pattern
, const char *string
,
209 static inline int ce_path_match(const struct cache_entry
*ce
,
210 const struct pathspec
*pathspec
,
213 return match_pathspec(pathspec
, ce
->name
, ce_namelen(ce
), 0, seen
,
214 S_ISDIR(ce
->ce_mode
) || S_ISGITLINK(ce
->ce_mode
));
217 static inline int dir_path_match(const struct dir_entry
*ent
,
218 const struct pathspec
*pathspec
,
219 int prefix
, char *seen
)
221 int has_trailing_dir
= ent
->len
&& ent
->name
[ent
->len
- 1] == '/';
222 int len
= has_trailing_dir
? ent
->len
- 1 : ent
->len
;
223 return match_pathspec(pathspec
, ent
->name
, len
, prefix
, seen
,