refs: wrap the packed refs cache in a level of indirection
[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
89df9c84
MH
13/*
14 * Bit values set in the flags argument passed to each_ref_fn():
15 */
16
17/* Reference is a symbolic reference. */
98ac34b2 18#define REF_ISSYMREF 0x01
89df9c84
MH
19
20/* Reference is a packed reference. */
98ac34b2 21#define REF_ISPACKED 0x02
89df9c84
MH
22
23/*
24 * Reference cannot be resolved to an object name: dangling symbolic
25 * reference (directly or indirectly), corrupt reference file, or
26 * symbolic reference refers to ill-formatted reference name.
27 */
98ac34b2 28#define REF_ISBROKEN 0x04
f4204ab9 29
8a65ff76 30/*
4f78c24c
MH
31 * The signature for the callback function for the for_each_*()
32 * functions below. The memory pointed to by the refname and sha1
33 * arguments is only guaranteed to be valid for the duration of a
34 * single callback invocation.
35 */
36typedef int each_ref_fn(const char *refname,
37 const unsigned char *sha1, int flags, void *cb_data);
38
39/*
40 * The following functions invoke the specified callback function for
41 * each reference indicated. If the function ever returns a nonzero
42 * value, stop the iteration and return that value. Please note that
43 * it is not safe to modify references while an iteration is in
44 * progress, unless the same callback function invocation that
45 * modifies the reference also returns a nonzero value to immediately
46 * stop the iteration.
8a65ff76 47 */
cb5d709f
JH
48extern int head_ref(each_ref_fn, void *);
49extern int for_each_ref(each_ref_fn, void *);
2a8177b6 50extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
51extern int for_each_tag_ref(each_ref_fn, void *);
52extern int for_each_branch_ref(each_ref_fn, void *);
53extern int for_each_remote_ref(each_ref_fn, void *);
29268700 54extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 55extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 56extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 57
9ef6aeb0
HV
58extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
59extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
60extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
61 each_ref_fn fn, void *cb_data);
62extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
63extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
64extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
65
a1bea2c1
JT
66extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
67extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
68
894a9d33
TR
69static inline const char *has_glob_specials(const char *pattern)
70{
71 return strpbrk(pattern, "?*[");
72}
73
f8948e2f
JH
74/* can be used to learn about broken ref and symref */
75extern int for_each_rawref(each_ref_fn, void *);
76
3cf6134a 77extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 78
30249ee6
MH
79/*
80 * Add a reference to the in-memory packed reference cache. To actually
81 * write the reference to the packed-refs file, call pack_refs().
82 */
83extern void add_packed_ref(const char *refname, const unsigned char *sha1);
84
32d462ce
MH
85/*
86 * Flags for controlling behaviour of pack_refs()
87 * PACK_REFS_PRUNE: Prune loose refs after packing
88 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
89 */
90#define PACK_REFS_PRUNE 0x0001
91#define PACK_REFS_ALL 0x0002
92
93/*
94 * Write a packed-refs file for the current repository.
95 * flags: Combination of the above PACK_REFS_* flags.
96 */
97int pack_refs(unsigned int flags);
98
2c5c66be 99extern int ref_exists(const char *);
e142a3c6 100
2312a793
MH
101/*
102 * If refname is a non-symbolic reference that refers to a tag object,
103 * and the tag can be (recursively) dereferenced to a non-tag object,
104 * store the SHA1 of the referred-to object to sha1 and return 0. If
105 * any of these conditions are not met, return a non-zero value.
106 * Symbolic references are considered unpeelable, even if they
107 * ultimately resolve to a peelable tag.
108 */
dfefa935 109extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 110
4bd18c43 111/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
dfefa935 112extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
4bd18c43
SP
113
114/** Locks any ref (for 'HEAD' type refs). */
68db31cc 115#define REF_NODEREF 0x01
dfefa935
MH
116extern struct ref_lock *lock_any_ref_for_update(const char *refname,
117 const unsigned char *old_sha1,
118 int flags);
95fc7512 119
435fc852
BC
120/** Close the file descriptor owned by a lock and return the status */
121extern int close_ref(struct ref_lock *lock);
122
123/** Close and commit the ref locked by the lock */
124extern int commit_ref(struct ref_lock *lock);
125
4bd18c43 126/** Release any lock taken but not written. **/
e5f38ec3 127extern void unlock_ref(struct ref_lock *lock);
95fc7512 128
4bd18c43
SP
129/** Writes sha1 into the ref specified by the lock. **/
130extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 131
8be8bde7
MH
132/*
133 * Invalidate the reference cache for the specified submodule. Use
134 * submodule=NULL to invalidate the cache for the main module. This
135 * function must be called if references are changed via a mechanism
136 * other than the refs API.
137 */
138extern void invalidate_ref_cache(const char *submodule);
139
859c3017 140/** Setup reflog before using. **/
157aaea5 141int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
859c3017 142
d556fae2 143/** Reads log for the value of ref during at_time. **/
dfefa935
MH
144extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
145 unsigned char *sha1, char **msg,
146 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 147
2ff81662 148/* iterate over reflog entries */
883d60fa 149typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935 150int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
98f85ff4 151int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
2ff81662 152
eb8381c8
NP
153/*
154 * Calls the specified function for each reflog file until it returns nonzero,
155 * and returns the value
156 */
157extern int for_each_reflog(each_ref_fn, void *);
158
8d9c5010
MH
159#define REFNAME_ALLOW_ONELEVEL 1
160#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 161#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
162
163/*
dfefa935
MH
164 * Return 0 iff refname has the correct format for a refname according
165 * to the rules described in Documentation/git-check-ref-format.txt.
166 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
167 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
168 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
169 * components. No leading or repeated slashes are accepted. If
170 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
171 * components to start with "." (but not a whole component equal to
172 * "." or "..").
8d9c5010 173 */
dfefa935 174extern int check_refname_format(const char *refname, int flags);
95fc7512 175
4577e483 176extern const char *prettify_refname(const char *refname);
dfefa935 177extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 178
c976d415 179/** rename ref, return 0 on success **/
678d0f4c 180extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 181
7f820bd9
MH
182/**
183 * Resolve refname in the nested "gitlink" repository that is located
184 * at path. If the resolution is successful, return 0 and set sha1 to
185 * the name of the object; otherwise, return a non-zero value.
186 */
187extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
0ebde32c 188
3d9f037c
CR
189/** lock a ref and then write its file */
190enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
191int update_ref(const char *action, const char *refname,
192 const unsigned char *sha1, const unsigned char *oldval,
193 int flags, enum action_on_err onerr);
194
daebaa78
JH
195extern int parse_hide_refs_config(const char *var, const char *value, const char *);
196extern int ref_is_hidden(const char *);
197
95fc7512 198#endif /* REFS_H */