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