1 #ifndef REFS_H
2 #define REFS_H
4 struct ref_lock {
5 char *ref_name;
6 char *log_file;
7 struct lock_file *lk;
8 unsigned char old_sha1[20];
9 int lock_fd;
10 int force_write;
11 };
13 #define REF_ISSYMREF 01
14 #define REF_ISPACKED 02
16 /*
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
19 */
20 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
21 extern int head_ref(each_ref_fn, void *);
22 extern int for_each_ref(each_ref_fn, void *);
23 extern int for_each_tag_ref(each_ref_fn, void *);
24 extern int for_each_branch_ref(each_ref_fn, void *);
25 extern int for_each_remote_ref(each_ref_fn, void *);
27 extern int peel_ref(const char *, unsigned char *);
29 /** Reads the refs file specified into sha1 **/
30 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
32 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
33 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
35 /** Locks any ref (for 'HEAD' type refs). */
36 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1);
38 /** Release any lock taken but not written. **/
39 extern void unlock_ref(struct ref_lock *lock);
41 /** Writes sha1 into the ref specified by the lock. **/
42 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
44 /** Reads log for the value of ref during at_time. **/
45 extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1);
47 /* iterate over reflog entries */
48 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, char *, void *);
49 void for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
51 /** Returns 0 if target has the right format for a ref. **/
52 extern int check_ref_format(const char *target);
54 /** rename ref, return 0 on success **/
55 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
57 #endif /* REFS_H */