mirror of
https://github.com/git/git
synced 2024-07-17 02:57:48 +00:00
cb5d709ff8
This is a long overdue fix to the API for for_each_ref() family of functions. It allows the callers to specify a callback data pointer, so that the caller does not have to use static variables to communicate with the callback funciton. The updated for_each_ref() family takes a function of type int (*fn)(const char *, const unsigned char *, void *) and a void pointer as parameters, and calls the function with the name of the ref and its SHA-1 with the caller-supplied void pointer as parameters. The commit updates two callers, builtin-name-rev.c and builtin-pack-refs.c as an example. Signed-off-by: Junio C Hamano <junkio@cox.net>
46 lines
1.5 KiB
C
46 lines
1.5 KiB
C
#ifndef REFS_H
|
|
#define REFS_H
|
|
|
|
struct ref_lock {
|
|
char *ref_name;
|
|
char *log_file;
|
|
struct lock_file *lk;
|
|
unsigned char old_sha1[20];
|
|
int lock_fd;
|
|
int force_write;
|
|
};
|
|
|
|
/*
|
|
* Calls the specified function for each ref file until it returns nonzero,
|
|
* and returns the value
|
|
*/
|
|
typedef int each_ref_fn(const char *refname, const unsigned char *sha1, void *cb_data);
|
|
extern int head_ref(each_ref_fn, void *);
|
|
extern int for_each_ref(each_ref_fn, void *);
|
|
extern int for_each_tag_ref(each_ref_fn, void *);
|
|
extern int for_each_branch_ref(each_ref_fn, void *);
|
|
extern int for_each_remote_ref(each_ref_fn, void *);
|
|
|
|
/** Reads the refs file specified into sha1 **/
|
|
extern int get_ref_sha1(const char *ref, unsigned char *sha1);
|
|
|
|
/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
|
|
extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1, int mustexist);
|
|
|
|
/** Locks any ref (for 'HEAD' type refs). */
|
|
extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int mustexist);
|
|
|
|
/** Release any lock taken but not written. **/
|
|
extern void unlock_ref(struct ref_lock *lock);
|
|
|
|
/** Writes sha1 into the ref specified by the lock. **/
|
|
extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
|
|
|
|
/** Reads log for the value of ref during at_time. **/
|
|
extern int read_ref_at(const char *ref, unsigned long at_time, unsigned char *sha1);
|
|
|
|
/** Returns 0 if target has the right format for a ref. **/
|
|
extern int check_ref_format(const char *target);
|
|
|
|
#endif /* REFS_H */
|