dwim_ref(): Separate name-to-ref DWIM code out.
[git/git.git] / refs.h
CommitLineData
95fc7512
DB
1#ifndef REFS_H
2#define REFS_H
3
4bd18c43 4struct ref_lock {
434cd0cd 5 char *ref_name;
6de08ae6 6 char *log_file;
c33d5174 7 struct lock_file *lk;
4bd18c43
SP
8 unsigned char old_sha1[20];
9 int lock_fd;
732232a1 10 int force_write;
4bd18c43
SP
11};
12
f4204ab9
JH
13#define REF_ISSYMREF 01
14#define REF_ISPACKED 02
15
8a65ff76
LT
16/*
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
19 */
8da19775 20typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
cb5d709f
JH
21extern int head_ref(each_ref_fn, void *);
22extern int for_each_ref(each_ref_fn, void *);
23extern int for_each_tag_ref(each_ref_fn, void *);
24extern int for_each_branch_ref(each_ref_fn, void *);
25extern int for_each_remote_ref(each_ref_fn, void *);
8a65ff76 26
cf0adba7
JH
27extern int peel_ref(const char *, unsigned char *);
28
95fc7512
DB
29/** Reads the refs file specified into sha1 **/
30extern int get_ref_sha1(const char *ref, unsigned char *sha1);
31
4bd18c43 32/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
4431fcc4 33extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
4bd18c43
SP
34
35/** Locks any ref (for 'HEAD' type refs). */
4431fcc4 36extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1);
95fc7512 37
4bd18c43 38/** Release any lock taken but not written. **/
e5f38ec3 39extern void unlock_ref(struct ref_lock *lock);
95fc7512 40
4bd18c43
SP
41/** Writes sha1 into the ref specified by the lock. **/
42extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 43
d556fae2 44/** Reads log for the value of ref during at_time. **/
ab2a1a32 45extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1);
d556fae2 46
2ff81662 47/* iterate over reflog entries */
883d60fa
JS
48typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
49int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
2ff81662 50
95fc7512
DB
51/** Returns 0 if target has the right format for a ref. **/
52extern int check_ref_format(const char *target);
53
c976d415 54/** rename ref, return 0 on success **/
678d0f4c 55extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 56
95fc7512 57#endif /* REFS_H */