#define REFS_H

#include "commit.h"

struct object_id;

struct ref_store;

struct strbuf;

struct string_list;

struct string_list_item;

struct worktree;

/*

* Resolve a reference, recursively following symbolic refererences.

struct object_id *oid,

int *flags);

char *refs_resolve_refdup(struct ref_store *refs,

const char *refname, int resolve_flags,

struct object_id *oid, int *flags);

int refs_read_symbolic_ref(struct ref_store *ref_store, const char *refname,

struct strbuf *referent);

int refs_ref_exists(struct ref_store *refs, const char *refname);

int should_autocreate_reflog(const char *refname);

int is_branch(const char *refname);

/*

* Return the peeled value of the oid currently being iterated via

* for_each_ref(), etc. This is equivalent to calling:

*

*

* with the "oid" value given to the each_ref_fn callback, except

* that some ref storage may be able to answer the query without

* actually loading the object in memory.

*/

/**

* Resolve refname in the nested "gitlink" repository in the specified

* successful, return 0 and set oid to the name of the object;

* otherwise, return a non-zero value.

*/

/*

* Return true iff abbrev_name is a possible abbreviation for

int repo_dwim_ref(struct repository *r, const char *str, int len,

struct object_id *oid, char **ref, int nonfatal_dangling_mark);

int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);

/*

* Retrieves the default branch name for newly-initialized repositories.

*

*/

char *repo_default_branch_name(struct repository *r, int quiet);

/*

const struct object_id *oid, int flags, void *cb_data);

/*

* The following functions invoke the specified callback function for

* each reference indicated. If the function ever returns a nonzero

* value, stop the iteration and return that value. Please note that

each_ref_fn fn, void *cb_data);

int refs_for_each_remote_ref(struct ref_store *refs,

each_ref_fn fn, void *cb_data);

/*

* references matching any pattern in "exclude_patterns" are omitted from the

int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,

const char **exclude_patterns,

each_ref_fn fn, void *cb_data);

/**

* iterate all refs in "patterns" by partitioning patterns into disjoint sets

const char **exclude_patterns,

each_ref_fn fn, void *cb_data);

/* iterates all refs that match the specified glob pattern. */

/*

* references matching any pattern in "exclude_patterns" are omitted from the

* result set on a best-effort basis.

*/

/* can be used to learn about broken ref and symref */

int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data);

/*

* Iterates over all refs including root refs, i.e. pseudorefs and HEAD.

return strpbrk(pattern, "?*[");

}

/*

* Flags for controlling behaviour of pack_refs()

*/

int refs_create_reflog(struct ref_store *refs, const char *refname,

struct strbuf *err);

/**

* Reads log for the value of ref during at_time (in which case "cnt" should be

/** Check if a particular reflog exists */

int refs_reflog_exists(struct ref_store *refs, const char *refname);

/*

* Delete the specified reference. If old_oid is non-NULL, then

const char *refname,

const struct object_id *old_oid,

unsigned int flags);

/*

* Delete the specified references. If there are any problems, emit

*/

int refs_delete_refs(struct ref_store *refs, const char *msg,

struct string_list *refnames, unsigned int flags);

/** Delete a reflog */

int refs_delete_reflog(struct ref_store *refs, const char *refname);

/*

* Callback to process a reflog entry found by the iteration functions (see

void *cb_data);

/*

* functions below. The memory pointed to by the refname argument is only

* guaranteed to be valid for the duration of a single callback invocation.

*/

* and returns the value. Reflog file order is unspecified.

*/

int refs_for_each_reflog(struct ref_store *refs, each_reflog_fn fn, void *cb_data);

#define REFNAME_ALLOW_ONELEVEL 1

#define REFNAME_REFSPEC_PATTERN 2

char *refs_shorten_unambiguous_ref(struct ref_store *refs,

const char *refname, int strict);

/** rename ref, return 0 on success **/

int refs_rename_ref(struct ref_store *refs, const char *oldref,

const char *newref, const char *logmsg);

/** copy ref, return 0 on success **/

int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,

const char *newref, const char *logmsg);

const char *target, const char *logmsg);

enum action_on_err {

UPDATE_REFS_MSG_ON_ERR,

*/

struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,

struct strbuf *err);

/*

* Reference transaction updates

* before the update. A copy of this value is made in the

* transaction.

*

* flags -- flags affecting the update, passed to

* update_ref_lock(). Possible flags: REF_NO_DEREF,

* REF_FORCE_CREATE_REFLOG. See those constants for more

#define REF_SKIP_REFNAME_VERIFICATION (1 << 11)

/*

* Bitmask of all of the flags that are allowed to be passed in to

* ref_transaction_update() and friends:

*/

#define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \

(REF_NO_DEREF | REF_FORCE_CREATE_REFLOG | REF_SKIP_OID_VERIFICATION | \

/*

* Add a reference update to transaction. `new_oid` is the value that

* beforehand. The old value is checked after the lock is taken to

* prevent races. If the old value doesn't agree with old_oid, the

* whole transaction fails. If old_oid is NULL, then the previous

*

* See the above comment "Reference transaction updates" for more

* information.

const char *refname,

const struct object_id *new_oid,

const struct object_id *old_oid,

unsigned int flags, const char *msg,

struct strbuf *err);

int ref_transaction_create(struct ref_transaction *transaction,

const char *refname,

const struct object_id *new_oid,

unsigned int flags, const char *msg,

struct strbuf *err);

int ref_transaction_delete(struct ref_transaction *transaction,

const char *refname,

const struct object_id *old_oid,

struct strbuf *err);

/*

int ref_transaction_verify(struct ref_transaction *transaction,

const char *refname,

const struct object_id *old_oid,

unsigned int flags,

struct strbuf *err);

int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname,

const struct object_id *new_oid, const struct object_id *old_oid,

unsigned int flags, enum action_on_err onerr);

int parse_hide_refs_config(const char *var, const char *value, const char *,

struct strvec *);

/*

* The following interface is used for reflog expiration. The caller

* of the following types. The callback functions define the

* expiration policy that is desired.

*

reflog_expiry_should_prune_fn should_prune_fn,

reflog_expiry_cleanup_fn cleanup_fn,

void *policy_cb_data);

struct ref_store *get_main_ref_store(struct repository *r);

* For backwards compatibility, submodule=="" is treated the same as

* submodule==NULL.

*/

struct ref_store *get_worktree_ref_store(const struct worktree *wt);

/*

*/

struct ref_namespace_info {

enum decoration_type decoration;

/*

*/

void update_ref_namespace(enum ref_namespace namespace, char *ref);

#endif /* REFS_H */