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;
20 eecfbcd1 2018-12-29 stsp /* status codes */
21 f8d1f275 2019-02-04 stsp #define GOT_STATUS_NO_CHANGE ' '
22 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_ADD 'A'
23 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_EXISTS 'E'
24 507dc3bb 2018-12-29 stsp #define GOT_STATUS_UPDATE 'U'
25 512f0d0e 2019-01-02 stsp #define GOT_STATUS_DELETE 'D'
26 276262e8 2019-02-08 stsp #define GOT_STATUS_MODIFY 'M'
27 6353ad76 2019-02-08 stsp #define GOT_STATUS_CONFLICT 'C'
28 6353ad76 2019-02-08 stsp #define GOT_STATUS_MERGE 'G'
29 f8d1f275 2019-02-04 stsp #define GOT_STATUS_MISSING '!'
30 f8d1f275 2019-02-04 stsp #define GOT_STATUS_UNVERSIONED '?'
31 0dbc2271 2019-02-05 stsp #define GOT_STATUS_OBSTRUCTED '~'
32 a129376b 2019-03-28 stsp #define GOT_STATUS_REVERT 'R'
33 2b92fad7 2019-06-02 stsp #define GOT_STATUS_CANNOT_DELETE 'd'
34 a484d721 2019-06-10 stsp #define GOT_STATUS_BUMP_BASE 'b'
37 0c60ce5a 2018-04-02 stsp * Attempt to initialize a new work tree on disk.
38 0c60ce5a 2018-04-02 stsp * The first argument is the path to a directory where the work tree
39 0c60ce5a 2018-04-02 stsp * will be created. The path itself must not yet exist, but the dirname(3)
40 0c60ce5a 2018-04-02 stsp * of the path must already exist.
41 93a30277 2018-12-24 stsp * The reference provided will be used to determine the new worktree's
42 93a30277 2018-12-24 stsp * base commit. The third argument speficies the work tree's path prefix.
44 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_init(const char *, struct got_reference *,
45 577ec78f 2018-03-11 stsp const char *, struct got_repository *);
48 247140b2 2019-02-05 stsp * Attempt to open a worktree at or above the specified path.
49 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_worktree_close().
51 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_open(struct got_worktree **, const char *);
53 0c60ce5a 2018-04-02 stsp /* Dispose of an open work tree. */
54 3a6ce05a 2019-02-11 stsp const struct got_error *got_worktree_close(struct got_worktree *);
57 c7f4312f 2019-02-05 stsp * Get the path to the root directory of a worktree.
59 c7f4312f 2019-02-05 stsp const char *got_worktree_get_root_path(struct got_worktree *);
62 0c60ce5a 2018-04-02 stsp * Get the path to the repository associated with a worktree.
64 2fbdb5ae 2018-12-29 stsp const char *got_worktree_get_repo_path(struct got_worktree *);
67 49520a32 2018-12-29 stsp * Get the path prefix associated with a worktree.
69 49520a32 2018-12-29 stsp const char *got_worktree_get_path_prefix(struct got_worktree *);
72 e5dc7198 2018-12-29 stsp * Check if a user-provided path prefix matches that of the worktree.
74 e5dc7198 2018-12-29 stsp const struct got_error *got_worktree_match_path_prefix(int *,
75 e5dc7198 2018-12-29 stsp struct got_worktree *, const char *);
78 0c60ce5a 2018-04-02 stsp * Get the name of a work tree's HEAD reference.
80 bc70eb79 2019-05-09 stsp const char *got_worktree_get_head_ref_name(struct got_worktree *);
83 024e9686 2019-05-14 stsp * Set the branch head reference of the work tree.
85 024e9686 2019-05-14 stsp const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
86 024e9686 2019-05-14 stsp struct got_reference *);
89 507dc3bb 2018-12-29 stsp * Get the current base commit ID of a worktree.
91 b72f483a 2019-02-05 stsp struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
94 507dc3bb 2018-12-29 stsp * Set the base commit Id of a worktree.
96 507dc3bb 2018-12-29 stsp const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
97 507dc3bb 2018-12-29 stsp struct got_repository *, struct got_object_id *);
99 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
100 a0eb853d 2018-12-29 stsp typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
102 99437157 2018-11-11 stsp /* A callback function which is invoked at cancellation points.
103 99437157 2018-11-11 stsp * May return GOT_ERR_CANCELLED to abort the runing operation. */
104 99437157 2018-11-11 stsp typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
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.
114 c4cdcb68 2019-04-03 stsp * It is possible to restrict the checkout operation to a specific path in
115 c4cdcb68 2019-04-03 stsp * the work tree, in which case all files outside this path 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 c4cdcb68 2019-04-03 stsp * The specified path is relative to the work tree's root. Pass "" to check
121 c4cdcb68 2019-04-03 stsp * out files across the entire work tree.
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.
126 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
127 c4cdcb68 2019-04-03 stsp const char *, struct got_repository *, got_worktree_checkout_cb, void *,
128 99437157 2018-11-11 stsp got_worktree_cancel_cb, void *);
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 234035bc 2019-06-01 stsp got_worktree_cancel_cb, void *);
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 016a88dd 2019-05-13 stsp unsigned char, const char *, struct got_object_id *,
140 016a88dd 2019-05-13 stsp struct got_object_id *);
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.
147 6c34b1aa 2019-03-18 stsp const struct got_error *got_worktree_status(struct got_worktree *,
148 6c34b1aa 2019-03-18 stsp const char *, struct got_repository *, got_worktree_status_cb, void *,
149 927df6b7 2019-02-10 stsp got_worktree_cancel_cb cancel_cb, void *);
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).
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 *);
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 *);
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.
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 *);
174 a129376b 2019-03-28 stsp * Revert a file at the specified path such that it matches its
175 a129376b 2019-03-28 stsp * original state in the worktree's base commit.
177 a129376b 2019-03-28 stsp const struct got_error *got_worktree_revert(struct got_worktree *,
178 e20a8b6f 2019-06-04 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
179 e20a8b6f 2019-06-04 stsp struct got_repository *);
182 33ad4cbe 2019-05-12 jcs * A callback function which is invoked when a commit message is requested.
183 8656d6c4 2019-05-20 stsp * Passes a pathlist with a struct got_commitable * in the data pointer of
184 8656d6c4 2019-05-20 stsp * each element, a pointer to the log message that must be set by the
185 8656d6c4 2019-05-20 stsp * callback and will be freed after committing, and an argument passed
186 8656d6c4 2019-05-20 stsp * through to the callback.
188 33ad4cbe 2019-05-12 jcs typedef const struct got_error *(*got_worktree_commit_msg_cb)(
189 33ad4cbe 2019-05-12 jcs struct got_pathlist_head *, char **, void *);
192 c4296144 2019-05-09 stsp * Create a new commit from changes in the work tree.
193 c4296144 2019-05-09 stsp * Return the ID of the newly created commit.
194 c4296144 2019-05-09 stsp * The worktree's base commit will be set to this new commit.
195 c4296144 2019-05-09 stsp * Files unaffected by this commit operation will retain their
196 c4296144 2019-05-09 stsp * current base commit.
197 de18fc63 2019-05-09 stsp * An author and a non-empty log message must be specified.
198 de18fc63 2019-05-09 stsp * The name of the committer is optional (may be NULL).
199 c4296144 2019-05-09 stsp * If an on-disk path is specified, only commit changes at or within this path.
201 de18fc63 2019-05-09 stsp const struct got_error *got_worktree_commit(struct got_object_id **,
202 de18fc63 2019-05-09 stsp struct got_worktree *, const char *, const char *, const char *,
203 33ad4cbe 2019-05-12 jcs got_worktree_commit_msg_cb, void *,
204 33ad4cbe 2019-05-12 jcs got_worktree_status_cb, void *, struct got_repository *);
206 8656d6c4 2019-05-20 stsp /* Get the path of a commitable worktree item. */
207 8656d6c4 2019-05-20 stsp const char *got_commitable_get_path(struct got_commitable *);
209 8656d6c4 2019-05-20 stsp /* Get the status of a commitable worktree item. */
210 8656d6c4 2019-05-20 stsp unsigned int got_commitable_get_status(struct got_commitable *);
