thodg/got/include/got_repository.h

• Show log

  Commit

• Hash : 9a1cc63f
  Author :
  Date : 2020-02-03T09:18:40
  

  read repository owner name with gitconfig parser instead of a hand-rolled one

Download

• include/got_repository.h

• /*
   * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
   *
   * Permission to use, copy, modify, and distribute this software for any
   * purpose with or without fee is hereby granted, provided that the above
   * copyright notice and this permission notice appear in all copies.
   *
   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   */
  
  struct got_repository;
  struct got_pathlist_head;
  struct got_tag_object;
  
  /* Open and close repositories. */
  const struct got_error *got_repo_open(struct got_repository**, const char *,
      const char *);
  const struct got_error *got_repo_close(struct got_repository*);
  
  /* Obtain the on-disk path to the repository. */
  const char *got_repo_get_path(struct got_repository *);
  
  /*
   * Obtain the path to a non-bare repository's .git directory.
   * For bare repositories, this returns the same result as got_repo_get_path().
   */
  const char *got_repo_get_path_git_dir(struct got_repository *);
  
  /* Obtain the commit author name if parsed from gitconfig, else NULL. */
  const char *got_repo_get_gitconfig_author_name(struct got_repository *);
  
  /* Obtain the commit author email if parsed from gitconfig, else NULL. */
  const char *got_repo_get_gitconfig_author_email(struct got_repository *);
  
  /* Obtain global commit author name parsed ~/.gitconfig, else NULL. */
  const char *got_repo_get_global_gitconfig_author_name(struct got_repository *);
  
  /* Obtain global commit author email parsed ~/.gitconfig, else NULL. */
  const char *got_repo_get_global_gitconfig_author_email(struct got_repository *);
  
  /* Obtain repository owner name if parsed from gitconfig, else NULL. */
  const char *got_repo_get_gitconfig_owner(struct got_repository *);
  
  /* Information about one remote repository. */
  struct got_remote_repo {
  	char *name;
  	char *url;
  };
  
  /* Obtain the list of remote repositories parsed from gitconfig. */ 
  void got_repo_get_gitconfig_remotes(int *, struct got_remote_repo **,
      struct got_repository *);
  
  /*
   * Obtain paths to various directories within a repository.
   * The caller must dispose of a path with free(3).
   */
  char *got_repo_get_path_objects(struct got_repository *);
  char *got_repo_get_path_objects_pack(struct got_repository *);
  char *got_repo_get_path_refs(struct got_repository *);
  char *got_repo_get_path_packed_refs(struct got_repository *);
  
  struct got_reference;
  
  /*
   * Obtain a reference, by name, from a repository.
   * The caller must dispose of it with got_ref_close().
   */
  const struct got_error *got_repo_get_reference(struct got_reference **,
      struct got_repository *, const char *);
  
  
  /* Indicate whether this is a bare repositiry (contains no git working tree). */
  int got_repo_is_bare(struct got_repository *);
  
  /* Attempt to map an arbitrary path to a path within the repository. */
  const struct got_error *got_repo_map_path(char **, struct got_repository *,
      const char *, int);
  
  /* Create a new repository in an empty directory at a specified path. */
  const struct got_error *got_repo_init(const char *);
  
  /* Attempt to find a unique object ID for a given ID string prefix. */
  const struct got_error *got_repo_match_object_id_prefix(struct got_object_id **,
      const char *, int, struct got_repository *);
  
  /*
   * Given an object ID string or reference name, attempt to find a corresponding
   * commit object. Tags can optionally be ignored during matching.
   * The object type may be restricted to commit, tree, blob, or tag.
   * GOT_OBJ_TYPE_ANY will match any type of object.
   * A human-readable label can optionally be returned, which the caller should
   * dispose of with free(3).
   * Return GOT_ERR_NO_OBJ if no matching commit can be found.
   */
  const struct got_error *got_repo_match_object_id(struct got_object_id **,
      char **, const char *, int, int, struct got_repository *);
  
  /*
   * Attempt to find a tag object with a given name and target object type.
   * Return GOT_ERR_NO_OBJ if no matching tag can be found.
   */
  const struct got_error *got_repo_object_match_tag(struct got_tag_object **,
      const char *, int, struct got_repository *);
  
  /* A callback function which is invoked when a path is imported. */
  typedef const struct got_error *(*got_repo_import_cb)(void *, const char *);
  
  /*
   * Import an unversioned directory tree into the repository.
   * Creates a root commit, i.e. a commit with zero parents.
   */
  const struct got_error *got_repo_import(struct got_object_id **, const char *,
      const char *, const char *, struct got_pathlist_head *,
      struct got_repository *, got_repo_import_cb, void *);
  

Download