[thirdparty/git.git] / dir.h

#ifndef DIR_H
#define DIR_H

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

#include "strbuf.h"

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

#define EXC_FLAG_NODIR 1
#define EXC_FLAG_ENDSWITH 4
#define EXC_FLAG_MUSTBEDIR 8
#define EXC_FLAG_NEGATIVE 16

struct exclude {
	/*
	 * This allows callers of last_exclude_matching() etc.
	 * to determine the origin of the matching pattern.
	 */
	struct exclude_list *el;

	const char *pattern;
	int patternlen;
	int nowildcardlen;
	const char *base;
	int baselen;
	int flags;

	/*
	 * 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 exclude_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 exclude **excludes;
};

/*
 * 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 exclude_list *el;
};

struct sha1_stat {
	struct stat_data stat;
	unsigned char sha1[20];
	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 SHA-1 means this directory does not have .gitignore */
	unsigned char exclude_sha1[20];
	char name[FLEX_ARRAY];
};

struct untracked_cache {
	struct sha1_stat ss_info_exclude;
	struct sha1_stat ss_excludes_file;
	const char *exclude_per_dir;
	/*
	 * 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;
};

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
	} 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 exclude *exclude;
	struct strbuf basebuf;

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

/*
 * 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
extern int simple_length(const char *match);
extern int no_wildcard(const char *string);
extern char *common_prefix(const struct pathspec *pathspec);
extern int match_pathspec(const struct pathspec *pathspec,
			  const char *name, int namelen,
			  int prefix, char *seen, int is_dir);
extern int within_depth(const char *name, int namelen, int depth, int max_depth);

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

extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
				 int *dtype, struct exclude_list *el);
struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);

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

extern struct exclude *last_exclude_matching(struct dir_struct *dir,
					     const char *name, int *dtype);

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

extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
					     int group_type, const char *src);
extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
					  struct exclude_list *el, int check_index);
extern void add_excludes_from_file(struct dir_struct *, const char *fname);
extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
extern void add_exclude(const char *string, const char *base,
			int baselen, struct exclude_list *el, int srcpos);
extern void clear_exclude_list(struct exclude_list *el);
extern void clear_directory(struct dir_struct *dir);
extern int file_exists(const char *);

extern int is_inside_dir(const char *dir);
extern 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')));
}

extern int is_empty_dir(const char *dir);

extern void setup_standard_excludes(struct dir_struct *dir);

#define REMOVE_DIR_EMPTY_ONLY 01
#define REMOVE_DIR_KEEP_NESTED_GIT 02
#define REMOVE_DIR_KEEP_TOPLEVEL 04
extern int remove_dir_recursively(struct strbuf *path, int flag);

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

extern int strcmp_icase(const char *a, const char *b);
extern int strncmp_icase(const char *a, const char *b, size_t count);
extern int fnmatch_icase(const char *pattern, const char *string, int flags);

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

static inline int ce_path_match(const struct cache_entry *ce,
				const struct pathspec *pathspec,
				char *seen)
{
	return match_pathspec(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 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(pathspec, ent->name, len, prefix, seen,
			      has_trailing_dir);
}

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);
#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
eb41775e JH	6	#include "strbuf.h"
eb41775e JH	7
453ec4bd	8	struct 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
709359c8 NTND	18	struct exclude {
	19	/*
	20	* This allows callers of last_exclude_matching() etc.
	21	* to determine the origin of the matching pattern.
	22	*/
	23	struct exclude_list *el;
	24
	25	const char *pattern;
	26	int patternlen;
	27	int nowildcardlen;
	28	const char *base;
	29	int baselen;
	30	int flags;
	31
	32	/*
	33	* Counting starts from 1 for line numbers in ignore files,
	34	* and from -1 decrementing for patterns from CLI args.
	35	*/
	36	int srcpos;
	37	};
	38
