1#ifndef REFS_H 2#define REFS_H 3 4struct ref_lock { 5 char *ref_name; 6 char *orig_ref_name; 7 struct lock_file *lk; 8 unsigned char old_sha1[20]; 9 int lock_fd; 10 int force_write; 11}; 12 13#define REF_ISSYMREF 01 14#define REF_ISPACKED 02 15 16/* 17 * Calls the specified function for each ref file until it returns nonzero, 18 * and returns the value 19 */ 20typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data); 21extern int head_ref(each_ref_fn, void *); 22extern int for_each_ref(each_ref_fn, void *); 23extern int for_each_ref_in(const char *, each_ref_fn, void *); 24extern int for_each_tag_ref(each_ref_fn, void *); 25extern int for_each_branch_ref(each_ref_fn, void *); 26extern int for_each_remote_ref(each_ref_fn, void *); 27extern int for_each_replace_ref(each_ref_fn, void *); 28extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *); 29 30/* can be used to learn about broken ref and symref */ 31extern int for_each_rawref(each_ref_fn, void *); 32 33extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); 34 35/* 36 * Extra refs will be listed by for_each_ref() before any actual refs 37 * for the duration of this process or until clear_extra_refs() is 38 * called. Only extra refs added before for_each_ref() is called will 39 * be listed on a given call of for_each_ref(). 40 */ 41extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags); 42extern void clear_extra_refs(void); 43 44extern int peel_ref(const char *, unsigned char *); 45 46/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/ 47extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1); 48 49/** Locks any ref (for 'HEAD' type refs). */ 50#define REF_NODEREF 0x01 51extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags); 52 53/** Close the file descriptor owned by a lock and return the status */ 54extern int close_ref(struct ref_lock *lock); 55 56/** Close and commit the ref locked by the lock */ 57extern int commit_ref(struct ref_lock *lock); 58 59/** Release any lock taken but not written. **/ 60extern void unlock_ref(struct ref_lock *lock); 61 62/** Writes sha1 into the ref specified by the lock. **/ 63extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg); 64 65/** Reads log for the value of ref during at_time. **/ 66extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt); 67 68/* iterate over reflog entries */ 69typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *); 70int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data); 71int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data); 72 73/* 74 * Calls the specified function for each reflog file until it returns nonzero, 75 * and returns the value 76 */ 77extern int for_each_reflog(each_ref_fn, void *); 78 79#define CHECK_REF_FORMAT_OK 0 80#define CHECK_REF_FORMAT_ERROR (-1) 81#define CHECK_REF_FORMAT_ONELEVEL (-2) 82#define CHECK_REF_FORMAT_WILDCARD (-3) 83extern int check_ref_format(const char *target); 84 85extern const char *prettify_refname(const char *refname); 86extern char *shorten_unambiguous_ref(const char *ref, int strict); 87 88/** rename ref, return 0 on success **/ 89extern int rename_ref(const char *oldref, const char *newref, const char *logmsg); 90 91/** resolve ref in nested "gitlink" repository */ 92extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result); 93 94/** lock a ref and then write its file */ 95enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR }; 96int update_ref(const char *action, const char *refname, 97 const unsigned char *sha1, const unsigned char *oldval, 98 int flags, enum action_on_err onerr); 99 100#endif /* REFS_H */