[thirdparty/git.git] / dir.h

#ifndef DIR_H
#define DIR_H

/* See Documentation/technical/api-directory-listing.txt */

#include "cache.h"
#include "strbuf.h"

struct dir_entry {
	unsigned int len;
	char name[FLEX_ARRAY]; /* more */
};

#define PATTERN_FLAG_NODIR 1
#define PATTERN_FLAG_ENDSWITH 4
#define PATTERN_FLAG_MUSTBEDIR 8
#define PATTERN_FLAG_NEGATIVE 16

struct path_pattern {
	/*
	 * This allows callers of last_matching_pattern() etc.
	 * to determine the origin of the matching pattern.
	 */
	struct pattern_list *pl;

	const char *pattern;
	int patternlen;
	int nowildcardlen;
	const char *base;
	int baselen;
	unsigned flags;		/* PATTERN_FLAG_* */

	/*
	 * Counting starts from 1 for line numbers in ignore files,
	 * and from -1 decrementing for patterns from CLI args.
	 */
	int srcpos;
};

/*
 * Each excludes file will be parsed into a fresh exclude_list which
 * is appended to the relevant exclude_list_group (either EXC_DIRS or
 * EXC_FILE).  An exclude_list within the EXC_CMDL exclude_list_group
 * can also be used to represent the list of --exclude values passed
 * via CLI args.
 */
struct pattern_list {
	int nr;
	int alloc;

	/* remember pointer to exclude file contents so we can free() */
	char *filebuf;

	/* origin of list, e.g. path to filename, or descriptive string */
	const char *src;

	struct path_pattern **patterns;
};

/*
 * The contents of the per-directory exclude files are lazily read on
 * demand and then cached in memory, one per exclude_stack struct, in
 * order to avoid opening and parsing each one every time that
 * directory is traversed.
 */
struct exclude_stack {
	struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
	int baselen;
	int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
	struct untracked_cache_dir *ucd;
};

struct exclude_list_group {
	int nr, alloc;
	struct pattern_list *pl;
};

struct oid_stat {
	struct stat_data stat;
	struct object_id oid;
	int valid;
};

/*
 *  Untracked cache
 *
 *  The following inputs are sufficient to determine what files in a
 *  directory are excluded:
 *
 *   - The list of files and directories of the directory in question
 *   - The $GIT_DIR/index
 *   - dir_struct flags
 *   - The content of $GIT_DIR/info/exclude
 *   - The content of core.excludesfile
 *   - The content (or the lack) of .gitignore of all parent directories
 *     from $GIT_WORK_TREE
 *   - The check_only flag in read_directory_recursive (for
 *     DIR_HIDE_EMPTY_DIRECTORIES)
 *
 *  The first input can be checked using directory mtime. In many
 *  filesystems, directory mtime (stat_data field) is updated when its
 *  files or direct subdirs are added or removed.
 *
 *  The second one can be hooked from cache_tree_invalidate_path().
 *  Whenever a file (or a submodule) is added or removed from a
 *  directory, we invalidate that directory.
 *
 *  The remaining inputs are easy, their SHA-1 could be used to verify
 *  their contents (exclude_sha1[], info_exclude_sha1[] and
 *  excludes_file_sha1[])
 */
struct untracked_cache_dir {
	struct untracked_cache_dir **dirs;
	char **untracked;
	struct stat_data stat_data;
	unsigned int untracked_alloc, dirs_nr, dirs_alloc;
	unsigned int untracked_nr;
	unsigned int check_only : 1;
	/* all data except 'dirs' in this struct are good */
	unsigned int valid : 1;
	unsigned int recurse : 1;
	/* null object ID means this directory does not have .gitignore */
	struct object_id exclude_oid;
	char name[FLEX_ARRAY];
};

struct untracked_cache {
	struct oid_stat ss_info_exclude;
	struct oid_stat ss_excludes_file;
	const char *exclude_per_dir;
	struct strbuf ident;
	/*
	 * dir_struct#flags must match dir_flags or the untracked
	 * cache is ignored.
	 */
	unsigned dir_flags;
	struct untracked_cache_dir *root;
	/* Statistics */
	int dir_created;
	int gitignore_invalidated;
	int dir_invalidated;
	int dir_opened;
	/* fsmonitor invalidation data */
	unsigned int use_fsmonitor : 1;
};

