get_ref_dir(): change signature
[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
98ac34b2
JH
13#define REF_ISSYMREF 0x01
14#define REF_ISPACKED 0x02
15#define REF_ISBROKEN 0x04
f4204ab9 16
8a65ff76
LT
17/*
18 * Calls the specified function for each ref file until it returns nonzero,
19 * and returns the value
20 */
8da19775 21typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
cb5d709f
JH
22extern int head_ref(each_ref_fn, void *);
23extern int for_each_ref(each_ref_fn, void *);
2a8177b6 24extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
25extern int for_each_tag_ref(each_ref_fn, void *);
26extern int for_each_branch_ref(each_ref_fn, void *);
27extern int for_each_remote_ref(each_ref_fn, void *);
29268700 28extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 29extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 30extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 31
9ef6aeb0
HV
32extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
33extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
34extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
35 each_ref_fn fn, void *cb_data);
36extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
37extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
38extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
39
a1bea2c1
JT
40extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
41extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
42
894a9d33
TR
43static inline const char *has_glob_specials(const char *pattern)
44{
45 return strpbrk(pattern, "?*[");
46}
47
f8948e2f
JH
48/* can be used to learn about broken ref and symref */
49extern int for_each_rawref(each_ref_fn, void *);
50
3cf6134a 51extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 52
e142a3c6
DB
53/*
54 * Extra refs will be listed by for_each_ref() before any actual refs
55 * for the duration of this process or until clear_extra_refs() is
56 * called. Only extra refs added before for_each_ref() is called will
57 * be listed on a given call of for_each_ref().
58 */
59extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
60extern void clear_extra_refs(void);
2c5c66be 61extern int ref_exists(const char *);
e142a3c6 62
dfefa935 63extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 64
4bd18c43 65/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
dfefa935 66extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
4bd18c43
SP
67
68/** Locks any ref (for 'HEAD' type refs). */
68db31cc 69#define REF_NODEREF 0x01
dfefa935
MH
70extern struct ref_lock *lock_any_ref_for_update(const char *refname,
71 const unsigned char *old_sha1,
72 int flags);
95fc7512 73
435fc852
BC
74/** Close the file descriptor owned by a lock and return the status */
75extern int close_ref(struct ref_lock *lock);
76
77/** Close and commit the ref locked by the lock */
78extern int commit_ref(struct ref_lock *lock);
79
4bd18c43 80/** Release any lock taken but not written. **/
e5f38ec3 81extern void unlock_ref(struct ref_lock *lock);
95fc7512 82
4bd18c43
SP
83/** Writes sha1 into the ref specified by the lock. **/
84extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 85
8be8bde7
MH
86/*
87 * Invalidate the reference cache for the specified submodule. Use
88 * submodule=NULL to invalidate the cache for the main module. This
89 * function must be called if references are changed via a mechanism
90 * other than the refs API.
91 */
92extern void invalidate_ref_cache(const char *submodule);
93
859c3017 94/** Setup reflog before using. **/
157aaea5 95int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
859c3017 96
d556fae2 97/** Reads log for the value of ref during at_time. **/
dfefa935
MH
98extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
99 unsigned char *sha1, char **msg,
100 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 101
2ff81662 102/* iterate over reflog entries */
883d60fa 103typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935
MH
104int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
105int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long, void *cb_data);
2ff81662 106
eb8381c8
NP
107/*
108 * Calls the specified function for each reflog file until it returns nonzero,
109 * and returns the value
110 */
111extern int for_each_reflog(each_ref_fn, void *);
112
8d9c5010
MH
113#define REFNAME_ALLOW_ONELEVEL 1
114#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 115#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
116
117/*
dfefa935
MH
118 * Return 0 iff refname has the correct format for a refname according
119 * to the rules described in Documentation/git-check-ref-format.txt.
120 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
121 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
122 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
123 * components. No leading or repeated slashes are accepted. If
124 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
125 * components to start with "." (but not a whole component equal to
126 * "." or "..").
8d9c5010 127 */
dfefa935 128extern int check_refname_format(const char *refname, int flags);
95fc7512 129
4577e483 130extern const char *prettify_refname(const char *refname);
dfefa935 131extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 132
c976d415 133/** rename ref, return 0 on success **/
678d0f4c 134extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 135
0ebde32c 136/** resolve ref in nested "gitlink" repository */
85be1fe3 137extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *sha1);
0ebde32c 138
3d9f037c
CR
139/** lock a ref and then write its file */
140enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
141int update_ref(const char *action, const char *refname,
142 const unsigned char *sha1, const unsigned char *oldval,
143 int flags, enum action_on_err onerr);
144
95fc7512 145#endif /* REFS_H */