Git 2.42-rc2
[alt-git.git] / dir-iterator.c
blob278b04243a3f40e63df433eea9549f90aed1c34d
1 #include "git-compat-util.h"
2 #include "dir.h"
3 #include "iterator.h"
4 #include "dir-iterator.h"
6 struct dir_iterator_level {
7 DIR *dir;
9 /*
10 * The length of the directory part of path at this level
11 * (including a trailing '/'):
13 size_t prefix_len;
17 * The full data structure used to manage the internal directory
18 * iteration state. It includes members that are not part of the
19 * public interface.
21 struct dir_iterator_int {
22 struct dir_iterator base;
25 * The number of levels currently on the stack. After the first
26 * call to dir_iterator_begin(), if it succeeds to open the
27 * first level's dir, this will always be at least 1. Then,
28 * when it comes to zero the iteration is ended and this
29 * struct is freed.
31 size_t levels_nr;
33 /* The number of levels that have been allocated on the stack */
34 size_t levels_alloc;
37 * A stack of levels. levels[0] is the uppermost directory
38 * that will be included in this iteration.
40 struct dir_iterator_level *levels;
42 /* Combination of flags for this dir-iterator */
43 unsigned int flags;
47 * Push a level in the iter stack and initialize it with information from
48 * the directory pointed by iter->base->path. It is assumed that this
49 * strbuf points to a valid directory path. Return 0 on success and -1
50 * otherwise, setting errno accordingly and leaving the stack unchanged.
52 static int push_level(struct dir_iterator_int *iter)
54 struct dir_iterator_level *level;
56 ALLOC_GROW(iter->levels, iter->levels_nr + 1, iter->levels_alloc);
57 level = &iter->levels[iter->levels_nr++];
59 if (!is_dir_sep(iter->base.path.buf[iter->base.path.len - 1]))
60 strbuf_addch(&iter->base.path, '/');
61 level->prefix_len = iter->base.path.len;
63 level->dir = opendir(iter->base.path.buf);
64 if (!level->dir) {
65 int saved_errno = errno;
66 if (errno != ENOENT) {
67 warning_errno("error opening directory '%s'",
68 iter->base.path.buf);
70 iter->levels_nr--;
71 errno = saved_errno;
72 return -1;
75 return 0;
79 * Pop the top level on the iter stack, releasing any resources associated
80 * with it. Return the new value of iter->levels_nr.
82 static int pop_level(struct dir_iterator_int *iter)
84 struct dir_iterator_level *level =
85 &iter->levels[iter->levels_nr - 1];
87 if (level->dir && closedir(level->dir))
88 warning_errno("error closing directory '%s'",
89 iter->base.path.buf);
90 level->dir = NULL;
92 return --iter->levels_nr;
96 * Populate iter->base with the necessary information on the next iteration
97 * entry, represented by the given dirent de. Return 0 on success and -1
98 * otherwise, setting errno accordingly.
100 static int prepare_next_entry_data(struct dir_iterator_int *iter,
101 struct dirent *de)
103 int err, saved_errno;
105 strbuf_addstr(&iter->base.path, de->d_name);
107 * We have to reset these because the path strbuf might have
108 * been realloc()ed at the previous strbuf_addstr().
110 iter->base.relative_path = iter->base.path.buf +
111 iter->levels[0].prefix_len;
112 iter->base.basename = iter->base.path.buf +
113 iter->levels[iter->levels_nr - 1].prefix_len;
115 err = lstat(iter->base.path.buf, &iter->base.st);
117 saved_errno = errno;
118 if (err && errno != ENOENT)
119 warning_errno("failed to stat '%s'", iter->base.path.buf);
121 errno = saved_errno;
122 return err;
125 int dir_iterator_advance(struct dir_iterator *dir_iterator)
127 struct dir_iterator_int *iter =
128 (struct dir_iterator_int *)dir_iterator;
130 if (S_ISDIR(iter->base.st.st_mode) && push_level(iter)) {
131 if (errno != ENOENT && iter->flags & DIR_ITERATOR_PEDANTIC)
132 goto error_out;
133 if (iter->levels_nr == 0)
134 goto error_out;
137 /* Loop until we find an entry that we can give back to the caller. */
138 while (1) {
139 struct dirent *de;
140 struct dir_iterator_level *level =
141 &iter->levels[iter->levels_nr - 1];
143 strbuf_setlen(&iter->base.path, level->prefix_len);
144 errno = 0;
145 de = readdir(level->dir);
147 if (!de) {
148 if (errno) {
149 warning_errno("error reading directory '%s'",
150 iter->base.path.buf);
151 if (iter->flags & DIR_ITERATOR_PEDANTIC)
152 goto error_out;
153 } else if (pop_level(iter) == 0) {
154 return dir_iterator_abort(dir_iterator);
156 continue;
159 if (is_dot_or_dotdot(de->d_name))
160 continue;
162 if (prepare_next_entry_data(iter, de)) {
163 if (errno != ENOENT && iter->flags & DIR_ITERATOR_PEDANTIC)
164 goto error_out;
165 continue;
168 return ITER_OK;
171 error_out:
172 dir_iterator_abort(dir_iterator);
173 return ITER_ERROR;
176 int dir_iterator_abort(struct dir_iterator *dir_iterator)
178 struct dir_iterator_int *iter = (struct dir_iterator_int *)dir_iterator;
180 for (; iter->levels_nr; iter->levels_nr--) {
181 struct dir_iterator_level *level =
182 &iter->levels[iter->levels_nr - 1];
184 if (level->dir && closedir(level->dir)) {
185 int saved_errno = errno;
186 strbuf_setlen(&iter->base.path, level->prefix_len);
187 errno = saved_errno;
188 warning_errno("error closing directory '%s'",
189 iter->base.path.buf);
193 free(iter->levels);
194 strbuf_release(&iter->base.path);
195 free(iter);
196 return ITER_DONE;
199 struct dir_iterator *dir_iterator_begin(const char *path, unsigned int flags)
201 struct dir_iterator_int *iter = xcalloc(1, sizeof(*iter));
202 struct dir_iterator *dir_iterator = &iter->base;
203 int saved_errno, err;
205 strbuf_init(&iter->base.path, PATH_MAX);
206 strbuf_addstr(&iter->base.path, path);
208 ALLOC_GROW(iter->levels, 10, iter->levels_alloc);
209 iter->levels_nr = 0;
210 iter->flags = flags;
213 * Note: lstat already checks for NULL or empty strings and
214 * nonexistent paths.
216 err = lstat(iter->base.path.buf, &iter->base.st);
218 if (err < 0) {
219 saved_errno = errno;
220 goto error_out;
223 if (!S_ISDIR(iter->base.st.st_mode)) {
224 saved_errno = ENOTDIR;
225 goto error_out;
228 return dir_iterator;
230 error_out:
231 dir_iterator_abort(dir_iterator);
232 errno = saved_errno;
233 return NULL;