blob: 1c18a2c90c4148471f52e27c39685e80a9a414e1 [file] [log] [blame]
Adam Spiers6f525e72013-01-06 16:58:08 +00001#ifndef PATHSPEC_H
2#define PATHSPEC_H
3
Elijah Newrenef3ca952018-08-15 10:54:05 -07004struct index_state;
5
Nguyễn Thái Ngọc Duy87323bd2013-07-14 15:35:28 +07006/* Pathspec magic */
7#define PATHSPEC_FROMTOP (1<<0)
Nguyễn Thái Ngọc Duy6330a172013-07-14 15:35:32 +07008#define PATHSPEC_MAXDEPTH (1<<1)
Nguyễn Thái Ngọc Duy5c6933d2013-07-14 15:36:06 +07009#define PATHSPEC_LITERAL (1<<2)
Nguyễn Thái Ngọc Duybd30c2e2013-07-14 15:36:08 +070010#define PATHSPEC_GLOB (1<<3)
Nguyễn Thái Ngọc Duy93d93532013-07-14 15:36:09 +070011#define PATHSPEC_ICASE (1<<4)
Nguyễn Thái Ngọc Duyef79b1f2013-12-06 14:30:48 +070012#define PATHSPEC_EXCLUDE (1<<5)
Brandon Williamsb0db7042017-03-13 11:23:21 -070013#define PATHSPEC_ATTR (1<<6)
Nguyễn Thái Ngọc Duy6330a172013-07-14 15:35:32 +070014#define PATHSPEC_ALL_MAGIC \
15 (PATHSPEC_FROMTOP | \
Nguyễn Thái Ngọc Duy5c6933d2013-07-14 15:36:06 +070016 PATHSPEC_MAXDEPTH | \
Nguyễn Thái Ngọc Duybd30c2e2013-07-14 15:36:08 +070017 PATHSPEC_LITERAL | \
Nguyễn Thái Ngọc Duy93d93532013-07-14 15:36:09 +070018 PATHSPEC_GLOB | \
Nguyễn Thái Ngọc Duyef79b1f2013-12-06 14:30:48 +070019 PATHSPEC_ICASE | \
Brandon Williamsb0db7042017-03-13 11:23:21 -070020 PATHSPEC_EXCLUDE | \
21 PATHSPEC_ATTR)
Nguyễn Thái Ngọc Duy87323bd2013-07-14 15:35:28 +070022
Junio C Hamanofadf96a2013-09-09 14:50:42 -070023#define PATHSPEC_ONESTAR 1 /* the pathspec pattern satisfies GFNM_ONESTAR */
Nguyễn Thái Ngọc Duy64acde92013-07-14 15:35:25 +070024
25struct pathspec {
Nguyễn Thái Ngọc Duy64acde92013-07-14 15:35:25 +070026 int nr;
27 unsigned int has_wildcard:1;
28 unsigned int recursive:1;
Brandon Williamseef3df52017-12-04 16:07:34 -080029 unsigned int recurse_submodules:1;
Nguyễn Thái Ngọc Duy87323bd2013-07-14 15:35:28 +070030 unsigned magic;
Nguyễn Thái Ngọc Duy64acde92013-07-14 15:35:25 +070031 int max_depth;
32 struct pathspec_item {
Brandon Williams8aee7692017-01-04 10:04:01 -080033 char *match;
34 char *original;
Nguyễn Thái Ngọc Duy87323bd2013-07-14 15:35:28 +070035 unsigned magic;
Nguyễn Thái Ngọc Duy645a29c2013-07-14 15:36:03 +070036 int len, prefix;
Nguyễn Thái Ngọc Duy64acde92013-07-14 15:35:25 +070037 int nowildcard_len;
38 int flags;
Brandon Williamsb0db7042017-03-13 11:23:21 -070039 int attr_match_nr;
40 struct attr_match {
41 char *value;
42 enum attr_match_mode {
43 MATCH_SET,
44 MATCH_UNSET,
45 MATCH_VALUE,
46 MATCH_UNSPECIFIED
47 } match_mode;
48 } *attr_match;
49 struct attr_check *attr_check;
Nguyễn Thái Ngọc Duy64acde92013-07-14 15:35:25 +070050 } *items;
51};
52
Nguyễn Thái Ngọc Duy8f4f8f42013-07-14 15:35:36 +070053#define GUARD_PATHSPEC(ps, mask) \
54 do { \
55 if ((ps)->magic & ~(mask)) \
56 die("BUG:%s:%d: unsupported magic %x", \
57 __FILE__, __LINE__, (ps)->magic & ~(mask)); \
58 } while (0)
59
Nguyễn Thái Ngọc Duyfc122612013-07-14 15:35:30 +070060/* parse_pathspec flags */
61#define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
62#define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
Nguyễn Thái Ngọc Duy6330a172013-07-14 15:35:32 +070063#define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
Nguyễn Thái Ngọc Duy87450242013-07-14 15:35:34 +070064/* die if a symlink is part of the given path's directory */
Brandon Williams2249d4d2017-05-11 15:04:26 -070065#define PATHSPEC_SYMLINK_LEADING_PATH (1<<3)
66#define PATHSPEC_PREFIX_ORIGIN (1<<4)
67#define PATHSPEC_KEEP_ORDER (1<<5)
Nguyễn Thái Ngọc Duy4a2d5ae2013-10-26 09:09:20 +070068/*
69 * For the callers that just need pure paths from somewhere else, not
70 * from command line. Global --*-pathspecs options are ignored. No
71 * magic is parsed in each pathspec either. If PATHSPEC_LITERAL is
72 * allowed, then it will automatically set for every pathspec.
73 */
Brandon Williams2249d4d2017-05-11 15:04:26 -070074#define PATHSPEC_LITERAL_PATH (1<<6)
Nguyễn Thái Ngọc Duyfc122612013-07-14 15:35:30 +070075
Jonathan Nieder29c0e902017-09-20 21:41:12 -070076/*
77 * Given command line arguments and a prefix, convert the input to
78 * pathspec. die() if any magic in magic_mask is used.
79 *
80 * Any arguments used are copied. It is safe for the caller to modify
81 * or free 'prefix' and 'args' after calling this function.
82 */
Nguyễn Thái Ngọc Duy93e23792018-11-18 17:47:58 +010083void parse_pathspec(struct pathspec *pathspec,
84 unsigned magic_mask,
85 unsigned flags,
86 const char *prefix,
87 const char **args);
88void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
89void clear_pathspec(struct pathspec *);
Nguyễn Thái Ngọc Duy64acde92013-07-14 15:35:25 +070090
Nguyễn Thái Ngọc Duy93d93532013-07-14 15:36:09 +070091static inline int ps_strncmp(const struct pathspec_item *item,
92 const char *s1, const char *s2, size_t n)
93{
94 if (item->magic & PATHSPEC_ICASE)
95 return strncasecmp(s1, s2, n);
96 else
97 return strncmp(s1, s2, n);
98}
99
100static inline int ps_strcmp(const struct pathspec_item *item,
101 const char *s1, const char *s2)
102{
103 if (item->magic & PATHSPEC_ICASE)
104 return strcasecmp(s1, s2);
105 else
106 return strcmp(s1, s2);
107}
108
Nguyễn Thái Ngọc Duy93e23792018-11-18 17:47:58 +0100109void add_pathspec_matches_against_index(const struct pathspec *pathspec,
110 const struct index_state *istate,
111 char *seen);
112char *find_pathspecs_matching_against_index(const struct pathspec *pathspec,
113 const struct index_state *istate);
Nguyễn Thái Ngọc Duy22af33b2018-11-18 17:47:59 +0100114int match_pathspec_attrs(const struct index_state *istate,
115 const char *name, int namelen,
116 const struct pathspec_item *item);
Adam Spiers6f525e72013-01-06 16:58:08 +0000117
118#endif /* PATHSPEC_H */