worktree.h 2.55 KB
Newer Older
1 2 3
#ifndef WORKTREE_H
#define WORKTREE_H

4 5
#include "refs.h"

6 7
struct worktree {
	char *path;
8
	char *id;
9
	char *head_ref;		/* NULL if HEAD is broken or detached */
10
	char *lock_reason;	/* internal use */
11
	struct object_id head_oid;
12 13
	int is_detached;
	int is_bare;
14
	int is_current;
15
	int lock_reason_valid;
16 17 18 19
};

/* Functions for acting on the information about worktrees. */

20 21
#define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */

22 23 24 25 26 27 28 29
/*
 * Get the worktrees.  The primary worktree will always be the first returned,
 * and linked worktrees will be pointed to by 'next' in each subsequent
 * worktree.  No specific ordering is done on the linked worktrees.
 *
 * The caller is responsible for freeing the memory from the returned
 * worktree(s).
 */
30
extern struct worktree **get_worktrees(unsigned flags);
31

32 33 34 35 36
/*
 * Returns 1 if linked worktrees exist, 0 otherwise.
 */
extern int submodule_uses_worktrees(const char *path);

37 38 39 40 41 42
/*
 * Return git dir of the worktree. Note that the path may be relative.
 * If wt is NULL, git dir of current worktree is returned.
 */
extern const char *get_worktree_git_dir(const struct worktree *wt);

Duy Nguyen's avatar
Duy Nguyen committed
43 44 45 46 47 48 49 50
/*
 * Search a worktree that can be unambiguously identified by
 * "arg". "prefix" must not be NULL.
 */
extern struct worktree *find_worktree(struct worktree **list,
				      const char *prefix,
				      const char *arg);

51 52 53 54 55
/*
 * Return true if the given worktree is the main one.
 */
extern int is_main_worktree(const struct worktree *wt);

56 57 58 59 60 61
/*
 * Return the reason string if the given worktree is locked or NULL
 * otherwise.
 */
extern const char *is_worktree_locked(struct worktree *wt);

62 63 64 65 66
/*
 * Free up the memory for worktree(s)
 */
extern void free_worktrees(struct worktree **);

67 68
/*
 * Check if a per-worktree symref points to a ref in the main worktree
69 70
 * or any linked worktree, and return the worktree that holds the ref,
 * or NULL otherwise. The result may be destroyed by the next call.
71
 */
72 73
extern const struct worktree *find_shared_symref(const char *symref,
						 const char *target);
74

75 76 77 78 79 80
/*
 * Similar to head_ref() for all HEADs _except_ one from the current
 * worktree, which is covered by head_ref().
 */
int other_head_refs(each_ref_fn fn, void *cb_data);

81 82 83
int is_worktree_being_rebased(const struct worktree *wt, const char *target);
int is_worktree_being_bisected(const struct worktree *wt, const char *target);

84 85 86 87 88 89 90 91
/*
 * Similar to git_path() but can produce paths for a specified
 * worktree instead of current one
 */
extern const char *worktree_git_path(const struct worktree *wt,
				     const char *fmt, ...)
	__attribute__((format (printf, 2, 3)));

92
#endif