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