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_MODIFIY	'M'
26 #define GOT_STATUS_MISSING	'!'
27 #define GOT_STATUS_UNVERSIONED	'?'
28 
29 /*
30  * Attempt to initialize a new work tree on disk.
31  * The first argument is the path to a directory where the work tree
32  * will be created. The path itself must not yet exist, but the dirname(3)
33  * of the path must already exist.
34  * The reference provided will be used to determine the new worktree's
35  * base commit. The third argument speficies the work tree's path prefix.
36  */
37 const struct got_error *got_worktree_init(const char *, struct got_reference *,
38     const char *, struct got_repository *);
39 
40 /*
41  * Attempt to open a worktree at the specified path.
42  * The caller must dispose of it with got_worktree_close().
43  */
44 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
45 
46 /* Dispose of an open work tree. */
47 void got_worktree_close(struct got_worktree *);
48 
49 /*
50  * Get the path to the repository associated with a worktree.
51  */
52 const char *got_worktree_get_repo_path(struct got_worktree *);
53 
54 /*
55  * Get the path prefix associated with a worktree.
56  */
57 const char *got_worktree_get_path_prefix(struct got_worktree *);
58 
59 /*
60  * Check if a user-provided path prefix matches that of the worktree.
61  */
62 const struct got_error *got_worktree_match_path_prefix(int *,
63     struct got_worktree *, const char *);
64 
65 /*
66  * Get the name of a work tree's HEAD reference.
67  * The caller must dispose of it with free(3).
68  */
69 char  *got_worktree_get_head_ref_name(struct got_worktree *);
70 
71 /*
72  * Get the work tree's HEAD reference.
73  * The caller must dispose of it with free(3).
74  */
75 struct got_reference *got_worktree_get_head_ref(struct got_worktree *);
76 
77 /*
78  * Get the current base commit ID of a worktree.
79  */
80 const struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
81 
82 /*
83  * Set the base commit Id of a worktree.
84  */
85 const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
86     struct got_repository *, struct got_object_id *);
87 
88 /* A callback function which is invoked when a path is checked out. */
89 typedef void (*got_worktree_checkout_cb)(void *, unsigned char, const char *);
90 
91 /* A callback function which is invoked at cancellation points.
92  * May return GOT_ERR_CANCELLED to abort the runing operation. */
93 typedef const struct got_error *(*got_worktree_cancel_cb)(void *);
94 
95 /*
96  * Attempt to check out files into a work tree from its associated repository
97  * and path prefix, and update the work tree's file index accordingly.
98  * File content is obtained from blobs within the work tree's path prefix
99  * inside the tree corresponding to the work tree's base commit.
100  * The checkout progress callback will be invoked with the provided
101  * void * argument, and the path of each checked out file.
102  */
103 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
104     struct got_repository *, got_worktree_checkout_cb progress, void *,
105     got_worktree_cancel_cb, void *);
106 
107 /* A callback function which is invoked to report a path's status. */
108 typedef void (*got_worktree_status_cb)(void *, unsigned char, const char *);
109 
110 /*
111  * Report the status of paths in the work tree.
112  * The status callback will be invoked with the provided void * argument,
113  * a path, and a corresponding status code.
114  */
115 const struct got_error *
116 got_worktree_status(struct got_worktree *, struct got_repository *,
117     got_worktree_status_cb, void *, got_worktree_cancel_cb cancel_cb, void *);