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 struct got_commitable;
19 
20 /* status codes */
21 #define GOT_STATUS_NO_CHANGE	' '
22 #define GOT_STATUS_ADD		'A'
23 #define GOT_STATUS_EXISTS	'E'
24 #define GOT_STATUS_UPDATE	'U'
25 #define GOT_STATUS_DELETE	'D'
26 #define GOT_STATUS_MODIFY	'M'
27 #define GOT_STATUS_CONFLICT	'C'
28 #define GOT_STATUS_MERGE	'G'
29 #define GOT_STATUS_MISSING	'!'
30 #define GOT_STATUS_UNVERSIONED	'?'
31 #define GOT_STATUS_OBSTRUCTED	'~'
32 #define GOT_STATUS_REVERT	'R'
33 #define GOT_STATUS_CANNOT_DELETE 'd'
34 
35 /*
36  * Attempt to initialize a new work tree on disk.
37  * The first argument is the path to a directory where the work tree
38  * will be created. The path itself must not yet exist, but the dirname(3)
39  * of the path must already exist.
40  * The reference provided will be used to determine the new worktree's
41  * base commit. The third argument speficies the work tree's path prefix.
42  */
43 const struct got_error *got_worktree_init(const char *, struct got_reference *,
44     const char *, struct got_repository *);
45 
46 /*
47  * Attempt to open a worktree at or above the specified path.
48  * The caller must dispose of it with got_worktree_close().
49  */
50 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
51 
52 /* Dispose of an open work tree. */
53 const struct got_error *got_worktree_close(struct got_worktree *);
54 
55 /*
56  * Get the path to the root directory of a worktree.
57  */
58 const char *got_worktree_get_root_path(struct got_worktree *);
59 
60 /*
61  * Get the path to the repository associated with a worktree.
62  */
63 const char *got_worktree_get_repo_path(struct got_worktree *);
64 
65 /*
66  * Get the path prefix associated with a worktree.
67  */
68 const char *got_worktree_get_path_prefix(struct got_worktree *);
69 
70 /*
71  * Check if a user-provided path prefix matches that of the worktree.
72  */
73 const struct got_error *got_worktree_match_path_prefix(int *,
74     struct got_worktree *, const char *);
75 
76 /*
77  * Get the name of a work tree's HEAD reference.
78  */
79 const char *got_worktree_get_head_ref_name(struct got_worktree *);
80 
81 /*
82  * Set the branch head reference of the work tree.
83  */
84 const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
85     struct got_reference *);
86 
87 /*
88  * Get the current base commit ID of a worktree.
89  */
90 struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
91 
92 /*
93  * Set the base commit Id of a worktree.
94  */
95 const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
96     struct got_repository *, struct got_object_id *);
97 
98 /* A callback function which is invoked when a path is checked out. */
99 typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
100 
101 /* A callback function which is invoked at cancellation points.
102  * May return GOT_ERR_CANCELLED to abort the runing operation. */
103 typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
104 
105 /*
106  * Attempt to check out files into a work tree from its associated repository
107  * and path prefix, and update the work tree's file index accordingly.
108  * File content is obtained from blobs within the work tree's path prefix
109  * inside the tree corresponding to the work tree's base commit.
110  * The checkout progress callback will be invoked with the provided
111  * void * argument, and the path of each checked out file.
112  *
113  * It is possible to restrict the checkout operation to a specific path in
114  * the work tree, in which case all files outside this path will remain at
115  * their currently recorded base commit. Inconsistent base commits can be
116  * repaired later by running another update operation across the entire work
117  * tree. Inconsistent base-commits may also occur if this function runs into
118  * an error or if the checkout operation is cancelled by the cancel callback.
119  * The specified path is relative to the work tree's root. Pass "" to check
120  * out files across the entire work tree.
121  *
122  * Some operations may refuse to run while the work tree contains files from
123  * multiple base commits.
124  */
125 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
126     const char *, struct got_repository *, got_worktree_checkout_cb, void *,
127     got_worktree_cancel_cb, void *);
128 
129 /* Merge the differences between two commits into a work tree. */
130 const struct got_error *
131 got_worktree_merge_files(struct got_worktree *,
132     struct got_object_id *, struct got_object_id *,
133     struct got_repository *, got_worktree_checkout_cb, void *,
134     got_worktree_cancel_cb, void *);
135 
136 /* A callback function which is invoked to report a path's status. */
137 typedef const struct got_error *(*got_worktree_status_cb)(void *,
138     unsigned char, const char *, struct got_object_id *,
139     struct got_object_id *);
140 
141 /*
142  * Report the status of paths in the work tree.
143  * The status callback will be invoked with the provided void * argument,
144  * a path, and a corresponding status code.
145  */
146 const struct got_error *got_worktree_status(struct got_worktree *,
147     const char *, struct got_repository *, got_worktree_status_cb, void *,
148     got_worktree_cancel_cb cancel_cb, void *);
149 
150 /*
151  * Try to resolve a user-provided path to an on-disk path in the work tree.
152  * The caller must dispose of the resolved path with free(3).
153  */
154 const struct got_error *got_worktree_resolve_path(char **,
155     struct got_worktree *, const char *);
156 
157 /* Schedule files at on-disk paths for addition in the next commit. */
158 const struct got_error *got_worktree_schedule_add(struct got_worktree *,
159     struct got_pathlist_head *, got_worktree_status_cb, void *,
160     struct got_repository *);
161 
162 /*
163  * Remove a file from disk and schedule it to be deleted in the next commit.
164  * Don't allow deleting files with uncommitted modifications, unless the
165  * parameter 'delete_local_mods' is set.
166  */
167 const struct got_error *
168 got_worktree_schedule_delete(struct got_worktree *, const char *, int,
169    got_worktree_status_cb, void *, struct got_repository *);
170 
171 /*
172  * Revert a file at the specified path such that it matches its
173  * original state in the worktree's base commit.
174  */
175 const struct got_error *got_worktree_revert(struct got_worktree *,
176     const char *, got_worktree_checkout_cb, void *, struct got_repository *);
177 
178 /*
179  * A callback function which is invoked when a commit message is requested.
180  * Passes a pathlist with a struct got_commitable * in the data pointer of
181  * each element, a pointer to the log message that must be set by the
182  * callback and will be freed after committing, and an argument passed
183  * through to the callback.
184  */
185 typedef const struct got_error *(*got_worktree_commit_msg_cb)(
186     struct got_pathlist_head *, char **, void *);
187 
188 /*
189  * Create a new commit from changes in the work tree.
190  * Return the ID of the newly created commit.
191  * The worktree's base commit will be set to this new commit.
192  * Files unaffected by this commit operation will retain their
193  * current base commit.
194  * An author and a non-empty log message must be specified.
195  * The name of the committer is optional (may be NULL).
196  * If an on-disk path is specified, only commit changes at or within this path.
197  */
198 const struct got_error *got_worktree_commit(struct got_object_id **,
199     struct got_worktree *, const char *, const char *, const char *,
200     got_worktree_commit_msg_cb, void *,
201     got_worktree_status_cb, void *, struct got_repository *);
202 
203 /* Get the path of a commitable worktree item. */
204 const char *got_commitable_get_path(struct got_commitable *);
205 
206 /* Get the status of a commitable worktree item. */
207 unsigned int got_commitable_get_status(struct got_commitable *);