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         unsigned char head_sha1[20];
   9         int is_detached;
  10         int is_bare;
  11         int is_current;
  12 };
  13
  14 /* Functions for acting on the information about worktrees. */
  15
  16 /*
  17  * Get the worktrees.  The primary worktree will always be the first returned,
  18  * and linked worktrees will be pointed to by 'next' in each subsequent
  19  * worktree.  No specific ordering is done on the linked worktrees.
  20  *
  21  * The caller is responsible for freeing the memory from the returned
  22  * worktree(s).
  23  */
  24 extern struct worktree **get_worktrees(void);
  25
  26 /*
  27  * Return git dir of the worktree. Note that the path may be relative.
  28  * If wt is NULL, git dir of current worktree is returned.
  29  */
  30 extern const char *get_worktree_git_dir(const struct worktree *wt);
  31
  32 /*
  33  * Search a worktree that can be unambiguously identified by
  34  * "arg". "prefix" must not be NULL.
  35  */
  36 extern struct worktree *find_worktree(struct worktree **list,
  37                                       const char *prefix,
  38                                       const char *arg);
  39
  40 /*
  41  * Free up the memory for worktree(s)
  42  */
  43 extern void free_worktrees(struct worktree **);
  44
  45 /*
  46  * Check if a per-worktree symref points to a ref in the main worktree
  47  * or any linked worktree, and return the worktree that holds the ref,
  48  * or NULL otherwise. The result may be destroyed by the next call.
  49  */
  50 extern const struct worktree *find_shared_symref(const char *symref,
  51                                                  const char *target);
  52
  53 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
  54 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
  55
  56 /*
  57  * Similar to git_path() but can produce paths for a specified
  58  * worktree instead of current one
  59  */
  60 extern const char *worktree_git_path(const struct worktree *wt,
  61                                      const char *fmt, ...)
  62         __attribute__((format (printf, 2, 3)));
  63
  64 #endif