Blame


1 7b19e0f1 2017-11-05 stsp /*
2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3 7b19e0f1 2017-11-05 stsp *
4 7b19e0f1 2017-11-05 stsp * Permission to use, copy, modify, and distribute this software for any
5 7b19e0f1 2017-11-05 stsp * purpose with or without fee is hereby granted, provided that the above
6 7b19e0f1 2017-11-05 stsp * copyright notice and this permission notice appear in all copies.
7 7b19e0f1 2017-11-05 stsp *
8 7b19e0f1 2017-11-05 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 7b19e0f1 2017-11-05 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 7b19e0f1 2017-11-05 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 7b19e0f1 2017-11-05 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 7b19e0f1 2017-11-05 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 7b19e0f1 2017-11-05 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 7b19e0f1 2017-11-05 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 7b19e0f1 2017-11-05 stsp */
16 7b19e0f1 2017-11-05 stsp
17 3b339b2f 2018-02-12 stsp struct got_repository;
18 3ce1b845 2019-07-15 stsp struct got_pathlist_head;
19 303e2782 2019-08-09 stsp struct got_tag_object;
20 4027f31a 2017-11-04 stsp
21 0c60ce5a 2018-04-02 stsp /* Open and close repositories. */
22 c9956ddf 2019-09-08 stsp const struct got_error *got_repo_open(struct got_repository**, const char *,
23 c9956ddf 2019-09-08 stsp const char *);
24 ad242220 2018-09-08 stsp const struct got_error *got_repo_close(struct got_repository*);
25 4027f31a 2017-11-04 stsp
26 4b0bb327 2019-01-06 stsp /* Obtain the on-disk path to the repository. */
27 7839bc15 2019-01-06 stsp const char *got_repo_get_path(struct got_repository *);
28 4b0bb327 2019-01-06 stsp
29 4b0bb327 2019-01-06 stsp /*
30 4b0bb327 2019-01-06 stsp * Obtain the path to a non-bare repository's .git directory.
31 4b0bb327 2019-01-06 stsp * For bare repositories, this returns the same result as got_repo_get_path().
32 4b0bb327 2019-01-06 stsp */
33 6e9da951 2019-01-06 stsp const char *got_repo_get_path_git_dir(struct got_repository *);
34 7839bc15 2019-01-06 stsp
35 aba9c984 2019-09-08 stsp /* Obtain the commit author name if parsed from gitconfig, else NULL. */
36 aba9c984 2019-09-08 stsp const char *got_repo_get_gitconfig_author_name(struct got_repository *);
37 aba9c984 2019-09-08 stsp
38 aba9c984 2019-09-08 stsp /* Obtain the commit author email if parsed from gitconfig, else NULL. */
39 aba9c984 2019-09-08 stsp const char *got_repo_get_gitconfig_author_email(struct got_repository *);
40 aba9c984 2019-09-08 stsp
41 c9956ddf 2019-09-08 stsp /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
42 c9956ddf 2019-09-08 stsp const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
43 c9956ddf 2019-09-08 stsp
44 c9956ddf 2019-09-08 stsp /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
45 c9956ddf 2019-09-08 stsp const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
46 c9956ddf 2019-09-08 stsp
47 0c60ce5a 2018-04-02 stsp /*
48 0c60ce5a 2018-04-02 stsp * Obtain paths to various directories within a repository.
49 0c60ce5a 2018-04-02 stsp * The caller must dispose of a path with free(3).
50 0c60ce5a 2018-04-02 stsp */
51 11995603 2017-11-05 stsp char *got_repo_get_path_objects(struct got_repository *);
52 a1fd68d8 2018-01-12 stsp char *got_repo_get_path_objects_pack(struct got_repository *);
53 11995603 2017-11-05 stsp char *got_repo_get_path_refs(struct got_repository *);
54 fb79db15 2019-02-01 stsp char *got_repo_get_path_packed_refs(struct got_repository *);
55 11995603 2017-11-05 stsp
56 11995603 2017-11-05 stsp struct got_reference;
57 11995603 2017-11-05 stsp
58 0c60ce5a 2018-04-02 stsp /*
59 0c60ce5a 2018-04-02 stsp * Obtain a reference, by name, from a repository.
60 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_ref_close().
61 0c60ce5a 2018-04-02 stsp */
62 4027f31a 2017-11-04 stsp const struct got_error *got_repo_get_reference(struct got_reference **,
63 4027f31a 2017-11-04 stsp struct got_repository *, const char *);
64 04ca23f4 2018-07-16 stsp
65 04ca23f4 2018-07-16 stsp
66 04ca23f4 2018-07-16 stsp /* Indicate whether this is a bare repositiry (contains no git working tree). */
67 04ca23f4 2018-07-16 stsp int got_repo_is_bare(struct got_repository *);
68 04ca23f4 2018-07-16 stsp
69 04ca23f4 2018-07-16 stsp /* Attempt to map an arbitrary path to a path within the repository. */
70 04ca23f4 2018-07-16 stsp const struct got_error *got_repo_map_path(char **, struct got_repository *,
71 23721109 2018-10-22 stsp const char *, int);
72 2c7829a4 2019-06-17 stsp
73 2c7829a4 2019-06-17 stsp /* Create a new repository in an empty directory at a specified path. */
74 2c7829a4 2019-06-17 stsp const struct got_error *got_repo_init(const char *);
75 e09a504c 2019-06-28 stsp
76 e09a504c 2019-06-28 stsp /* Attempt to find a unique object ID for a given ID string prefix. */
77 e09a504c 2019-06-28 stsp const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
78 dd88155e 2019-06-29 stsp const char *, int, struct got_repository *);
79 3ce1b845 2019-07-15 stsp
80 303e2782 2019-08-09 stsp /*
81 303e2782 2019-08-09 stsp * Attempt to find a tag object with a given name and target object type.
82 303e2782 2019-08-09 stsp * Return GOT_ERR_NO_OBJ if no matching tag can be found.
83 303e2782 2019-08-09 stsp */
84 303e2782 2019-08-09 stsp const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
85 303e2782 2019-08-09 stsp const char *, int, struct got_repository *);
86 303e2782 2019-08-09 stsp
87 3ce1b845 2019-07-15 stsp /* A callback function which is invoked when a path is imported. */
88 3ce1b845 2019-07-15 stsp typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
89 3ce1b845 2019-07-15 stsp
90 3ce1b845 2019-07-15 stsp /*
91 3ce1b845 2019-07-15 stsp * Import an unversioned directory tree into the repository.
92 3ce1b845 2019-07-15 stsp * Creates a root commit, i.e. a commit with zero parents.
93 3ce1b845 2019-07-15 stsp */
94 3ce1b845 2019-07-15 stsp const struct got_error *got_repo_import(struct got_object_id **, const char *,
95 3ce1b845 2019-07-15 stsp const char *, const char *, struct got_pathlist_head *,
96 3ce1b845 2019-07-15 stsp struct got_repository *, got_repo_import_cb, void *);