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