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;
19 eecfbcd1 2018-12-29 stsp /* status codes */
20 f8d1f275 2019-02-04 stsp #define GOT_STATUS_NO_CHANGE ' '
21 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_ADD 'A'
22 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_EXISTS 'E'
23 507dc3bb 2018-12-29 stsp #define GOT_STATUS_UPDATE 'U'
24 512f0d0e 2019-01-02 stsp #define GOT_STATUS_DELETE 'D'
25 276262e8 2019-02-08 stsp #define GOT_STATUS_MODIFY 'M'
26 6353ad76 2019-02-08 stsp #define GOT_STATUS_CONFLICT 'C'
27 6353ad76 2019-02-08 stsp #define GOT_STATUS_MERGE 'G'
28 f8d1f275 2019-02-04 stsp #define GOT_STATUS_MISSING '!'
29 f8d1f275 2019-02-04 stsp #define GOT_STATUS_UNVERSIONED '?'
30 0dbc2271 2019-02-05 stsp #define GOT_STATUS_OBSTRUCTED '~'
31 a129376b 2019-03-28 stsp #define GOT_STATUS_REVERT 'R'
33 33ad4cbe 2019-05-12 jcs struct got_commitable {
35 33ad4cbe 2019-05-12 jcs char *in_repo_path;
36 33ad4cbe 2019-05-12 jcs char *ondisk_path;
37 33ad4cbe 2019-05-12 jcs unsigned char status;
38 33ad4cbe 2019-05-12 jcs struct got_object_id *blob_id;
39 33ad4cbe 2019-05-12 jcs struct got_object_id *base_id;
44 0c60ce5a 2018-04-02 stsp * Attempt to initialize a new work tree on disk.
45 0c60ce5a 2018-04-02 stsp * The first argument is the path to a directory where the work tree
46 0c60ce5a 2018-04-02 stsp * will be created. The path itself must not yet exist, but the dirname(3)
47 0c60ce5a 2018-04-02 stsp * of the path must already exist.
48 93a30277 2018-12-24 stsp * The reference provided will be used to determine the new worktree's
49 93a30277 2018-12-24 stsp * base commit. The third argument speficies the work tree's path prefix.
51 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_init(const char *, struct got_reference *,
52 577ec78f 2018-03-11 stsp const char *, struct got_repository *);
55 247140b2 2019-02-05 stsp * Attempt to open a worktree at or above the specified path.
56 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_worktree_close().
58 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_open(struct got_worktree **, const char *);
60 0c60ce5a 2018-04-02 stsp /* Dispose of an open work tree. */
61 3a6ce05a 2019-02-11 stsp const struct got_error *got_worktree_close(struct got_worktree *);
64 c7f4312f 2019-02-05 stsp * Get the path to the root directory of a worktree.
66 c7f4312f 2019-02-05 stsp const char *got_worktree_get_root_path(struct got_worktree *);
69 0c60ce5a 2018-04-02 stsp * Get the path to the repository associated with a worktree.
71 2fbdb5ae 2018-12-29 stsp const char *got_worktree_get_repo_path(struct got_worktree *);
74 49520a32 2018-12-29 stsp * Get the path prefix associated with a worktree.
76 49520a32 2018-12-29 stsp const char *got_worktree_get_path_prefix(struct got_worktree *);
79 e5dc7198 2018-12-29 stsp * Check if a user-provided path prefix matches that of the worktree.
81 e5dc7198 2018-12-29 stsp const struct got_error *got_worktree_match_path_prefix(int *,
82 e5dc7198 2018-12-29 stsp struct got_worktree *, const char *);
85 0c60ce5a 2018-04-02 stsp * Get the name of a work tree's HEAD reference.
87 bc70eb79 2019-05-09 stsp const char *got_worktree_get_head_ref_name(struct got_worktree *);
90 507dc3bb 2018-12-29 stsp * Get the current base commit ID of a worktree.
92 b72f483a 2019-02-05 stsp struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
95 507dc3bb 2018-12-29 stsp * Set the base commit Id of a worktree.
97 507dc3bb 2018-12-29 stsp const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
98 507dc3bb 2018-12-29 stsp struct got_repository *, struct got_object_id *);
100 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
101 a0eb853d 2018-12-29 stsp typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
103 99437157 2018-11-11 stsp /* A callback function which is invoked at cancellation points.
104 99437157 2018-11-11 stsp * May return GOT_ERR_CANCELLED to abort the runing operation. */
105 99437157 2018-11-11 stsp typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
108 0c60ce5a 2018-04-02 stsp * Attempt to check out files into a work tree from its associated repository
109 0c60ce5a 2018-04-02 stsp * and path prefix, and update the work tree's file index accordingly.
110 0c60ce5a 2018-04-02 stsp * File content is obtained from blobs within the work tree's path prefix
111 93a30277 2018-12-24 stsp * inside the tree corresponding to the work tree's base commit.
112 0c60ce5a 2018-04-02 stsp * The checkout progress callback will be invoked with the provided
113 0c60ce5a 2018-04-02 stsp * void * argument, and the path of each checked out file.
115 c4cdcb68 2019-04-03 stsp * It is possible to restrict the checkout operation to a specific path in
116 c4cdcb68 2019-04-03 stsp * the work tree, in which case all files outside this path will remain at
117 c4cdcb68 2019-04-03 stsp * their currently recorded base commit. Inconsistent base commits can be
118 c4cdcb68 2019-04-03 stsp * repaired later by running another update operation across the entire work
119 c4cdcb68 2019-04-03 stsp * tree. Inconsistent base-commits may also occur if this function runs into
120 c4cdcb68 2019-04-03 stsp * an error or if the checkout operation is cancelled by the cancel callback.
121 c4cdcb68 2019-04-03 stsp * The specified path is relative to the work tree's root. Pass "" to check
122 c4cdcb68 2019-04-03 stsp * out files across the entire work tree.
124 c4cdcb68 2019-04-03 stsp * Some operations may refuse to run while the work tree contains files from
125 c4cdcb68 2019-04-03 stsp * multiple base commits.
127 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
128 c4cdcb68 2019-04-03 stsp const char *, struct got_repository *, got_worktree_checkout_cb, void *,
129 99437157 2018-11-11 stsp got_worktree_cancel_cb, void *);
131 f8d1f275 2019-02-04 stsp /* A callback function which is invoked to report a path's status. */
132 b72f483a 2019-02-05 stsp typedef const struct got_error *(*got_worktree_status_cb)(void *,
133 b72f483a 2019-02-05 stsp unsigned char, const char *, struct got_object_id *);
136 f8d1f275 2019-02-04 stsp * Report the status of paths in the work tree.
137 f8d1f275 2019-02-04 stsp * The status callback will be invoked with the provided void * argument,
138 f8d1f275 2019-02-04 stsp * a path, and a corresponding status code.
140 6c34b1aa 2019-03-18 stsp const struct got_error *got_worktree_status(struct got_worktree *,
141 6c34b1aa 2019-03-18 stsp const char *, struct got_repository *, got_worktree_status_cb, void *,
142 927df6b7 2019-02-10 stsp got_worktree_cancel_cb cancel_cb, void *);
145 6c7ab921 2019-03-18 stsp * Try to resolve a user-provided path to an on-disk path in the work tree.
146 6c7ab921 2019-03-18 stsp * The caller must dispose of the resolved path with free(3).
148 6c7ab921 2019-03-18 stsp const struct got_error *got_worktree_resolve_path(char **,
149 6c7ab921 2019-03-18 stsp struct got_worktree *, const char *);
151 1dd54920 2019-05-11 stsp /* Schedule files at on-disk paths for addition in the next commit. */
152 031a5338 2019-03-26 stsp const struct got_error *got_worktree_schedule_add(struct got_worktree *,
153 1dd54920 2019-05-11 stsp struct got_pathlist_head *, got_worktree_status_cb, void *,
154 1dd54920 2019-05-11 stsp struct got_repository *);
157 2ec1f75b 2019-03-26 stsp * Remove a file from disk and schedule it to be deleted in the next commit.
158 2ec1f75b 2019-03-26 stsp * Don't allow deleting files with uncommitted modifications, unless the
159 2ec1f75b 2019-03-26 stsp * parameter 'delete_local_mods' is set.
161 2ec1f75b 2019-03-26 stsp const struct got_error *
162 2ec1f75b 2019-03-26 stsp got_worktree_schedule_delete(struct got_worktree *, const char *, int,
163 2ec1f75b 2019-03-26 stsp got_worktree_status_cb, void *, struct got_repository *);
166 a129376b 2019-03-28 stsp * Revert a file at the specified path such that it matches its
167 a129376b 2019-03-28 stsp * original state in the worktree's base commit.
169 a129376b 2019-03-28 stsp const struct got_error *got_worktree_revert(struct got_worktree *,
170 a129376b 2019-03-28 stsp const char *, got_worktree_checkout_cb, void *, struct got_repository *);
173 33ad4cbe 2019-05-12 jcs * A callback function which is invoked when a commit message is requested.
174 33ad4cbe 2019-05-12 jcs * Passes a list of modified paths being committed to, a pointer to the log
175 33ad4cbe 2019-05-12 jcs * message that must be set by the callback and will be freed after committing,
176 33ad4cbe 2019-05-12 jcs * and an argument passed through to the callback.
178 33ad4cbe 2019-05-12 jcs typedef const struct got_error *(*got_worktree_commit_msg_cb)(
179 33ad4cbe 2019-05-12 jcs struct got_pathlist_head *, char **, void *);
182 c4296144 2019-05-09 stsp * Create a new commit from changes in the work tree.
183 c4296144 2019-05-09 stsp * Return the ID of the newly created commit.
184 c4296144 2019-05-09 stsp * The worktree's base commit will be set to this new commit.
185 c4296144 2019-05-09 stsp * Files unaffected by this commit operation will retain their
186 c4296144 2019-05-09 stsp * current base commit.
187 de18fc63 2019-05-09 stsp * An author and a non-empty log message must be specified.
188 de18fc63 2019-05-09 stsp * The name of the committer is optional (may be NULL).
189 c4296144 2019-05-09 stsp * If an on-disk path is specified, only commit changes at or within this path.
191 de18fc63 2019-05-09 stsp const struct got_error *got_worktree_commit(struct got_object_id **,
192 de18fc63 2019-05-09 stsp struct got_worktree *, const char *, const char *, const char *,
193 33ad4cbe 2019-05-12 jcs got_worktree_commit_msg_cb, void *,
194 33ad4cbe 2019-05-12 jcs got_worktree_status_cb, void *, struct got_repository *);
