]>
Commit | Line | Data |
---|---|---|
ac6c561b MR |
1 | #ifndef WORKTREE_H |
2 | #define WORKTREE_H | |
3 | ||
d0c39a49 NTND |
4 | #include "refs.h" |
5 | ||
4ddddc1f NTND |
6 | struct strbuf; |
7 | ||
51934904 MR |
8 | struct worktree { |
9 | char *path; | |
69dfe3b9 | 10 | char *id; |
fa099d23 | 11 | char *head_ref; /* NULL if HEAD is broken or detached */ |
346ef530 | 12 | char *lock_reason; /* internal use */ |
0f05154c | 13 | struct object_id head_oid; |
92718b74 MR |
14 | int is_detached; |
15 | int is_bare; | |
750e8a60 | 16 | int is_current; |
346ef530 | 17 | int lock_reason_valid; |
51934904 MR |
18 | }; |
19 | ||
20 | /* Functions for acting on the information about worktrees. */ | |
21 | ||
4df1d4d4 NTND |
22 | #define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */ |
23 | ||
51934904 MR |
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 | */ | |
4fff1ef7 | 32 | extern struct worktree **get_worktrees(unsigned flags); |
51934904 | 33 | |
1a248cf2 SB |
34 | /* |
35 | * Returns 1 if linked worktrees exist, 0 otherwise. | |
36 | */ | |
37 | extern int submodule_uses_worktrees(const char *path); | |
38 | ||
69dfe3b9 NTND |
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 | ||
68353144 NTND |
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 | ||
984ad9e5 NTND |
53 | /* |
54 | * Return true if the given worktree is the main one. | |
55 | */ | |
56 | extern int is_main_worktree(const struct worktree *wt); | |
57 | ||
346ef530 NTND |
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 | ||
4ddddc1f NTND |
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 | ||
9c620fc7 NTND |
71 | /* |
72 | * Update worktrees/xxx/gitdir with the new path. | |
73 | */ | |
74 | extern void update_worktree_location(struct worktree *wt, | |
75 | const char *path_); | |
76 | ||
51934904 MR |
77 | /* |
78 | * Free up the memory for worktree(s) | |
79 | */ | |
80 | extern void free_worktrees(struct worktree **); | |
81 | ||
ac6c561b MR |
82 | /* |
83 | * Check if a per-worktree symref points to a ref in the main worktree | |
d3b9ac07 NTND |
84 | * or any linked worktree, and return the worktree that holds the ref, |
85 | * or NULL otherwise. The result may be destroyed by the next call. | |
ac6c561b | 86 | */ |
d3b9ac07 NTND |
87 | extern const struct worktree *find_shared_symref(const char *symref, |
88 | const char *target); | |
ac6c561b | 89 | |
d0c39a49 NTND |
90 | /* |
91 | * Similar to head_ref() for all HEADs _except_ one from the current | |
92 | * worktree, which is covered by head_ref(). | |
93 | */ | |
94 | int other_head_refs(each_ref_fn fn, void *cb_data); | |
95 | ||
14ace5b7 NTND |
96 | int is_worktree_being_rebased(const struct worktree *wt, const char *target); |
97 | int is_worktree_being_bisected(const struct worktree *wt, const char *target); | |
98 | ||
2e641d58 NTND |
99 | /* |
100 | * Similar to git_path() but can produce paths for a specified | |
101 | * worktree instead of current one | |
102 | */ | |
103 | extern const char *worktree_git_path(const struct worktree *wt, | |
104 | const char *fmt, ...) | |
105 | __attribute__((format (printf, 2, 3))); | |
106 | ||
ac6c561b | 107 | #endif |