2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
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.
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.
19 struct got_blob_object;
20 struct got_tree_object;
21 struct got_tree_entry;
22 struct got_tag_object;
23 struct got_commit_object;
25 struct got_object_qid {
26 SIMPLEQ_ENTRY(got_object_qid) entry;
27 struct got_object_id *id;
30 SIMPLEQ_HEAD(got_object_id_queue, got_object_qid);
32 const struct got_error *got_object_qid_alloc(struct got_object_qid **,
33 struct got_object_id *);
34 void got_object_qid_free(struct got_object_qid *);
35 void got_object_id_queue_free(struct got_object_id_queue *);
38 #define GOT_OBJ_TYPE_ANY 0 /* wildcard value at run-time */
39 #define GOT_OBJ_TYPE_COMMIT 1
40 #define GOT_OBJ_TYPE_TREE 2
41 #define GOT_OBJ_TYPE_BLOB 3
42 #define GOT_OBJ_TYPE_TAG 4
44 #define GOT_OBJ_TYPE_OFFSET_DELTA 6
45 #define GOT_OBJ_TYPE_REF_DELTA 7
48 * Labels used in object data.
51 #define GOT_OBJ_LABEL_COMMIT "commit"
52 #define GOT_OBJ_LABEL_TREE "tree"
53 #define GOT_OBJ_LABEL_BLOB "blob"
54 #define GOT_OBJ_LABEL_TAG "tag"
56 #define GOT_COMMIT_LABEL_TREE "tree "
57 #define GOT_COMMIT_LABEL_PARENT "parent "
58 #define GOT_COMMIT_LABEL_AUTHOR "author "
59 #define GOT_COMMIT_LABEL_COMMITTER "committer "
61 #define GOT_TAG_LABEL_OBJECT "object "
62 #define GOT_TAG_LABEL_TYPE "type "
63 #define GOT_TAG_LABEL_TAG "tag "
64 #define GOT_TAG_LABEL_TAGGER "tagger "
66 struct got_repository;
69 * Obtain a string representation of an object ID. The output depends on
70 * the hash function used by the repository format (currently SHA1).
72 const struct got_error *got_object_id_str(char **, struct got_object_id *);
75 * Compare two object IDs. Return value behaves like memcmp(3).
77 int got_object_id_cmp(const struct got_object_id *,
78 const struct got_object_id *);
81 * Created a newly allocated copy of an object ID.
82 * The caller should dispose of it with free(3).
84 struct got_object_id *got_object_id_dup(struct got_object_id *);
87 * Get a newly allocated ID of the object which resides at the specified
88 * path in the tree of the specified commit.
89 * The caller should dispose of it with free(3).
91 const struct got_error *got_object_id_by_path(struct got_object_id **,
92 struct got_repository *, struct got_object_id *, const char *);
95 * Obtain the type of an object.
96 * Returns one of the GOT_OBJ_TYPE_x values (see above).
98 const struct got_error *got_object_get_type(int *, struct got_repository *,
99 struct got_object_id *);
102 * Attempt to resolve the textual representation of an object ID
103 * to the ID of an existing object in the repository.
104 * The caller should dispose of the ID with free(3).
106 const struct got_error *got_object_resolve_id_str(struct got_object_id **,
107 struct got_repository *, const char *);
110 * Attempt to open a commit object in a repository.
111 * The caller must dispose of the commit with got_object_commit_close().
113 const struct got_error *got_object_open_as_commit(struct got_commit_object **,
114 struct got_repository *, struct got_object_id *);
116 /* Dispose of a commit object. */
117 void got_object_commit_close(struct got_commit_object *);
119 /* Obtain the ID of the tree created in a commit. */
120 struct got_object_id *got_object_commit_get_tree_id(struct got_commit_object *);
122 /* Obtain the number of parent commits of a commit. */
123 int got_object_commit_get_nparents(struct got_commit_object *);
125 /* Obtain the list of parent commits of a commit. */
126 const struct got_object_id_queue *got_object_commit_get_parent_ids(
127 struct got_commit_object *);
129 /* Get the author's name and email address. */
130 const char *got_object_commit_get_author(struct got_commit_object *);
132 /* Get an author's commit timestamp in UTC. */
133 time_t got_object_commit_get_author_time(struct got_commit_object *);
135 /* Get an author's timezone offset. */
136 time_t got_object_commit_get_author_gmtoff(struct got_commit_object *);
138 /* Get the committer's name and email address. */
139 const char *got_object_commit_get_committer(struct got_commit_object *);
141 /* Get a committer's commit timestamp in UTC. */
142 time_t got_object_commit_get_committer_time(struct got_commit_object *);
144 /* Get a committer's timezone offset. */
145 time_t got_object_commit_get_committer_gmtoff(struct got_commit_object *);
148 * Get the commit log message.
149 * PGP-signatures contained in the log message will be stripped.
150 * The caller must dispose of it with free(3).
152 const struct got_error *got_object_commit_get_logmsg(char **,
153 struct got_commit_object *);
155 /* Get the raw commit log message.*/
156 const char *got_object_commit_get_logmsg_raw(struct got_commit_object *);
159 * Attempt to open a tree object in a repository.
160 * The caller must dispose of the tree with got_object_tree_close().
162 const struct got_error *got_object_open_as_tree(struct got_tree_object **,
163 struct got_repository *, struct got_object_id *);
165 /* Dispose of a tree object. */
166 void got_object_tree_close(struct got_tree_object *);
168 /* Get the number of entries in this tree object. */
169 int got_object_tree_get_nentries(struct got_tree_object *);
171 /* Get the first tree entry from a tree, or NULL if there is none. */
172 struct got_tree_entry *got_object_tree_get_first_entry(struct got_tree_object *);
174 /* Get the last tree entry from a tree, or NULL if there is none. */
175 struct got_tree_entry *got_object_tree_get_last_entry(struct got_tree_object *);
177 /* Get the entry with the specified index from a tree object. */
178 struct got_tree_entry *got_object_tree_get_entry(
179 struct got_tree_object *, int);
181 /* Find a particular entry in a tree by name. */
182 struct got_tree_entry *got_object_tree_find_entry(
183 struct got_tree_object *, const char *);
185 /* Get the file permission mode of a tree entry. */
186 mode_t got_tree_entry_get_mode(struct got_tree_entry *);
188 /* Get the name of a tree entry. */
189 const char *got_tree_entry_get_name(struct got_tree_entry *);
191 /* Get the object ID of a tree entry. */
192 struct got_object_id *got_tree_entry_get_id(struct got_tree_entry *);
195 * Get a string containing the target path of a given a symlink tree entry.
196 * The caller should dispose of it with free(3).
198 const struct got_error *got_tree_entry_get_symlink_target(char **,
199 struct got_tree_entry *, struct got_repository *);
201 /* Get the index of a tree entry. */
202 int got_tree_entry_get_index(struct got_tree_entry *);
204 /* Get the next tree entry from a tree, or NULL if there is none. */
205 struct got_tree_entry *got_tree_entry_get_next(struct got_tree_object *,
206 struct got_tree_entry *);
208 /* Get the previous tree entry from a tree, or NULL if there is none. */
209 struct got_tree_entry *got_tree_entry_get_prev(struct got_tree_object *,
210 struct got_tree_entry *);
212 /* Return non-zero if the specified tree entry is a Git submodule. */
213 int got_object_tree_entry_is_submodule(struct got_tree_entry *);
215 /* Return non-zero if the specified tree entry is a symbolic link. */
216 int got_object_tree_entry_is_symlink(struct got_tree_entry *);
219 * Resolve an in-repository symlink at the specified path in the tree
220 * corresponding to the specified commit. If the specified path is not
221 * a symlink then set *link_target to NULL.
222 * Otherwise, resolve symlinks recursively and return the final link
223 * target path. The caller must dispose of it with free(3).
225 const struct got_error *got_object_resolve_symlinks(char **, const char *,
226 struct got_object_id *, struct got_repository *);
229 * Compare two trees and indicate whether the entry at the specified path
230 * differs between them. The path must not be the root path "/"; the function
231 * got_object_id_cmp() should be used instead to compare the tree roots.
233 const struct got_error *got_object_tree_path_changed(int *,
234 struct got_tree_object *, struct got_tree_object *, const char *,
235 struct got_repository *);
238 * Attempt to open a blob object in a repository.
239 * The size_t argument specifies the block size of an associated read buffer.
240 * The caller must dispose of the blob with got_object_blob_close().
242 const struct got_error *got_object_open_as_blob(struct got_blob_object **,
243 struct got_repository *, struct got_object_id *, size_t);
245 /* Dispose of a blob object. */
246 const struct got_error *got_object_blob_close(struct got_blob_object *);
249 * Get the length of header data at the beginning of the blob's read buffer.
250 * Note that header data is only present upon the first invocation of
251 * got_object_blob_read_block() after the blob is opened.
253 size_t got_object_blob_get_hdrlen(struct got_blob_object *);
256 * Get a pointer to the blob's read buffer.
257 * The read buffer is filled by got_object_blob_read_block().
259 const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
262 * Read the next chunk of data from a blob, up to the blob's read buffer
263 * block size. The size_t output argument indicates how many bytes have
264 * been read into the blob's read buffer. Zero bytes will be reported if
265 * all data in the blob has been read.
267 const struct got_error *got_object_blob_read_block(size_t *,
268 struct got_blob_object *);
270 /* Rewind an open blob's data stream back to the beginning. */
271 void got_object_blob_rewind(struct got_blob_object *);
274 * Read the entire content of a blob and write it to the specified file.
275 * Flush and rewind the file as well. Indicate the amount of bytes
276 * written in the size_t output argument, and the number of lines in the
277 * file in the int argument, and line offsets in the off_t argument
278 * (NULL can be passed for any output argument).
280 const struct got_error *got_object_blob_dump_to_file(off_t *, int *,
281 off_t **, FILE *, struct got_blob_object *);
284 * Read the entire content of a blob into a newly allocated string buffer
285 * and terminate it with '\0'. This is intended for blobs which contain a
286 * symlink target path. It should not be used to process arbitrary blobs.
287 * Use got_object_blob_dump_to_file() or got_tree_entry_get_symlink_target()
288 * instead if possible. The caller must dispose of the string with free(3).
290 const struct got_error *got_object_blob_read_to_str(char **,
291 struct got_blob_object *);
294 * Attempt to open a tag object in a repository.
295 * The caller must dispose of the tree with got_tag_object_close().
297 const struct got_error *got_object_open_as_tag(struct got_tag_object **,
298 struct got_repository *, struct got_object_id *);
300 /* Dispose of a tag object. */
301 void got_object_tag_close(struct got_tag_object *);
303 /* Get the name of a tag. */
304 const char *got_object_tag_get_name(struct got_tag_object *);
306 /* Get type of the object a tag points to. */
307 int got_object_tag_get_object_type(struct got_tag_object *);
310 * Get ID of the object a tag points to.
311 * This must not be freed by the caller. Use got_object_id_dup() if needed.
313 struct got_object_id *got_object_tag_get_object_id(struct got_tag_object *);
316 /* Get the timestamp of the tag. */
317 time_t got_object_tag_get_tagger_time(struct got_tag_object *);
319 /* Get the tag's timestamp's GMT offset. */
320 time_t got_object_tag_get_tagger_gmtoff(struct got_tag_object *);
322 /* Get the author of the tag. */
323 const char *got_object_tag_get_tagger(struct got_tag_object *);
325 /* Get the tag message associated with the tag. */
326 const char *got_object_tag_get_message(struct got_tag_object *);
328 const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
331 /* Create a new tag object in the repository. */
332 const struct got_error *got_object_tag_create(struct got_object_id **,
333 const char *, struct got_object_id *, const char *,
334 time_t, const char *, struct got_repository *);
