2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
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.
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.
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;
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*);
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 *);
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().
33 6e9da951 2019-01-06 stsp const char *got_repo_get_path_git_dir(struct got_repository *);
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 *);
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 *);
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 *);
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 *);
47 9a1cc63f 2020-02-03 stsp /* Obtain repository owner name if parsed from gitconfig, else NULL. */
48 9a1cc63f 2020-02-03 stsp const char *got_repo_get_gitconfig_owner(struct got_repository *);
50 cd95becd 2019-11-29 stsp /* Information about one remote repository. */
51 cd95becd 2019-11-29 stsp struct got_remote_repo {
56 469dd726 2020-03-20 stsp * If set, references are mirrored 1:1 into the local repository.
57 469dd726 2020-03-20 stsp * If not set, references are mapped into "refs/remotes/$name/".
59 469dd726 2020-03-20 stsp int mirror_references;
61 b8adfa55 2020-09-25 stsp /* Branches to fetch by default. */
62 b8adfa55 2020-09-25 stsp int nbranches;
63 b8adfa55 2020-09-25 stsp char **branches;
67 b8adfa55 2020-09-25 stsp * Free data allocated for the specified remote repository.
68 b8adfa55 2020-09-25 stsp * Do not free the remote_repo pointer itself.
70 b8adfa55 2020-09-25 stsp void got_repo_free_remote_repo_data(struct got_remote_repo *);
72 b8adfa55 2020-09-25 stsp /* Obtain the list of remote repositories parsed from gitconfig. */
73 50b0790e 2020-09-11 stsp void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
74 cd95becd 2019-11-29 stsp struct got_repository *);
77 50b0790e 2020-09-11 stsp * Obtain a parsed representation of this repository's got.conf file.
78 50b0790e 2020-09-11 stsp * Return NULL if this configuration file could not be read.
80 50b0790e 2020-09-11 stsp const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
83 0c60ce5a 2018-04-02 stsp * Obtain paths to various directories within a repository.
84 0c60ce5a 2018-04-02 stsp * The caller must dispose of a path with free(3).
86 11995603 2017-11-05 stsp char *got_repo_get_path_objects(struct got_repository *);
87 a1fd68d8 2018-01-12 stsp char *got_repo_get_path_objects_pack(struct got_repository *);
88 11995603 2017-11-05 stsp char *got_repo_get_path_refs(struct got_repository *);
89 fb79db15 2019-02-01 stsp char *got_repo_get_path_packed_refs(struct got_repository *);
90 b46f3e71 2020-03-18 stsp char *got_repo_get_path_gitconfig(struct got_repository *);
91 257add31 2020-09-09 stsp char *got_repo_get_path_gotconfig(struct got_repository *);
93 11995603 2017-11-05 stsp struct got_reference;
96 0c60ce5a 2018-04-02 stsp * Obtain a reference, by name, from a repository.
97 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_ref_close().
99 4027f31a 2017-11-04 stsp const struct got_error *got_repo_get_reference(struct got_reference **,
100 4027f31a 2017-11-04 stsp struct got_repository *, const char *);
103 04ca23f4 2018-07-16 stsp /* Indicate whether this is a bare repositiry (contains no git working tree). */
104 04ca23f4 2018-07-16 stsp int got_repo_is_bare(struct got_repository *);
106 04ca23f4 2018-07-16 stsp /* Attempt to map an arbitrary path to a path within the repository. */
107 04ca23f4 2018-07-16 stsp const struct got_error *got_repo_map_path(char **, struct got_repository *,
108 8fa913ec 2020-11-14 stsp const char *);
110 2c7829a4 2019-06-17 stsp /* Create a new repository in an empty directory at a specified path. */
111 2c7829a4 2019-06-17 stsp const struct got_error *got_repo_init(const char *);
113 e09a504c 2019-06-28 stsp /* Attempt to find a unique object ID for a given ID string prefix. */
114 e09a504c 2019-06-28 stsp const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
115 dd88155e 2019-06-29 stsp const char *, int, struct got_repository *);
118 71a27632 2020-01-15 stsp * Given an object ID string or reference name, attempt to find a corresponding
119 71a27632 2020-01-15 stsp * commit object. Tags can optionally be ignored during matching.
120 71a27632 2020-01-15 stsp * The object type may be restricted to commit, tree, blob, or tag.
121 71a27632 2020-01-15 stsp * GOT_OBJ_TYPE_ANY will match any type of object.
122 71a27632 2020-01-15 stsp * A human-readable label can optionally be returned, which the caller should
123 71a27632 2020-01-15 stsp * dispose of with free(3).
124 71a27632 2020-01-15 stsp * Return GOT_ERR_NO_OBJ if no matching commit can be found.
126 71a27632 2020-01-15 stsp const struct got_error *got_repo_match_object_id(struct got_object_id **,
127 71a27632 2020-01-15 stsp char **, const char *, int, int, struct got_repository *);
130 303e2782 2019-08-09 stsp * Attempt to find a tag object with a given name and target object type.
131 303e2782 2019-08-09 stsp * Return GOT_ERR_NO_OBJ if no matching tag can be found.
133 303e2782 2019-08-09 stsp const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
134 303e2782 2019-08-09 stsp const char *, int, struct got_repository *);
136 3ce1b845 2019-07-15 stsp /* A callback function which is invoked when a path is imported. */
137 3ce1b845 2019-07-15 stsp typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
140 3ce1b845 2019-07-15 stsp * Import an unversioned directory tree into the repository.
141 3ce1b845 2019-07-15 stsp * Creates a root commit, i.e. a commit with zero parents.
143 3ce1b845 2019-07-15 stsp const struct got_error *got_repo_import(struct got_object_id **, const char *,
144 3ce1b845 2019-07-15 stsp const char *, const char *, struct got_pathlist_head *,
145 3ce1b845 2019-07-15 stsp struct got_repository *, got_repo_import_cb, void *);
