refs: introduce get_worktree_ref_store()
[git/git.git] / worktree.h
CommitLineData
ac6c561b
MR
1#ifndef WORKTREE_H
2#define WORKTREE_H
3
51934904
MR
4struct worktree {
5 char *path;
69dfe3b9 6 char *id;
92718b74 7 char *head_ref;
346ef530 8 char *lock_reason; /* internal use */
92718b74
MR
9 unsigned char head_sha1[20];
10 int is_detached;
11 int is_bare;
750e8a60 12 int is_current;
346ef530 13 int lock_reason_valid;
51934904
MR
14};
15
16/* Functions for acting on the information about worktrees. */
17
4df1d4d4
NTND
18#define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
19
51934904
MR
20/*
21 * Get the worktrees. The primary worktree will always be the first returned,
22 * and linked worktrees will be pointed to by 'next' in each subsequent
23 * worktree. No specific ordering is done on the linked worktrees.
24 *
25 * The caller is responsible for freeing the memory from the returned
26 * worktree(s).
27 */
4fff1ef7 28extern struct worktree **get_worktrees(unsigned flags);
51934904 29
1a248cf2
SB
30/*
31 * Returns 1 if linked worktrees exist, 0 otherwise.
32 */
33extern int submodule_uses_worktrees(const char *path);
34
69dfe3b9
NTND
35/*
36 * Return git dir of the worktree. Note that the path may be relative.
37 * If wt is NULL, git dir of current worktree is returned.
38 */
39extern const char *get_worktree_git_dir(const struct worktree *wt);
40
68353144
NTND
41/*
42 * Search a worktree that can be unambiguously identified by
43 * "arg". "prefix" must not be NULL.
44 */
45extern struct worktree *find_worktree(struct worktree **list,
46 const char *prefix,
47 const char *arg);
48
984ad9e5
NTND
49/*
50 * Return true if the given worktree is the main one.
51 */
52extern int is_main_worktree(const struct worktree *wt);
53
346ef530
NTND
54/*
55 * Return the reason string if the given worktree is locked or NULL
56 * otherwise.
57 */
58extern const char *is_worktree_locked(struct worktree *wt);
59
51934904
MR
60/*
61 * Free up the memory for worktree(s)
62 */
63extern void free_worktrees(struct worktree **);
64
ac6c561b
MR
65/*
66 * Check if a per-worktree symref points to a ref in the main worktree
d3b9ac07
NTND
67 * or any linked worktree, and return the worktree that holds the ref,
68 * or NULL otherwise. The result may be destroyed by the next call.
ac6c561b 69 */
d3b9ac07
NTND
70extern const struct worktree *find_shared_symref(const char *symref,
71 const char *target);
ac6c561b 72
14ace5b7
NTND
73int is_worktree_being_rebased(const struct worktree *wt, const char *target);
74int is_worktree_being_bisected(const struct worktree *wt, const char *target);
75
2e641d58
NTND
76/*
77 * Similar to git_path() but can produce paths for a specified
78 * worktree instead of current one
79 */
80extern const char *worktree_git_path(const struct worktree *wt,
81 const char *fmt, ...)
82 __attribute__((format (printf, 2, 3)));
83
ac6c561b 84#endif