[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_EXCLUDE	(1<<5)
#define PATHSPEC_ATTR		(1<<6)
#define PATHSPEC_ALL_MAGIC	  \
	(PATHSPEC_FROMTOP	| \
	 PATHSPEC_MAXDEPTH	| \
	 PATHSPEC_LITERAL	| \
	 PATHSPEC_GLOB		| \
	 PATHSPEC_ICASE		| \
	 PATHSPEC_EXCLUDE	| \
	 PATHSPEC_ATTR)

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

struct pathspec {
	int nr;
	unsigned int has_wildcard:1;
	unsigned int recursive:1;
	unsigned int recurse_submodules:1;
	unsigned magic;
	int max_depth;
	struct pathspec_item {
		char *match;
		char *original;
		unsigned magic;
		int len, prefix;
		int nowildcard_len;
		int flags;
		int attr_match_nr;
		struct attr_match {
			char *value;
			enum attr_match_mode {
				MATCH_SET,
				MATCH_UNSET,
				MATCH_VALUE,
				MATCH_UNSPECIFIED
			} match_mode;
		} *attr_match;
		struct attr_check *attr_check;
	} *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 */
/* die if a symlink is part of the given path's directory */
#define PATHSPEC_SYMLINK_LEADING_PATH (1<<3)
#define PATHSPEC_PREFIX_ORIGIN (1<<4)
#define PATHSPEC_KEEP_ORDER (1<<5)
/*
 * For the callers that just need pure paths from somewhere else, not
 * from command line. Global --*-pathspecs options are ignored. No
 * magic is parsed in each pathspec either. If PATHSPEC_LITERAL is
 * allowed, then it will automatically set for every pathspec.
 */
#define PATHSPEC_LITERAL_PATH (1<<6)

/*
 * Given command line arguments and a prefix, convert the input to
 * pathspec. die() if any magic in magic_mask is used.
 *
 * Any arguments used are copied. It is safe for the caller to modify
 * or free 'prefix' and 'args' after calling this function.
 */
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 clear_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 void add_pathspec_matches_against_index(const struct pathspec *pathspec,
					       const struct index_state *istate,
					       char *seen);
extern char *find_pathspecs_matching_against_index(const struct pathspec *pathspec,
						   const struct index_state *istate);

#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)
ef79b1f8	10	#define PATHSPEC_EXCLUDE (1<<5)
b0db7046	11	#define PATHSPEC_ATTR (1<<6)
6330a171 NTND	12	#define PATHSPEC_ALL_MAGIC \
6330a171 NTND	13	(PATHSPEC_FROMTOP \| \
5c6933d2	14	PATHSPEC_MAXDEPTH \| \
bd30c2e4	15	PATHSPEC_LITERAL \| \
93d93537	16	PATHSPEC_GLOB \| \
ef79b1f8	17	PATHSPEC_ICASE \| \
b0db7046 BW	18	PATHSPEC_EXCLUDE \| \
b0db7046 BW	19	PATHSPEC_ATTR)
87323bda	20
fadf96ab	21	#define PATHSPEC_ONESTAR 1 /* the pathspec pattern satisfies GFNM_ONESTAR */
64acde94 NTND	22
64acde94 NTND	23	struct pathspec {
64acde94 NTND	24	int nr;
	25	unsigned int has_wildcard:1;
	26	unsigned int recursive:1;
eef3df5a	27	unsigned int recurse_submodules:1;
87323bda	28	unsigned magic;
64acde94 NTND	29	int max_depth;
64acde94 NTND	30	struct pathspec_item {
8aee769f BW	31	char *match;
8aee769f BW	32	char *original;
87323bda	33	unsigned magic;
645a29c4	34	int len, prefix;
64acde94 NTND	35	int nowildcard_len;
64acde94 NTND	36	int flags;
b0db7046 BW	37	int attr_match_nr;
	38	struct attr_match {
	39	char *value;
	40	enum attr_match_mode {
	41	MATCH_SET,
	42	MATCH_UNSET,
	43	MATCH_VALUE,
	44	MATCH_UNSPECIFIED
	45	} match_mode;
	46	} *attr_match;
	47	struct attr_check *attr_check;
64acde94 NTND	48	} *items;
	49	};
	50
8f4f8f45 NTND	51	#define GUARD_PATHSPEC(ps, mask) \
	52	do { \
	53	if ((ps)->magic & ~(mask)) \
	54	die("BUG:%s:%d: unsupported magic %x", \
	55	__FILE__, __LINE__, (ps)->magic & ~(mask)); \
	56	} while (0)
	57
fc12261f NTND	58	/* parse_pathspec flags */
	59	#define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
	60	#define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
6330a171	61	#define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
87450244	62	/* die if a symlink is part of the given path's directory */
2249d4db BW	63	#define PATHSPEC_SYMLINK_LEADING_PATH (1<<3)
	64	#define PATHSPEC_PREFIX_ORIGIN (1<<4)
	65	#define PATHSPEC_KEEP_ORDER (1<<5)
4a2d5ae2 NTND	66	/*
	67	* For the callers that just need pure paths from somewhere else, not
	68	* from command line. Global --*-pathspecs options are ignored. No
	69	* magic is parsed in each pathspec either. If PATHSPEC_LITERAL is
	70	* allowed, then it will automatically set for every pathspec.
	71	*/
2249d4db	72	#define PATHSPEC_LITERAL_PATH (1<<6)
fc12261f	73
29c0e902 JN	74	/*
	75	* Given command line arguments and a prefix, convert the input to
	76	* pathspec. die() if any magic in magic_mask is used.
	77	*
	78	* Any arguments used are copied. It is safe for the caller to modify
	79	* or free 'prefix' and 'args' after calling this function.
	80	*/
87323bda NTND	81	extern void parse_pathspec(struct pathspec *pathspec,
	82	unsigned magic_mask,
	83	unsigned flags,
	84	const char *prefix,
	85	const char **args);
e4d92cdc	86	extern void copy_pathspec(struct pathspec dst, const struct pathspec src);
ed6e8038	87	extern void clear_pathspec(struct pathspec *);
64acde94	88
93d93537 NTND	89	static inline int ps_strncmp(const struct pathspec_item *item,
	90	const char s1, const char s2, size_t n)
	91	{
	92	if (item->magic & PATHSPEC_ICASE)
	93	return strncasecmp(s1, s2, n);
	94	else
	95	return strncmp(s1, s2, n);
	96	}
	97
	98	static inline int ps_strcmp(const struct pathspec_item *item,
	99	const char s1, const char s2)
	100	{
	101	if (item->magic & PATHSPEC_ICASE)
	102	return strcasecmp(s1, s2);
	103	else
	104	return strcmp(s1, s2);
	105	}
	106
08de9151 BW	107	extern void add_pathspec_matches_against_index(const struct pathspec *pathspec,
	108	const struct index_state *istate,
	109	char *seen);
	110	extern char find_pathspecs_matching_against_index(const struct pathspec pathspec,
	111	const struct index_state *istate);
6f525e71 AS	112
6f525e71 AS	113	#endif /* PATHSPEC_H */