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