git-sh-i18n--envsubst: add SYNOPSIS section to the documentation
[git/jnareb-git.git] / dir.h
blob433b5b4cd4c51e9b7557d3056570ed46b7ceba92
1 #ifndef DIR_H
2 #define DIR_H
4 struct dir_entry {
5 unsigned int len;
6 char name[FLEX_ARRAY]; /* more */
7 };
9 #define EXC_FLAG_NODIR 1
10 #define EXC_FLAG_NOWILDCARD 2
11 #define EXC_FLAG_ENDSWITH 4
12 #define EXC_FLAG_MUSTBEDIR 8
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;
27 struct exclude_stack {
28 struct exclude_stack *prev;
29 char *filebuf;
30 int baselen;
31 int exclude_ix;
34 struct dir_struct {
35 int nr, alloc;
36 int ignored_nr, ignored_alloc;
37 enum {
38 DIR_SHOW_IGNORED = 1<<0,
39 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
40 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
41 DIR_NO_GITLINKS = 1<<3,
42 DIR_COLLECT_IGNORED = 1<<4
43 } flags;
44 struct dir_entry **entries;
45 struct dir_entry **ignored;
47 /* Exclude info */
48 const char *exclude_per_dir;
49 struct exclude_list exclude_list[3];
51 * We maintain three exclude pattern lists:
52 * EXC_CMDL lists patterns explicitly given on the command line.
53 * EXC_DIRS lists patterns obtained from per-directory ignore files.
54 * EXC_FILE lists patterns from fallback ignore files.
56 #define EXC_CMDL 0
57 #define EXC_DIRS 1
58 #define EXC_FILE 2
60 struct exclude_stack *exclude_stack;
61 char basebuf[PATH_MAX];
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 extern int match_pathspec_depth(const struct pathspec *pathspec,
69 const char *name, int namelen,
70 int prefix, char *seen);
71 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
73 extern int fill_directory(struct dir_struct *dir, const char **pathspec);
74 extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
76 extern int excluded_from_list(const char *pathname, int pathlen, const char *basename,
77 int *dtype, struct exclude_list *el);
78 extern int excluded(struct dir_struct *, const char *, int *);
79 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
80 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
81 char **buf_p, struct exclude_list *which, int check_index);
82 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
83 extern void add_exclude(const char *string, const char *base,
84 int baselen, struct exclude_list *which);
85 extern void free_excludes(struct exclude_list *el);
86 extern int file_exists(const char *);
88 extern int is_inside_dir(const char *dir);
89 extern int dir_inside_of(const char *subdir, const char *dir);
91 static inline int is_dot_or_dotdot(const char *name)
93 return (name[0] == '.' &&
94 (name[1] == '\0' ||
95 (name[1] == '.' && name[2] == '\0')));
98 extern int is_empty_dir(const char *dir);
100 extern void setup_standard_excludes(struct dir_struct *dir);
102 #define REMOVE_DIR_EMPTY_ONLY 01
103 #define REMOVE_DIR_KEEP_NESTED_GIT 02
104 extern int remove_dir_recursively(struct strbuf *path, int flag);
106 /* tries to remove the path with empty directories along it, ignores ENOENT */
107 extern int remove_path(const char *path);
109 extern int strcmp_icase(const char *a, const char *b);
110 extern int strncmp_icase(const char *a, const char *b, size_t count);
111 extern int fnmatch_icase(const char *pattern, const char *string, int flags);
113 #endif