2 5261c201 2018-04-01 stsp * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 5261c201 2018-04-01 stsp * Permission to use, copy, modify, and distribute this software for any
5 5261c201 2018-04-01 stsp * purpose with or without fee is hereby granted, provided that the above
6 5261c201 2018-04-01 stsp * copyright notice and this permission notice appear in all copies.
8 5261c201 2018-04-01 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 5261c201 2018-04-01 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 5261c201 2018-04-01 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 5261c201 2018-04-01 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 5261c201 2018-04-01 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 5261c201 2018-04-01 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 5261c201 2018-04-01 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 5261c201 2018-04-01 stsp /* A reference which points to an arbitrary object. */
18 5261c201 2018-04-01 stsp struct got_reference;
20 5261c201 2018-04-01 stsp /* Well-known reference names. */
21 5261c201 2018-04-01 stsp #define GOT_REF_HEAD "HEAD"
22 5261c201 2018-04-01 stsp #define GOT_REF_ORIG_HEAD "ORIG_HEAD"
23 5261c201 2018-04-01 stsp #define GOT_REF_MERGE_HEAD "MERGE_HEAD"
24 5261c201 2018-04-01 stsp #define GOT_REF_FETCH_HEAD "FETCH_HEAD"
26 5261c201 2018-04-01 stsp struct got_repository;
27 5261c201 2018-04-01 stsp struct got_object_id;
30 0c60ce5a 2018-04-02 stsp * Attempt to open the reference with the provided name in a repository.
31 2f17228e 2019-05-12 stsp * The caller must dispose of the reference with got_ref_close().
32 2f17228e 2019-05-12 stsp * Optionally, the underlying reference file can be locked before it is opened
33 2f17228e 2019-05-12 stsp * to prevent concurrent modification of the reference, in which case the file
34 2f17228e 2019-05-12 stsp * must be unlocked with got_ref_unlock() before got_ref_close() is called.
36 6c34b1aa 2019-03-18 stsp const struct got_error *got_ref_open(struct got_reference **,
37 2f17228e 2019-05-12 stsp struct got_repository *, const char *, int);
40 5892cdd6 2019-03-10 stsp * Allocate a new reference for a given object ID.
41 5892cdd6 2019-03-10 stsp * The caller must dispose of it with got_ref_close().
43 5892cdd6 2019-03-10 stsp const struct got_error *got_ref_alloc(struct got_reference **, const char *,
44 5892cdd6 2019-03-10 stsp struct got_object_id *);
47 aaf88317 2019-07-10 stsp * Allocate a new symbolic reference which points at a given reference.
48 aaf88317 2019-07-10 stsp * The caller must dispose of it with got_ref_close().
50 aaf88317 2019-07-10 stsp const struct got_error *got_ref_alloc_symref(struct got_reference **,
51 aaf88317 2019-07-10 stsp const char *, struct got_reference *);
53 0c60ce5a 2018-04-02 stsp /* Dispose of a reference. */
54 5261c201 2018-04-01 stsp void got_ref_close(struct got_reference *);
56 0bd18d37 2019-02-01 stsp /* Get the name of the reference. */
57 0bd18d37 2019-02-01 stsp const char *got_ref_get_name(struct got_reference *);
59 aaf88317 2019-07-10 stsp /* Get the name of the reference which a symoblic reference points at. */
60 aaf88317 2019-07-10 stsp const char *got_ref_get_symref_target(struct got_reference *);
63 0c60ce5a 2018-04-02 stsp * Create a duplicate copy of a reference.
64 0c60ce5a 2018-04-02 stsp * The caller must dispose of this copy with got_ref_close().
66 5261c201 2018-04-01 stsp struct got_reference *got_ref_dup(struct got_reference *);
68 0c60ce5a 2018-04-02 stsp /* Attempt to resolve a reference to an object ID. */
69 5261c201 2018-04-01 stsp const struct got_error *got_ref_resolve(struct got_object_id **,
70 5261c201 2018-04-01 stsp struct got_repository *, struct got_reference *);
73 271d2a38 2018-12-25 stsp * Return a string representation of a reference.
74 271d2a38 2018-12-25 stsp * The caller must dispose of it with free(3).
76 5261c201 2018-04-01 stsp char *got_ref_to_str(struct got_reference *);
78 48cae60d 2020-09-22 stsp /* List of references. */
79 199a4027 2019-02-02 stsp struct got_reflist_entry {
80 d9dff0e5 2020-12-26 stsp TAILQ_ENTRY(got_reflist_entry) entry;
81 199a4027 2019-02-02 stsp struct got_reference *ref;
83 d9dff0e5 2020-12-26 stsp TAILQ_HEAD(got_reflist_head, got_reflist_entry);
85 b8bad2ba 2019-08-23 stsp /* Duplicate a reference list entry. Caller must dispose of it with free(3). */
86 b8bad2ba 2019-08-23 stsp const struct got_error *got_reflist_entry_dup(struct got_reflist_entry **,
87 b8bad2ba 2019-08-23 stsp struct got_reflist_entry *);
89 b8bad2ba 2019-08-23 stsp /* A function which compares two references. Used with got_ref_list(). */
90 b8bad2ba 2019-08-23 stsp typedef const struct got_error *(*got_ref_cmp_cb)(void *, int *,
91 b8bad2ba 2019-08-23 stsp struct got_reference *, struct got_reference *);
93 b8bad2ba 2019-08-23 stsp /* An implementation of got_ref_cmp_cb which compares two references by name. */
94 b8bad2ba 2019-08-23 stsp const struct got_error *got_ref_cmp_by_name(void *, int *,
95 b8bad2ba 2019-08-23 stsp struct got_reference *, struct got_reference *);
97 d1f16636 2020-01-15 stsp /* An implementation of got_ref_cmp_cb which compares two tags. */
98 d1f16636 2020-01-15 stsp const struct got_error *got_ref_cmp_tags(void *, int *,
99 d1f16636 2020-01-15 stsp struct got_reference *, struct got_reference *);
102 e600f124 2021-03-21 stsp * An implementation of got_ref_cmp_cb which compares commit timestamps.
103 e600f124 2021-03-21 stsp * Requires a struct got_repository * as the void * argument.
105 e600f124 2021-03-21 stsp const struct got_error *got_ref_cmp_by_commit_timestamp_descending(void *,
106 e600f124 2021-03-21 stsp int *, struct got_reference *, struct got_reference *);
109 29606af7 2019-08-23 stsp * Append all known references to a caller-provided ref list head.
110 29606af7 2019-08-23 stsp * Optionally limit references returned to those within a given
111 b8bad2ba 2019-08-23 stsp * reference namespace. Sort the list with the provided reference comparison
112 b8bad2ba 2019-08-23 stsp * function, usually got_ref_cmp_by_name().
114 199a4027 2019-02-02 stsp const struct got_error *got_ref_list(struct got_reflist_head *,
115 b8bad2ba 2019-08-23 stsp struct got_repository *, const char *, got_ref_cmp_cb, void *);
117 e2e879a0 2019-03-11 stsp /* Free all references on a ref list. */
118 e2e879a0 2019-03-11 stsp void got_ref_list_free(struct got_reflist_head *);
121 779e1159 2021-06-18 stsp * Insert a reference into a reference list.
122 779e1159 2021-06-18 stsp * Return a pointer to the newly allocated list entry in *newp.
123 779e1159 2021-06-18 stsp * If *newp is NULL and no error occured then the specified reference was
124 779e1159 2021-06-18 stsp * already an element of the list. If *newp is not NULL then the reference
125 779e1159 2021-06-18 stsp * was shallow-copied onto the list and should no longer be closed with
126 779e1159 2021-06-18 stsp * got_ref_close(). Instead it will be closed along with other list
127 779e1159 2021-06-18 stsp * elements by got_ref_list_free().
129 779e1159 2021-06-18 stsp const struct got_error *
130 779e1159 2021-06-18 stsp got_reflist_insert(struct got_reflist_entry **newp, struct got_reflist_head *refs,
131 779e1159 2021-06-18 stsp struct got_reference *ref, struct got_repository *repo,
132 779e1159 2021-06-18 stsp got_ref_cmp_cb cmp_cb, void *cmp_arg);
134 b249b824 2019-05-09 stsp /* Indicate whether the provided reference is symbolic (points at another
135 b249b824 2019-05-09 stsp * refernce) or not (points at an object ID). */
136 b249b824 2019-05-09 stsp int got_ref_is_symbolic(struct got_reference *);
138 b249b824 2019-05-09 stsp /* Change the object ID a reference points to. */
139 b249b824 2019-05-09 stsp const struct got_error *
140 b249b824 2019-05-09 stsp got_ref_change_ref(struct got_reference *, struct got_object_id *);
142 b249b824 2019-05-09 stsp /* Change the reference name a symbolic reference points to. */
143 b249b824 2019-05-09 stsp const struct got_error *got_ref_change_symref(struct got_reference *,
144 d7b899ab 2020-03-25 stsp const char *);
147 e8a967e0 2020-03-21 stsp * Change a symbolic reference into a regular reference which points to
148 e8a967e0 2020-03-21 stsp * the provided object ID.
150 e8a967e0 2020-03-21 stsp const struct got_error *got_ref_change_symref_to_ref(struct got_reference *,
151 e8a967e0 2020-03-21 stsp struct got_object_id *);
153 9e672c74 2019-03-11 stsp /* Write a reference to its on-disk path in the repository. */
154 9e672c74 2019-03-11 stsp const struct got_error *got_ref_write(struct got_reference *,
155 9e672c74 2019-03-11 stsp struct got_repository *);
157 2d2e1378 2019-03-11 stsp /* Delete a reference from its on-disk path in the repository. */
158 2d2e1378 2019-03-11 stsp const struct got_error *got_ref_delete(struct got_reference *,
159 2d2e1378 2019-03-11 stsp struct got_repository *);
161 2f17228e 2019-05-12 stsp /* Unlock a reference which was opened in locked state. */
162 2f17228e 2019-05-12 stsp const struct got_error *got_ref_unlock(struct got_reference *);
164 7b5b670e 2020-12-25 stsp /* Map object IDs to references. */
165 7b5b670e 2020-12-25 stsp struct got_reflist_object_id_map;
168 7b5b670e 2020-12-25 stsp * Create and populate an object ID map for a given list of references.
169 7b5b670e 2020-12-25 stsp * Map entries will contain deep-copies of elements of the reflist.
170 f193b038 2020-12-26 stsp * The caller must dispose of the map with got_reflist_object_id_map_free().
172 7b5b670e 2020-12-25 stsp const struct got_error *got_reflist_object_id_map_create(
173 7b5b670e 2020-12-25 stsp struct got_reflist_object_id_map **, struct got_reflist_head *,
174 7b5b670e 2020-12-25 stsp struct got_repository *);
177 7b5b670e 2020-12-25 stsp * Return a list of references which correspond to a given object ID.
178 7b5b670e 2020-12-25 stsp * The returned list must be considered read-only.
179 7b5b670e 2020-12-25 stsp * The caller must _not_ call free(3) on the returned pointer!
180 7b5b670e 2020-12-25 stsp * If no references are associated with the ID, return NULL.
182 7b5b670e 2020-12-25 stsp struct got_reflist_head *
183 7b5b670e 2020-12-25 stsp got_reflist_object_id_map_lookup(struct got_reflist_object_id_map *,
184 7b5b670e 2020-12-25 stsp struct got_object_id *);
186 7b5b670e 2020-12-25 stsp /* Free the specified object ID map. */
187 f193b038 2020-12-26 stsp void got_reflist_object_id_map_free(struct got_reflist_object_id_map *);
