thodg/libgit2/src/fileops.h

• Show log

  Commit

• Hash : f2e6b877
  Author :
  Date : 2011-06-03T23:44:38
  

  Repository: Added some util functions that we'll need to discover repository path. retrieve_device returns the file device for a given path (so that we can detect device change while walking through parent directories). abspath returns a canonicalized path, symbolic link free. retrieive_ceiling_directories_offset returns the biggest path offset that path match in the ceiling directory list (so that we can stop at ceiling directories).

Download

• src/fileops.h

• /*
   * fileops.h - OS agnostic disk io operations
   *
   * This header describes the strictly internal part of the api
   */
  #ifndef INCLUDE_fileops_h__
  #define INCLUDE_fileops_h__
  
  #include "common.h"
  #include "map.h"
  #include "dir.h"
  #include <fcntl.h>
  #include <time.h>
  
  #define GIT_PATH_LIST_SEPARATOR ':'
  
  #ifdef GIT_WIN32
  #define GIT_PLATFORM_PATH_SEP '\\'
  #else
  #define GIT_PLATFORM_PATH_SEP '/'
  #endif
  
  #ifdef GIT_WIN32
  GIT_INLINE(int) link(const char *GIT_UNUSED(old), const char *GIT_UNUSED(new))
  {
  	GIT_UNUSED_ARG(old)
  	GIT_UNUSED_ARG(new)
  	errno = ENOSYS;
  	return -1;
  }
  
  GIT_INLINE(int) git__mkdir(const char *path, int GIT_UNUSED(mode))
  {
  	GIT_UNUSED_ARG(mode)
  	return mkdir(path);
  }
  
  extern int git__unlink(const char *path);
  extern int git__mkstemp(char *template);
  extern int git__fsync(int fd);
  
  # ifndef GIT__WIN32_NO_HIDE_FILEOPS
  #  define unlink(p) git__unlink(p)
  #  define mkstemp(t) git__mkstemp(t)
  #  define mkdir(p,m) git__mkdir(p, m)
  #  define fsync(fd) git__fsync(fd)
  # endif
  #endif  /* GIT_WIN32 */
  
  
  #if !defined(O_BINARY)
  #define O_BINARY 0
  #endif
  
  #define GITFO_BUF_INIT {NULL, 0}
  
  typedef int git_file;
  
  typedef struct {  /* file io buffer  */
  	void *data;  /* data bytes   */
  	size_t len;  /* data length  */
  } gitfo_buf;
  
  extern int gitfo_exists(const char *path);
  extern int gitfo_open(const char *path, int flags);
  extern int gitfo_creat(const char *path, int mode);
  extern int gitfo_creat_force(const char *path, int mode);
  extern int gitfo_creat_locked(const char *path, int mode);
  extern int gitfo_creat_locked_force(const char *path, int mode);
  extern int gitfo_mktemp(char *path_out, const char *filename);
  extern int gitfo_isdir(const char *path);
  extern int gitfo_isfile(const char *path);
  extern int gitfo_mkdir_recurs(const char *path, int mode);
  extern int gitfo_mkdir_2file(const char *path);
  #define gitfo_close(fd) close(fd)
  
  extern int gitfo_read(git_file fd, void *buf, size_t cnt);
  extern int gitfo_write(git_file fd, void *buf, size_t cnt);
  #define gitfo_lseek(f,n,w) lseek(f, n, w)
  extern git_off_t gitfo_size(git_file fd);
  
  extern int gitfo_read_file(gitfo_buf *obj, const char *path);
  extern void gitfo_free_buf(gitfo_buf *obj);
  
  /* Move (rename) a file; this operation is atomic */
  extern int gitfo_mv(const char *from, const char *to);
  
  /* Move a file (forced); this will create the destination
   * path if it doesn't exist */
  extern int gitfo_mv_force(const char *from, const char *to);
  
  #define gitfo_stat(p,b) stat(p, b)
  #define gitfo_fstat(f,b) fstat(f, b)
  
  #define gitfo_unlink(p) unlink(p)
  #define gitfo_rmdir(p) rmdir(p)
  #define gitfo_chdir(p) chdir(p)
  #define gitfo_mkdir(p,m) mkdir(p, m)
  
  #define gitfo_mkstemp(t) mkstemp(t)
  #define gitfo_fsync(fd) fsync(fd)
  #define gitfo_chmod(p,m) chmod(p, m)
  
  /**
   * Read-only map all or part of a file into memory.
   * When possible this function should favor a virtual memory
   * style mapping over some form of malloc()+read(), as the
   * data access will be random and is not likely to touch the
   * majority of the region requested.
   *
   * @param out buffer to populate with the mapping information.
   * @param fd open descriptor to configure the mapping from.
   * @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.
   */
  extern int gitfo_map_ro(
  	git_map *out,
  	git_file fd,
  	git_off_t begin,
  	size_t len);
  
  /**
   * Release the memory associated with a previous memory mapping.
   * @param map the mapping description previously configured.
   */
  extern void gitfo_free_map(git_map *map);
  
  /**
   * Walk each directory entry, except '.' and '..', calling fn(state).
   *
   * @param pathbuf buffer the function reads the initial directory
   * 		path from, and updates with each successive entry's name.
   * @param pathmax maximum allocation of pathbuf.
   * @param fn function to invoke with each entry.  The first arg is
   *		the input state and the second arg is pathbuf.  The function
   *		may modify the pathbuf, but only by appending new text.
   * @param state to pass to fn as the first arg.
   */
  extern int gitfo_dirent(
  	char *pathbuf,
  	size_t pathmax,
  	int (*fn)(void *, char *),
  	void *state);
  
  extern int gitfo_cmp_path(const char *name1, int len1, int isdir1,
  		const char *name2, int len2, int isdir2);
  
  extern int gitfo_getcwd(char *buffer_out, size_t size);
  
  /**
   * Clean up a provided absolute or relative directory path.
   * 
   * This prettification relies on basic operations such as coalescing 
   * multiple forward slashes into a single slash, removing '.' and 
   * './' current directory segments, and removing parent directory 
   * whenever '..' is encountered.
   *
   * If not empty, the returned path ends with a forward slash.
   *
   * For instance, this will turn "d1/s1///s2/..//../s3" into "d1/s3/".
   *
   * This only performs a string based analysis of the path.
   * No checks are done to make sure the path actually makes sense from 
   * the file system perspective.
   *
   * @param buffer_out buffer to populate with the normalized path.
   * @param size buffer size.
   * @param path directory path to clean up.
   * @return
   * - GIT_SUCCESS on success;
   * - GIT_ERROR when the input path is invalid or escapes the current directory.
   */
  int gitfo_prettify_dir_path(char *buffer_out, size_t size, const char *path, const char *base_path);
  
  /**
   * Clean up a provided absolute or relative file path.
   * 
   * This prettification relies on basic operations such as coalescing 
   * multiple forward slashes into a single slash, removing '.' and 
   * './' current directory segments, and removing parent directory 
   * whenever '..' is encountered.
   *
   * For instance, this will turn "d1/s1///s2/..//../s3" into "d1/s3".
   *
   * This only performs a string based analysis of the path.
   * No checks are done to make sure the path actually makes sense from 
   * the file system perspective.
   *
   * @param buffer_out buffer to populate with the normalized path.
   * @param size buffer size.
   * @param path file path to clean up.
   * @return
   * - GIT_SUCCESS on success;
   * - GIT_ERROR when the input path is invalid or escapes the current directory.
   */
  int gitfo_prettify_file_path(char *buffer_out, size_t size, const char *path, const char *base_path);
  
  void gitfo_posixify_path(char *path);
  
  int gitfo_retrieve_path_root_offset(const char *path);
  
  #endif /* INCLUDE_fileops_h__ */
  

Download