Start preparing for 1.8.4.2
[alt-git.git] / dir.h
blob3d6b80c933b395644c005f6d8df4697215ff000a
1 #ifndef DIR_H
2 #define DIR_H
4 /* See Documentation/technical/api-directory-listing.txt */
6 #include "strbuf.h"
8 struct dir_entry {
9 unsigned int len;
10 char name[FLEX_ARRAY]; /* more */
13 #define EXC_FLAG_NODIR 1
14 #define EXC_FLAG_ENDSWITH 4
15 #define EXC_FLAG_MUSTBEDIR 8
16 #define EXC_FLAG_NEGATIVE 16
19 * Each excludes file will be parsed into a fresh exclude_list which
20 * is appended to the relevant exclude_list_group (either EXC_DIRS or
21 * EXC_FILE). An exclude_list within the EXC_CMDL exclude_list_group
22 * can also be used to represent the list of --exclude values passed
23 * via CLI args.
25 struct exclude_list {
26 int nr;
27 int alloc;
29 /* remember pointer to exclude file contents so we can free() */
30 char *filebuf;
32 /* origin of list, e.g. path to filename, or descriptive string */
33 const char *src;
35 struct exclude {
37 * This allows callers of last_exclude_matching() etc.
38 * to determine the origin of the matching pattern.
40 struct exclude_list *el;
42 const char *pattern;
43 int patternlen;
44 int nowildcardlen;
45 const char *base;
46 int baselen;
47 int flags;
50 * Counting starts from 1 for line numbers in ignore files,
51 * and from -1 decrementing for patterns from CLI args.
53 int srcpos;
54 } **excludes;
58 * The contents of the per-directory exclude files are lazily read on
59 * demand and then cached in memory, one per exclude_stack struct, in
60 * order to avoid opening and parsing each one every time that
61 * directory is traversed.
63 struct exclude_stack {
64 struct exclude_stack *prev; /* the struct exclude_stack for the parent directory */
65 int baselen;
66 int exclude_ix; /* index of exclude_list within EXC_DIRS exclude_list_group */
69 struct exclude_list_group {
70 int nr, alloc;
71 struct exclude_list *el;
74 struct dir_struct {
75 int nr, alloc;
76 int ignored_nr, ignored_alloc;
77 enum {
78 DIR_SHOW_IGNORED = 1<<0,
79 DIR_SHOW_OTHER_DIRECTORIES = 1<<1,
80 DIR_HIDE_EMPTY_DIRECTORIES = 1<<2,
81 DIR_NO_GITLINKS = 1<<3,
82 DIR_COLLECT_IGNORED = 1<<4,
83 DIR_SHOW_IGNORED_TOO = 1<<5
84 } flags;
85 struct dir_entry **entries;
86 struct dir_entry **ignored;
88 /* Exclude info */
89 const char *exclude_per_dir;
92 * We maintain three groups of exclude pattern lists:
94 * EXC_CMDL lists patterns explicitly given on the command line.
95 * EXC_DIRS lists patterns obtained from per-directory ignore files.
96 * EXC_FILE lists patterns from fallback ignore files, e.g.
97 * - .git/info/exclude
98 * - core.excludesfile
100 * Each group contains multiple exclude lists, a single list
101 * per source.
103 #define EXC_CMDL 0
104 #define EXC_DIRS 1
105 #define EXC_FILE 2
106 struct exclude_list_group exclude_list_group[3];
109 * Temporary variables which are used during loading of the
110 * per-directory exclude lists.
112 * exclude_stack points to the top of the exclude_stack, and
113 * basebuf contains the full path to the current
114 * (sub)directory in the traversal. Exclude points to the
115 * matching exclude struct if the directory is excluded.
117 struct exclude_stack *exclude_stack;
118 struct exclude *exclude;
119 char basebuf[PATH_MAX];
123 * The ordering of these constants is significant, with
124 * higher-numbered match types signifying "closer" (i.e. more
125 * specific) matches which will override lower-numbered match types
126 * when populating the seen[] array.
128 #define MATCHED_RECURSIVELY 1
129 #define MATCHED_FNMATCH 2
130 #define MATCHED_EXACTLY 3
131 extern char *common_prefix(const char **pathspec);
132 extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
133 extern int match_pathspec_depth(const struct pathspec *pathspec,
134 const char *name, int namelen,
135 int prefix, char *seen);
136 extern int within_depth(const char *name, int namelen, int depth, int max_depth);
138 extern int fill_directory(struct dir_struct *dir, const char **pathspec);
139 extern int read_directory(struct dir_struct *, const char *path, int len, const char **pathspec);
141 extern int is_excluded_from_list(const char *pathname, int pathlen, const char *basename,
142 int *dtype, struct exclude_list *el);
143 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len);
146 * these implement the matching logic for dir.c:excluded_from_list and
147 * attr.c:path_matches()
149 extern int match_basename(const char *, int,
150 const char *, int, int, int);
151 extern int match_pathname(const char *, int,
152 const char *, int,
153 const char *, int, int, int);
155 extern struct exclude *last_exclude_matching(struct dir_struct *dir,
156 const char *name, int *dtype);
158 extern int is_excluded(struct dir_struct *dir, const char *name, int *dtype);
160 extern struct exclude_list *add_exclude_list(struct dir_struct *dir,
161 int group_type, const char *src);
162 extern int add_excludes_from_file_to_list(const char *fname, const char *base, int baselen,
163 struct exclude_list *el, int check_index);
164 extern void add_excludes_from_file(struct dir_struct *, const char *fname);
165 extern void parse_exclude_pattern(const char **string, int *patternlen, int *flags, int *nowildcardlen);
166 extern void add_exclude(const char *string, const char *base,
167 int baselen, struct exclude_list *el, int srcpos);
168 extern void clear_exclude_list(struct exclude_list *el);
169 extern void clear_directory(struct dir_struct *dir);
170 extern int file_exists(const char *);
172 extern int is_inside_dir(const char *dir);
173 extern int dir_inside_of(const char *subdir, const char *dir);
175 static inline int is_dot_or_dotdot(const char *name)
177 return (name[0] == '.' &&
178 (name[1] == '\0' ||
179 (name[1] == '.' && name[2] == '\0')));
182 extern int is_empty_dir(const char *dir);
184 extern void setup_standard_excludes(struct dir_struct *dir);
186 #define REMOVE_DIR_EMPTY_ONLY 01
187 #define REMOVE_DIR_KEEP_NESTED_GIT 02
188 #define REMOVE_DIR_KEEP_TOPLEVEL 04
189 extern int remove_dir_recursively(struct strbuf *path, int flag);
191 /* tries to remove the path with empty directories along it, ignores ENOENT */
192 extern int remove_path(const char *path);
194 extern int strcmp_icase(const char *a, const char *b);
195 extern int strncmp_icase(const char *a, const char *b, size_t count);
196 extern int fnmatch_icase(const char *pattern, const char *string, int flags);
199 * The prefix part of pattern must not contains wildcards.
201 #define GFNM_PATHNAME 1 /* similar to FNM_PATHNAME */
202 #define GFNM_ONESTAR 2 /* there is only _one_ wildcard, a star */
204 extern int git_fnmatch(const char *pattern, const char *string,
205 int flags, int prefix);
207 #endif