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 0ae84acc 2022-06-15 tracey const char *, int *);
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 6d5a9006 2020-12-16 yzhong /* Obtain the file descriptor of the repository's .git directory. */
36 6d5a9006 2020-12-16 yzhong int got_repo_get_fd(struct got_repository *);
38 aba9c984 2019-09-08 stsp /* Obtain the commit author name if parsed from gitconfig, else NULL. */
39 aba9c984 2019-09-08 stsp const char *got_repo_get_gitconfig_author_name(struct got_repository *);
41 aba9c984 2019-09-08 stsp /* Obtain the commit author email if parsed from gitconfig, else NULL. */
42 aba9c984 2019-09-08 stsp const char *got_repo_get_gitconfig_author_email(struct got_repository *);
44 c9956ddf 2019-09-08 stsp /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
45 c9956ddf 2019-09-08 stsp const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
47 c9956ddf 2019-09-08 stsp /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
48 c9956ddf 2019-09-08 stsp const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
50 9a1cc63f 2020-02-03 stsp /* Obtain repository owner name if parsed from gitconfig, else NULL. */
51 9a1cc63f 2020-02-03 stsp const char *got_repo_get_gitconfig_owner(struct got_repository *);
53 798586ca 2023-02-05 op /* Query if a given Git extension is enabled in gitconfig. */
54 798586ca 2023-02-05 op int got_repo_has_extension(struct got_repository *, const char *);
56 cd95becd 2019-11-29 stsp /* Information about one remote repository. */
57 cd95becd 2019-11-29 stsp struct got_remote_repo {
59 6480c871 2021-08-30 stsp char *fetch_url;
60 6480c871 2021-08-30 stsp char *send_url;
63 6480c871 2021-08-30 stsp * If set, fetched references are mirrored 1:1 into our repository.
64 469dd726 2020-03-20 stsp * If not set, references are mapped into "refs/remotes/$name/".
66 469dd726 2020-03-20 stsp int mirror_references;
69 0c8b29c5 2021-01-05 stsp * If set, fetch all branches by default and ignore the list of
70 0c8b29c5 2021-01-05 stsp * branches below.
72 0c8b29c5 2021-01-05 stsp int fetch_all_branches;
74 b8adfa55 2020-09-25 stsp /* Branches to fetch by default. */
75 6480c871 2021-08-30 stsp int nfetch_branches;
76 6480c871 2021-08-30 stsp char **fetch_branches;
78 6480c871 2021-08-30 stsp /* Branches to send by default. */
79 6480c871 2021-08-30 stsp int nsend_branches;
80 6480c871 2021-08-30 stsp char **send_branches;
82 99495ddb 2021-01-10 stsp /* Other arbitrary references to fetch by default. */
83 6480c871 2021-08-30 stsp int nfetch_refs;
84 6480c871 2021-08-30 stsp char **fetch_refs;
88 b8adfa55 2020-09-25 stsp * Free data allocated for the specified remote repository.
89 b8adfa55 2020-09-25 stsp * Do not free the remote_repo pointer itself.
91 b8adfa55 2020-09-25 stsp void got_repo_free_remote_repo_data(struct got_remote_repo *);
93 b8adfa55 2020-09-25 stsp /* Obtain the list of remote repositories parsed from gitconfig. */
94 50b0790e 2020-09-11 stsp void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
95 cd95becd 2019-11-29 stsp struct got_repository *);
98 50b0790e 2020-09-11 stsp * Obtain a parsed representation of this repository's got.conf file.
99 50b0790e 2020-09-11 stsp * Return NULL if this configuration file could not be read.
101 50b0790e 2020-09-11 stsp const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
104 0c60ce5a 2018-04-02 stsp * Obtain paths to various directories within a repository.
105 0c60ce5a 2018-04-02 stsp * The caller must dispose of a path with free(3).
107 11995603 2017-11-05 stsp char *got_repo_get_path_objects(struct got_repository *);
108 a1fd68d8 2018-01-12 stsp char *got_repo_get_path_objects_pack(struct got_repository *);
109 11995603 2017-11-05 stsp char *got_repo_get_path_refs(struct got_repository *);
110 fb79db15 2019-02-01 stsp char *got_repo_get_path_packed_refs(struct got_repository *);
111 b46f3e71 2020-03-18 stsp char *got_repo_get_path_gitconfig(struct got_repository *);
112 257add31 2020-09-09 stsp char *got_repo_get_path_gotconfig(struct got_repository *);
114 11995603 2017-11-05 stsp struct got_reference;
115 84de9106 2020-12-26 stsp struct got_reflist_head;
118 0c60ce5a 2018-04-02 stsp * Obtain a reference, by name, from a repository.
119 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_ref_close().
121 4027f31a 2017-11-04 stsp const struct got_error *got_repo_get_reference(struct got_reference **,
122 4027f31a 2017-11-04 stsp struct got_repository *, const char *);
125 04ca23f4 2018-07-16 stsp /* Indicate whether this is a bare repositiry (contains no git working tree). */
126 04ca23f4 2018-07-16 stsp int got_repo_is_bare(struct got_repository *);
128 04ca23f4 2018-07-16 stsp /* Attempt to map an arbitrary path to a path within the repository. */
129 04ca23f4 2018-07-16 stsp const struct got_error *got_repo_map_path(char **, struct got_repository *,
130 8fa913ec 2020-11-14 stsp const char *);
133 6f04a73d 2022-09-20 mark * Create a new repository with optional specified
134 6f04a73d 2022-09-20 mark * HEAD ref in an empty directory at a specified path.
136 6f04a73d 2022-09-20 mark const struct got_error *got_repo_init(const char *, const char *);
138 e09a504c 2019-06-28 stsp /* Attempt to find a unique object ID for a given ID string prefix. */
139 e09a504c 2019-06-28 stsp const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
140 dd88155e 2019-06-29 stsp const char *, int, struct got_repository *);
143 71a27632 2020-01-15 stsp * Given an object ID string or reference name, attempt to find a corresponding
145 71a27632 2020-01-15 stsp * The object type may be restricted to commit, tree, blob, or tag.
146 84de9106 2020-12-26 stsp * Tags will only be matched if a list of references is provided.
147 71a27632 2020-01-15 stsp * GOT_OBJ_TYPE_ANY will match any type of object.
148 71a27632 2020-01-15 stsp * A human-readable label can optionally be returned, which the caller should
149 71a27632 2020-01-15 stsp * dispose of with free(3).
150 71a27632 2020-01-15 stsp * Return GOT_ERR_NO_OBJ if no matching commit can be found.
152 71a27632 2020-01-15 stsp const struct got_error *got_repo_match_object_id(struct got_object_id **,
153 84de9106 2020-12-26 stsp char **, const char *, int, struct got_reflist_head *,
154 84de9106 2020-12-26 stsp struct got_repository *);
157 84de9106 2020-12-26 stsp * Search the provided list of references for a tag with a given name
158 84de9106 2020-12-26 stsp * and target object type.
159 303e2782 2019-08-09 stsp * Return GOT_ERR_NO_OBJ if no matching tag can be found.
161 303e2782 2019-08-09 stsp const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
162 84de9106 2020-12-26 stsp const char *, int, struct got_reflist_head *, struct got_repository *);
164 3ce1b845 2019-07-15 stsp /* A callback function which is invoked when a path is imported. */
165 3ce1b845 2019-07-15 stsp typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
168 3ce1b845 2019-07-15 stsp * Import an unversioned directory tree into the repository.
169 3ce1b845 2019-07-15 stsp * Creates a root commit, i.e. a commit with zero parents.
171 3ce1b845 2019-07-15 stsp const struct got_error *got_repo_import(struct got_object_id **, const char *,
172 3ce1b845 2019-07-15 stsp const char *, const char *, struct got_pathlist_head *,
173 3ce1b845 2019-07-15 stsp struct got_repository *, got_repo_import_cb, void *);
175 20662ea0 2021-04-10 stsp /* Obtain the number and size of loose objects in the repository. */
176 20662ea0 2021-04-10 stsp const struct got_error *got_repo_get_loose_object_info(int *nobjects,
177 20662ea0 2021-04-10 stsp off_t *ondisk_size, struct got_repository *);
179 20662ea0 2021-04-10 stsp /* Obtain the number and size of packed objects in the repository. */
180 20662ea0 2021-04-10 stsp const struct got_error *got_repo_get_packfile_info(int *npackfiles,
181 20662ea0 2021-04-10 stsp int *nobjects, off_t *total_packsize, struct got_repository *);
183 0ae84acc 2022-06-15 tracey /* Create an array of file descriptors to hand over to got_repo_open for pack */
184 0ae84acc 2022-06-15 tracey const struct got_error *got_repo_pack_fds_open(int **);
186 0ae84acc 2022-06-15 tracey /* Close the array of file descriptors handed over to got_repo_open for pack */
187 0ae84acc 2022-06-15 tracey const struct got_error *got_repo_pack_fds_close(int *);
189 13b2bc37 2022-10-23 stsp /* Open/set/close temporary files for internal use. Needed by gotd(8). */
190 13b2bc37 2022-10-23 stsp const struct got_error *got_repo_temp_fds_open(int **);
191 13b2bc37 2022-10-23 stsp void got_repo_temp_fds_set(struct got_repository *, int *);
192 13b2bc37 2022-10-23 stsp const struct got_error *got_repo_temp_fds_close(int *);