struct dir_struct {
	int nr, alloc;
	int ignored_nr, ignored_alloc;
	enum {
		DIR_SHOW_IGNORED = 1<<0,
		DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
		DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
		DIR_NO_GITLINKS = 1<<3,
		DIR_COLLECT_IGNORED = 1<<4,
		DIR_SHOW_IGNORED_TOO = 1<<5,
		DIR_COLLECT_KILLED_ONLY = 1<<6,
		DIR_KEEP_UNTRACKED_CONTENTS = 1<<7,
		DIR_SHOW_IGNORED_TOO_MODE_MATCHING = 1<<8
	} flags;
	struct dir_entry **entries;
	struct dir_entry **ignored;

	/* Exclude info */
	const char *exclude_per_dir;

	/*
	 * We maintain three groups of exclude pattern lists:
	 *
	 * EXC_CMDL lists patterns explicitly given on the command line.
	 * EXC_DIRS lists patterns obtained from per-directory ignore files.
	 * EXC_FILE lists patterns from fallback ignore files, e.g.
	 *   - .git/info/exclude
	 *   - core.excludesfile
	 *
	 * Each group contains multiple exclude lists, a single list
	 * per source.
	 */
#define EXC_CMDL 0
#define EXC_DIRS 1
#define EXC_FILE 2
	struct exclude_list_group exclude_list_group[3];

	/*
	 * Temporary variables which are used during loading of the
	 * per-directory exclude lists.
	 *
	 * exclude_stack points to the top of the exclude_stack, and
	 * basebuf contains the full path to the current
	 * (sub)directory in the traversal. Exclude points to the
	 * matching exclude struct if the directory is excluded.
	 */
	struct exclude_stack *exclude_stack;
	struct path_pattern *pattern;
	struct strbuf basebuf;

	/* Enable untracked file cache if set */
	struct untracked_cache *untracked;
	struct oid_stat ss_info_exclude;
	struct oid_stat ss_excludes_file;
	unsigned unmanaged_exclude_files;
};

/*Count the number of slashes for string s*/
int count_slashes(const char *s);

/*
 * The ordering of these constants is significant, with
 * higher-numbered match types signifying "closer" (i.e. more
 * specific) matches which will override lower-numbered match types
 * when populating the seen[] array.
 */
#define MATCHED_RECURSIVELY 1
#define MATCHED_FNMATCH 2
#define MATCHED_EXACTLY 3
int simple_length(const char *match);
int no_wildcard(const char *string);
char *common_prefix(const struct pathspec *pathspec);
int match_pathspec(const struct index_state *istate,
		   const struct pathspec *pathspec,
		   const char *name, int namelen,
		   int prefix, char *seen, int is_dir);
int report_path_error(const char *ps_matched, const struct pathspec *pathspec);
int within_depth(const char *name, int namelen, int depth, int max_depth);

int fill_directory(struct dir_struct *dir,
		   struct index_state *istate,
		   const struct pathspec *pathspec);
int read_directory(struct dir_struct *, struct index_state *istate,
		   const char *path, int len,
		   const struct pathspec *pathspec);

enum pattern_match_result {
	UNDECIDED = -1,
	NOT_MATCHED = 0,
	MATCHED = 1,
};

/*
 * Scan the list of patterns to determine if the ordered list
 * of patterns matches on 'pathname'.
 *
 * Return 1 for a match, 0 for not matched and -1 for undecided.
 */
enum pattern_match_result path_matches_pattern_list(const char *pathname,
				int pathlen,
				const char *basename, int *dtype,
				struct pattern_list *pl,
				struct index_state *istate);
struct dir_entry *dir_add_ignored(struct dir_struct *dir,
				  struct index_state *istate,
				  const char *pathname, int len);

/*
 * these implement the matching logic for dir.c:excluded_from_list and
 * attr.c:path_matches()
 */
int match_basename(const char *, int,
		   const char *, int, int, unsigned);
int match_pathname(const char *, int,
		   const char *, int,
		   const char *, int, int, unsigned);

struct path_pattern *last_matching_pattern(struct dir_struct *dir,
					   struct index_state *istate,
					   const char *name, int *dtype);

int is_excluded(struct dir_struct *dir,
		struct index_state *istate,
		const char *name, int *dtype);

