4 /* See Documentation/technical/api-directory-listing.txt */
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
29 /* remember pointer to exclude file contents so we can free() */
32 /* origin of list, e.g. path to filename, or descriptive string */
37 * This allows callers of last_exclude_matching() etc.
38 * to determine the origin of the matching pattern.
40 struct exclude_list
*el
;
50 * Counting starts from 1 for line numbers in ignore files,
51 * and from -1 decrementing for patterns from CLI args.
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 */
66 int exclude_ix
; /* index of exclude_list within EXC_DIRS exclude_list_group */
69 struct exclude_list_group
{
71 struct exclude_list
*el
;
76 int ignored_nr
, ignored_alloc
;
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
84 struct dir_entry
**entries
;
85 struct dir_entry
**ignored
;
88 const char *exclude_per_dir
;
91 * We maintain three groups of exclude pattern lists:
93 * EXC_CMDL lists patterns explicitly given on the command line.
94 * EXC_DIRS lists patterns obtained from per-directory ignore files.
95 * EXC_FILE lists patterns from fallback ignore files, e.g.
99 * Each group contains multiple exclude lists, a single list
105 struct exclude_list_group exclude_list_group
[3];
108 * Temporary variables which are used during loading of the
109 * per-directory exclude lists.
111 * exclude_stack points to the top of the exclude_stack, and
112 * basebuf contains the full path to the current
113 * (sub)directory in the traversal. Exclude points to the
114 * matching exclude struct if the directory is excluded.
116 struct exclude_stack
*exclude_stack
;
117 struct exclude
*exclude
;
118 char basebuf
[PATH_MAX
];
122 * The ordering of these constants is significant, with
123 * higher-numbered match types signifying "closer" (i.e. more
124 * specific) matches which will override lower-numbered match types
125 * when populating the seen[] array.
127 #define MATCHED_RECURSIVELY 1
128 #define MATCHED_FNMATCH 2
129 #define MATCHED_EXACTLY 3
130 extern char *common_prefix(const char **pathspec
);
131 extern int match_pathspec(const char **pathspec
, const char *name
, int namelen
, int prefix
, char *seen
);
132 extern int match_pathspec_depth(const struct pathspec
*pathspec
,
133 const char *name
, int namelen
,
134 int prefix
, char *seen
);
135 extern int within_depth(const char *name
, int namelen
, int depth
, int max_depth
);
137 extern int fill_directory(struct dir_struct
*dir
, const char **pathspec
);
138 extern int read_directory(struct dir_struct
*, const char *path
, int len
, const char **pathspec
);
140 extern int is_excluded_from_list(const char *pathname
, int pathlen
, const char *basename
,
141 int *dtype
, struct exclude_list
*el
);
142 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
, const char *pathname
, int len
);
145 * these implement the matching logic for dir.c:excluded_from_list and
146 * attr.c:path_matches()
148 extern int match_basename(const char *, int,
149 const char *, int, int, int);
150 extern int match_pathname(const char *, int,
152 const char *, int, int, int);
154 extern struct exclude
*last_exclude_matching(struct dir_struct
*dir
,
155 const char *name
, int *dtype
);
157 extern int is_excluded(struct dir_struct
*dir
, const char *name
, int *dtype
);
159 extern struct exclude_list
*add_exclude_list(struct dir_struct
*dir
,
160 int group_type
, const char *src
);
161 extern int add_excludes_from_file_to_list(const char *fname
, const char *base
, int baselen
,
162 struct exclude_list
*el
, int check_index
);
163 extern void add_excludes_from_file(struct dir_struct
*, const char *fname
);
164 extern void parse_exclude_pattern(const char **string
, int *patternlen
, int *flags
, int *nowildcardlen
);
165 extern void add_exclude(const char *string
, const char *base
,
166 int baselen
, struct exclude_list
*el
, int srcpos
);
167 extern void clear_exclude_list(struct exclude_list
*el
);
168 extern void clear_directory(struct dir_struct
*dir
);
169 extern int file_exists(const char *);
171 extern int is_inside_dir(const char *dir
);
172 extern int dir_inside_of(const char *subdir
, const char *dir
);
174 static inline int is_dot_or_dotdot(const char *name
)
176 return (name
[0] == '.' &&
178 (name
[1] == '.' && name
[2] == '\0')));
181 extern int is_empty_dir(const char *dir
);
183 extern void setup_standard_excludes(struct dir_struct
*dir
);
185 #define REMOVE_DIR_EMPTY_ONLY 01
186 #define REMOVE_DIR_KEEP_NESTED_GIT 02
187 #define REMOVE_DIR_KEEP_TOPLEVEL 04
188 extern int remove_dir_recursively(struct strbuf
*path
, int flag
);
190 /* tries to remove the path with empty directories along it, ignores ENOENT */
191 extern int remove_path(const char *path
);
193 extern int strcmp_icase(const char *a
, const char *b
);
194 extern int strncmp_icase(const char *a
, const char *b
, size_t count
);
195 extern int fnmatch_icase(const char *pattern
, const char *string
, int flags
);
198 * The prefix part of pattern must not contains wildcards.
200 #define GFNM_PATHNAME 1 /* similar to FNM_PATHNAME */
201 #define GFNM_ONESTAR 2 /* there is only _one_ wildcard, a star */
203 extern int git_fnmatch(const char *pattern
, const char *string
,
204 int flags
, int prefix
);