1 86c3caaf 2018-03-09 stsp /*
 2 86c3caaf 2018-03-09 stsp  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
 3 86c3caaf 2018-03-09 stsp  *
 4 86c3caaf 2018-03-09 stsp  * Permission to use, copy, modify, and distribute this software for any
 5 86c3caaf 2018-03-09 stsp  * purpose with or without fee is hereby granted, provided that the above
 6 86c3caaf 2018-03-09 stsp  * copyright notice and this permission notice appear in all copies.
 7 86c3caaf 2018-03-09 stsp  *
 8 86c3caaf 2018-03-09 stsp  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 9 86c3caaf 2018-03-09 stsp  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 86c3caaf 2018-03-09 stsp  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 86c3caaf 2018-03-09 stsp  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 86c3caaf 2018-03-09 stsp  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 86c3caaf 2018-03-09 stsp  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 86c3caaf 2018-03-09 stsp  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 86c3caaf 2018-03-09 stsp  */
16 86c3caaf 2018-03-09 stsp 
17 86c3caaf 2018-03-09 stsp struct got_worktree;
18 86c3caaf 2018-03-09 stsp 
19 0c60ce5a 2018-04-02 stsp /*
20 0c60ce5a 2018-04-02 stsp  * Attempt to initialize a new work tree on disk.
21 0c60ce5a 2018-04-02 stsp  * The first argument is the path to a directory where the work tree
22 0c60ce5a 2018-04-02 stsp  * will be created. The path itself must not yet exist, but the dirname(3)
23 0c60ce5a 2018-04-02 stsp  * of the path must already exist.
24 0c60ce5a 2018-04-02 stsp  * The reference provided will be used as the new worktree's HEAD.
25 0c60ce5a 2018-04-02 stsp  * The third argument speficies the work tree's path prefix.
26 0c60ce5a 2018-04-02 stsp  */
27 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_init(const char *, struct got_reference *,
28 577ec78f 2018-03-11 stsp     const char *, struct got_repository *);
29 0c60ce5a 2018-04-02 stsp 
30 0c60ce5a 2018-04-02 stsp /*
31 0c60ce5a 2018-04-02 stsp  * Attempt to open a worktree at the specified path.
32 0c60ce5a 2018-04-02 stsp  * The caller must dispose of it with got_worktree_close().
33 0c60ce5a 2018-04-02 stsp  */
34 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_open(struct got_worktree **, const char *);
35 0c60ce5a 2018-04-02 stsp 
36 0c60ce5a 2018-04-02 stsp /* Dispose of an open work tree. */
37 86c3caaf 2018-03-09 stsp void got_worktree_close(struct got_worktree *);
38 0c60ce5a 2018-04-02 stsp 
39 0c60ce5a 2018-04-02 stsp /*
40 0c60ce5a 2018-04-02 stsp  * Get the path to the repository associated with a worktree.
41 0c60ce5a 2018-04-02 stsp  * The caller must dispose of it with free(3).
42 0c60ce5a 2018-04-02 stsp  */
43 86c3caaf 2018-03-09 stsp char *got_worktree_get_repo_path(struct got_worktree *);
44 0c60ce5a 2018-04-02 stsp 
45 0c60ce5a 2018-04-02 stsp /*
46 0c60ce5a 2018-04-02 stsp  * Get the name of a work tree's HEAD reference.
47 0c60ce5a 2018-04-02 stsp  * The caller must dispose of it with free(3).
48 0c60ce5a 2018-04-02 stsp  */
49 35be1456 2018-03-11 stsp char  *got_worktree_get_head_ref_name(struct got_worktree *);
50 0c60ce5a 2018-04-02 stsp 
51 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
52 92a684f4 2018-03-12 stsp typedef void (*got_worktree_checkout_cb)(void *, const char *);
53 0c60ce5a 2018-04-02 stsp 
54 0c60ce5a 2018-04-02 stsp /*
55 0c60ce5a 2018-04-02 stsp  * Attempt to check out files into a work tree from its associated repository
56 0c60ce5a 2018-04-02 stsp  * and path prefix, and update the work tree's file index accordingly.
57 0c60ce5a 2018-04-02 stsp  * File content is obtained from blobs within the work tree's path prefix
58 0c60ce5a 2018-04-02 stsp  * inside the tree resolved via the provided reference.
59 0c60ce5a 2018-04-02 stsp  * The checkout progress callback will be invoked with the provided
60 0c60ce5a 2018-04-02 stsp  * void * argument, and the path of each checked out file.
61 0c60ce5a 2018-04-02 stsp  */
62 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
63 92a684f4 2018-03-12 stsp     struct got_reference *, struct got_repository *,
64 0c60ce5a 2018-04-02 stsp     got_worktree_checkout_cb progress, void *);