struct pattern_list *add_pattern_list(struct dir_struct *dir,
				      int group_type, const char *src);
int add_patterns_from_file_to_list(const char *fname, const char *base, int baselen,
				   struct pattern_list *pl, struct  index_state *istate);
void add_patterns_from_file(struct dir_struct *, const char *fname);
int add_patterns_from_blob_to_list(struct object_id *oid,
				   const char *base, int baselen,
				   struct pattern_list *pl);
void parse_path_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
void add_pattern(const char *string, const char *base,
		 int baselen, struct pattern_list *pl, int srcpos);
void clear_pattern_list(struct pattern_list *pl);
void clear_directory(struct dir_struct *dir);

int repo_file_exists(struct repository *repo, const char *path);
int file_exists(const char *);

int is_inside_dir(const char *dir);
int dir_inside_of(const char *subdir, const char *dir);

static inline int is_dot_or_dotdot(const char *name)
{
	return (name[0] == '.' &&
		(name[1] == '\0' ||
		 (name[1] == '.' && name[2] == '\0')));
}

int is_empty_dir(const char *dir);

void setup_standard_excludes(struct dir_struct *dir);


/* Constants for remove_dir_recursively: */

/*
 * If a non-directory is found within path, stop and return an error.
 * (In this case some empty directories might already have been
 * removed.)
 */
#define REMOVE_DIR_EMPTY_ONLY 01

/*
 * If any Git work trees are found within path, skip them without
 * considering it an error.
 */
#define REMOVE_DIR_KEEP_NESTED_GIT 02

/* Remove the contents of path, but leave path itself. */
#define REMOVE_DIR_KEEP_TOPLEVEL 04

/*
 * Remove path and its contents, recursively. flags is a combination
 * of the above REMOVE_DIR_* constants. Return 0 on success.
 *
 * This function uses path as temporary scratch space, but restores it
 * before returning.
 */
int remove_dir_recursively(struct strbuf *path, int flag);

/* tries to remove the path with empty directories along it, ignores ENOENT */
int remove_path(const char *path);

int fspathcmp(const char *a, const char *b);
int fspathncmp(const char *a, const char *b, size_t count);

/*
 * The prefix part of pattern must not contains wildcards.
 */
struct pathspec_item;
int git_fnmatch(const struct pathspec_item *item,
		const char *pattern, const char *string,
		int prefix);

int submodule_path_match(const struct index_state *istate,
			 const struct pathspec *ps,
			 const char *submodule_name,
			 char *seen);

static inline int ce_path_match(const struct index_state *istate,
				const struct cache_entry *ce,
				const struct pathspec *pathspec,
				char *seen)
{
	return match_pathspec(istate, pathspec, ce->name, ce_namelen(ce), 0, seen,
			      S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
}

static inline int dir_path_match(const struct index_state *istate,
				 const struct dir_entry *ent,
				 const struct pathspec *pathspec,
				 int prefix, char *seen)
{
	int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
	int len = has_trailing_dir ? ent->len - 1 : ent->len;
	return match_pathspec(istate, pathspec, ent->name, len, prefix, seen,
			      has_trailing_dir);
}

int cmp_dir_entry(const void *p1, const void *p2);
int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);

void untracked_cache_invalidate_path(struct index_state *, const char *, int safe_path);
void untracked_cache_remove_from_index(struct index_state *, const char *);
void untracked_cache_add_to_index(struct index_state *, const char *);

void free_untracked_cache(struct untracked_cache *);
struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
void add_untracked_cache(struct index_state *istate);
void remove_untracked_cache(struct index_state *istate);

/*
 * Connect a worktree to a git directory by creating (or overwriting) a
 * '.git' file containing the location of the git directory. In the git
 * directory set the core.worktree setting to indicate where the worktree is.
 * When `recurse_into_nested` is set, recurse into any nested submodules,
 * connecting them as well.
 */
void connect_work_tree_and_git_dir(const char *work_tree,
				   const char *git_dir,
				   int recurse_into_nested);
void relocate_gitdir(const char *path,
		     const char *old_git_dir,
		     const char *new_git_dir);
#endif
Commit	Line	Data
453ec4bd LT	1	#ifndef DIR_H
	2	#define DIR_H
	3
