mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
![Eric Sunshine](/assets/img/avatar_default.png)
find_worktree() employs heuristics to match user provided input -- which may be a pathname or some sort of shorthand -- with an actual worktree. Although this convenience allows a user to identify a worktree with minimal typing, the black-box nature of these heuristics makes it potentially difficult for callers which already know the exact path of a worktree to be confident that the correct worktree will be returned for any specific pathname (particularly a relative one), especially as the heuristics are enhanced and updated. Therefore, add a companion function, find_worktree_by_path(), which deterministically identifies a worktree strictly by pathname with no interpretation and no magic matching. Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
152 lines
4.4 KiB
C
152 lines
4.4 KiB
C
#ifndef WORKTREE_H
|
|
#define WORKTREE_H
|
|
|
|
#include "cache.h"
|
|
#include "refs.h"
|
|
|
|
struct strbuf;
|
|
|
|
struct worktree {
|
|
char *path;
|
|
char *id;
|
|
char *head_ref; /* NULL if HEAD is broken or detached */
|
|
char *lock_reason; /* private - use worktree_lock_reason */
|
|
struct object_id head_oid;
|
|
int is_detached;
|
|
int is_bare;
|
|
int is_current;
|
|
int lock_reason_valid; /* private */
|
|
};
|
|
|
|
/* Functions for acting on the information about worktrees. */
|
|
|
|
#define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
|
|
|
|
/*
|
|
* Get the worktrees. The primary worktree will always be the first returned,
|
|
* and linked worktrees will be pointed to by 'next' in each subsequent
|
|
* worktree. No specific ordering is done on the linked worktrees.
|
|
*
|
|
* The caller is responsible for freeing the memory from the returned
|
|
* worktree(s).
|
|
*/
|
|
struct worktree **get_worktrees(unsigned flags);
|
|
|
|
/*
|
|
* Returns 1 if linked worktrees exist, 0 otherwise.
|
|
*/
|
|
int submodule_uses_worktrees(const char *path);
|
|
|
|
/*
|
|
* Return git dir of the worktree. Note that the path may be relative.
|
|
* If wt is NULL, git dir of current worktree is returned.
|
|
*/
|
|
const char *get_worktree_git_dir(const struct worktree *wt);
|
|
|
|
/*
|
|
* Search for the worktree identified unambiguously by `arg` -- typically
|
|
* supplied by the user via the command-line -- which may be a pathname or some
|
|
* shorthand uniquely identifying a worktree, thus making it convenient for the
|
|
* user to specify a worktree with minimal typing. For instance, if the last
|
|
* component (say, "foo") of a worktree's pathname is unique among worktrees
|
|
* (say, "work/foo" and "work/bar"), it can be used to identify the worktree
|
|
* unambiguously.
|
|
*
|
|
* `prefix` should be the `prefix` handed to top-level Git commands along with
|
|
* `argc` and `argv`.
|
|
*
|
|
* Return the worktree identified by `arg`, or NULL if not found.
|
|
*/
|
|
struct worktree *find_worktree(struct worktree **list,
|
|
const char *prefix,
|
|
const char *arg);
|
|
|
|
/*
|
|
* Return the worktree corresponding to `path`, or NULL if no such worktree
|
|
* exists.
|
|
*/
|
|
struct worktree *find_worktree_by_path(struct worktree **, const char *path);
|
|
|
|
/*
|
|
* Return true if the given worktree is the main one.
|
|
*/
|
|
int is_main_worktree(const struct worktree *wt);
|
|
|
|
/*
|
|
* Return the reason string if the given worktree is locked or NULL
|
|
* otherwise.
|
|
*/
|
|
const char *worktree_lock_reason(struct worktree *wt);
|
|
|
|
#define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
|
|
|
|
/*
|
|
* Return zero if the worktree is in good condition. Error message is
|
|
* returned if "errmsg" is not NULL.
|
|
*/
|
|
int validate_worktree(const struct worktree *wt,
|
|
struct strbuf *errmsg,
|
|
unsigned flags);
|
|
|
|
/*
|
|
* Update worktrees/xxx/gitdir with the new path.
|
|
*/
|
|
void update_worktree_location(struct worktree *wt,
|
|
const char *path_);
|
|
|
|
/*
|
|
* Free up the memory for worktree(s)
|
|
*/
|
|
void free_worktrees(struct worktree **);
|
|
|
|
/*
|
|
* Check if a per-worktree symref points to a ref in the main worktree
|
|
* or any linked worktree, and return the worktree that holds the ref,
|
|
* or NULL otherwise. The result may be destroyed by the next call.
|
|
*/
|
|
const struct worktree *find_shared_symref(const char *symref,
|
|
const char *target);
|
|
|
|
/*
|
|
* Similar to head_ref() for all HEADs _except_ one from the current
|
|
* worktree, which is covered by head_ref().
|
|
*/
|
|
int other_head_refs(each_ref_fn fn, void *cb_data);
|
|
|
|
int is_worktree_being_rebased(const struct worktree *wt, const char *target);
|
|
int is_worktree_being_bisected(const struct worktree *wt, const char *target);
|
|
|
|
/*
|
|
* Similar to git_path() but can produce paths for a specified
|
|
* worktree instead of current one
|
|
*/
|
|
const char *worktree_git_path(const struct worktree *wt,
|
|
const char *fmt, ...)
|
|
__attribute__((format (printf, 2, 3)));
|
|
|
|
/*
|
|
* Parse a worktree ref (i.e. with prefix main-worktree/ or
|
|
* worktrees/) and return the position of the worktree's name and
|
|
* length (or NULL and zero if it's main worktree), and ref.
|
|
*
|
|
* All name, name_length and ref arguments could be NULL.
|
|
*/
|
|
int parse_worktree_ref(const char *worktree_ref, const char **name,
|
|
int *name_length, const char **ref);
|
|
|
|
/*
|
|
* Return a refname suitable for access from the current ref store.
|
|
*/
|
|
void strbuf_worktree_ref(const struct worktree *wt,
|
|
struct strbuf *sb,
|
|
const char *refname);
|
|
|
|
/*
|
|
* Return a refname suitable for access from the current ref
|
|
* store. The result will be destroyed at the next call.
|
|
*/
|
|
const char *worktree_ref(const struct worktree *wt,
|
|
const char *refname);
|
|
|
|
#endif
|