]>
Commit | Line | Data |
---|---|---|
95fc7512 DB |
1 | #ifndef REFS_H |
2 | #define REFS_H | |
3 | ||
ec06b055 | 4 | #include "cache.h" |
b9342b3f | 5 | #include "commit.h" |
ec06b055 | 6 | |
504c4d42 | 7 | struct object_id; |
077be78d | 8 | struct ref_store; |
ef3ca954 | 9 | struct repository; |
504c4d42 NTND |
10 | struct strbuf; |
11 | struct string_list; | |
ef3ca954 | 12 | struct string_list_item; |
17eff96b | 13 | struct worktree; |
504c4d42 | 14 | |
fb58c8d5 MH |
15 | /* |
16 | * Resolve a reference, recursively following symbolic refererences. | |
17 | * | |
54fad661 RS |
18 | * Return the name of the non-symbolic reference that ultimately pointed |
19 | * at the resolved object name. The return value, if not NULL, is a | |
20 | * pointer into either a static buffer or the input ref. | |
21 | * | |
49e61479 | 22 | * If oid is non-NULL, store the referred-to object's name in it. |
fb58c8d5 MH |
23 | * |
24 | * If the reference cannot be resolved to an object, the behavior | |
25 | * depends on the RESOLVE_REF_READING flag: | |
26 | * | |
27 | * - If RESOLVE_REF_READING is set, return NULL. | |
28 | * | |
49e61479 | 29 | * - If RESOLVE_REF_READING is not set, clear oid and return the name of |
fb58c8d5 MH |
30 | * the last reference name in the chain, which will either be a non-symbolic |
31 | * reference or an undefined reference. If this is a prelude to | |
32 | * "writing" to the ref, the return value is the name of the ref | |
33 | * that will actually be created or changed. | |
34 | * | |
35 | * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one | |
49e61479 | 36 | * level of symbolic reference. The value stored in oid for a symbolic |
37 | * reference will always be null_oid in this case, and the return | |
fb58c8d5 MH |
38 | * value is the reference that the symref refers to directly. |
39 | * | |
40 | * If flags is non-NULL, set the value that it points to the | |
41 | * combination of REF_ISPACKED (if the reference was found among the | |
42 | * packed references), REF_ISSYMREF (if the initial reference was a | |
43 | * symbolic reference), REF_BAD_NAME (if the reference name is ill | |
44 | * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN | |
45 | * (if the ref is malformed or has a bad name). See refs.h for more detail | |
46 | * on each flag. | |
47 | * | |
48 | * If ref is not a properly-formatted, normalized reference, return | |
49 | * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, | |
50 | * give up and return NULL. | |
51 | * | |
52 | * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their | |
53 | * name is invalid according to git-check-ref-format(1). If the name | |
49e61479 | 54 | * is bad then the value stored in oid will be null_oid and the two |
fb58c8d5 MH |
55 | * flags REF_ISBROKEN and REF_BAD_NAME will be set. |
56 | * | |
57 | * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/ | |
58 | * directory and do not consist of all caps and underscores cannot be | |
59 | * resolved. The function returns NULL for such ref names. | |
60 | * Caps and underscores refers to the special refs, such as HEAD, | |
61 | * FETCH_HEAD and friends, that all live outside of the refs/ directory. | |
62 | */ | |
63 | #define RESOLVE_REF_READING 0x01 | |
64 | #define RESOLVE_REF_NO_RECURSE 0x02 | |
65 | #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 | |
66 | ||
7d2df051 NTND |
67 | const char *refs_resolve_ref_unsafe(struct ref_store *refs, |
68 | const char *refname, | |
69 | int resolve_flags, | |
49e61479 | 70 | struct object_id *oid, |
ce14de03 | 71 | int *flags); |
25a33b33 | 72 | |
1354c9b2 | 73 | const char *resolve_ref_unsafe(const char *refname, int resolve_flags, |
49e61479 | 74 | struct object_id *oid, int *flags); |
fb58c8d5 | 75 | |
7d2df051 NTND |
76 | char *refs_resolve_refdup(struct ref_store *refs, |
77 | const char *refname, int resolve_flags, | |
0f2dc722 | 78 | struct object_id *oid, int *flags); |
1354c9b2 | 79 | char *resolve_refdup(const char *refname, int resolve_flags, |
0f2dc722 | 80 | struct object_id *oid, int *flags); |
fb58c8d5 | 81 | |
1354c9b2 | 82 | int read_ref_full(const char *refname, int resolve_flags, |
34c290a6 | 83 | struct object_id *oid, int *flags); |
84 | int read_ref(const char *refname, struct object_id *oid); | |
fb58c8d5 | 85 | |
cd475b3b PS |
86 | int refs_read_symbolic_ref(struct ref_store *ref_store, const char *refname, |
87 | struct strbuf *referent); | |
88 | ||
7d2df051 NTND |
89 | /* |
90 | * Return 0 if a reference named refname could be created without | |
91 | * conflicting with the name of an existing reference. Otherwise, | |
92 | * return a negative value and write an explanation to err. If extras | |
93 | * is non-NULL, it is a list of additional refnames with which refname | |
94 | * is not allowed to conflict. If skip is non-NULL, ignore potential | |
95 | * conflicts with refs in skip (e.g., because they are scheduled for | |
96 | * deletion in the same operation). Behavior is undefined if the same | |
97 | * name is listed in both extras and skip. | |
98 | * | |
99 | * Two reference names conflict if one of them exactly matches the | |
100 | * leading components of the other; e.g., "foo/bar" conflicts with | |
101 | * both "foo" and with "foo/bar/baz" but not with "foo/bar" or | |
102 | * "foo/barbados". | |
103 | * | |
104 | * extras and skip must be sorted. | |
105 | */ | |
106 | ||
107 | int refs_verify_refname_available(struct ref_store *refs, | |
108 | const char *refname, | |
b05855b5 | 109 | const struct string_list *extras, |
7d2df051 NTND |
110 | const struct string_list *skip, |
111 | struct strbuf *err); | |
112 | ||
3f9f1acc HWN |
113 | int refs_ref_exists(struct ref_store *refs, const char *refname); |
114 | ||
1354c9b2 | 115 | int ref_exists(const char *refname); |
fb58c8d5 | 116 | |
341fb286 CW |
117 | int should_autocreate_reflog(const char *refname); |
118 | ||
1354c9b2 | 119 | int is_branch(const char *refname); |
fb58c8d5 | 120 | |
55454427 | 121 | int refs_init_db(struct strbuf *err); |
6fb5acfd | 122 | |
fb58c8d5 | 123 | /* |
36a31792 JK |
124 | * Return the peeled value of the oid currently being iterated via |
125 | * for_each_ref(), etc. This is equivalent to calling: | |
126 | * | |
127 | * peel_object(oid, &peeled); | |
128 | * | |
129 | * with the "oid" value given to the each_ref_fn callback, except | |
130 | * that some ref storage may be able to answer the query without | |
131 | * actually loading the object in memory. | |
fb58c8d5 | 132 | */ |
36a31792 | 133 | int peel_iterated_oid(const struct object_id *base, struct object_id *peeled); |
fb58c8d5 MH |
134 | |
135 | /** | |
a8355bb7 MH |
136 | * Resolve refname in the nested "gitlink" repository in the specified |
137 | * submodule (which must be non-NULL). If the resolution is | |
78fb4579 | 138 | * successful, return 0 and set oid to the name of the object; |
a8355bb7 | 139 | * otherwise, return a non-zero value. |
fb58c8d5 | 140 | */ |
a8355bb7 | 141 | int resolve_gitlink_ref(const char *submodule, const char *refname, |
a98e6101 | 142 | struct object_id *oid); |
fb58c8d5 MH |
143 | |
144 | /* | |
145 | * Return true iff abbrev_name is a possible abbreviation for | |
146 | * full_name according to the rules defined by ref_rev_parse_rules in | |
147 | * refs.c. | |
148 | */ | |
1354c9b2 | 149 | int refname_match(const char *abbrev_name, const char *full_name); |
fb58c8d5 | 150 | |
b4be7410 BW |
151 | /* |
152 | * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add | |
153 | * the results to 'prefixes' | |
154 | */ | |
873cd28a JK |
155 | struct strvec; |
156 | void expand_ref_prefix(struct strvec *prefixes, const char *prefix); | |
b4be7410 | 157 | |
0b1dbf53 | 158 | int expand_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref); |
f24c30e0 JT |
159 | int repo_dwim_ref(struct repository *r, const char *str, int len, |
160 | struct object_id *oid, char **ref, int nonfatal_dangling_mark); | |
56700903 | 161 | int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref); |
ec06b055 | 162 | static inline int dwim_ref(const char *str, int len, struct object_id *oid, |
f24c30e0 | 163 | char **ref, int nonfatal_dangling_mark) |
ec06b055 | 164 | { |
f24c30e0 JT |
165 | return repo_dwim_ref(the_repository, str, len, oid, ref, |
166 | nonfatal_dangling_mark); | |
ec06b055 | 167 | } |
334dc52f | 168 | int dwim_log(const char *str, int len, struct object_id *oid, char **ref); |
fb58c8d5 | 169 | |
8747ebb7 DGW |
170 | /* |
171 | * Retrieves the default branch name for newly-initialized repositories. | |
172 | * | |
173 | * The return value of `repo_default_branch_name()` is an allocated string. The | |
174 | * return value of `git_default_branch_name()` is a singleton. | |
175 | */ | |
cc0f13c5 JS |
176 | const char *git_default_branch_name(int quiet); |
177 | char *repo_default_branch_name(struct repository *r, int quiet); | |
8747ebb7 | 178 | |
b416af5b | 179 | /* |
30173b88 MH |
180 | * A ref_transaction represents a collection of reference updates that |
181 | * should succeed or fail together. | |
b416af5b RS |
182 | * |
183 | * Calling sequence | |
184 | * ---------------- | |
30173b88 | 185 | * |
b416af5b RS |
186 | * - Allocate and initialize a `struct ref_transaction` by calling |
187 | * `ref_transaction_begin()`. | |
188 | * | |
30173b88 MH |
189 | * - Specify the intended ref updates by calling one or more of the |
190 | * following functions: | |
191 | * - `ref_transaction_update()` | |
192 | * - `ref_transaction_create()` | |
193 | * - `ref_transaction_delete()` | |
194 | * - `ref_transaction_verify()` | |
195 | * | |
196 | * - Then either: | |
197 | * | |
198 | * - Optionally call `ref_transaction_prepare()` to prepare the | |
199 | * transaction. This locks all references, checks preconditions, | |
200 | * etc. but doesn't finalize anything. If this step fails, the | |
201 | * transaction has been closed and can only be freed. If this step | |
202 | * succeeds, then `ref_transaction_commit()` is almost certain to | |
203 | * succeed. However, you can still call `ref_transaction_abort()` | |
204 | * if you decide not to commit the transaction after all. | |
205 | * | |
206 | * - Call `ref_transaction_commit()` to execute the transaction, | |
207 | * make the changes permanent, and release all locks. If you | |
208 | * haven't already called `ref_transaction_prepare()`, then | |
209 | * `ref_transaction_commit()` calls it for you. | |
210 | * | |
211 | * Or | |
212 | * | |
213 | * - Call `initial_ref_transaction_commit()` if the ref database is | |
214 | * known to be empty and have no other writers (e.g. during | |
215 | * clone). This is likely to be much faster than | |
216 | * `ref_transaction_commit()`. `ref_transaction_prepare()` should | |
217 | * *not* be called before `initial_ref_transaction_commit()`. | |
218 | * | |
219 | * - Then finally, call `ref_transaction_free()` to free the | |
220 | * `ref_transaction` data structure. | |
221 | * | |
222 | * At any time before calling `ref_transaction_commit()`, you can call | |
223 | * `ref_transaction_abort()` to abort the transaction, rollback any | |
224 | * locks, and free any associated resources (including the | |
225 | * `ref_transaction` data structure). | |
226 | * | |
227 | * Putting it all together, a complete reference update looks like | |
228 | * | |
229 | * struct ref_transaction *transaction; | |
230 | * struct strbuf err = STRBUF_INIT; | |
231 | * int ret = 0; | |
232 | * | |
c6da34a6 | 233 | * transaction = ref_store_transaction_begin(refs, &err); |
30173b88 MH |
234 | * if (!transaction || |
235 | * ref_transaction_update(...) || | |
236 | * ref_transaction_create(...) || | |
237 | * ...etc... || | |
238 | * ref_transaction_commit(transaction, &err)) { | |
239 | * error("%s", err.buf); | |
240 | * ret = -1; | |
241 | * } | |
242 | * ref_transaction_free(transaction); | |
243 | * strbuf_release(&err); | |
244 | * return ret; | |
b416af5b RS |
245 | * |
246 | * Error handling | |
247 | * -------------- | |
248 | * | |
249 | * On error, transaction functions append a message about what | |
250 | * went wrong to the 'err' argument. The message mentions what | |
251 | * ref was being updated (if any) when the error occurred so it | |
252 | * can be passed to 'die' or 'error' as-is. | |
253 | * | |
254 | * The message is appended to err without first clearing err. | |
255 | * err will not be '\n' terminated. | |
49386868 DT |
256 | * |
257 | * Caveats | |
258 | * ------- | |
259 | * | |
260 | * Note that no locks are taken, and no refs are read, until | |
30173b88 MH |
261 | * `ref_transaction_prepare()` or `ref_transaction_commit()` is |
262 | * called. So, for example, `ref_transaction_verify()` won't report a | |
263 | * verification failure until the commit is attempted. | |
b416af5b | 264 | */ |
caa4046c MH |
265 | struct ref_transaction; |
266 | ||
89df9c84 | 267 | /* |
3bc581b9 MH |
268 | * Bit values set in the flags argument passed to each_ref_fn() and |
269 | * stored in ref_iterator::flags. Other bits are for internal use | |
270 | * only: | |
89df9c84 MH |
271 | */ |
272 | ||
273 | /* Reference is a symbolic reference. */ | |
98ac34b2 | 274 | #define REF_ISSYMREF 0x01 |
89df9c84 MH |
275 | |
276 | /* Reference is a packed reference. */ | |
98ac34b2 | 277 | #define REF_ISPACKED 0x02 |
89df9c84 MH |
278 | |
279 | /* | |
280 | * Reference cannot be resolved to an object name: dangling symbolic | |
d0f810f0 RS |
281 | * reference (directly or indirectly), corrupt reference file, |
282 | * reference exists but name is bad, or symbolic reference refers to | |
283 | * ill-formatted reference name. | |
89df9c84 | 284 | */ |
98ac34b2 | 285 | #define REF_ISBROKEN 0x04 |
f4204ab9 | 286 | |
d0f810f0 RS |
287 | /* |
288 | * Reference name is not well formed. | |
289 | * | |
290 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
291 | */ | |
292 | #define REF_BAD_NAME 0x08 | |
293 | ||
8a65ff76 | 294 | /* |
4f78c24c | 295 | * The signature for the callback function for the for_each_*() |
78fb4579 | 296 | * functions below. The memory pointed to by the refname and oid |
4f78c24c MH |
297 | * arguments is only guaranteed to be valid for the duration of a |
298 | * single callback invocation. | |
299 | */ | |
300 | typedef int each_ref_fn(const char *refname, | |
2b2a5be3 MH |
301 | const struct object_id *oid, int flags, void *cb_data); |
302 | ||
4a6067cd SB |
303 | /* |
304 | * The same as each_ref_fn, but also with a repository argument that | |
305 | * contains the repository associated with the callback. | |
306 | */ | |
307 | typedef int each_repo_ref_fn(struct repository *r, | |
308 | const char *refname, | |
309 | const struct object_id *oid, | |
310 | int flags, | |
311 | void *cb_data); | |
312 | ||
4f78c24c MH |
313 | /* |
314 | * The following functions invoke the specified callback function for | |
315 | * each reference indicated. If the function ever returns a nonzero | |
316 | * value, stop the iteration and return that value. Please note that | |
317 | * it is not safe to modify references while an iteration is in | |
318 | * progress, unless the same callback function invocation that | |
319 | * modifies the reference also returns a nonzero value to immediately | |
adac8115 | 320 | * stop the iteration. Returned references are sorted. |
8a65ff76 | 321 | */ |
62f0b399 NTND |
322 | int refs_head_ref(struct ref_store *refs, |
323 | each_ref_fn fn, void *cb_data); | |
7d2df051 NTND |
324 | int refs_for_each_ref(struct ref_store *refs, |
325 | each_ref_fn fn, void *cb_data); | |
326 | int refs_for_each_ref_in(struct ref_store *refs, const char *prefix, | |
327 | each_ref_fn fn, void *cb_data); | |
328 | int refs_for_each_tag_ref(struct ref_store *refs, | |
329 | each_ref_fn fn, void *cb_data); | |
330 | int refs_for_each_branch_ref(struct ref_store *refs, | |
331 | each_ref_fn fn, void *cb_data); | |
332 | int refs_for_each_remote_ref(struct ref_store *refs, | |
333 | each_ref_fn fn, void *cb_data); | |
334 | ||
126c1cce | 335 | /* just iterates the head ref. */ |
1354c9b2 | 336 | int head_ref(each_ref_fn fn, void *cb_data); |
126c1cce HW |
337 | |
338 | /* iterates all refs. */ | |
1354c9b2 | 339 | int for_each_ref(each_ref_fn fn, void *cb_data); |
126c1cce HW |
340 | |
341 | /** | |
342 | * iterates all refs which have a defined prefix and strips that prefix from | |
343 | * the passed variable refname. | |
344 | */ | |
1354c9b2 | 345 | int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data); |
126c1cce | 346 | |
073cf63c | 347 | int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix, |
67985e4e JK |
348 | each_ref_fn fn, void *cb_data); |
349 | int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data); | |
126c1cce | 350 | |
16b1985b TB |
351 | /** |
352 | * iterate all refs in "patterns" by partitioning patterns into disjoint sets | |
353 | * and iterating the longest-common prefix of each set. | |
354 | * | |
355 | * callers should be prepared to ignore references that they did not ask for. | |
356 | */ | |
91e2ab15 JK |
357 | int refs_for_each_fullref_in_prefixes(struct ref_store *refs, |
358 | const char *namespace, const char **patterns, | |
359 | each_ref_fn fn, void *cb_data); | |
360 | ||
126c1cce HW |
361 | /** |
362 | * iterate refs from the respective area. | |
363 | */ | |
1354c9b2 MH |
364 | int for_each_tag_ref(each_ref_fn fn, void *cb_data); |
365 | int for_each_branch_ref(each_ref_fn fn, void *cb_data); | |
366 | int for_each_remote_ref(each_ref_fn fn, void *cb_data); | |
212e0f7e | 367 | int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data); |
126c1cce HW |
368 | |
369 | /* iterates all refs that match the specified glob pattern. */ | |
1354c9b2 | 370 | int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data); |
126c1cce | 371 | |
1354c9b2 MH |
372 | int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, |
373 | const char *prefix, void *cb_data); | |
374 | ||
1354c9b2 MH |
375 | int head_ref_namespaced(each_ref_fn fn, void *cb_data); |
376 | int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
a1bea2c1 | 377 | |
fb58c8d5 | 378 | /* can be used to learn about broken ref and symref */ |
7d2df051 | 379 | int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 380 | int for_each_rawref(each_ref_fn fn, void *cb_data); |
fb58c8d5 | 381 | |
65516f58 RA |
382 | /* |
383 | * Normalizes partial refs to their fully qualified form. | |
384 | * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'. | |
385 | * <prefix> will default to 'refs/' if NULL. | |
386 | * | |
387 | * item.string will be set to the result. | |
388 | * item.util will be set to NULL if <pattern> contains glob characters, or | |
389 | * non-NULL if it doesn't. | |
390 | */ | |
391 | void normalize_glob_ref(struct string_list_item *item, const char *prefix, | |
392 | const char *pattern); | |
393 | ||
894a9d33 TR |
394 | static inline const char *has_glob_specials(const char *pattern) |
395 | { | |
396 | return strpbrk(pattern, "?*["); | |
397 | } | |
398 | ||
1354c9b2 MH |
399 | void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); |
400 | void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, | |
401 | const struct string_list *refnames); | |
f8948e2f | 402 | |
32d462ce MH |
403 | /* |
404 | * Flags for controlling behaviour of pack_refs() | |
405 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
406 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
407 | */ | |
408 | #define PACK_REFS_PRUNE 0x0001 | |
409 | #define PACK_REFS_ALL 0x0002 | |
410 | ||
411 | /* | |
412 | * Write a packed-refs file for the current repository. | |
413 | * flags: Combination of the above PACK_REFS_* flags. | |
414 | */ | |
7d2df051 | 415 | int refs_pack_refs(struct ref_store *refs, unsigned int flags); |
32d462ce | 416 | |
bd3b02da | 417 | /* |
a4c653df | 418 | * Setup reflog before using. Fill in err and return -1 on failure. |
bd3b02da | 419 | */ |
7d2df051 | 420 | int refs_create_reflog(struct ref_store *refs, const char *refname, |
7b089120 HWN |
421 | struct strbuf *err); |
422 | int safe_create_reflog(const char *refname, struct strbuf *err); | |
859c3017 | 423 | |
d556fae2 | 424 | /** Reads log for the value of ref during at_time. **/ |
7fdff474 NTND |
425 | int read_ref_at(struct ref_store *refs, |
426 | const char *refname, unsigned int flags, | |
dddbad72 | 427 | timestamp_t at_time, int cnt, |
8eb36d94 | 428 | struct object_id *oid, char **msg, |
dddbad72 | 429 | timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt); |
d556fae2 | 430 | |
4da58835 | 431 | /** Check if a particular reflog exists */ |
7d2df051 | 432 | int refs_reflog_exists(struct ref_store *refs, const char *refname); |
1354c9b2 | 433 | int reflog_exists(const char *refname); |
4da58835 | 434 | |
fc1c2168 | 435 | /* |
2616a5e5 | 436 | * Delete the specified reference. If old_oid is non-NULL, then |
78fb4579 | 437 | * verify that the current value of the reference is old_oid before |
2616a5e5 | 438 | * deleting it. If old_oid is NULL, delete the reference if it |
439 | * exists, regardless of its old value. It is an error for old_oid to | |
440 | * be null_oid. msg and flags are passed through to | |
64da4199 | 441 | * ref_transaction_delete(). |
fc1c2168 | 442 | */ |
c0fe4e8b NTND |
443 | int refs_delete_ref(struct ref_store *refs, const char *msg, |
444 | const char *refname, | |
2616a5e5 | 445 | const struct object_id *old_oid, |
c0fe4e8b | 446 | unsigned int flags); |
755b49ae | 447 | int delete_ref(const char *msg, const char *refname, |
2616a5e5 | 448 | const struct object_id *old_oid, unsigned int flags); |
fc1c2168 | 449 | |
98ffd5ff MH |
450 | /* |
451 | * Delete the specified references. If there are any problems, emit | |
452 | * errors but attempt to keep going (i.e., the deletes are not done in | |
64da4199 | 453 | * an all-or-nothing transaction). msg and flags are passed through to |
c5f04ddd | 454 | * ref_transaction_delete(). |
98ffd5ff | 455 | */ |
64da4199 MH |
456 | int refs_delete_refs(struct ref_store *refs, const char *msg, |
457 | struct string_list *refnames, unsigned int flags); | |
458 | int delete_refs(const char *msg, struct string_list *refnames, | |
459 | unsigned int flags); | |
98ffd5ff | 460 | |
4da58835 | 461 | /** Delete a reflog */ |
7d2df051 | 462 | int refs_delete_reflog(struct ref_store *refs, const char *refname); |
1354c9b2 | 463 | int delete_reflog(const char *refname); |
4da58835 | 464 | |
d1eb22da HWN |
465 | /* |
466 | * Callback to process a reflog entry found by the iteration functions (see | |
e6e94f34 JH |
467 | * below). |
468 | * | |
469 | * The committer parameter is a single string, in the form | |
470 | * "$GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" (without double quotes). | |
471 | * | |
472 | * The timestamp parameter gives the time when entry was created as the number | |
473 | * of seconds since the UNIX epoch. | |
474 | * | |
475 | * The tz parameter gives the timezone offset for the user who created | |
476 | * the reflog entry, and its value gives a positive or negative offset | |
477 | * from UTC. Its absolute value is formed by multiplying the hour | |
478 | * part by 100 and adding the minute part. For example, 1 hour ahead | |
479 | * of UTC, CET == "+0100", is represented as positive one hundred (not | |
480 | * postiive sixty). | |
481 | * | |
482 | * The msg parameter is a single complete line; a reflog message given | |
483 | * to refs_delete_ref, refs_update_ref, etc. is returned to the | |
484 | * callback normalized---each run of whitespaces are squashed into a | |
485 | * single whitespace, trailing whitespace, if exists, is trimmed, and | |
486 | * then a single LF is added at the end. | |
487 | * | |
488 | * The cb_data is a caller-supplied pointer given to the iterator | |
489 | * functions. | |
d1eb22da | 490 | */ |
1354c9b2 | 491 | typedef int each_reflog_ent_fn( |
9461d272 | 492 | struct object_id *old_oid, struct object_id *new_oid, |
dddbad72 | 493 | const char *committer, timestamp_t timestamp, |
1354c9b2 MH |
494 | int tz, const char *msg, void *cb_data); |
495 | ||
d1eb22da HWN |
496 | /* Iterate over reflog entries in the log for `refname`. */ |
497 | ||
498 | /* oldest entry first */ | |
7d2df051 NTND |
499 | int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname, |
500 | each_reflog_ent_fn fn, void *cb_data); | |
d1eb22da HWN |
501 | |
502 | /* youngest entry first */ | |
7d2df051 NTND |
503 | int refs_for_each_reflog_ent_reverse(struct ref_store *refs, |
504 | const char *refname, | |
505 | each_reflog_ent_fn fn, | |
506 | void *cb_data); | |
d1eb22da HWN |
507 | |
508 | /* | |
509 | * Iterate over reflog entries in the log for `refname` in the main ref store. | |
510 | */ | |
511 | ||
512 | /* oldest entry first */ | |
dfefa935 | 513 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
d1eb22da HWN |
514 | |
515 | /* youngest entry first */ | |
98f85ff4 | 516 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
2ff81662 | 517 | |
eb8381c8 NP |
518 | /* |
519 | * Calls the specified function for each reflog file until it returns nonzero, | |
adac8115 | 520 | * and returns the value. Reflog file order is unspecified. |
eb8381c8 | 521 | */ |
7d2df051 | 522 | int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 523 | int for_each_reflog(each_ref_fn fn, void *cb_data); |
eb8381c8 | 524 | |
8d9c5010 MH |
525 | #define REFNAME_ALLOW_ONELEVEL 1 |
526 | #define REFNAME_REFSPEC_PATTERN 2 | |
527 | ||
528 | /* | |
dfefa935 MH |
529 | * Return 0 iff refname has the correct format for a refname according |
530 | * to the rules described in Documentation/git-check-ref-format.txt. | |
531 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
8d9c5010 | 532 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then |
cd377f45 JK |
533 | * allow a single "*" wildcard character in the refspec. No leading or |
534 | * repeated slashes are accepted. | |
8d9c5010 | 535 | */ |
1354c9b2 | 536 | int check_refname_format(const char *refname, int flags); |
95fc7512 | 537 | |
1de16aec NTND |
538 | /* |
539 | * Apply the rules from check_refname_format, but mutate the result until it | |
540 | * is acceptable, and place the result in "out". | |
541 | */ | |
542 | void sanitize_refname_component(const char *refname, struct strbuf *out); | |
543 | ||
1354c9b2 | 544 | const char *prettify_refname(const char *refname); |
fb58c8d5 | 545 | |
546edf37 NTND |
546 | char *refs_shorten_unambiguous_ref(struct ref_store *refs, |
547 | const char *refname, int strict); | |
1354c9b2 | 548 | char *shorten_unambiguous_ref(const char *refname, int strict); |
a9c37a72 | 549 | |
c976d415 | 550 | /** rename ref, return 0 on success **/ |
7d2df051 NTND |
551 | int refs_rename_ref(struct ref_store *refs, const char *oldref, |
552 | const char *newref, const char *logmsg); | |
52d59cc6 SD |
553 | int rename_ref(const char *oldref, const char *newref, |
554 | const char *logmsg); | |
555 | ||
556 | /** copy ref, return 0 on success **/ | |
557 | int refs_copy_existing_ref(struct ref_store *refs, const char *oldref, | |
558 | const char *newref, const char *logmsg); | |
559 | int copy_existing_ref(const char *oldref, const char *newref, | |
560 | const char *logmsg); | |
c976d415 | 561 | |
7d2df051 NTND |
562 | int refs_create_symref(struct ref_store *refs, const char *refname, |
563 | const char *target, const char *logmsg); | |
1354c9b2 | 564 | int create_symref(const char *refname, const char *target, const char *logmsg); |
0ebde32c | 565 | |
f4124112 MH |
566 | enum action_on_err { |
567 | UPDATE_REFS_MSG_ON_ERR, | |
568 | UPDATE_REFS_DIE_ON_ERR, | |
569 | UPDATE_REFS_QUIET_ON_ERR | |
570 | }; | |
571 | ||
caa4046c MH |
572 | /* |
573 | * Begin a reference transaction. The reference transaction must | |
33f9fc59 | 574 | * be freed by calling ref_transaction_free(). |
caa4046c | 575 | */ |
c0fe4e8b NTND |
576 | struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs, |
577 | struct strbuf *err); | |
93a644ea | 578 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); |
caa4046c | 579 | |
caa4046c | 580 | /* |
d1dd721f MH |
581 | * Reference transaction updates |
582 | * | |
583 | * The following four functions add a reference check or update to a | |
584 | * ref_transaction. They have some common similar parameters: | |
585 | * | |
586 | * transaction -- a pointer to an open ref_transaction, obtained | |
587 | * from ref_transaction_begin(). | |
588 | * | |
589 | * refname -- the name of the reference to be affected. | |
590 | * | |
5ac95fee MH |
591 | * new_oid -- the object ID that should be set to be the new value |
592 | * of the reference. Some functions allow this parameter to be | |
fd2ce9c0 | 593 | * NULL, meaning that the reference is not changed, or |
5ac95fee | 594 | * null_oid, meaning that the reference should be deleted. A |
fd2ce9c0 MH |
595 | * copy of this value is made in the transaction. |
596 | * | |
5ac95fee | 597 | * old_oid -- the object ID that the reference must have before |
fd2ce9c0 MH |
598 | * the update. Some functions allow this parameter to be NULL, |
599 | * meaning that the old value of the reference is not checked, | |
5ac95fee | 600 | * or null_oid, meaning that the reference must not exist |
fd2ce9c0 MH |
601 | * before the update. A copy of this value is made in the |
602 | * transaction. | |
603 | * | |
d1dd721f | 604 | * flags -- flags affecting the update, passed to |
91774afc | 605 | * update_ref_lock(). Possible flags: REF_NO_DEREF, |
5ac95fee MH |
606 | * REF_FORCE_CREATE_REFLOG. See those constants for more |
607 | * information. | |
d1dd721f MH |
608 | * |
609 | * msg -- a message describing the change (for the reflog). | |
610 | * | |
611 | * err -- a strbuf for receiving a description of any error that | |
dc72b500 | 612 | * might have occurred. |
d1dd721f MH |
613 | * |
614 | * The functions make internal copies of refname and msg, so the | |
615 | * caller retains ownership of these parameters. | |
616 | * | |
617 | * The functions return 0 on success and non-zero on failure. A | |
618 | * failure means that the transaction as a whole has failed and needs | |
619 | * to be rolled back. | |
caa4046c MH |
620 | */ |
621 | ||
caa4046c | 622 | /* |
5ac95fee MH |
623 | * The following flags can be passed to ref_transaction_update() etc. |
624 | * Internally, they are stored in `ref_update::flags`, along with some | |
625 | * internal flags. | |
626 | */ | |
627 | ||
628 | /* | |
629 | * Act on the ref directly; i.e., without dereferencing symbolic refs. | |
630 | * If this flag is not specified, then symbolic references are | |
631 | * dereferenced and the update is applied to the referent. | |
632 | */ | |
91774afc | 633 | #define REF_NO_DEREF (1 << 0) |
5ac95fee MH |
634 | |
635 | /* | |
636 | * Force the creation of a reflog for this reference, even if it | |
637 | * didn't previously have a reflog. | |
638 | */ | |
639 | #define REF_FORCE_CREATE_REFLOG (1 << 1) | |
640 | ||
e9706a18 HWN |
641 | /* |
642 | * Blindly write an object_id. This is useful for testing data corruption | |
643 | * scenarios. | |
644 | */ | |
645 | #define REF_SKIP_OID_VERIFICATION (1 << 10) | |
646 | ||
3c966c7b HWN |
647 | /* |
648 | * Skip verifying refname. This is useful for testing data corruption scenarios. | |
649 | */ | |
650 | #define REF_SKIP_REFNAME_VERIFICATION (1 << 11) | |
651 | ||
5ac95fee MH |
652 | /* |
653 | * Bitmask of all of the flags that are allowed to be passed in to | |
654 | * ref_transaction_update() and friends: | |
655 | */ | |
3c966c7b HWN |
656 | #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \ |
657 | (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG | REF_SKIP_OID_VERIFICATION | \ | |
658 | REF_SKIP_REFNAME_VERIFICATION) | |
5ac95fee MH |
659 | |
660 | /* | |
661 | * Add a reference update to transaction. `new_oid` is the value that | |
662 | * the reference should have after the update, or `null_oid` if it | |
663 | * should be deleted. If `new_oid` is NULL, then the reference is not | |
664 | * changed at all. `old_oid` is the value that the reference must have | |
665 | * before the update, or `null_oid` if it must not have existed | |
16180334 | 666 | * beforehand. The old value is checked after the lock is taken to |
89f3bbdd | 667 | * prevent races. If the old value doesn't agree with old_oid, the |
668 | * whole transaction fails. If old_oid is NULL, then the previous | |
16180334 MH |
669 | * value is not checked. |
670 | * | |
d1dd721f MH |
671 | * See the above comment "Reference transaction updates" for more |
672 | * information. | |
caa4046c | 673 | */ |
8e34800e RS |
674 | int ref_transaction_update(struct ref_transaction *transaction, |
675 | const char *refname, | |
89f3bbdd | 676 | const struct object_id *new_oid, |
677 | const struct object_id *old_oid, | |
1d147bdf | 678 | unsigned int flags, const char *msg, |
8e34800e | 679 | struct strbuf *err); |
caa4046c MH |
680 | |
681 | /* | |
89f3bbdd | 682 | * Add a reference creation to transaction. new_oid is the value that |
d1dd721f | 683 | * the reference should have after the update; it must not be |
89f3bbdd | 684 | * null_oid. It is verified that the reference does not exist |
caa4046c | 685 | * already. |
d1dd721f MH |
686 | * |
687 | * See the above comment "Reference transaction updates" for more | |
688 | * information. | |
caa4046c | 689 | */ |
b416af5b RS |
690 | int ref_transaction_create(struct ref_transaction *transaction, |
691 | const char *refname, | |
89f3bbdd | 692 | const struct object_id *new_oid, |
fec14ec3 | 693 | unsigned int flags, const char *msg, |
b416af5b | 694 | struct strbuf *err); |
caa4046c MH |
695 | |
696 | /* | |
89f3bbdd | 697 | * Add a reference deletion to transaction. If old_oid is non-NULL, |
d1dd721f | 698 | * then it holds the value that the reference should have had before |
89f3bbdd | 699 | * the update (which must not be null_oid). |
d1dd721f MH |
700 | * |
701 | * See the above comment "Reference transaction updates" for more | |
702 | * information. | |
caa4046c | 703 | */ |
8c8bdc0d RS |
704 | int ref_transaction_delete(struct ref_transaction *transaction, |
705 | const char *refname, | |
89f3bbdd | 706 | const struct object_id *old_oid, |
fb5a6bb6 | 707 | unsigned int flags, const char *msg, |
8c8bdc0d | 708 | struct strbuf *err); |
caa4046c | 709 | |
16180334 | 710 | /* |
89f3bbdd | 711 | * Verify, within a transaction, that refname has the value old_oid, |
712 | * or, if old_oid is null_oid, then verify that the reference | |
713 | * doesn't exist. old_oid must be non-NULL. | |
d1dd721f MH |
714 | * |
715 | * See the above comment "Reference transaction updates" for more | |
716 | * information. | |
16180334 MH |
717 | */ |
718 | int ref_transaction_verify(struct ref_transaction *transaction, | |
719 | const char *refname, | |
89f3bbdd | 720 | const struct object_id *old_oid, |
16180334 MH |
721 | unsigned int flags, |
722 | struct strbuf *err); | |
723 | ||
28e6a97e RS |
724 | /* Naming conflict (for example, the ref names A and A/B conflict). */ |
725 | #define TRANSACTION_NAME_CONFLICT -1 | |
726 | /* All other errors. */ | |
727 | #define TRANSACTION_GENERIC_ERROR -2 | |
30173b88 MH |
728 | |
729 | /* | |
64127575 | 730 | * Perform the preparatory stages of committing `transaction`. Acquire |
30173b88 MH |
731 | * any needed locks, check preconditions, etc.; basically, do as much |
732 | * as possible to ensure that the transaction will be able to go | |
733 | * through, stopping just short of making any irrevocable or | |
734 | * user-visible changes. The updates that this function prepares can | |
735 | * be finished up by calling `ref_transaction_commit()` or rolled back | |
736 | * by calling `ref_transaction_abort()`. | |
737 | * | |
738 | * On success, return 0 and leave the transaction in "prepared" state. | |
739 | * On failure, abort the transaction, write an error message to `err`, | |
740 | * and return one of the `TRANSACTION_*` constants. | |
741 | * | |
64127575 | 742 | * Callers who don't need such fine-grained control over committing |
30173b88 MH |
743 | * reference transactions should just call `ref_transaction_commit()`. |
744 | */ | |
745 | int ref_transaction_prepare(struct ref_transaction *transaction, | |
746 | struct strbuf *err); | |
747 | ||
748 | /* | |
749 | * Commit all of the changes that have been queued in transaction, as | |
750 | * atomically as possible. On success, return 0 and leave the | |
751 | * transaction in "closed" state. On failure, roll back the | |
752 | * transaction, write an error message to `err`, and return one of the | |
753 | * `TRANSACTION_*` constants | |
754 | */ | |
caa4046c | 755 | int ref_transaction_commit(struct ref_transaction *transaction, |
db7516ab | 756 | struct strbuf *err); |
caa4046c | 757 | |
30173b88 MH |
758 | /* |
759 | * Abort `transaction`, which has been begun and possibly prepared, | |
760 | * but not yet committed. | |
761 | */ | |
762 | int ref_transaction_abort(struct ref_transaction *transaction, | |
763 | struct strbuf *err); | |
764 | ||
58f233ce MH |
765 | /* |
766 | * Like ref_transaction_commit(), but optimized for creating | |
767 | * references when originally initializing a repository (e.g., by "git | |
768 | * clone"). It writes the new references directly to packed-refs | |
769 | * without locking the individual references. | |
770 | * | |
771 | * It is a bug to call this function when there might be other | |
772 | * processes accessing the repository or if there are existing | |
773 | * references that might conflict with the ones being created. All | |
78fb4579 | 774 | * old_oid values must either be absent or null_oid. |
58f233ce MH |
775 | */ |
776 | int initial_ref_transaction_commit(struct ref_transaction *transaction, | |
777 | struct strbuf *err); | |
778 | ||
4f2ba2d0 PS |
779 | /* |
780 | * Execute the given callback function for each of the reference updates which | |
781 | * have been queued in the given transaction. `old_oid` and `new_oid` may be | |
782 | * `NULL` pointers depending on whether the update has these object IDs set or | |
783 | * not. | |
784 | */ | |
785 | typedef void ref_transaction_for_each_queued_update_fn(const char *refname, | |
786 | const struct object_id *old_oid, | |
787 | const struct object_id *new_oid, | |
788 | void *cb_data); | |
789 | void ref_transaction_for_each_queued_update(struct ref_transaction *transaction, | |
790 | ref_transaction_for_each_queued_update_fn cb, | |
791 | void *cb_data); | |
792 | ||
026bd1d3 | 793 | /* |
30173b88 | 794 | * Free `*transaction` and all associated data. |
026bd1d3 RS |
795 | */ |
796 | void ref_transaction_free(struct ref_transaction *transaction); | |
797 | ||
4b7b520b MH |
798 | /** |
799 | * Lock, update, and unlock a single reference. This function | |
800 | * basically does a transaction containing a single call to | |
801 | * ref_transaction_update(). The parameters to this function have the | |
802 | * same meaning as the corresponding parameters to | |
803 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
804 | * argument. | |
805 | */ | |
c0fe4e8b | 806 | int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname, |
ae077771 | 807 | const struct object_id *new_oid, const struct object_id *old_oid, |
c0fe4e8b | 808 | unsigned int flags, enum action_on_err onerr); |
4b7b520b | 809 | int update_ref(const char *msg, const char *refname, |
8f6dc7e3 | 810 | const struct object_id *new_oid, const struct object_id *old_oid, |
811 | unsigned int flags, enum action_on_err onerr); | |
3d9f037c | 812 | |
9b67eb6f PS |
813 | int parse_hide_refs_config(const char *var, const char *value, const char *, |
814 | struct string_list *); | |
fb58c8d5 | 815 | |
78a766ab LF |
816 | /* |
817 | * Check whether a ref is hidden. If no namespace is set, both the first and | |
818 | * the second parameter point to the full ref name. If a namespace is set and | |
819 | * the ref is inside that namespace, the first parameter is a pointer to the | |
820 | * name of the ref with the namespace prefix removed. If a namespace is set and | |
821 | * the ref is outside that namespace, the first parameter is NULL. The second | |
822 | * parameter always points to the full ref name. | |
823 | */ | |
9b67eb6f | 824 | int ref_is_hidden(const char *, const char *, const struct string_list *); |
daebaa78 | 825 | |
71e54734 HWN |
826 | /* Is this a per-worktree ref living in the refs/ namespace? */ |
827 | int is_per_worktree_ref(const char *refname); | |
828 | ||
829 | /* Describes how a refname relates to worktrees */ | |
830 | enum ref_worktree_type { | |
831 | REF_WORKTREE_CURRENT, /* implicitly per worktree, eg. HEAD or | |
832 | refs/bisect/SOMETHING */ | |
833 | REF_WORKTREE_MAIN, /* explicitly in main worktree, eg. | |
834 | main-worktree/HEAD */ | |
835 | REF_WORKTREE_OTHER, /* explicitly in named worktree, eg. | |
836 | worktrees/bla/HEAD */ | |
837 | REF_WORKTREE_SHARED, /* the default, eg. refs/heads/main */ | |
266b1827 DT |
838 | }; |
839 | ||
71e54734 HWN |
840 | /* |
841 | * Parse a `maybe_worktree_ref` as a ref that possibly refers to a worktree ref | |
842 | * (ie. either REFNAME, main-worktree/REFNAME or worktree/WORKTREE/REFNAME). It | |
843 | * returns what kind of ref was found, and in case of REF_WORKTREE_OTHER, the | |
844 | * worktree name is returned in `worktree_name` (pointing into | |
845 | * `maybe_worktree_ref`) and `worktree_name_length`. The bare refname (the | |
846 | * refname stripped of prefixes) is returned in `bare_refname`. The | |
847 | * `worktree_name`, `worktree_name_length` and `bare_refname` arguments may be | |
848 | * NULL. | |
849 | */ | |
850 | enum ref_worktree_type parse_worktree_ref(const char *maybe_worktree_ref, | |
851 | const char **worktree_name, | |
852 | int *worktree_name_length, | |
853 | const char **bare_refname); | |
266b1827 | 854 | |
fa5b1830 MH |
855 | enum expire_reflog_flags { |
856 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
857 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
fcd2c3d9 | 858 | EXPIRE_REFLOGS_REWRITE = 1 << 2, |
fa5b1830 MH |
859 | }; |
860 | ||
861 | /* | |
862 | * The following interface is used for reflog expiration. The caller | |
863 | * calls reflog_expire(), supplying it with three callback functions, | |
864 | * of the following types. The callback functions define the | |
865 | * expiration policy that is desired. | |
866 | * | |
867 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
ae35e16c | 868 | * locked. Called with the OID of the locked reference. |
fa5b1830 MH |
869 | * |
870 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
871 | * existing reflog. It should return true iff that entry should be | |
872 | * pruned. | |
873 | * | |
874 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
875 | * unlocked again. | |
876 | */ | |
877 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
4322478a | 878 | const struct object_id *oid, |
fa5b1830 | 879 | void *cb_data); |
4322478a | 880 | typedef int reflog_expiry_should_prune_fn(struct object_id *ooid, |
881 | struct object_id *noid, | |
fa5b1830 | 882 | const char *email, |
dddbad72 | 883 | timestamp_t timestamp, int tz, |
fa5b1830 MH |
884 | const char *message, void *cb_data); |
885 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
886 | ||
887 | /* | |
cc40b5ce ÆAB |
888 | * Expire reflog entries for the specified reference. |
889 | * flags is a combination of the constants in | |
fa5b1830 MH |
890 | * enum expire_reflog_flags. The three function pointers are described |
891 | * above. On success, return zero. | |
892 | */ | |
7d2df051 NTND |
893 | int refs_reflog_expire(struct ref_store *refs, |
894 | const char *refname, | |
7d2df051 NTND |
895 | unsigned int flags, |
896 | reflog_expiry_prepare_fn prepare_fn, | |
897 | reflog_expiry_should_prune_fn should_prune_fn, | |
898 | reflog_expiry_cleanup_fn cleanup_fn, | |
899 | void *policy_cb_data); | |
cc40b5ce | 900 | int reflog_expire(const char *refname, |
1354c9b2 MH |
901 | unsigned int flags, |
902 | reflog_expiry_prepare_fn prepare_fn, | |
903 | reflog_expiry_should_prune_fn should_prune_fn, | |
904 | reflog_expiry_cleanup_fn cleanup_fn, | |
905 | void *policy_cb_data); | |
fa5b1830 | 906 | |
64a74161 | 907 | struct ref_store *get_main_ref_store(struct repository *r); |
126c1cce HW |
908 | |
909 | /** | |
910 | * Submodules | |
911 | * ---------- | |
912 | * | |
913 | * If you want to iterate the refs of a submodule you first need to add the | |
914 | * submodules object database. You can do this by a code-snippet like | |
915 | * this: | |
916 | * | |
917 | * const char *path = "path/to/submodule" | |
918 | * if (add_submodule_odb(path)) | |
919 | * die("Error submodule '%s' not populated.", path); | |
920 | * | |
921 | * `add_submodule_odb()` will return zero on success. If you | |
922 | * do not do this you will get an error for each ref that it does not point | |
923 | * to a valid object. | |
924 | * | |
925 | * Note: As a side-effect of this you cannot safely assume that all | |
926 | * objects you lookup are available in superproject. All submodule objects | |
927 | * will be available the same way as the superprojects objects. | |
928 | * | |
929 | * Example: | |
930 | * -------- | |
931 | * | |
932 | * ---- | |
933 | * static int handle_remote_ref(const char *refname, | |
934 | * const unsigned char *sha1, int flags, void *cb_data) | |
935 | * { | |
936 | * struct strbuf *output = cb_data; | |
937 | * strbuf_addf(output, "%s\n", refname); | |
938 | * return 0; | |
939 | * } | |
940 | * | |
941 | */ | |
942 | ||
18d0002d NTND |
943 | /* |
944 | * Return the ref_store instance for the specified submodule. For the | |
945 | * main repository, use submodule==NULL; such a call cannot fail. For | |
946 | * a submodule, the submodule must exist and be a nonbare repository, | |
947 | * otherwise return NULL. If the requested reference store has not yet | |
948 | * been initialized, initialize it first. | |
949 | * | |
950 | * For backwards compatibility, submodule=="" is treated the same as | |
951 | * submodule==NULL. | |
952 | */ | |
953 | struct ref_store *get_submodule_ref_store(const char *submodule); | |
17eff96b | 954 | struct ref_store *get_worktree_ref_store(const struct worktree *wt); |
077be78d | 955 | |
b9342b3f DS |
956 | /* |
957 | * Some of the names specified by refs have special meaning to Git. | |
958 | * Organize these namespaces in a comon 'ref_namespace' array for | |
959 | * reference from multiple places in the codebase. | |
960 | */ | |
961 | ||
962 | struct ref_namespace_info { | |
963 | char *ref; | |
964 | enum decoration_type decoration; | |
965 | ||
966 | /* | |
967 | * If 'exact' is true, then we must match the 'ref' exactly. | |
968 | * Otherwise, use a prefix match. | |
969 | * | |
970 | * 'ref_updated' is for internal use. It represents whether the | |
971 | * 'ref' value was replaced from its original literal version. | |
972 | */ | |
973 | unsigned exact:1, | |
974 | ref_updated:1; | |
975 | }; | |
976 | ||
977 | enum ref_namespace { | |
978 | NAMESPACE_HEAD, | |
979 | NAMESPACE_BRANCHES, | |
980 | NAMESPACE_TAGS, | |
981 | NAMESPACE_REMOTE_REFS, | |
982 | NAMESPACE_STASH, | |
983 | NAMESPACE_REPLACE, | |
984 | NAMESPACE_NOTES, | |
985 | NAMESPACE_PREFETCH, | |
986 | NAMESPACE_REWRITTEN, | |
987 | ||
988 | /* Must be last */ | |
989 | NAMESPACE__COUNT | |
990 | }; | |
991 | ||
992 | /* See refs.c for the contents of this array. */ | |
993 | extern struct ref_namespace_info ref_namespace[NAMESPACE__COUNT]; | |
994 | ||
995 | /* | |
996 | * Some ref namespaces can be modified by config values or environment | |
997 | * variables. Modify a namespace as specified by its ref_namespace key. | |
998 | */ | |
999 | void update_ref_namespace(enum ref_namespace namespace, char *ref); | |
1000 | ||
95fc7512 | 1001 | #endif /* REFS_H */ |