Blame


1 86c3caaf 2018-03-09 stsp /*
2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3 86c3caaf 2018-03-09 stsp *
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.
7 86c3caaf 2018-03-09 stsp *
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.
15 86c3caaf 2018-03-09 stsp */
16 86c3caaf 2018-03-09 stsp
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;
21 86c3caaf 2018-03-09 stsp
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 '#'
41 eecfbcd1 2018-12-29 stsp
42 0c60ce5a 2018-04-02 stsp /*
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.
49 0c60ce5a 2018-04-02 stsp */
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 *);
52 0c60ce5a 2018-04-02 stsp
53 0c60ce5a 2018-04-02 stsp /*
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().
56 0c60ce5a 2018-04-02 stsp */
57 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_open(struct got_worktree **, const char *);
58 0c60ce5a 2018-04-02 stsp
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 *);
61 0c60ce5a 2018-04-02 stsp
62 0c60ce5a 2018-04-02 stsp /*
63 c7f4312f 2019-02-05 stsp * Get the path to the root directory of a worktree.
64 c7f4312f 2019-02-05 stsp */
65 c7f4312f 2019-02-05 stsp const char *got_worktree_get_root_path(struct got_worktree *);
66 c7f4312f 2019-02-05 stsp
67 c7f4312f 2019-02-05 stsp /*
68 0c60ce5a 2018-04-02 stsp * Get the path to the repository associated with a worktree.
69 0c60ce5a 2018-04-02 stsp */
70 2fbdb5ae 2018-12-29 stsp const char *got_worktree_get_repo_path(struct got_worktree *);
71 0c60ce5a 2018-04-02 stsp
72 0c60ce5a 2018-04-02 stsp /*
73 49520a32 2018-12-29 stsp * Get the path prefix associated with a worktree.
74 49520a32 2018-12-29 stsp */
75 49520a32 2018-12-29 stsp const char *got_worktree_get_path_prefix(struct got_worktree *);
76 b2118c49 2020-07-28 stsp
77 b2118c49 2020-07-28 stsp /*
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).
80 b2118c49 2020-07-28 stsp */
81 b2118c49 2020-07-28 stsp const struct got_error *got_worktree_get_uuid(char **, struct got_worktree *);
82 49520a32 2018-12-29 stsp
83 49520a32 2018-12-29 stsp /*
84 e5dc7198 2018-12-29 stsp * Check if a user-provided path prefix matches that of the worktree.
85 e5dc7198 2018-12-29 stsp */
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 *);
88 e5dc7198 2018-12-29 stsp
89 e5dc7198 2018-12-29 stsp /*
90 0c60ce5a 2018-04-02 stsp * Get the name of a work tree's HEAD reference.
91 0c60ce5a 2018-04-02 stsp */
92 bc70eb79 2019-05-09 stsp const char *got_worktree_get_head_ref_name(struct got_worktree *);
93 0c60ce5a 2018-04-02 stsp
94 507dc3bb 2018-12-29 stsp /*
95 024e9686 2019-05-14 stsp * Set the branch head reference of the work tree.
96 024e9686 2019-05-14 stsp */
97 024e9686 2019-05-14 stsp const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
98 024e9686 2019-05-14 stsp struct got_reference *);
99 024e9686 2019-05-14 stsp
100 024e9686 2019-05-14 stsp /*
101 507dc3bb 2018-12-29 stsp * Get the current base commit ID of a worktree.
102 507dc3bb 2018-12-29 stsp */
103 b72f483a 2019-02-05 stsp struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
104 507dc3bb 2018-12-29 stsp
105 507dc3bb 2018-12-29 stsp /*
106 507dc3bb 2018-12-29 stsp * Set the base commit Id of a worktree.
107 507dc3bb 2018-12-29 stsp */
108 507dc3bb 2018-12-29 stsp const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
109 507dc3bb 2018-12-29 stsp struct got_repository *, struct got_object_id *);
110 507dc3bb 2018-12-29 stsp
111 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
112 1ee397ad 2019-07-12 stsp typedef const struct got_error *(*got_worktree_checkout_cb)(void *,
113 1ee397ad 2019-07-12 stsp unsigned char, const char *);
114 f2a9dc41 2019-12-13 tracey
115 f2a9dc41 2019-12-13 tracey /* A callback function which is invoked when a path is removed. */
116 f2a9dc41 2019-12-13 tracey typedef const struct got_error *(*got_worktree_delete_cb)(void *,
117 f2a9dc41 2019-12-13 tracey unsigned char, unsigned char, const char *);
118 0c60ce5a 2018-04-02 stsp
119 0c60ce5a 2018-04-02 stsp /*
120 0c60ce5a 2018-04-02 stsp * Attempt to check out files into a work tree from its associated repository
121 0c60ce5a 2018-04-02 stsp * and path prefix, and update the work tree's file index accordingly.
122 0c60ce5a 2018-04-02 stsp * File content is obtained from blobs within the work tree's path prefix
123 93a30277 2018-12-24 stsp * inside the tree corresponding to the work tree's base commit.
124 0c60ce5a 2018-04-02 stsp * The checkout progress callback will be invoked with the provided
125 0c60ce5a 2018-04-02 stsp * void * argument, and the path of each checked out file.
126 c4cdcb68 2019-04-03 stsp *
127 f2ea84fa 2019-07-27 stsp * It is possible to restrict the checkout operation to specific paths in
128 f2ea84fa 2019-07-27 stsp * the work tree, in which case all files outside those paths will remain at
129 c4cdcb68 2019-04-03 stsp * their currently recorded base commit. Inconsistent base commits can be
130 c4cdcb68 2019-04-03 stsp * repaired later by running another update operation across the entire work
131 c4cdcb68 2019-04-03 stsp * tree. Inconsistent base-commits may also occur if this function runs into
132 c4cdcb68 2019-04-03 stsp * an error or if the checkout operation is cancelled by the cancel callback.
133 f2ea84fa 2019-07-27 stsp * Allspecified paths are relative to the work tree's root. Pass a pathlist
134 f2ea84fa 2019-07-27 stsp * with a single empty path "" to check out files across the entire work tree.
135 c4cdcb68 2019-04-03 stsp *
136 c4cdcb68 2019-04-03 stsp * Some operations may refuse to run while the work tree contains files from
137 c4cdcb68 2019-04-03 stsp * multiple base commits.
138 0c60ce5a 2018-04-02 stsp */
139 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
140 f2ea84fa 2019-07-27 stsp struct got_pathlist_head *, struct got_repository *,
141 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
142 507dc3bb 2018-12-29 stsp
143 234035bc 2019-06-01 stsp /* Merge the differences between two commits into a work tree. */
144 234035bc 2019-06-01 stsp const struct got_error *
145 234035bc 2019-06-01 stsp got_worktree_merge_files(struct got_worktree *,
146 234035bc 2019-06-01 stsp struct got_object_id *, struct got_object_id *,
147 234035bc 2019-06-01 stsp struct got_repository *, got_worktree_checkout_cb, void *,
148 e6209546 2019-08-22 stsp got_cancel_cb, void *);
149 234035bc 2019-06-01 stsp
150 12463d8b 2019-12-13 stsp /*
151 12463d8b 2019-12-13 stsp * A callback function which is invoked to report a file's status.
152 12463d8b 2019-12-13 stsp *
153 12463d8b 2019-12-13 stsp * If a valid directory file descriptor and a directory entry name are passed,
154 12463d8b 2019-12-13 stsp * these should be used to open the file instead of opening the file by path.
155 12463d8b 2019-12-13 stsp * This prevents race conditions if the filesystem is modified concurrently.
156 12463d8b 2019-12-13 stsp * If the directory descriptor is not available then its value will be -1.
157 12463d8b 2019-12-13 stsp */
158 b72f483a 2019-02-05 stsp typedef const struct got_error *(*got_worktree_status_cb)(void *,
159 88d0e355 2019-08-03 stsp unsigned char, unsigned char, const char *, struct got_object_id *,
160 12463d8b 2019-12-13 stsp struct got_object_id *, struct got_object_id *, int, const char *);
161 f8d1f275 2019-02-04 stsp
162 f8d1f275 2019-02-04 stsp /*
163 f8d1f275 2019-02-04 stsp * Report the status of paths in the work tree.
164 f8d1f275 2019-02-04 stsp * The status callback will be invoked with the provided void * argument,
165 f8d1f275 2019-02-04 stsp * a path, and a corresponding status code.
166 f8d1f275 2019-02-04 stsp */
167 6c34b1aa 2019-03-18 stsp const struct got_error *got_worktree_status(struct got_worktree *,
168 72ea6654 2019-07-27 stsp struct got_pathlist_head *, struct got_repository *,
169 e6209546 2019-08-22 stsp got_worktree_status_cb, void *, got_cancel_cb cancel_cb, void *);
170 6c7ab921 2019-03-18 stsp
171 6c7ab921 2019-03-18 stsp /*
172 6c7ab921 2019-03-18 stsp * Try to resolve a user-provided path to an on-disk path in the work tree.
173 6c7ab921 2019-03-18 stsp * The caller must dispose of the resolved path with free(3).
174 6c7ab921 2019-03-18 stsp */
175 6c7ab921 2019-03-18 stsp const struct got_error *got_worktree_resolve_path(char **,
176 6c7ab921 2019-03-18 stsp struct got_worktree *, const char *);
177 d00136be 2019-03-26 stsp
178 1dd54920 2019-05-11 stsp /* Schedule files at on-disk paths for addition in the next commit. */
179 031a5338 2019-03-26 stsp const struct got_error *got_worktree_schedule_add(struct got_worktree *,
180 4e68cba3 2019-11-23 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
181 022fae89 2019-12-06 tracey struct got_repository *, int);
182 2ec1f75b 2019-03-26 stsp
183 2ec1f75b 2019-03-26 stsp /*
184 17ed4618 2019-06-02 stsp * Remove files from disk and schedule them to be deleted in the next commit.
185 2ec1f75b 2019-03-26 stsp * Don't allow deleting files with uncommitted modifications, unless the
186 2ec1f75b 2019-03-26 stsp * parameter 'delete_local_mods' is set.
187 2ec1f75b 2019-03-26 stsp */
188 2ec1f75b 2019-03-26 stsp const struct got_error *
189 17ed4618 2019-06-02 stsp got_worktree_schedule_delete(struct got_worktree *,
190 766841c2 2020-08-13 stsp struct got_pathlist_head *, int, const char *,
191 766841c2 2020-08-13 stsp got_worktree_delete_cb, void *, struct got_repository *, int);
192 a129376b 2019-03-28 stsp
193 33aa809d 2019-08-08 stsp /* A callback function which is used to select or reject a patch. */
194 33aa809d 2019-08-08 stsp typedef const struct got_error *(*got_worktree_patch_cb)(int *, void *,
195 33aa809d 2019-08-08 stsp unsigned char, const char *, FILE *, int, int);
196 33aa809d 2019-08-08 stsp
197 33aa809d 2019-08-08 stsp /* Values for result output parameter of got_wortree_patch_cb. */
198 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NONE 0
199 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_YES 1
200 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NO 2
201 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_QUIT 3
202 33aa809d 2019-08-08 stsp
203 a129376b 2019-03-28 stsp /*
204 a129376b 2019-03-28 stsp * Revert a file at the specified path such that it matches its
205 a129376b 2019-03-28 stsp * original state in the worktree's base commit.
206 33aa809d 2019-08-08 stsp * If the patch callback is not NULL, call it to select patch hunks to
207 33aa809d 2019-08-08 stsp * revert. Otherwise, revert the whole file found at each path.
208 a129376b 2019-03-28 stsp */
209 a129376b 2019-03-28 stsp const struct got_error *got_worktree_revert(struct got_worktree *,
210 e20a8b6f 2019-06-04 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
211 33aa809d 2019-08-08 stsp got_worktree_patch_cb patch_cb, void *patch_arg,
212 e20a8b6f 2019-06-04 stsp struct got_repository *);
213 c4296144 2019-05-09 stsp
214 c4296144 2019-05-09 stsp /*
215 33ad4cbe 2019-05-12 jcs * A callback function which is invoked when a commit message is requested.
216 8656d6c4 2019-05-20 stsp * Passes a pathlist with a struct got_commitable * in the data pointer of
217 8656d6c4 2019-05-20 stsp * each element, a pointer to the log message that must be set by the
218 8656d6c4 2019-05-20 stsp * callback and will be freed after committing, and an argument passed
219 8656d6c4 2019-05-20 stsp * through to the callback.
220 33ad4cbe 2019-05-12 jcs */
221 33ad4cbe 2019-05-12 jcs typedef const struct got_error *(*got_worktree_commit_msg_cb)(
222 33ad4cbe 2019-05-12 jcs struct got_pathlist_head *, char **, void *);
223 33ad4cbe 2019-05-12 jcs
224 33ad4cbe 2019-05-12 jcs /*
225 c4296144 2019-05-09 stsp * Create a new commit from changes in the work tree.
226 c4296144 2019-05-09 stsp * Return the ID of the newly created commit.
227 c4296144 2019-05-09 stsp * The worktree's base commit will be set to this new commit.
228 c4296144 2019-05-09 stsp * Files unaffected by this commit operation will retain their
229 c4296144 2019-05-09 stsp * current base commit.
230 de18fc63 2019-05-09 stsp * An author and a non-empty log message must be specified.
231 de18fc63 2019-05-09 stsp * The name of the committer is optional (may be NULL).
232 35213c7c 2020-07-23 stsp * If a path to be committed contains a symlink which points outside
233 35213c7c 2020-07-23 stsp * of the path space under version control, raise an error unless
234 35213c7c 2020-07-23 stsp * committing of such paths is being forced by the caller.
235 c4296144 2019-05-09 stsp */
236 de18fc63 2019-05-09 stsp const struct got_error *got_worktree_commit(struct got_object_id **,
237 5c1e53bc 2019-07-28 stsp struct got_worktree *, struct got_pathlist_head *, const char *,
238 35213c7c 2020-07-23 stsp const char *, int, got_worktree_commit_msg_cb, void *,
239 33ad4cbe 2019-05-12 jcs got_worktree_status_cb, void *, struct got_repository *);
240 8656d6c4 2019-05-20 stsp
241 8656d6c4 2019-05-20 stsp /* Get the path of a commitable worktree item. */
242 8656d6c4 2019-05-20 stsp const char *got_commitable_get_path(struct got_commitable *);
243 8656d6c4 2019-05-20 stsp
244 8656d6c4 2019-05-20 stsp /* Get the status of a commitable worktree item. */
245 8656d6c4 2019-05-20 stsp unsigned int got_commitable_get_status(struct got_commitable *);
246 818c7501 2019-07-11 stsp
247 818c7501 2019-07-11 stsp /*
248 818c7501 2019-07-11 stsp * Prepare for rebasing a branch onto the work tree's current branch.
249 818c7501 2019-07-11 stsp * This function creates references to a temporary branch, the branch
250 818c7501 2019-07-11 stsp * being rebased, and the work tree's current branch, under the
251 818c7501 2019-07-11 stsp * "got/worktree/rebase/" namespace. These references are used to
252 818c7501 2019-07-11 stsp * keep track of rebase operation state and are used as input and/or
253 818c7501 2019-07-11 stsp * output arguments with other rebase-related functions.
254 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
255 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
256 818c7501 2019-07-11 stsp */
257 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_prepare(struct got_reference **,
258 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_fileindex **, struct got_worktree *,
259 3e3a69f1 2019-07-25 stsp struct got_reference *, struct got_repository *);
260 818c7501 2019-07-11 stsp
261 818c7501 2019-07-11 stsp /*
262 818c7501 2019-07-11 stsp * Continue an interrupted rebase operation.
263 818c7501 2019-07-11 stsp * This function returns existing references created when rebase was prepared,
264 818c7501 2019-07-11 stsp * and the ID of the commit currently being rebased. This should be called
265 818c7501 2019-07-11 stsp * before either resuming or aborting a rebase operation.
266 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
267 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
268 818c7501 2019-07-11 stsp */
269 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_continue(struct got_object_id **,
270 818c7501 2019-07-11 stsp struct got_reference **, struct got_reference **, struct got_reference **,
271 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
272 818c7501 2019-07-11 stsp
273 818c7501 2019-07-11 stsp /* Check whether a, potentially interrupted, rebase operation is in progress. */
274 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_in_progress(int *,
275 818c7501 2019-07-11 stsp struct got_worktree *);
276 818c7501 2019-07-11 stsp
277 818c7501 2019-07-11 stsp /*
278 818c7501 2019-07-11 stsp * Merge changes from the commit currently being rebased into the work tree.
279 818c7501 2019-07-11 stsp * Report affected files, including merge conflicts, via the specified
280 01757395 2019-07-12 stsp * progress callback. Also populate a list of affected paths which should
281 01757395 2019-07-12 stsp * be passed to got_worktree_rebase_commit() after a conflict-free merge.
282 01757395 2019-07-12 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
283 01757395 2019-07-12 stsp * got_worktree_rebase_pathlist_free().
284 818c7501 2019-07-11 stsp */
285 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_merge_files(
286 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
287 01757395 2019-07-12 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
288 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
289 818c7501 2019-07-11 stsp
290 818c7501 2019-07-11 stsp /*
291 01757395 2019-07-12 stsp * Commit changes merged by got_worktree_rebase_merge_files() to a temporary
292 01757395 2019-07-12 stsp * branch and return the ID of the newly created commit. An optional list of
293 01757395 2019-07-12 stsp * merged paths can be provided; otherwise this function will perform a status
294 01757395 2019-07-12 stsp * crawl across the entire work tree to find paths to commit.
295 818c7501 2019-07-11 stsp */
296 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_commit(struct got_object_id **,
297 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
298 01757395 2019-07-12 stsp struct got_reference *, struct got_commit_object *,
299 818c7501 2019-07-11 stsp struct got_object_id *, struct got_repository *);
300 818c7501 2019-07-11 stsp
301 01757395 2019-07-12 stsp /* Free a list of merged paths from got_worktree_merge_files. */
302 01757395 2019-07-12 stsp void got_worktree_rebase_pathlist_free(struct got_pathlist_head *);
303 01757395 2019-07-12 stsp
304 818c7501 2019-07-11 stsp /* Postpone the rebase operation. Should be called after a merge conflict. */
305 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_rebase_postpone(struct got_worktree *,
306 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
307 818c7501 2019-07-11 stsp
308 818c7501 2019-07-11 stsp /*
309 818c7501 2019-07-11 stsp * Complete the current rebase operation. This should be called once all
310 818c7501 2019-07-11 stsp * commits have been rebased successfully.
311 818c7501 2019-07-11 stsp */
312 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_complete(struct got_worktree *,
313 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
314 3e3a69f1 2019-07-25 stsp struct got_reference *, struct got_repository *);
315 818c7501 2019-07-11 stsp
316 818c7501 2019-07-11 stsp /*
317 818c7501 2019-07-11 stsp * Abort the current rebase operation.
318 818c7501 2019-07-11 stsp * Report reverted files via the specified progress callback.
319 818c7501 2019-07-11 stsp */
320 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_abort(struct got_worktree *,
321 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
322 0ebf8283 2019-07-24 stsp got_worktree_checkout_cb, void *);
323 0ebf8283 2019-07-24 stsp
324 0ebf8283 2019-07-24 stsp /*
325 0ebf8283 2019-07-24 stsp * Prepare for editing the history of the work tree's current branch.
326 0ebf8283 2019-07-24 stsp * This function creates references to a temporary branch, and the
327 0ebf8283 2019-07-24 stsp * work tree's current branch, under the "got/worktree/histedit/" namespace.
328 0ebf8283 2019-07-24 stsp * These references are used to keep track of histedit operation state and
329 0ebf8283 2019-07-24 stsp * are used as input and/or output arguments with other histedit-related
330 0ebf8283 2019-07-24 stsp * functions.
331 0ebf8283 2019-07-24 stsp */
332 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_prepare(struct got_reference **,
333 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_object_id **, struct got_fileindex **,
334 3e3a69f1 2019-07-25 stsp struct got_worktree *, struct got_repository *);
335 0ebf8283 2019-07-24 stsp
336 0ebf8283 2019-07-24 stsp /*
337 0ebf8283 2019-07-24 stsp * Continue an interrupted histedit operation.
338 0ebf8283 2019-07-24 stsp * This function returns existing references created when histedit was
339 0ebf8283 2019-07-24 stsp * prepared and the ID of the commit currently being edited.
340 0ebf8283 2019-07-24 stsp * It should be called before resuming or aborting a histedit operation.
341 0ebf8283 2019-07-24 stsp */
342 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_continue(struct got_object_id **,
343 0ebf8283 2019-07-24 stsp struct got_reference **, struct got_reference **, struct got_object_id **,
344 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
345 0ebf8283 2019-07-24 stsp
346 0ebf8283 2019-07-24 stsp /* Check whether a histedit operation is in progress. */
347 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_in_progress(int *,
348 0ebf8283 2019-07-24 stsp struct got_worktree *);
349 0ebf8283 2019-07-24 stsp
350 0ebf8283 2019-07-24 stsp /*
351 0ebf8283 2019-07-24 stsp * Merge changes from the commit currently being edited into the work tree.
352 0ebf8283 2019-07-24 stsp * Report affected files, including merge conflicts, via the specified
353 0ebf8283 2019-07-24 stsp * progress callback. Also populate a list of affected paths which should
354 0ebf8283 2019-07-24 stsp * be passed to got_worktree_histedit_commit() after a conflict-free merge.
355 0ebf8283 2019-07-24 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
356 0ebf8283 2019-07-24 stsp * got_worktree_rebase_pathlist_free().
357 0ebf8283 2019-07-24 stsp */
358 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_merge_files(
359 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
360 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
361 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
362 0ebf8283 2019-07-24 stsp
363 0ebf8283 2019-07-24 stsp /*
364 0ebf8283 2019-07-24 stsp * Commit changes merged by got_worktree_histedit_merge_files() to a temporary
365 0ebf8283 2019-07-24 stsp * branch and return the ID of the newly created commit. An optional list of
366 0ebf8283 2019-07-24 stsp * merged paths can be provided; otherwise this function will perform a status
367 0ebf8283 2019-07-24 stsp * crawl across the entire work tree to find paths to commit.
368 0ebf8283 2019-07-24 stsp * An optional log message can be provided which will be used instead of the
369 0ebf8283 2019-07-24 stsp * commit's original message.
370 0ebf8283 2019-07-24 stsp */
371 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_commit(struct got_object_id **,
372 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
373 0ebf8283 2019-07-24 stsp struct got_reference *, struct got_commit_object *,
374 0ebf8283 2019-07-24 stsp struct got_object_id *, const char *, struct got_repository *);
375 0ebf8283 2019-07-24 stsp
376 0ebf8283 2019-07-24 stsp /*
377 0ebf8283 2019-07-24 stsp * Record the specified commit as skipped during histedit.
378 0ebf8283 2019-07-24 stsp * This should be called for commits which get dropped or get folded into
379 0ebf8283 2019-07-24 stsp * a subsequent commit.
380 0ebf8283 2019-07-24 stsp */
381 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_skip_commit(struct got_worktree *,
382 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_repository *);
383 0ebf8283 2019-07-24 stsp
384 0ebf8283 2019-07-24 stsp /* Postpone the histedit operation. */
385 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_histedit_postpone(struct got_worktree *,
386 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
387 0ebf8283 2019-07-24 stsp
388 0ebf8283 2019-07-24 stsp /*
389 0ebf8283 2019-07-24 stsp * Complete the current histedit operation. This should be called once all
390 0ebf8283 2019-07-24 stsp * commits have been edited successfully.
391 0ebf8283 2019-07-24 stsp */
392 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_complete(struct got_worktree *,
393 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
394 3e3a69f1 2019-07-25 stsp struct got_repository *);
395 0ebf8283 2019-07-24 stsp
396 0ebf8283 2019-07-24 stsp /*
397 0ebf8283 2019-07-24 stsp * Abort the current histedit operation.
398 0ebf8283 2019-07-24 stsp * Report reverted files via the specified progress callback.
399 0ebf8283 2019-07-24 stsp */
400 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_abort(struct got_worktree *,
401 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
402 3e3a69f1 2019-07-25 stsp struct got_object_id *, got_worktree_checkout_cb, void *);
403 0ebf8283 2019-07-24 stsp
404 c3022ba5 2019-07-27 stsp /* Get the path to this work tree's histedit script file. */
405 c3022ba5 2019-07-27 stsp const struct got_error *got_worktree_get_histedit_script_path(char **,
406 0ebf8283 2019-07-24 stsp struct got_worktree *);
407 dc424a06 2019-08-07 stsp
408 2822a352 2019-10-15 stsp /*
409 2822a352 2019-10-15 stsp * Prepare a work tree for integrating a branch.
410 2822a352 2019-10-15 stsp * Return pointers to a fileindex and locked references which must be
411 2822a352 2019-10-15 stsp * passed back to other integrate-related functions.
412 2822a352 2019-10-15 stsp */
413 2822a352 2019-10-15 stsp const struct got_error *
414 2822a352 2019-10-15 stsp got_worktree_integrate_prepare(struct got_fileindex **,
415 2822a352 2019-10-15 stsp struct got_reference **, struct got_reference **,
416 2822a352 2019-10-15 stsp struct got_worktree *, const char *, struct got_repository *);
417 dc424a06 2019-08-07 stsp
418 fdfa9bf2 2019-08-03 stsp /*
419 2822a352 2019-10-15 stsp * Carry out a prepared branch integration operation.
420 2822a352 2019-10-15 stsp * Report affected files via the specified progress callback.
421 2822a352 2019-10-15 stsp */
422 2822a352 2019-10-15 stsp const struct got_error *got_worktree_integrate_continue(
423 2822a352 2019-10-15 stsp struct got_worktree *, struct got_fileindex *, struct got_repository *,
424 2822a352 2019-10-15 stsp struct got_reference *, struct got_reference *,
425 2822a352 2019-10-15 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
426 2822a352 2019-10-15 stsp
427 2822a352 2019-10-15 stsp /* Abort a prepared branch integration operation. */
428 2822a352 2019-10-15 stsp const struct got_error *got_worktree_integrate_abort(struct got_worktree *,
429 2822a352 2019-10-15 stsp struct got_fileindex *, struct got_repository *,
430 2822a352 2019-10-15 stsp struct got_reference *, struct got_reference *);
431 2822a352 2019-10-15 stsp
432 2822a352 2019-10-15 stsp /*
433 fdfa9bf2 2019-08-03 stsp * Stage the specified paths for commit.
434 dc424a06 2019-08-07 stsp * If the patch callback is not NULL, call it to select patch hunks for
435 dc424a06 2019-08-07 stsp * staging. Otherwise, stage the full file content found at each path.
436 35213c7c 2020-07-23 stsp * If a path being staged contains a symlink which points outside
437 35213c7c 2020-07-23 stsp * of the path space under version control, raise an error unless
438 35213c7c 2020-07-23 stsp * staging of such paths is being forced by the caller.
439 35213c7c 2020-07-23 stsp */
440 1e71573e 2019-08-03 stsp const struct got_error *got_worktree_stage(struct got_worktree *,
441 1e71573e 2019-08-03 stsp struct got_pathlist_head *, got_worktree_status_cb, void *,
442 35213c7c 2020-07-23 stsp got_worktree_patch_cb, void *, int, struct got_repository *);
443 ad493afc 2019-08-03 stsp
444 ad493afc 2019-08-03 stsp /*
445 ad493afc 2019-08-03 stsp * Merge staged changes for the specified paths back into the work tree
446 ad493afc 2019-08-03 stsp * and mark the paths as non-staged again.
447 ad493afc 2019-08-03 stsp */
448 ad493afc 2019-08-03 stsp const struct got_error *got_worktree_unstage(struct got_worktree *,
449 ad493afc 2019-08-03 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
450 2e1f37b0 2019-08-08 stsp got_worktree_patch_cb, void *, struct got_repository *);
451 b2118c49 2020-07-28 stsp
452 b2118c49 2020-07-28 stsp /* A callback function which is invoked with per-path info. */
453 b2118c49 2020-07-28 stsp typedef const struct got_error *(*got_worktree_path_info_cb)(void *,
454 b2118c49 2020-07-28 stsp const char *path, mode_t mode, time_t mtime,
455 b2118c49 2020-07-28 stsp struct got_object_id *blob_id, struct got_object_id *staged_blob_id,
456 b2118c49 2020-07-28 stsp struct got_object_id *commit_id);
457 b2118c49 2020-07-28 stsp
458 b2118c49 2020-07-28 stsp /*
459 b2118c49 2020-07-28 stsp * Report work-tree meta data for paths in the work tree.
460 b2118c49 2020-07-28 stsp * The info callback will be invoked with the provided void * argument,
461 b2118c49 2020-07-28 stsp * a path, and meta-data arguments (see got_worktree_path_info_cb).
462 b2118c49 2020-07-28 stsp */
463 b2118c49 2020-07-28 stsp const struct got_error *
464 b2118c49 2020-07-28 stsp got_worktree_path_info(struct got_worktree *, struct got_pathlist_head *,
465 b2118c49 2020-07-28 stsp got_worktree_path_info_cb, void *, got_cancel_cb , void *);