95a68344 AS	4	/* See Documentation/technical/api-directory-listing.txt */
95a68344 AS	5
70c369cd	6	#include "cache.h"
eb41775e JH	7	#include "strbuf.h"
eb41775e JH	8
453ec4bd	9	struct dir_entry {
e96980ef	10	unsigned int len;
453ec4bd LT	11	char name[FLEX_ARRAY]; /* more */
	12	};
	13
4ff89ee5 DS	14	#define PATTERN_FLAG_NODIR 1
	15	#define PATTERN_FLAG_ENDSWITH 4
	16	#define PATTERN_FLAG_MUSTBEDIR 8
	17	#define PATTERN_FLAG_NEGATIVE 16
68492fc7	18
ab8db613	19	struct path_pattern {
709359c8	20	/*
65edd96a	21	* This allows callers of last_matching_pattern() etc.
709359c8 NTND	22	* to determine the origin of the matching pattern.
709359c8 NTND	23	*/
caa3d554	24	struct pattern_list *pl;
709359c8 NTND	25
	26	const char *pattern;
	27	int patternlen;
	28	int nowildcardlen;
	29	const char *base;
	30	int baselen;
4ff89ee5	31	unsigned flags; /* PATTERN_FLAG_* */
709359c8 NTND	32
	33	/*
	34	* Counting starts from 1 for line numbers in ignore files,
	35	* and from -1 decrementing for patterns from CLI args.
	36	*/
	37	int srcpos;
	38	};
	39
95a68344	40	/*
c082df24 AS	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
	45	* via CLI args.
95a68344	46	*/
caa3d554	47	struct pattern_list {
453ec4bd LT	48	int nr;
453ec4bd LT	49	int alloc;
c04318e4	50
c082df24 AS	51	/* remember pointer to exclude file contents so we can free() */
	52	char *filebuf;
	53
c04318e4 AS	54	/* origin of list, e.g. path to filename, or descriptive string */
	55	const char *src;
	56
ab8db613	57	struct path_pattern **patterns;
453ec4bd LT	58	};
453ec4bd LT	59
95a68344 AS	60	/*
	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.
	65	*/
63d285c8	66	struct exclude_stack {
95a68344	67	struct exclude_stack prev; / the struct exclude_stack for the parent directory */
63d285c8	68	int baselen;
c082df24	69	int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
0dcb8d7f	70	struct untracked_cache_dir *ucd;
c082df24 AS	71	};
	72
	73	struct exclude_list_group {
	74	int nr, alloc;
caa3d554	75	struct pattern_list *pl;
63d285c8 JH	76	};
63d285c8 JH	77
4b33e602	78	struct oid_stat {
55fe6f51	79	struct stat_data stat;
4b33e602	80	struct object_id oid;
55fe6f51 NTND	81	int valid;
	82	};
	83
