Merge branch 'cp/git-flush-is-an-env-bool'
[alt-git.git] / worktree.h
blobf14784a2ff871c69e5b5e28466439201721407b2
1 #ifndef WORKTREE_H
2 #define WORKTREE_H
4 #include "refs.h"
6 struct strbuf;
8 struct worktree {
9 char *path;
10 char *id;
11 char *head_ref; /* NULL if HEAD is broken or detached */
12 char *lock_reason; /* private - use worktree_lock_reason */
13 char *prune_reason; /* private - use worktree_prune_reason */
14 struct object_id head_oid;
15 int is_detached;
16 int is_bare;
17 int is_current;
18 int lock_reason_valid; /* private */
19 int prune_reason_valid; /* private */
23 * Get the worktrees. The primary worktree will always be the first returned,
24 * and linked worktrees will follow in no particular order.
26 * The caller is responsible for freeing the memory from the returned
27 * worktrees by calling free_worktrees().
29 struct worktree **get_worktrees(void);
32 * Returns 1 if linked worktrees exist, 0 otherwise.
34 int submodule_uses_worktrees(const char *path);
37 * Return git dir of the worktree. Note that the path may be relative.
38 * If wt is NULL, git dir of current worktree is returned.
40 const char *get_worktree_git_dir(const struct worktree *wt);
43 * Search for the worktree identified unambiguously by `arg` -- typically
44 * supplied by the user via the command-line -- which may be a pathname or some
45 * shorthand uniquely identifying a worktree, thus making it convenient for the
46 * user to specify a worktree with minimal typing. For instance, if the last
47 * component (say, "foo") of a worktree's pathname is unique among worktrees
48 * (say, "work/foo" and "work/bar"), it can be used to identify the worktree
49 * unambiguously.
51 * `prefix` should be the `prefix` handed to top-level Git commands along with
52 * `argc` and `argv`.
54 * Return the worktree identified by `arg`, or NULL if not found.
56 struct worktree *find_worktree(struct worktree **list,
57 const char *prefix,
58 const char *arg);
61 * Look up the worktree corresponding to `id`, or NULL of no such worktree
62 * exists.
64 struct worktree *get_linked_worktree(const char *id,
65 int skip_reading_head);
68 * Return the worktree corresponding to `path`, or NULL if no such worktree
69 * exists.
71 struct worktree *find_worktree_by_path(struct worktree **, const char *path);
74 * Return true if the given worktree is the main one.
76 int is_main_worktree(const struct worktree *wt);
79 * Return the reason string if the given worktree is locked or NULL
80 * otherwise.
82 const char *worktree_lock_reason(struct worktree *wt);
85 * Return the reason string if the given worktree should be pruned, otherwise
86 * NULL if it should not be pruned. `expire` defines a grace period to prune
87 * the worktree when its path does not exist.
89 const char *worktree_prune_reason(struct worktree *wt, timestamp_t expire);
92 * Return true if worktree entry should be pruned, along with the reason for
93 * pruning. Otherwise, return false and the worktree's path in `wtpath`, or
94 * NULL if it cannot be determined. Caller is responsible for freeing
95 * returned path.
97 * `expire` defines a grace period to prune the worktree when its path
98 * does not exist.
100 int should_prune_worktree(const char *id,
101 struct strbuf *reason,
102 char **wtpath,
103 timestamp_t expire);
105 #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
108 * Return zero if the worktree is in good condition. Error message is
109 * returned if "errmsg" is not NULL.
111 int validate_worktree(const struct worktree *wt,
112 struct strbuf *errmsg,
113 unsigned flags);
116 * Update worktrees/xxx/gitdir with the new path.
118 void update_worktree_location(struct worktree *wt,
119 const char *path_);
121 typedef void (* worktree_repair_fn)(int iserr, const char *path,
122 const char *msg, void *cb_data);
125 * Visit each registered linked worktree and repair corruptions. For each
126 * repair made or error encountered while attempting a repair, the callback
127 * function, if non-NULL, is called with the path of the worktree and a
128 * description of the repair or error, along with the callback user-data.
130 void repair_worktrees(worktree_repair_fn, void *cb_data);
133 * Repair administrative files corresponding to the worktree at the given path.
134 * The worktree's .git file pointing at the repository must be intact for the
135 * repair to succeed. Useful for re-associating an orphaned worktree with the
136 * repository if the worktree has been moved manually (without using "git
137 * worktree move"). For each repair made or error encountered while attempting
138 * a repair, the callback function, if non-NULL, is called with the path of the
139 * worktree and a description of the repair or error, along with the callback
140 * user-data.
142 void repair_worktree_at_path(const char *, worktree_repair_fn, void *cb_data);
145 * Free up the memory for a worktree.
147 void free_worktree(struct worktree *);
150 * Free up the memory for worktree(s)
152 void free_worktrees(struct worktree **);
155 * Check if a per-worktree symref points to a ref in the main worktree
156 * or any linked worktree, and return the worktree that holds the ref,
157 * or NULL otherwise.
159 const struct worktree *find_shared_symref(struct worktree **worktrees,
160 const char *symref,
161 const char *target);
164 * Returns true if a symref points to a ref in a worktree.
166 int is_shared_symref(const struct worktree *wt,
167 const char *symref, const char *target);
170 * Similar to head_ref() for all HEADs _except_ one from the current
171 * worktree, which is covered by head_ref().
173 int other_head_refs(each_ref_fn fn, void *cb_data);
175 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
176 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
179 * Similar to git_path() but can produce paths for a specified
180 * worktree instead of current one
182 const char *worktree_git_path(const struct worktree *wt,
183 const char *fmt, ...)
184 __attribute__((format (printf, 2, 3)));
187 * Return a refname suitable for access from the current ref store.
189 void strbuf_worktree_ref(const struct worktree *wt,
190 struct strbuf *sb,
191 const char *refname);
194 * Enable worktree config for the first time. This will make the following
195 * adjustments:
197 * 1. Add extensions.worktreeConfig=true in the common config file.
199 * 2. If the common config file has a core.worktree value, then that value
200 * is moved to the main worktree's config.worktree file.
202 * 3. If the common config file has a core.bare enabled, then that value
203 * is moved to the main worktree's config.worktree file.
205 * If extensions.worktreeConfig is already true, then this method
206 * terminates early without any of the above steps. The existing config
207 * arrangement is assumed to be intentional.
209 * Returns 0 on success. Reports an error message and returns non-zero
210 * if any of these steps fail.
212 int init_worktree_config(struct repository *r);
214 #endif