]>
Commit | Line | Data |
---|---|---|
ac6c561b MR |
1 | #ifndef WORKTREE_H |
2 | #define WORKTREE_H | |
3 | ||
ef3ca954 | 4 | #include "cache.h" |
d0c39a49 NTND |
5 | #include "refs.h" |
6 | ||
4ddddc1f NTND |
7 | struct strbuf; |
8 | ||
51934904 MR |
9 | struct worktree { |
10 | char *path; | |
69dfe3b9 | 11 | char *id; |
fa099d23 | 12 | char *head_ref; /* NULL if HEAD is broken or detached */ |
d236f12b | 13 | char *lock_reason; /* private - use worktree_lock_reason */ |
0f05154c | 14 | struct object_id head_oid; |
92718b74 MR |
15 | int is_detached; |
16 | int is_bare; | |
750e8a60 | 17 | int is_current; |
e21cc076 | 18 | int lock_reason_valid; /* private */ |
51934904 MR |
19 | }; |
20 | ||
21 | /* Functions for acting on the information about worktrees. */ | |
22 | ||
4df1d4d4 NTND |
23 | #define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */ |
24 | ||
51934904 MR |
25 | /* |
26 | * Get the worktrees. The primary worktree will always be the first returned, | |
27 | * and linked worktrees will be pointed to by 'next' in each subsequent | |
28 | * worktree. No specific ordering is done on the linked worktrees. | |
29 | * | |
30 | * The caller is responsible for freeing the memory from the returned | |
31 | * worktree(s). | |
32 | */ | |
55454427 | 33 | struct worktree **get_worktrees(unsigned flags); |
51934904 | 34 | |
1a248cf2 SB |
35 | /* |
36 | * Returns 1 if linked worktrees exist, 0 otherwise. | |
37 | */ | |
55454427 | 38 | int submodule_uses_worktrees(const char *path); |
1a248cf2 | 39 | |
69dfe3b9 NTND |
40 | /* |
41 | * Return git dir of the worktree. Note that the path may be relative. | |
42 | * If wt is NULL, git dir of current worktree is returned. | |
43 | */ | |
55454427 | 44 | const char *get_worktree_git_dir(const struct worktree *wt); |
69dfe3b9 | 45 | |
68353144 | 46 | /* |
a80c4c22 ES |
47 | * Search for the worktree identified unambiguously by `arg` -- typically |
48 | * supplied by the user via the command-line -- which may be a pathname or some | |
49 | * shorthand uniquely identifying a worktree, thus making it convenient for the | |
50 | * user to specify a worktree with minimal typing. For instance, if the last | |
51 | * component (say, "foo") of a worktree's pathname is unique among worktrees | |
52 | * (say, "work/foo" and "work/bar"), it can be used to identify the worktree | |
53 | * unambiguously. | |
54 | * | |
55 | * `prefix` should be the `prefix` handed to top-level Git commands along with | |
56 | * `argc` and `argv`. | |
57 | * | |
58 | * Return the worktree identified by `arg`, or NULL if not found. | |
68353144 | 59 | */ |
55454427 | 60 | struct worktree *find_worktree(struct worktree **list, |
ad6dad09 DL |
61 | const char *prefix, |
62 | const char *arg); | |
68353144 | 63 | |
bb4995fc ES |
64 | /* |
65 | * Return the worktree corresponding to `path`, or NULL if no such worktree | |
66 | * exists. | |
67 | */ | |
68 | struct worktree *find_worktree_by_path(struct worktree **, const char *path); | |
69 | ||
984ad9e5 NTND |
70 | /* |
71 | * Return true if the given worktree is the main one. | |
72 | */ | |
55454427 | 73 | int is_main_worktree(const struct worktree *wt); |
984ad9e5 | 74 | |
346ef530 NTND |
75 | /* |
76 | * Return the reason string if the given worktree is locked or NULL | |
77 | * otherwise. | |
78 | */ | |
55454427 | 79 | const char *worktree_lock_reason(struct worktree *wt); |
346ef530 | 80 | |
ee6763af NTND |
81 | #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0) |
82 | ||
4ddddc1f NTND |
83 | /* |
84 | * Return zero if the worktree is in good condition. Error message is | |
85 | * returned if "errmsg" is not NULL. | |
86 | */ | |
55454427 | 87 | int validate_worktree(const struct worktree *wt, |
ad6dad09 DL |
88 | struct strbuf *errmsg, |
89 | unsigned flags); | |
4ddddc1f | 90 | |
9c620fc7 NTND |
91 | /* |
92 | * Update worktrees/xxx/gitdir with the new path. | |
93 | */ | |
55454427 | 94 | void update_worktree_location(struct worktree *wt, |
ad6dad09 | 95 | const char *path_); |
9c620fc7 | 96 | |
51934904 MR |
97 | /* |
98 | * Free up the memory for worktree(s) | |
99 | */ | |
55454427 | 100 | void free_worktrees(struct worktree **); |
51934904 | 101 | |
ac6c561b MR |
102 | /* |
103 | * Check if a per-worktree symref points to a ref in the main worktree | |
d3b9ac07 NTND |
104 | * or any linked worktree, and return the worktree that holds the ref, |
105 | * or NULL otherwise. The result may be destroyed by the next call. | |
ac6c561b | 106 | */ |
55454427 | 107 | const struct worktree *find_shared_symref(const char *symref, |
ad6dad09 | 108 | const char *target); |
ac6c561b | 109 | |
d0c39a49 NTND |
110 | /* |
111 | * Similar to head_ref() for all HEADs _except_ one from the current | |
112 | * worktree, which is covered by head_ref(). | |
113 | */ | |
114 | int other_head_refs(each_ref_fn fn, void *cb_data); | |
115 | ||
14ace5b7 NTND |
116 | int is_worktree_being_rebased(const struct worktree *wt, const char *target); |
117 | int is_worktree_being_bisected(const struct worktree *wt, const char *target); | |
118 | ||
2e641d58 NTND |
119 | /* |
120 | * Similar to git_path() but can produce paths for a specified | |
121 | * worktree instead of current one | |
122 | */ | |
b199d714 | 123 | const char *worktree_git_path(const struct worktree *wt, |
ad6dad09 | 124 | const char *fmt, ...) |
2e641d58 NTND |
125 | __attribute__((format (printf, 2, 3))); |
126 | ||
3a3b9d8c NTND |
127 | /* |
128 | * Parse a worktree ref (i.e. with prefix main-worktree/ or | |
129 | * worktrees/) and return the position of the worktree's name and | |
130 | * length (or NULL and zero if it's main worktree), and ref. | |
131 | * | |
132 | * All name, name_length and ref arguments could be NULL. | |
133 | */ | |
134 | int parse_worktree_ref(const char *worktree_ref, const char **name, | |
135 | int *name_length, const char **ref); | |
ab3e1f78 NTND |
136 | |
137 | /* | |
138 | * Return a refname suitable for access from the current ref store. | |
139 | */ | |
140 | void strbuf_worktree_ref(const struct worktree *wt, | |
141 | struct strbuf *sb, | |
142 | const char *refname); | |
143 | ||
144 | /* | |
145 | * Return a refname suitable for access from the current ref | |
146 | * store. The result will be destroyed at the next call. | |
147 | */ | |
148 | const char *worktree_ref(const struct worktree *wt, | |
149 | const char *refname); | |
150 | ||
ac6c561b | 151 | #endif |