1 /*
2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 struct got_worktree;
18 
19 /* status codes */
20 #define GOT_STATUS_ADD		'A'
21 #define GOT_STATUS_EXISTS	'E'
22 #define GOT_STATUS_UPDATE	'U'
23 #define GOT_STATUS_DELETE	'D'
24 
25 /*
26  * Attempt to initialize a new work tree on disk.
27  * The first argument is the path to a directory where the work tree
28  * will be created. The path itself must not yet exist, but the dirname(3)
29  * of the path must already exist.
30  * The reference provided will be used to determine the new worktree's
31  * base commit. The third argument speficies the work tree's path prefix.
32  */
33 const struct got_error *got_worktree_init(const char *, struct got_reference *,
34     const char *, struct got_repository *);
35 
36 /*
37  * Attempt to open a worktree at the specified path.
38  * The caller must dispose of it with got_worktree_close().
39  */
40 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
41 
42 /* Dispose of an open work tree. */
43 void got_worktree_close(struct got_worktree *);
44 
45 /*
46  * Get the path to the repository associated with a worktree.
47  */
48 const char *got_worktree_get_repo_path(struct got_worktree *);
49 
50 /*
51  * Get the path prefix associated with a worktree.
52  */
53 const char *got_worktree_get_path_prefix(struct got_worktree *);
54 
55 /*
56  * Check if a user-provided path prefix matches that of the worktree.
57  */
58 const struct got_error *got_worktree_match_path_prefix(int *,
59     struct got_worktree *, const char *);
60 
61 /*
62  * Get the name of a work tree's HEAD reference.
63  * The caller must dispose of it with free(3).
64  */
65 char  *got_worktree_get_head_ref_name(struct got_worktree *);
66 
67 /*
68  * Get the work tree's HEAD reference.
69  * The caller must dispose of it with free(3).
70  */
71 struct got_reference *got_worktree_get_head_ref(struct got_worktree *);
72 
73 /*
74  * Get the current base commit ID of a worktree.
75  */
76 const struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
77 
78 /*
79  * Set the base commit Id of a worktree.
80  */
81 const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
82     struct got_repository *, struct got_object_id *);
83 
84 /* A callback function which is invoked when a path is checked out. */
85 typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
86 
87 /* A callback function which is invoked at cancellation points.
88  * May return GOT_ERR_CANCELLED to abort the runing operation. */
89 typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
90 
91 /*
92  * Attempt to check out files into a work tree from its associated repository
93  * and path prefix, and update the work tree's file index accordingly.
94  * File content is obtained from blobs within the work tree's path prefix
95  * inside the tree corresponding to the work tree's base commit.
96  * The checkout progress callback will be invoked with the provided
97  * void * argument, and the path of each checked out file.
98  */
99 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
100     struct got_repository *, got_worktree_checkout_cb progress, void *,
101     got_worktree_cancel_cb, void *);
102