[thirdparty/git.git] / pathspec.h

#ifndef PATHSPEC_H
#define PATHSPEC_H

/* Pathspec magic */
#define PATHSPEC_FROMTOP	(1<<0)
#define PATHSPEC_MAXDEPTH	(1<<1)
#define PATHSPEC_ALL_MAGIC	  \
	(PATHSPEC_FROMTOP	| \
	 PATHSPEC_MAXDEPTH)

#define PATHSPEC_ONESTAR 1	/* the pathspec pattern sastisfies GFNM_ONESTAR */

struct pathspec {
	const char **_raw; /* get_pathspec() result, not freed by free_pathspec() */
	int nr;
	unsigned int has_wildcard:1;
	unsigned int recursive:1;
	unsigned magic;
	int max_depth;
	struct pathspec_item {
		const char *match;
		const char *original;
		unsigned magic;
		int len;
		int nowildcard_len;
		int flags;
	} *items;
};

#define GUARD_PATHSPEC(ps, mask) \
	do { \
		if ((ps)->magic & ~(mask))	       \
			die("BUG:%s:%d: unsupported magic %x",	\
			    __FILE__, __LINE__, (ps)->magic & ~(mask)); \
	} while (0)

/* parse_pathspec flags */
#define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
#define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
#define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
/* strip the trailing slash if the given path is a gitlink */
#define PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP (1<<3)
/* die if a symlink is part of the given path's directory */
#define PATHSPEC_SYMLINK_LEADING_PATH (1<<4)
/*
 * This is like a combination of ..LEADING_PATH and .._SLASH_CHEAP
 * (but not the same): it strips the trailing slash if the given path
 * is a gitlink but also checks and dies if gitlink is part of the
 * leading path (i.e. the given path goes beyond a submodule). It's
 * safer than _SLASH_CHEAP and also more expensive.
 */
#define PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE (1<<5)
#define PATHSPEC_PREFIX_ORIGIN (1<<6)
#define PATHSPEC_KEEP_ORDER (1<<7)

extern void parse_pathspec(struct pathspec *pathspec,
			   unsigned magic_mask,
			   unsigned flags,
			   const char *prefix,
			   const char **args);
extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
extern void free_pathspec(struct pathspec *);

extern int limit_pathspec_to_literal(void);

extern char *find_pathspecs_matching_against_index(const struct pathspec *pathspec);
extern void add_pathspec_matches_against_index(const struct pathspec *pathspec, char *seen);
extern const char *check_path_for_gitlink(const char *path);
extern void die_if_path_beyond_symlink(const char *path, const char *prefix);

#endif /* PATHSPEC_H */
Commit	Line	Data
6f525e71 AS	1	#ifndef PATHSPEC_H
	2	#define PATHSPEC_H
	3
87323bda NTND	4	/* Pathspec magic */
87323bda NTND	5	#define PATHSPEC_FROMTOP (1<<0)
6330a171 NTND	6	#define PATHSPEC_MAXDEPTH (1<<1)
	7	#define PATHSPEC_ALL_MAGIC \
	8	(PATHSPEC_FROMTOP \| \
	9	PATHSPEC_MAXDEPTH)
87323bda	10
64acde94 NTND	11	#define PATHSPEC_ONESTAR 1 /* the pathspec pattern sastisfies GFNM_ONESTAR */
	12
	13	struct pathspec {
b3920bbd	14	const char *_raw; / get_pathspec() result, not freed by free_pathspec() */
64acde94 NTND	15	int nr;
	16	unsigned int has_wildcard:1;
	17	unsigned int recursive:1;
87323bda	18	unsigned magic;
64acde94 NTND	19	int max_depth;
	20	struct pathspec_item {
	21	const char *match;
d2ce1331	22	const char *original;
87323bda	23	unsigned magic;
64acde94 NTND	24	int len;
	25	int nowildcard_len;
	26	int flags;
	27	} *items;
	28	};
	29
8f4f8f45 NTND	30	#define GUARD_PATHSPEC(ps, mask) \
	31	do { \
	32	if ((ps)->magic & ~(mask)) \
	33	die("BUG:%s:%d: unsupported magic %x", \
	34	__FILE__, __LINE__, (ps)->magic & ~(mask)); \
	35	} while (0)
	36
fc12261f NTND	37	/* parse_pathspec flags */
	38	#define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
	39	#define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
6330a171	40	#define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
b69bb3fc NTND	41	/* strip the trailing slash if the given path is a gitlink */
b69bb3fc NTND	42	#define PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP (1<<3)
87450244 NTND	43	/* die if a symlink is part of the given path's directory */
	44	#define PATHSPEC_SYMLINK_LEADING_PATH (1<<4)
	45	/*
	46	* This is like a combination of ..LEADING_PATH and .._SLASH_CHEAP
	47	* (but not the same): it strips the trailing slash if the given path
	48	* is a gitlink but also checks and dies if gitlink is part of the
	49	* leading path (i.e. the given path goes beyond a submodule). It's
	50	* safer than _SLASH_CHEAP and also more expensive.
	51	*/
	52	#define PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE (1<<5)
dad2586a	53	#define PATHSPEC_PREFIX_ORIGIN (1<<6)
931eab64	54	#define PATHSPEC_KEEP_ORDER (1<<7)
fc12261f	55
87323bda NTND	56	extern void parse_pathspec(struct pathspec *pathspec,
	57	unsigned magic_mask,
	58	unsigned flags,
	59	const char *prefix,
	60	const char **args);
e4d92cdc	61	extern void copy_pathspec(struct pathspec dst, const struct pathspec src);
64acde94 NTND	62	extern void free_pathspec(struct pathspec *);
	63
	64	extern int limit_pathspec_to_literal(void);
	65
84b8b5d1 NTND	66	extern char find_pathspecs_matching_against_index(const struct pathspec pathspec);
84b8b5d1 NTND	67	extern void add_pathspec_matches_against_index(const struct pathspec pathspec, char seen);
9d67b61f	68	extern const char check_path_for_gitlink(const char path);
512aaf94	69	extern void die_if_path_beyond_symlink(const char path, const char prefix);
6f525e71 AS	70
6f525e71 AS	71	#endif /* PATHSPEC_H */