[thirdparty/git.git] / tmp-objdir.h

#ifndef TMP_OBJDIR_H
#define TMP_OBJDIR_H

/*
 * This API allows you to create a temporary object directory, advertise it to
 * sub-processes via GIT_OBJECT_DIRECTORY and GIT_ALTERNATE_OBJECT_DIRECTORIES,
 * and then either migrate its object into the main object directory, or remove
 * it. The library handles unexpected signal/exit death by cleaning up the
 * temporary directory.
 *
 * Example:
 *
 *	struct tmp_objdir *t = tmp_objdir_create("incoming");
 *	if (!run_command_v_opt_cd_env(cmd, 0, NULL, tmp_objdir_env(t)) &&
 *	    !tmp_objdir_migrate(t))
 *		printf("success!\n");
 *	else
 *		die("failed...tmp_objdir will clean up for us");
 *
 */

struct tmp_objdir;

/*
 * Create a new temporary object directory with the specified prefix;
 * returns NULL on failure.
 */
struct tmp_objdir *tmp_objdir_create(const char *prefix);

/*
 * Return a list of environment strings, suitable for use with
 * child_process.env, that can be passed to child programs to make use of the
 * temporary object directory.
 */
const char **tmp_objdir_env(const struct tmp_objdir *);

/*
 * Finalize a temporary object directory by migrating its objects into the main
 * object database, removing the temporary directory, and freeing any
 * associated resources.
 */
int tmp_objdir_migrate(struct tmp_objdir *);

/*
 * Destroy a temporary object directory, discarding any objects it contains.
 */
int tmp_objdir_destroy(struct tmp_objdir *);

/*
 * Remove all objects from the temporary object directory, while leaving it
 * around so more objects can be added.
 */
void tmp_objdir_discard_objects(struct tmp_objdir *);

/*
 * Add the temporary object directory as an alternate object store in the
 * current process.
 */
void tmp_objdir_add_as_alternate(const struct tmp_objdir *);

/*
 * Replaces the writable object store in the current process with the temporary
 * object directory and makes the former main object store an alternate.
 * If will_destroy is nonzero, the object directory may not be migrated.
 */
void tmp_objdir_replace_primary_odb(struct tmp_objdir *, int will_destroy);

/*
 * If the primary object database was replaced by a temporary object directory,
 * restore it to its original value while keeping the directory contents around.
 * Returns NULL if the primary object database was not replaced.
 */
struct tmp_objdir *tmp_objdir_unapply_primary_odb(void);

/*
 * Reapplies the former primary temporary object database, after potentially
 * changing its relative path.
 */
void tmp_objdir_reapply_primary_odb(struct tmp_objdir *, const char *old_cwd,
		const char *new_cwd);


#endif /* TMP_OBJDIR_H */
Commit	Line	Data
2564d994 JK	1	#ifndef TMP_OBJDIR_H
	2	#define TMP_OBJDIR_H
	3
	4	/*
	5	* This API allows you to create a temporary object directory, advertise it to
	6	* sub-processes via GIT_OBJECT_DIRECTORY and GIT_ALTERNATE_OBJECT_DIRECTORIES,
	7	* and then either migrate its object into the main object directory, or remove
	8	* it. The library handles unexpected signal/exit death by cleaning up the
	9	* temporary directory.
	10	*
	11	* Example:
	12	*
b3cecf49	13	* struct tmp_objdir *t = tmp_objdir_create("incoming");
2564d994 JK	14	* if (!run_command_v_opt_cd_env(cmd, 0, NULL, tmp_objdir_env(t)) &&
	15	* !tmp_objdir_migrate(t))
	16	* printf("success!\n");
	17	* else
	18	* die("failed...tmp_objdir will clean up for us");
	19	*
	20	*/
	21
	22	struct tmp_objdir;
	23
	24	/*
b3cecf49 NS	25	* Create a new temporary object directory with the specified prefix;
b3cecf49 NS	26	* returns NULL on failure.
2564d994	27	*/
b3cecf49	28	struct tmp_objdir tmp_objdir_create(const char prefix);
2564d994 JK	29
	30	/*
	31	* Return a list of environment strings, suitable for use with
	32	* child_process.env, that can be passed to child programs to make use of the
	33	* temporary object directory.
	34	*/
	35	const char *tmp_objdir_env(const struct tmp_objdir );
	36
	37	/*
	38	* Finalize a temporary object directory by migrating its objects into the main
	39	* object database, removing the temporary directory, and freeing any
	40	* associated resources.
	41	*/
	42	int tmp_objdir_migrate(struct tmp_objdir *);
	43
	44	/*
	45	* Destroy a temporary object directory, discarding any objects it contains.
	46	*/
	47	int tmp_objdir_destroy(struct tmp_objdir *);
7b90ab46 EN	48
	49	/*
	50	* Remove all objects from the temporary object directory, while leaving it
	51	* around so more objects can be added.
	52	*/
	53	void tmp_objdir_discard_objects(struct tmp_objdir *);
2564d994 JK	54
	55	/*
	56	* Add the temporary object directory as an alternate object store in the
	57	* current process.
	58	*/
	59	void tmp_objdir_add_as_alternate(const struct tmp_objdir *);
	60
b3cecf49 NS	61	/*
	62	* Replaces the writable object store in the current process with the temporary
	63	* object directory and makes the former main object store an alternate.
	64	* If will_destroy is nonzero, the object directory may not be migrated.
	65	*/
	66	void tmp_objdir_replace_primary_odb(struct tmp_objdir *, int will_destroy);
	67
	68	/*
	69	* If the primary object database was replaced by a temporary object directory,
	70	* restore it to its original value while keeping the directory contents around.
	71	* Returns NULL if the primary object database was not replaced.
	72	*/
	73	struct tmp_objdir *tmp_objdir_unapply_primary_odb(void);
	74
	75	/*
	76	* Reapplies the former primary temporary object database, after potentially
	77	* changing its relative path.
	78	*/
	79	void tmp_objdir_reapply_primary_odb(struct tmp_objdir , const char old_cwd,
	80	const char *new_cwd);
	81
	82
2564d994	83	#endif /* TMP_OBJDIR_H */