0dcb8d7f NTND	84	/*
	85	* Untracked cache
	86	*
	87	* The following inputs are sufficient to determine what files in a
	88	* directory are excluded:
	89	*
	90	* - The list of files and directories of the directory in question
	91	* - The $GIT_DIR/index
	92	* - dir_struct flags
	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
	96	* from $GIT_WORK_TREE
	97	* - The check_only flag in read_directory_recursive (for
	98	* DIR_HIDE_EMPTY_DIRECTORIES)
	99	*
	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.
	103	*
	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.
	107	*
	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[])
	111	*/
	112	struct untracked_cache_dir {
	113	struct untracked_cache_dir **dirs;
	114	char **untracked;
	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;
26cb0182	119	/* all data except 'dirs' in this struct are good */
ccad261f	120	unsigned int valid : 1;
26cb0182	121	unsigned int recurse : 1;
70c369cd	122	/* null object ID means this directory does not have .gitignore */
70c369cd	123	struct object_id exclude_oid;
0dcb8d7f NTND	124	char name[FLEX_ARRAY];
	125	};
	126
	127	struct untracked_cache {
4b33e602 PO	128	struct oid_stat ss_info_exclude;
4b33e602 PO	129	struct oid_stat ss_excludes_file;
0dcb8d7f	130	const char *exclude_per_dir;
1e8fef60	131	struct strbuf ident;
0dcb8d7f NTND	132	/*
	133	* dir_struct#flags must match dir_flags or the untracked
	134	* cache is ignored.
	135	*/
	136	unsigned dir_flags;
	137	struct untracked_cache_dir *root;
	138	/* Statistics */
	139	int dir_created;
ccad261f	140	int gitignore_invalidated;
91a2288b NTND	141	int dir_invalidated;
91a2288b NTND	142	int dir_opened;
883e248b BP	143	/* fsmonitor invalidation data */
883e248b BP	144	unsigned int use_fsmonitor : 1;
0dcb8d7f NTND	145	};
0dcb8d7f NTND	146
453ec4bd LT	147	struct dir_struct {
453ec4bd LT	148	int nr, alloc;
2abd31b0	149	int ignored_nr, ignored_alloc;
7c4c97c0 JS	150	enum {
	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,
0aaf62b6	155	DIR_COLLECT_IGNORED = 1<<4,
2eac2a4c	156	DIR_SHOW_IGNORED_TOO = 1<<5,
fb898888	157	DIR_COLLECT_KILLED_ONLY = 1<<6,
eec0f7f2 JM	158	DIR_KEEP_UNTRACKED_CONTENTS = 1<<7,
eec0f7f2 JM	159	DIR_SHOW_IGNORED_TOO_MODE_MATCHING = 1<<8
7c4c97c0	160	} flags;
453ec4bd	161	struct dir_entry **entries;
2abd31b0	162	struct dir_entry **ignored;
453ec4bd LT	163
	164	/* Exclude info */
	165	const char *exclude_per_dir;
c082df24	166
63d285c8	167	/*
c082df24 AS	168	* We maintain three groups of exclude pattern lists:
c082df24 AS	169	*
63d285c8 JH	170	* EXC_CMDL lists patterns explicitly given on the command line.
63d285c8 JH	171	* EXC_DIRS lists patterns obtained from per-directory ignore files.
c082df24 AS	172	* EXC_FILE lists patterns from fallback ignore files, e.g.
	173	* - .git/info/exclude
	174	* - core.excludesfile
	175	*
	176	* Each group contains multiple exclude lists, a single list
	177	* per source.
63d285c8 JH	178	*/
	179	#define EXC_CMDL 0
	180	#define EXC_DIRS 1
	181	#define EXC_FILE 2
c082df24	182	struct exclude_list_group exclude_list_group[3];
63d285c8	183
95a68344 AS	184	/*
	185	* Temporary variables which are used during loading of the
	186	* per-directory exclude lists.
	187	*
	188	* exclude_stack points to the top of the exclude_stack, and
	189	* basebuf contains the full path to the current
95c6f271 KB	190	* (sub)directory in the traversal. Exclude points to the
95c6f271 KB	191	* matching exclude struct if the directory is excluded.
95a68344	192	*/
63d285c8	193	struct exclude_stack *exclude_stack;
ab8db613	194	struct path_pattern *pattern;
aceb9429	195	struct strbuf basebuf;
0dcb8d7f NTND	196
	197	/* Enable untracked file cache if set */
	198	struct untracked_cache *untracked;
4b33e602 PO	199	struct oid_stat ss_info_exclude;
4b33e602 PO	200	struct oid_stat ss_excludes_file;
ccad261f	201	unsigned unmanaged_exclude_files;
453ec4bd LT	202	};
453ec4bd LT	203
e0556a92	204	/Count the number of slashes for string s/
55454427	205	int count_slashes(const char *s);
e0556a92	206
52ed1894 AS	207	/*
	208	* The ordering of these constants is significant, with
	209	* higher-numbered match types signifying "closer" (i.e. more
	210	* specific) matches which will override lower-numbered match types
	211	* when populating the seen[] array.
	212	*/
e813d50e JH	213	#define MATCHED_RECURSIVELY 1
	214	#define MATCHED_FNMATCH 2
	215	#define MATCHED_EXACTLY 3
55454427 DL	216	int simple_length(const char *match);
	217	int no_wildcard(const char *string);
	218	char common_prefix(const struct pathspec pathspec);
	219	int match_pathspec(const struct index_state *istate,
ad6dad09 DL	220	const struct pathspec *pathspec,
	221	const char *name, int namelen,
	222	int prefix, char *seen, int is_dir);
