parse_pathspec: support stripping/checking submodule paths
[git] / pathspec.h
1 #ifndef PATHSPEC_H
2 #define PATHSPEC_H
3
4 /* Pathspec magic */
5 #define PATHSPEC_FROMTOP        (1<<0)
6 #define PATHSPEC_MAXDEPTH       (1<<1)
7 #define PATHSPEC_ALL_MAGIC        \
8         (PATHSPEC_FROMTOP       | \
9          PATHSPEC_MAXDEPTH)
10
11 #define PATHSPEC_ONESTAR 1      /* the pathspec pattern sastisfies GFNM_ONESTAR */
12
13 struct pathspec {
14         const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
15         int nr;
16         unsigned int has_wildcard:1;
17         unsigned int recursive:1;
18         unsigned magic;
19         int max_depth;
20         struct pathspec_item {
21                 const char *match;
22                 const char *original;
23                 unsigned magic;
24                 int len;
25                 int nowildcard_len;
26                 int flags;
27         } *items;
28 };
29
30 /* parse_pathspec flags */
31 #define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
32 #define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
33 #define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
34 /* strip the trailing slash if the given path is a gitlink */
35 #define PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP (1<<3)
36 /* die if a symlink is part of the given path's directory */
37 #define PATHSPEC_SYMLINK_LEADING_PATH (1<<4)
38 /*
39  * This is like a combination of ..LEADING_PATH and .._SLASH_CHEAP
40  * (but not the same): it strips the trailing slash if the given path
41  * is a gitlink but also checks and dies if gitlink is part of the
42  * leading path (i.e. the given path goes beyond a submodule). It's
43  * safer than _SLASH_CHEAP and also more expensive.
44  */
45 #define PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE (1<<5)
46
47 extern int init_pathspec(struct pathspec *, const char **);
48 extern void parse_pathspec(struct pathspec *pathspec,
49                            unsigned magic_mask,
50                            unsigned flags,
51                            const char *prefix,
52                            const char **args);
53 extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
54 extern void free_pathspec(struct pathspec *);
55
56 extern int limit_pathspec_to_literal(void);
57
58 extern char *find_pathspecs_matching_against_index(const char **pathspec);
59 extern void add_pathspec_matches_against_index(const char **pathspec, char *seen, int specs);
60 extern const char *check_path_for_gitlink(const char *path);
61 extern void die_if_path_beyond_symlink(const char *path, const char *prefix);
62
63 #endif /* PATHSPEC_H */