1 /*
2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 struct got_worktree;
18 
19 /* status codes */
20 #define GOT_STATUS_NO_CHANGE	' '
21 #define GOT_STATUS_ADD		'A'
22 #define GOT_STATUS_EXISTS	'E'
23 #define GOT_STATUS_UPDATE	'U'
24 #define GOT_STATUS_DELETE	'D'
25 #define GOT_STATUS_MODIFY	'M'
26 #define GOT_STATUS_CONFLICT	'C'
27 #define GOT_STATUS_MERGE	'G'
28 #define GOT_STATUS_MISSING	'!'
29 #define GOT_STATUS_UNVERSIONED	'?'
30 #define GOT_STATUS_OBSTRUCTED	'~'
31 #define GOT_STATUS_REVERT	'R'
32 
33 struct got_commitable {
34 	char *path;
35 	char *in_repo_path;
36 	char *ondisk_path;
37 	unsigned char status;
38 	struct got_object_id *blob_id;
39 	struct got_object_id *base_id;
40 	mode_t mode;
41 };
42 
43 /*
44  * Attempt to initialize a new work tree on disk.
45  * The first argument is the path to a directory where the work tree
46  * will be created. The path itself must not yet exist, but the dirname(3)
47  * of the path must already exist.
48  * The reference provided will be used to determine the new worktree's
49  * base commit. The third argument speficies the work tree's path prefix.
50  */
51 const struct got_error *got_worktree_init(const char *, struct got_reference *,
52     const char *, struct got_repository *);
53 
54 /*
55  * Attempt to open a worktree at or above the specified path.
56  * The caller must dispose of it with got_worktree_close().
57  */
58 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
59 
60 /* Dispose of an open work tree. */
61 const struct got_error *got_worktree_close(struct got_worktree *);
62 
63 /*
64  * Get the path to the root directory of a worktree.
65  */
66 const char *got_worktree_get_root_path(struct got_worktree *);
67 
68 /*
69  * Get the path to the repository associated with a worktree.
70  */
71 const char *got_worktree_get_repo_path(struct got_worktree *);
72 
73 /*
74  * Get the path prefix associated with a worktree.
75  */
76 const char *got_worktree_get_path_prefix(struct got_worktree *);
77 
78 /*
79  * Check if a user-provided path prefix matches that of the worktree.
80  */
81 const struct got_error *got_worktree_match_path_prefix(int *,
82     struct got_worktree *, const char *);
83 
84 /*
85  * Get the name of a work tree's HEAD reference.
86  */
87 const char *got_worktree_get_head_ref_name(struct got_worktree *);
88 
89 /*
90  * Get the current base commit ID of a worktree.
91  */
92 struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
93 
94 /*
95  * Set the base commit Id of a worktree.
96  */
97 const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
98     struct got_repository *, struct got_object_id *);
99 
100 /* A callback function which is invoked when a path is checked out. */
101 typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
102 
103 /* A callback function which is invoked at cancellation points.
104  * May return GOT_ERR_CANCELLED to abort the runing operation. */
105 typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
106 
107 /*
108  * Attempt to check out files into a work tree from its associated repository
109  * and path prefix, and update the work tree's file index accordingly.
110  * File content is obtained from blobs within the work tree's path prefix
111  * inside the tree corresponding to the work tree's base commit.
112  * The checkout progress callback will be invoked with the provided
113  * void * argument, and the path of each checked out file.
114  *
115  * It is possible to restrict the checkout operation to a specific path in
116  * the work tree, in which case all files outside this path will remain at
117  * their currently recorded base commit. Inconsistent base commits can be
118  * repaired later by running another update operation across the entire work
119  * tree. Inconsistent base-commits may also occur if this function runs into
120  * an error or if the checkout operation is cancelled by the cancel callback.
121  * The specified path is relative to the work tree's root. Pass "" to check
122  * out files across the entire work tree.
123  *
124  * Some operations may refuse to run while the work tree contains files from
125  * multiple base commits.
126  */
127 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
128     const char *, struct got_repository *, got_worktree_checkout_cb, void *,
129     got_worktree_cancel_cb, void *);
130 
131 /* A callback function which is invoked to report a path's status. */
132 typedef const struct got_error *(*got_worktree_status_cb)(void *,
133     unsigned char, const char *, struct got_object_id *);
134 
135 /*
136  * Report the status of paths in the work tree.
137  * The status callback will be invoked with the provided void * argument,
138  * a path, and a corresponding status code.
139  */
140 const struct got_error *got_worktree_status(struct got_worktree *,
141     const char *, struct got_repository *, got_worktree_status_cb, void *,
142     got_worktree_cancel_cb cancel_cb, void *);
143 
144 /*
145  * Try to resolve a user-provided path to an on-disk path in the work tree.
146  * The caller must dispose of the resolved path with free(3).
147  */
148 const struct got_error *got_worktree_resolve_path(char **,
149     struct got_worktree *, const char *);
150 
151 /* Schedule files at on-disk paths for addition in the next commit. */
152 const struct got_error *got_worktree_schedule_add(struct got_worktree *,
153     struct got_pathlist_head *, got_worktree_status_cb, void *,
154     struct got_repository *);
155 
156 /*
157  * Remove a file from disk and schedule it to be deleted in the next commit.
158  * Don't allow deleting files with uncommitted modifications, unless the
159  * parameter 'delete_local_mods' is set.
160  */
161 const struct got_error *
162 got_worktree_schedule_delete(struct got_worktree *, const char *, int,
163    got_worktree_status_cb, void *, struct got_repository *);
164 
165 /*
166  * Revert a file at the specified path such that it matches its
167  * original state in the worktree's base commit.
168  */
169 const struct got_error *got_worktree_revert(struct got_worktree *,
170     const char *, got_worktree_checkout_cb, void *, struct got_repository *);
171 
172 /*
173  * A callback function which is invoked when a commit message is requested.
174  * Passes a list of modified paths being committed to, a pointer to the log
175  * message that must be set by the callback and will be freed after committing,
176  * and an argument passed through to the callback.
177  */
178 typedef const struct got_error *(*got_worktree_commit_msg_cb)(
179     struct got_pathlist_head *, char **, void *);
180 
181 /*
182  * Create a new commit from changes in the work tree.
183  * Return the ID of the newly created commit.
184  * The worktree's base commit will be set to this new commit.
185  * Files unaffected by this commit operation will retain their
186  * current base commit.
187  * An author and a non-empty log message must be specified.
188  * The name of the committer is optional (may be NULL).
189  * If an on-disk path is specified, only commit changes at or within this path.
190  */
191 const struct got_error *got_worktree_commit(struct got_object_id **,
192     struct got_worktree *, const char *, const char *, const char *,
193     got_worktree_commit_msg_cb, void *,
194     got_worktree_status_cb, void *, struct got_repository *);