2 * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
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.
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.
18 struct got_commitable;
19 struct got_commit_object;
23 #define GOT_STATUS_NO_CHANGE ' '
24 #define GOT_STATUS_ADD 'A'
25 #define GOT_STATUS_EXISTS 'E'
26 #define GOT_STATUS_UPDATE 'U'
27 #define GOT_STATUS_DELETE 'D'
28 #define GOT_STATUS_MODIFY 'M'
29 #define GOT_STATUS_CONFLICT 'C'
30 #define GOT_STATUS_MERGE 'G'
31 #define GOT_STATUS_MISSING '!'
32 #define GOT_STATUS_UNVERSIONED '?'
33 #define GOT_STATUS_OBSTRUCTED '~'
34 #define GOT_STATUS_REVERT 'R'
35 #define GOT_STATUS_CANNOT_DELETE 'd'
36 #define GOT_STATUS_BUMP_BASE 'b'
39 * Attempt to initialize a new work tree on disk.
40 * The first argument is the path to a directory where the work tree
41 * will be created. The path itself must not yet exist, but the dirname(3)
42 * of the path must already exist.
43 * The reference provided will be used to determine the new worktree's
44 * base commit. The third argument speficies the work tree's path prefix.
46 const struct got_error *got_worktree_init(const char *, struct got_reference *,
47 const char *, struct got_repository *);
50 * Attempt to open a worktree at or above the specified path.
51 * The caller must dispose of it with got_worktree_close().
53 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
55 /* Dispose of an open work tree. */
56 const struct got_error *got_worktree_close(struct got_worktree *);
59 * Get the path to the root directory of a worktree.
61 const char *got_worktree_get_root_path(struct got_worktree *);
64 * Get the path to the repository associated with a worktree.
66 const char *got_worktree_get_repo_path(struct got_worktree *);
69 * Get the path prefix associated with a worktree.
71 const char *got_worktree_get_path_prefix(struct got_worktree *);
74 * Check if a user-provided path prefix matches that of the worktree.
76 const struct got_error *got_worktree_match_path_prefix(int *,
77 struct got_worktree *, const char *);
80 * Get the name of a work tree's HEAD reference.
82 const char *got_worktree_get_head_ref_name(struct got_worktree *);
85 * Set the branch head reference of the work tree.
87 const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
88 struct got_reference *);
91 * Get the current base commit ID of a worktree.
93 struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
96 * Set the base commit Id of a worktree.
98 const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
99 struct got_repository *, struct got_object_id *);
101 /* A callback function which is invoked when a path is checked out. */
102 typedef const struct got_error *(*got_worktree_checkout_cb)(void *,
103 unsigned char, const char *);
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.
113 * It is possible to restrict the checkout operation to specific paths in
114 * the work tree, in which case all files outside those paths 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 * Allspecified paths are relative to the work tree's root. Pass a pathlist
120 * with a single empty path "" to check out files across the entire work tree.
122 * Some operations may refuse to run while the work tree contains files from
123 * multiple base commits.
125 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
126 struct got_pathlist_head *, struct got_repository *,
127 got_worktree_checkout_cb, void *, got_cancel_cb, void *);
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_cancel_cb, void *);
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, unsigned char, const char *, struct got_object_id *,
139 struct got_object_id *, struct got_object_id *);
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.
146 const struct got_error *got_worktree_status(struct got_worktree *,
147 struct got_pathlist_head *, struct got_repository *,
148 got_worktree_status_cb, void *, got_cancel_cb cancel_cb, void *);
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).
154 const struct got_error *got_worktree_resolve_path(char **,
155 struct got_worktree *, const char *);
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 *);
163 * Remove files from disk and schedule them 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.
167 const struct got_error *
168 got_worktree_schedule_delete(struct got_worktree *,
169 struct got_pathlist_head *, int, got_worktree_status_cb, void *,
170 struct got_repository *);
172 /* A callback function which is used to select or reject a patch. */
173 typedef const struct got_error *(*got_worktree_patch_cb)(int *, void *,
174 unsigned char, const char *, FILE *, int, int);
176 /* Values for result output parameter of got_wortree_patch_cb. */
177 #define GOT_PATCH_CHOICE_NONE 0
178 #define GOT_PATCH_CHOICE_YES 1
179 #define GOT_PATCH_CHOICE_NO 2
180 #define GOT_PATCH_CHOICE_QUIT 3
183 * Revert a file at the specified path such that it matches its
184 * original state in the worktree's base commit.
185 * If the patch callback is not NULL, call it to select patch hunks to
186 * revert. Otherwise, revert the whole file found at each path.
188 const struct got_error *got_worktree_revert(struct got_worktree *,
189 struct got_pathlist_head *, got_worktree_checkout_cb, void *,
190 got_worktree_patch_cb patch_cb, void *patch_arg,
191 struct got_repository *);
194 * A callback function which is invoked when a commit message is requested.
195 * Passes a pathlist with a struct got_commitable * in the data pointer of
196 * each element, a pointer to the log message that must be set by the
197 * callback and will be freed after committing, and an argument passed
198 * through to the callback.
200 typedef const struct got_error *(*got_worktree_commit_msg_cb)(
201 struct got_pathlist_head *, char **, void *);
204 * Create a new commit from changes in the work tree.
205 * Return the ID of the newly created commit.
206 * The worktree's base commit will be set to this new commit.
207 * Files unaffected by this commit operation will retain their
208 * current base commit.
209 * An author and a non-empty log message must be specified.
210 * The name of the committer is optional (may be NULL).
212 const struct got_error *got_worktree_commit(struct got_object_id **,
213 struct got_worktree *, struct got_pathlist_head *, const char *,
214 const char *, got_worktree_commit_msg_cb, void *,
215 got_worktree_status_cb, void *, struct got_repository *);
217 /* Get the path of a commitable worktree item. */
218 const char *got_commitable_get_path(struct got_commitable *);
220 /* Get the status of a commitable worktree item. */
221 unsigned int got_commitable_get_status(struct got_commitable *);
224 * Prepare for rebasing a branch onto the work tree's current branch.
225 * This function creates references to a temporary branch, the branch
226 * being rebased, and the work tree's current branch, under the
227 * "got/worktree/rebase/" namespace. These references are used to
228 * keep track of rebase operation state and are used as input and/or
229 * output arguments with other rebase-related functions.
230 * The function also returns a pointer to a fileindex which must be
231 * passed back to other rebase-related functions.
233 const struct got_error *got_worktree_rebase_prepare(struct got_reference **,
234 struct got_reference **, struct got_fileindex **, struct got_worktree *,
235 struct got_reference *, struct got_repository *);
238 * Continue an interrupted rebase operation.
239 * This function returns existing references created when rebase was prepared,
240 * and the ID of the commit currently being rebased. This should be called
241 * before either resuming or aborting a rebase operation.
242 * The function also returns a pointer to a fileindex which must be
243 * passed back to other rebase-related functions.
245 const struct got_error *got_worktree_rebase_continue(struct got_object_id **,
246 struct got_reference **, struct got_reference **, struct got_reference **,
247 struct got_fileindex **, struct got_worktree *, struct got_repository *);
249 /* Check whether a, potentially interrupted, rebase operation is in progress. */
250 const struct got_error *got_worktree_rebase_in_progress(int *,
251 struct got_worktree *);
254 * Merge changes from the commit currently being rebased into the work tree.
255 * Report affected files, including merge conflicts, via the specified
256 * progress callback. Also populate a list of affected paths which should
257 * be passed to got_worktree_rebase_commit() after a conflict-free merge.
258 * This list must be initialized with TAILQ_INIT() and disposed of with
259 * got_worktree_rebase_pathlist_free().
261 const struct got_error *got_worktree_rebase_merge_files(
262 struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
263 struct got_object_id *, struct got_object_id *, struct got_repository *,
264 got_worktree_checkout_cb, void *, got_cancel_cb, void *);
267 * Commit changes merged by got_worktree_rebase_merge_files() to a temporary
268 * branch and return the ID of the newly created commit. An optional list of
269 * merged paths can be provided; otherwise this function will perform a status
270 * crawl across the entire work tree to find paths to commit.
272 const struct got_error *got_worktree_rebase_commit(struct got_object_id **,
273 struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
274 struct got_reference *, struct got_commit_object *,
275 struct got_object_id *, struct got_repository *);
277 /* Free a list of merged paths from got_worktree_merge_files. */
278 void got_worktree_rebase_pathlist_free(struct got_pathlist_head *);
280 /* Postpone the rebase operation. Should be called after a merge conflict. */
281 const struct got_error *got_worktree_rebase_postpone(struct got_worktree *,
282 struct got_fileindex *);
285 * Complete the current rebase operation. This should be called once all
286 * commits have been rebased successfully.
288 const struct got_error *got_worktree_rebase_complete(struct got_worktree *,
289 struct got_fileindex *, struct got_reference *, struct got_reference *,
290 struct got_reference *, struct got_repository *);
293 * Abort the current rebase operation.
294 * Report reverted files via the specified progress callback.
296 const struct got_error *got_worktree_rebase_abort(struct got_worktree *,
297 struct got_fileindex *, struct got_repository *, struct got_reference *,
298 got_worktree_checkout_cb, void *);
301 * Prepare for editing the history of the work tree's current branch.
302 * This function creates references to a temporary branch, and the
303 * work tree's current branch, under the "got/worktree/histedit/" namespace.
304 * These references are used to keep track of histedit operation state and
305 * are used as input and/or output arguments with other histedit-related
308 const struct got_error *got_worktree_histedit_prepare(struct got_reference **,
309 struct got_reference **, struct got_object_id **, struct got_fileindex **,
310 struct got_worktree *, struct got_repository *);
313 * Continue an interrupted histedit operation.
314 * This function returns existing references created when histedit was
315 * prepared and the ID of the commit currently being edited.
316 * It should be called before resuming or aborting a histedit operation.
318 const struct got_error *got_worktree_histedit_continue(struct got_object_id **,
319 struct got_reference **, struct got_reference **, struct got_object_id **,
320 struct got_fileindex **, struct got_worktree *, struct got_repository *);
322 /* Check whether a histedit operation is in progress. */
323 const struct got_error *got_worktree_histedit_in_progress(int *,
324 struct got_worktree *);
327 * Merge changes from the commit currently being edited into the work tree.
328 * Report affected files, including merge conflicts, via the specified
329 * progress callback. Also populate a list of affected paths which should
330 * be passed to got_worktree_histedit_commit() after a conflict-free merge.
331 * This list must be initialized with TAILQ_INIT() and disposed of with
332 * got_worktree_rebase_pathlist_free().
334 const struct got_error *got_worktree_histedit_merge_files(
335 struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
336 struct got_object_id *, struct got_object_id *, struct got_repository *,
337 got_worktree_checkout_cb, void *, got_cancel_cb, void *);
340 * Commit changes merged by got_worktree_histedit_merge_files() to a temporary
341 * branch and return the ID of the newly created commit. An optional list of
342 * merged paths can be provided; otherwise this function will perform a status
343 * crawl across the entire work tree to find paths to commit.
344 * An optional log message can be provided which will be used instead of the
345 * commit's original message.
347 const struct got_error *got_worktree_histedit_commit(struct got_object_id **,
348 struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
349 struct got_reference *, struct got_commit_object *,
350 struct got_object_id *, const char *, struct got_repository *);
353 * Record the specified commit as skipped during histedit.
354 * This should be called for commits which get dropped or get folded into
355 * a subsequent commit.
357 const struct got_error *got_worktree_histedit_skip_commit(struct got_worktree *,
358 struct got_object_id *, struct got_repository *);
360 /* Postpone the histedit operation. */
361 const struct got_error *got_worktree_histedit_postpone(struct got_worktree *,
362 struct got_fileindex *);
365 * Complete the current histedit operation. This should be called once all
366 * commits have been edited successfully.
368 const struct got_error *got_worktree_histedit_complete(struct got_worktree *,
369 struct got_fileindex *, struct got_reference *, struct got_reference *,
370 struct got_repository *);
373 * Abort the current histedit operation.
374 * Report reverted files via the specified progress callback.
376 const struct got_error *got_worktree_histedit_abort(struct got_worktree *,
377 struct got_fileindex *, struct got_repository *, struct got_reference *,
378 struct got_object_id *, got_worktree_checkout_cb, void *);
380 /* Get the path to this work tree's histedit script file. */
381 const struct got_error *got_worktree_get_histedit_script_path(char **,
382 struct got_worktree *);
386 * Stage the specified paths for commit.
387 * If the patch callback is not NULL, call it to select patch hunks for
388 * staging. Otherwise, stage the full file content found at each path.
390 const struct got_error *got_worktree_stage(struct got_worktree *,
391 struct got_pathlist_head *, got_worktree_status_cb, void *,
392 got_worktree_patch_cb, void *, struct got_repository *);
395 * Merge staged changes for the specified paths back into the work tree
396 * and mark the paths as non-staged again.
398 const struct got_error *got_worktree_unstage(struct got_worktree *,
399 struct got_pathlist_head *, got_worktree_checkout_cb, void *,
400 got_worktree_patch_cb, void *, struct got_repository *);
