Merge branch 'jk/describe-omit-some-refs'
[git.git] / pathspec.h
blob49fd823ddfe9eb96c983f9f812f6ca1dcf062951
1 #ifndef PATHSPEC_H
2 #define PATHSPEC_H
4 /* Pathspec magic */
5 #define PATHSPEC_FROMTOP (1<<0)
6 #define PATHSPEC_MAXDEPTH (1<<1)
7 #define PATHSPEC_LITERAL (1<<2)
8 #define PATHSPEC_GLOB (1<<3)
9 #define PATHSPEC_ICASE (1<<4)
10 #define PATHSPEC_EXCLUDE (1<<5)
11 #define PATHSPEC_ALL_MAGIC \
12 (PATHSPEC_FROMTOP | \
13 PATHSPEC_MAXDEPTH | \
14 PATHSPEC_LITERAL | \
15 PATHSPEC_GLOB | \
16 PATHSPEC_ICASE | \
17 PATHSPEC_EXCLUDE)
19 #define PATHSPEC_ONESTAR 1 /* the pathspec pattern satisfies GFNM_ONESTAR */
21 struct pathspec {
22 int nr;
23 unsigned int has_wildcard:1;
24 unsigned int recursive:1;
25 unsigned magic;
26 int max_depth;
27 struct pathspec_item {
28 char *match;
29 char *original;
30 unsigned magic;
31 int len, prefix;
32 int nowildcard_len;
33 int flags;
34 } *items;
37 #define GUARD_PATHSPEC(ps, mask) \
38 do { \
39 if ((ps)->magic & ~(mask)) \
40 die("BUG:%s:%d: unsupported magic %x", \
41 __FILE__, __LINE__, (ps)->magic & ~(mask)); \
42 } while (0)
44 /* parse_pathspec flags */
45 #define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
46 #define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
47 #define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
48 /* strip the trailing slash if the given path is a gitlink */
49 #define PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP (1<<3)
50 /* die if a symlink is part of the given path's directory */
51 #define PATHSPEC_SYMLINK_LEADING_PATH (1<<4)
53 * This is like a combination of ..LEADING_PATH and .._SLASH_CHEAP
54 * (but not the same): it strips the trailing slash if the given path
55 * is a gitlink but also checks and dies if gitlink is part of the
56 * leading path (i.e. the given path goes beyond a submodule). It's
57 * safer than _SLASH_CHEAP and also more expensive.
59 #define PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE (1<<5)
60 #define PATHSPEC_PREFIX_ORIGIN (1<<6)
61 #define PATHSPEC_KEEP_ORDER (1<<7)
63 * For the callers that just need pure paths from somewhere else, not
64 * from command line. Global --*-pathspecs options are ignored. No
65 * magic is parsed in each pathspec either. If PATHSPEC_LITERAL is
66 * allowed, then it will automatically set for every pathspec.
68 #define PATHSPEC_LITERAL_PATH (1<<8)
70 extern void parse_pathspec(struct pathspec *pathspec,
71 unsigned magic_mask,
72 unsigned flags,
73 const char *prefix,
74 const char **args);
75 extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
76 extern void clear_pathspec(struct pathspec *);
78 static inline int ps_strncmp(const struct pathspec_item *item,
79 const char *s1, const char *s2, size_t n)
81 if (item->magic & PATHSPEC_ICASE)
82 return strncasecmp(s1, s2, n);
83 else
84 return strncmp(s1, s2, n);
87 static inline int ps_strcmp(const struct pathspec_item *item,
88 const char *s1, const char *s2)
90 if (item->magic & PATHSPEC_ICASE)
91 return strcasecmp(s1, s2);
92 else
93 return strcmp(s1, s2);
96 extern char *find_pathspecs_matching_against_index(const struct pathspec *pathspec);
97 extern void add_pathspec_matches_against_index(const struct pathspec *pathspec, char *seen);
99 #endif /* PATHSPEC_H */