1#ifndef REFS_H 2#define REFS_H 3 4struct ref_lock { 5char*ref_name; 6char*orig_ref_name; 7struct lock_file *lk; 8unsigned char old_sha1[20]; 9int lock_fd; 10int force_write; 11}; 12 13struct ref_transaction; 14 15/* 16 * Bit values set in the flags argument passed to each_ref_fn(): 17 */ 18 19/* Reference is a symbolic reference. */ 20#define REF_ISSYMREF 0x01 21 22/* Reference is a packed reference. */ 23#define REF_ISPACKED 0x02 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 */ 30#define REF_ISBROKEN 0x04 31 32/* 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 */ 38typedefinteach_ref_fn(const char*refname, 39const 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. 49 */ 50externinthead_ref(each_ref_fn,void*); 51externintfor_each_ref(each_ref_fn,void*); 52externintfor_each_ref_in(const char*, each_ref_fn,void*); 53externintfor_each_tag_ref(each_ref_fn,void*); 54externintfor_each_branch_ref(each_ref_fn,void*); 55externintfor_each_remote_ref(each_ref_fn,void*); 56externintfor_each_replace_ref(each_ref_fn,void*); 57externintfor_each_glob_ref(each_ref_fn,const char*pattern,void*); 58externintfor_each_glob_ref_in(each_ref_fn,const char*pattern,const char* prefix,void*); 59 60externinthead_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 61externintfor_each_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 62externintfor_each_ref_in_submodule(const char*submodule,const char*prefix, 63 each_ref_fn fn,void*cb_data); 64externintfor_each_tag_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 65externintfor_each_branch_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 66externintfor_each_remote_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 67 68externinthead_ref_namespaced(each_ref_fn fn,void*cb_data); 69externintfor_each_namespaced_ref(each_ref_fn fn,void*cb_data); 70 71staticinlineconst char*has_glob_specials(const char*pattern) 72{ 73returnstrpbrk(pattern,"?*["); 74} 75 76/* can be used to learn about broken ref and symref */ 77externintfor_each_rawref(each_ref_fn,void*); 78 79externvoidwarn_dangling_symref(FILE*fp,const char*msg_fmt,const char*refname); 80 81/* 82 * Lock the packed-refs file for writing. Flags is passed to 83 * hold_lock_file_for_update(). Return 0 on success. 84 */ 85externintlock_packed_refs(int flags); 86 87/* 88 * Add a reference to the in-memory packed reference cache. This may 89 * only be called while the packed-refs file is locked (see 90 * lock_packed_refs()). To actually write the packed-refs file, call 91 * commit_packed_refs(). 92 */ 93externvoidadd_packed_ref(const char*refname,const unsigned char*sha1); 94 95/* 96 * Write the current version of the packed refs cache from memory to 97 * disk. The packed-refs file must already be locked for writing (see 98 * lock_packed_refs()). Return zero on success. 99 */ 100externintcommit_packed_refs(void); 101 102/* 103 * Rollback the lockfile for the packed-refs file, and discard the 104 * in-memory packed reference cache. (The packed-refs file will be 105 * read anew if it is needed again after this function is called.) 106 */ 107externvoidrollback_packed_refs(void); 108 109/* 110 * Flags for controlling behaviour of pack_refs() 111 * PACK_REFS_PRUNE: Prune loose refs after packing 112 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs 113 */ 114#define PACK_REFS_PRUNE 0x0001 115#define PACK_REFS_ALL 0x0002 116 117/* 118 * Write a packed-refs file for the current repository. 119 * flags: Combination of the above PACK_REFS_* flags. 120 */ 121intpack_refs(unsigned int flags); 122 123externintref_exists(const char*); 124 125/* 126 * If refname is a non-symbolic reference that refers to a tag object, 127 * and the tag can be (recursively) dereferenced to a non-tag object, 128 * store the SHA1 of the referred-to object to sha1 and return 0. If 129 * any of these conditions are not met, return a non-zero value. 130 * Symbolic references are considered unpeelable, even if they 131 * ultimately resolve to a peelable tag. 132 */ 133externintpeel_ref(const char*refname,unsigned char*sha1); 134 135/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/ 136externstruct ref_lock *lock_ref_sha1(const char*refname,const unsigned char*old_sha1); 137 138/** Locks any ref (for 'HEAD' type refs). */ 139#define REF_NODEREF 0x01 140externstruct ref_lock *lock_any_ref_for_update(const char*refname, 141const unsigned char*old_sha1, 142int flags,int*type_p); 143 144/** Close the file descriptor owned by a lock and return the status */ 145externintclose_ref(struct ref_lock *lock); 146 147/** Close and commit the ref locked by the lock */ 148externintcommit_ref(struct ref_lock *lock); 149 150/** Release any lock taken but not written. **/ 151externvoidunlock_ref(struct ref_lock *lock); 152 153/** Writes sha1 into the ref specified by the lock. **/ 154externintwrite_ref_sha1(struct ref_lock *lock,const unsigned char*sha1,const char*msg); 155 156/** Setup reflog before using. **/ 157intlog_ref_setup(const char*refname,char*logfile,int bufsize); 158 159/** Reads log for the value of ref during at_time. **/ 160externintread_ref_at(const char*refname,unsigned long at_time,int cnt, 161unsigned char*sha1,char**msg, 162unsigned long*cutoff_time,int*cutoff_tz,int*cutoff_cnt); 163 164/* iterate over reflog entries */ 165typedefinteach_reflog_ent_fn(unsigned char*osha1,unsigned char*nsha1,const char*,unsigned long,int,const char*,void*); 166intfor_each_reflog_ent(const char*refname, each_reflog_ent_fn fn,void*cb_data); 167intfor_each_reflog_ent_reverse(const char*refname, each_reflog_ent_fn fn,void*cb_data); 168 169/* 170 * Calls the specified function for each reflog file until it returns nonzero, 171 * and returns the value 172 */ 173externintfor_each_reflog(each_ref_fn,void*); 174 175#define REFNAME_ALLOW_ONELEVEL 1 176#define REFNAME_REFSPEC_PATTERN 2 177#define REFNAME_DOT_COMPONENT 4 178 179/* 180 * Return 0 iff refname has the correct format for a refname according 181 * to the rules described in Documentation/git-check-ref-format.txt. 182 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level 183 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then 184 * allow a "*" wildcard character in place of one of the name 185 * components. No leading or repeated slashes are accepted. If 186 * REFNAME_DOT_COMPONENT is set in flags, then allow refname 187 * components to start with "." (but not a whole component equal to 188 * "." or ".."). 189 */ 190externintcheck_refname_format(const char*refname,int flags); 191 192externconst char*prettify_refname(const char*refname); 193externchar*shorten_unambiguous_ref(const char*refname,int strict); 194 195/** rename ref, return 0 on success **/ 196externintrename_ref(const char*oldref,const char*newref,const char*logmsg); 197 198/** 199 * Resolve refname in the nested "gitlink" repository that is located 200 * at path. If the resolution is successful, return 0 and set sha1 to 201 * the name of the object; otherwise, return a non-zero value. 202 */ 203externintresolve_gitlink_ref(const char*path,const char*refname,unsigned char*sha1); 204 205enum action_on_err { 206 UPDATE_REFS_MSG_ON_ERR, 207 UPDATE_REFS_DIE_ON_ERR, 208 UPDATE_REFS_QUIET_ON_ERR 209}; 210 211/* 212 * Begin a reference transaction. The reference transaction must 213 * eventually be commited using ref_transaction_commit() or rolled 214 * back using ref_transaction_rollback(). 215 */ 216struct ref_transaction *ref_transaction_begin(void); 217 218/* 219 * Roll back a ref_transaction and free all associated data. 220 */ 221voidref_transaction_rollback(struct ref_transaction *transaction); 222 223 224/* 225 * The following functions add a reference check or update to a 226 * ref_transaction. In all of them, refname is the name of the 227 * reference to be affected. The functions make internal copies of 228 * refname, so the caller retains ownership of the parameter. flags 229 * can be REF_NODEREF; it is passed to update_ref_lock(). 230 */ 231 232 233/* 234 * Add a reference update to transaction. new_sha1 is the value that 235 * the reference should have after the update, or zeros if it should 236 * be deleted. If have_old is true, then old_sha1 holds the value 237 * that the reference should have had before the update, or zeros if 238 * it must not have existed beforehand. 239 */ 240voidref_transaction_update(struct ref_transaction *transaction, 241const char*refname, 242unsigned char*new_sha1,unsigned char*old_sha1, 243int flags,int have_old); 244 245/* 246 * Add a reference creation to transaction. new_sha1 is the value 247 * that the reference should have after the update; it must not be the 248 * null SHA-1. It is verified that the reference does not exist 249 * already. 250 */ 251voidref_transaction_create(struct ref_transaction *transaction, 252const char*refname, 253unsigned char*new_sha1, 254int flags); 255 256/* 257 * Add a reference deletion to transaction. If have_old is true, then 258 * old_sha1 holds the value that the reference should have had before 259 * the update (which must not be the null SHA-1). 260 */ 261voidref_transaction_delete(struct ref_transaction *transaction, 262const char*refname, 263unsigned char*old_sha1, 264int flags,int have_old); 265 266/* 267 * Commit all of the changes that have been queued in transaction, as 268 * atomically as possible. Return a nonzero value if there is a 269 * problem. The ref_transaction is freed by this function. 270 */ 271intref_transaction_commit(struct ref_transaction *transaction, 272const char*msg,enum action_on_err onerr); 273 274/** Lock a ref and then write its file */ 275intupdate_ref(const char*action,const char*refname, 276const unsigned char*sha1,const unsigned char*oldval, 277int flags,enum action_on_err onerr); 278 279externintparse_hide_refs_config(const char*var,const char*value,const char*); 280externintref_is_hidden(const char*); 281 282#endif/* REFS_H */