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 6353ad76 2019-02-08 stsp #define GOT_STATUS_CONFLICT 'C'
30 6353ad76 2019-02-08 stsp #define GOT_STATUS_MERGE 'G'
31 f8d1f275 2019-02-04 stsp #define GOT_STATUS_MISSING '!'
32 f8d1f275 2019-02-04 stsp #define GOT_STATUS_UNVERSIONED '?'
33 0dbc2271 2019-02-05 stsp #define GOT_STATUS_OBSTRUCTED '~'
34 2a06fe5f 2019-08-24 stsp #define GOT_STATUS_NONEXISTENT 'N'
35 a129376b 2019-03-28 stsp #define GOT_STATUS_REVERT 'R'
36 2b92fad7 2019-06-02 stsp #define GOT_STATUS_CANNOT_DELETE 'd'
37 a484d721 2019-06-10 stsp #define GOT_STATUS_BUMP_BASE 'b'
38 eecfbcd1 2018-12-29 stsp
39 0c60ce5a 2018-04-02 stsp /*
40 0c60ce5a 2018-04-02 stsp * Attempt to initialize a new work tree on disk.
41 0c60ce5a 2018-04-02 stsp * The first argument is the path to a directory where the work tree
42 0c60ce5a 2018-04-02 stsp * will be created. The path itself must not yet exist, but the dirname(3)
43 0c60ce5a 2018-04-02 stsp * of the path must already exist.
44 93a30277 2018-12-24 stsp * The reference provided will be used to determine the new worktree's
45 93a30277 2018-12-24 stsp * base commit. The third argument speficies the work tree's path prefix.
46 0c60ce5a 2018-04-02 stsp */
47 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_init(const char *, struct got_reference *,
48 577ec78f 2018-03-11 stsp const char *, struct got_repository *);
49 0c60ce5a 2018-04-02 stsp
50 0c60ce5a 2018-04-02 stsp /*
51 247140b2 2019-02-05 stsp * Attempt to open a worktree at or above the specified path.
52 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_worktree_close().
53 0c60ce5a 2018-04-02 stsp */
54 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_open(struct got_worktree **, const char *);
55 0c60ce5a 2018-04-02 stsp
56 0c60ce5a 2018-04-02 stsp /* Dispose of an open work tree. */
57 3a6ce05a 2019-02-11 stsp const struct got_error *got_worktree_close(struct got_worktree *);
58 0c60ce5a 2018-04-02 stsp
59 0c60ce5a 2018-04-02 stsp /*
60 c7f4312f 2019-02-05 stsp * Get the path to the root directory of a worktree.
61 c7f4312f 2019-02-05 stsp */
62 c7f4312f 2019-02-05 stsp const char *got_worktree_get_root_path(struct got_worktree *);
63 c7f4312f 2019-02-05 stsp
64 c7f4312f 2019-02-05 stsp /*
65 0c60ce5a 2018-04-02 stsp * Get the path to the repository associated with a worktree.
66 0c60ce5a 2018-04-02 stsp */
67 2fbdb5ae 2018-12-29 stsp const char *got_worktree_get_repo_path(struct got_worktree *);
68 0c60ce5a 2018-04-02 stsp
69 0c60ce5a 2018-04-02 stsp /*
70 49520a32 2018-12-29 stsp * Get the path prefix associated with a worktree.
71 49520a32 2018-12-29 stsp */
72 49520a32 2018-12-29 stsp const char *got_worktree_get_path_prefix(struct got_worktree *);
73 49520a32 2018-12-29 stsp
74 49520a32 2018-12-29 stsp /*
75 e5dc7198 2018-12-29 stsp * Check if a user-provided path prefix matches that of the worktree.
76 e5dc7198 2018-12-29 stsp */
77 e5dc7198 2018-12-29 stsp const struct got_error *got_worktree_match_path_prefix(int *,
78 e5dc7198 2018-12-29 stsp struct got_worktree *, const char *);
79 e5dc7198 2018-12-29 stsp
80 e5dc7198 2018-12-29 stsp /*
81 0c60ce5a 2018-04-02 stsp * Get the name of a work tree's HEAD reference.
82 0c60ce5a 2018-04-02 stsp */
83 bc70eb79 2019-05-09 stsp const char *got_worktree_get_head_ref_name(struct got_worktree *);
84 0c60ce5a 2018-04-02 stsp
85 507dc3bb 2018-12-29 stsp /*
86 024e9686 2019-05-14 stsp * Set the branch head reference of the work tree.
87 024e9686 2019-05-14 stsp */
88 024e9686 2019-05-14 stsp const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
89 024e9686 2019-05-14 stsp struct got_reference *);
90 024e9686 2019-05-14 stsp
91 024e9686 2019-05-14 stsp /*
92 507dc3bb 2018-12-29 stsp * Get the current base commit ID of a worktree.
93 507dc3bb 2018-12-29 stsp */
94 b72f483a 2019-02-05 stsp struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
95 507dc3bb 2018-12-29 stsp
96 507dc3bb 2018-12-29 stsp /*
97 507dc3bb 2018-12-29 stsp * Set the base commit Id of a worktree.
98 507dc3bb 2018-12-29 stsp */
99 507dc3bb 2018-12-29 stsp const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
100 507dc3bb 2018-12-29 stsp struct got_repository *, struct got_object_id *);
101 507dc3bb 2018-12-29 stsp
102 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
103 1ee397ad 2019-07-12 stsp typedef const struct got_error *(*got_worktree_checkout_cb)(void *,
104 1ee397ad 2019-07-12 stsp unsigned char, const char *);
105 0c60ce5a 2018-04-02 stsp
106 0c60ce5a 2018-04-02 stsp /*
107 0c60ce5a 2018-04-02 stsp * Attempt to check out files into a work tree from its associated repository
108 0c60ce5a 2018-04-02 stsp * and path prefix, and update the work tree's file index accordingly.
109 0c60ce5a 2018-04-02 stsp * File content is obtained from blobs within the work tree's path prefix
110 93a30277 2018-12-24 stsp * inside the tree corresponding to the work tree's base commit.
111 0c60ce5a 2018-04-02 stsp * The checkout progress callback will be invoked with the provided
112 0c60ce5a 2018-04-02 stsp * void * argument, and the path of each checked out file.
113 c4cdcb68 2019-04-03 stsp *
114 f2ea84fa 2019-07-27 stsp * It is possible to restrict the checkout operation to specific paths in
115 f2ea84fa 2019-07-27 stsp * the work tree, in which case all files outside those paths will remain at
116 c4cdcb68 2019-04-03 stsp * their currently recorded base commit. Inconsistent base commits can be
117 c4cdcb68 2019-04-03 stsp * repaired later by running another update operation across the entire work
118 c4cdcb68 2019-04-03 stsp * tree. Inconsistent base-commits may also occur if this function runs into
119 c4cdcb68 2019-04-03 stsp * an error or if the checkout operation is cancelled by the cancel callback.
120 f2ea84fa 2019-07-27 stsp * Allspecified paths are relative to the work tree's root. Pass a pathlist
121 f2ea84fa 2019-07-27 stsp * with a single empty path "" to check out files across the entire work tree.
122 c4cdcb68 2019-04-03 stsp *
123 c4cdcb68 2019-04-03 stsp * Some operations may refuse to run while the work tree contains files from
124 c4cdcb68 2019-04-03 stsp * multiple base commits.
125 0c60ce5a 2018-04-02 stsp */
126 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
127 f2ea84fa 2019-07-27 stsp struct got_pathlist_head *, struct got_repository *,
128 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
129 507dc3bb 2018-12-29 stsp
130 234035bc 2019-06-01 stsp /* Merge the differences between two commits into a work tree. */
131 234035bc 2019-06-01 stsp const struct got_error *
132 234035bc 2019-06-01 stsp got_worktree_merge_files(struct got_worktree *,
133 234035bc 2019-06-01 stsp struct got_object_id *, struct got_object_id *,
134 234035bc 2019-06-01 stsp struct got_repository *, got_worktree_checkout_cb, void *,
135 e6209546 2019-08-22 stsp got_cancel_cb, void *);
136 234035bc 2019-06-01 stsp
137 f8d1f275 2019-02-04 stsp /* A callback function which is invoked to report a path's status. */
138 b72f483a 2019-02-05 stsp typedef const struct got_error *(*got_worktree_status_cb)(void *,
139 88d0e355 2019-08-03 stsp unsigned char, unsigned char, const char *, struct got_object_id *,
140 537ac44b 2019-08-03 stsp struct got_object_id *, struct got_object_id *);
141 f8d1f275 2019-02-04 stsp
142 f8d1f275 2019-02-04 stsp /*
143 f8d1f275 2019-02-04 stsp * Report the status of paths in the work tree.
144 f8d1f275 2019-02-04 stsp * The status callback will be invoked with the provided void * argument,
145 f8d1f275 2019-02-04 stsp * a path, and a corresponding status code.
146 f8d1f275 2019-02-04 stsp */
147 6c34b1aa 2019-03-18 stsp const struct got_error *got_worktree_status(struct got_worktree *,
148 72ea6654 2019-07-27 stsp struct got_pathlist_head *, struct got_repository *,
149 e6209546 2019-08-22 stsp got_worktree_status_cb, void *, got_cancel_cb cancel_cb, void *);
150 6c7ab921 2019-03-18 stsp
151 6c7ab921 2019-03-18 stsp /*
152 6c7ab921 2019-03-18 stsp * Try to resolve a user-provided path to an on-disk path in the work tree.
153 6c7ab921 2019-03-18 stsp * The caller must dispose of the resolved path with free(3).
154 6c7ab921 2019-03-18 stsp */
155 6c7ab921 2019-03-18 stsp const struct got_error *got_worktree_resolve_path(char **,
156 6c7ab921 2019-03-18 stsp struct got_worktree *, const char *);
157 d00136be 2019-03-26 stsp
158 1dd54920 2019-05-11 stsp /* Schedule files at on-disk paths for addition in the next commit. */
159 031a5338 2019-03-26 stsp const struct got_error *got_worktree_schedule_add(struct got_worktree *,
160 1dd54920 2019-05-11 stsp struct got_pathlist_head *, got_worktree_status_cb, void *,
161 1dd54920 2019-05-11 stsp struct got_repository *);
162 2ec1f75b 2019-03-26 stsp
163 2ec1f75b 2019-03-26 stsp /*
164 17ed4618 2019-06-02 stsp * Remove files from disk and schedule them to be deleted in the next commit.
165 2ec1f75b 2019-03-26 stsp * Don't allow deleting files with uncommitted modifications, unless the
166 2ec1f75b 2019-03-26 stsp * parameter 'delete_local_mods' is set.
167 2ec1f75b 2019-03-26 stsp */
168 2ec1f75b 2019-03-26 stsp const struct got_error *
169 17ed4618 2019-06-02 stsp got_worktree_schedule_delete(struct got_worktree *,
170 17ed4618 2019-06-02 stsp struct got_pathlist_head *, int, got_worktree_status_cb, void *,
171 17ed4618 2019-06-02 stsp struct got_repository *);
172 a129376b 2019-03-28 stsp
173 33aa809d 2019-08-08 stsp /* A callback function which is used to select or reject a patch. */
174 33aa809d 2019-08-08 stsp typedef const struct got_error *(*got_worktree_patch_cb)(int *, void *,
175 33aa809d 2019-08-08 stsp unsigned char, const char *, FILE *, int, int);
176 33aa809d 2019-08-08 stsp
177 33aa809d 2019-08-08 stsp /* Values for result output parameter of got_wortree_patch_cb. */
178 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NONE 0
179 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_YES 1
180 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NO 2
181 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_QUIT 3
182 33aa809d 2019-08-08 stsp
183 a129376b 2019-03-28 stsp /*
184 a129376b 2019-03-28 stsp * Revert a file at the specified path such that it matches its
185 a129376b 2019-03-28 stsp * original state in the worktree's base commit.
186 33aa809d 2019-08-08 stsp * If the patch callback is not NULL, call it to select patch hunks to
187 33aa809d 2019-08-08 stsp * revert. Otherwise, revert the whole file found at each path.
188 a129376b 2019-03-28 stsp */
189 a129376b 2019-03-28 stsp const struct got_error *got_worktree_revert(struct got_worktree *,
190 e20a8b6f 2019-06-04 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
191 33aa809d 2019-08-08 stsp got_worktree_patch_cb patch_cb, void *patch_arg,
192 e20a8b6f 2019-06-04 stsp struct got_repository *);
193 c4296144 2019-05-09 stsp
194 c4296144 2019-05-09 stsp /*
195 33ad4cbe 2019-05-12 jcs * A callback function which is invoked when a commit message is requested.
196 8656d6c4 2019-05-20 stsp * Passes a pathlist with a struct got_commitable * in the data pointer of
197 8656d6c4 2019-05-20 stsp * each element, a pointer to the log message that must be set by the
198 8656d6c4 2019-05-20 stsp * callback and will be freed after committing, and an argument passed
199 8656d6c4 2019-05-20 stsp * through to the callback.
200 33ad4cbe 2019-05-12 jcs */
201 33ad4cbe 2019-05-12 jcs typedef const struct got_error *(*got_worktree_commit_msg_cb)(
202 33ad4cbe 2019-05-12 jcs struct got_pathlist_head *, char **, void *);
203 33ad4cbe 2019-05-12 jcs
204 33ad4cbe 2019-05-12 jcs /*
205 c4296144 2019-05-09 stsp * Create a new commit from changes in the work tree.
206 c4296144 2019-05-09 stsp * Return the ID of the newly created commit.
207 c4296144 2019-05-09 stsp * The worktree's base commit will be set to this new commit.
208 c4296144 2019-05-09 stsp * Files unaffected by this commit operation will retain their
209 c4296144 2019-05-09 stsp * current base commit.
210 de18fc63 2019-05-09 stsp * An author and a non-empty log message must be specified.
211 de18fc63 2019-05-09 stsp * The name of the committer is optional (may be NULL).
212 c4296144 2019-05-09 stsp */
213 de18fc63 2019-05-09 stsp const struct got_error *got_worktree_commit(struct got_object_id **,
214 5c1e53bc 2019-07-28 stsp struct got_worktree *, struct got_pathlist_head *, const char *,
215 5c1e53bc 2019-07-28 stsp const char *, got_worktree_commit_msg_cb, void *,
216 33ad4cbe 2019-05-12 jcs got_worktree_status_cb, void *, struct got_repository *);
217 8656d6c4 2019-05-20 stsp
218 8656d6c4 2019-05-20 stsp /* Get the path of a commitable worktree item. */
219 8656d6c4 2019-05-20 stsp const char *got_commitable_get_path(struct got_commitable *);
220 8656d6c4 2019-05-20 stsp
221 8656d6c4 2019-05-20 stsp /* Get the status of a commitable worktree item. */
222 8656d6c4 2019-05-20 stsp unsigned int got_commitable_get_status(struct got_commitable *);
223 818c7501 2019-07-11 stsp
224 818c7501 2019-07-11 stsp /*
225 818c7501 2019-07-11 stsp * Prepare for rebasing a branch onto the work tree's current branch.
226 818c7501 2019-07-11 stsp * This function creates references to a temporary branch, the branch
227 818c7501 2019-07-11 stsp * being rebased, and the work tree's current branch, under the
228 818c7501 2019-07-11 stsp * "got/worktree/rebase/" namespace. These references are used to
229 818c7501 2019-07-11 stsp * keep track of rebase operation state and are used as input and/or
230 818c7501 2019-07-11 stsp * output arguments with other rebase-related functions.
231 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
232 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
233 818c7501 2019-07-11 stsp */
234 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_prepare(struct got_reference **,
235 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_fileindex **, struct got_worktree *,
236 3e3a69f1 2019-07-25 stsp struct got_reference *, struct got_repository *);
237 818c7501 2019-07-11 stsp
238 818c7501 2019-07-11 stsp /*
239 818c7501 2019-07-11 stsp * Continue an interrupted rebase operation.
240 818c7501 2019-07-11 stsp * This function returns existing references created when rebase was prepared,
241 818c7501 2019-07-11 stsp * and the ID of the commit currently being rebased. This should be called
242 818c7501 2019-07-11 stsp * before either resuming or aborting a rebase operation.
243 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
244 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
245 818c7501 2019-07-11 stsp */
246 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_continue(struct got_object_id **,
247 818c7501 2019-07-11 stsp struct got_reference **, struct got_reference **, struct got_reference **,
248 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
249 818c7501 2019-07-11 stsp
250 818c7501 2019-07-11 stsp /* Check whether a, potentially interrupted, rebase operation is in progress. */
251 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_in_progress(int *,
252 818c7501 2019-07-11 stsp struct got_worktree *);
253 818c7501 2019-07-11 stsp
254 818c7501 2019-07-11 stsp /*
255 818c7501 2019-07-11 stsp * Merge changes from the commit currently being rebased into the work tree.
256 818c7501 2019-07-11 stsp * Report affected files, including merge conflicts, via the specified
257 01757395 2019-07-12 stsp * progress callback. Also populate a list of affected paths which should
258 01757395 2019-07-12 stsp * be passed to got_worktree_rebase_commit() after a conflict-free merge.
259 01757395 2019-07-12 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
260 01757395 2019-07-12 stsp * got_worktree_rebase_pathlist_free().
261 818c7501 2019-07-11 stsp */
262 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_merge_files(
263 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
264 01757395 2019-07-12 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
265 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
266 818c7501 2019-07-11 stsp
267 818c7501 2019-07-11 stsp /*
268 01757395 2019-07-12 stsp * Commit changes merged by got_worktree_rebase_merge_files() to a temporary
269 01757395 2019-07-12 stsp * branch and return the ID of the newly created commit. An optional list of
270 01757395 2019-07-12 stsp * merged paths can be provided; otherwise this function will perform a status
271 01757395 2019-07-12 stsp * crawl across the entire work tree to find paths to commit.
272 818c7501 2019-07-11 stsp */
273 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_commit(struct got_object_id **,
274 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
275 01757395 2019-07-12 stsp struct got_reference *, struct got_commit_object *,
276 818c7501 2019-07-11 stsp struct got_object_id *, struct got_repository *);
277 818c7501 2019-07-11 stsp
278 01757395 2019-07-12 stsp /* Free a list of merged paths from got_worktree_merge_files. */
279 01757395 2019-07-12 stsp void got_worktree_rebase_pathlist_free(struct got_pathlist_head *);
280 01757395 2019-07-12 stsp
281 818c7501 2019-07-11 stsp /* Postpone the rebase operation. Should be called after a merge conflict. */
282 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_rebase_postpone(struct got_worktree *,
283 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
284 818c7501 2019-07-11 stsp
285 818c7501 2019-07-11 stsp /*
286 818c7501 2019-07-11 stsp * Complete the current rebase operation. This should be called once all
287 818c7501 2019-07-11 stsp * commits have been rebased successfully.
288 818c7501 2019-07-11 stsp */
289 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_complete(struct got_worktree *,
290 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
291 3e3a69f1 2019-07-25 stsp struct got_reference *, struct got_repository *);
292 818c7501 2019-07-11 stsp
293 818c7501 2019-07-11 stsp /*
294 818c7501 2019-07-11 stsp * Abort the current rebase operation.
295 818c7501 2019-07-11 stsp * Report reverted files via the specified progress callback.
296 818c7501 2019-07-11 stsp */
297 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_abort(struct got_worktree *,
298 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
299 0ebf8283 2019-07-24 stsp got_worktree_checkout_cb, void *);
300 0ebf8283 2019-07-24 stsp
301 0ebf8283 2019-07-24 stsp /*
302 0ebf8283 2019-07-24 stsp * Prepare for editing the history of the work tree's current branch.
303 0ebf8283 2019-07-24 stsp * This function creates references to a temporary branch, and the
304 0ebf8283 2019-07-24 stsp * work tree's current branch, under the "got/worktree/histedit/" namespace.
305 0ebf8283 2019-07-24 stsp * These references are used to keep track of histedit operation state and
306 0ebf8283 2019-07-24 stsp * are used as input and/or output arguments with other histedit-related
307 0ebf8283 2019-07-24 stsp * functions.
308 0ebf8283 2019-07-24 stsp */
309 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_prepare(struct got_reference **,
310 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_object_id **, struct got_fileindex **,
311 3e3a69f1 2019-07-25 stsp struct got_worktree *, struct got_repository *);
312 0ebf8283 2019-07-24 stsp
313 0ebf8283 2019-07-24 stsp /*
314 0ebf8283 2019-07-24 stsp * Continue an interrupted histedit operation.
315 0ebf8283 2019-07-24 stsp * This function returns existing references created when histedit was
316 0ebf8283 2019-07-24 stsp * prepared and the ID of the commit currently being edited.
317 0ebf8283 2019-07-24 stsp * It should be called before resuming or aborting a histedit operation.
318 0ebf8283 2019-07-24 stsp */
319 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_continue(struct got_object_id **,
320 0ebf8283 2019-07-24 stsp struct got_reference **, struct got_reference **, struct got_object_id **,
321 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
322 0ebf8283 2019-07-24 stsp
323 0ebf8283 2019-07-24 stsp /* Check whether a histedit operation is in progress. */
324 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_in_progress(int *,
325 0ebf8283 2019-07-24 stsp struct got_worktree *);
326 0ebf8283 2019-07-24 stsp
327 0ebf8283 2019-07-24 stsp /*
328 0ebf8283 2019-07-24 stsp * Merge changes from the commit currently being edited into the work tree.
329 0ebf8283 2019-07-24 stsp * Report affected files, including merge conflicts, via the specified
330 0ebf8283 2019-07-24 stsp * progress callback. Also populate a list of affected paths which should
331 0ebf8283 2019-07-24 stsp * be passed to got_worktree_histedit_commit() after a conflict-free merge.
332 0ebf8283 2019-07-24 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
333 0ebf8283 2019-07-24 stsp * got_worktree_rebase_pathlist_free().
334 0ebf8283 2019-07-24 stsp */
335 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_merge_files(
336 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
337 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
338 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
339 0ebf8283 2019-07-24 stsp
340 0ebf8283 2019-07-24 stsp /*
341 0ebf8283 2019-07-24 stsp * Commit changes merged by got_worktree_histedit_merge_files() to a temporary
342 0ebf8283 2019-07-24 stsp * branch and return the ID of the newly created commit. An optional list of
343 0ebf8283 2019-07-24 stsp * merged paths can be provided; otherwise this function will perform a status
344 0ebf8283 2019-07-24 stsp * crawl across the entire work tree to find paths to commit.
345 0ebf8283 2019-07-24 stsp * An optional log message can be provided which will be used instead of the
346 0ebf8283 2019-07-24 stsp * commit's original message.
347 0ebf8283 2019-07-24 stsp */
348 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_commit(struct got_object_id **,
349 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
350 0ebf8283 2019-07-24 stsp struct got_reference *, struct got_commit_object *,
351 0ebf8283 2019-07-24 stsp struct got_object_id *, const char *, struct got_repository *);
352 0ebf8283 2019-07-24 stsp
353 0ebf8283 2019-07-24 stsp /*
354 0ebf8283 2019-07-24 stsp * Record the specified commit as skipped during histedit.
355 0ebf8283 2019-07-24 stsp * This should be called for commits which get dropped or get folded into
356 0ebf8283 2019-07-24 stsp * a subsequent commit.
357 0ebf8283 2019-07-24 stsp */
358 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_skip_commit(struct got_worktree *,
359 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_repository *);
360 0ebf8283 2019-07-24 stsp
361 0ebf8283 2019-07-24 stsp /* Postpone the histedit operation. */
362 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_histedit_postpone(struct got_worktree *,
363 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
364 0ebf8283 2019-07-24 stsp
365 0ebf8283 2019-07-24 stsp /*
366 0ebf8283 2019-07-24 stsp * Complete the current histedit operation. This should be called once all
367 0ebf8283 2019-07-24 stsp * commits have been edited successfully.
368 0ebf8283 2019-07-24 stsp */
369 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_complete(struct got_worktree *,
370 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
371 3e3a69f1 2019-07-25 stsp struct got_repository *);
372 0ebf8283 2019-07-24 stsp
373 0ebf8283 2019-07-24 stsp /*
374 0ebf8283 2019-07-24 stsp * Abort the current histedit operation.
375 0ebf8283 2019-07-24 stsp * Report reverted files via the specified progress callback.
376 0ebf8283 2019-07-24 stsp */
377 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_abort(struct got_worktree *,
378 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
379 3e3a69f1 2019-07-25 stsp struct got_object_id *, got_worktree_checkout_cb, void *);
380 0ebf8283 2019-07-24 stsp
381 c3022ba5 2019-07-27 stsp /* Get the path to this work tree's histedit script file. */
382 c3022ba5 2019-07-27 stsp const struct got_error *got_worktree_get_histedit_script_path(char **,
383 0ebf8283 2019-07-24 stsp struct got_worktree *);
384 dc424a06 2019-08-07 stsp
385 dc424a06 2019-08-07 stsp
386 fdfa9bf2 2019-08-03 stsp /*
387 fdfa9bf2 2019-08-03 stsp * Stage the specified paths for commit.
388 dc424a06 2019-08-07 stsp * If the patch callback is not NULL, call it to select patch hunks for
389 dc424a06 2019-08-07 stsp * staging. Otherwise, stage the full file content found at each path.
390 fdfa9bf2 2019-08-03 stsp */
391 1e71573e 2019-08-03 stsp const struct got_error *got_worktree_stage(struct got_worktree *,
392 1e71573e 2019-08-03 stsp struct got_pathlist_head *, got_worktree_status_cb, void *,
393 dc424a06 2019-08-07 stsp got_worktree_patch_cb, void *, struct got_repository *);
394 ad493afc 2019-08-03 stsp
395 ad493afc 2019-08-03 stsp /*
396 ad493afc 2019-08-03 stsp * Merge staged changes for the specified paths back into the work tree
397 ad493afc 2019-08-03 stsp * and mark the paths as non-staged again.
398 ad493afc 2019-08-03 stsp */
399 ad493afc 2019-08-03 stsp const struct got_error *got_worktree_unstage(struct got_worktree *,
400 ad493afc 2019-08-03 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
401 2e1f37b0 2019-08-08 stsp got_worktree_patch_cb, void *, struct got_repository *);