1 /*
2  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3  *
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.
7  *
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.
15  */
16 
17 /* A reference which points to an arbitrary object. */
18 struct got_reference;
19 
20 /* Well-known reference names. */
21 #define GOT_REF_HEAD		"HEAD"
22 #define GOT_REF_ORIG_HEAD	"ORIG_HEAD"
23 #define GOT_REF_MERGE_HEAD	"MERGE_HEAD"
24 #define GOT_REF_FETCH_HEAD	"FETCH_HEAD"
25 
26 struct got_repository;
27 struct got_object_id;
28 
29 /*
30  * Attempt to open the reference with the provided name in a repository.
31  * The caller must dispose of it with got_ref_close().
32  */
33 const struct got_error * got_ref_open(struct got_reference **,
34     struct got_repository *, const char *);
35 
36 /* Dispose of a reference. */
37 void got_ref_close(struct got_reference *);
38 
39 /*
40  * Create a duplicate copy of a reference.
41  * The caller must dispose of this copy with got_ref_close().
42  */
43 struct got_reference *got_ref_dup(struct got_reference *);
44 
45 /* Attempt to resolve a reference to an object ID. */
46 const struct got_error *got_ref_resolve(struct got_object_id **,
47     struct got_repository *, struct got_reference *);
48 
49 /* Return a string representation of a reference. */
50 char *got_ref_to_str(struct got_reference *);