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