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 /* XXX TODO make this opaque */
34 struct got_commitable {
35 	char *path;
36 	char *in_repo_path;
37 	char *ondisk_path;
38 	unsigned char status;
39 	struct got_object_id *blob_id;
40 	struct got_object_id *base_blob_id;
41 	struct got_object_id *base_commit_id;
42 	mode_t mode;
43 	int flags;
44 #define GOT_COMMITABLE_ADDED 0x01
45 };
46 
47 /*
48  * Attempt to initialize a new work tree on disk.
49  * The first argument is the path to a directory where the work tree
50  * will be created. The path itself must not yet exist, but the dirname(3)
51  * of the path must already exist.
52  * The reference provided will be used to determine the new worktree's
53  * base commit. The third argument speficies the work tree's path prefix.
54  */
55 const struct got_error *got_worktree_init(const char *, struct got_reference *,
56     const char *, struct got_repository *);
57 
58 /*
59  * Attempt to open a worktree at or above the specified path.
60  * The caller must dispose of it with got_worktree_close().
61  */
62 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
63 
64 /* Dispose of an open work tree. */
65 const struct got_error *got_worktree_close(struct got_worktree *);
66 
67 /*
68  * Get the path to the root directory of a worktree.
69  */
70 const char *got_worktree_get_root_path(struct got_worktree *);
71 
72 /*
73  * Get the path to the repository associated with a worktree.
74  */
75 const char *got_worktree_get_repo_path(struct got_worktree *);
76 
77 /*
78  * Get the path prefix associated with a worktree.
79  */
80 const char *got_worktree_get_path_prefix(struct got_worktree *);
81 
82 /*
83  * Check if a user-provided path prefix matches that of the worktree.
84  */
85 const struct got_error *got_worktree_match_path_prefix(int *,
86     struct got_worktree *, const char *);
87 
88 /*
89  * Get the name of a work tree's HEAD reference.
90  */
91 const char *got_worktree_get_head_ref_name(struct got_worktree *);
92 
93 /*
94  * Set the branch head reference of the work tree.
95  */
96 const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
97     struct got_reference *);
98 
99 /*
100  * Get the current base commit ID of a worktree.
101  */
102 struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
103 
104 /*
105  * Set the base commit Id of a worktree.
106  */
107 const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
108     struct got_repository *, struct got_object_id *);
109 
110 /* A callback function which is invoked when a path is checked out. */
111 typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
112 
113 /* A callback function which is invoked at cancellation points.
114  * May return GOT_ERR_CANCELLED to abort the runing operation. */
115 typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
116 
117 /*
118  * Attempt to check out files into a work tree from its associated repository
119  * and path prefix, and update the work tree's file index accordingly.
120  * File content is obtained from blobs within the work tree's path prefix
121  * inside the tree corresponding to the work tree's base commit.
122  * The checkout progress callback will be invoked with the provided
123  * void * argument, and the path of each checked out file.
124  *
125  * It is possible to restrict the checkout operation to a specific path in
126  * the work tree, in which case all files outside this path will remain at
127  * their currently recorded base commit. Inconsistent base commits can be
128  * repaired later by running another update operation across the entire work
129  * tree. Inconsistent base-commits may also occur if this function runs into
130  * an error or if the checkout operation is cancelled by the cancel callback.
131  * The specified path is relative to the work tree's root. Pass "" to check
132  * out files across the entire work tree.
133  *
134  * Some operations may refuse to run while the work tree contains files from
135  * multiple base commits.
136  */
137 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
138     const char *, struct got_repository *, got_worktree_checkout_cb, void *,
139     got_worktree_cancel_cb, void *);
140 
141 /* A callback function which is invoked to report a path's status. */
142 typedef const struct got_error *(*got_worktree_status_cb)(void *,
143     unsigned char, const char *, struct got_object_id *,
144     struct got_object_id *);
145 
146 /*
147  * Report the status of paths in the work tree.
148  * The status callback will be invoked with the provided void * argument,
149  * a path, and a corresponding status code.
150  */
151 const struct got_error *got_worktree_status(struct got_worktree *,
152     const char *, struct got_repository *, got_worktree_status_cb, void *,
153     got_worktree_cancel_cb cancel_cb, void *);
154 
155 /*
156  * Try to resolve a user-provided path to an on-disk path in the work tree.
157  * The caller must dispose of the resolved path with free(3).
158  */
159 const struct got_error *got_worktree_resolve_path(char **,
160     struct got_worktree *, const char *);
161 
162 /* Schedule files at on-disk paths for addition in the next commit. */
163 const struct got_error *got_worktree_schedule_add(struct got_worktree *,
164     struct got_pathlist_head *, got_worktree_status_cb, void *,
165     struct got_repository *);
166 
167 /*
168  * Remove a file from disk and schedule it to be deleted in the next commit.
169  * Don't allow deleting files with uncommitted modifications, unless the
170  * parameter 'delete_local_mods' is set.
171  */
172 const struct got_error *
173 got_worktree_schedule_delete(struct got_worktree *, const char *, int,
174    got_worktree_status_cb, void *, struct got_repository *);
175 
176 /*
177  * Revert a file at the specified path such that it matches its
178  * original state in the worktree's base commit.
179  */
180 const struct got_error *got_worktree_revert(struct got_worktree *,
181     const char *, got_worktree_checkout_cb, void *, struct got_repository *);
182 
183 /*
184  * A callback function which is invoked when a commit message is requested.
185  * Passes a list of modified paths being committed to, a pointer to the log
186  * message that must be set by the callback and will be freed after committing,
187  * and an argument passed through to the callback.
188  */
189 typedef const struct got_error *(*got_worktree_commit_msg_cb)(
190     struct got_pathlist_head *, char **, void *);
191 
192 /*
193  * Create a new commit from changes in the work tree.
194  * Return the ID of the newly created commit.
195  * The worktree's base commit will be set to this new commit.
196  * Files unaffected by this commit operation will retain their
197  * current base commit.
198  * An author and a non-empty log message must be specified.
199  * The name of the committer is optional (may be NULL).
200  * If an on-disk path is specified, only commit changes at or within this path.
201  */
202 const struct got_error *got_worktree_commit(struct got_object_id **,
203     struct got_worktree *, const char *, const char *, const char *,
204     got_worktree_commit_msg_cb, void *,
205     got_worktree_status_cb, void *, struct got_repository *);