Merge branch 'am/maint-push-doc' into maint
[git] / dir.h
1 #ifndef DIR_H
2 #define DIR_H
3
4 struct dir_entry {
5         unsigned int len;
6         char name[FLEX_ARRAY]; /* more */
7 };
8
9 #define EXC_FLAG_NODIR 1
10 #define EXC_FLAG_NOWILDCARD 2
11 #define EXC_FLAG_ENDSWITH 4
12 #define EXC_FLAG_MUSTBEDIR 8
13
14 struct exclude_list {
15         int nr;
16         int alloc;
17         struct exclude {
18                 const char *pattern;
19                 int patternlen;
20                 const char *base;
21                 int baselen;
22                 int to_exclude;
23                 int flags;
24         } **excludes;
25 };
26
27 struct exclude_stack {
28         struct exclude_stack *prev;
29         char *filebuf;
30         int baselen;
31         int exclude_ix;
32 };
33
34 struct dir_struct {
35         int nr, alloc;
36         int ignored_nr, ignored_alloc;
37         unsigned int show_ignored:1,
38                      show_other_directories:1,
39                      hide_empty_directories:1,
40                      no_gitlinks:1,
41                      collect_ignored:1;
42         struct dir_entry **entries;
43         struct dir_entry **ignored;
44
45         /* Exclude info */
46         const char *exclude_per_dir;
47         struct exclude_list exclude_list[3];
48         /*
49          * We maintain three exclude pattern lists:
50          * EXC_CMDL lists patterns explicitly given on the command line.
51          * EXC_DIRS lists patterns obtained from per-directory ignore files.
52          * EXC_FILE lists patterns from fallback ignore files.
53          */
54 #define EXC_CMDL 0
55 #define EXC_DIRS 1
56 #define EXC_FILE 2
57
58         struct exclude_stack *exclude_stack;
59         char basebuf[PATH_MAX];
60 };
61
62 extern int common_prefix(const char **pathspec);
63
64 #define MATCHED_RECURSIVELY 1
65 #define MATCHED_FNMATCH 2
66 #define MATCHED_EXACTLY 3
67 extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
68
69 extern int read_directory(struct dir_struct *, const char *path, const char *base, int baselen, const char **pathspec);
70
71 extern int excluded(struct dir_struct *, const char *, int *);
72 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
73 extern void add_exclude(const char *string, const char *base,
74                         int baselen, struct exclude_list *which);
75 extern int file_exists(const char *);
76
77 extern char *get_relative_cwd(char *buffer, int size, const char *dir);
78 extern int is_inside_dir(const char *dir);
79
80 extern void setup_standard_excludes(struct dir_struct *dir);
81 extern int remove_dir_recursively(struct strbuf *path, int only_empty);
82
83 /* tries to remove the path with empty directories along it, ignores ENOENT */
84 extern int remove_path(const char *path);
85
86 #endif