1 /*
2  * Copyright (c) 2018 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 /*
20  * Attempt to initialize a new work tree on disk.
21  * The first argument is the path to a directory where the work tree
22  * will be created. The path itself must not yet exist, but the dirname(3)
23  * of the path must already exist.
24  * The reference provided will be used as the new worktree's HEAD.
25  * The third argument speficies the work tree's path prefix.
26  */
27 const struct got_error *got_worktree_init(const char *, struct got_reference *,
28     const char *, struct got_repository *);
29 
30 /*
31  * Attempt to open a worktree at the specified path.
32  * The caller must dispose of it with got_worktree_close().
33  */
34 const struct got_error *got_worktree_open(struct got_worktree **, const char *);
35 
36 /* Dispose of an open work tree. */
37 void got_worktree_close(struct got_worktree *);
38 
39 /*
40  * Get the path to the repository associated with a worktree.
41  * The caller must dispose of it with free(3).
42  */
43 char *got_worktree_get_repo_path(struct got_worktree *);
44 
45 /*
46  * Get the name of a work tree's HEAD reference.
47  * The caller must dispose of it with free(3).
48  */
49 char  *got_worktree_get_head_ref_name(struct got_worktree *);
50 
51 /* A callback function which is invoked when a path is checked out. */
52 typedef void (*got_worktree_checkout_cb)(void *, const char *);
53 
54 /*
55  * Attempt to check out files into a work tree from its associated repository
56  * and path prefix, and update the work tree's file index accordingly.
57  * File content is obtained from blobs within the work tree's path prefix
58  * inside the tree resolved via the provided reference.
59  * The checkout progress callback will be invoked with the provided
60  * void * argument, and the path of each checked out file.
61  */
62 const struct got_error *got_worktree_checkout_files(struct got_worktree *,
63     struct got_reference *, struct got_repository *,
64     got_worktree_checkout_cb progress, void *);