l10n: Update Catalan translation
[alt-git.git] / worktree.h
blobf38e6fd5a224fbe891f924df6b60a613b0b91638
1 #ifndef WORKTREE_H
2 #define WORKTREE_H
4 #include "cache.h"
5 #include "refs.h"
7 struct strbuf;
9 struct worktree {
10 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 int is_detached;
16 int is_bare;
17 int is_current;
18 int lock_reason_valid; /* private */
22 * Get the worktrees. The primary worktree will always be the first returned,
23 * and linked worktrees will follow in no particular order.
25 * The caller is responsible for freeing the memory from the returned
26 * worktrees by calling free_worktrees().
28 struct worktree **get_worktrees(void);
31 * Returns 1 if linked worktrees exist, 0 otherwise.
33 int submodule_uses_worktrees(const char *path);
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.
39 const char *get_worktree_git_dir(const struct worktree *wt);
42 * Search for the worktree identified unambiguously by `arg` -- typically
43 * supplied by the user via the command-line -- which may be a pathname or some
44 * shorthand uniquely identifying a worktree, thus making it convenient for the
45 * user to specify a worktree with minimal typing. For instance, if the last
46 * component (say, "foo") of a worktree's pathname is unique among worktrees
47 * (say, "work/foo" and "work/bar"), it can be used to identify the worktree
48 * unambiguously.
50 * `prefix` should be the `prefix` handed to top-level Git commands along with
51 * `argc` and `argv`.
53 * Return the worktree identified by `arg`, or NULL if not found.
55 struct worktree *find_worktree(struct worktree **list,
56 const char *prefix,
57 const char *arg);
60 * Return the worktree corresponding to `path`, or NULL if no such worktree
61 * exists.
63 struct worktree *find_worktree_by_path(struct worktree **, const char *path);
66 * Return true if the given worktree is the main one.
68 int is_main_worktree(const struct worktree *wt);
71 * Return the reason string if the given worktree is locked or NULL
72 * otherwise.
74 const char *worktree_lock_reason(struct worktree *wt);
76 #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
79 * Return zero if the worktree is in good condition. Error message is
80 * returned if "errmsg" is not NULL.
82 int validate_worktree(const struct worktree *wt,
83 struct strbuf *errmsg,
84 unsigned flags);
87 * Update worktrees/xxx/gitdir with the new path.
89 void update_worktree_location(struct worktree *wt,
90 const char *path_);
92 typedef void (* worktree_repair_fn)(int iserr, const char *path,
93 const char *msg, void *cb_data);
96 * Visit each registered linked worktree and repair corruptions. For each
97 * repair made or error encountered while attempting a repair, the callback
98 * function, if non-NULL, is called with the path of the worktree and a
99 * description of the repair or error, along with the callback user-data.
101 void repair_worktrees(worktree_repair_fn, void *cb_data);
104 * Repair administrative files corresponding to the worktree at the given path.
105 * The worktree's .git file pointing at the repository must be intact for the
106 * repair to succeed. Useful for re-associating an orphaned worktree with the
107 * repository if the worktree has been moved manually (without using "git
108 * worktree move"). For each repair made or error encountered while attempting
109 * a repair, the callback function, if non-NULL, is called with the path of the
110 * worktree and a description of the repair or error, along with the callback
111 * user-data.
113 void repair_worktree_at_path(const char *, worktree_repair_fn, void *cb_data);
116 * Free up the memory for worktree(s)
118 void free_worktrees(struct worktree **);
121 * Check if a per-worktree symref points to a ref in the main worktree
122 * or any linked worktree, and return the worktree that holds the ref,
123 * or NULL otherwise. The result may be destroyed by the next call.
125 const struct worktree *find_shared_symref(const char *symref,
126 const char *target);
129 * Similar to head_ref() for all HEADs _except_ one from the current
130 * worktree, which is covered by head_ref().
132 int other_head_refs(each_ref_fn fn, void *cb_data);
134 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
135 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
138 * Similar to git_path() but can produce paths for a specified
139 * worktree instead of current one
141 const char *worktree_git_path(const struct worktree *wt,
142 const char *fmt, ...)
143 __attribute__((format (printf, 2, 3)));
146 * Parse a worktree ref (i.e. with prefix main-worktree/ or
147 * worktrees/) and return the position of the worktree's name and
148 * length (or NULL and zero if it's main worktree), and ref.
150 * All name, name_length and ref arguments could be NULL.
152 int parse_worktree_ref(const char *worktree_ref, const char **name,
153 int *name_length, const char **ref);
156 * Return a refname suitable for access from the current ref store.
158 void strbuf_worktree_ref(const struct worktree *wt,
159 struct strbuf *sb,
160 const char *refname);
162 #endif