Andrew's git - gitweb.git/blob

   1#ifndef DIR_H
   2#define DIR_H
   3
   4/* See Documentation/technical/api-directory-listing.txt */
   5
   6#include "strbuf.h"
   7
   8struct dir_entry {
   9        unsigned int len;
  10        char name[FLEX_ARRAY]; /* more */
  11};
  12
  13#define EXC_FLAG_NODIR 1
  14#define EXC_FLAG_ENDSWITH 4
  15#define EXC_FLAG_MUSTBEDIR 8
  16#define EXC_FLAG_NEGATIVE 16
  17
  18struct exclude {
  19        /*
  20         * This allows callers of last_exclude_matching() etc.
  21         * to determine the origin of the matching pattern.
  22         */
  23        struct exclude_list *el;
  24
  25        const char *pattern;
  26        int patternlen;
  27        int nowildcardlen;
  28        const char *base;
  29        int baselen;
  30        unsigned flags;         /* EXC_FLAG_* */
  31
  32        /*
  33         * Counting starts from 1 for line numbers in ignore files,
  34         * and from -1 decrementing for patterns from CLI args.
  35         */
  36        int srcpos;
  37};
  38
  39/*
  40 * Each excludes file will be parsed into a fresh exclude_list which
  41 * is appended to the relevant exclude_list_group (either EXC_DIRS or
  42 * EXC_FILE).  An exclude_list within the EXC_CMDL exclude_list_group
  43 * can also be used to represent the list of --exclude values passed
  44 * via CLI args.
  45 */
  46struct exclude_list {
  47        int nr;
  48        int alloc;
  49
  50        /* remember pointer to exclude file contents so we can free() */
  51        char *filebuf;
  52
  53        /* origin of list, e.g. path to filename, or descriptive string */
  54        const char *src;
  55
  56        struct exclude **excludes;
  57};
  58
  59/*
  60 * The contents of the per-directory exclude files are lazily read on
  61 * demand and then cached in memory, one per exclude_stack struct, in
  62 * order to avoid opening and parsing each one every time that
  63 * directory is traversed.
  64 */
  65struct exclude_stack {
  66        struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
  67        int baselen;
  68        int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
  69        struct untracked_cache_dir *ucd;
  70};
  71
  72struct exclude_list_group {
  73        int nr, alloc;
  74        struct exclude_list *el;
  75};
  76
  77struct sha1_stat {
  78        struct stat_data stat;
  79        unsigned char sha1[20];
  80        int valid;
  81};
  82
  83/*
  84 *  Untracked cache
  85 *
  86 *  The following inputs are sufficient to determine what files in a
  87 *  directory are excluded:
  88 *
  89 *   - The list of files and directories of the directory in question
  90 *   - The $GIT_DIR/index
  91 *   - dir_struct flags
  92 *   - The content of $GIT_DIR/info/exclude
  93 *   - The content of core.excludesfile
  94 *   - The content (or the lack) of .gitignore of all parent directories
  95 *     from $GIT_WORK_TREE
  96 *   - The check_only flag in read_directory_recursive (for
  97 *     DIR_HIDE_EMPTY_DIRECTORIES)
  98 *
  99 *  The first input can be checked using directory mtime. In many
 100 *  filesystems, directory mtime (stat_data field) is updated when its
 101 *  files or direct subdirs are added or removed.
 102 *
 103 *  The second one can be hooked from cache_tree_invalidate_path().
 104 *  Whenever a file (or a submodule) is added or removed from a
 105 *  directory, we invalidate that directory.
 106 *
 107 *  The remaining inputs are easy, their SHA-1 could be used to verify
 108 *  their contents (exclude_sha1[], info_exclude_sha1[] and
 109 *  excludes_file_sha1[])
 110 */
 111struct untracked_cache_dir {
 112        struct untracked_cache_dir **dirs;
 113        char **untracked;
 114        struct stat_data stat_data;
 115        unsigned int untracked_alloc, dirs_nr, dirs_alloc;
 116        unsigned int untracked_nr;
 117        unsigned int check_only : 1;
 118        /* all data except 'dirs' in this struct are good */
 119        unsigned int valid : 1;
 120        unsigned int recurse : 1;
 121        /* null SHA-1 means this directory does not have .gitignore */
 122        unsigned char exclude_sha1[20];
 123        char name[FLEX_ARRAY];
 124};
 125
 126struct untracked_cache {
 127        struct sha1_stat ss_info_exclude;
 128        struct sha1_stat ss_excludes_file;
 129        const char *exclude_per_dir;
 130        struct strbuf ident;
 131        /*
 132         * dir_struct#flags must match dir_flags or the untracked
 133         * cache is ignored.
 134         */
 135        unsigned dir_flags;
 136        struct untracked_cache_dir *root;
 137        /* Statistics */
 138        int dir_created;
 139        int gitignore_invalidated;
 140        int dir_invalidated;
 141        int dir_opened;
 142        /* fsmonitor invalidation data */
 143        unsigned int use_fsmonitor : 1;
 144};
 145
 146struct dir_struct {
 147        int nr, alloc;
 148        int ignored_nr, ignored_alloc;
 149        enum {
 150                DIR_SHOW_IGNORED = 1<<0,
 151                DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
 152                DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
 153                DIR_NO_GITLINKS = 1<<3,
 154                DIR_COLLECT_IGNORED = 1<<4,
 155                DIR_SHOW_IGNORED_TOO = 1<<5,
 156                DIR_COLLECT_KILLED_ONLY = 1<<6,
 157                DIR_KEEP_UNTRACKED_CONTENTS = 1<<7
 158        } flags;
 159        struct dir_entry **entries;
 160        struct dir_entry **ignored;
 161
 162        /* Exclude info */
 163        const char *exclude_per_dir;
 164
 165        /*
 166         * We maintain three groups of exclude pattern lists:
 167         *
 168         * EXC_CMDL lists patterns explicitly given on the command line.
 169         * EXC_DIRS lists patterns obtained from per-directory ignore files.
 170         * EXC_FILE lists patterns from fallback ignore files, e.g.
 171         *   - .git/info/exclude
 172         *   - core.excludesfile
 173         *
 174         * Each group contains multiple exclude lists, a single list
 175         * per source.
 176         */
 177#define EXC_CMDL 0
 178#define EXC_DIRS 1
 179#define EXC_FILE 2
 180        struct exclude_list_group exclude_list_group[3];
 181
 182        /*
 183         * Temporary variables which are used during loading of the
 184         * per-directory exclude lists.
 185         *
 186         * exclude_stack points to the top of the exclude_stack, and
 187         * basebuf contains the full path to the current
 188         * (sub)directory in the traversal. Exclude points to the
 189         * matching exclude struct if the directory is excluded.
 190         */
 191        struct exclude_stack *exclude_stack;
 192        struct exclude *exclude;
 193        struct strbuf basebuf;
 194
 195        /* Enable untracked file cache if set */
 196        struct untracked_cache *untracked;
 197        struct sha1_stat ss_info_exclude;
 198        struct sha1_stat ss_excludes_file;
 199        unsigned unmanaged_exclude_files;
 200};
 201
 202/*Count the number of slashes for string s*/
 203extern int count_slashes(const char *s);
 204
 205/*
 206 * The ordering of these constants is significant, with
 207 * higher-numbered match types signifying "closer" (i.e. more
 208 * specific) matches which will override lower-numbered match types
 209 * when populating the seen[] array.
 210 */
 211#define MATCHED_RECURSIVELY 1
 212#define MATCHED_FNMATCH 2
 213#define MATCHED_EXACTLY 3
 214extern int simple_length(const char *match);
 215extern int no_wildcard(const char *string);
 216extern char *common_prefix(const struct pathspec *pathspec);
 217extern int match_pathspec(const struct pathspec *pathspec,
 218                          const char *name, int namelen,
 219                          int prefix, char *seen, int is_dir);
 220extern int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
 221extern int within_depth(const char *name, int namelen, int depth, int max_depth);
 222
 223extern int fill_directory(struct dir_struct *dir,
 224                          struct index_state *istate,
 225                          const struct pathspec *pathspec);
 226extern int read_directory(struct dir_struct *, struct index_state *istate,
 227                          const char *path, int len,
 228                          const struct pathspec *pathspec);
 229
 230extern int is_excluded_from_list(const char *pathname, int pathlen,
 231                                 const char *basename, int *dtype,
 232                                 struct exclude_list *el,
 233                                 struct index_state *istate);
 234struct dir_entry *dir_add_ignored(struct dir_struct *dir,
 235                                  struct index_state *istate,
 236                                  const char *pathname, int len);
 237
 238/*
 239 * these implement the matching logic for dir.c:excluded_from_list and
 240 * attr.c:path_matches()
 241 */
 242extern int match_basename(const char *, int,
 243                          const char *, int, int, unsigned);
 244extern int match_pathname(const char *, int,
 245                          const char *, int,
 246                          const char *, int, int, unsigned);
 247
 248extern struct exclude *last_exclude_matching(struct dir_struct *dir,
 249                                             struct index_state *istate,
 250                                             const char *name, int *dtype);
 251
 252extern int is_excluded(struct dir_struct *dir,
 253                       struct index_state *istate,
 254                       const char *name, int *dtype);
 255
 256extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
 257                                             int group_type, const char *src);
 258extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
 259                                          struct exclude_list *el, struct  index_state *istate);
 260extern void add_excludes_from_file(struct dir_struct *, const char *fname);
 261extern void parse_exclude_pattern(const char **string, int *patternlen, unsigned *flags, int *nowildcardlen);
 262extern void add_exclude(const char *string, const char *base,
 263                        int baselen, struct exclude_list *el, int srcpos);
 264extern void clear_exclude_list(struct exclude_list *el);
 265extern void clear_directory(struct dir_struct *dir);
 266extern int file_exists(const char *);
 267
 268extern int is_inside_dir(const char *dir);
 269extern int dir_inside_of(const char *subdir, const char *dir);
 270
 271static inline int is_dot_or_dotdot(const char *name)
 272{
 273        return (name[0] == '.' &&
 274                (name[1] == '\0' ||
 275                 (name[1] == '.' && name[2] == '\0')));
 276}
 277
 278extern int is_empty_dir(const char *dir);
 279
 280extern void setup_standard_excludes(struct dir_struct *dir);
 281
 282
 283/* Constants for remove_dir_recursively: */
 284
 285/*
 286 * If a non-directory is found within path, stop and return an error.
 287 * (In this case some empty directories might already have been
 288 * removed.)
 289 */
 290#define REMOVE_DIR_EMPTY_ONLY 01
 291
 292/*
 293 * If any Git work trees are found within path, skip them without
 294 * considering it an error.
 295 */
 296#define REMOVE_DIR_KEEP_NESTED_GIT 02
 297
 298/* Remove the contents of path, but leave path itself. */
 299#define REMOVE_DIR_KEEP_TOPLEVEL 04
 300
 301/*
 302 * Remove path and its contents, recursively. flags is a combination
 303 * of the above REMOVE_DIR_* constants. Return 0 on success.
 304 *
 305 * This function uses path as temporary scratch space, but restores it
 306 * before returning.
 307 */
 308extern int remove_dir_recursively(struct strbuf *path, int flag);
 309
 310/* tries to remove the path with empty directories along it, ignores ENOENT */
 311extern int remove_path(const char *path);
 312
 313extern int fspathcmp(const char *a, const char *b);
 314extern int fspathncmp(const char *a, const char *b, size_t count);
 315
 316/*
 317 * The prefix part of pattern must not contains wildcards.
 318 */
 319struct pathspec_item;
 320extern int git_fnmatch(const struct pathspec_item *item,
 321                       const char *pattern, const char *string,
 322                       int prefix);
 323
 324extern int submodule_path_match(const struct pathspec *ps,
 325                                const char *submodule_name,
 326                                char *seen);
 327
 328static inline int ce_path_match(const struct cache_entry *ce,
 329                                const struct pathspec *pathspec,
 330                                char *seen)
 331{
 332        return match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen,
 333                              S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode));
 334}
 335
 336static inline int dir_path_match(const struct dir_entry *ent,
 337                                 const struct pathspec *pathspec,
 338                                 int prefix, char *seen)
 339{
 340        int has_trailing_dir = ent->len && ent->name[ent->len - 1] == '/';
 341        int len = has_trailing_dir ? ent->len - 1 : ent->len;
 342        return match_pathspec(pathspec, ent->name, len, prefix, seen,
 343                              has_trailing_dir);
 344}
 345
 346int cmp_dir_entry(const void *p1, const void *p2);
 347int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in);
 348
 349void untracked_cache_invalidate_path(struct index_state *, const char *);
 350void untracked_cache_remove_from_index(struct index_state *, const char *);
 351void untracked_cache_add_to_index(struct index_state *, const char *);
 352
 353void free_untracked_cache(struct untracked_cache *);
 354struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz);
 355void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked);
 356void add_untracked_cache(struct index_state *istate);
 357void remove_untracked_cache(struct index_state *istate);
 358extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
 359extern void relocate_gitdir(const char *path,
 360                            const char *old_git_dir,
 361                            const char *new_git_dir);
 362#endif