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

4
#include "cache.h"
5 6
#include "refs.h"

7 8
struct strbuf;

9 10
struct worktree {
	char *path;
11
	char *id;
12
	char *head_ref;		/* NULL if HEAD is broken or detached */
13
	char *lock_reason;	/* private - use worktree_lock_reason */
14
	struct object_id head_oid;
15 16
	int is_detached;
	int is_bare;
17
	int is_current;
18
	int lock_reason_valid; /* private */
19 20 21 22
};

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

23 24
#define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */

25 26 27 28 29 30 31 32
/*
 * 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).
 */
33
extern struct worktree **get_worktrees(unsigned flags);
34

35 36 37 38 39
/*
 * Returns 1 if linked worktrees exist, 0 otherwise.
 */
extern int submodule_uses_worktrees(const char *path);

40 41 42 43 44 45
/*
 * 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);

46 47 48 49 50 51 52 53
/*
 * 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);

54 55 56 57 58
/*
 * Return true if the given worktree is the main one.
 */
extern int is_main_worktree(const struct worktree *wt);

59 60 61 62
/*
 * Return the reason string if the given worktree is locked or NULL
 * otherwise.
 */
63
extern const char *worktree_lock_reason(struct worktree *wt);
64

65 66
#define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)

67 68 69 70 71
/*
 * Return zero if the worktree is in good condition. Error message is
 * returned if "errmsg" is not NULL.
 */
extern int validate_worktree(const struct worktree *wt,
72 73
			     struct strbuf *errmsg,
			     unsigned flags);
74

75 76 77 78 79 80
/*
 * Update worktrees/xxx/gitdir with the new path.
 */
extern void update_worktree_location(struct worktree *wt,
				     const char *path_);

81 82 83 84 85
/*
 * Free up the memory for worktree(s)
 */
extern void free_worktrees(struct worktree **);

86 87
/*
 * Check if a per-worktree symref points to a ref in the main worktree
88 89
 * or any linked worktree, and return the worktree that holds the ref,
 * or NULL otherwise. The result may be destroyed by the next call.
90
 */
91 92
extern const struct worktree *find_shared_symref(const char *symref,
						 const char *target);
93

94 95 96 97 98 99
/*
 * 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);

100 101 102
int is_worktree_being_rebased(const struct worktree *wt, const char *target);
int is_worktree_being_bisected(const struct worktree *wt, const char *target);

103 104 105 106 107 108 109 110
/*
 * 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)));

111 112 113 114 115 116 117 118 119
/*
 * Parse a worktree ref (i.e. with prefix main-worktree/ or
 * worktrees/) and return the position of the worktree's name and
 * length (or NULL and zero if it's main worktree), and ref.
 *
 * All name, name_length and ref arguments could be NULL.
 */
int parse_worktree_ref(const char *worktree_ref, const char **name,
		       int *name_length, const char **ref);
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

/*
 * Return a refname suitable for access from the current ref store.
 */
void strbuf_worktree_ref(const struct worktree *wt,
			 struct strbuf *sb,
			 const char *refname);

/*
 * Return a refname suitable for access from the current ref
 * store. The result will be destroyed at the next call.
 */
const char *worktree_ref(const struct worktree *wt,
			 const char *refname);

135
#endif