dir.hon commit Update documentation occurrences of filename .sh (0e5ed7c)
   1#ifndef DIR_H
   2#define DIR_H
   3
   4#include "strbuf.h"
   5
   6struct dir_entry {
   7        unsigned int len;
   8        char name[FLEX_ARRAY]; /* more */
   9};
  10
  11#define EXC_FLAG_NODIR 1
  12#define EXC_FLAG_ENDSWITH 4
  13#define EXC_FLAG_MUSTBEDIR 8
  14#define EXC_FLAG_NEGATIVE 16
  15
  16struct exclude_list {
  17        int nr;
  18        int alloc;
  19        struct exclude {
  20                const char *pattern;
  21                int patternlen;
  22                int nowildcardlen;
  23                const char *base;
  24                int baselen;
  25                int flags;
  26        } **excludes;
  27};
  28
  29struct exclude_stack {
  30        struct exclude_stack *prev;
  31        char *filebuf;
  32        int baselen;
  33        int exclude_ix;
  34};
  35
  36struct dir_struct {
  37        int nr, alloc;
  38        int ignored_nr, ignored_alloc;
  39        enum {
  40                DIR_SHOW_IGNORED = 1<<0,
  41                DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
  42                DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
  43                DIR_NO_GITLINKS = 1<<3,
  44                DIR_COLLECT_IGNORED = 1<<4
  45        } flags;
  46        struct dir_entry **entries;
  47        struct dir_entry **ignored;
  48
  49        /* Exclude info */
  50        const char *exclude_per_dir;
  51        struct exclude_list exclude_list[3];
  52        /*
  53         * We maintain three exclude pattern lists:
  54         * EXC_CMDL lists patterns explicitly given on the command line.
  55         * EXC_DIRS lists patterns obtained from per-directory ignore files.
  56         * EXC_FILE lists patterns from fallback ignore files.
  57         */
  58#define EXC_CMDL 0
  59#define EXC_DIRS 1
  60#define EXC_FILE 2
  61
  62        struct exclude_stack *exclude_stack;
  63        char basebuf[PATH_MAX];
  64};
  65
  66#define MATCHED_RECURSIVELY 1
  67#define MATCHED_FNMATCH 2
  68#define MATCHED_EXACTLY 3
  69extern char *common_prefix(const char **pathspec);
  70extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
  71extern int match_pathspec_depth(const struct pathspec *pathspec,
  72                                const char *name, int namelen,
  73                                int prefix, char *seen);
  74extern int within_depth(const char *name, int namelen, int depth, int max_depth);
  75
  76extern int fill_directory(struct dir_struct *dir, const char **pathspec);
  77extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
  78
  79extern int excluded_from_list(const char *pathname, int pathlen, const char *basename,
  80                              int *dtype, struct exclude_list *el);
  81struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
  82
  83/*
  84 * these implement the matching logic for dir.c:excluded_from_list and
  85 * attr.c:path_matches()
  86 */
  87extern int match_basename(const char *, int,
  88                          const char *, int, int, int);
  89extern int match_pathname(const char *, int,
  90                          const char *, int,
  91                          const char *, int, int, int);
  92
  93/*
  94 * The excluded() API is meant for callers that check each level of leading
  95 * directory hierarchies with excluded() to avoid recursing into excluded
  96 * directories.  Callers that do not do so should use this API instead.
  97 */
  98struct path_exclude_check {
  99        struct dir_struct *dir;
 100        struct strbuf path;
 101};
 102extern void path_exclude_check_init(struct path_exclude_check *, struct dir_struct *);
 103extern void path_exclude_check_clear(struct path_exclude_check *);
 104extern int path_excluded(struct path_exclude_check *, const char *, int namelen, int *dtype);
 105
 106
 107extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
 108                                          char **buf_p, struct exclude_list *which, int check_index);
 109extern void add_excludes_from_file(struct dir_struct *, const char *fname);
 110extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
 111extern void add_exclude(const char *string, const char *base,
 112                        int baselen, struct exclude_list *which);
 113extern void free_excludes(struct exclude_list *el);
 114extern int file_exists(const char *);
 115
 116extern int is_inside_dir(const char *dir);
 117extern int dir_inside_of(const char *subdir, const char *dir);
 118
 119static inline int is_dot_or_dotdot(const char *name)
 120{
 121        return (name[0] == '.' &&
 122                (name[1] == '\0' ||
 123                 (name[1] == '.' && name[2] == '\0')));
 124}
 125
 126extern int is_empty_dir(const char *dir);
 127
 128extern void setup_standard_excludes(struct dir_struct *dir);
 129
 130#define REMOVE_DIR_EMPTY_ONLY 01
 131#define REMOVE_DIR_KEEP_NESTED_GIT 02
 132#define REMOVE_DIR_KEEP_TOPLEVEL 04
 133extern int remove_dir_recursively(struct strbuf *path, int flag);
 134
 135/* tries to remove the path with empty directories along it, ignores ENOENT */
 136extern int remove_path(const char *path);
 137
 138extern int strcmp_icase(const char *a, const char *b);
 139extern int strncmp_icase(const char *a, const char *b, size_t count);
 140extern int fnmatch_icase(const char *pattern, const char *string, int flags);
 141
 142#endif