interpret_nth_last_branch(): plug small memleak
[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;
1655707c 6 char *orig_ref_name;
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
e142a3c6
DB
27/*
28 * Extra refs will be listed by for_each_ref() before any actual refs
29 * for the duration of this process or until clear_extra_refs() is
30 * called. Only extra refs added before for_each_ref() is called will
31 * be listed on a given call of for_each_ref().
32 */
33extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
34extern void clear_extra_refs(void);
35
cf0adba7
JH
36extern int peel_ref(const char *, unsigned char *);
37
4bd18c43 38/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
4431fcc4 39extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
4bd18c43
SP
40
41/** Locks any ref (for 'HEAD' type refs). */
68db31cc
SV
42#define REF_NODEREF 0x01
43extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
95fc7512 44
435fc852
BC
45/** Close the file descriptor owned by a lock and return the status */
46extern int close_ref(struct ref_lock *lock);
47
48/** Close and commit the ref locked by the lock */
49extern int commit_ref(struct ref_lock *lock);
50
4bd18c43 51/** Release any lock taken but not written. **/
e5f38ec3 52extern void unlock_ref(struct ref_lock *lock);
95fc7512 53
4bd18c43
SP
54/** Writes sha1 into the ref specified by the lock. **/
55extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 56
d556fae2 57/** Reads log for the value of ref during at_time. **/
16d7cc90 58extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 59
2ff81662 60/* iterate over reflog entries */
883d60fa
JS
61typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
62int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
2ff81662 63
eb8381c8
NP
64/*
65 * Calls the specified function for each reflog file until it returns nonzero,
66 * and returns the value
67 */
68extern int for_each_reflog(each_ref_fn, void *);
69
5f7b202a
JH
70#define CHECK_REF_FORMAT_OK 0
71#define CHECK_REF_FORMAT_ERROR (-1)
72#define CHECK_REF_FORMAT_ONELEVEL (-2)
73#define CHECK_REF_FORMAT_WILDCARD (-3)
95fc7512
DB
74extern int check_ref_format(const char *target);
75
c976d415 76/** rename ref, return 0 on success **/
678d0f4c 77extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 78
0ebde32c
LT
79/** resolve ref in nested "gitlink" repository */
80extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
81
3d9f037c
CR
82/** lock a ref and then write its file */
83enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
84int update_ref(const char *action, const char *refname,
85 const unsigned char *sha1, const unsigned char *oldval,
86 int flags, enum action_on_err onerr);
87
95fc7512 88#endif /* REFS_H */