]>
Commit | Line | Data |
---|---|---|
95fc7512 DB |
1 | #ifndef REFS_H |
2 | #define REFS_H | |
3 | ||
504c4d42 | 4 | struct object_id; |
077be78d | 5 | struct ref_store; |
504c4d42 NTND |
6 | struct strbuf; |
7 | struct string_list; | |
17eff96b | 8 | struct worktree; |
504c4d42 | 9 | |
fb58c8d5 MH |
10 | /* |
11 | * Resolve a reference, recursively following symbolic refererences. | |
12 | * | |
54fad661 RS |
13 | * Return the name of the non-symbolic reference that ultimately pointed |
14 | * at the resolved object name. The return value, if not NULL, is a | |
15 | * pointer into either a static buffer or the input ref. | |
16 | * | |
49e61479 | 17 | * If oid is non-NULL, store the referred-to object's name in it. |
fb58c8d5 MH |
18 | * |
19 | * If the reference cannot be resolved to an object, the behavior | |
20 | * depends on the RESOLVE_REF_READING flag: | |
21 | * | |
22 | * - If RESOLVE_REF_READING is set, return NULL. | |
23 | * | |
49e61479 | 24 | * - If RESOLVE_REF_READING is not set, clear oid and return the name of |
fb58c8d5 MH |
25 | * the last reference name in the chain, which will either be a non-symbolic |
26 | * reference or an undefined reference. If this is a prelude to | |
27 | * "writing" to the ref, the return value is the name of the ref | |
28 | * that will actually be created or changed. | |
29 | * | |
30 | * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one | |
49e61479 | 31 | * level of symbolic reference. The value stored in oid for a symbolic |
32 | * reference will always be null_oid in this case, and the return | |
fb58c8d5 MH |
33 | * value is the reference that the symref refers to directly. |
34 | * | |
35 | * If flags is non-NULL, set the value that it points to the | |
36 | * combination of REF_ISPACKED (if the reference was found among the | |
37 | * packed references), REF_ISSYMREF (if the initial reference was a | |
38 | * symbolic reference), REF_BAD_NAME (if the reference name is ill | |
39 | * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN | |
40 | * (if the ref is malformed or has a bad name). See refs.h for more detail | |
41 | * on each flag. | |
42 | * | |
43 | * If ref is not a properly-formatted, normalized reference, return | |
44 | * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, | |
45 | * give up and return NULL. | |
46 | * | |
47 | * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their | |
48 | * name is invalid according to git-check-ref-format(1). If the name | |
49e61479 | 49 | * is bad then the value stored in oid will be null_oid and the two |
fb58c8d5 MH |
50 | * flags REF_ISBROKEN and REF_BAD_NAME will be set. |
51 | * | |
52 | * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/ | |
53 | * directory and do not consist of all caps and underscores cannot be | |
54 | * resolved. The function returns NULL for such ref names. | |
55 | * Caps and underscores refers to the special refs, such as HEAD, | |
56 | * FETCH_HEAD and friends, that all live outside of the refs/ directory. | |
57 | */ | |
58 | #define RESOLVE_REF_READING 0x01 | |
59 | #define RESOLVE_REF_NO_RECURSE 0x02 | |
60 | #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 | |
61 | ||
7d2df051 NTND |
62 | const char *refs_resolve_ref_unsafe(struct ref_store *refs, |
63 | const char *refname, | |
64 | int resolve_flags, | |
49e61479 | 65 | struct object_id *oid, |
7d2df051 | 66 | int *flags); |
1354c9b2 | 67 | const char *resolve_ref_unsafe(const char *refname, int resolve_flags, |
49e61479 | 68 | struct object_id *oid, int *flags); |
fb58c8d5 | 69 | |
7d2df051 NTND |
70 | char *refs_resolve_refdup(struct ref_store *refs, |
71 | const char *refname, int resolve_flags, | |
0f2dc722 | 72 | struct object_id *oid, int *flags); |
1354c9b2 | 73 | char *resolve_refdup(const char *refname, int resolve_flags, |
0f2dc722 | 74 | struct object_id *oid, int *flags); |
fb58c8d5 | 75 | |
7d2df051 | 76 | int refs_read_ref_full(struct ref_store *refs, const char *refname, |
34c290a6 | 77 | int resolve_flags, struct object_id *oid, int *flags); |
1354c9b2 | 78 | int read_ref_full(const char *refname, int resolve_flags, |
34c290a6 | 79 | struct object_id *oid, int *flags); |
80 | int read_ref(const char *refname, struct object_id *oid); | |
fb58c8d5 | 81 | |
7d2df051 NTND |
82 | /* |
83 | * Return 0 if a reference named refname could be created without | |
84 | * conflicting with the name of an existing reference. Otherwise, | |
85 | * return a negative value and write an explanation to err. If extras | |
86 | * is non-NULL, it is a list of additional refnames with which refname | |
87 | * is not allowed to conflict. If skip is non-NULL, ignore potential | |
88 | * conflicts with refs in skip (e.g., because they are scheduled for | |
89 | * deletion in the same operation). Behavior is undefined if the same | |
90 | * name is listed in both extras and skip. | |
91 | * | |
92 | * Two reference names conflict if one of them exactly matches the | |
93 | * leading components of the other; e.g., "foo/bar" conflicts with | |
94 | * both "foo" and with "foo/bar/baz" but not with "foo/bar" or | |
95 | * "foo/barbados". | |
96 | * | |
97 | * extras and skip must be sorted. | |
98 | */ | |
99 | ||
100 | int refs_verify_refname_available(struct ref_store *refs, | |
101 | const char *refname, | |
b05855b5 | 102 | const struct string_list *extras, |
7d2df051 NTND |
103 | const struct string_list *skip, |
104 | struct strbuf *err); | |
105 | ||
1354c9b2 | 106 | int ref_exists(const char *refname); |
fb58c8d5 | 107 | |
341fb286 CW |
108 | int should_autocreate_reflog(const char *refname); |
109 | ||
1354c9b2 | 110 | int is_branch(const char *refname); |
fb58c8d5 | 111 | |
6fb5acfd DT |
112 | extern int refs_init_db(struct strbuf *err); |
113 | ||
fb58c8d5 MH |
114 | /* |
115 | * If refname is a non-symbolic reference that refers to a tag object, | |
116 | * and the tag can be (recursively) dereferenced to a non-tag object, | |
b420d909 | 117 | * store the object ID of the referred-to object to oid and return 0. |
118 | * If any of these conditions are not met, return a non-zero value. | |
fb58c8d5 MH |
119 | * Symbolic references are considered unpeelable, even if they |
120 | * ultimately resolve to a peelable tag. | |
121 | */ | |
7d2df051 | 122 | int refs_peel_ref(struct ref_store *refs, const char *refname, |
b420d909 | 123 | struct object_id *oid); |
124 | int peel_ref(const char *refname, struct object_id *oid); | |
fb58c8d5 MH |
125 | |
126 | /** | |
a8355bb7 MH |
127 | * Resolve refname in the nested "gitlink" repository in the specified |
128 | * submodule (which must be non-NULL). If the resolution is | |
78fb4579 | 129 | * successful, return 0 and set oid to the name of the object; |
a8355bb7 | 130 | * otherwise, return a non-zero value. |
fb58c8d5 | 131 | */ |
a8355bb7 | 132 | int resolve_gitlink_ref(const char *submodule, const char *refname, |
a98e6101 | 133 | struct object_id *oid); |
fb58c8d5 MH |
134 | |
135 | /* | |
136 | * Return true iff abbrev_name is a possible abbreviation for | |
137 | * full_name according to the rules defined by ref_rev_parse_rules in | |
138 | * refs.c. | |
139 | */ | |
1354c9b2 | 140 | int refname_match(const char *abbrev_name, const char *full_name); |
fb58c8d5 | 141 | |
cca5fa64 | 142 | int expand_ref(const char *str, int len, struct object_id *oid, char **ref); |
143 | int dwim_ref(const char *str, int len, struct object_id *oid, char **ref); | |
334dc52f | 144 | int dwim_log(const char *str, int len, struct object_id *oid, char **ref); |
fb58c8d5 | 145 | |
b416af5b | 146 | /* |
30173b88 MH |
147 | * A ref_transaction represents a collection of reference updates that |
148 | * should succeed or fail together. | |
b416af5b RS |
149 | * |
150 | * Calling sequence | |
151 | * ---------------- | |
30173b88 | 152 | * |
b416af5b RS |
153 | * - Allocate and initialize a `struct ref_transaction` by calling |
154 | * `ref_transaction_begin()`. | |
155 | * | |
30173b88 MH |
156 | * - Specify the intended ref updates by calling one or more of the |
157 | * following functions: | |
158 | * - `ref_transaction_update()` | |
159 | * - `ref_transaction_create()` | |
160 | * - `ref_transaction_delete()` | |
161 | * - `ref_transaction_verify()` | |
162 | * | |
163 | * - Then either: | |
164 | * | |
165 | * - Optionally call `ref_transaction_prepare()` to prepare the | |
166 | * transaction. This locks all references, checks preconditions, | |
167 | * etc. but doesn't finalize anything. If this step fails, the | |
168 | * transaction has been closed and can only be freed. If this step | |
169 | * succeeds, then `ref_transaction_commit()` is almost certain to | |
170 | * succeed. However, you can still call `ref_transaction_abort()` | |
171 | * if you decide not to commit the transaction after all. | |
172 | * | |
173 | * - Call `ref_transaction_commit()` to execute the transaction, | |
174 | * make the changes permanent, and release all locks. If you | |
175 | * haven't already called `ref_transaction_prepare()`, then | |
176 | * `ref_transaction_commit()` calls it for you. | |
177 | * | |
178 | * Or | |
179 | * | |
180 | * - Call `initial_ref_transaction_commit()` if the ref database is | |
181 | * known to be empty and have no other writers (e.g. during | |
182 | * clone). This is likely to be much faster than | |
183 | * `ref_transaction_commit()`. `ref_transaction_prepare()` should | |
184 | * *not* be called before `initial_ref_transaction_commit()`. | |
185 | * | |
186 | * - Then finally, call `ref_transaction_free()` to free the | |
187 | * `ref_transaction` data structure. | |
188 | * | |
189 | * At any time before calling `ref_transaction_commit()`, you can call | |
190 | * `ref_transaction_abort()` to abort the transaction, rollback any | |
191 | * locks, and free any associated resources (including the | |
192 | * `ref_transaction` data structure). | |
193 | * | |
194 | * Putting it all together, a complete reference update looks like | |
195 | * | |
196 | * struct ref_transaction *transaction; | |
197 | * struct strbuf err = STRBUF_INIT; | |
198 | * int ret = 0; | |
199 | * | |
200 | * transaction = ref_store_transaction_begin(refs, &err); | |
201 | * if (!transaction || | |
202 | * ref_transaction_update(...) || | |
203 | * ref_transaction_create(...) || | |
204 | * ...etc... || | |
205 | * ref_transaction_commit(transaction, &err)) { | |
206 | * error("%s", err.buf); | |
207 | * ret = -1; | |
208 | * } | |
209 | * ref_transaction_free(transaction); | |
210 | * strbuf_release(&err); | |
211 | * return ret; | |
b416af5b RS |
212 | * |
213 | * Error handling | |
214 | * -------------- | |
215 | * | |
216 | * On error, transaction functions append a message about what | |
217 | * went wrong to the 'err' argument. The message mentions what | |
218 | * ref was being updated (if any) when the error occurred so it | |
219 | * can be passed to 'die' or 'error' as-is. | |
220 | * | |
221 | * The message is appended to err without first clearing err. | |
222 | * err will not be '\n' terminated. | |
49386868 DT |
223 | * |
224 | * Caveats | |
225 | * ------- | |
226 | * | |
227 | * Note that no locks are taken, and no refs are read, until | |
30173b88 MH |
228 | * `ref_transaction_prepare()` or `ref_transaction_commit()` is |
229 | * called. So, for example, `ref_transaction_verify()` won't report a | |
230 | * verification failure until the commit is attempted. | |
b416af5b | 231 | */ |
caa4046c MH |
232 | struct ref_transaction; |
233 | ||
89df9c84 | 234 | /* |
3bc581b9 MH |
235 | * Bit values set in the flags argument passed to each_ref_fn() and |
236 | * stored in ref_iterator::flags. Other bits are for internal use | |
237 | * only: | |
89df9c84 MH |
238 | */ |
239 | ||
240 | /* Reference is a symbolic reference. */ | |
98ac34b2 | 241 | #define REF_ISSYMREF 0x01 |
89df9c84 MH |
242 | |
243 | /* Reference is a packed reference. */ | |
98ac34b2 | 244 | #define REF_ISPACKED 0x02 |
89df9c84 MH |
245 | |
246 | /* | |
247 | * Reference cannot be resolved to an object name: dangling symbolic | |
d0f810f0 RS |
248 | * reference (directly or indirectly), corrupt reference file, |
249 | * reference exists but name is bad, or symbolic reference refers to | |
250 | * ill-formatted reference name. | |
89df9c84 | 251 | */ |
98ac34b2 | 252 | #define REF_ISBROKEN 0x04 |
f4204ab9 | 253 | |
d0f810f0 RS |
254 | /* |
255 | * Reference name is not well formed. | |
256 | * | |
257 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
258 | */ | |
259 | #define REF_BAD_NAME 0x08 | |
260 | ||
8a65ff76 | 261 | /* |
4f78c24c | 262 | * The signature for the callback function for the for_each_*() |
78fb4579 | 263 | * functions below. The memory pointed to by the refname and oid |
4f78c24c MH |
264 | * arguments is only guaranteed to be valid for the duration of a |
265 | * single callback invocation. | |
266 | */ | |
267 | typedef int each_ref_fn(const char *refname, | |
2b2a5be3 MH |
268 | const struct object_id *oid, int flags, void *cb_data); |
269 | ||
4f78c24c MH |
270 | /* |
271 | * The following functions invoke the specified callback function for | |
272 | * each reference indicated. If the function ever returns a nonzero | |
273 | * value, stop the iteration and return that value. Please note that | |
274 | * it is not safe to modify references while an iteration is in | |
275 | * progress, unless the same callback function invocation that | |
276 | * modifies the reference also returns a nonzero value to immediately | |
adac8115 | 277 | * stop the iteration. Returned references are sorted. |
8a65ff76 | 278 | */ |
62f0b399 NTND |
279 | int refs_head_ref(struct ref_store *refs, |
280 | each_ref_fn fn, void *cb_data); | |
7d2df051 NTND |
281 | int refs_for_each_ref(struct ref_store *refs, |
282 | each_ref_fn fn, void *cb_data); | |
283 | int refs_for_each_ref_in(struct ref_store *refs, const char *prefix, | |
284 | each_ref_fn fn, void *cb_data); | |
285 | int refs_for_each_tag_ref(struct ref_store *refs, | |
286 | each_ref_fn fn, void *cb_data); | |
287 | int refs_for_each_branch_ref(struct ref_store *refs, | |
288 | each_ref_fn fn, void *cb_data); | |
289 | int refs_for_each_remote_ref(struct ref_store *refs, | |
290 | each_ref_fn fn, void *cb_data); | |
291 | ||
1354c9b2 MH |
292 | int head_ref(each_ref_fn fn, void *cb_data); |
293 | int for_each_ref(each_ref_fn fn, void *cb_data); | |
294 | int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data); | |
073cf63c NTND |
295 | int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix, |
296 | each_ref_fn fn, void *cb_data, | |
297 | unsigned int broken); | |
1354c9b2 MH |
298 | int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, |
299 | unsigned int broken); | |
300 | int for_each_tag_ref(each_ref_fn fn, void *cb_data); | |
301 | int for_each_branch_ref(each_ref_fn fn, void *cb_data); | |
302 | int for_each_remote_ref(each_ref_fn fn, void *cb_data); | |
60ce76d3 SB |
303 | #define for_each_replace_ref(r, fn, cb) \ |
304 | for_each_replace_ref_##r(fn, cb) | |
305 | int for_each_replace_ref_the_repository(each_ref_fn fn, void *cb_data); | |
1354c9b2 MH |
306 | int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data); |
307 | int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, | |
308 | const char *prefix, void *cb_data); | |
309 | ||
1354c9b2 MH |
310 | int head_ref_namespaced(each_ref_fn fn, void *cb_data); |
311 | int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
a1bea2c1 | 312 | |
fb58c8d5 | 313 | /* can be used to learn about broken ref and symref */ |
7d2df051 | 314 | int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 315 | int for_each_rawref(each_ref_fn fn, void *cb_data); |
fb58c8d5 | 316 | |
65516f58 RA |
317 | /* |
318 | * Normalizes partial refs to their fully qualified form. | |
319 | * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'. | |
320 | * <prefix> will default to 'refs/' if NULL. | |
321 | * | |
322 | * item.string will be set to the result. | |
323 | * item.util will be set to NULL if <pattern> contains glob characters, or | |
324 | * non-NULL if it doesn't. | |
325 | */ | |
326 | void normalize_glob_ref(struct string_list_item *item, const char *prefix, | |
327 | const char *pattern); | |
328 | ||
329 | /* | |
330 | * Returns 0 if refname matches any of the exclude_patterns, or if it doesn't | |
331 | * match any of the include_patterns. Returns 1 otherwise. | |
332 | * | |
333 | * If pattern list is NULL or empty, matching against that list is skipped. | |
334 | * This has the effect of matching everything by default, unless the user | |
335 | * specifies rules otherwise. | |
336 | */ | |
337 | int ref_filter_match(const char *refname, | |
338 | const struct string_list *include_patterns, | |
339 | const struct string_list *exclude_patterns); | |
340 | ||
894a9d33 TR |
341 | static inline const char *has_glob_specials(const char *pattern) |
342 | { | |
343 | return strpbrk(pattern, "?*["); | |
344 | } | |
345 | ||
1354c9b2 MH |
346 | void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); |
347 | void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, | |
348 | const struct string_list *refnames); | |
f8948e2f | 349 | |
32d462ce MH |
350 | /* |
351 | * Flags for controlling behaviour of pack_refs() | |
352 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
353 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
354 | */ | |
355 | #define PACK_REFS_PRUNE 0x0001 | |
356 | #define PACK_REFS_ALL 0x0002 | |
357 | ||
358 | /* | |
359 | * Write a packed-refs file for the current repository. | |
360 | * flags: Combination of the above PACK_REFS_* flags. | |
361 | */ | |
7d2df051 | 362 | int refs_pack_refs(struct ref_store *refs, unsigned int flags); |
32d462ce | 363 | |
bd3b02da | 364 | /* |
a4c653df | 365 | * Setup reflog before using. Fill in err and return -1 on failure. |
bd3b02da | 366 | */ |
7d2df051 NTND |
367 | int refs_create_reflog(struct ref_store *refs, const char *refname, |
368 | int force_create, struct strbuf *err); | |
abd0cd3a | 369 | int safe_create_reflog(const char *refname, int force_create, struct strbuf *err); |
859c3017 | 370 | |
d556fae2 | 371 | /** Reads log for the value of ref during at_time. **/ |
1354c9b2 | 372 | int read_ref_at(const char *refname, unsigned int flags, |
dddbad72 | 373 | timestamp_t at_time, int cnt, |
8eb36d94 | 374 | struct object_id *oid, char **msg, |
dddbad72 | 375 | timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt); |
d556fae2 | 376 | |
4da58835 | 377 | /** Check if a particular reflog exists */ |
7d2df051 | 378 | int refs_reflog_exists(struct ref_store *refs, const char *refname); |
1354c9b2 | 379 | int reflog_exists(const char *refname); |
4da58835 | 380 | |
fc1c2168 | 381 | /* |
2616a5e5 | 382 | * Delete the specified reference. If old_oid is non-NULL, then |
78fb4579 | 383 | * verify that the current value of the reference is old_oid before |
2616a5e5 | 384 | * deleting it. If old_oid is NULL, delete the reference if it |
385 | * exists, regardless of its old value. It is an error for old_oid to | |
386 | * be null_oid. msg and flags are passed through to | |
64da4199 | 387 | * ref_transaction_delete(). |
fc1c2168 | 388 | */ |
c0fe4e8b NTND |
389 | int refs_delete_ref(struct ref_store *refs, const char *msg, |
390 | const char *refname, | |
2616a5e5 | 391 | const struct object_id *old_oid, |
c0fe4e8b | 392 | unsigned int flags); |
755b49ae | 393 | int delete_ref(const char *msg, const char *refname, |
2616a5e5 | 394 | const struct object_id *old_oid, unsigned int flags); |
fc1c2168 | 395 | |
98ffd5ff MH |
396 | /* |
397 | * Delete the specified references. If there are any problems, emit | |
398 | * errors but attempt to keep going (i.e., the deletes are not done in | |
64da4199 | 399 | * an all-or-nothing transaction). msg and flags are passed through to |
c5f04ddd | 400 | * ref_transaction_delete(). |
98ffd5ff | 401 | */ |
64da4199 MH |
402 | int refs_delete_refs(struct ref_store *refs, const char *msg, |
403 | struct string_list *refnames, unsigned int flags); | |
404 | int delete_refs(const char *msg, struct string_list *refnames, | |
405 | unsigned int flags); | |
98ffd5ff | 406 | |
4da58835 | 407 | /** Delete a reflog */ |
7d2df051 | 408 | int refs_delete_reflog(struct ref_store *refs, const char *refname); |
1354c9b2 | 409 | int delete_reflog(const char *refname); |
4da58835 | 410 | |
2ff81662 | 411 | /* iterate over reflog entries */ |
1354c9b2 | 412 | typedef int each_reflog_ent_fn( |
9461d272 | 413 | struct object_id *old_oid, struct object_id *new_oid, |
dddbad72 | 414 | const char *committer, timestamp_t timestamp, |
1354c9b2 MH |
415 | int tz, const char *msg, void *cb_data); |
416 | ||
7d2df051 NTND |
417 | int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname, |
418 | each_reflog_ent_fn fn, void *cb_data); | |
419 | int refs_for_each_reflog_ent_reverse(struct ref_store *refs, | |
420 | const char *refname, | |
421 | each_reflog_ent_fn fn, | |
422 | void *cb_data); | |
dfefa935 | 423 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
98f85ff4 | 424 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
2ff81662 | 425 | |
eb8381c8 NP |
426 | /* |
427 | * Calls the specified function for each reflog file until it returns nonzero, | |
adac8115 | 428 | * and returns the value. Reflog file order is unspecified. |
eb8381c8 | 429 | */ |
7d2df051 | 430 | int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 431 | int for_each_reflog(each_ref_fn fn, void *cb_data); |
eb8381c8 | 432 | |
8d9c5010 MH |
433 | #define REFNAME_ALLOW_ONELEVEL 1 |
434 | #define REFNAME_REFSPEC_PATTERN 2 | |
435 | ||
436 | /* | |
dfefa935 MH |
437 | * Return 0 iff refname has the correct format for a refname according |
438 | * to the rules described in Documentation/git-check-ref-format.txt. | |
439 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
8d9c5010 | 440 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then |
cd377f45 JK |
441 | * allow a single "*" wildcard character in the refspec. No leading or |
442 | * repeated slashes are accepted. | |
8d9c5010 | 443 | */ |
1354c9b2 | 444 | int check_refname_format(const char *refname, int flags); |
95fc7512 | 445 | |
1354c9b2 | 446 | const char *prettify_refname(const char *refname); |
fb58c8d5 | 447 | |
1354c9b2 | 448 | char *shorten_unambiguous_ref(const char *refname, int strict); |
a9c37a72 | 449 | |
c976d415 | 450 | /** rename ref, return 0 on success **/ |
7d2df051 NTND |
451 | int refs_rename_ref(struct ref_store *refs, const char *oldref, |
452 | const char *newref, const char *logmsg); | |
52d59cc6 SD |
453 | int rename_ref(const char *oldref, const char *newref, |
454 | const char *logmsg); | |
455 | ||
456 | /** copy ref, return 0 on success **/ | |
457 | int refs_copy_existing_ref(struct ref_store *refs, const char *oldref, | |
458 | const char *newref, const char *logmsg); | |
459 | int copy_existing_ref(const char *oldref, const char *newref, | |
460 | const char *logmsg); | |
c976d415 | 461 | |
7d2df051 NTND |
462 | int refs_create_symref(struct ref_store *refs, const char *refname, |
463 | const char *target, const char *logmsg); | |
1354c9b2 | 464 | int create_symref(const char *refname, const char *target, const char *logmsg); |
0ebde32c | 465 | |
f4124112 MH |
466 | enum action_on_err { |
467 | UPDATE_REFS_MSG_ON_ERR, | |
468 | UPDATE_REFS_DIE_ON_ERR, | |
469 | UPDATE_REFS_QUIET_ON_ERR | |
470 | }; | |
471 | ||
caa4046c MH |
472 | /* |
473 | * Begin a reference transaction. The reference transaction must | |
33f9fc59 | 474 | * be freed by calling ref_transaction_free(). |
caa4046c | 475 | */ |
c0fe4e8b NTND |
476 | struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs, |
477 | struct strbuf *err); | |
93a644ea | 478 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); |
caa4046c | 479 | |
caa4046c | 480 | /* |
d1dd721f MH |
481 | * Reference transaction updates |
482 | * | |
483 | * The following four functions add a reference check or update to a | |
484 | * ref_transaction. They have some common similar parameters: | |
485 | * | |
486 | * transaction -- a pointer to an open ref_transaction, obtained | |
487 | * from ref_transaction_begin(). | |
488 | * | |
489 | * refname -- the name of the reference to be affected. | |
490 | * | |
5ac95fee MH |
491 | * new_oid -- the object ID that should be set to be the new value |
492 | * of the reference. Some functions allow this parameter to be | |
fd2ce9c0 | 493 | * NULL, meaning that the reference is not changed, or |
5ac95fee | 494 | * null_oid, meaning that the reference should be deleted. A |
fd2ce9c0 MH |
495 | * copy of this value is made in the transaction. |
496 | * | |
5ac95fee | 497 | * old_oid -- the object ID that the reference must have before |
fd2ce9c0 MH |
498 | * the update. Some functions allow this parameter to be NULL, |
499 | * meaning that the old value of the reference is not checked, | |
5ac95fee | 500 | * or null_oid, meaning that the reference must not exist |
fd2ce9c0 MH |
501 | * before the update. A copy of this value is made in the |
502 | * transaction. | |
503 | * | |
d1dd721f | 504 | * flags -- flags affecting the update, passed to |
91774afc | 505 | * update_ref_lock(). Possible flags: REF_NO_DEREF, |
5ac95fee MH |
506 | * REF_FORCE_CREATE_REFLOG. See those constants for more |
507 | * information. | |
d1dd721f MH |
508 | * |
509 | * msg -- a message describing the change (for the reflog). | |
510 | * | |
511 | * err -- a strbuf for receiving a description of any error that | |
dc72b500 | 512 | * might have occurred. |
d1dd721f MH |
513 | * |
514 | * The functions make internal copies of refname and msg, so the | |
515 | * caller retains ownership of these parameters. | |
516 | * | |
517 | * The functions return 0 on success and non-zero on failure. A | |
518 | * failure means that the transaction as a whole has failed and needs | |
519 | * to be rolled back. | |
caa4046c MH |
520 | */ |
521 | ||
caa4046c | 522 | /* |
5ac95fee MH |
523 | * The following flags can be passed to ref_transaction_update() etc. |
524 | * Internally, they are stored in `ref_update::flags`, along with some | |
525 | * internal flags. | |
526 | */ | |
527 | ||
528 | /* | |
529 | * Act on the ref directly; i.e., without dereferencing symbolic refs. | |
530 | * If this flag is not specified, then symbolic references are | |
531 | * dereferenced and the update is applied to the referent. | |
532 | */ | |
91774afc | 533 | #define REF_NO_DEREF (1 << 0) |
5ac95fee MH |
534 | |
535 | /* | |
536 | * Force the creation of a reflog for this reference, even if it | |
537 | * didn't previously have a reflog. | |
538 | */ | |
539 | #define REF_FORCE_CREATE_REFLOG (1 << 1) | |
540 | ||
541 | /* | |
542 | * Bitmask of all of the flags that are allowed to be passed in to | |
543 | * ref_transaction_update() and friends: | |
544 | */ | |
545 | #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \ | |
91774afc | 546 | (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG) |
5ac95fee MH |
547 | |
548 | /* | |
549 | * Add a reference update to transaction. `new_oid` is the value that | |
550 | * the reference should have after the update, or `null_oid` if it | |
551 | * should be deleted. If `new_oid` is NULL, then the reference is not | |
552 | * changed at all. `old_oid` is the value that the reference must have | |
553 | * before the update, or `null_oid` if it must not have existed | |
16180334 | 554 | * beforehand. The old value is checked after the lock is taken to |
89f3bbdd | 555 | * prevent races. If the old value doesn't agree with old_oid, the |
556 | * whole transaction fails. If old_oid is NULL, then the previous | |
16180334 MH |
557 | * value is not checked. |
558 | * | |
d1dd721f MH |
559 | * See the above comment "Reference transaction updates" for more |
560 | * information. | |
caa4046c | 561 | */ |
8e34800e RS |
562 | int ref_transaction_update(struct ref_transaction *transaction, |
563 | const char *refname, | |
89f3bbdd | 564 | const struct object_id *new_oid, |
565 | const struct object_id *old_oid, | |
1d147bdf | 566 | unsigned int flags, const char *msg, |
8e34800e | 567 | struct strbuf *err); |
caa4046c MH |
568 | |
569 | /* | |
89f3bbdd | 570 | * Add a reference creation to transaction. new_oid is the value that |
d1dd721f | 571 | * the reference should have after the update; it must not be |
89f3bbdd | 572 | * null_oid. It is verified that the reference does not exist |
caa4046c | 573 | * already. |
d1dd721f MH |
574 | * |
575 | * See the above comment "Reference transaction updates" for more | |
576 | * information. | |
caa4046c | 577 | */ |
b416af5b RS |
578 | int ref_transaction_create(struct ref_transaction *transaction, |
579 | const char *refname, | |
89f3bbdd | 580 | const struct object_id *new_oid, |
fec14ec3 | 581 | unsigned int flags, const char *msg, |
b416af5b | 582 | struct strbuf *err); |
caa4046c MH |
583 | |
584 | /* | |
89f3bbdd | 585 | * Add a reference deletion to transaction. If old_oid is non-NULL, |
d1dd721f | 586 | * then it holds the value that the reference should have had before |
89f3bbdd | 587 | * the update (which must not be null_oid). |
d1dd721f MH |
588 | * |
589 | * See the above comment "Reference transaction updates" for more | |
590 | * information. | |
caa4046c | 591 | */ |
8c8bdc0d RS |
592 | int ref_transaction_delete(struct ref_transaction *transaction, |
593 | const char *refname, | |
89f3bbdd | 594 | const struct object_id *old_oid, |
fb5a6bb6 | 595 | unsigned int flags, const char *msg, |
8c8bdc0d | 596 | struct strbuf *err); |
caa4046c | 597 | |
16180334 | 598 | /* |
89f3bbdd | 599 | * Verify, within a transaction, that refname has the value old_oid, |
600 | * or, if old_oid is null_oid, then verify that the reference | |
601 | * doesn't exist. old_oid must be non-NULL. | |
d1dd721f MH |
602 | * |
603 | * See the above comment "Reference transaction updates" for more | |
604 | * information. | |
16180334 MH |
605 | */ |
606 | int ref_transaction_verify(struct ref_transaction *transaction, | |
607 | const char *refname, | |
89f3bbdd | 608 | const struct object_id *old_oid, |
16180334 MH |
609 | unsigned int flags, |
610 | struct strbuf *err); | |
611 | ||
28e6a97e RS |
612 | /* Naming conflict (for example, the ref names A and A/B conflict). */ |
613 | #define TRANSACTION_NAME_CONFLICT -1 | |
614 | /* All other errors. */ | |
615 | #define TRANSACTION_GENERIC_ERROR -2 | |
30173b88 MH |
616 | |
617 | /* | |
64127575 | 618 | * Perform the preparatory stages of committing `transaction`. Acquire |
30173b88 MH |
619 | * any needed locks, check preconditions, etc.; basically, do as much |
620 | * as possible to ensure that the transaction will be able to go | |
621 | * through, stopping just short of making any irrevocable or | |
622 | * user-visible changes. The updates that this function prepares can | |
623 | * be finished up by calling `ref_transaction_commit()` or rolled back | |
624 | * by calling `ref_transaction_abort()`. | |
625 | * | |
626 | * On success, return 0 and leave the transaction in "prepared" state. | |
627 | * On failure, abort the transaction, write an error message to `err`, | |
628 | * and return one of the `TRANSACTION_*` constants. | |
629 | * | |
64127575 | 630 | * Callers who don't need such fine-grained control over committing |
30173b88 MH |
631 | * reference transactions should just call `ref_transaction_commit()`. |
632 | */ | |
633 | int ref_transaction_prepare(struct ref_transaction *transaction, | |
634 | struct strbuf *err); | |
635 | ||
636 | /* | |
637 | * Commit all of the changes that have been queued in transaction, as | |
638 | * atomically as possible. On success, return 0 and leave the | |
639 | * transaction in "closed" state. On failure, roll back the | |
640 | * transaction, write an error message to `err`, and return one of the | |
641 | * `TRANSACTION_*` constants | |
642 | */ | |
caa4046c | 643 | int ref_transaction_commit(struct ref_transaction *transaction, |
db7516ab | 644 | struct strbuf *err); |
caa4046c | 645 | |
30173b88 MH |
646 | /* |
647 | * Abort `transaction`, which has been begun and possibly prepared, | |
648 | * but not yet committed. | |
649 | */ | |
650 | int ref_transaction_abort(struct ref_transaction *transaction, | |
651 | struct strbuf *err); | |
652 | ||
58f233ce MH |
653 | /* |
654 | * Like ref_transaction_commit(), but optimized for creating | |
655 | * references when originally initializing a repository (e.g., by "git | |
656 | * clone"). It writes the new references directly to packed-refs | |
657 | * without locking the individual references. | |
658 | * | |
659 | * It is a bug to call this function when there might be other | |
660 | * processes accessing the repository or if there are existing | |
661 | * references that might conflict with the ones being created. All | |
78fb4579 | 662 | * old_oid values must either be absent or null_oid. |
58f233ce MH |
663 | */ |
664 | int initial_ref_transaction_commit(struct ref_transaction *transaction, | |
665 | struct strbuf *err); | |
666 | ||
026bd1d3 | 667 | /* |
30173b88 | 668 | * Free `*transaction` and all associated data. |
026bd1d3 RS |
669 | */ |
670 | void ref_transaction_free(struct ref_transaction *transaction); | |
671 | ||
4b7b520b MH |
672 | /** |
673 | * Lock, update, and unlock a single reference. This function | |
674 | * basically does a transaction containing a single call to | |
675 | * ref_transaction_update(). The parameters to this function have the | |
676 | * same meaning as the corresponding parameters to | |
677 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
678 | * argument. | |
679 | */ | |
c0fe4e8b | 680 | int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname, |
ae077771 | 681 | const struct object_id *new_oid, const struct object_id *old_oid, |
c0fe4e8b | 682 | unsigned int flags, enum action_on_err onerr); |
4b7b520b | 683 | int update_ref(const char *msg, const char *refname, |
8f6dc7e3 | 684 | const struct object_id *new_oid, const struct object_id *old_oid, |
685 | unsigned int flags, enum action_on_err onerr); | |
3d9f037c | 686 | |
1354c9b2 | 687 | int parse_hide_refs_config(const char *var, const char *value, const char *); |
fb58c8d5 | 688 | |
78a766ab LF |
689 | /* |
690 | * Check whether a ref is hidden. If no namespace is set, both the first and | |
691 | * the second parameter point to the full ref name. If a namespace is set and | |
692 | * the ref is inside that namespace, the first parameter is a pointer to the | |
693 | * name of the ref with the namespace prefix removed. If a namespace is set and | |
694 | * the ref is outside that namespace, the first parameter is NULL. The second | |
695 | * parameter always points to the full ref name. | |
696 | */ | |
1354c9b2 | 697 | int ref_is_hidden(const char *, const char *); |
daebaa78 | 698 | |
266b1827 DT |
699 | enum ref_type { |
700 | REF_TYPE_PER_WORKTREE, | |
701 | REF_TYPE_PSEUDOREF, | |
702 | REF_TYPE_NORMAL, | |
703 | }; | |
704 | ||
705 | enum ref_type ref_type(const char *refname); | |
706 | ||
fa5b1830 MH |
707 | enum expire_reflog_flags { |
708 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
709 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
710 | EXPIRE_REFLOGS_VERBOSE = 1 << 2, | |
711 | EXPIRE_REFLOGS_REWRITE = 1 << 3 | |
712 | }; | |
713 | ||
714 | /* | |
715 | * The following interface is used for reflog expiration. The caller | |
716 | * calls reflog_expire(), supplying it with three callback functions, | |
717 | * of the following types. The callback functions define the | |
718 | * expiration policy that is desired. | |
719 | * | |
720 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
721 | * locked. | |
722 | * | |
723 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
724 | * existing reflog. It should return true iff that entry should be | |
725 | * pruned. | |
726 | * | |
727 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
728 | * unlocked again. | |
729 | */ | |
730 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
4322478a | 731 | const struct object_id *oid, |
fa5b1830 | 732 | void *cb_data); |
4322478a | 733 | typedef int reflog_expiry_should_prune_fn(struct object_id *ooid, |
734 | struct object_id *noid, | |
fa5b1830 | 735 | const char *email, |
dddbad72 | 736 | timestamp_t timestamp, int tz, |
fa5b1830 MH |
737 | const char *message, void *cb_data); |
738 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
739 | ||
740 | /* | |
0155f710 | 741 | * Expire reflog entries for the specified reference. oid is the old |
fa5b1830 MH |
742 | * value of the reference. flags is a combination of the constants in |
743 | * enum expire_reflog_flags. The three function pointers are described | |
744 | * above. On success, return zero. | |
745 | */ | |
7d2df051 NTND |
746 | int refs_reflog_expire(struct ref_store *refs, |
747 | const char *refname, | |
0155f710 | 748 | const struct object_id *oid, |
7d2df051 NTND |
749 | unsigned int flags, |
750 | reflog_expiry_prepare_fn prepare_fn, | |
751 | reflog_expiry_should_prune_fn should_prune_fn, | |
752 | reflog_expiry_cleanup_fn cleanup_fn, | |
753 | void *policy_cb_data); | |
0155f710 | 754 | int reflog_expire(const char *refname, const struct object_id *oid, |
1354c9b2 MH |
755 | unsigned int flags, |
756 | reflog_expiry_prepare_fn prepare_fn, | |
757 | reflog_expiry_should_prune_fn should_prune_fn, | |
758 | reflog_expiry_cleanup_fn cleanup_fn, | |
759 | void *policy_cb_data); | |
fa5b1830 | 760 | |
3dce444f RS |
761 | int ref_storage_backend_exists(const char *name); |
762 | ||
23a3f0cb SB |
763 | #define get_main_ref_store(r) \ |
764 | get_main_ref_store_##r() | |
765 | struct ref_store *get_main_ref_store_the_repository(void); | |
18d0002d NTND |
766 | /* |
767 | * Return the ref_store instance for the specified submodule. For the | |
768 | * main repository, use submodule==NULL; such a call cannot fail. For | |
769 | * a submodule, the submodule must exist and be a nonbare repository, | |
770 | * otherwise return NULL. If the requested reference store has not yet | |
771 | * been initialized, initialize it first. | |
772 | * | |
773 | * For backwards compatibility, submodule=="" is treated the same as | |
774 | * submodule==NULL. | |
775 | */ | |
776 | struct ref_store *get_submodule_ref_store(const char *submodule); | |
17eff96b | 777 | struct ref_store *get_worktree_ref_store(const struct worktree *wt); |
077be78d | 778 | |
95fc7512 | 779 | #endif /* REFS_H */ |