95a68344	39	/*
c082df24 AS	40	* Each excludes file will be parsed into a fresh exclude_list which
	41	* is appended to the relevant exclude_list_group (either EXC_DIRS or
	42	* EXC_FILE). An exclude_list within the EXC_CMDL exclude_list_group
	43	* can also be used to represent the list of --exclude values passed
	44	* via CLI args.
95a68344	45	*/
453ec4bd LT	46	struct exclude_list {
	47	int nr;
	48	int alloc;
c04318e4	49
c082df24 AS	50	/* remember pointer to exclude file contents so we can free() */
	51	char *filebuf;
	52
c04318e4 AS	53	/* origin of list, e.g. path to filename, or descriptive string */
	54	const char *src;
	55
709359c8	56	struct exclude **excludes;
453ec4bd LT	57	};
453ec4bd LT	58
95a68344 AS	59	/*
	60	* The contents of the per-directory exclude files are lazily read on
	61	* demand and then cached in memory, one per exclude_stack struct, in
	62	* order to avoid opening and parsing each one every time that
	63	* directory is traversed.
	64	*/
63d285c8	65	struct exclude_stack {
95a68344	66	struct exclude_stack prev; / the struct exclude_stack for the parent directory */
63d285c8	67	int baselen;
c082df24	68	int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
0dcb8d7f	69	struct untracked_cache_dir *ucd;
c082df24 AS	70	};
	71
	72	struct exclude_list_group {
	73	int nr, alloc;
	74	struct exclude_list *el;
63d285c8 JH	75	};
63d285c8 JH	76
55fe6f51 NTND	77	struct sha1_stat {
	78	struct stat_data stat;
	79	unsigned char sha1[20];
	80	int valid;
	81	};
	82
0dcb8d7f NTND	83	/*
	84	* Untracked cache
	85	*
	86	* The following inputs are sufficient to determine what files in a
	87	* directory are excluded:
	88	*
	89	* - The list of files and directories of the directory in question
	90	* - The $GIT_DIR/index
	91	* - dir_struct flags
	92	* - The content of $GIT_DIR/info/exclude
	93	* - The content of core.excludesfile
	94	* - The content (or the lack) of .gitignore of all parent directories
	95	* from $GIT_WORK_TREE
	96	* - The check_only flag in read_directory_recursive (for
	97	* DIR_HIDE_EMPTY_DIRECTORIES)
	98	*
	99	* The first input can be checked using directory mtime. In many
	100	* filesystems, directory mtime (stat_data field) is updated when its
	101	* files or direct subdirs are added or removed.
	102	*
	103	* The second one can be hooked from cache_tree_invalidate_path().
	104	* Whenever a file (or a submodule) is added or removed from a
	105	* directory, we invalidate that directory.
	106	*
	107	* The remaining inputs are easy, their SHA-1 could be used to verify
	108	* their contents (exclude_sha1[], info_exclude_sha1[] and
	109	* excludes_file_sha1[])
	110	*/
	111	struct untracked_cache_dir {
	112	struct untracked_cache_dir **dirs;
	113	char **untracked;
	114	struct stat_data stat_data;
	115	unsigned int untracked_alloc, dirs_nr, dirs_alloc;
	116	unsigned int untracked_nr;
	117	unsigned int check_only : 1;
26cb0182	118	/* all data except 'dirs' in this struct are good */
ccad261f	119	unsigned int valid : 1;
26cb0182	120	unsigned int recurse : 1;
0dcb8d7f NTND	121	/* null SHA-1 means this directory does not have .gitignore */
	122	unsigned char exclude_sha1[20];
	123	char name[FLEX_ARRAY];
	124	};
	125
	126	struct untracked_cache {
	127	struct sha1_stat ss_info_exclude;
	128	struct sha1_stat ss_excludes_file;
	129	const char *exclude_per_dir;
	130	/*
	131	* dir_struct#flags must match dir_flags or the untracked
	132	* cache is ignored.
	133	*/
	134	unsigned dir_flags;
	135	struct untracked_cache_dir *root;
	136	/* Statistics */
	137	int dir_created;
ccad261f	138	int gitignore_invalidated;
91a2288b NTND	139	int dir_invalidated;
91a2288b NTND	140	int dir_opened;
0dcb8d7f NTND	141	};
0dcb8d7f NTND	142
453ec4bd LT	143	struct dir_struct {
453ec4bd LT	144	int nr, alloc;
2abd31b0	145	int ignored_nr, ignored_alloc;
7c4c97c0 JS	146	enum {
	147	DIR_SHOW_IGNORED = 1<<0,
	148	DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
	149	DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
	150	DIR_NO_GITLINKS = 1<<3,
0aaf62b6	151	DIR_COLLECT_IGNORED = 1<<4,
2eac2a4c JH	152	DIR_SHOW_IGNORED_TOO = 1<<5,
2eac2a4c JH	153	DIR_COLLECT_KILLED_ONLY = 1<<6
7c4c97c0	154	} flags;
453ec4bd	155	struct dir_entry **entries;
2abd31b0	156	struct dir_entry **ignored;
453ec4bd LT	157
	158	/* Exclude info */
	159	const char *exclude_per_dir;
c082df24	160
63d285c8	161	/*
c082df24 AS	162	* We maintain three groups of exclude pattern lists:
c082df24 AS	163	*
63d285c8 JH	164	* EXC_CMDL lists patterns explicitly given on the command line.
63d285c8 JH	165	* EXC_DIRS lists patterns obtained from per-directory ignore files.
c082df24 AS	166	* EXC_FILE lists patterns from fallback ignore files, e.g.
	167	* - .git/info/exclude
	168	* - core.excludesfile
	169	*
	170	* Each group contains multiple exclude lists, a single list
	171	* per source.
63d285c8 JH	172	*/
	173	#define EXC_CMDL 0
	174	#define EXC_DIRS 1
	175	#define EXC_FILE 2
c082df24	176	struct exclude_list_group exclude_list_group[3];
63d285c8	177
95a68344 AS	178	/*
	179	* Temporary variables which are used during loading of the
	180	* per-directory exclude lists.
	181	*
	182	* exclude_stack points to the top of the exclude_stack, and
	183	* basebuf contains the full path to the current
95c6f271 KB	184	* (sub)directory in the traversal. Exclude points to the
95c6f271 KB	185	* matching exclude struct if the directory is excluded.
95a68344	186	*/
63d285c8	187	struct exclude_stack *exclude_stack;
95c6f271	188	struct exclude *exclude;
aceb9429	189	struct strbuf basebuf;
0dcb8d7f NTND	190
	191	/* Enable untracked file cache if set */
	192	struct untracked_cache *untracked;
	193	struct sha1_stat ss_info_exclude;
	194	struct sha1_stat ss_excludes_file;
ccad261f	195	unsigned unmanaged_exclude_files;
453ec4bd LT	196	};
453ec4bd LT	197
52ed1894 AS	198	/*
	199	* The ordering of these constants is significant, with
	200	* higher-numbered match types signifying "closer" (i.e. more
	201	* specific) matches which will override lower-numbered match types
	202	* when populating the seen[] array.
	203	*/
