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;
21 0ffeb3c2 2017-11-26 stsp struct got_tree_entry {
22 0ffeb3c2 2017-11-26 stsp SIMPLEQ_ENTRY(got_tree_entry) entry;
23 0ffeb3c2 2017-11-26 stsp mode_t mode;
25 59ece79d 2018-02-12 stsp struct got_object_id *id;
28 d1cda826 2017-11-06 stsp struct got_tree_object {
29 0ffeb3c2 2017-11-26 stsp int nentries;
30 0ffeb3c2 2017-11-26 stsp SIMPLEQ_HEAD(, got_tree_entry) entries;
32 f6be5c30 2018-06-22 stsp int refcnt; /* for internal use only */
35 79f35eb3 2018-06-11 stsp struct got_object_qid {
36 79f35eb3 2018-06-11 stsp SIMPLEQ_ENTRY(got_object_qid) entry;
37 59ece79d 2018-02-12 stsp struct got_object_id *id;
40 79f35eb3 2018-06-11 stsp SIMPLEQ_HEAD(got_object_id_queue, got_object_qid);
42 d1cda826 2017-11-06 stsp struct got_commit_object {
43 59ece79d 2018-02-12 stsp struct got_object_id *tree_id;
44 d1cda826 2017-11-06 stsp unsigned int nparents;
45 79f35eb3 2018-06-11 stsp struct got_object_id_queue parent_ids;
46 d1cda826 2017-11-06 stsp char *author;
47 788c352e 2018-06-16 stsp struct tm tm_author; /* UTC */
48 d1cda826 2017-11-06 stsp char *committer;
49 788c352e 2018-06-16 stsp struct tm tm_committer; /* UTC */
50 d1cda826 2017-11-06 stsp char *logmsg;
52 1943de01 2018-06-22 stsp int refcnt; /* for internal use only */
55 0c60ce5a 2018-04-02 stsp /* A generic object. Used as a handle which holds an ID and an object type. */
56 eef6493a 2018-01-19 stsp struct got_object;
57 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_COMMIT 1
58 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TREE 2
59 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_BLOB 3
60 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_TAG 4
61 f9a4270b 2017-12-03 stsp /* 5 is reserved */
62 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_OFFSET_DELTA 6
63 9b1d5162 2017-12-03 stsp #define GOT_OBJ_TYPE_REF_DELTA 7
65 ab9a70b2 2017-11-06 stsp struct got_repository;
68 0c60ce5a 2018-04-02 stsp * Obtain a string representation of an object ID. The output depends on
69 0c60ce5a 2018-04-02 stsp * the hash function used by the repository format (currently SHA1).
71 ef0981d5 2018-02-12 stsp const struct got_error *got_object_id_str(char **, struct got_object_id *);
74 0c60ce5a 2018-04-02 stsp * Compare two object IDs. Return value behaves like memcmp(3).
76 a1fd68d8 2018-01-12 stsp int got_object_id_cmp(struct got_object_id *, struct got_object_id *);
79 0c60ce5a 2018-04-02 stsp * Created a newly allocated copy of an object ID.
80 0c60ce5a 2018-04-02 stsp * The caller should dispose of it with free(3).
82 8bf5b3c9 2018-03-17 stsp struct got_object_id *got_object_id_dup(struct got_object_id *);
85 0c60ce5a 2018-04-02 stsp * Get a newly allocated copy of an object's ID.
86 0c60ce5a 2018-04-02 stsp * The caller should dispose of it with free(3).
88 3235492e 2018-04-01 stsp struct got_object_id *got_object_get_id(struct got_object *);
91 bacc9935 2018-05-20 stsp * Get a newly allocated copy of an object's ID string.
92 bacc9935 2018-05-20 stsp * The caller should dispose of it with free(3).
94 bacc9935 2018-05-20 stsp const struct got_error *got_object_get_id_str(char **, struct got_object *);
97 0c60ce5a 2018-04-02 stsp * Obtain the type of an object.
98 0c60ce5a 2018-04-02 stsp * Returns one of the GOT_OBJ_TYPE_x values (see above).
100 b107e67f 2018-01-19 stsp int got_object_get_type(struct got_object *);
103 0c60ce5a 2018-04-02 stsp * Attempt to open the object in a repository with the provided ID.
104 0c60ce5a 2018-04-02 stsp * Caller must dispose of it with got_object_close().
106 ab9a70b2 2017-11-06 stsp const struct got_error *got_object_open(struct got_object **,
107 ab9a70b2 2017-11-06 stsp struct got_repository *, struct got_object_id *);
110 0c60ce5a 2018-04-02 stsp * Attempt to map the provided ID string to an object ID and then
111 0c60ce5a 2018-04-02 stsp * attempt to open the object in a repository with this ID.
112 0c60ce5a 2018-04-02 stsp * The form of an ID string depends on the hash function used by the
113 0c60ce5a 2018-04-02 stsp * repository format (currently SHA1).
114 0c60ce5a 2018-04-02 stsp * Caller must dispose of the object with got_object_close().
116 6dfa2fd3 2018-02-12 stsp const struct got_error *got_object_open_by_id_str(struct got_object **,
117 0c60ce5a 2018-04-02 stsp struct got_repository *, const char *);
119 0c60ce5a 2018-04-02 stsp /* Dispose of an object. */
120 ab9a70b2 2017-11-06 stsp void got_object_close(struct got_object *);
123 0c60ce5a 2018-04-02 stsp * Attempt to open a commit object in a repository.
124 0c60ce5a 2018-04-02 stsp * The provided object must be of type GOT_OBJ_TYPE_COMMIT.
125 0c60ce5a 2018-04-02 stsp * The caller must dispose of the commit with got_object_commit_close().
127 d1cda826 2017-11-06 stsp const struct got_error *got_object_commit_open(struct got_commit_object **,
128 d1cda826 2017-11-06 stsp struct got_repository *, struct got_object *);
130 0c60ce5a 2018-04-02 stsp /* Dispose of a commit object. */
131 d1cda826 2017-11-06 stsp void got_object_commit_close(struct got_commit_object *);
134 0c60ce5a 2018-04-02 stsp * Attempt to open a tree object in a repository.
135 0c60ce5a 2018-04-02 stsp * The provided object must be of type GOT_OBJ_TYPE_TREE.
136 0c60ce5a 2018-04-02 stsp * The caller must dispose of the tree with got_object_tree_close().
138 0ffeb3c2 2017-11-26 stsp const struct got_error *got_object_tree_open(struct got_tree_object **,
139 0ffeb3c2 2017-11-26 stsp struct got_repository *, struct got_object *);
141 0c60ce5a 2018-04-02 stsp /* Dispose of a tree object. */
142 0ffeb3c2 2017-11-26 stsp void got_object_tree_close(struct got_tree_object *);
145 0c60ce5a 2018-04-02 stsp * Attempt to open a blob object in a repository.
146 0c60ce5a 2018-04-02 stsp * The provided object must be of type GOT_OBJ_TYPE_BLOB.
147 0c60ce5a 2018-04-02 stsp * The size_t argument specifies the block size of an associated read buffer.
148 0c60ce5a 2018-04-02 stsp * The caller must dispose of the blob with got_object_blob_close().
150 68482ea3 2017-11-27 stsp const struct got_error *got_object_blob_open(struct got_blob_object **,
151 68482ea3 2017-11-27 stsp struct got_repository *, struct got_object *, size_t);
153 0c60ce5a 2018-04-02 stsp /* Dispose of a blob object. */
154 68482ea3 2017-11-27 stsp void got_object_blob_close(struct got_blob_object *);
157 0c60ce5a 2018-04-02 stsp * Write the string representation of the object ID of a blob to a buffer.
158 0c60ce5a 2018-04-02 stsp * The size_t argument speficies the size of the buffer. In the current
159 0c60ce5a 2018-04-02 stsp * implementation, it must be at least SHA1_DIGEST_STRING_LENGTH bytes.
160 0c60ce5a 2018-04-02 stsp * XXX This is a bad API, use got_object_id_str() instead.
162 f934cf2c 2018-02-12 stsp char *got_object_blob_id_str(struct got_blob_object*, char *, size_t);
165 0c60ce5a 2018-04-02 stsp * Get the length of header data at the beginning of the blob's read buffer.
166 0c60ce5a 2018-04-02 stsp * Note that header data is only present upon the first invocation of
167 0c60ce5a 2018-04-02 stsp * got_object_blob_read_block() after the blob is opened.
169 f934cf2c 2018-02-12 stsp size_t got_object_blob_get_hdrlen(struct got_blob_object *);
172 0c60ce5a 2018-04-02 stsp * Get a pointer to the blob's read buffer.
173 0c60ce5a 2018-04-02 stsp * The read buffer is filled by got_object_blob_read_block().
175 f934cf2c 2018-02-12 stsp const uint8_t *got_object_blob_get_read_buf(struct got_blob_object *);
178 0c60ce5a 2018-04-02 stsp * Read the next chunk of data from a blob, up to the blob's read buffer
179 0c60ce5a 2018-04-02 stsp * block size. The size_t output argument indicates how many bytes have
180 0c60ce5a 2018-04-02 stsp * been read into the blob's read buffer. Zero bytes will be reported if
181 0c60ce5a 2018-04-02 stsp * all data in the blob has been read.
183 eb651edf 2018-02-11 stsp const struct got_error *got_object_blob_read_block(size_t *,
184 eb651edf 2018-02-11 stsp struct got_blob_object *);
187 35e9ba5d 2018-06-21 stsp * Read the entire content of a blob and write it to the specified file.
188 35e9ba5d 2018-06-21 stsp * Flush and rewind the file as well, and indicate the amount of bytes
189 35e9ba5d 2018-06-21 stsp * written in the size_t output argument.
191 35e9ba5d 2018-06-21 stsp const struct got_error *got_object_blob_dump_to_file(size_t *, FILE *,
192 35e9ba5d 2018-06-21 stsp struct got_blob_object *);
194 be6a1b5a 2018-06-11 stsp const struct got_error *
195 be6a1b5a 2018-06-11 stsp got_object_open_as_commit(struct got_commit_object **,
196 be6a1b5a 2018-06-11 stsp struct got_repository *, struct got_object_id *);
197 776d4d29 2018-06-17 stsp const struct got_error *
198 776d4d29 2018-06-17 stsp got_object_open_as_tree(struct got_tree_object **,
199 776d4d29 2018-06-17 stsp struct got_repository *, struct got_object_id *);
200 a19581a2 2018-06-21 stsp const struct got_error *
201 a19581a2 2018-06-21 stsp got_object_open_as_blob(struct got_blob_object **,
202 a19581a2 2018-06-21 stsp struct got_repository *, struct got_object_id *, size_t);
204 776d4d29 2018-06-17 stsp const struct got_error *
205 776d4d29 2018-06-17 stsp got_object_open_by_path(struct got_object **, struct got_repository *,
206 776d4d29 2018-06-17 stsp struct got_object_id *, const char *);
208 bff6ca00 2018-04-23 stsp const struct got_error *got_object_commit_add_parent(struct got_commit_object *,
209 bff6ca00 2018-04-23 stsp const char *);
