worktree.h

   1 #ifndef WORKTREE_H
   2 #define WORKTREE_H
   3
   4 #include "cache.h"
   5 #include "refs.h"
   6
   7 struct strbuf;
   8
   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 */
  19 };
  20
  21 /*
  22  * Get the worktrees.  The primary worktree will always be the first returned,
  23  * and linked worktrees will follow in no particular order.
  24  *
  25  * The caller is responsible for freeing the memory from the returned
  26  * worktrees by calling free_worktrees().
  27  */
  28 struct worktree **get_worktrees(void);
  29
  30 /*
  31  * Returns 1 if linked worktrees exist, 0 otherwise.
  32  */
  33 int submodule_uses_worktrees(const char *path);
  34
  35 /*
  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.
  38  */
  39 const char *get_worktree_git_dir(const struct worktree *wt);
  40
  41 /*
  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.
  49  *
  50  * `prefix` should be the `prefix` handed to top-level Git commands along with
  51  * `argc` and `argv`.
  52  *
  53  * Return the worktree identified by `arg`, or NULL if not found.
  54  */
  55 struct worktree *find_worktree(struct worktree **list,
  56                                const char *prefix,
  57                                const char *arg);
  58
  59 /*
  60  * Return the worktree corresponding to `path`, or NULL if no such worktree
  61  * exists.
  62  */
  63 struct worktree *find_worktree_by_path(struct worktree **, const char *path);
  64
  65 /*
  66  * Return true if the given worktree is the main one.
  67  */
  68 int is_main_worktree(const struct worktree *wt);
  69
  70 /*
  71  * Return the reason string if the given worktree is locked or NULL
  72  * otherwise.
  73  */
  74 const char *worktree_lock_reason(struct worktree *wt);
  75
  76 #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
  77
  78 /*
  79  * Return zero if the worktree is in good condition. Error message is
  80  * returned if "errmsg" is not NULL.
  81  */
  82 int validate_worktree(const struct worktree *wt,
  83                       struct strbuf *errmsg,
  84                       unsigned flags);
  85
  86 /*
  87  * Update worktrees/xxx/gitdir with the new path.
  88  */
  89 void update_worktree_location(struct worktree *wt,
  90                               const char *path_);
  91
  92 /*
  93  * Free up the memory for worktree(s)
  94  */
  95 void free_worktrees(struct worktree **);
  96
  97 /*
  98  * Check if a per-worktree symref points to a ref in the main worktree
  99  * or any linked worktree, and return the worktree that holds the ref,
 100  * or NULL otherwise. The result may be destroyed by the next call.
 101  */
 102 const struct worktree *find_shared_symref(const char *symref,
 103                                           const char *target);
 104
 105 /*
 106  * Similar to head_ref() for all HEADs _except_ one from the current
 107  * worktree, which is covered by head_ref().
 108  */
 109 int other_head_refs(each_ref_fn fn, void *cb_data);
 110
 111 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
 112 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
 113
 114 /*
 115  * Similar to git_path() but can produce paths for a specified
 116  * worktree instead of current one
 117  */
 118 const char *worktree_git_path(const struct worktree *wt,
 119                               const char *fmt, ...)
 120         __attribute__((format (printf, 2, 3)));
 121
 122 /*
 123  * Parse a worktree ref (i.e. with prefix main-worktree/ or
 124  * worktrees/) and return the position of the worktree's name and
 125  * length (or NULL and zero if it's main worktree), and ref.
 126  *
 127  * All name, name_length and ref arguments could be NULL.
 128  */
 129 int parse_worktree_ref(const char *worktree_ref, const char **name,
 130                        int *name_length, const char **ref);
 131
 132 /*
 133  * Return a refname suitable for access from the current ref store.
 134  */
 135 void strbuf_worktree_ref(const struct worktree *wt,
 136                          struct strbuf *sb,
 137                          const char *refname);
 138
 139 /*
 140  * Return a refname suitable for access from the current ref
 141  * store. The result will be destroyed at the next call.
 142  */
 143 const char *worktree_ref(const struct worktree *wt,
 144                          const char *refname);
 145
 146 #endif