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