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 #define GUARD_PATHSPEC(ps, mask) \
  31         do { \
  32                 if ((ps)->magic & ~(mask))             \
  33                         die("BUG:%s:%d: unsupported magic %x",  \
  34                             __FILE__, __LINE__, (ps)->magic & ~(mask)); \
  35         } while (0)
  36
  37 /* parse_pathspec flags */
  38 #define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
  39 #define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
  40 #define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
  41 /* strip the trailing slash if the given path is a gitlink */
  42 #define PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP (1<<3)
  43 /* die if a symlink is part of the given path's directory */
  44 #define PATHSPEC_SYMLINK_LEADING_PATH (1<<4)
  45 /*
  46  * This is like a combination of ..LEADING_PATH and .._SLASH_CHEAP
  47  * (but not the same): it strips the trailing slash if the given path
  48  * is a gitlink but also checks and dies if gitlink is part of the
  49  * leading path (i.e. the given path goes beyond a submodule). It's
  50  * safer than _SLASH_CHEAP and also more expensive.
  51  */
  52 #define PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE (1<<5)
  53 #define PATHSPEC_PREFIX_ORIGIN (1<<6)
  54 #define PATHSPEC_KEEP_ORDER (1<<7)
  55
  56 extern int init_pathspec(struct pathspec *, const char **);
  57 extern void parse_pathspec(struct pathspec *pathspec,
  58                            unsigned magic_mask,
  59                            unsigned flags,
  60                            const char *prefix,
  61                            const char **args);
  62 extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
  63 extern void free_pathspec(struct pathspec *);
  64
  65 extern int limit_pathspec_to_literal(void);
  66
  67 extern char *find_pathspecs_matching_against_index(const char **pathspec);
  68 extern void add_pathspec_matches_against_index(const char **pathspec, char *seen, int specs);
  69 extern const char *check_path_for_gitlink(const char *path);
  70 extern void die_if_path_beyond_symlink(const char *path, const char *prefix);
  71
  72 #endif /* PATHSPEC_H */