thodg/got/include/got_reference.h

• Show log

  Commit

• Hash : aaf88317
  Author :
  Date : 2019-07-10T18:08:23
  

  introduce got_ref_alloc_symref() and got_ref_get_symref_target()

Download

• include/got_reference.h

• /*
   * Copyright (c) 2018 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.
   */
  
  /* A reference which points to an arbitrary object. */
  struct got_reference;
  
  /* Well-known reference names. */
  #define GOT_REF_HEAD		"HEAD"
  #define GOT_REF_ORIG_HEAD	"ORIG_HEAD"
  #define GOT_REF_MERGE_HEAD	"MERGE_HEAD"
  #define GOT_REF_FETCH_HEAD	"FETCH_HEAD"
  
  struct got_repository;
  struct got_object_id;
  
  /*
   * Attempt to open the reference with the provided name in a repository.
   * The caller must dispose of the reference with got_ref_close().
   * Optionally, the underlying reference file can be locked before it is opened
   * to prevent concurrent modification of the reference, in which case the file
   * must be unlocked with got_ref_unlock() before got_ref_close() is called.
   */
  const struct got_error *got_ref_open(struct got_reference **,
      struct got_repository *, const char *, int);
  
  /*
   * Allocate a new reference for a given object ID.
   * The caller must dispose of it with got_ref_close().
   */
  const struct got_error *got_ref_alloc(struct got_reference **, const char *,
      struct got_object_id *);
  
  /*
   * Allocate a new symbolic reference which points at a given reference.
   * The caller must dispose of it with got_ref_close().
   */
  const struct got_error *got_ref_alloc_symref(struct got_reference **,
      const char *, struct got_reference *);
  
  /* Dispose of a reference. */
  void got_ref_close(struct got_reference *);
  
  /* Get the name of the reference. */
  const char *got_ref_get_name(struct got_reference *);
  
  /* Get the name of the reference which a symoblic reference points at. */
  const char *got_ref_get_symref_target(struct got_reference *);
  
  /*
   * Create a duplicate copy of a reference.
   * The caller must dispose of this copy with got_ref_close().
   */
  struct got_reference *got_ref_dup(struct got_reference *);
  
  /* Attempt to resolve a reference to an object ID. */
  const struct got_error *got_ref_resolve(struct got_object_id **,
      struct got_repository *, struct got_reference *);
  
  /*
   * Return a string representation of a reference.
   * The caller must dispose of it with free(3).
   */
  char *got_ref_to_str(struct got_reference *);
  
  /* A list of references and the object ID which they resolve to. */
  struct got_reflist_entry {
  	SIMPLEQ_ENTRY(got_reflist_entry) entry;
  	struct got_reference *ref;
  	struct got_object_id *id;
  };
  SIMPLEQ_HEAD(got_reflist_head, got_reflist_entry);
  
  /* Append all known references to a caller-provided ref list head. */
  const struct got_error *got_ref_list(struct got_reflist_head *,
      struct got_repository *);
  
  /* Free all references on a ref list. */
  void got_ref_list_free(struct got_reflist_head *);
  
  /* Indicate whether the provided reference is symbolic (points at another
   * refernce) or not (points at an object ID). */
  int got_ref_is_symbolic(struct got_reference *);
  
  /* Change the object ID a reference points to. */
  const struct got_error *
  got_ref_change_ref(struct got_reference *, struct got_object_id *);
  
  /* Change the reference name a symbolic reference points to. */
  const struct got_error *got_ref_change_symref(struct got_reference *,
      char *);
  
  /* Write a reference to its on-disk path in the repository. */
  const struct got_error *got_ref_write(struct got_reference *,
      struct got_repository *);
  
  /* Delete a reference from its on-disk path in the repository. */
  const struct got_error *got_ref_delete(struct got_reference *,
      struct got_repository *);
  
  /* Unlock a reference which was opened in locked state. */
  const struct got_error *got_ref_unlock(struct got_reference *);
  

Download