2 a1fd68d8 2018-01-12 stsp * Copyright (c) 2018 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 59ece79d 2018-02-12 stsp struct got_object_id;
19 f934cf2c 2018-02-12 stsp struct got_blob_object;
20 883f0469 2018-06-23 stsp struct got_tree_object;
21 56e0773d 2019-11-28 stsp struct got_tree_entry;
22 f4a881ce 2018-11-17 stsp struct got_tag_object;
23 45d799e2 2018-12-23 stsp struct got_commit_object;
25 79f35eb3 2018-06-11 stsp struct got_object_qid {
26 dbdddfee 2021-06-23 naddy STAILQ_ENTRY(got_object_qid) entry;
27 59ece79d 2018-02-12 stsp struct got_object_id *id;
28 74a2356f 2021-06-18 stsp void *data; /* managed by API user */
31 dbdddfee 2021-06-23 naddy STAILQ_HEAD(got_object_id_queue, got_object_qid);
33 dbc6a6b6 2018-07-12 stsp const struct got_error *got_object_qid_alloc(struct got_object_qid **,
34 dbc6a6b6 2018-07-12 stsp struct got_object_id *);
35 dbc6a6b6 2018-07-12 stsp void got_object_qid_free(struct got_object_qid *);
36 dd88155e 2019-06-29 stsp void got_object_id_queue_free(struct got_object_id_queue *);
39 9ca9aafb 2021-06-18 stsp * Deep-copy elements from ID queue src to ID queue dest. Do not copy any
40 9ca9aafb 2021-06-18 stsp * qid->data pointers! This is the caller's responsibility if needed.
42 9ca9aafb 2021-06-18 stsp const struct got_error *got_object_id_queue_copy(
43 9ca9aafb 2021-06-18 stsp const struct got_object_id_queue *src, struct got_object_id_queue *dest);
45 15a94983 2018-12-23 stsp /* Object types. */
46 dd88155e 2019-06-29 stsp #define GOT_OBJ_TYPE_ANY 0 /* wildcard value at run-time */
47 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_COMMIT 1
48 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TREE 2
49 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_BLOB 3
50 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TAG 4
51 f9a4270b 2017-12-03 stsp /* 5 is reserved */
52 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_OFFSET_DELTA 6
53 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_REF_DELTA 7
56 8aa93786 2019-08-22 stsp * Labels used in object data.
59 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_COMMIT "commit"
60 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_TREE "tree"
61 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_BLOB "blob"
62 8aa93786 2019-08-22 stsp #define GOT_OBJ_LABEL_TAG "tag"
64 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_TREE "tree "
65 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_PARENT "parent "
66 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_AUTHOR "author "
67 8aa93786 2019-08-22 stsp #define GOT_COMMIT_LABEL_COMMITTER "committer "
69 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_OBJECT "object "
70 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TYPE "type "
71 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TAG "tag "
72 8aa93786 2019-08-22 stsp #define GOT_TAG_LABEL_TAGGER "tagger "
74 ab9a70b2 2017-11-06 stsp struct got_repository;
77 0c60ce5a 2018-04-02 stsp * Obtain a string representation of an object ID. The output depends on
78 0c60ce5a 2018-04-02 stsp * the hash function used by the repository format (currently SHA1).
80 ef0981d5 2018-02-12 stsp const struct got_error *got_object_id_str(char **, struct got_object_id *);
83 0c60ce5a 2018-04-02 stsp * Compare two object IDs. Return value behaves like memcmp(3).
85 984e8a45 2018-11-05 stsp int got_object_id_cmp(const struct got_object_id *,
86 984e8a45 2018-11-05 stsp const struct got_object_id *);
89 0c60ce5a 2018-04-02 stsp * Created a newly allocated copy of an object ID.
90 0c60ce5a 2018-04-02 stsp * The caller should dispose of it with free(3).
92 8bf5b3c9 2018-03-17 stsp struct got_object_id *got_object_id_dup(struct got_object_id *);
95 27d434c2 2018-09-15 stsp * Get a newly allocated ID of the object which resides at the specified
96 27d434c2 2018-09-15 stsp * path in the tree of the specified commit.
97 27d434c2 2018-09-15 stsp * The caller should dispose of it with free(3).
99 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_id_by_path(struct got_object_id **,
100 6c34b1aa 2019-03-18 stsp struct got_repository *, struct got_object_id *, const char *);
103 0c60ce5a 2018-04-02 stsp * Obtain the type of an object.
104 0c60ce5a 2018-04-02 stsp * Returns one of the GOT_OBJ_TYPE_x values (see above).
106 15a94983 2018-12-23 stsp const struct got_error *got_object_get_type(int *, struct got_repository *,
107 15a94983 2018-12-23 stsp struct got_object_id *);
110 15a94983 2018-12-23 stsp * Attempt to resolve the textual representation of an object ID
111 15a94983 2018-12-23 stsp * to the ID of an existing object in the repository.
112 15a94983 2018-12-23 stsp * The caller should dispose of the ID with free(3).
114 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_resolve_id_str(struct got_object_id **,
115 6c34b1aa 2019-03-18 stsp struct got_repository *, const char *);
118 0c60ce5a 2018-04-02 stsp * Attempt to open a commit object in a repository.
119 0c60ce5a 2018-04-02 stsp * The caller must dispose of the commit with got_object_commit_close().
121 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_commit(struct got_commit_object **,
122 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
124 0c60ce5a 2018-04-02 stsp /* Dispose of a commit object. */
125 d1cda826 2017-11-06 stsp void got_object_commit_close(struct got_commit_object *);
127 45d799e2 2018-12-23 stsp /* Obtain the ID of the tree created in a commit. */
128 45d799e2 2018-12-23 stsp struct got_object_id *got_object_commit_get_tree_id(struct got_commit_object *);
130 45d799e2 2018-12-23 stsp /* Obtain the number of parent commits of a commit. */
131 45d799e2 2018-12-23 stsp int got_object_commit_get_nparents(struct got_commit_object *);
133 45d799e2 2018-12-23 stsp /* Obtain the list of parent commits of a commit. */
134 45d799e2 2018-12-23 stsp const struct got_object_id_queue *got_object_commit_get_parent_ids(
135 45d799e2 2018-12-23 stsp struct got_commit_object *);
137 45d799e2 2018-12-23 stsp /* Get the author's name and email address. */
138 45d799e2 2018-12-23 stsp const char *got_object_commit_get_author(struct got_commit_object *);
140 2df4e4ff 2018-12-23 stsp /* Get an author's commit timestamp in UTC. */
141 45d799e2 2018-12-23 stsp time_t got_object_commit_get_author_time(struct got_commit_object *);
143 45d799e2 2018-12-23 stsp /* Get an author's timezone offset. */
144 45d799e2 2018-12-23 stsp time_t got_object_commit_get_author_gmtoff(struct got_commit_object *);
146 45d799e2 2018-12-23 stsp /* Get the committer's name and email address. */
147 45d799e2 2018-12-23 stsp const char *got_object_commit_get_committer(struct got_commit_object *);
149 450eaa8b 2018-12-23 stsp /* Get a committer's commit timestamp in UTC. */
150 45d799e2 2018-12-23 stsp time_t got_object_commit_get_committer_time(struct got_commit_object *);
152 450eaa8b 2018-12-23 stsp /* Get a committer's timezone offset. */
153 45d799e2 2018-12-23 stsp time_t got_object_commit_get_committer_gmtoff(struct got_commit_object *);
156 24ea5512 2019-08-22 stsp * Get the commit log message.
157 24ea5512 2019-08-22 stsp * PGP-signatures contained in the log message will be stripped.
158 24ea5512 2019-08-22 stsp * The caller must dispose of it with free(3).
160 5943eee2 2019-08-13 stsp const struct got_error *got_object_commit_get_logmsg(char **,
161 5943eee2 2019-08-13 stsp struct got_commit_object *);
163 24ea5512 2019-08-22 stsp /* Get the raw commit log message.*/
164 24ea5512 2019-08-22 stsp const char *got_object_commit_get_logmsg_raw(struct got_commit_object *);
167 0c60ce5a 2018-04-02 stsp * Attempt to open a tree object in a repository.
168 0c60ce5a 2018-04-02 stsp * The caller must dispose of the tree with got_object_tree_close().
170 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_tree(struct got_tree_object **,
171 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
173 0c60ce5a 2018-04-02 stsp /* Dispose of a tree object. */
174 0ffeb3c2 2017-11-26 stsp void got_object_tree_close(struct got_tree_object *);
176 56e0773d 2019-11-28 stsp /* Get the number of entries in this tree object. */
177 56e0773d 2019-11-28 stsp int got_object_tree_get_nentries(struct got_tree_object *);
179 56e0773d 2019-11-28 stsp /* Get the first tree entry from a tree, or NULL if there is none. */
180 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_first_entry(struct got_tree_object *);
182 56e0773d 2019-11-28 stsp /* Get the last tree entry from a tree, or NULL if there is none. */
183 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_last_entry(struct got_tree_object *);
185 56e0773d 2019-11-28 stsp /* Get the entry with the specified index from a tree object. */
186 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_get_entry(
187 56e0773d 2019-11-28 stsp struct got_tree_object *, int);
189 56e0773d 2019-11-28 stsp /* Find a particular entry in a tree by name. */
190 56e0773d 2019-11-28 stsp struct got_tree_entry *got_object_tree_find_entry(
191 a129376b 2019-03-28 stsp struct got_tree_object *, const char *);
193 56e0773d 2019-11-28 stsp /* Get the file permission mode of a tree entry. */
194 56e0773d 2019-11-28 stsp mode_t got_tree_entry_get_mode(struct got_tree_entry *);
196 56e0773d 2019-11-28 stsp /* Get the name of a tree entry. */
197 56e0773d 2019-11-28 stsp const char *got_tree_entry_get_name(struct got_tree_entry *);
199 56e0773d 2019-11-28 stsp /* Get the object ID of a tree entry. */
200 56e0773d 2019-11-28 stsp struct got_object_id *got_tree_entry_get_id(struct got_tree_entry *);
203 0d6c6ee3 2020-05-20 stsp * Get a string containing the target path of a given a symlink tree entry.
204 0d6c6ee3 2020-05-20 stsp * The caller should dispose of it with free(3).
206 0d6c6ee3 2020-05-20 stsp const struct got_error *got_tree_entry_get_symlink_target(char **,
207 0d6c6ee3 2020-05-20 stsp struct got_tree_entry *, struct got_repository *);
209 56e0773d 2019-11-28 stsp /* Get the index of a tree entry. */
210 56e0773d 2019-11-28 stsp int got_tree_entry_get_index(struct got_tree_entry *);
212 56e0773d 2019-11-28 stsp /* Get the next tree entry from a tree, or NULL if there is none. */
213 56e0773d 2019-11-28 stsp struct got_tree_entry *got_tree_entry_get_next(struct got_tree_object *,
214 56e0773d 2019-11-28 stsp struct got_tree_entry *);
216 56e0773d 2019-11-28 stsp /* Get the previous tree entry from a tree, or NULL if there is none. */
217 56e0773d 2019-11-28 stsp struct got_tree_entry *got_tree_entry_get_prev(struct got_tree_object *,
218 56e0773d 2019-11-28 stsp struct got_tree_entry *);
220 63c5ca5d 2019-08-24 stsp /* Return non-zero if the specified tree entry is a Git submodule. */
221 56e0773d 2019-11-28 stsp int got_object_tree_entry_is_submodule(struct got_tree_entry *);
223 e40622f4 2020-07-23 stsp /* Return non-zero if the specified tree entry is a symbolic link. */
224 e40622f4 2020-07-23 stsp int got_object_tree_entry_is_symlink(struct got_tree_entry *);
227 e40622f4 2020-07-23 stsp * Resolve an in-repository symlink at the specified path in the tree
228 e40622f4 2020-07-23 stsp * corresponding to the specified commit. If the specified path is not
229 e40622f4 2020-07-23 stsp * a symlink then set *link_target to NULL.
230 e40622f4 2020-07-23 stsp * Otherwise, resolve symlinks recursively and return the final link
231 e40622f4 2020-07-23 stsp * target path. The caller must dispose of it with free(3).
233 e40622f4 2020-07-23 stsp const struct got_error *got_object_resolve_symlinks(char **, const char *,
234 e40622f4 2020-07-23 stsp struct got_object_id *, struct got_repository *);
237 07862c20 2018-09-15 stsp * Compare two trees and indicate whether the entry at the specified path
238 31cedeaf 2018-09-15 stsp * differs between them. The path must not be the root path "/"; the function
239 31cedeaf 2018-09-15 stsp * got_object_id_cmp() should be used instead to compare the tree roots.
241 07862c20 2018-09-15 stsp const struct got_error *got_object_tree_path_changed(int *,
242 07862c20 2018-09-15 stsp struct got_tree_object *, struct got_tree_object *, const char *,
243 07862c20 2018-09-15 stsp struct got_repository *);
246 0c60ce5a 2018-04-02 stsp * Attempt to open a blob object in a repository.
247 0c60ce5a 2018-04-02 stsp * The size_t argument specifies the block size of an associated read buffer.
248 0c60ce5a 2018-04-02 stsp * The caller must dispose of the blob with got_object_blob_close().
250 6c34b1aa 2019-03-18 stsp const struct got_error *got_object_open_as_blob(struct got_blob_object **,
251 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *, size_t);
253 0c60ce5a 2018-04-02 stsp /* Dispose of a blob object. */
254 fb43ecf1 2019-02-11 stsp const struct got_error *got_object_blob_close(struct got_blob_object *);
257 0c60ce5a 2018-04-02 stsp * Get the length of header data at the beginning of the blob's read buffer.
258 0c60ce5a 2018-04-02 stsp * Note that header data is only present upon the first invocation of
259 0c60ce5a 2018-04-02 stsp * got_object_blob_read_block() after the blob is opened.
261 f934cf2c 2018-02-12 stsp size_t got_object_blob_get_hdrlen(struct got_blob_object *);
264 0c60ce5a 2018-04-02 stsp * Get a pointer to the blob's read buffer.
265 0c60ce5a 2018-04-02 stsp * The read buffer is filled by got_object_blob_read_block().
267 f934cf2c 2018-02-12 stsp const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
270 0c60ce5a 2018-04-02 stsp * Read the next chunk of data from a blob, up to the blob's read buffer
271 0c60ce5a 2018-04-02 stsp * block size. The size_t output argument indicates how many bytes have
272 0c60ce5a 2018-04-02 stsp * been read into the blob's read buffer. Zero bytes will be reported if
273 0c60ce5a 2018-04-02 stsp * all data in the blob has been read.
275 eb651edf 2018-02-11 stsp const struct got_error *got_object_blob_read_block(size_t *,
276 eb651edf 2018-02-11 stsp struct got_blob_object *);
278 8ba819a3 2020-07-23 stsp /* Rewind an open blob's data stream back to the beginning. */
279 8ba819a3 2020-07-23 stsp void got_object_blob_rewind(struct got_blob_object *);
282 35e9ba5d 2018-06-21 stsp * Read the entire content of a blob and write it to the specified file.
283 84451b3e 2018-07-10 stsp * Flush and rewind the file as well. Indicate the amount of bytes
284 6c4c42e0 2019-06-24 stsp * written in the size_t output argument, and the number of lines in the
285 0f6650ff 2019-08-14 stsp * file in the int argument, and line offsets in the off_t argument
286 6c4c42e0 2019-06-24 stsp * (NULL can be passed for any output argument).
288 be659d10 2020-11-18 stsp const struct got_error *got_object_blob_dump_to_file(off_t *, int *,
289 6c4c42e0 2019-06-24 stsp off_t **, FILE *, struct got_blob_object *);
292 af57b12a 2020-07-23 stsp * Read the entire content of a blob into a newly allocated string buffer
293 af57b12a 2020-07-23 stsp * and terminate it with '\0'. This is intended for blobs which contain a
294 af57b12a 2020-07-23 stsp * symlink target path. It should not be used to process arbitrary blobs.
295 af57b12a 2020-07-23 stsp * Use got_object_blob_dump_to_file() or got_tree_entry_get_symlink_target()
296 af57b12a 2020-07-23 stsp * instead if possible. The caller must dispose of the string with free(3).
298 af57b12a 2020-07-23 stsp const struct got_error *got_object_blob_read_to_str(char **,
299 af57b12a 2020-07-23 stsp struct got_blob_object *);
302 f4a881ce 2018-11-17 stsp * Attempt to open a tag object in a repository.
303 01073a5d 2019-08-22 stsp * The caller must dispose of the tree with got_tag_object_close().
305 15a94983 2018-12-23 stsp const struct got_error *got_object_open_as_tag(struct got_tag_object **,
306 15a94983 2018-12-23 stsp struct got_repository *, struct got_object_id *);
308 f4a881ce 2018-11-17 stsp /* Dispose of a tag object. */
309 f4a881ce 2018-11-17 stsp void got_object_tag_close(struct got_tag_object *);
311 d24820bf 2019-08-11 stsp /* Get the name of a tag. */
312 d24820bf 2019-08-11 stsp const char *got_object_tag_get_name(struct got_tag_object *);
314 0bd18d37 2019-02-01 stsp /* Get type of the object a tag points to. */
315 0bd18d37 2019-02-01 stsp int got_object_tag_get_object_type(struct got_tag_object *);
318 0bd18d37 2019-02-01 stsp * Get ID of the object a tag points to.
319 0bd18d37 2019-02-01 stsp * This must not be freed by the caller. Use got_object_id_dup() if needed.
321 0bd18d37 2019-02-01 stsp struct got_object_id *got_object_tag_get_object_id(struct got_tag_object *);
324 01073a5d 2019-08-22 stsp /* Get the timestamp of the tag. */
325 01073a5d 2019-08-22 stsp time_t got_object_tag_get_tagger_time(struct got_tag_object *);
327 01073a5d 2019-08-22 stsp /* Get the tag's timestamp's GMT offset. */
328 01073a5d 2019-08-22 stsp time_t got_object_tag_get_tagger_gmtoff(struct got_tag_object *);
330 01073a5d 2019-08-22 stsp /* Get the author of the tag. */
331 01073a5d 2019-08-22 stsp const char *got_object_tag_get_tagger(struct got_tag_object *);
333 01073a5d 2019-08-22 stsp /* Get the tag message associated with the tag. */
334 01073a5d 2019-08-22 stsp const char *got_object_tag_get_message(struct got_tag_object *);
336 bff6ca00 2018-04-23 stsp const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
337 bff6ca00 2018-04-23 stsp const char *);
339 8e7bd50a 2019-08-22 stsp /* Create a new tag object in the repository. */
340 8e7bd50a 2019-08-22 stsp const struct got_error *got_object_tag_create(struct got_object_id **,
341 8e7bd50a 2019-08-22 stsp const char *, struct got_object_id *, const char *,
342 8e7bd50a 2019-08-22 stsp time_t, const char *, struct got_repository *);
