test-lib-functions.sh: teach test_commit -C <dir>
[git/git.git] / worktree.h
1 #ifndef WORKTREE_H
2 #define WORKTREE_H
3
4 struct worktree {
5 char *path;
6 char *id;
7 char *head_ref;
8 char *lock_reason; /* internal use */
9 unsigned char head_sha1[20];
10 int is_detached;
11 int is_bare;
12 int is_current;
13 int lock_reason_valid;
14 };
15
16 /* Functions for acting on the information about worktrees. */
17
18 #define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
19
20 /*
21 * Get the worktrees. The primary worktree will always be the first returned,
22 * and linked worktrees will be pointed to by 'next' in each subsequent
23 * worktree. No specific ordering is done on the linked worktrees.
24 *
25 * The caller is responsible for freeing the memory from the returned
26 * worktree(s).
27 */
28 extern struct worktree **get_worktrees(unsigned flags);
29
30 /*
31 * Return git dir of the worktree. Note that the path may be relative.
32 * If wt is NULL, git dir of current worktree is returned.
33 */
34 extern const char *get_worktree_git_dir(const struct worktree *wt);
35
36 /*
37 * Search a worktree that can be unambiguously identified by
38 * "arg". "prefix" must not be NULL.
39 */
40 extern struct worktree *find_worktree(struct worktree **list,
41 const char *prefix,
42 const char *arg);
43
44 /*
45 * Return true if the given worktree is the main one.
46 */
47 extern int is_main_worktree(const struct worktree *wt);
48
49 /*
50 * Return the reason string if the given worktree is locked or NULL
51 * otherwise.
52 */
53 extern const char *is_worktree_locked(struct worktree *wt);
54
55 /*
56 * Free up the memory for worktree(s)
57 */
58 extern void free_worktrees(struct worktree **);
59
60 /*
61 * Check if a per-worktree symref points to a ref in the main worktree
62 * or any linked worktree, and return the worktree that holds the ref,
63 * or NULL otherwise. The result may be destroyed by the next call.
64 */
65 extern const struct worktree *find_shared_symref(const char *symref,
66 const char *target);
67
68 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
69 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
70
71 /*
72 * Similar to git_path() but can produce paths for a specified
73 * worktree instead of current one
74 */
75 extern const char *worktree_git_path(const struct worktree *wt,
76 const char *fmt, ...)
77 __attribute__((format (printf, 2, 3)));
78
79 #endif