t1503: use test_must_be_empty
[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
b416af5b
RS
13/*
14 * A ref_transaction represents a collection of ref updates
15 * that should succeed or fail together.
16 *
17 * Calling sequence
18 * ----------------
19 * - Allocate and initialize a `struct ref_transaction` by calling
20 * `ref_transaction_begin()`.
21 *
22 * - List intended ref updates by calling functions like
23 * `ref_transaction_update()` and `ref_transaction_create()`.
24 *
25 * - Call `ref_transaction_commit()` to execute the transaction.
26 * If this succeeds, the ref updates will have taken place and
27 * the transaction cannot be rolled back.
28 *
29 * - At any time call `ref_transaction_free()` to discard the
30 * transaction and free associated resources. In particular,
31 * this rolls back the transaction if it has not been
32 * successfully committed.
33 *
34 * Error handling
35 * --------------
36 *
37 * On error, transaction functions append a message about what
38 * went wrong to the 'err' argument. The message mentions what
39 * ref was being updated (if any) when the error occurred so it
40 * can be passed to 'die' or 'error' as-is.
41 *
42 * The message is appended to err without first clearing err.
43 * err will not be '\n' terminated.
44 */
caa4046c
MH
45struct ref_transaction;
46
89df9c84
MH
47/*
48 * Bit values set in the flags argument passed to each_ref_fn():
49 */
50
51/* Reference is a symbolic reference. */
98ac34b2 52#define REF_ISSYMREF 0x01
89df9c84
MH
53
54/* Reference is a packed reference. */
98ac34b2 55#define REF_ISPACKED 0x02
89df9c84
MH
56
57/*
58 * Reference cannot be resolved to an object name: dangling symbolic
59 * reference (directly or indirectly), corrupt reference file, or
60 * symbolic reference refers to ill-formatted reference name.
61 */
98ac34b2 62#define REF_ISBROKEN 0x04
f4204ab9 63
8a65ff76 64/*
4f78c24c
MH
65 * The signature for the callback function for the for_each_*()
66 * functions below. The memory pointed to by the refname and sha1
67 * arguments is only guaranteed to be valid for the duration of a
68 * single callback invocation.
69 */
70typedef int each_ref_fn(const char *refname,
71 const unsigned char *sha1, int flags, void *cb_data);
72
73/*
74 * The following functions invoke the specified callback function for
75 * each reference indicated. If the function ever returns a nonzero
76 * value, stop the iteration and return that value. Please note that
77 * it is not safe to modify references while an iteration is in
78 * progress, unless the same callback function invocation that
79 * modifies the reference also returns a nonzero value to immediately
80 * stop the iteration.
8a65ff76 81 */
cb5d709f
JH
82extern int head_ref(each_ref_fn, void *);
83extern int for_each_ref(each_ref_fn, void *);
2a8177b6 84extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
85extern int for_each_tag_ref(each_ref_fn, void *);
86extern int for_each_branch_ref(each_ref_fn, void *);
87extern int for_each_remote_ref(each_ref_fn, void *);
29268700 88extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 89extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 90extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 91
9ef6aeb0
HV
92extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
93extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
94extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
95 each_ref_fn fn, void *cb_data);
96extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
97extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
98extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
99
a1bea2c1
JT
100extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
101extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
102
894a9d33
TR
103static inline const char *has_glob_specials(const char *pattern)
104{
105 return strpbrk(pattern, "?*[");
106}
107
f8948e2f
JH
108/* can be used to learn about broken ref and symref */
109extern int for_each_rawref(each_ref_fn, void *);
110
3cf6134a 111extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
e6bea66d 112extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list* refnames);
f8948e2f 113
30249ee6 114/*
9f69d297
MH
115 * Lock the packed-refs file for writing. Flags is passed to
116 * hold_lock_file_for_update(). Return 0 on success.
447ff1bf 117 * Errno is set to something meaningful on error.
9f69d297
MH
118 */
119extern int lock_packed_refs(int flags);
120
121/*
122 * Add a reference to the in-memory packed reference cache. This may
123 * only be called while the packed-refs file is locked (see
124 * lock_packed_refs()). To actually write the packed-refs file, call
125 * commit_packed_refs().
30249ee6
MH
126 */
127extern void add_packed_ref(const char *refname, const unsigned char *sha1);
128
9f69d297
MH
129/*
130 * Write the current version of the packed refs cache from memory to
131 * disk. The packed-refs file must already be locked for writing (see
132 * lock_packed_refs()). Return zero on success.
d3f66555 133 * Sets errno to something meaningful on error.
9f69d297
MH
134 */
135extern int commit_packed_refs(void);
136
137/*
138 * Rollback the lockfile for the packed-refs file, and discard the
139 * in-memory packed reference cache. (The packed-refs file will be
140 * read anew if it is needed again after this function is called.)
141 */
142extern void rollback_packed_refs(void);
143
32d462ce
MH
144/*
145 * Flags for controlling behaviour of pack_refs()
146 * PACK_REFS_PRUNE: Prune loose refs after packing
147 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
148 */
149#define PACK_REFS_PRUNE 0x0001
150#define PACK_REFS_ALL 0x0002
151
152/*
153 * Write a packed-refs file for the current repository.
154 * flags: Combination of the above PACK_REFS_* flags.
155 */
156int pack_refs(unsigned int flags);
157
60bca085
RS
158extern int repack_without_refs(const char **refnames, int n,
159 struct strbuf *err);
c9e768bb 160
2c5c66be 161extern int ref_exists(const char *);
e142a3c6 162
e7e0f26e
RS
163extern int is_branch(const char *refname);
164
2312a793
MH
165/*
166 * If refname is a non-symbolic reference that refers to a tag object,
167 * and the tag can be (recursively) dereferenced to a non-tag object,
168 * store the SHA1 of the referred-to object to sha1 and return 0. If
169 * any of these conditions are not met, return a non-zero value.
170 * Symbolic references are considered unpeelable, even if they
171 * ultimately resolve to a peelable tag.
172 */
dfefa935 173extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 174
835e3c99 175/*
029cdb4a
RS
176 * Flags controlling lock_any_ref_for_update(), ref_transaction_update(),
177 * ref_transaction_create(), etc.
178 * REF_NODEREF: act on the ref directly, instead of dereferencing
179 * symbolic references.
180 *
181 * Flags >= 0x100 are reserved for internal use.
835e3c99 182 */
68db31cc 183#define REF_NODEREF 0x01
029cdb4a
RS
184/*
185 * This function sets errno to something meaningful on failure.
186 */
dfefa935
MH
187extern struct ref_lock *lock_any_ref_for_update(const char *refname,
188 const unsigned char *old_sha1,
9bbb0fa1 189 int flags, int *type_p);
95fc7512 190
435fc852
BC
191/** Close the file descriptor owned by a lock and return the status */
192extern int close_ref(struct ref_lock *lock);
193
194/** Close and commit the ref locked by the lock */
195extern int commit_ref(struct ref_lock *lock);
196
4bd18c43 197/** Release any lock taken but not written. **/
e5f38ec3 198extern void unlock_ref(struct ref_lock *lock);
95fc7512 199
4bd18c43
SP
200/** Writes sha1 into the ref specified by the lock. **/
201extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 202
bd3b02da
RS
203/*
204 * Setup reflog before using. Set errno to something meaningful on failure.
205 */
5524e241 206int log_ref_setup(const char *refname, char *logfile, int bufsize);
859c3017 207
d556fae2 208/** Reads log for the value of ref during at_time. **/
dfefa935
MH
209extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
210 unsigned char *sha1, char **msg,
211 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 212
4da58835
RS
213/** Check if a particular reflog exists */
214extern int reflog_exists(const char *refname);
215
216/** Delete a reflog */
217extern int delete_reflog(const char *refname);
218
2ff81662 219/* iterate over reflog entries */
883d60fa 220typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935 221int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
98f85ff4 222int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
2ff81662 223
eb8381c8
NP
224/*
225 * Calls the specified function for each reflog file until it returns nonzero,
226 * and returns the value
227 */
228extern int for_each_reflog(each_ref_fn, void *);
229
8d9c5010
MH
230#define REFNAME_ALLOW_ONELEVEL 1
231#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 232#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
233
234/*
dfefa935
MH
235 * Return 0 iff refname has the correct format for a refname according
236 * to the rules described in Documentation/git-check-ref-format.txt.
237 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
238 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
239 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
240 * components. No leading or repeated slashes are accepted. If
241 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
242 * components to start with "." (but not a whole component equal to
243 * "." or "..").
8d9c5010 244 */
dfefa935 245extern int check_refname_format(const char *refname, int flags);
95fc7512 246
4577e483 247extern const char *prettify_refname(const char *refname);
dfefa935 248extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 249
c976d415 250/** rename ref, return 0 on success **/
678d0f4c 251extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 252
7f820bd9
MH
253/**
254 * Resolve refname in the nested "gitlink" repository that is located
255 * at path. If the resolution is successful, return 0 and set sha1 to
256 * the name of the object; otherwise, return a non-zero value.
257 */
258extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
0ebde32c 259
f4124112
MH
260enum action_on_err {
261 UPDATE_REFS_MSG_ON_ERR,
262 UPDATE_REFS_DIE_ON_ERR,
263 UPDATE_REFS_QUIET_ON_ERR
264};
265
caa4046c
MH
266/*
267 * Begin a reference transaction. The reference transaction must
33f9fc59 268 * be freed by calling ref_transaction_free().
caa4046c 269 */
93a644ea 270struct ref_transaction *ref_transaction_begin(struct strbuf *err);
caa4046c 271
caa4046c
MH
272/*
273 * The following functions add a reference check or update to a
274 * ref_transaction. In all of them, refname is the name of the
275 * reference to be affected. The functions make internal copies of
276 * refname, so the caller retains ownership of the parameter. flags
277 * can be REF_NODEREF; it is passed to update_ref_lock().
278 */
279
caa4046c
MH
280/*
281 * Add a reference update to transaction. new_sha1 is the value that
282 * the reference should have after the update, or zeros if it should
283 * be deleted. If have_old is true, then old_sha1 holds the value
284 * that the reference should have had before the update, or zeros if
285 * it must not have existed beforehand.
8e34800e
RS
286 * Function returns 0 on success and non-zero on failure. A failure to update
287 * means that the transaction as a whole has failed and will need to be
b416af5b 288 * rolled back.
caa4046c 289 */
8e34800e
RS
290int ref_transaction_update(struct ref_transaction *transaction,
291 const char *refname,
292 const unsigned char *new_sha1,
293 const unsigned char *old_sha1,
294 int flags, int have_old,
295 struct strbuf *err);
caa4046c
MH
296
297/*
298 * Add a reference creation to transaction. new_sha1 is the value
299 * that the reference should have after the update; it must not be the
300 * null SHA-1. It is verified that the reference does not exist
301 * already.
b416af5b
RS
302 * Function returns 0 on success and non-zero on failure. A failure to create
303 * means that the transaction as a whole has failed and will need to be
304 * rolled back.
caa4046c 305 */
b416af5b
RS
306int ref_transaction_create(struct ref_transaction *transaction,
307 const char *refname,
308 const unsigned char *new_sha1,
309 int flags,
310 struct strbuf *err);
caa4046c
MH
311
312/*
313 * Add a reference deletion to transaction. If have_old is true, then
314 * old_sha1 holds the value that the reference should have had before
315 * the update (which must not be the null SHA-1).
8c8bdc0d
RS
316 * Function returns 0 on success and non-zero on failure. A failure to delete
317 * means that the transaction as a whole has failed and will need to be
318 * rolled back.
caa4046c 319 */
8c8bdc0d
RS
320int ref_transaction_delete(struct ref_transaction *transaction,
321 const char *refname,
322 const unsigned char *old_sha1,
323 int flags, int have_old,
324 struct strbuf *err);
caa4046c
MH
325
326/*
327 * Commit all of the changes that have been queued in transaction, as
328 * atomically as possible. Return a nonzero value if there is a
33f9fc59 329 * problem.
caa4046c
MH
330 */
331int ref_transaction_commit(struct ref_transaction *transaction,
01319837 332 const char *msg, struct strbuf *err);
caa4046c 333
026bd1d3
RS
334/*
335 * Free an existing transaction and all associated data.
336 */
337void ref_transaction_free(struct ref_transaction *transaction);
338
f4124112 339/** Lock a ref and then write its file */
3d9f037c
CR
340int update_ref(const char *action, const char *refname,
341 const unsigned char *sha1, const unsigned char *oldval,
342 int flags, enum action_on_err onerr);
343
daebaa78
JH
344extern int parse_hide_refs_config(const char *var, const char *value, const char *);
345extern int ref_is_hidden(const char *);
346
95fc7512 347#endif /* REFS_H */