4 /* See Documentation/technical/api-directory-listing.txt */
11 char name
[FLEX_ARRAY
]; /* more */
14 #define EXC_FLAG_NODIR 1
15 #define EXC_FLAG_ENDSWITH 4
16 #define EXC_FLAG_MUSTBEDIR 8
17 #define EXC_FLAG_NEGATIVE 16
21 * This allows callers of last_exclude_matching() etc.
22 * to determine the origin of the matching pattern.
24 struct exclude_list
*el
;
31 unsigned flags
; /* EXC_FLAG_* */
34 * Counting starts from 1 for line numbers in ignore files,
35 * and from -1 decrementing for patterns from CLI args.
41 * Each excludes file will be parsed into a fresh exclude_list which
42 * is appended to the relevant exclude_list_group (either EXC_DIRS or
43 * EXC_FILE). An exclude_list within the EXC_CMDL exclude_list_group
44 * can also be used to represent the list of --exclude values passed
51 /* remember pointer to exclude file contents so we can free() */
54 /* origin of list, e.g. path to filename, or descriptive string */
57 struct exclude
**excludes
;
61 * The contents of the per-directory exclude files are lazily read on
62 * demand and then cached in memory, one per exclude_stack struct, in
63 * order to avoid opening and parsing each one every time that
64 * directory is traversed.
66 struct exclude_stack
{
67 struct exclude_stack
*prev
; /* the struct exclude_stack for the parent directory */
69 int exclude_ix
; /* index of exclude_list within EXC_DIRS exclude_list_group */
70 struct untracked_cache_dir
*ucd
;
73 struct exclude_list_group
{
75 struct exclude_list
*el
;
79 struct stat_data stat
;
87 * The following inputs are sufficient to determine what files in a
88 * directory are excluded:
90 * - The list of files and directories of the directory in question
91 * - The $GIT_DIR/index
93 * - The content of $GIT_DIR/info/exclude
94 * - The content of core.excludesfile
95 * - The content (or the lack) of .gitignore of all parent directories
97 * - The check_only flag in read_directory_recursive (for
98 * DIR_HIDE_EMPTY_DIRECTORIES)
100 * The first input can be checked using directory mtime. In many
101 * filesystems, directory mtime (stat_data field) is updated when its
102 * files or direct subdirs are added or removed.
104 * The second one can be hooked from cache_tree_invalidate_path().
105 * Whenever a file (or a submodule) is added or removed from a
106 * directory, we invalidate that directory.
108 * The remaining inputs are easy, their SHA-1 could be used to verify
109 * their contents (exclude_sha1[], info_exclude_sha1[] and
110 * excludes_file_sha1[])
112 struct untracked_cache_dir
{
113 struct untracked_cache_dir
**dirs
;
115 struct stat_data stat_data
;
116 unsigned int untracked_alloc
, dirs_nr
, dirs_alloc
;
117 unsigned int untracked_nr
;
118 unsigned int check_only
: 1;
119 /* all data except 'dirs' in this struct are good */
120 unsigned int valid
: 1;
121 unsigned int recurse
: 1;
122 /* null object ID means this directory does not have .gitignore */
123 struct object_id exclude_oid
;
124 char name
[FLEX_ARRAY
];
127 struct untracked_cache
{
128 struct oid_stat ss_info_exclude
;
129 struct oid_stat ss_excludes_file
;
130 const char *exclude_per_dir
;
133 * dir_struct#flags must match dir_flags or the untracked
137 struct untracked_cache_dir
*root
;
140 int gitignore_invalidated
;
143 /* fsmonitor invalidation data */
144 unsigned int use_fsmonitor
: 1;
149 int ignored_nr
, ignored_alloc
;
151 DIR_SHOW_IGNORED
= 1<<0,
152 DIR_SHOW_OTHER_DIRECTORIES
= 1<<1,
153 DIR_HIDE_EMPTY_DIRECTORIES
= 1<<2,
154 DIR_NO_GITLINKS
= 1<<3,
155 DIR_COLLECT_IGNORED
= 1<<4,
156 DIR_SHOW_IGNORED_TOO
= 1<<5,
157 DIR_COLLECT_KILLED_ONLY
= 1<<6,
158 DIR_KEEP_UNTRACKED_CONTENTS
= 1<<7,
159 DIR_SHOW_IGNORED_TOO_MODE_MATCHING
= 1<<8,
160 DIR_SKIP_NESTED_GIT
= 1<<9
162 struct dir_entry
**entries
;
163 struct dir_entry
**ignored
;
166 const char *exclude_per_dir
;
169 * We maintain three groups of exclude pattern lists:
171 * EXC_CMDL lists patterns explicitly given on the command line.
172 * EXC_DIRS lists patterns obtained from per-directory ignore files.
173 * EXC_FILE lists patterns from fallback ignore files, e.g.
174 * - .git/info/exclude
175 * - core.excludesfile
177 * Each group contains multiple exclude lists, a single list
183 struct exclude_list_group exclude_list_group
[3];
186 * Temporary variables which are used during loading of the
187 * per-directory exclude lists.
189 * exclude_stack points to the top of the exclude_stack, and
190 * basebuf contains the full path to the current
191 * (sub)directory in the traversal. Exclude points to the
192 * matching exclude struct if the directory is excluded.
194 struct exclude_stack
*exclude_stack
;
195 struct exclude
*exclude
;
196 struct strbuf basebuf
;
198 /* Enable untracked file cache if set */
199 struct untracked_cache
*untracked
;
200 struct oid_stat ss_info_exclude
;
201 struct oid_stat ss_excludes_file
;
202 unsigned unmanaged_exclude_files
;
205 /*Count the number of slashes for string s*/
206 int count_slashes(const char *s
);
209 * The ordering of these constants is significant, with
210 * higher-numbered match types signifying "closer" (i.e. more
211 * specific) matches which will override lower-numbered match types
212 * when populating the seen[] array.
214 #define MATCHED_RECURSIVELY 1
215 #define MATCHED_RECURSIVELY_LEADING_PATHSPEC 2
216 #define MATCHED_FNMATCH 3
217 #define MATCHED_EXACTLY 4
218 int simple_length(const char *match
);
219 int no_wildcard(const char *string
);
220 char *common_prefix(const struct pathspec
*pathspec
);
221 int match_pathspec(const struct index_state
*istate
,
222 const struct pathspec
*pathspec
,
223 const char *name
, int namelen
,
224 int prefix
, char *seen
, int is_dir
);
225 int report_path_error(const char *ps_matched
, const struct pathspec
*pathspec
);
226 int within_depth(const char *name
, int namelen
, int depth
, int max_depth
);
228 int fill_directory(struct dir_struct
*dir
,
229 struct index_state
*istate
,
230 const struct pathspec
*pathspec
);
231 int read_directory(struct dir_struct
*, struct index_state
*istate
,
232 const char *path
, int len
,
233 const struct pathspec
*pathspec
);
235 int is_excluded_from_list(const char *pathname
, int pathlen
,
236 const char *basename
, int *dtype
,
237 struct exclude_list
*el
,
238 struct index_state
*istate
);
239 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
,
240 struct index_state
*istate
,
241 const char *pathname
, int len
);
244 * these implement the matching logic for dir.c:excluded_from_list and
245 * attr.c:path_matches()
247 int match_basename(const char *, int,
248 const char *, int, int, unsigned);
249 int match_pathname(const char *, int,
251 const char *, int, int, unsigned);
253 struct exclude
*last_exclude_matching(struct dir_struct
*dir
,
254 struct index_state
*istate
,
255 const char *name
, int *dtype
);
257 int is_excluded(struct dir_struct
*dir
,
258 struct index_state
*istate
,
259 const char *name
, int *dtype
);
261 struct exclude_list
*add_exclude_list(struct dir_struct
*dir
,
262 int group_type
, const char *src
);
263 int add_excludes_from_file_to_list(const char *fname
, const char *base
, int baselen
,
264 struct exclude_list
*el
, struct index_state
*istate
);
265 void add_excludes_from_file(struct dir_struct
*, const char *fname
);
266 int add_excludes_from_blob_to_list(struct object_id
*oid
,
267 const char *base
, int baselen
,
268 struct exclude_list
*el
);
269 void parse_exclude_pattern(const char **string
, int *patternlen
, unsigned *flags
, int *nowildcardlen
);
270 void add_exclude(const char *string
, const char *base
,
271 int baselen
, struct exclude_list
*el
, int srcpos
);
272 void clear_exclude_list(struct exclude_list
*el
);
273 void clear_directory(struct dir_struct
*dir
);
275 int repo_file_exists(struct repository
*repo
, const char *path
);
276 int file_exists(const char *);
278 int is_inside_dir(const char *dir
);
279 int dir_inside_of(const char *subdir
, const char *dir
);
281 static inline int is_dot_or_dotdot(const char *name
)
283 return (name
[0] == '.' &&
285 (name
[1] == '.' && name
[2] == '\0')));
288 int is_empty_dir(const char *dir
);
290 void setup_standard_excludes(struct dir_struct
*dir
);
293 /* Constants for remove_dir_recursively: */
296 * If a non-directory is found within path, stop and return an error.
297 * (In this case some empty directories might already have been
300 #define REMOVE_DIR_EMPTY_ONLY 01
303 * If any Git work trees are found within path, skip them without
304 * considering it an error.
306 #define REMOVE_DIR_KEEP_NESTED_GIT 02
308 /* Remove the contents of path, but leave path itself. */
309 #define REMOVE_DIR_KEEP_TOPLEVEL 04
312 * Remove path and its contents, recursively. flags is a combination
313 * of the above REMOVE_DIR_* constants. Return 0 on success.
315 * This function uses path as temporary scratch space, but restores it
318 int remove_dir_recursively(struct strbuf
*path
, int flag
);
320 /* tries to remove the path with empty directories along it, ignores ENOENT */
321 int remove_path(const char *path
);
323 int fspathcmp(const char *a
, const char *b
);
324 int fspathncmp(const char *a
, const char *b
, size_t count
);
327 * The prefix part of pattern must not contains wildcards.
329 struct pathspec_item
;
330 int git_fnmatch(const struct pathspec_item
*item
,
331 const char *pattern
, const char *string
,
334 int submodule_path_match(const struct index_state
*istate
,
335 const struct pathspec
*ps
,
336 const char *submodule_name
,
339 static inline int ce_path_match(const struct index_state
*istate
,
340 const struct cache_entry
*ce
,
341 const struct pathspec
*pathspec
,
344 return match_pathspec(istate
, pathspec
, ce
->name
, ce_namelen(ce
), 0, seen
,
345 S_ISDIR(ce
->ce_mode
) || S_ISGITLINK(ce
->ce_mode
));
348 static inline int dir_path_match(const struct index_state
*istate
,
349 const struct dir_entry
*ent
,
350 const struct pathspec
*pathspec
,
351 int prefix
, char *seen
)
353 int has_trailing_dir
= ent
->len
&& ent
->name
[ent
->len
- 1] == '/';
354 int len
= has_trailing_dir
? ent
->len
- 1 : ent
->len
;
355 return match_pathspec(istate
, pathspec
, ent
->name
, len
, prefix
, seen
,
359 int cmp_dir_entry(const void *p1
, const void *p2
);
360 int check_dir_entry_contains(const struct dir_entry
*out
, const struct dir_entry
*in
);
362 void untracked_cache_invalidate_path(struct index_state
*, const char *, int safe_path
);
363 void untracked_cache_remove_from_index(struct index_state
*, const char *);
364 void untracked_cache_add_to_index(struct index_state
*, const char *);
366 void free_untracked_cache(struct untracked_cache
*);
367 struct untracked_cache
*read_untracked_extension(const void *data
, unsigned long sz
);
368 void write_untracked_extension(struct strbuf
*out
, struct untracked_cache
*untracked
);
369 void add_untracked_cache(struct index_state
*istate
);
370 void remove_untracked_cache(struct index_state
*istate
);
373 * Connect a worktree to a git directory by creating (or overwriting) a
374 * '.git' file containing the location of the git directory. In the git
375 * directory set the core.worktree setting to indicate where the worktree is.
376 * When `recurse_into_nested` is set, recurse into any nested submodules,
377 * connecting them as well.
379 void connect_work_tree_and_git_dir(const char *work_tree
,
381 int recurse_into_nested
);
382 void relocate_gitdir(const char *path
,
383 const char *old_git_dir
,
384 const char *new_git_dir
);