Add callback data to for_each_ref() family.
[git/git.git] / refs.h
1 #ifndef REFS_H
2 #define REFS_H
3
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 };
12
13 /*
14 * Calls the specified function for each ref file until it returns nonzero,
15 * and returns the value
16 */
17 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, void *cb_data);
18 extern int head_ref(each_ref_fn, void *);
19 extern int for_each_ref(each_ref_fn, void *);
20 extern int for_each_tag_ref(each_ref_fn, void *);
21 extern int for_each_branch_ref(each_ref_fn, void *);
22 extern int for_each_remote_ref(each_ref_fn, void *);
23
24 /** Reads the refs file specified into sha1 **/
25 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
26
27 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
28 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1, int mustexist);
29
30 /** Locks any ref (for 'HEAD' type refs). */
31 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int mustexist);
32
33 /** Release any lock taken but not written. **/
34 extern void unlock_ref(struct ref_lock *lock);
35
36 /** Writes sha1 into the ref specified by the lock. **/
37 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
38
39 /** Reads log for the value of ref during at_time. **/
40 extern int read_ref_at(const char *ref, unsigned long at_time, unsigned char *sha1);
41
42 /** Returns 0 if target has the right format for a ref. **/
43 extern int check_ref_format(const char *target);
44
45 #endif /* REFS_H */