worktree.h

   1 #ifndef WORKTREE_H
   2 #define WORKTREE_H
   3
   4 struct worktree {
   5         char *path;
   6         char *id;
   7         char *head_ref;         /* NULL if HEAD is broken or detached */
   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  * Returns 1 if linked worktrees exist, 0 otherwise.
  32  */
  33 extern 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 extern const char *get_worktree_git_dir(const struct worktree *wt);
  40
  41 /*
  42  * Search a worktree that can be unambiguously identified by
  43  * "arg". "prefix" must not be NULL.
  44  */
  45 extern struct worktree *find_worktree(struct worktree **list,
  46                                       const char *prefix,
  47                                       const char *arg);
  48
  49 /*
  50  * Return true if the given worktree is the main one.
  51  */
  52 extern int is_main_worktree(const struct worktree *wt);
  53
  54 /*
  55  * Return the reason string if the given worktree is locked or NULL
  56  * otherwise.
  57  */
  58 extern const char *is_worktree_locked(struct worktree *wt);
  59
  60 /*
  61  * Free up the memory for worktree(s)
  62  */
  63 extern void free_worktrees(struct worktree **);
  64
  65 /*
  66  * Check if a per-worktree symref points to a ref in the main worktree
  67  * or any linked worktree, and return the worktree that holds the ref,
  68  * or NULL otherwise. The result may be destroyed by the next call.
  69  */
  70 extern const struct worktree *find_shared_symref(const char *symref,
  71                                                  const char *target);
  72
  73 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
  74 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
  75
  76 /*
  77  * Similar to git_path() but can produce paths for a specified
  78  * worktree instead of current one
  79  */
  80 extern const char *worktree_git_path(const struct worktree *wt,
  81                                      const char *fmt, ...)
  82         __attribute__((format (printf, 2, 3)));
  83
  84 #endif