2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 86c3caaf 2018-03-09 stsp * Permission to use, copy, modify, and distribute this software for any
5 86c3caaf 2018-03-09 stsp * purpose with or without fee is hereby granted, provided that the above
6 86c3caaf 2018-03-09 stsp * copyright notice and this permission notice appear in all copies.
8 86c3caaf 2018-03-09 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 86c3caaf 2018-03-09 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 86c3caaf 2018-03-09 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 86c3caaf 2018-03-09 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 86c3caaf 2018-03-09 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 86c3caaf 2018-03-09 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 86c3caaf 2018-03-09 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 86c3caaf 2018-03-09 stsp struct got_worktree;
18 8656d6c4 2019-05-20 stsp struct got_commitable;
19 818c7501 2019-07-11 stsp struct got_commit_object;
20 3e3a69f1 2019-07-25 stsp struct got_fileindex;
22 eecfbcd1 2018-12-29 stsp /* status codes */
23 f8d1f275 2019-02-04 stsp #define GOT_STATUS_NO_CHANGE ' '
24 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_ADD 'A'
25 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_EXISTS 'E'
26 507dc3bb 2018-12-29 stsp #define GOT_STATUS_UPDATE 'U'
27 512f0d0e 2019-01-02 stsp #define GOT_STATUS_DELETE 'D'
28 276262e8 2019-02-08 stsp #define GOT_STATUS_MODIFY 'M'
29 1ebedb77 2019-10-19 stsp #define GOT_STATUS_MODE_CHANGE 'm'
30 6353ad76 2019-02-08 stsp #define GOT_STATUS_CONFLICT 'C'
31 6353ad76 2019-02-08 stsp #define GOT_STATUS_MERGE 'G'
32 f8d1f275 2019-02-04 stsp #define GOT_STATUS_MISSING '!'
33 f8d1f275 2019-02-04 stsp #define GOT_STATUS_UNVERSIONED '?'
34 0dbc2271 2019-02-05 stsp #define GOT_STATUS_OBSTRUCTED '~'
35 2a06fe5f 2019-08-24 stsp #define GOT_STATUS_NONEXISTENT 'N'
36 a129376b 2019-03-28 stsp #define GOT_STATUS_REVERT 'R'
37 2b92fad7 2019-06-02 stsp #define GOT_STATUS_CANNOT_DELETE 'd'
38 a484d721 2019-06-10 stsp #define GOT_STATUS_BUMP_BASE 'b'
39 7f47418f 2019-12-20 stsp #define GOT_STATUS_BASE_REF_ERR 'B'
40 5036ab18 2020-04-18 stsp #define GOT_STATUS_CANNOT_UPDATE '#'
43 0c60ce5a 2018-04-02 stsp * Attempt to initialize a new work tree on disk.
44 0c60ce5a 2018-04-02 stsp * The first argument is the path to a directory where the work tree
45 0c60ce5a 2018-04-02 stsp * will be created. The path itself must not yet exist, but the dirname(3)
46 0c60ce5a 2018-04-02 stsp * of the path must already exist.
47 93a30277 2018-12-24 stsp * The reference provided will be used to determine the new worktree's
48 93a30277 2018-12-24 stsp * base commit. The third argument speficies the work tree's path prefix.
50 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_init(const char *, struct got_reference *,
51 577ec78f 2018-03-11 stsp const char *, struct got_repository *);
54 247140b2 2019-02-05 stsp * Attempt to open a worktree at or above the specified path.
55 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_worktree_close().
57 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_open(struct got_worktree **, const char *);
59 0c60ce5a 2018-04-02 stsp /* Dispose of an open work tree. */
60 3a6ce05a 2019-02-11 stsp const struct got_error *got_worktree_close(struct got_worktree *);
63 c7f4312f 2019-02-05 stsp * Get the path to the root directory of a worktree.
65 c7f4312f 2019-02-05 stsp const char *got_worktree_get_root_path(struct got_worktree *);
68 0c60ce5a 2018-04-02 stsp * Get the path to the repository associated with a worktree.
70 2fbdb5ae 2018-12-29 stsp const char *got_worktree_get_repo_path(struct got_worktree *);
73 49520a32 2018-12-29 stsp * Get the path prefix associated with a worktree.
75 49520a32 2018-12-29 stsp const char *got_worktree_get_path_prefix(struct got_worktree *);
78 b2118c49 2020-07-28 stsp * Get the UUID of a work tree as a string.
79 b2118c49 2020-07-28 stsp * The caller must dispose of the returned UUID string with free(3).
81 b2118c49 2020-07-28 stsp const struct got_error *got_worktree_get_uuid(char **, struct got_worktree *);
84 e5dc7198 2018-12-29 stsp * Check if a user-provided path prefix matches that of the worktree.
86 e5dc7198 2018-12-29 stsp const struct got_error *got_worktree_match_path_prefix(int *,
87 e5dc7198 2018-12-29 stsp struct got_worktree *, const char *);
90 9587e6cc 2023-01-28 mark * Prefix for references pointing at base commit of backout/cherrypick commits.
91 9587e6cc 2023-01-28 mark * Reference path takes the form: PREFIX-WORKTREE_UUID-COMMIT_ID
93 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_CHERRYPICK_REF_PREFIX "refs/got/worktree/cherrypick"
94 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_BACKOUT_REF_PREFIX "refs/got/worktree/backout"
96 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_CHERRYPICK_REF_PREFIX_LEN \
97 9587e6cc 2023-01-28 mark sizeof(GOT_WORKTREE_CHERRYPICK_REF_PREFIX) - 1
98 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_BACKOUT_REF_PREFIX_LEN \
99 9587e6cc 2023-01-28 mark sizeof(GOT_WORKTREE_BACKOUT_REF_PREFIX) - 1
100 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_UUID_STRLEN 36
102 9587e6cc 2023-01-28 mark const struct got_error *got_worktree_get_logmsg_ref_name(char **,
103 9587e6cc 2023-01-28 mark struct got_worktree *, const char *);
105 0c60ce5a 2018-04-02 stsp * Get the name of a work tree's HEAD reference.
107 bc70eb79 2019-05-09 stsp const char *got_worktree_get_head_ref_name(struct got_worktree *);
110 024e9686 2019-05-14 stsp * Set the branch head reference of the work tree.
112 024e9686 2019-05-14 stsp const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
113 024e9686 2019-05-14 stsp struct got_reference *);
116 507dc3bb 2018-12-29 stsp * Get the current base commit ID of a worktree.
118 b72f483a 2019-02-05 stsp struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
121 507dc3bb 2018-12-29 stsp * Set the base commit Id of a worktree.
123 507dc3bb 2018-12-29 stsp const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
124 507dc3bb 2018-12-29 stsp struct got_repository *, struct got_object_id *);
127 50b0790e 2020-09-11 stsp * Obtain a parsed representation of this worktree's got.conf file.
128 50b0790e 2020-09-11 stsp * Return NULL if this configuration file could not be read.
130 50b0790e 2020-09-11 stsp const struct got_gotconfig *got_worktree_get_gotconfig(struct got_worktree *);
132 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
133 1ee397ad 2019-07-12 stsp typedef const struct got_error *(*got_worktree_checkout_cb)(void *,
134 1ee397ad 2019-07-12 stsp unsigned char, const char *);
136 f2a9dc41 2019-12-13 tracey /* A callback function which is invoked when a path is removed. */
137 f2a9dc41 2019-12-13 tracey typedef const struct got_error *(*got_worktree_delete_cb)(void *,
138 f2a9dc41 2019-12-13 tracey unsigned char, unsigned char, const char *);
141 0c60ce5a 2018-04-02 stsp * Attempt to check out files into a work tree from its associated repository
142 0c60ce5a 2018-04-02 stsp * and path prefix, and update the work tree's file index accordingly.
143 0c60ce5a 2018-04-02 stsp * File content is obtained from blobs within the work tree's path prefix
144 93a30277 2018-12-24 stsp * inside the tree corresponding to the work tree's base commit.
145 0c60ce5a 2018-04-02 stsp * The checkout progress callback will be invoked with the provided
146 0c60ce5a 2018-04-02 stsp * void * argument, and the path of each checked out file.
148 f2ea84fa 2019-07-27 stsp * It is possible to restrict the checkout operation to specific paths in
149 f2ea84fa 2019-07-27 stsp * the work tree, in which case all files outside those paths will remain at
150 c4cdcb68 2019-04-03 stsp * their currently recorded base commit. Inconsistent base commits can be
151 c4cdcb68 2019-04-03 stsp * repaired later by running another update operation across the entire work
152 c4cdcb68 2019-04-03 stsp * tree. Inconsistent base-commits may also occur if this function runs into
153 c4cdcb68 2019-04-03 stsp * an error or if the checkout operation is cancelled by the cancel callback.
154 f2ea84fa 2019-07-27 stsp * Allspecified paths are relative to the work tree's root. Pass a pathlist
155 f2ea84fa 2019-07-27 stsp * with a single empty path "" to check out files across the entire work tree.
157 c4cdcb68 2019-04-03 stsp * Some operations may refuse to run while the work tree contains files from
158 c4cdcb68 2019-04-03 stsp * multiple base commits.
160 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
161 f2ea84fa 2019-07-27 stsp struct got_pathlist_head *, struct got_repository *,
162 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
164 234035bc 2019-06-01 stsp /* Merge the differences between two commits into a work tree. */
165 234035bc 2019-06-01 stsp const struct got_error *
166 234035bc 2019-06-01 stsp got_worktree_merge_files(struct got_worktree *,
167 234035bc 2019-06-01 stsp struct got_object_id *, struct got_object_id *,
168 234035bc 2019-06-01 stsp struct got_repository *, got_worktree_checkout_cb, void *,
169 e6209546 2019-08-22 stsp got_cancel_cb, void *);
172 12463d8b 2019-12-13 stsp * A callback function which is invoked to report a file's status.
174 12463d8b 2019-12-13 stsp * If a valid directory file descriptor and a directory entry name are passed,
175 12463d8b 2019-12-13 stsp * these should be used to open the file instead of opening the file by path.
176 12463d8b 2019-12-13 stsp * This prevents race conditions if the filesystem is modified concurrently.
177 12463d8b 2019-12-13 stsp * If the directory descriptor is not available then its value will be -1.
179 b72f483a 2019-02-05 stsp typedef const struct got_error *(*got_worktree_status_cb)(void *,
180 88d0e355 2019-08-03 stsp unsigned char, unsigned char, const char *, struct got_object_id *,
181 12463d8b 2019-12-13 stsp struct got_object_id *, struct got_object_id *, int, const char *);
184 f8d1f275 2019-02-04 stsp * Report the status of paths in the work tree.
185 f8d1f275 2019-02-04 stsp * The status callback will be invoked with the provided void * argument,
186 f8d1f275 2019-02-04 stsp * a path, and a corresponding status code.
188 6c34b1aa 2019-03-18 stsp const struct got_error *got_worktree_status(struct got_worktree *,
189 f6343036 2021-06-22 stsp struct got_pathlist_head *, struct got_repository *, int no_ignores,
190 e6209546 2019-08-22 stsp got_worktree_status_cb, void *, got_cancel_cb cancel_cb, void *);
193 6c7ab921 2019-03-18 stsp * Try to resolve a user-provided path to an on-disk path in the work tree.
194 6c7ab921 2019-03-18 stsp * The caller must dispose of the resolved path with free(3).
196 6c7ab921 2019-03-18 stsp const struct got_error *got_worktree_resolve_path(char **,
197 6c7ab921 2019-03-18 stsp struct got_worktree *, const char *);
199 1dd54920 2019-05-11 stsp /* Schedule files at on-disk paths for addition in the next commit. */
200 031a5338 2019-03-26 stsp const struct got_error *got_worktree_schedule_add(struct got_worktree *,
201 4e68cba3 2019-11-23 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
202 022fae89 2019-12-06 tracey struct got_repository *, int);
205 17ed4618 2019-06-02 stsp * Remove files from disk and schedule them to be deleted in the next commit.
206 2ec1f75b 2019-03-26 stsp * Don't allow deleting files with uncommitted modifications, unless the
207 2ec1f75b 2019-03-26 stsp * parameter 'delete_local_mods' is set.
209 2ec1f75b 2019-03-26 stsp const struct got_error *
210 17ed4618 2019-06-02 stsp got_worktree_schedule_delete(struct got_worktree *,
211 766841c2 2020-08-13 stsp struct got_pathlist_head *, int, const char *,
212 4e12cd97 2022-01-25 stsp got_worktree_delete_cb, void *, struct got_repository *, int, int);
214 33aa809d 2019-08-08 stsp /* A callback function which is used to select or reject a patch. */
215 33aa809d 2019-08-08 stsp typedef const struct got_error *(*got_worktree_patch_cb)(int *, void *,
216 33aa809d 2019-08-08 stsp unsigned char, const char *, FILE *, int, int);
218 33aa809d 2019-08-08 stsp /* Values for result output parameter of got_wortree_patch_cb. */
219 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NONE 0
220 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_YES 1
221 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NO 2
222 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_QUIT 3
225 a129376b 2019-03-28 stsp * Revert a file at the specified path such that it matches its
226 a129376b 2019-03-28 stsp * original state in the worktree's base commit.
227 33aa809d 2019-08-08 stsp * If the patch callback is not NULL, call it to select patch hunks to
228 33aa809d 2019-08-08 stsp * revert. Otherwise, revert the whole file found at each path.
230 a129376b 2019-03-28 stsp const struct got_error *got_worktree_revert(struct got_worktree *,
231 e20a8b6f 2019-06-04 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
232 33aa809d 2019-08-08 stsp got_worktree_patch_cb patch_cb, void *patch_arg,
233 e20a8b6f 2019-06-04 stsp struct got_repository *);
236 33ad4cbe 2019-05-12 jcs * A callback function which is invoked when a commit message is requested.
237 8656d6c4 2019-05-20 stsp * Passes a pathlist with a struct got_commitable * in the data pointer of
238 2a47b1e5 2022-11-01 stsp * each element, the path to a file which contains a diff of changes to be
239 2a47b1e5 2022-11-01 stsp * committed (may be NULL), and a pointer to the log message that must be
240 2a47b1e5 2022-11-01 stsp * set by the callback and will be freed after committing, and an argument
241 2a47b1e5 2022-11-01 stsp * passed through to the callback.
243 33ad4cbe 2019-05-12 jcs typedef const struct got_error *(*got_worktree_commit_msg_cb)(
244 2a47b1e5 2022-11-01 stsp struct got_pathlist_head *, const char *, char **, void *);
247 c4296144 2019-05-09 stsp * Create a new commit from changes in the work tree.
248 c4296144 2019-05-09 stsp * Return the ID of the newly created commit.
249 c4296144 2019-05-09 stsp * The worktree's base commit will be set to this new commit.
250 c4296144 2019-05-09 stsp * Files unaffected by this commit operation will retain their
251 c4296144 2019-05-09 stsp * current base commit.
252 de18fc63 2019-05-09 stsp * An author and a non-empty log message must be specified.
253 de18fc63 2019-05-09 stsp * The name of the committer is optional (may be NULL).
254 35213c7c 2020-07-23 stsp * If a path to be committed contains a symlink which points outside
255 35213c7c 2020-07-23 stsp * of the path space under version control, raise an error unless
256 35213c7c 2020-07-23 stsp * committing of such paths is being forced by the caller.
258 de18fc63 2019-05-09 stsp const struct got_error *got_worktree_commit(struct got_object_id **,
259 5c1e53bc 2019-07-28 stsp struct got_worktree *, struct got_pathlist_head *, const char *,
260 12383673 2023-02-18 mark const char *, int, int, int, got_worktree_commit_msg_cb, void *,
261 33ad4cbe 2019-05-12 jcs got_worktree_status_cb, void *, struct got_repository *);
263 8656d6c4 2019-05-20 stsp /* Get the path of a commitable worktree item. */
264 8656d6c4 2019-05-20 stsp const char *got_commitable_get_path(struct got_commitable *);
266 8656d6c4 2019-05-20 stsp /* Get the status of a commitable worktree item. */
267 8656d6c4 2019-05-20 stsp unsigned int got_commitable_get_status(struct got_commitable *);
270 818c7501 2019-07-11 stsp * Prepare for rebasing a branch onto the work tree's current branch.
271 818c7501 2019-07-11 stsp * This function creates references to a temporary branch, the branch
272 818c7501 2019-07-11 stsp * being rebased, and the work tree's current branch, under the
273 818c7501 2019-07-11 stsp * "got/worktree/rebase/" namespace. These references are used to
274 818c7501 2019-07-11 stsp * keep track of rebase operation state and are used as input and/or
275 818c7501 2019-07-11 stsp * output arguments with other rebase-related functions.
276 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
277 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
279 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_prepare(struct got_reference **,
280 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_fileindex **, struct got_worktree *,
281 3e3a69f1 2019-07-25 stsp struct got_reference *, struct got_repository *);
284 818c7501 2019-07-11 stsp * Continue an interrupted rebase operation.
285 818c7501 2019-07-11 stsp * This function returns existing references created when rebase was prepared,
286 818c7501 2019-07-11 stsp * and the ID of the commit currently being rebased. This should be called
287 818c7501 2019-07-11 stsp * before either resuming or aborting a rebase operation.
288 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
289 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
291 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_continue(struct got_object_id **,
292 818c7501 2019-07-11 stsp struct got_reference **, struct got_reference **, struct got_reference **,
293 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
295 818c7501 2019-07-11 stsp /* Check whether a, potentially interrupted, rebase operation is in progress. */
296 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_in_progress(int *,
297 818c7501 2019-07-11 stsp struct got_worktree *);
300 818c7501 2019-07-11 stsp * Merge changes from the commit currently being rebased into the work tree.
301 818c7501 2019-07-11 stsp * Report affected files, including merge conflicts, via the specified
302 01757395 2019-07-12 stsp * progress callback. Also populate a list of affected paths which should
303 01757395 2019-07-12 stsp * be passed to got_worktree_rebase_commit() after a conflict-free merge.
304 01757395 2019-07-12 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
305 d8bacb93 2023-01-10 mark * got_pathlist_free(list, GOT_PATHLIST_FREE_PATH).
307 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_merge_files(
308 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
309 01757395 2019-07-12 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
310 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
313 01757395 2019-07-12 stsp * Commit changes merged by got_worktree_rebase_merge_files() to a temporary
314 01757395 2019-07-12 stsp * branch and return the ID of the newly created commit. An optional list of
315 01757395 2019-07-12 stsp * merged paths can be provided; otherwise this function will perform a status
316 01757395 2019-07-12 stsp * crawl across the entire work tree to find paths to commit.
318 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_commit(struct got_object_id **,
319 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
320 598eac43 2022-07-22 stsp struct got_reference *, const char *, struct got_commit_object *,
321 12383673 2023-02-18 mark struct got_object_id *, int, struct got_repository *);
323 818c7501 2019-07-11 stsp /* Postpone the rebase operation. Should be called after a merge conflict. */
324 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_rebase_postpone(struct got_worktree *,
325 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
328 818c7501 2019-07-11 stsp * Complete the current rebase operation. This should be called once all
329 818c7501 2019-07-11 stsp * commits have been rebased successfully.
330 e600f124 2021-03-21 stsp * The create_backup parameter controls whether the rebased branch will
331 e600f124 2021-03-21 stsp * be backed up via a reference in refs/got/backup/rebase/.
333 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_complete(struct got_worktree *,
334 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
335 ef85a376 2023-02-01 mark struct got_repository *, int create_backup);
338 818c7501 2019-07-11 stsp * Abort the current rebase operation.
339 818c7501 2019-07-11 stsp * Report reverted files via the specified progress callback.
341 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_abort(struct got_worktree *,
342 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
343 0ebf8283 2019-07-24 stsp got_worktree_checkout_cb, void *);
346 0ebf8283 2019-07-24 stsp * Prepare for editing the history of the work tree's current branch.
347 0ebf8283 2019-07-24 stsp * This function creates references to a temporary branch, and the
348 0ebf8283 2019-07-24 stsp * work tree's current branch, under the "got/worktree/histedit/" namespace.
349 0ebf8283 2019-07-24 stsp * These references are used to keep track of histedit operation state and
350 0ebf8283 2019-07-24 stsp * are used as input and/or output arguments with other histedit-related
351 0ebf8283 2019-07-24 stsp * functions.
353 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_prepare(struct got_reference **,
354 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_object_id **, struct got_fileindex **,
355 3e3a69f1 2019-07-25 stsp struct got_worktree *, struct got_repository *);
358 0ebf8283 2019-07-24 stsp * Continue an interrupted histedit operation.
359 0ebf8283 2019-07-24 stsp * This function returns existing references created when histedit was
360 0ebf8283 2019-07-24 stsp * prepared and the ID of the commit currently being edited.
361 0ebf8283 2019-07-24 stsp * It should be called before resuming or aborting a histedit operation.
363 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_continue(struct got_object_id **,
364 0ebf8283 2019-07-24 stsp struct got_reference **, struct got_reference **, struct got_object_id **,
365 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
367 0ebf8283 2019-07-24 stsp /* Check whether a histedit operation is in progress. */
368 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_in_progress(int *,
369 0ebf8283 2019-07-24 stsp struct got_worktree *);
372 0ebf8283 2019-07-24 stsp * Merge changes from the commit currently being edited into the work tree.
373 0ebf8283 2019-07-24 stsp * Report affected files, including merge conflicts, via the specified
374 0ebf8283 2019-07-24 stsp * progress callback. Also populate a list of affected paths which should
375 0ebf8283 2019-07-24 stsp * be passed to got_worktree_histedit_commit() after a conflict-free merge.
376 0ebf8283 2019-07-24 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
377 d8bacb93 2023-01-10 mark * got_pathlist_free(list, GOT_PATHLIST_FREE_PATH).
379 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_merge_files(
380 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
381 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
382 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
385 0ebf8283 2019-07-24 stsp * Commit changes merged by got_worktree_histedit_merge_files() to a temporary
386 0ebf8283 2019-07-24 stsp * branch and return the ID of the newly created commit. An optional list of
387 0ebf8283 2019-07-24 stsp * merged paths can be provided; otherwise this function will perform a status
388 0ebf8283 2019-07-24 stsp * crawl across the entire work tree to find paths to commit.
389 0ebf8283 2019-07-24 stsp * An optional log message can be provided which will be used instead of the
390 0ebf8283 2019-07-24 stsp * commit's original message.
392 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_commit(struct got_object_id **,
393 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
394 598eac43 2022-07-22 stsp struct got_reference *, const char *, struct got_commit_object *,
395 12383673 2023-02-18 mark struct got_object_id *, const char *, int, struct got_repository *);
398 0ebf8283 2019-07-24 stsp * Record the specified commit as skipped during histedit.
399 0ebf8283 2019-07-24 stsp * This should be called for commits which get dropped or get folded into
400 0ebf8283 2019-07-24 stsp * a subsequent commit.
402 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_skip_commit(struct got_worktree *,
403 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_repository *);
405 0ebf8283 2019-07-24 stsp /* Postpone the histedit operation. */
406 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_histedit_postpone(struct got_worktree *,
407 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
410 0ebf8283 2019-07-24 stsp * Complete the current histedit operation. This should be called once all
411 0ebf8283 2019-07-24 stsp * commits have been edited successfully.
413 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_complete(struct got_worktree *,
414 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
415 3e3a69f1 2019-07-25 stsp struct got_repository *);
418 0ebf8283 2019-07-24 stsp * Abort the current histedit operation.
419 0ebf8283 2019-07-24 stsp * Report reverted files via the specified progress callback.
421 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_abort(struct got_worktree *,
422 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
423 3e3a69f1 2019-07-25 stsp struct got_object_id *, got_worktree_checkout_cb, void *);
425 c3022ba5 2019-07-27 stsp /* Get the path to this work tree's histedit script file. */
426 c3022ba5 2019-07-27 stsp const struct got_error *got_worktree_get_histedit_script_path(char **,
427 0ebf8283 2019-07-24 stsp struct got_worktree *);
430 2822a352 2019-10-15 stsp * Prepare a work tree for integrating a branch.
431 2822a352 2019-10-15 stsp * Return pointers to a fileindex and locked references which must be
432 2822a352 2019-10-15 stsp * passed back to other integrate-related functions.
434 2822a352 2019-10-15 stsp const struct got_error *
435 2822a352 2019-10-15 stsp got_worktree_integrate_prepare(struct got_fileindex **,
436 abc59930 2021-09-05 naddy struct got_reference **, struct got_reference **,
437 2822a352 2019-10-15 stsp struct got_worktree *, const char *, struct got_repository *);
440 2822a352 2019-10-15 stsp * Carry out a prepared branch integration operation.
441 2822a352 2019-10-15 stsp * Report affected files via the specified progress callback.
443 2822a352 2019-10-15 stsp const struct got_error *got_worktree_integrate_continue(
444 2822a352 2019-10-15 stsp struct got_worktree *, struct got_fileindex *, struct got_repository *,
445 2822a352 2019-10-15 stsp struct got_reference *, struct got_reference *,
446 2822a352 2019-10-15 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
448 2822a352 2019-10-15 stsp /* Abort a prepared branch integration operation. */
449 2822a352 2019-10-15 stsp const struct got_error *got_worktree_integrate_abort(struct got_worktree *,
450 2822a352 2019-10-15 stsp struct got_fileindex *, struct got_repository *,
451 2822a352 2019-10-15 stsp struct got_reference *, struct got_reference *);
453 f259c4c1 2021-09-24 stsp /* Postpone the merge operation. Should be called after a merge conflict. */
454 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_postpone(struct got_worktree *,
455 f259c4c1 2021-09-24 stsp struct got_fileindex *);
457 f259c4c1 2021-09-24 stsp /* Merge changes from the merge source branch into the worktree. */
458 f259c4c1 2021-09-24 stsp const struct got_error *
459 f259c4c1 2021-09-24 stsp got_worktree_merge_branch(struct got_worktree *worktree,
460 f259c4c1 2021-09-24 stsp struct got_fileindex *fileindex,
461 f259c4c1 2021-09-24 stsp struct got_object_id *yca_commit_id,
462 f259c4c1 2021-09-24 stsp struct got_object_id *branch_tip,
463 f259c4c1 2021-09-24 stsp struct got_repository *repo, got_worktree_checkout_cb progress_cb,
464 f259c4c1 2021-09-24 stsp void *progress_arg, got_cancel_cb cancel_cb, void *cancel_arg);
466 f259c4c1 2021-09-24 stsp /* Attempt to commit merged changes. */
467 f259c4c1 2021-09-24 stsp const struct got_error *
468 f259c4c1 2021-09-24 stsp got_worktree_merge_commit(struct got_object_id **new_commit_id,
469 f259c4c1 2021-09-24 stsp struct got_worktree *worktree, struct got_fileindex *fileindex,
470 f259c4c1 2021-09-24 stsp const char *author, const char *committer, int allow_bad_symlinks,
471 f259c4c1 2021-09-24 stsp struct got_object_id *branch_tip, const char *branch_name,
472 12383673 2023-02-18 mark int allow_conflict, struct got_repository *repo,
473 0ff8d236 2021-09-28 stsp got_worktree_status_cb status_cb, void *status_arg);
476 f259c4c1 2021-09-24 stsp * Complete the merge operation.
477 f259c4c1 2021-09-24 stsp * This should be called once changes have been successfully committed.
479 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_complete(
480 f259c4c1 2021-09-24 stsp struct got_worktree *worktree, struct got_fileindex *fileindex,
481 f259c4c1 2021-09-24 stsp struct got_repository *repo);
483 f259c4c1 2021-09-24 stsp /* Check whether a merge operation is in progress. */
484 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_in_progress(int *,
485 f259c4c1 2021-09-24 stsp struct got_worktree *, struct got_repository *);
488 f259c4c1 2021-09-24 stsp * Prepare for merging a branch into the work tree's current branch.
489 f259c4c1 2021-09-24 stsp * This function creates a reference to the branch being merged, and to
490 f259c4c1 2021-09-24 stsp * this branch's current tip commit, in the "got/worktree/merge/" namespace.
491 f259c4c1 2021-09-24 stsp * These references are used to keep track of merge operation state and are
492 f259c4c1 2021-09-24 stsp * used as input and/or output arguments with other merge-related functions.
493 f259c4c1 2021-09-24 stsp * The function also returns a pointer to a fileindex which must be
494 f259c4c1 2021-09-24 stsp * passed back to other merge-related functions.
496 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_prepare(struct got_fileindex **,
497 f259c4c1 2021-09-24 stsp struct got_worktree *, struct got_reference *, struct got_repository *);
500 f259c4c1 2021-09-24 stsp * Continue an interrupted merge operation.
501 f259c4c1 2021-09-24 stsp * This function returns name of the branch being merged, and the ID of the
502 f259c4c1 2021-09-24 stsp * tip commit being merged.
503 f259c4c1 2021-09-24 stsp * This function should be called before either resuming or aborting a
504 f259c4c1 2021-09-24 stsp * merge operation.
505 f259c4c1 2021-09-24 stsp * The function also returns a pointer to a fileindex which must be
506 f259c4c1 2021-09-24 stsp * passed back to other merge-related functions.
508 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_continue(char **,
509 f259c4c1 2021-09-24 stsp struct got_object_id **, struct got_fileindex **,
510 f259c4c1 2021-09-24 stsp struct got_worktree *, struct got_repository *);
513 f259c4c1 2021-09-24 stsp * Abort the current rebase operation.
514 f259c4c1 2021-09-24 stsp * Report reverted files via the specified progress callback.
516 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_abort(struct got_worktree *,
517 f259c4c1 2021-09-24 stsp struct got_fileindex *, struct got_repository *,
518 f259c4c1 2021-09-24 stsp got_worktree_checkout_cb, void *);
521 fdfa9bf2 2019-08-03 stsp * Stage the specified paths for commit.
522 dc424a06 2019-08-07 stsp * If the patch callback is not NULL, call it to select patch hunks for
523 dc424a06 2019-08-07 stsp * staging. Otherwise, stage the full file content found at each path.
524 35213c7c 2020-07-23 stsp * If a path being staged contains a symlink which points outside
525 35213c7c 2020-07-23 stsp * of the path space under version control, raise an error unless
526 35213c7c 2020-07-23 stsp * staging of such paths is being forced by the caller.
528 1e71573e 2019-08-03 stsp const struct got_error *got_worktree_stage(struct got_worktree *,
529 1e71573e 2019-08-03 stsp struct got_pathlist_head *, got_worktree_status_cb, void *,
530 35213c7c 2020-07-23 stsp got_worktree_patch_cb, void *, int, struct got_repository *);
533 ad493afc 2019-08-03 stsp * Merge staged changes for the specified paths back into the work tree
534 ad493afc 2019-08-03 stsp * and mark the paths as non-staged again.
536 ad493afc 2019-08-03 stsp const struct got_error *got_worktree_unstage(struct got_worktree *,
537 ad493afc 2019-08-03 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
538 2e1f37b0 2019-08-08 stsp got_worktree_patch_cb, void *, struct got_repository *);
540 b2118c49 2020-07-28 stsp /* A callback function which is invoked with per-path info. */
541 b2118c49 2020-07-28 stsp typedef const struct got_error *(*got_worktree_path_info_cb)(void *,
542 b2118c49 2020-07-28 stsp const char *path, mode_t mode, time_t mtime,
543 b2118c49 2020-07-28 stsp struct got_object_id *blob_id, struct got_object_id *staged_blob_id,
544 b2118c49 2020-07-28 stsp struct got_object_id *commit_id);
547 b2118c49 2020-07-28 stsp * Report work-tree meta data for paths in the work tree.
548 b2118c49 2020-07-28 stsp * The info callback will be invoked with the provided void * argument,
549 b2118c49 2020-07-28 stsp * a path, and meta-data arguments (see got_worktree_path_info_cb).
551 b2118c49 2020-07-28 stsp const struct got_error *
552 b2118c49 2020-07-28 stsp got_worktree_path_info(struct got_worktree *, struct got_pathlist_head *,
553 b2118c49 2020-07-28 stsp got_worktree_path_info_cb, void *, got_cancel_cb , void *);
555 e600f124 2021-03-21 stsp /* References pointing at pre-rebase commit backups. */
556 e600f124 2021-03-21 stsp #define GOT_WORKTREE_REBASE_BACKUP_REF_PREFIX "refs/got/backup/rebase"
558 e600f124 2021-03-21 stsp /* References pointing at pre-histedit commit backups. */
559 e600f124 2021-03-21 stsp #define GOT_WORKTREE_HISTEDIT_BACKUP_REF_PREFIX "refs/got/backup/histedit"
562 78f5ac24 2022-03-19 op * Prepare for applying a patch.
564 78f5ac24 2022-03-19 op const struct got_error *
565 f2dd7807 2022-05-17 op got_worktree_patch_prepare(struct got_fileindex **, char **,
566 f2dd7807 2022-05-17 op struct got_worktree *);
569 78f5ac24 2022-03-19 op * Lookup paths for the "old" and "new" file before patching and check their
572 78f5ac24 2022-03-19 op const struct got_error *
573 78f5ac24 2022-03-19 op got_worktree_patch_check_path(const char *, const char *, char **, char **,
574 78f5ac24 2022-03-19 op struct got_worktree *, struct got_repository *, struct got_fileindex *);
576 f2dd7807 2022-05-17 op const struct got_error *
577 f2dd7807 2022-05-17 op got_worktree_patch_schedule_add(const char *, struct got_repository *,
578 f2dd7807 2022-05-17 op struct got_worktree *, struct got_fileindex *, got_worktree_checkout_cb,
581 f2dd7807 2022-05-17 op const struct got_error *
582 f2dd7807 2022-05-17 op got_worktree_patch_schedule_rm(const char *, struct got_repository *,
583 f2dd7807 2022-05-17 op struct got_worktree *, struct got_fileindex *, got_worktree_delete_cb,
586 78f5ac24 2022-03-19 op /* Complete the patch operation. */
587 78f5ac24 2022-03-19 op const struct got_error *
588 4bcdc895 2022-05-17 op got_worktree_patch_complete(struct got_fileindex *, const char *);
