[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_LITERAL	(1<<2)
#define PATHSPEC_GLOB		(1<<3)
#define PATHSPEC_ICASE		(1<<4)
#define PATHSPEC_ALL_MAGIC	  \
	(PATHSPEC_FROMTOP	| \
	 PATHSPEC_MAXDEPTH	| \
	 PATHSPEC_LITERAL	| \
	 PATHSPEC_GLOB		| \
	 PATHSPEC_ICASE)

#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, prefix;
		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 *);

static inline int ps_strncmp(const struct pathspec_item *item,
			     const char *s1, const char *s2, size_t n)
{
	if (item->magic & PATHSPEC_ICASE)
		return strncasecmp(s1, s2, n);
	else
		return strncmp(s1, s2, n);
}

static inline int ps_strcmp(const struct pathspec_item *item,
			    const char *s1, const char *s2)
{
	if (item->magic & PATHSPEC_ICASE)
		return strcasecmp(s1, s2);
	else
		return strcmp(s1, s2);
}

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