mirror of
https://github.com/git/git
synced 2024-08-27 11:39:22 +00:00
![Patrick Steinhardt](/assets/img/avatar_default.png)
The `struct dir_iterator` is a helper that allows us to iterate through directory entries. This iterator returns entries in the exact same order as readdir(3P) does -- or in other words, it guarantees no specific order at all. This is about to become problematic as we are introducing a new reflog subcommand to list reflogs. As the "files" backend uses the directory iterator to enumerate reflogs, returning reflog names and exposing them to the user would inherit the indeterministic ordering. Naturally, it would make for a terrible user interface to show a list with no discernible order. While this could be handled at a higher level by the new subcommand itself by collecting and ordering the reflogs, this would be inefficient because we would first have to collect all reflogs before we can sort them, which would introduce additional latency when there are many reflogs. Instead, introduce a new option into the directory iterator that asks for its entries to be yielded in lexicographical order. If set, the iterator will read all directory entries greedily and sort them before we start to iterate over them. While this will of course also incur overhead as we cannot yield the directory entries immediately, it should at least be more efficient than having to sort the complete list of reflogs as we only need to sort one directory at a time. This functionality will be used in a follow-up commit. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
118 lines
3.7 KiB
C
118 lines
3.7 KiB
C
#ifndef DIR_ITERATOR_H
|
|
#define DIR_ITERATOR_H
|
|
|
|
#include "strbuf.h"
|
|
|
|
/*
|
|
* Iterate over a directory tree.
|
|
*
|
|
* Iterate over a directory tree, recursively, including paths of all
|
|
* types and hidden paths. Skip "." and ".." entries and don't follow
|
|
* symlinks except for the original path. Note that the original path
|
|
* is not included in the iteration.
|
|
*
|
|
* Every time dir_iterator_advance() is called, update the members of
|
|
* the dir_iterator structure to reflect the next path in the
|
|
* iteration. The order that paths are iterated over within a
|
|
* directory is undefined, directory paths are always given before
|
|
* their contents.
|
|
*
|
|
* A typical iteration looks like this:
|
|
*
|
|
* int ok;
|
|
* unsigned int flags = DIR_ITERATOR_PEDANTIC;
|
|
* struct dir_iterator *iter = dir_iterator_begin(path, flags);
|
|
*
|
|
* if (!iter)
|
|
* goto error_handler;
|
|
*
|
|
* while ((ok = dir_iterator_advance(iter)) == ITER_OK) {
|
|
* if (want_to_stop_iteration()) {
|
|
* ok = dir_iterator_abort(iter);
|
|
* break;
|
|
* }
|
|
*
|
|
* // Access information about the current path:
|
|
* if (S_ISDIR(iter->st.st_mode))
|
|
* printf("%s is a directory\n", iter->relative_path);
|
|
* }
|
|
*
|
|
* if (ok != ITER_DONE)
|
|
* handle_error();
|
|
*
|
|
* Callers are allowed to modify iter->path while they are working,
|
|
* but they must restore it to its original contents before calling
|
|
* dir_iterator_advance() again.
|
|
*/
|
|
|
|
/*
|
|
* Flags for dir_iterator_begin:
|
|
*
|
|
* - DIR_ITERATOR_PEDANTIC: override dir-iterator's default behavior
|
|
* in case of an error at dir_iterator_advance(), which is to keep
|
|
* looking for a next valid entry. With this flag, resources are freed
|
|
* and ITER_ERROR is returned immediately. In both cases, a meaningful
|
|
* warning is emitted. Note: ENOENT errors are always ignored so that
|
|
* the API users may remove files during iteration.
|
|
*
|
|
* - DIR_ITERATOR_SORTED: sort directory entries alphabetically.
|
|
*/
|
|
#define DIR_ITERATOR_PEDANTIC (1 << 0)
|
|
#define DIR_ITERATOR_SORTED (1 << 1)
|
|
|
|
struct dir_iterator {
|
|
/* The current path: */
|
|
struct strbuf path;
|
|
|
|
/*
|
|
* The current path relative to the starting path. This part
|
|
* of the path always uses "/" characters to separate path
|
|
* components:
|
|
*/
|
|
const char *relative_path;
|
|
|
|
/* The current basename: */
|
|
const char *basename;
|
|
|
|
/*
|
|
* The result of calling lstat() on path.
|
|
*/
|
|
struct stat st;
|
|
};
|
|
|
|
/*
|
|
* Start a directory iteration over path with the combination of
|
|
* options specified by flags. On success, return a dir_iterator
|
|
* that holds the internal state of the iteration. In case of
|
|
* failure, return NULL and set errno accordingly.
|
|
*
|
|
* The iteration includes all paths under path, not including path
|
|
* itself and not including "." or ".." entries.
|
|
*
|
|
* Parameters are:
|
|
* - path is the starting directory. An internal copy will be made.
|
|
* - flags is a combination of the possible flags to initialize a
|
|
* dir-iterator or 0 for default behavior.
|
|
*/
|
|
struct dir_iterator *dir_iterator_begin(const char *path, unsigned int flags);
|
|
|
|
/*
|
|
* Advance the iterator to the first or next item and return ITER_OK.
|
|
* If the iteration is exhausted, free the dir_iterator and any
|
|
* resources associated with it and return ITER_DONE.
|
|
*
|
|
* It is a bug to use iterator or call this function again after it
|
|
* has returned ITER_DONE or ITER_ERROR (which may be returned iff
|
|
* the DIR_ITERATOR_PEDANTIC flag was set).
|
|
*/
|
|
int dir_iterator_advance(struct dir_iterator *iterator);
|
|
|
|
/*
|
|
* End the iteration before it has been exhausted. Free the
|
|
* dir_iterator and any associated resources and return ITER_DONE. On
|
|
* error, free the dir_iterator and return ITER_ERROR.
|
|
*/
|
|
int dir_iterator_abort(struct dir_iterator *iterator);
|
|
|
|
#endif
|