e813d50e JH	204	#define MATCHED_RECURSIVELY 1
	205	#define MATCHED_FNMATCH 2
	206	#define MATCHED_EXACTLY 3
87323bda NTND	207	extern int simple_length(const char *match);
87323bda NTND	208	extern int no_wildcard(const char *string);
827f4d6c	209	extern char common_prefix(const struct pathspec pathspec);
854b0959 NTND	210	extern int match_pathspec(const struct pathspec *pathspec,
854b0959 NTND	211	const char *name, int namelen,
ae8d0824	212	int prefix, char *seen, int is_dir);
bc96cc87	213	extern int within_depth(const char *name, int namelen, int depth, int max_depth);
3c6a370b	214
7327d3d1 NTND	215	extern int fill_directory(struct dir_struct dir, const struct pathspec pathspec);
7327d3d1 NTND	216	extern int read_directory(struct dir_struct , const char path, int len, const struct pathspec *pathspec);
f8a9d428	217
07958050 AS	218	extern int is_excluded_from_list(const char pathname, int pathlen, const char basename,
07958050 AS	219	int dtype, struct exclude_list el);
108da0db	220	struct dir_entry dir_add_ignored(struct dir_struct dir, const char *pathname, int len);
eb41775e	221
82dce998 NTND	222	/*
	223	* these implement the matching logic for dir.c:excluded_from_list and
	224	* attr.c:path_matches()
	225	*/
	226	extern int match_basename(const char *, int,
	227	const char *, int, int, int);
	228	extern int match_pathname(const char *, int,
	229	const char *, int,
	230	const char *, int, int, int);
	231
