summaryrefslogtreecommitdiff
path: root/worktree.h
diff options
context:
space:
mode:
Diffstat (limited to 'worktree.h')
-rw-r--r--worktree.h65
1 files changed, 45 insertions, 20 deletions
diff --git a/worktree.h b/worktree.h
index fe38ce10c3..caecc7a281 100644
--- a/worktree.h
+++ b/worktree.h
@@ -1,6 +1,7 @@
#ifndef WORKTREE_H
#define WORKTREE_H
+#include "cache.h"
#include "refs.h"
struct strbuf;
@@ -9,12 +10,12 @@ struct worktree {
char *path;
char *id;
char *head_ref; /* NULL if HEAD is broken or detached */
- char *lock_reason; /* internal use */
+ 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;
+ int lock_reason_valid; /* private */
};
/* Functions for acting on the information about worktrees. */
@@ -29,37 +30,37 @@ struct worktree {
* The caller is responsible for freeing the memory from the returned
* worktree(s).
*/
-extern struct worktree **get_worktrees(unsigned flags);
+struct worktree **get_worktrees(unsigned flags);
/*
* Returns 1 if linked worktrees exist, 0 otherwise.
*/
-extern int submodule_uses_worktrees(const char *path);
+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.
*/
-extern const char *get_worktree_git_dir(const struct worktree *wt);
+const char *get_worktree_git_dir(const struct worktree *wt);
/*
* Search a worktree that can be unambiguously identified by
* "arg". "prefix" must not be NULL.
*/
-extern struct worktree *find_worktree(struct worktree **list,
- const char *prefix,
- const char *arg);
+struct worktree *find_worktree(struct worktree **list,
+ const char *prefix,
+ const char *arg);
/*
* Return true if the given worktree is the main one.
*/
-extern int is_main_worktree(const struct worktree *wt);
+int is_main_worktree(const struct worktree *wt);
/*
* Return the reason string if the given worktree is locked or NULL
* otherwise.
*/
-extern const char *is_worktree_locked(struct worktree *wt);
+const char *worktree_lock_reason(struct worktree *wt);
#define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
@@ -67,28 +68,28 @@ extern const char *is_worktree_locked(struct worktree *wt);
* Return zero if the worktree is in good condition. Error message is
* returned if "errmsg" is not NULL.
*/
-extern int validate_worktree(const struct worktree *wt,
- struct strbuf *errmsg,
- unsigned flags);
+int validate_worktree(const struct worktree *wt,
+ struct strbuf *errmsg,
+ unsigned flags);
/*
* Update worktrees/xxx/gitdir with the new path.
*/
-extern void update_worktree_location(struct worktree *wt,
- const char *path_);
+void update_worktree_location(struct worktree *wt,
+ const char *path_);
/*
* Free up the memory for worktree(s)
*/
-extern void free_worktrees(struct worktree **);
+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.
*/
-extern const struct worktree *find_shared_symref(const char *symref,
- const char *target);
+const struct worktree *find_shared_symref(const char *symref,
+ const char *target);
/*
* Similar to head_ref() for all HEADs _except_ one from the current
@@ -103,8 +104,32 @@ 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
*/
-extern const char *worktree_git_path(const struct worktree *wt,
- const char *fmt, ...)
+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