git.uis.cam.ac.uk - uis - git/git.git/blame_incremental

... / ...

Commit	Line	Data
	1	#ifndef WORKTREE_H
	2	#define WORKTREE_H
	3
	4	#include "refs.h"
	5
	6	struct strbuf;
	7
	8	struct worktree {
	9	char *path;
	10	char *id;
	11	char head_ref; / NULL if HEAD is broken or detached */
	12	char lock_reason; / internal use */
	13	struct object_id head_oid;
	14	int is_detached;
	15	int is_bare;
	16	int is_current;
	17	int lock_reason_valid;
	18	};
	19
	20	/* Functions for acting on the information about worktrees. */
	21
	22	#define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
	23
	24	/*
	25	* Get the worktrees. The primary worktree will always be the first returned,
	26	* and linked worktrees will be pointed to by 'next' in each subsequent
	27	* worktree. No specific ordering is done on the linked worktrees.
	28	*
	29	* The caller is responsible for freeing the memory from the returned
	30	* worktree(s).
	31	*/
	32	extern struct worktree **get_worktrees(unsigned flags);
	33
	34	/*
	35	* Returns 1 if linked worktrees exist, 0 otherwise.
	36	*/
	37	extern int submodule_uses_worktrees(const char *path);
	38
	39	/*
	40	* Return git dir of the worktree. Note that the path may be relative.
	41	* If wt is NULL, git dir of current worktree is returned.
	42	*/
	43	extern const char get_worktree_git_dir(const struct worktree wt);
	44
	45	/*
	46	* Search a worktree that can be unambiguously identified by
	47	* "arg". "prefix" must not be NULL.
	48	*/
	49	extern struct worktree find_worktree(struct worktree *list,
	50	const char *prefix,
	51	const char *arg);
	52
	53	/*
	54	* Return true if the given worktree is the main one.
	55	*/
	56	extern int is_main_worktree(const struct worktree *wt);
	57
	58	/*
	59	* Return the reason string if the given worktree is locked or NULL
	60	* otherwise.
	61	*/
	62	extern const char is_worktree_locked(struct worktree wt);
	63
	64	/*
	65	* Return zero if the worktree is in good condition. Error message is
	66	* returned if "errmsg" is not NULL.
	67	*/
	68	extern int validate_worktree(const struct worktree *wt,
	69	struct strbuf *errmsg);
	70
	71	/*
	72	* Free up the memory for worktree(s)
	73	*/
	74	extern void free_worktrees(struct worktree **);
	75
	76	/*
	77	* Check if a per-worktree symref points to a ref in the main worktree
	78	* or any linked worktree, and return the worktree that holds the ref,
	79	* or NULL otherwise. The result may be destroyed by the next call.
	80	*/
	81	extern const struct worktree find_shared_symref(const char symref,
	82	const char *target);
	83
	84	/*
	85	* Similar to head_ref() for all HEADs _except_ one from the current
	86	* worktree, which is covered by head_ref().
	87	*/
	88	int other_head_refs(each_ref_fn fn, void *cb_data);
	89
	90	int is_worktree_being_rebased(const struct worktree wt, const char target);
	91	int is_worktree_being_bisected(const struct worktree wt, const char target);
	92
	93	/*
	94	* Similar to git_path() but can produce paths for a specified
	95	* worktree instead of current one
	96	*/
	97	extern const char worktree_git_path(const struct worktree wt,
	98	const char *fmt, ...)
	99	__attribute__((format (printf, 2, 3)));
	100
	101	#endif