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