worktree: move subcommand
[git] / refs.h
1 #ifndef REFS_H
2 #define REFS_H
3
4 struct object_id;
5 struct ref_store;
6 struct strbuf;
7 struct string_list;
8
9 /*
10  * Resolve a reference, recursively following symbolic refererences.
11  *
12  * Store the referred-to object's name in sha1 and return the name of
13  * the non-symbolic reference that ultimately pointed at it.  The
14  * return value, if not NULL, is a pointer into either a static buffer
15  * or the input ref.
16  *
17  * If the reference cannot be resolved to an object, the behavior
18  * depends on the RESOLVE_REF_READING flag:
19  *
20  * - If RESOLVE_REF_READING is set, return NULL.
21  *
22  * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
23  *   the last reference name in the chain, which will either be a non-symbolic
24  *   reference or an undefined reference.  If this is a prelude to
25  *   "writing" to the ref, the return value is the name of the ref
26  *   that will actually be created or changed.
27  *
28  * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
29  * level of symbolic reference.  The value stored in sha1 for a symbolic
30  * reference will always be null_sha1 in this case, and the return
31  * value is the reference that the symref refers to directly.
32  *
33  * If flags is non-NULL, set the value that it points to the
34  * combination of REF_ISPACKED (if the reference was found among the
35  * packed references), REF_ISSYMREF (if the initial reference was a
36  * symbolic reference), REF_BAD_NAME (if the reference name is ill
37  * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
38  * (if the ref is malformed or has a bad name). See refs.h for more detail
39  * on each flag.
40  *
41  * If ref is not a properly-formatted, normalized reference, return
42  * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
43  * give up and return NULL.
44  *
45  * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
46  * name is invalid according to git-check-ref-format(1).  If the name
47  * is bad then the value stored in sha1 will be null_sha1 and the two
48  * flags REF_ISBROKEN and REF_BAD_NAME will be set.
49  *
50  * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
51  * directory and do not consist of all caps and underscores cannot be
52  * resolved. The function returns NULL for such ref names.
53  * Caps and underscores refers to the special refs, such as HEAD,
54  * FETCH_HEAD and friends, that all live outside of the refs/ directory.
55  */
56 #define RESOLVE_REF_READING 0x01
57 #define RESOLVE_REF_NO_RECURSE 0x02
58 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
59
60 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
61                                     const char *refname,
62                                     int resolve_flags,
63                                     unsigned char *sha1,
64                                     int *flags);
65 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
66                                unsigned char *sha1, int *flags);
67
68 char *refs_resolve_refdup(struct ref_store *refs,
69                           const char *refname, int resolve_flags,
70                           unsigned char *sha1, int *flags);
71 char *resolve_refdup(const char *refname, int resolve_flags,
72                      unsigned char *sha1, int *flags);
73
74 int refs_read_ref_full(struct ref_store *refs, const char *refname,
75                        int resolve_flags, unsigned char *sha1, int *flags);
76 int read_ref_full(const char *refname, int resolve_flags,
77                   unsigned char *sha1, int *flags);
78 int read_ref(const char *refname, unsigned char *sha1);
79
80 /*
81  * Return 0 if a reference named refname could be created without
82  * conflicting with the name of an existing reference. Otherwise,
83  * return a negative value and write an explanation to err. If extras
84  * is non-NULL, it is a list of additional refnames with which refname
85  * is not allowed to conflict. If skip is non-NULL, ignore potential
86  * conflicts with refs in skip (e.g., because they are scheduled for
87  * deletion in the same operation). Behavior is undefined if the same
88  * name is listed in both extras and skip.
89  *
90  * Two reference names conflict if one of them exactly matches the
91  * leading components of the other; e.g., "foo/bar" conflicts with
92  * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
93  * "foo/barbados".
94  *
95  * extras and skip must be sorted.
96  */
97
98 int refs_verify_refname_available(struct ref_store *refs,
99                                   const char *refname,
100                                   const struct string_list *extra,
101                                   const struct string_list *skip,
102                                   struct strbuf *err);
103
104 int ref_exists(const char *refname);
105
106 int should_autocreate_reflog(const char *refname);
107
108 int is_branch(const char *refname);
109
110 extern int refs_init_db(struct strbuf *err);
111
112 /*
113  * If refname is a non-symbolic reference that refers to a tag object,
114  * and the tag can be (recursively) dereferenced to a non-tag object,
115  * store the SHA1 of the referred-to object to sha1 and return 0.  If
116  * any of these conditions are not met, return a non-zero value.
117  * Symbolic references are considered unpeelable, even if they
118  * ultimately resolve to a peelable tag.
119  */
120 int refs_peel_ref(struct ref_store *refs, const char *refname,
121                   unsigned char *sha1);
122 int peel_ref(const char *refname, unsigned char *sha1);
123
124 /**
125  * Resolve refname in the nested "gitlink" repository in the specified
126  * submodule (which must be non-NULL). If the resolution is
127  * successful, return 0 and set sha1 to the name of the object;
128  * otherwise, return a non-zero value.
129  */
130 int resolve_gitlink_ref(const char *submodule, const char *refname,
131                         unsigned char *sha1);
132
133 /*
134  * Return true iff abbrev_name is a possible abbreviation for
135  * full_name according to the rules defined by ref_rev_parse_rules in
136  * refs.c.
137  */
138 int refname_match(const char *abbrev_name, const char *full_name);
139
140 int expand_ref(const char *str, int len, unsigned char *sha1, char **ref);
141 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
142 int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
143
144 /*
145  * A ref_transaction represents a collection of ref updates
146  * that should succeed or fail together.
147  *
148  * Calling sequence
149  * ----------------
150  * - Allocate and initialize a `struct ref_transaction` by calling
151  *   `ref_transaction_begin()`.
152  *
153  * - List intended ref updates by calling functions like
154  *   `ref_transaction_update()` and `ref_transaction_create()`.
155  *
156  * - Call `ref_transaction_commit()` to execute the transaction.
157  *   If this succeeds, the ref updates will have taken place and
158  *   the transaction cannot be rolled back.
159  *
160  * - Instead of `ref_transaction_commit`, use
161  *   `initial_ref_transaction_commit()` if the ref database is known
162  *   to be empty (e.g. during clone).  This is likely to be much
163  *   faster.
164  *
165  * - At any time call `ref_transaction_free()` to discard the
166  *   transaction and free associated resources.  In particular,
167  *   this rolls back the transaction if it has not been
168  *   successfully committed.
169  *
170  * Error handling
171  * --------------
172  *
173  * On error, transaction functions append a message about what
174  * went wrong to the 'err' argument.  The message mentions what
175  * ref was being updated (if any) when the error occurred so it
176  * can be passed to 'die' or 'error' as-is.
177  *
178  * The message is appended to err without first clearing err.
179  * err will not be '\n' terminated.
180  *
181  * Caveats
182  * -------
183  *
184  * Note that no locks are taken, and no refs are read, until
185  * `ref_transaction_commit` is called.  So `ref_transaction_verify`
186  * won't report a verification failure until the commit is attempted.
187  */
188 struct ref_transaction;
189
190 /*
191  * Bit values set in the flags argument passed to each_ref_fn() and
192  * stored in ref_iterator::flags. Other bits are for internal use
193  * only:
194  */
195
196 /* Reference is a symbolic reference. */
197 #define REF_ISSYMREF 0x01
198
199 /* Reference is a packed reference. */
200 #define REF_ISPACKED 0x02
201
202 /*
203  * Reference cannot be resolved to an object name: dangling symbolic
204  * reference (directly or indirectly), corrupt reference file,
205  * reference exists but name is bad, or symbolic reference refers to
206  * ill-formatted reference name.
207  */
208 #define REF_ISBROKEN 0x04
209
210 /*
211  * Reference name is not well formed.
212  *
213  * See git-check-ref-format(1) for the definition of well formed ref names.
214  */
215 #define REF_BAD_NAME 0x08
216
217 /*
218  * The signature for the callback function for the for_each_*()
219  * functions below.  The memory pointed to by the refname and sha1
220  * arguments is only guaranteed to be valid for the duration of a
221  * single callback invocation.
222  */
223 typedef int each_ref_fn(const char *refname,
224                         const struct object_id *oid, int flags, void *cb_data);
225
226 /*
227  * The following functions invoke the specified callback function for
228  * each reference indicated.  If the function ever returns a nonzero
229  * value, stop the iteration and return that value.  Please note that
230  * it is not safe to modify references while an iteration is in
231  * progress, unless the same callback function invocation that
232  * modifies the reference also returns a nonzero value to immediately
233  * stop the iteration. Returned references are sorted.
234  */
235 int refs_for_each_ref(struct ref_store *refs,
236                       each_ref_fn fn, void *cb_data);
237 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
238                          each_ref_fn fn, void *cb_data);
239 int refs_for_each_tag_ref(struct ref_store *refs,
240                           each_ref_fn fn, void *cb_data);
241 int refs_for_each_branch_ref(struct ref_store *refs,
242                              each_ref_fn fn, void *cb_data);
243 int refs_for_each_remote_ref(struct ref_store *refs,
244                              each_ref_fn fn, void *cb_data);
245
246 int head_ref(each_ref_fn fn, void *cb_data);
247 int for_each_ref(each_ref_fn fn, void *cb_data);
248 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
249 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data,
250                         unsigned int broken);
251 int for_each_tag_ref(each_ref_fn fn, void *cb_data);
252 int for_each_branch_ref(each_ref_fn fn, void *cb_data);
253 int for_each_remote_ref(each_ref_fn fn, void *cb_data);
254 int for_each_replace_ref(each_ref_fn fn, void *cb_data);
255 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
256 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
257                          const char *prefix, void *cb_data);
258
259 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
260 int for_each_ref_submodule(const char *submodule,
261                            each_ref_fn fn, void *cb_data);
262 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
263                 each_ref_fn fn, void *cb_data);
264 int for_each_tag_ref_submodule(const char *submodule,
265                                each_ref_fn fn, void *cb_data);
266 int for_each_branch_ref_submodule(const char *submodule,
267                                   each_ref_fn fn, void *cb_data);
268 int for_each_remote_ref_submodule(const char *submodule,
269                                   each_ref_fn fn, void *cb_data);
270
271 int head_ref_namespaced(each_ref_fn fn, void *cb_data);
272 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
273
274 /* can be used to learn about broken ref and symref */
275 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data);
276 int for_each_rawref(each_ref_fn fn, void *cb_data);
277
278 static inline const char *has_glob_specials(const char *pattern)
279 {
280         return strpbrk(pattern, "?*[");
281 }
282
283 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
284 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt,
285                            const struct string_list *refnames);
286
287 /*
288  * Flags for controlling behaviour of pack_refs()
289  * PACK_REFS_PRUNE: Prune loose refs after packing
290  * PACK_REFS_ALL:   Pack _all_ refs, not just tags and already packed refs
291  */
292 #define PACK_REFS_PRUNE 0x0001
293 #define PACK_REFS_ALL   0x0002
294
295 /*
296  * Write a packed-refs file for the current repository.
297  * flags: Combination of the above PACK_REFS_* flags.
298  */
299 int refs_pack_refs(struct ref_store *refs, unsigned int flags);
300
301 /*
302  * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
303  * REF_NODEREF: act on the ref directly, instead of dereferencing
304  *              symbolic references.
305  *
306  * Other flags are reserved for internal use.
307  */
308 #define REF_NODEREF     0x01
309 #define REF_FORCE_CREATE_REFLOG 0x40
310
311 /*
312  * Setup reflog before using. Fill in err and return -1 on failure.
313  */
314 int refs_create_reflog(struct ref_store *refs, const char *refname,
315                        int force_create, struct strbuf *err);
316 int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
317
318 /** Reads log for the value of ref during at_time. **/
319 int read_ref_at(const char *refname, unsigned int flags,
320                 unsigned long at_time, int cnt,
321                 unsigned char *sha1, char **msg,
322                 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
323
324 /** Check if a particular reflog exists */
325 int refs_reflog_exists(struct ref_store *refs, const char *refname);
326 int reflog_exists(const char *refname);
327
328 /*
329  * Delete the specified reference. If old_sha1 is non-NULL, then
330  * verify that the current value of the reference is old_sha1 before
331  * deleting it. If old_sha1 is NULL, delete the reference if it
332  * exists, regardless of its old value. It is an error for old_sha1 to
333  * be NULL_SHA1. flags is passed through to ref_transaction_delete().
334  */
335 int refs_delete_ref(struct ref_store *refs, const char *msg,
336                     const char *refname,
337                     const unsigned char *old_sha1,
338                     unsigned int flags);
339 int delete_ref(const char *msg, const char *refname,
340                const unsigned char *old_sha1, unsigned int flags);
341
342 /*
343  * Delete the specified references. If there are any problems, emit
344  * errors but attempt to keep going (i.e., the deletes are not done in
345  * an all-or-nothing transaction). flags is passed through to
346  * ref_transaction_delete().
347  */
348 int refs_delete_refs(struct ref_store *refs, struct string_list *refnames,
349                      unsigned int flags);
350 int delete_refs(struct string_list *refnames, unsigned int flags);
351
352 /** Delete a reflog */
353 int refs_delete_reflog(struct ref_store *refs, const char *refname);
354 int delete_reflog(const char *refname);
355
356 /* iterate over reflog entries */
357 typedef int each_reflog_ent_fn(
358                 struct object_id *old_oid, struct object_id *new_oid,
359                 const char *committer, unsigned long timestamp,
360                 int tz, const char *msg, void *cb_data);
361
362 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
363                              each_reflog_ent_fn fn, void *cb_data);
364 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
365                                      const char *refname,
366                                      each_reflog_ent_fn fn,
367                                      void *cb_data);
368 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
369 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
370
371 /*
372  * Calls the specified function for each reflog file until it returns nonzero,
373  * and returns the value. Reflog file order is unspecified.
374  */
375 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data);
376 int for_each_reflog(each_ref_fn fn, void *cb_data);
377
378 #define REFNAME_ALLOW_ONELEVEL 1
379 #define REFNAME_REFSPEC_PATTERN 2
380
381 /*
382  * Return 0 iff refname has the correct format for a refname according
383  * to the rules described in Documentation/git-check-ref-format.txt.
384  * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
385  * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
386  * allow a single "*" wildcard character in the refspec. No leading or
387  * repeated slashes are accepted.
388  */
389 int check_refname_format(const char *refname, int flags);
390
391 const char *prettify_refname(const char *refname);
392
393 char *shorten_unambiguous_ref(const char *refname, int strict);
394
395 /** rename ref, return 0 on success **/
396 int refs_rename_ref(struct ref_store *refs, const char *oldref,
397                     const char *newref, const char *logmsg);
398 int rename_ref(const char *oldref, const char *newref, const char *logmsg);
399
400 int refs_create_symref(struct ref_store *refs, const char *refname,
401                        const char *target, const char *logmsg);
402 int create_symref(const char *refname, const char *target, const char *logmsg);
403
404 /*
405  * Update HEAD of the specified gitdir.
406  * Similar to create_symref("relative-git-dir/HEAD", target, NULL), but
407  * this can update the main working tree's HEAD regardless of where
408  * $GIT_DIR points to.
409  * Return 0 if successful, non-zero otherwise.
410  * */
411 int set_worktree_head_symref(const char *gitdir, const char *target,
412                              const char *logmsg);
413
414 enum action_on_err {
415         UPDATE_REFS_MSG_ON_ERR,
416         UPDATE_REFS_DIE_ON_ERR,
417         UPDATE_REFS_QUIET_ON_ERR
418 };
419
420 /*
421  * Begin a reference transaction.  The reference transaction must
422  * be freed by calling ref_transaction_free().
423  */
424 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
425                                                     struct strbuf *err);
426 struct ref_transaction *ref_transaction_begin(struct strbuf *err);
427
428 /*
429  * Reference transaction updates
430  *
431  * The following four functions add a reference check or update to a
432  * ref_transaction.  They have some common similar parameters:
433  *
434  *     transaction -- a pointer to an open ref_transaction, obtained
435  *         from ref_transaction_begin().
436  *
437  *     refname -- the name of the reference to be affected.
438  *
439  *     flags -- flags affecting the update, passed to
440  *         update_ref_lock(). Can be REF_NODEREF, which means that
441  *         symbolic references should not be followed.
442  *
443  *     msg -- a message describing the change (for the reflog).
444  *
445  *     err -- a strbuf for receiving a description of any error that
446  *         might have occurred.
447  *
448  * The functions make internal copies of refname and msg, so the
449  * caller retains ownership of these parameters.
450  *
451  * The functions return 0 on success and non-zero on failure. A
452  * failure means that the transaction as a whole has failed and needs
453  * to be rolled back.
454  */
455
456 /*
457  * Add a reference update to transaction. new_sha1 is the value that
458  * the reference should have after the update, or null_sha1 if it
459  * should be deleted. If new_sha1 is NULL, then the reference is not
460  * changed at all. old_sha1 is the value that the reference must have
461  * before the update, or null_sha1 if it must not have existed
462  * beforehand. The old value is checked after the lock is taken to
463  * prevent races. If the old value doesn't agree with old_sha1, the
464  * whole transaction fails. If old_sha1 is NULL, then the previous
465  * value is not checked.
466  *
467  * See the above comment "Reference transaction updates" for more
468  * information.
469  */
470 int ref_transaction_update(struct ref_transaction *transaction,
471                            const char *refname,
472                            const unsigned char *new_sha1,
473                            const unsigned char *old_sha1,
474                            unsigned int flags, const char *msg,
475                            struct strbuf *err);
476
477 /*
478  * Add a reference creation to transaction. new_sha1 is the value that
479  * the reference should have after the update; it must not be
480  * null_sha1. It is verified that the reference does not exist
481  * already.
482  *
483  * See the above comment "Reference transaction updates" for more
484  * information.
485  */
486 int ref_transaction_create(struct ref_transaction *transaction,
487                            const char *refname,
488                            const unsigned char *new_sha1,
489                            unsigned int flags, const char *msg,
490                            struct strbuf *err);
491
492 /*
493  * Add a reference deletion to transaction. If old_sha1 is non-NULL,
494  * then it holds the value that the reference should have had before
495  * the update (which must not be null_sha1).
496  *
497  * See the above comment "Reference transaction updates" for more
498  * information.
499  */
500 int ref_transaction_delete(struct ref_transaction *transaction,
501                            const char *refname,
502                            const unsigned char *old_sha1,
503                            unsigned int flags, const char *msg,
504                            struct strbuf *err);
505
506 /*
507  * Verify, within a transaction, that refname has the value old_sha1,
508  * or, if old_sha1 is null_sha1, then verify that the reference
509  * doesn't exist. old_sha1 must be non-NULL.
510  *
511  * See the above comment "Reference transaction updates" for more
512  * information.
513  */
514 int ref_transaction_verify(struct ref_transaction *transaction,
515                            const char *refname,
516                            const unsigned char *old_sha1,
517                            unsigned int flags,
518                            struct strbuf *err);
519
520 /*
521  * Commit all of the changes that have been queued in transaction, as
522  * atomically as possible.
523  *
524  * Returns 0 for success, or one of the below error codes for errors.
525  */
526 /* Naming conflict (for example, the ref names A and A/B conflict). */
527 #define TRANSACTION_NAME_CONFLICT -1
528 /* All other errors. */
529 #define TRANSACTION_GENERIC_ERROR -2
530 int ref_transaction_commit(struct ref_transaction *transaction,
531                            struct strbuf *err);
532
533 /*
534  * Like ref_transaction_commit(), but optimized for creating
535  * references when originally initializing a repository (e.g., by "git
536  * clone"). It writes the new references directly to packed-refs
537  * without locking the individual references.
538  *
539  * It is a bug to call this function when there might be other
540  * processes accessing the repository or if there are existing
541  * references that might conflict with the ones being created. All
542  * old_sha1 values must either be absent or NULL_SHA1.
543  */
544 int initial_ref_transaction_commit(struct ref_transaction *transaction,
545                                    struct strbuf *err);
546
547 /*
548  * Free an existing transaction and all associated data.
549  */
550 void ref_transaction_free(struct ref_transaction *transaction);
551
552 /**
553  * Lock, update, and unlock a single reference. This function
554  * basically does a transaction containing a single call to
555  * ref_transaction_update(). The parameters to this function have the
556  * same meaning as the corresponding parameters to
557  * ref_transaction_update(). Handle errors as requested by the `onerr`
558  * argument.
559  */
560 int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname,
561                     const unsigned char *new_sha1, const unsigned char *old_sha1,
562                     unsigned int flags, enum action_on_err onerr);
563 int update_ref(const char *msg, const char *refname,
564                const unsigned char *new_sha1, const unsigned char *old_sha1,
565                unsigned int flags, enum action_on_err onerr);
566 int update_ref_oid(const char *msg, const char *refname,
567                const struct object_id *new_oid, const struct object_id *old_oid,
568                unsigned int flags, enum action_on_err onerr);
569
570 int parse_hide_refs_config(const char *var, const char *value, const char *);
571
572 /*
573  * Check whether a ref is hidden. If no namespace is set, both the first and
574  * the second parameter point to the full ref name. If a namespace is set and
575  * the ref is inside that namespace, the first parameter is a pointer to the
576  * name of the ref with the namespace prefix removed. If a namespace is set and
577  * the ref is outside that namespace, the first parameter is NULL. The second
578  * parameter always points to the full ref name.
579  */
580 int ref_is_hidden(const char *, const char *);
581
582 enum ref_type {
583         REF_TYPE_PER_WORKTREE,
584         REF_TYPE_PSEUDOREF,
585         REF_TYPE_NORMAL,
586 };
587
588 enum ref_type ref_type(const char *refname);
589
590 enum expire_reflog_flags {
591         EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
592         EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
593         EXPIRE_REFLOGS_VERBOSE = 1 << 2,
594         EXPIRE_REFLOGS_REWRITE = 1 << 3
595 };
596
597 /*
598  * The following interface is used for reflog expiration. The caller
599  * calls reflog_expire(), supplying it with three callback functions,
600  * of the following types. The callback functions define the
601  * expiration policy that is desired.
602  *
603  * reflog_expiry_prepare_fn -- Called once after the reference is
604  *     locked.
605  *
606  * reflog_expiry_should_prune_fn -- Called once for each entry in the
607  *     existing reflog. It should return true iff that entry should be
608  *     pruned.
609  *
610  * reflog_expiry_cleanup_fn -- Called once before the reference is
611  *     unlocked again.
612  */
613 typedef void reflog_expiry_prepare_fn(const char *refname,
614                                       const unsigned char *sha1,
615                                       void *cb_data);
616 typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
617                                           unsigned char *nsha1,
618                                           const char *email,
619                                           unsigned long timestamp, int tz,
620                                           const char *message, void *cb_data);
621 typedef void reflog_expiry_cleanup_fn(void *cb_data);
622
623 /*
624  * Expire reflog entries for the specified reference. sha1 is the old
625  * value of the reference. flags is a combination of the constants in
626  * enum expire_reflog_flags. The three function pointers are described
627  * above. On success, return zero.
628  */
629 int refs_reflog_expire(struct ref_store *refs,
630                        const char *refname,
631                        const unsigned char *sha1,
632                        unsigned int flags,
633                        reflog_expiry_prepare_fn prepare_fn,
634                        reflog_expiry_should_prune_fn should_prune_fn,
635                        reflog_expiry_cleanup_fn cleanup_fn,
636                        void *policy_cb_data);
637 int reflog_expire(const char *refname, const unsigned char *sha1,
638                   unsigned int flags,
639                   reflog_expiry_prepare_fn prepare_fn,
640                   reflog_expiry_should_prune_fn should_prune_fn,
641                   reflog_expiry_cleanup_fn cleanup_fn,
642                   void *policy_cb_data);
643
644 int ref_storage_backend_exists(const char *name);
645
646 struct ref_store *get_main_ref_store(void);
647 /*
648  * Return the ref_store instance for the specified submodule. For the
649  * main repository, use submodule==NULL; such a call cannot fail. For
650  * a submodule, the submodule must exist and be a nonbare repository,
651  * otherwise return NULL. If the requested reference store has not yet
652  * been initialized, initialize it first.
653  *
654  * For backwards compatibility, submodule=="" is treated the same as
655  * submodule==NULL.
656  */
657 struct ref_store *get_submodule_ref_store(const char *submodule);
658
659 #endif /* REFS_H */