transport-helper: drop read/write errno checks
[git.git] / worktree.h
blob9e3b0b7b6f9bd2aad3de9094febb8ad76aa45caf
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 */
21 /* Functions for acting on the information about worktrees. */
23 #define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
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.
30 * The caller is responsible for freeing the memory from the returned
31 * worktree(s).
33 extern struct worktree **get_worktrees(unsigned flags);
36 * Returns 1 if linked worktrees exist, 0 otherwise.
38 extern int submodule_uses_worktrees(const char *path);
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.
44 extern const char *get_worktree_git_dir(const struct worktree *wt);
47 * Search a worktree that can be unambiguously identified by
48 * "arg". "prefix" must not be NULL.
50 extern struct worktree *find_worktree(struct worktree **list,
51 const char *prefix,
52 const char *arg);
55 * Return true if the given worktree is the main one.
57 extern int is_main_worktree(const struct worktree *wt);
60 * Return the reason string if the given worktree is locked or NULL
61 * otherwise.
63 extern const char *worktree_lock_reason(struct worktree *wt);
65 #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
68 * Return zero if the worktree is in good condition. Error message is
69 * returned if "errmsg" is not NULL.
71 extern int validate_worktree(const struct worktree *wt,
72 struct strbuf *errmsg,
73 unsigned flags);
76 * Update worktrees/xxx/gitdir with the new path.
78 extern void update_worktree_location(struct worktree *wt,
79 const char *path_);
82 * Free up the memory for worktree(s)
84 extern void free_worktrees(struct worktree **);
87 * Check if a per-worktree symref points to a ref in the main worktree
88 * or any linked worktree, and return the worktree that holds the ref,
89 * or NULL otherwise. The result may be destroyed by the next call.
91 extern const struct worktree *find_shared_symref(const char *symref,
92 const char *target);
95 * Similar to head_ref() for all HEADs _except_ one from the current
96 * worktree, which is covered by head_ref().
98 int other_head_refs(each_ref_fn fn, void *cb_data);
100 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
101 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
104 * Similar to git_path() but can produce paths for a specified
105 * worktree instead of current one
107 extern const char *worktree_git_path(const struct worktree *wt,
108 const char *fmt, ...)
109 __attribute__((format (printf, 2, 3)));
112 * Parse a worktree ref (i.e. with prefix main-worktree/ or
113 * worktrees/) and return the position of the worktree's name and
114 * length (or NULL and zero if it's main worktree), and ref.
116 * All name, name_length and ref arguments could be NULL.
118 int parse_worktree_ref(const char *worktree_ref, const char **name,
119 int *name_length, const char **ref);
122 * Return a refname suitable for access from the current ref store.
124 void strbuf_worktree_ref(const struct worktree *wt,
125 struct strbuf *sb,
126 const char *refname);
129 * Return a refname suitable for access from the current ref
130 * store. The result will be destroyed at the next call.
132 const char *worktree_ref(const struct worktree *wt,
133 const char *refname);
135 #endif