rev-parse --branches/--tags/--remotes=pattern
[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 *);
2a8177b6 23extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
24extern int for_each_tag_ref(each_ref_fn, void *);
25extern int for_each_branch_ref(each_ref_fn, void *);
26extern int for_each_remote_ref(each_ref_fn, void *);
29268700 27extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 28extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 29extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 30
f8948e2f
JH
31/* can be used to learn about broken ref and symref */
32extern int for_each_rawref(each_ref_fn, void *);
33
3cf6134a 34extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 35
e142a3c6
DB
36/*
37 * Extra refs will be listed by for_each_ref() before any actual refs
38 * for the duration of this process or until clear_extra_refs() is
39 * called. Only extra refs added before for_each_ref() is called will
40 * be listed on a given call of for_each_ref().
41 */
42extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
43extern void clear_extra_refs(void);
44
cf0adba7
JH
45extern int peel_ref(const char *, unsigned char *);
46
4bd18c43 47/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
4431fcc4 48extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
4bd18c43
SP
49
50/** Locks any ref (for 'HEAD' type refs). */
68db31cc
SV
51#define REF_NODEREF 0x01
52extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
95fc7512 53
435fc852
BC
54/** Close the file descriptor owned by a lock and return the status */
55extern int close_ref(struct ref_lock *lock);
56
57/** Close and commit the ref locked by the lock */
58extern int commit_ref(struct ref_lock *lock);
59
4bd18c43 60/** Release any lock taken but not written. **/
e5f38ec3 61extern void unlock_ref(struct ref_lock *lock);
95fc7512 62
4bd18c43
SP
63/** Writes sha1 into the ref specified by the lock. **/
64extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 65
d556fae2 66/** Reads log for the value of ref during at_time. **/
16d7cc90 67extern 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 68
2ff81662 69/* iterate over reflog entries */
883d60fa
JS
70typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
71int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
101d15e0 72int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
2ff81662 73
eb8381c8
NP
74/*
75 * Calls the specified function for each reflog file until it returns nonzero,
76 * and returns the value
77 */
78extern int for_each_reflog(each_ref_fn, void *);
79
5f7b202a
JH
80#define CHECK_REF_FORMAT_OK 0
81#define CHECK_REF_FORMAT_ERROR (-1)
82#define CHECK_REF_FORMAT_ONELEVEL (-2)
83#define CHECK_REF_FORMAT_WILDCARD (-3)
95fc7512
DB
84extern int check_ref_format(const char *target);
85
4577e483 86extern const char *prettify_refname(const char *refname);
6e7b3309 87extern char *shorten_unambiguous_ref(const char *ref, int strict);
a9c37a72 88
c976d415 89/** rename ref, return 0 on success **/
678d0f4c 90extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 91
0ebde32c
LT
92/** resolve ref in nested "gitlink" repository */
93extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
94
3d9f037c
CR
95/** lock a ref and then write its file */
96enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
97int update_ref(const char *action, const char *refname,
98 const unsigned char *sha1, const unsigned char *oldval,
99 int flags, enum action_on_err onerr);
100
95fc7512 101#endif /* REFS_H */