1 7b19e0f1 2017-11-05 stsp /*
  2 5d56da81 2019-01-13 stsp  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
  3 7b19e0f1 2017-11-05 stsp  *
  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.
  7 7b19e0f1 2017-11-05 stsp  *
  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.
 15 7b19e0f1 2017-11-05 stsp  */
 16 7b19e0f1 2017-11-05 stsp 
 17 3b339b2f 2018-02-12 stsp struct got_repository;
 18 3ce1b845 2019-07-15 stsp struct got_pathlist_head;
 19 303e2782 2019-08-09 stsp struct got_tag_object;
 20 4027f31a 2017-11-04 stsp 
 21 0c60ce5a 2018-04-02 stsp /* Open and close repositories. */
 22 c9956ddf 2019-09-08 stsp const struct got_error *got_repo_open(struct got_repository**, const char *,
 23 c9956ddf 2019-09-08 stsp     const char *);
 24 ad242220 2018-09-08 stsp const struct got_error *got_repo_close(struct got_repository*);
 25 4027f31a 2017-11-04 stsp 
 26 4b0bb327 2019-01-06 stsp /* Obtain the on-disk path to the repository. */
 27 7839bc15 2019-01-06 stsp const char *got_repo_get_path(struct got_repository *);
 28 4b0bb327 2019-01-06 stsp 
 29 4b0bb327 2019-01-06 stsp /*
 30 4b0bb327 2019-01-06 stsp  * Obtain the path to a non-bare repository's .git directory.
 31 4b0bb327 2019-01-06 stsp  * For bare repositories, this returns the same result as got_repo_get_path().
 32 4b0bb327 2019-01-06 stsp  */
 33 6e9da951 2019-01-06 stsp const char *got_repo_get_path_git_dir(struct got_repository *);
 34 7839bc15 2019-01-06 stsp 
 35 6d5a9006 2020-12-16 yzhong /* Obtain the file descriptor of the repository's .git directory. */
 36 6d5a9006 2020-12-16 yzhong int got_repo_get_fd(struct got_repository *);
 37 6d5a9006 2020-12-16 yzhong 
 38 aba9c984 2019-09-08 stsp /* Obtain the commit author name if parsed from gitconfig, else NULL. */
 39 aba9c984 2019-09-08 stsp const char *got_repo_get_gitconfig_author_name(struct got_repository *);
 40 aba9c984 2019-09-08 stsp 
 41 aba9c984 2019-09-08 stsp /* Obtain the commit author email if parsed from gitconfig, else NULL. */
 42 aba9c984 2019-09-08 stsp const char *got_repo_get_gitconfig_author_email(struct got_repository *);
 43 aba9c984 2019-09-08 stsp 
 44 c9956ddf 2019-09-08 stsp /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
 45 c9956ddf 2019-09-08 stsp const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
 46 c9956ddf 2019-09-08 stsp 
 47 c9956ddf 2019-09-08 stsp /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
 48 c9956ddf 2019-09-08 stsp const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
 49 c9956ddf 2019-09-08 stsp 
 50 9a1cc63f 2020-02-03 stsp /* Obtain repository owner name if parsed from gitconfig, else NULL. */
 51 9a1cc63f 2020-02-03 stsp const char *got_repo_get_gitconfig_owner(struct got_repository *);
 52 9a1cc63f 2020-02-03 stsp 
 53 cd95becd 2019-11-29 stsp /* Information about one remote repository. */
 54 cd95becd 2019-11-29 stsp struct got_remote_repo {
 55 cd95becd 2019-11-29 stsp 	char *name;
 56 cd95becd 2019-11-29 stsp 	char *url;
 57 b8adfa55 2020-09-25 stsp 
 58 469dd726 2020-03-20 stsp 	/*
 59 469dd726 2020-03-20 stsp 	 * If set, references are mirrored 1:1 into the local repository.
 60 469dd726 2020-03-20 stsp 	 * If not set, references are mapped into "refs/remotes/$name/".
 61 469dd726 2020-03-20 stsp 	 */
 62 469dd726 2020-03-20 stsp 	int mirror_references;
 63 b8adfa55 2020-09-25 stsp 
 64 b8adfa55 2020-09-25 stsp 	/* Branches to fetch by default. */
 65 b8adfa55 2020-09-25 stsp 	int nbranches;
 66 b8adfa55 2020-09-25 stsp 	char **branches;
 67 cd95becd 2019-11-29 stsp };
 68 cd95becd 2019-11-29 stsp 
 69 b8adfa55 2020-09-25 stsp /*
 70 b8adfa55 2020-09-25 stsp  * Free data allocated for the specified remote repository.
 71 b8adfa55 2020-09-25 stsp  * Do not free the remote_repo pointer itself.
 72 b8adfa55 2020-09-25 stsp  */
 73 b8adfa55 2020-09-25 stsp void got_repo_free_remote_repo_data(struct got_remote_repo *);
 74 b8adfa55 2020-09-25 stsp 
 75 b8adfa55 2020-09-25 stsp /* Obtain the list of remote repositories parsed from gitconfig. */
 76 50b0790e 2020-09-11 stsp void got_repo_get_gitconfig_remotes(int *, const struct got_remote_repo **,
 77 cd95becd 2019-11-29 stsp     struct got_repository *);
 78 cd95becd 2019-11-29 stsp 
 79 50b0790e 2020-09-11 stsp /*
 80 50b0790e 2020-09-11 stsp  * Obtain a parsed representation of this repository's got.conf file.
 81 50b0790e 2020-09-11 stsp  * Return NULL if this configuration file could not be read.
 82 50b0790e 2020-09-11 stsp  */
 83 50b0790e 2020-09-11 stsp const struct got_gotconfig *got_repo_get_gotconfig(struct got_repository *);
 84 257add31 2020-09-09 stsp 
 85 0c60ce5a 2018-04-02 stsp /*
 86 0c60ce5a 2018-04-02 stsp  * Obtain paths to various directories within a repository.
 87 0c60ce5a 2018-04-02 stsp  * The caller must dispose of a path with free(3).
 88 0c60ce5a 2018-04-02 stsp  */
 89 11995603 2017-11-05 stsp char *got_repo_get_path_objects(struct got_repository *);
 90 a1fd68d8 2018-01-12 stsp char *got_repo_get_path_objects_pack(struct got_repository *);
 91 11995603 2017-11-05 stsp char *got_repo_get_path_refs(struct got_repository *);
 92 fb79db15 2019-02-01 stsp char *got_repo_get_path_packed_refs(struct got_repository *);
 93 b46f3e71 2020-03-18 stsp char *got_repo_get_path_gitconfig(struct got_repository *);
 94 257add31 2020-09-09 stsp char *got_repo_get_path_gotconfig(struct got_repository *);
 95 11995603 2017-11-05 stsp 
 96 11995603 2017-11-05 stsp struct got_reference;
 97 84de9106 2020-12-26 stsp struct got_reflist_head;
 98 11995603 2017-11-05 stsp 
 99 0c60ce5a 2018-04-02 stsp /*
100 0c60ce5a 2018-04-02 stsp  * Obtain a reference, by name, from a repository.
101 0c60ce5a 2018-04-02 stsp  * The caller must dispose of it with got_ref_close().
102 0c60ce5a 2018-04-02 stsp  */
103 4027f31a 2017-11-04 stsp const struct got_error *got_repo_get_reference(struct got_reference **,
104 4027f31a 2017-11-04 stsp     struct got_repository *, const char *);
105 04ca23f4 2018-07-16 stsp 
106 04ca23f4 2018-07-16 stsp 
107 04ca23f4 2018-07-16 stsp /* Indicate whether this is a bare repositiry (contains no git working tree). */
108 04ca23f4 2018-07-16 stsp int got_repo_is_bare(struct got_repository *);
109 04ca23f4 2018-07-16 stsp 
110 04ca23f4 2018-07-16 stsp /* Attempt to map an arbitrary path to a path within the repository. */
111 04ca23f4 2018-07-16 stsp const struct got_error *got_repo_map_path(char **, struct got_repository *,
112 8fa913ec 2020-11-14 stsp     const char *);
113 2c7829a4 2019-06-17 stsp 
114 2c7829a4 2019-06-17 stsp /* Create a new repository in an empty directory at a specified path. */
115 2c7829a4 2019-06-17 stsp const struct got_error *got_repo_init(const char *);
116 e09a504c 2019-06-28 stsp 
117 e09a504c 2019-06-28 stsp /* Attempt to find a unique object ID for a given ID string prefix. */
118 e09a504c 2019-06-28 stsp const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
119 dd88155e 2019-06-29 stsp     const char *, int, struct got_repository *);
120 3ce1b845 2019-07-15 stsp 
121 303e2782 2019-08-09 stsp /*
122 71a27632 2020-01-15 stsp  * Given an object ID string or reference name, attempt to find a corresponding
123 84de9106 2020-12-26 stsp  * commit object.
124 71a27632 2020-01-15 stsp  * The object type may be restricted to commit, tree, blob, or tag.
125 84de9106 2020-12-26 stsp  * Tags will only be matched if a list of references is provided.
126 71a27632 2020-01-15 stsp  * GOT_OBJ_TYPE_ANY will match any type of object.
127 71a27632 2020-01-15 stsp  * A human-readable label can optionally be returned, which the caller should
128 71a27632 2020-01-15 stsp  * dispose of with free(3).
129 71a27632 2020-01-15 stsp  * Return GOT_ERR_NO_OBJ if no matching commit can be found.
130 71a27632 2020-01-15 stsp  */
131 71a27632 2020-01-15 stsp const struct got_error *got_repo_match_object_id(struct got_object_id **,
132 84de9106 2020-12-26 stsp     char **, const char *, int, struct got_reflist_head *,
133 84de9106 2020-12-26 stsp     struct got_repository *);
134 71a27632 2020-01-15 stsp 
135 71a27632 2020-01-15 stsp /*
136 84de9106 2020-12-26 stsp  * Search the provided list of references for a tag with a given name
137 84de9106 2020-12-26 stsp  * and target object type.
138 303e2782 2019-08-09 stsp  * Return GOT_ERR_NO_OBJ if no matching tag can be found.
139 303e2782 2019-08-09 stsp  */
140 303e2782 2019-08-09 stsp const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
141 84de9106 2020-12-26 stsp     const char *, int, struct got_reflist_head *, struct got_repository *);
142 303e2782 2019-08-09 stsp 
143 3ce1b845 2019-07-15 stsp /* A callback function which is invoked when a path is imported. */
144 3ce1b845 2019-07-15 stsp typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
145 3ce1b845 2019-07-15 stsp 
146 3ce1b845 2019-07-15 stsp /*
147 3ce1b845 2019-07-15 stsp  * Import an unversioned directory tree into the repository.
148 3ce1b845 2019-07-15 stsp  * Creates a root commit, i.e. a commit with zero parents.
149 3ce1b845 2019-07-15 stsp  */
150 3ce1b845 2019-07-15 stsp const struct got_error *got_repo_import(struct got_object_id **, const char *,
151 3ce1b845 2019-07-15 stsp     const char *, const char *, struct got_pathlist_head *,
152 3ce1b845 2019-07-15 stsp     struct got_repository *, got_repo_import_cb, void *);