4aeeef37	223	int report_path_error(const char ps_matched, const struct pathspec pathspec);
55454427	224	int within_depth(const char *name, int namelen, int depth, int max_depth);
3c6a370b	225
55454427	226	int fill_directory(struct dir_struct *dir,
ad6dad09 DL	227	struct index_state *istate,
ad6dad09 DL	228	const struct pathspec *pathspec);
55454427	229	int read_directory(struct dir_struct , struct index_state istate,
ad6dad09 DL	230	const char *path, int len,
ad6dad09 DL	231	const struct pathspec *pathspec);
f8a9d428	232
468ce99b DS	233	enum pattern_match_result {
	234	UNDECIDED = -1,
	235	NOT_MATCHED = 0,
	236	MATCHED = 1,
	237	};
	238
	239	/*
	240	* Scan the list of patterns to determine if the ordered list
	241	* of patterns matches on 'pathname'.
	242	*
	243	* Return 1 for a match, 0 for not matched and -1 for undecided.
	244	*/
	245	enum pattern_match_result path_matches_pattern_list(const char *pathname,
	246	int pathlen,
	247	const char basename, int dtype,
	248	struct pattern_list *pl,
	249	struct index_state *istate);
9e58beca BW	250	struct dir_entry dir_add_ignored(struct dir_struct dir,
	251	struct index_state *istate,
	252	const char *pathname, int len);
eb41775e	253
82dce998 NTND	254	/*
	255	* these implement the matching logic for dir.c:excluded_from_list and
	256	* attr.c:path_matches()
	257	*/
55454427	258	int match_basename(const char *, int,
ad6dad09	259	const char *, int, int, unsigned);
55454427	260	int match_pathname(const char *, int,
ad6dad09 DL	261	const char *, int,
ad6dad09 DL	262	const char *, int, int, unsigned);
82dce998	263
65edd96a DS	264	struct path_pattern last_matching_pattern(struct dir_struct dir,
	265	struct index_state *istate,
	266	const char name, int dtype);
782cd4c0	267
55454427	268	int is_excluded(struct dir_struct *dir,
ad6dad09 DL	269	struct index_state *istate,
ad6dad09 DL	270	const char name, int dtype);
eb41775e	271
65edd96a	272	struct pattern_list add_pattern_list(struct dir_struct dir,
ad6dad09	273	int group_type, const char *src);
65edd96a	274	int add_patterns_from_file_to_list(const char fname, const char base, int baselen,
caa3d554	275	struct pattern_list pl, struct index_state istate);
65edd96a DS	276	void add_patterns_from_file(struct dir_struct , const char fname);
65edd96a DS	277	int add_patterns_from_blob_to_list(struct object_id *oid,
ad6dad09	278	const char *base, int baselen,
caa3d554	279	struct pattern_list *pl);
65edd96a DS	280	void parse_path_pattern(const char *string, int patternlen, unsigned flags, int nowildcardlen);
65edd96a DS	281	void add_pattern(const char string, const char base,
caa3d554	282	int baselen, struct pattern_list *pl, int srcpos);
65edd96a	283	void clear_pattern_list(struct pattern_list *pl);
55454427	284	void clear_directory(struct dir_struct *dir);
0488481e NTND	285
	286	int repo_file_exists(struct repository repo, const char path);
	287	int file_exists(const char *);
453ec4bd	288
55454427 DL	289	int is_inside_dir(const char *dir);
55454427 DL	290	int dir_inside_of(const char subdir, const char dir);
e6636747	291
8ca12c0d AP	292	static inline int is_dot_or_dotdot(const char *name)
	293	{
	294	return (name[0] == '.' &&
	295	(name[1] == '\0' \|\|
	296	(name[1] == '.' && name[2] == '\0')));
	297	}
	298
55454427	299	int is_empty_dir(const char *dir);
55892d23	300
55454427	301	void setup_standard_excludes(struct dir_struct *dir);
a0f4afbe	302
728af283 MH	303
	304	/* Constants for remove_dir_recursively: */
	305
	306	/*
	307	* If a non-directory is found within path, stop and return an error.
	308	* (In this case some empty directories might already have been
	309	* removed.)
	310	*/
a0f4afbe	311	#define REMOVE_DIR_EMPTY_ONLY 01
728af283 MH	312
	313	/*
	314	* If any Git work trees are found within path, skip them without
	315	* considering it an error.
	316	*/
