summaryrefslogtreecommitdiff
path: root/src/git/fileops.h
blob: 7f5dd37769557fb8ce6eb0f82dbca7394eb94fcc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#ifndef INCLUDE_git_fileops_h__
#define INCLUDE_git_fileops_h__

/**
 * @file git/fileops.h
 * @brief Git platform agnostic filesystem operations
 * @defgroup git_fileops Git filesystem operations
 * @ingroup Git
 * @{
 */

#include "common.h"
GIT_BEGIN_DECL
/**
 * For each directory entry (except "." and ".."), run the function
 * "fn", passing it "arg" as its first argument and the path to
 * the entry as the second argument.
 * @param dir The directory to walk
 * @param fn The callback function to run for each entry in *dir.
 *        "fn" may return >0 to signal "I'm done. Stop parsing and
 *        return successfully" or <0 to signal an error.  All non-zero
 *        return codes cause directory traversal to stop.
 * @param arg The first argument that will be passed to 'fn'
 * @return GIT_SUCCESS if all entries were successfully traversed,
 *         otherwise the result of fn.
 */
GIT_EXTERN(int) git_foreach_dirent(const char *dir,
			int (*fn)(void *, const char *), void *arg);

/** @} */
GIT_END_DECL
#endif /* INCLUDE_git_fileops_h__ */