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 /*
34  * Attempt to initialize a new work tree on disk.
35  * The first argument is the path to a directory where the work tree
36  * will be created. The path itself must not yet exist, but the dirname(3)
37  * of the path must already exist.
38  * The reference provided will be used to determine the new worktree's
39  * base commit. The third argument speficies the work tree's path prefix.
40  */
41 const struct got_error *got_worktree_init(const char *, struct got_reference *,
42     const char *, struct got_repository *);
43 
44 /*
45  * Attempt to open a worktree at or above the specified path.
46  * The caller must dispose of it with got_worktree_close().
47  */
48 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
49 
50 /* Dispose of an open work tree. */
51 const struct got_error *got_worktree_close(struct got_worktree *);
52 
53 /*
54  * Get the path to the root directory of a worktree.
55  */
56 const char *got_worktree_get_root_path(struct got_worktree *);
57 
58 /*
59  * Get the path to the repository associated with a worktree.
60  */
61 const char *got_worktree_get_repo_path(struct got_worktree *);
62 
63 /*
64  * Get the path prefix associated with a worktree.
65  */
66 const char *got_worktree_get_path_prefix(struct got_worktree *);
67 
68 /*
69  * Check if a user-provided path prefix matches that of the worktree.
70  */
71 const struct got_error *got_worktree_match_path_prefix(int *,
72     struct got_worktree *, const char *);
73 
74 /*
75  * Get the name of a work tree's HEAD reference.
76  * The caller must dispose of it with free(3).
77  */
78 char *got_worktree_get_head_ref_name(struct got_worktree *);
79 
80 /*
81  * Get the work tree's HEAD reference.
82  * The caller must dispose of it with free(3).
83  */
84 struct got_reference *got_worktree_get_head_ref(struct got_worktree *);
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 
132 /*
133  * Report the status of paths in the work tree.
134  * The status callback will be invoked with the provided void * argument,
135  * a path, and a corresponding status code.
136  */
137 const struct got_error *got_worktree_status(struct got_worktree *,
138     const char *, struct got_repository *, got_worktree_status_cb, void *,
139     got_worktree_cancel_cb cancel_cb, void *);
140 
141 /*
142  * Try to resolve a user-provided path to an on-disk path in the work tree.
143  * The caller must dispose of the resolved path with free(3).
144  */
145 const struct got_error *got_worktree_resolve_path(char **,
146     struct got_worktree *, const char *);
147 
148 /* Schedule a file at an on-disk path for addition in the next commit. */
149 const struct got_error *got_worktree_schedule_add(struct got_worktree *,
150     const char *, got_worktree_status_cb, void *, struct got_repository *);
151 
152 /*
153  * Remove a file from disk and schedule it to be deleted in the next commit.
154  * Don't allow deleting files with uncommitted modifications, unless the
155  * parameter 'delete_local_mods' is set.
156  */
157 const struct got_error *
158 got_worktree_schedule_delete(struct got_worktree *, const char *, int,
159    got_worktree_status_cb, void *, struct got_repository *);
160 
161 /*
162  * Revert a file at the specified path such that it matches its
163  * original state in the worktree's base commit.
164  */
165 const struct got_error *got_worktree_revert(struct got_worktree *,
166     const char *, got_worktree_checkout_cb, void *, struct got_repository *);