Store peeled refs in packed-refs file.
[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 #define REF_ISSYMREF 01
18 #define REF_ISPACKED 02
19 #define REF_ISPEELED 04 /* internal use */
20
21 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
22 extern int head_ref(each_ref_fn, void *);
23 extern int for_each_ref(each_ref_fn, void *);
24 extern int for_each_tag_ref(each_ref_fn, void *);
25 extern int for_each_branch_ref(each_ref_fn, void *);
26 extern int for_each_remote_ref(each_ref_fn, void *);
27
28 extern int peel_ref(const char *, unsigned char *);
29
30 /** Reads the refs file specified into sha1 **/
31 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
32
33 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
34 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
35
36 /** Locks any ref (for 'HEAD' type refs). */
37 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1);
38
39 /** Release any lock taken but not written. **/
40 extern void unlock_ref(struct ref_lock *lock);
41
42 /** Writes sha1 into the ref specified by the lock. **/
43 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
44
45 /** Reads log for the value of ref during at_time. **/
46 extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1);
47
48 /** Returns 0 if target has the right format for a ref. **/
49 extern int check_ref_format(const char *target);
50
51 #endif /* REFS_H */