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