filebuf.h 2.54 KB
Newer Older
Vicent Marti committed
1
/*
schu committed
2
 * Copyright (C) 2009-2012 the libgit2 contributors
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8 9 10 11
#ifndef INCLUDE_filebuf_h__
#define INCLUDE_filebuf_h__

#include "fileops.h"
#include "hash.h"
12
#include <zlib.h>
13 14 15 16 17

#ifdef GIT_THREADS
#	define GIT_FILEBUF_THREADS
#endif

Vicent Marti committed
18 19 20 21
#define GIT_FILEBUF_HASH_CONTENTS		(1 << 0)
#define GIT_FILEBUF_APPEND				(1 << 2)
#define GIT_FILEBUF_FORCE				(1 << 3)
#define GIT_FILEBUF_TEMPORARY			(1 << 4)
22 23
#define GIT_FILEBUF_DO_NOT_BUFFER		(1 << 5)
#define GIT_FILEBUF_DEFLATE_SHIFT		(6)
24

25 26 27
#define GIT_FILELOCK_EXTENSION ".lock\0"
#define GIT_FILELOCK_EXTLENGTH 6

28 29 30 31
struct git_filebuf {
	char *path_original;
	char *path_lock;

32
	int (*write)(struct git_filebuf *file, void *source, size_t len);
Vicent Marti committed
33

34 35 36
	git_hash_ctx *digest;

	unsigned char *buffer;
Vicent Marti committed
37 38 39 40
	unsigned char *z_buf;

	z_stream zs;
	int flush_mode;
41 42 43

	size_t buf_size, buf_pos;
	git_file fd;
44
	bool fd_is_open;
45
	bool do_not_buffer;
46
	int last_error;
47 48 49 50
};

typedef struct git_filebuf git_filebuf;

51 52
#define GIT_FILEBUF_INIT {0}

53 54
/*
 * The git_filebuf object lifecycle is:
55
 * - Allocate git_filebuf, preferably using GIT_FILEBUF_INIT.
56
 *
57
 * - Call git_filebuf_open() to initialize the filebuf for use.
58
 *
59
 * - Make as many calls to git_filebuf_write(), git_filebuf_printf(),
60 61 62 63
 *   git_filebuf_reserve() as you like. The error codes for these
 *   functions don't need to be checked. They are stored internally
 *   by the file buffer.
 *
64
 * - While you are writing, you may call git_filebuf_hash() to get
65 66 67
 *   the hash of all you have written so far. This function will
 *   fail if any of the previous writes to the buffer failed.
 *
68 69 70
 * - To close the git_filebuf, you may call git_filebuf_commit() or
 *   git_filebuf_commit_at() to save the file, or
 *   git_filebuf_cleanup() to abandon the file.  All of these will
71 72 73
 *   free the git_filebuf object. Likewise, all of these will fail
 *   if any of the previous writes to the buffer failed, and set
 *   an error code accordingly.
74
 */
Vicent Marti committed
75
int git_filebuf_write(git_filebuf *lock, const void *buff, size_t len);
76
int git_filebuf_reserve(git_filebuf *file, void **buff, size_t len);
77
int git_filebuf_printf(git_filebuf *file, const char *format, ...) GIT_FORMAT_PRINTF(2, 3);
78 79

int git_filebuf_open(git_filebuf *lock, const char *path, int flags);
80 81
int git_filebuf_commit(git_filebuf *lock, mode_t mode);
int git_filebuf_commit_at(git_filebuf *lock, const char *path, mode_t mode);
82 83 84 85
void git_filebuf_cleanup(git_filebuf *lock);
int git_filebuf_hash(git_oid *oid, git_filebuf *file);

#endif