diff options
Diffstat (limited to 'src/fileops.h')
-rw-r--r-- | src/fileops.h | 41 |
1 files changed, 31 insertions, 10 deletions
diff --git a/src/fileops.h b/src/fileops.h index ab57b6f38..be619d620 100644 --- a/src/fileops.h +++ b/src/fileops.h @@ -26,7 +26,7 @@ extern int git_futils_readbuffer_updated(git_buf *obj, const char *path, time_t * These are custom filesystem-related helper methods. They are * rather high level, and wrap the underlying POSIX methods * - * All these methods return GIT_SUCCESS on success, + * All these methods return 0 on success, * or an error code on failure and an error message is set. */ @@ -58,10 +58,25 @@ extern int git_futils_mkdir_r(const char *path, const char *base, const mode_t m */ extern int git_futils_mkpath2file(const char *path, const mode_t mode); +typedef enum { + GIT_DIRREMOVAL_EMPTY_HIERARCHY = 0, + GIT_DIRREMOVAL_FILES_AND_DIRS = 1, + GIT_DIRREMOVAL_ONLY_EMPTY_DIRS = 2, +} git_directory_removal_type; + /** * Remove path and any files and directories beneath it. + * + * @param path Path to to top level directory to process. + * + * @param removal_type GIT_DIRREMOVAL_EMPTY_HIERARCHY to remove a hierarchy + * of empty directories (will fail if any file is found), GIT_DIRREMOVAL_FILES_AND_DIRS + * to remove a hierarchy of files and folders, GIT_DIRREMOVAL_ONLY_EMPTY_DIRS to only remove + * empty directories (no failure on file encounter). + * + * @return 0 on success; -1 on error. */ -extern int git_futils_rmdir_r(const char *path, int force); +extern int git_futils_rmdir_r(const char *path, git_directory_removal_type removal_type); /** * Create and open a temporary file with a `_git2_` suffix. @@ -77,6 +92,11 @@ extern int git_futils_mktmp(git_buf *path_out, const char *filename); extern int git_futils_mv_withpath(const char *from, const char *to, const mode_t dirmode); /** + * Open a file readonly and set error if needed. + */ +extern int git_futils_open_ro(const char *path); + +/** * Get the filesize in bytes of a file */ extern git_off_t git_futils_filesize(git_file fd); @@ -103,8 +123,8 @@ extern mode_t git_futils_canonical_mode(mode_t raw_mode); * @param begin first byte to map, this should be page aligned. * @param end number of bytes to map. * @return - * - GIT_SUCCESS on success; - * - GIT_EOSERR on an unspecified OS related error. + * - 0 on success; + * - -1 on error. */ extern int git_futils_mmap_ro( git_map *out, @@ -118,8 +138,9 @@ extern int git_futils_mmap_ro( * @param out buffer to populate with the mapping information. * @param path path to file to be opened. * @return - * - GIT_SUCCESS on success; - * - GIT_EOSERR on an unspecified OS related error. + * - 0 on success; + * - GIT_ENOTFOUND if not found; + * - -1 on an unspecified OS related error. */ extern int git_futils_mmap_ro_file( git_map *out, @@ -137,9 +158,9 @@ extern void git_futils_mmap_free(git_map *map); * @param pathbuf buffer to write the full path into * @param filename name of file to find in the home directory * @return - * - GIT_SUCCESS if found; + * - 0 if found; * - GIT_ENOTFOUND if not found; - * - GIT_EOSERR on an unspecified OS related error. + * - -1 on an unspecified OS related error. */ extern int git_futils_find_global_file(git_buf *path, const char *filename); @@ -149,9 +170,9 @@ extern int git_futils_find_global_file(git_buf *path, const char *filename); * @param pathbuf buffer to write the full path into * @param filename name of file to find in the home directory * @return - * - GIT_SUCCESS if found; + * - 0 if found; * - GIT_ENOTFOUND if not found; - * - GIT_EOSERR on an unspecified OS related error. + * - -1 on an unspecified OS related error. */ extern int git_futils_find_system_file(git_buf *path, const char *filename); |