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_repository;
18 struct got_pathlist_head;
19 
20 /* Open and close repositories. */
21 const struct got_error *got_repo_open(struct got_repository**, const char *);
22 const struct got_error *got_repo_close(struct got_repository*);
23 
24 /* Obtain the on-disk path to the repository. */
25 const char *got_repo_get_path(struct got_repository *);
26 
27 /*
28  * Obtain the path to a non-bare repository's .git directory.
29  * For bare repositories, this returns the same result as got_repo_get_path().
30  */
31 const char *got_repo_get_path_git_dir(struct got_repository *);
32 
33 /*
34  * Obtain paths to various directories within a repository.
35  * The caller must dispose of a path with free(3).
36  */
37 char *got_repo_get_path_objects(struct got_repository *);
38 char *got_repo_get_path_objects_pack(struct got_repository *);
39 char *got_repo_get_path_refs(struct got_repository *);
40 char *got_repo_get_path_packed_refs(struct got_repository *);
41 
42 struct got_reference;
43 
44 /*
45  * Obtain a reference, by name, from a repository.
46  * The caller must dispose of it with got_ref_close().
47  */
48 const struct got_error *got_repo_get_reference(struct got_reference **,
49     struct got_repository *, const char *);
50 
51 
52 /* Indicate whether this is a bare repositiry (contains no git working tree). */
53 int got_repo_is_bare(struct got_repository *);
54 
55 /* Attempt to map an arbitrary path to a path within the repository. */
56 const struct got_error *got_repo_map_path(char **, struct got_repository *,
57     const char *, int);
58 
59 /* Create a new repository in an empty directory at a specified path. */
60 const struct got_error *got_repo_init(const char *);
61 
62 /* Attempt to find a unique object ID for a given ID string prefix. */
63 const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
64     const char *, int, struct got_repository *);
65 
66 /* A callback function which is invoked when a path is imported. */
67 typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
68 
69 /*
70  * Import an unversioned directory tree into the repository.
71  * Creates a root commit, i.e. a commit with zero parents.
72  */
73 const struct got_error *got_repo_import(struct got_object_id **, const char *,
74     const char *, const char *, struct got_pathlist_head *,
75     struct got_repository *, got_repo_import_cb, void *);