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_LITERAL        (1<<2)
   8 #define PATHSPEC_ALL_MAGIC        \
   9         (PATHSPEC_FROMTOP       | \
  10          PATHSPEC_MAXDEPTH      | \
  11          PATHSPEC_LITERAL)
  12
  13 #define PATHSPEC_ONESTAR 1      /* the pathspec pattern sastisfies GFNM_ONESTAR */
  14
  15 struct pathspec {
  16         const char **_raw; /* get_pathspec() result, not freed by free_pathspec() */
  17         int nr;
  18         unsigned int has_wildcard:1;
  19         unsigned int recursive:1;
  20         unsigned magic;
  21         int max_depth;
  22         struct pathspec_item {
  23                 const char *match;
  24                 const char *original;
  25                 unsigned magic;
  26                 int len, prefix;
  27                 int nowildcard_len;
  28                 int flags;
  29         } *items;
  30 };
  31
  32 #define GUARD_PATHSPEC(ps, mask) \
  33         do { \
  34                 if ((ps)->magic & ~(mask))             \
  35                         die("BUG:%s:%d: unsupported magic %x",  \
  36                             __FILE__, __LINE__, (ps)->magic & ~(mask)); \
  37         } while (0)
  38
  39 /* parse_pathspec flags */
  40 #define PATHSPEC_PREFER_CWD (1<<0) /* No args means match cwd */
  41 #define PATHSPEC_PREFER_FULL (1<<1) /* No args means match everything */
  42 #define PATHSPEC_MAXDEPTH_VALID (1<<2) /* max_depth field is valid */
  43 /* strip the trailing slash if the given path is a gitlink */
  44 #define PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP (1<<3)
  45 /* die if a symlink is part of the given path's directory */
  46 #define PATHSPEC_SYMLINK_LEADING_PATH (1<<4)
  47 /*
  48  * This is like a combination of ..LEADING_PATH and .._SLASH_CHEAP
  49  * (but not the same): it strips the trailing slash if the given path
  50  * is a gitlink but also checks and dies if gitlink is part of the
  51  * leading path (i.e. the given path goes beyond a submodule). It's
  52  * safer than _SLASH_CHEAP and also more expensive.
  53  */
  54 #define PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE (1<<5)
  55 #define PATHSPEC_PREFIX_ORIGIN (1<<6)
  56 #define PATHSPEC_KEEP_ORDER (1<<7)
  57
  58 extern void parse_pathspec(struct pathspec *pathspec,
  59                            unsigned magic_mask,
  60                            unsigned flags,
  61                            const char *prefix,
  62                            const char **args);
  63 extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
  64 extern void free_pathspec(struct pathspec *);
  65
  66 extern char *find_pathspecs_matching_against_index(const struct pathspec *pathspec);
  67 extern void add_pathspec_matches_against_index(const struct pathspec *pathspec, char *seen);
  68 extern const char *check_path_for_gitlink(const char *path);
  69 extern void die_if_path_beyond_symlink(const char *path, const char *prefix);
  70
  71 #endif /* PATHSPEC_H */