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