mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-01 14:36:46 +00:00
21ca045100
Create a new include/git2/sys/refs.h and move the reference alloc functions there. Also fix some documentation issues and some minor code cleanups.
131 lines
3.6 KiB
C
131 lines
3.6 KiB
C
/*
|
|
* 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
|
|
|
|
/** 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);
|
|
|
|
/**
|
|
* 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
|