]>
git.proxmox.com Git - libgit2.git/blob - include/git2/sys/refdb_backend.h
2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
7 #ifndef INCLUDE_sys_git_refdb_backend_h__
8 #define INCLUDE_sys_git_refdb_backend_h__
10 #include "git2/common.h"
11 #include "git2/types.h"
15 * @file git2/refdb_backend.h
16 * @brief Git custom refs backend functions
17 * @defgroup git_refdb_backend Git custom refs backend API
25 * Every backend's iterator must have a pointer to itself as the first
26 * element, so the API can talk to it. You'd define your iterator as
28 * struct my_iterator {
29 * git_reference_iterator parent;
33 * and assign `iter->parent.backend` to your `git_refdb_backend`.
35 struct git_reference_iterator
{
39 * Return the current reference and advance the iterator.
43 git_reference_iterator
*iter
);
46 * Return the name of the current reference and advance the iterator
49 const char **ref_name
,
50 git_reference_iterator
*iter
);
56 git_reference_iterator
*iter
);
59 /** An instance for a custom backend */
60 struct git_refdb_backend
{
64 * Queries the refdb backend to determine if the given ref_name
65 * exists. A refdb implementation must provide this function.
69 git_refdb_backend
*backend
,
70 const char *ref_name
);
73 * Queries the refdb backend for a given reference. A refdb
74 * implementation must provide this function.
78 git_refdb_backend
*backend
,
79 const char *ref_name
);
82 * Allocate an iterator object for the backend.
84 * A refdb implementation must provide this function.
87 git_reference_iterator
**iter
,
88 struct git_refdb_backend
*backend
,
92 * Writes the given reference to the refdb. A refdb implementation
93 * must provide this function.
95 int (*write
)(git_refdb_backend
*backend
,
96 const git_reference
*ref
, int force
,
97 const git_signature
*who
, const char *message
,
98 const git_oid
*old
, const char *old_target
);
101 git_reference
**out
, git_refdb_backend
*backend
,
102 const char *old_name
, const char *new_name
, int force
,
103 const git_signature
*who
, const char *message
);
106 * Deletes the given reference from the refdb. A refdb implementation
107 * must provide this function.
109 int (*del
)(git_refdb_backend
*backend
, const char *ref_name
, const git_oid
*old_id
, const char *old_target
);
112 * Suggests that the given refdb compress or optimize its references.
113 * This mechanism is implementation specific. (For on-disk reference
114 * databases, this may pack all loose references.) A refdb
115 * implementation may provide this function; if it is not provided,
116 * nothing will be done.
118 int (*compress
)(git_refdb_backend
*backend
);
121 * Query whether a particular reference has a log (may be empty)
123 int (*has_log
)(git_refdb_backend
*backend
, const char *refname
);
126 * Make sure a particular reference will have a reflog which
127 * will be appended to on writes.
129 int (*ensure_log
)(git_refdb_backend
*backend
, const char *refname
);
132 * Frees any resources held by the refdb. A refdb implementation may
133 * provide this function; if it is not provided, nothing will be done.
135 void (*free
)(git_refdb_backend
*backend
);
138 * Read the reflog for the given reference name.
140 int (*reflog_read
)(git_reflog
**out
, git_refdb_backend
*backend
, const char *name
);
143 * Write a reflog to disk.
145 int (*reflog_write
)(git_refdb_backend
*backend
, git_reflog
*reflog
);
150 int (*reflog_rename
)(git_refdb_backend
*_backend
, const char *old_name
, const char *new_name
);
155 int (*reflog_delete
)(git_refdb_backend
*backend
, const char *name
);
158 * Lock a reference. The opaque parameter will be passed to the unlock function
160 int (*lock
)(void **payload_out
, git_refdb_backend
*backend
, const char *refname
);
163 * Unlock a reference. Only one of target or symbolic_target
164 * will be set. success indicates whether to update the
165 * reference or discard the lock (if it's false)
167 int (*unlock
)(git_refdb_backend
*backend
, void *payload
, int success
, int update_reflog
,
168 const git_reference
*ref
, const git_signature
*sig
, const char *message
);
171 #define GIT_REFDB_BACKEND_VERSION 1
172 #define GIT_REFDB_BACKEND_INIT {GIT_REFDB_BACKEND_VERSION}
175 * Initializes a `git_refdb_backend` with default values. Equivalent to
176 * creating an instance with GIT_REFDB_BACKEND_INIT.
178 * @param opts the `git_refdb_backend` struct to initialize
179 * @param version Version of struct; pass `GIT_REFDB_BACKEND_VERSION`
180 * @return Zero on success; -1 on failure.
182 GIT_EXTERN(int) git_refdb_init_backend(
183 git_refdb_backend
*backend
,
184 unsigned int version
);
187 * Constructors for default filesystem-based refdb backend
189 * Under normal usage, this is called for you when the repository is
190 * opened / created, but you can use this to explicitly construct a
191 * filesystem refdb backend for a repository.
193 * @param backend_out Output pointer to the git_refdb_backend object
194 * @param repo Git repository to access
195 * @return 0 on success, <0 error code on failure
197 GIT_EXTERN(int) git_refdb_backend_fs(
198 git_refdb_backend
**backend_out
,
199 git_repository
*repo
);
202 * Sets the custom backend to an existing reference DB
204 * The `git_refdb` will take ownership of the `git_refdb_backend` so you
205 * should NOT free it after calling this function.
207 * @param refdb database to add the backend to
208 * @param backend pointer to a git_refdb_backend instance
209 * @return 0 on success; error code otherwise
211 GIT_EXTERN(int) git_refdb_set_backend(
213 git_refdb_backend
*backend
);