a0f4afbe	317	#define REMOVE_DIR_KEEP_NESTED_GIT 02
728af283 MH	318
728af283 MH	319	/* Remove the contents of path, but leave path itself. */
c844a803	320	#define REMOVE_DIR_KEEP_TOPLEVEL 04
728af283 MH	321
	322	/*
	323	* Remove path and its contents, recursively. flags is a combination
	324	* of the above REMOVE_DIR_* constants. Return 0 on success.
	325	*
	326	* This function uses path as temporary scratch space, but restores it
	327	* before returning.
	328	*/
55454427	329	int remove_dir_recursively(struct strbuf *path, int flag);
7155b727	330
4a92d1bf	331	/* tries to remove the path with empty directories along it, ignores ENOENT */
55454427	332	int remove_path(const char *path);
4a92d1bf	333
55454427 DL	334	int fspathcmp(const char a, const char b);
55454427 DL	335	int fspathncmp(const char a, const char b, size_t count);
8cf2a84e	336
5d74762d NTND	337	/*
	338	* The prefix part of pattern must not contains wildcards.
	339	*/
bd30c2e4	340	struct pathspec_item;
55454427	341	int git_fnmatch(const struct pathspec_item *item,
ad6dad09 DL	342	const char pattern, const char string,
ad6dad09 DL	343	int prefix);
5d74762d	344
55454427	345	int submodule_path_match(const struct index_state *istate,
ad6dad09 DL	346	const struct pathspec *ps,
	347	const char *submodule_name,
	348	char *seen);
75a6315f	349
6d2df284 NTND	350	static inline int ce_path_match(const struct index_state *istate,
6d2df284 NTND	351	const struct cache_entry *ce,
429bb40a NTND	352	const struct pathspec *pathspec,
	353	char *seen)
	354	{
6d2df284	355	return match_pathspec(istate, pathspec, ce->name, ce_namelen(ce), 0, seen,
ae8d0824	356	S_ISDIR(ce->ce_mode) \|\| S_ISGITLINK(ce->ce_mode));
429bb40a NTND	357	}
429bb40a NTND	358
6d2df284 NTND	359	static inline int dir_path_match(const struct index_state *istate,
6d2df284 NTND	360	const struct dir_entry *ent,
ebb32893 NTND	361	const struct pathspec *pathspec,
	362	int prefix, char *seen)
	363	{
ae8d0824 NTND	364	int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
ae8d0824 NTND	365	int len = has_trailing_dir ? ent->len - 1 : ent->len;
6d2df284	366	return match_pathspec(istate, pathspec, ent->name, len, prefix, seen,
ae8d0824	367	has_trailing_dir);
ebb32893 NTND	368	}
ebb32893 NTND	369
bbf504a9 SL	370	int cmp_dir_entry(const void p1, const void p2);
	371	int check_dir_entry_contains(const struct dir_entry out, const struct dir_entry in);
	372
0cacebf0	373	void untracked_cache_invalidate_path(struct index_state , const char , int safe_path);
e931371a NTND	374	void untracked_cache_remove_from_index(struct index_state , const char );
	375	void untracked_cache_add_to_index(struct index_state , const char );
	376
f9e6c649 NTND	377	void free_untracked_cache(struct untracked_cache *);
f9e6c649 NTND	378	struct untracked_cache read_untracked_extension(const void data, unsigned long sz);
83c094ad	379	void write_untracked_extension(struct strbuf out, struct untracked_cache untracked);
4a4ca479	380	void add_untracked_cache(struct index_state *istate);
07b29bfd	381	void remove_untracked_cache(struct index_state *istate);
da62f786 SB	382
	383	/*
	384	* Connect a worktree to a git directory by creating (or overwriting) a
	385	* '.git' file containing the location of the git directory. In the git
	386	* directory set the core.worktree setting to indicate where the worktree is.
	387	* When `recurse_into_nested` is set, recurse into any nested submodules,
	388	* connecting them as well.
	389	*/
55454427	390	void connect_work_tree_and_git_dir(const char *work_tree,
ad6dad09 DL	391	const char *git_dir,
ad6dad09 DL	392	int recurse_into_nested);
55454427	393	void relocate_gitdir(const char *path,
ad6dad09 DL	394	const char *old_git_dir,
ad6dad09 DL	395	const char *new_git_dir);
453ec4bd	396	#endif