]> git.ipfire.org Git - thirdparty/git.git/blame - pathspec.h
reftable: read reftable files
[thirdparty/git.git] / pathspec.h
CommitLineData
6f525e71
AS
1#ifndef PATHSPEC_H
2#define PATHSPEC_H
3
ef3ca954
EN
4struct index_state;
5
87323bda
NTND
6/* Pathspec magic */
7#define PATHSPEC_FROMTOP (1<<0)
6330a171 8#define PATHSPEC_MAXDEPTH (1<<1)
5c6933d2 9#define PATHSPEC_LITERAL (1<<2)
bd30c2e4 10#define PATHSPEC_GLOB (1<<3)
93d93537 11#define PATHSPEC_ICASE (1<<4)
ef79b1f8 12#define PATHSPEC_EXCLUDE (1<<5)
b0db7046 13#define PATHSPEC_ATTR (1<<6)
6330a171
NTND
14#define PATHSPEC_ALL_MAGIC \
15 (PATHSPEC_FROMTOP | \
5c6933d2 16 PATHSPEC_MAXDEPTH | \
bd30c2e4 17 PATHSPEC_LITERAL | \
93d93537 18 PATHSPEC_GLOB | \
ef79b1f8 19 PATHSPEC_ICASE | \
b0db7046
BW
20 PATHSPEC_EXCLUDE | \
21 PATHSPEC_ATTR)
87323bda 22
fadf96ab 23#define PATHSPEC_ONESTAR 1 /* the pathspec pattern satisfies GFNM_ONESTAR */
64acde94 24
19ef3ddd
HW
25/**
26 * See glossary-context.txt for the syntax of pathspec.
27 * In memory, a pathspec set is represented by "struct pathspec" and is
28 * prepared by parse_pathspec().
29 */
64acde94 30struct pathspec {
64acde94
NTND
31 int nr;
32 unsigned int has_wildcard:1;
33 unsigned int recursive:1;
eef3df5a 34 unsigned int recurse_submodules:1;
87323bda 35 unsigned magic;
64acde94
NTND
36 int max_depth;
37 struct pathspec_item {
8aee769f
BW
38 char *match;
39 char *original;
87323bda 40 unsigned magic;
645a29c4 41 int len, prefix;
64acde94
NTND
42 int nowildcard_len;
43 int flags;
b0db7046
BW
44 int attr_match_nr;
45 struct attr_match {
46 char *value;
47 enum attr_match_mode {
48 MATCH_SET,
49 MATCH_UNSET,
50 MATCH_VALUE,
51 MATCH_UNSPECIFIED
52 } match_mode;
53 } *attr_match;
54 struct attr_check *attr_check;
64acde94
NTND
55 } *items;
56};
57
8f4f8f45
NTND
58#define GUARD_PATHSPEC(ps, mask) \
59 do { \
60 if ((ps)->magic & ~(mask)) \
61 die("BUG:%s:%d: unsupported magic %x", \
62 __FILE__, __LINE__, (ps)->magic & ~(mask)); \
63 } while (0)
64
fc12261f
NTND
65/* parse_pathspec flags */
66#define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
67#define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
6330a171 68#define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
87450244 69/* die if a symlink is part of the given path's directory */
2249d4db
BW
70#define PATHSPEC_SYMLINK_LEADING_PATH (1<<3)
71#define PATHSPEC_PREFIX_ORIGIN (1<<4)
72#define PATHSPEC_KEEP_ORDER (1<<5)
4a2d5ae2
NTND
73/*
74 * For the callers that just need pure paths from somewhere else, not
75 * from command line. Global --*-pathspecs options are ignored. No
76 * magic is parsed in each pathspec either. If PATHSPEC_LITERAL is
77 * allowed, then it will automatically set for every pathspec.
78 */
2249d4db 79#define PATHSPEC_LITERAL_PATH (1<<6)
fc12261f 80
19ef3ddd 81/**
29c0e902
JN
82 * Given command line arguments and a prefix, convert the input to
83 * pathspec. die() if any magic in magic_mask is used.
84 *
85 * Any arguments used are copied. It is safe for the caller to modify
86 * or free 'prefix' and 'args' after calling this function.
19ef3ddd
HW
87 *
88 * - magic_mask specifies what features that are NOT supported by the following
89 * code. If a user attempts to use such a feature, parse_pathspec() can reject
90 * it early.
91 *
92 * - flags specifies other things that the caller wants parse_pathspec to
93 * perform.
94 *
95 * - prefix and args come from cmd_* functions
96 *
97 * parse_pathspec() helps catch unsupported features and reject them politely.
98 * At a lower level, different pathspec-related functions may not support the
99 * same set of features. Such pathspec-sensitive functions are guarded with
100 * GUARD_PATHSPEC(), which will die in an unfriendly way when an unsupported
101 * feature is requested.
102 *
103 * The command designers are supposed to make sure that GUARD_PATHSPEC() never
104 * dies. They have to make sure all unsupported features are caught by
105 * parse_pathspec(), not by GUARD_PATHSPEC. grepping GUARD_PATHSPEC() should
106 * give the designers all pathspec-sensitive codepaths and what features they
107 * support.
108 *
109 * A similar process is applied when a new pathspec magic is added. The designer
110 * lifts the GUARD_PATHSPEC restriction in the functions that support the new
0e20b229 111 * magic while at the same time making sure this new feature will be
19ef3ddd
HW
112 * caught at parse_pathspec() in commands that cannot handle the new magic in
113 * some cases. grepping parse_pathspec() should help.
29c0e902 114 */
93e23798
NTND
115void parse_pathspec(struct pathspec *pathspec,
116 unsigned magic_mask,
117 unsigned flags,
118 const char *prefix,
119 const char **args);
24e4750c
AM
120/*
121 * Same as parse_pathspec() but uses file as input.
122 * When 'file' is exactly "-" it uses 'stdin' instead.
123 */
124void parse_pathspec_file(struct pathspec *pathspec,
125 unsigned magic_mask,
126 unsigned flags,
127 const char *prefix,
128 const char *file,
129 int nul_term_line);
19ef3ddd 130
93e23798
NTND
131void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
132void clear_pathspec(struct pathspec *);
64acde94 133
93d93537
NTND
134static inline int ps_strncmp(const struct pathspec_item *item,
135 const char *s1, const char *s2, size_t n)
136{
137 if (item->magic & PATHSPEC_ICASE)
138 return strncasecmp(s1, s2, n);
139 else
140 return strncmp(s1, s2, n);
141}
142
143static inline int ps_strcmp(const struct pathspec_item *item,
144 const char *s1, const char *s2)
145{
146 if (item->magic & PATHSPEC_ICASE)
147 return strcasecmp(s1, s2);
148 else
149 return strcmp(s1, s2);
150}
151
719630eb
MT
152enum ps_skip_worktree_action {
153 PS_HEED_SKIP_WORKTREE = 0,
154 PS_IGNORE_SKIP_WORKTREE = 1
155};
93e23798 156void add_pathspec_matches_against_index(const struct pathspec *pathspec,
847a9e5d 157 struct index_state *istate,
719630eb
MT
158 char *seen,
159 enum ps_skip_worktree_action sw_action);
93e23798 160char *find_pathspecs_matching_against_index(const struct pathspec *pathspec,
fe069dce 161 struct index_state *istate,
719630eb 162 enum ps_skip_worktree_action sw_action);
a20f7047
MT
163char *find_pathspecs_matching_skip_worktree(const struct pathspec *pathspec);
164static inline int matches_skip_worktree(const struct pathspec *pathspec,
165 int item, char **seen_ptr)
166{
167 if (!*seen_ptr)
168 *seen_ptr = find_pathspecs_matching_skip_worktree(pathspec);
169 return (*seen_ptr)[item];
170}
847a9e5d 171int match_pathspec_attrs(struct index_state *istate,
22af33be
NTND
172 const char *name, int namelen,
173 const struct pathspec_item *item);
6f525e71
AS
174
175#endif /* PATHSPEC_H */