Andrew's git - gitweb.git/blob

   1#ifndef WORKTREE_H
   2#define WORKTREE_H
   3
   4struct 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/*
  19 * Get the worktrees.  The primary worktree will always be the first returned,
  20 * and linked worktrees will be pointed to by 'next' in each subsequent
  21 * worktree.  No specific ordering is done on the linked worktrees.
  22 *
  23 * The caller is responsible for freeing the memory from the returned
  24 * worktree(s).
  25 */
  26extern struct worktree **get_worktrees(void);
  27
  28/*
  29 * Return git dir of the worktree. Note that the path may be relative.
  30 * If wt is NULL, git dir of current worktree is returned.
  31 */
  32extern const char *get_worktree_git_dir(const struct worktree *wt);
  33
  34/*
  35 * Search a worktree that can be unambiguously identified by
  36 * "arg". "prefix" must not be NULL.
  37 */
  38extern struct worktree *find_worktree(struct worktree **list,
  39                                      const char *prefix,
  40                                      const char *arg);
  41
  42/*
  43 * Return true if the given worktree is the main one.
  44 */
  45extern int is_main_worktree(const struct worktree *wt);
  46
  47/*
  48 * Return the reason string if the given worktree is locked or NULL
  49 * otherwise.
  50 */
  51extern const char *is_worktree_locked(struct worktree *wt);
  52
  53/*
  54 * Free up the memory for worktree(s)
  55 */
  56extern void free_worktrees(struct worktree **);
  57
  58/*
  59 * Check if a per-worktree symref points to a ref in the main worktree
  60 * or any linked worktree, and return the worktree that holds the ref,
  61 * or NULL otherwise. The result may be destroyed by the next call.
  62 */
  63extern const struct worktree *find_shared_symref(const char *symref,
  64                                                 const char *target);
  65
  66int is_worktree_being_rebased(const struct worktree *wt, const char *target);
  67int is_worktree_being_bisected(const struct worktree *wt, const char *target);
  68
  69/*
  70 * Similar to git_path() but can produce paths for a specified
  71 * worktree instead of current one
  72 */
  73extern const char *worktree_git_path(const struct worktree *wt,
  74                                     const char *fmt, ...)
  75        __attribute__((format (printf, 2, 3)));
  76
  77#endif