thodg/libgit2/include/git2/sys/refdb_backend.h

• Show log

  Commit

• Hash : 4def7035
  Author :
  Date : 2013-03-02T19:31:03
  

  refs: introduce an iterator This allows us to get a list of reference names in a loop instead of callbacks.

Download

• include/git2/sys/refdb_backend.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_sys_git_refdb_backend_h__
  #define INCLUDE_sys_git_refdb_backend_h__
  
  #include "git2/common.h"
  #include "git2/types.h"
  #include "git2/oid.h"
  
  /**
   * @file git2/refdb_backend.h
   * @brief Git custom refs backend functions
   * @defgroup git_refdb_backend Git custom refs backend API
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  
  /**
   * Every backend's iterator must have a pointer to itself as the first
   * element, so the API can talk to it. You'd define your iterator as
   *
   *     struct my_iterator {
   *             git_reference_iterator parent;
   *             ...
   *     }
   *
   * and assing `iter->parent.backend` to your `git_refdb_backend`.
   */
  struct git_reference_iterator {
  	git_refdb_backend *backend;
  };
  
  /** An instance for a custom backend */
  struct git_refdb_backend {
      unsigned int version;
  
  	/**
  	 * Queries the refdb backend to determine if the given ref_name
  	 * exists.  A refdb implementation must provide this function.
  	 */
  	int (*exists)(
  		int *exists,
  		git_refdb_backend *backend,
  		const char *ref_name);
  
  	/**
  	 * Queries the refdb backend for a given reference.  A refdb
  	 * implementation must provide this function.
  	 */
  	int (*lookup)(
  		git_reference **out,
  		git_refdb_backend *backend,
  		const char *ref_name);
  
  	/**
  	 * Enumerates each reference in the refdb.  A refdb implementation must
  	 * provide this function.
  	 */
  	int (*foreach)(
  		git_refdb_backend *backend,
  		unsigned int list_flags,
  		git_reference_foreach_cb callback,
  		void *payload);
  
  	/**
  	 * Enumerates each reference in the refdb that matches the given
  	 * glob string.  A refdb implementation may provide this function;
  	 * if it is not provided, foreach will be used and the results filtered
  	 * against the glob.
  	 */
  	int (*foreach_glob)(
  		git_refdb_backend *backend,
  		const char *glob,
  		unsigned int list_flags,
  		git_reference_foreach_cb callback,
  		void *payload);
  
  	/**
  	 * Allocate an iterator object for the backend
  	 */
  	int (*iterator)(
  		git_reference_iterator **iter,
  		struct git_refdb_backend *backend);
  
  	/**
  	 * Return the current value and advance the iterator.
  	 */
  	int (*next)(
  		const char **name,
  		git_reference_iterator *iter);
  
  	/**
  	 * Free the iterator
  	 */
  	void (*iterator_free)(
  		git_reference_iterator *iter);
  	/*
  	 * Writes the given reference to the refdb.  A refdb implementation
  	 * must provide this function.
  	 */
  	int (*write)(git_refdb_backend *backend, const git_reference *ref);
  
  	/**
  	 * Deletes the given reference from the refdb.  A refdb implementation
  	 * must provide this function.
  	 */
  	int (*delete)(git_refdb_backend *backend, const git_reference *ref);
  
  	/**
  	 * Suggests that the given refdb compress or optimize its references.
  	 * This mechanism is implementation specific.  (For on-disk reference
  	 * databases, this may pack all loose references.)    A refdb
  	 * implementation may provide this function; if it is not provided,
  	 * nothing will be done.
  	 */
  	int (*compress)(git_refdb_backend *backend);
  
  	/**
  	 * Frees any resources held by the refdb.  A refdb implementation may
  	 * provide this function; if it is not provided, nothing will be done.
  	 */
  	void (*free)(git_refdb_backend *backend);
  };
  
  #define GIT_ODB_BACKEND_VERSION 1
  #define GIT_ODB_BACKEND_INIT {GIT_ODB_BACKEND_VERSION}
  
  /**
   * Constructors for default filesystem-based refdb backend
   *
   * Under normal usage, this is called for you when the repository is
   * opened / created, but you can use this to explicitly construct a
   * filesystem refdb backend for a repository.
   *
   * @param backend_out Output pointer to the git_refdb_backend object
   * @param repo Git repository to access
   * @return 0 on success, <0 error code on failure
   */
  GIT_EXTERN(int) git_refdb_backend_fs(
  	git_refdb_backend **backend_out,
  	git_repository *repo);
  
  /**
   * Sets the custom backend to an existing reference DB
   *
   * The `git_refdb` will take ownership of the `git_refdb_backend` so you
   * should NOT free it after calling this function.
   *
   * @param refdb database to add the backend to
   * @param backend pointer to a git_refdb_backend instance
   * @return 0 on success; error code otherwise
   */
  GIT_EXTERN(int) git_refdb_set_backend(
  	git_refdb *refdb,
  	git_refdb_backend *backend);
  
  GIT_END_DECL
  
  #endif
  

Download