remote: repack packed-refs once when deleting multiple refs
[git] / refs.h
1 #ifndef REFS_H
2 #define REFS_H
3
4 struct ref_lock {
5         char *ref_name;
6         char *orig_ref_name;
7         struct lock_file *lk;
8         unsigned char old_sha1[20];
9         int lock_fd;
10         int force_write;
11 };
12
13 /**
14  * Information needed for a single ref update.  Set new_sha1 to the
15  * new value or to zero to delete the ref.  To check the old value
16  * while locking the ref, set have_old to 1 and set old_sha1 to the
17  * value or to zero to ensure the ref does not exist before update.
18  */
19 struct ref_update {
20         const char *ref_name;
21         unsigned char new_sha1[20];
22         unsigned char old_sha1[20];
23         int flags; /* REF_NODEREF? */
24         int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
25 };
26
27 /*
28  * Bit values set in the flags argument passed to each_ref_fn():
29  */
30
31 /* Reference is a symbolic reference. */
32 #define REF_ISSYMREF 0x01
33
34 /* Reference is a packed reference. */
35 #define REF_ISPACKED 0x02
36
37 /*
38  * Reference cannot be resolved to an object name: dangling symbolic
39  * reference (directly or indirectly), corrupt reference file, or
40  * symbolic reference refers to ill-formatted reference name.
41  */
42 #define REF_ISBROKEN 0x04
43
44 /*
45  * The signature for the callback function for the for_each_*()
46  * functions below.  The memory pointed to by the refname and sha1
47  * arguments is only guaranteed to be valid for the duration of a
48  * single callback invocation.
49  */
50 typedef int each_ref_fn(const char *refname,
51                         const unsigned char *sha1, int flags, void *cb_data);
52
53 /*
54  * The following functions invoke the specified callback function for
55  * each reference indicated.  If the function ever returns a nonzero
56  * value, stop the iteration and return that value.  Please note that
57  * it is not safe to modify references while an iteration is in
58  * progress, unless the same callback function invocation that
59  * modifies the reference also returns a nonzero value to immediately
60  * stop the iteration.
61  */
62 extern int head_ref(each_ref_fn, void *);
63 extern int for_each_ref(each_ref_fn, void *);
64 extern int for_each_ref_in(const char *, each_ref_fn, void *);
65 extern int for_each_tag_ref(each_ref_fn, void *);
66 extern int for_each_branch_ref(each_ref_fn, void *);
67 extern int for_each_remote_ref(each_ref_fn, void *);
68 extern int for_each_replace_ref(each_ref_fn, void *);
69 extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
70 extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
71
72 extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
73 extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
74 extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
75                 each_ref_fn fn, void *cb_data);
76 extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
77 extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
78 extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
79
80 extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
81 extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
82
83 static inline const char *has_glob_specials(const char *pattern)
84 {
85         return strpbrk(pattern, "?*[");
86 }
87
88 /* can be used to learn about broken ref and symref */
89 extern int for_each_rawref(each_ref_fn, void *);
90
91 extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
92
93 /*
94  * Lock the packed-refs file for writing.  Flags is passed to
95  * hold_lock_file_for_update().  Return 0 on success.
96  */
97 extern int lock_packed_refs(int flags);
98
99 /*
100  * Add a reference to the in-memory packed reference cache.  This may
101  * only be called while the packed-refs file is locked (see
102  * lock_packed_refs()).  To actually write the packed-refs file, call
103  * commit_packed_refs().
104  */
105 extern void add_packed_ref(const char *refname, const unsigned char *sha1);
106
107 /*
108  * Write the current version of the packed refs cache from memory to
109  * disk.  The packed-refs file must already be locked for writing (see
110  * lock_packed_refs()).  Return zero on success.
111  */
112 extern int commit_packed_refs(void);
113
114 /*
115  * Rollback the lockfile for the packed-refs file, and discard the
116  * in-memory packed reference cache.  (The packed-refs file will be
117  * read anew if it is needed again after this function is called.)
118  */
119 extern void rollback_packed_refs(void);
120
121 /*
122  * Flags for controlling behaviour of pack_refs()
123  * PACK_REFS_PRUNE: Prune loose refs after packing
124  * PACK_REFS_ALL:   Pack _all_ refs, not just tags and already packed refs
125  */
126 #define PACK_REFS_PRUNE 0x0001
127 #define PACK_REFS_ALL   0x0002
128
129 /*
130  * Write a packed-refs file for the current repository.
131  * flags: Combination of the above PACK_REFS_* flags.
132  */
133 int pack_refs(unsigned int flags);
134
135 extern int repack_without_refs(const char **refnames, int n);
136
137 extern int ref_exists(const char *);
138
139 /*
140  * If refname is a non-symbolic reference that refers to a tag object,
141  * and the tag can be (recursively) dereferenced to a non-tag object,
142  * store the SHA1 of the referred-to object to sha1 and return 0.  If
143  * any of these conditions are not met, return a non-zero value.
144  * Symbolic references are considered unpeelable, even if they
145  * ultimately resolve to a peelable tag.
146  */
147 extern int peel_ref(const char *refname, unsigned char *sha1);
148
149 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
150 extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
151
152 /** Locks any ref (for 'HEAD' type refs). */
153 #define REF_NODEREF     0x01
154 extern struct ref_lock *lock_any_ref_for_update(const char *refname,
155                                                 const unsigned char *old_sha1,
156                                                 int flags, int *type_p);
157
158 /** Close the file descriptor owned by a lock and return the status */
159 extern int close_ref(struct ref_lock *lock);
160
161 /** Close and commit the ref locked by the lock */
162 extern int commit_ref(struct ref_lock *lock);
163
164 /** Release any lock taken but not written. **/
165 extern void unlock_ref(struct ref_lock *lock);
166
167 /** Writes sha1 into the ref specified by the lock. **/
168 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
169
170 /** Setup reflog before using. **/
171 int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
172
173 /** Reads log for the value of ref during at_time. **/
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);
177
178 /* iterate over reflog entries */
179 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
180 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
181 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
182
183 /*
184  * Calls the specified function for each reflog file until it returns nonzero,
185  * and returns the value
186  */
187 extern int for_each_reflog(each_ref_fn, void *);
188
189 #define REFNAME_ALLOW_ONELEVEL 1
190 #define REFNAME_REFSPEC_PATTERN 2
191 #define REFNAME_DOT_COMPONENT 4
192
193 /*
194  * Return 0 iff refname has the correct format for a refname according
195  * to the rules described in Documentation/git-check-ref-format.txt.
196  * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
197  * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
198  * allow a "*" wildcard character in place of one of the name
199  * components.  No leading or repeated slashes are accepted.  If
200  * REFNAME_DOT_COMPONENT is set in flags, then allow refname
201  * components to start with "." (but not a whole component equal to
202  * "." or "..").
203  */
204 extern int check_refname_format(const char *refname, int flags);
205
206 extern const char *prettify_refname(const char *refname);
207 extern char *shorten_unambiguous_ref(const char *refname, int strict);
208
209 /** rename ref, return 0 on success **/
210 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
211
212 /**
213  * Resolve refname in the nested "gitlink" repository that is located
214  * at path.  If the resolution is successful, return 0 and set sha1 to
215  * the name of the object; otherwise, return a non-zero value.
216  */
217 extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
218
219 /** lock a ref and then write its file */
220 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
221 int update_ref(const char *action, const char *refname,
222                 const unsigned char *sha1, const unsigned char *oldval,
223                 int flags, enum action_on_err onerr);
224
225 /**
226  * Lock all refs and then perform all modifications.
227  */
228 int update_refs(const char *action, const struct ref_update **updates,
229                 int n, enum action_on_err onerr);
230
231 extern int parse_hide_refs_config(const char *var, const char *value, const char *);
232 extern int ref_is_hidden(const char *);
233
234 #endif /* REFS_H */