b07bc8c8 KB	232	extern struct exclude last_exclude_matching(struct dir_struct dir,
b07bc8c8 KB	233	const char name, int dtype);
782cd4c0	234
b07bc8c8	235	extern int is_excluded(struct dir_struct dir, const char name, int *dtype);
eb41775e	236
c04318e4 AS	237	extern struct exclude_list add_exclude_list(struct dir_struct dir,
c04318e4 AS	238	int group_type, const char *src);
cb097534	239	extern int add_excludes_from_file_to_list(const char fname, const char base, int baselen,
c082df24	240	struct exclude_list *el, int check_index);
453ec4bd	241	extern void add_excludes_from_file(struct dir_struct , const char fname);
82dce998	242	extern void parse_exclude_pattern(const char *string, int patternlen, int flags, int nowildcardlen);
453ec4bd	243	extern void add_exclude(const char string, const char base,
c04318e4	244	int baselen, struct exclude_list *el, int srcpos);
f6198812	245	extern void clear_exclude_list(struct exclude_list *el);
270be816	246	extern void clear_directory(struct dir_struct *dir);
c91f0d92	247	extern int file_exists(const char *);
453ec4bd	248
e6636747	249	extern int is_inside_dir(const char *dir);
9b125da4	250	extern int dir_inside_of(const char subdir, const char dir);
e6636747	251
8ca12c0d AP	252	static inline int is_dot_or_dotdot(const char *name)
	253	{
	254	return (name[0] == '.' &&
	255	(name[1] == '\0' \|\|
	256	(name[1] == '.' && name[2] == '\0')));
	257	}
	258
55892d23 AP	259	extern int is_empty_dir(const char *dir);
55892d23 AP	260
039bc64e	261	extern void setup_standard_excludes(struct dir_struct *dir);
a0f4afbe JH	262
	263	#define REMOVE_DIR_EMPTY_ONLY 01
	264	#define REMOVE_DIR_KEEP_NESTED_GIT 02
c844a803	265	#define REMOVE_DIR_KEEP_TOPLEVEL 04
a0f4afbe	266	extern int remove_dir_recursively(struct strbuf *path, int flag);
7155b727	267
4a92d1bf AR	268	/* tries to remove the path with empty directories along it, ignores ENOENT */
	269	extern int remove_path(const char *path);
	270
8cf2a84e JJ	271	extern int strcmp_icase(const char a, const char b);
	272	extern int strncmp_icase(const char a, const char b, size_t count);
	273	extern int fnmatch_icase(const char pattern, const char string, int flags);
	274
5d74762d NTND	275	/*
	276	* The prefix part of pattern must not contains wildcards.
	277	*/
bd30c2e4 NTND	278	struct pathspec_item;
	279	extern int git_fnmatch(const struct pathspec_item *item,
	280	const char pattern, const char string,
	281	int prefix);
5d74762d	282
429bb40a NTND	283	static inline int ce_path_match(const struct cache_entry *ce,
	284	const struct pathspec *pathspec,
	285	char *seen)
	286	{
ae8d0824 NTND	287	return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
ae8d0824 NTND	288	S_ISDIR(ce->ce_mode) \|\| S_ISGITLINK(ce->ce_mode));
429bb40a NTND	289	}
429bb40a NTND	290
ebb32893 NTND	291	static inline int dir_path_match(const struct dir_entry *ent,
	292	const struct pathspec *pathspec,
	293	int prefix, char *seen)
	294	{
ae8d0824 NTND	295	int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
	296	int len = has_trailing_dir ? ent->len - 1 : ent->len;
	297	return match_pathspec(pathspec, ent->name, len, prefix, seen,
	298	has_trailing_dir);
ebb32893 NTND	299	}
ebb32893 NTND	300
f9e6c649 NTND	301	void free_untracked_cache(struct untracked_cache *);
f9e6c649 NTND	302	struct untracked_cache read_untracked_extension(const void data, unsigned long sz);
83c094ad	303	void write_untracked_extension(struct strbuf out, struct untracked_cache untracked);
453ec4bd	304	#endif