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 13/* 14 * Bit values set in the flags argument passed to each_ref_fn(): 15 */ 16 17/* Reference is a symbolic reference. */ 18#define REF_ISSYMREF 0x01 19 20/* Reference is a packed reference. */ 21#define REF_ISPACKED 0x02 22 23/* 24 * Reference cannot be resolved to an object name: dangling symbolic 25 * reference (directly or indirectly), corrupt reference file, or 26 * symbolic reference refers to ill-formatted reference name. 27 */ 28#define REF_ISBROKEN 0x04 29 30/* 31 * The signature for the callback function for the for_each_*() 32 * functions below. The memory pointed to by the refname and sha1 33 * arguments is only guaranteed to be valid for the duration of a 34 * single callback invocation. 35 */ 36typedefinteach_ref_fn(const char*refname, 37const unsigned char*sha1,int flags,void*cb_data); 38 39/* 40 * The following functions invoke the specified callback function for 41 * each reference indicated. If the function ever returns a nonzero 42 * value, stop the iteration and return that value. Please note that 43 * it is not safe to modify references while an iteration is in 44 * progress, unless the same callback function invocation that 45 * modifies the reference also returns a nonzero value to immediately 46 * stop the iteration. 47 */ 48externinthead_ref(each_ref_fn,void*); 49externintfor_each_ref(each_ref_fn,void*); 50externintfor_each_ref_in(const char*, each_ref_fn,void*); 51externintfor_each_tag_ref(each_ref_fn,void*); 52externintfor_each_branch_ref(each_ref_fn,void*); 53externintfor_each_remote_ref(each_ref_fn,void*); 54externintfor_each_replace_ref(each_ref_fn,void*); 55externintfor_each_glob_ref(each_ref_fn,const char*pattern,void*); 56externintfor_each_glob_ref_in(each_ref_fn,const char*pattern,const char* prefix,void*); 57 58externinthead_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 59externintfor_each_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 60externintfor_each_ref_in_submodule(const char*submodule,const char*prefix, 61 each_ref_fn fn,void*cb_data); 62externintfor_each_tag_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 63externintfor_each_branch_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 64externintfor_each_remote_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 65 66externinthead_ref_namespaced(each_ref_fn fn,void*cb_data); 67externintfor_each_namespaced_ref(each_ref_fn fn,void*cb_data); 68 69staticinlineconst char*has_glob_specials(const char*pattern) 70{ 71returnstrpbrk(pattern,"?*["); 72} 73 74/* can be used to learn about broken ref and symref */ 75externintfor_each_rawref(each_ref_fn,void*); 76 77externvoidwarn_dangling_symref(FILE*fp,const char*msg_fmt,const char*refname); 78 79/* 80 * Add a reference to the in-memory packed reference cache. To actually 81 * write the reference to the packed-refs file, call pack_refs(). 82 */ 83externvoidadd_packed_ref(const char*refname,const unsigned char*sha1); 84 85/* 86 * Flags for controlling behaviour of pack_refs() 87 * PACK_REFS_PRUNE: Prune loose refs after packing 88 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs 89 */ 90#define PACK_REFS_PRUNE 0x0001 91#define PACK_REFS_ALL 0x0002 92 93/* 94 * Write a packed-refs file for the current repository. 95 * flags: Combination of the above PACK_REFS_* flags. 96 */ 97intpack_refs(unsigned int flags); 98 99externintref_exists(const char*); 100 101/* 102 * If refname is a non-symbolic reference that refers to a tag object, 103 * and the tag can be (recursively) dereferenced to a non-tag object, 104 * store the SHA1 of the referred-to object to sha1 and return 0. If 105 * any of these conditions are not met, return a non-zero value. 106 * Symbolic references are considered unpeelable, even if they 107 * ultimately resolve to a peelable tag. 108 */ 109externintpeel_ref(const char*refname,unsigned char*sha1); 110 111/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/ 112externstruct ref_lock *lock_ref_sha1(const char*refname,const unsigned char*old_sha1); 113 114/** Locks any ref (for 'HEAD' type refs). */ 115#define REF_NODEREF 0x01 116externstruct ref_lock *lock_any_ref_for_update(const char*refname, 117const unsigned char*old_sha1, 118int flags); 119 120/** Close the file descriptor owned by a lock and return the status */ 121externintclose_ref(struct ref_lock *lock); 122 123/** Close and commit the ref locked by the lock */ 124externintcommit_ref(struct ref_lock *lock); 125 126/** Release any lock taken but not written. **/ 127externvoidunlock_ref(struct ref_lock *lock); 128 129/** Writes sha1 into the ref specified by the lock. **/ 130externintwrite_ref_sha1(struct ref_lock *lock,const unsigned char*sha1,const char*msg); 131 132/* 133 * Invalidate the reference cache for the specified submodule. Use 134 * submodule=NULL to invalidate the cache for the main module. This 135 * function must be called if references are changed via a mechanism 136 * other than the refs API. 137 */ 138externvoidinvalidate_ref_cache(const char*submodule); 139 140/** Setup reflog before using. **/ 141intlog_ref_setup(const char*ref_name,char*logfile,int bufsize); 142 143/** Reads log for the value of ref during at_time. **/ 144externintread_ref_at(const char*refname,unsigned long at_time,int cnt, 145unsigned char*sha1,char**msg, 146unsigned long*cutoff_time,int*cutoff_tz,int*cutoff_cnt); 147 148/* iterate over reflog entries */ 149typedefinteach_reflog_ent_fn(unsigned char*osha1,unsigned char*nsha1,const char*,unsigned long,int,const char*,void*); 150intfor_each_reflog_ent(const char*refname, each_reflog_ent_fn fn,void*cb_data); 151intfor_each_reflog_ent_reverse(const char*refname, each_reflog_ent_fn fn,void*cb_data); 152 153/* 154 * Calls the specified function for each reflog file until it returns nonzero, 155 * and returns the value 156 */ 157externintfor_each_reflog(each_ref_fn,void*); 158 159#define REFNAME_ALLOW_ONELEVEL 1 160#define REFNAME_REFSPEC_PATTERN 2 161#define REFNAME_DOT_COMPONENT 4 162 163/* 164 * Return 0 iff refname has the correct format for a refname according 165 * to the rules described in Documentation/git-check-ref-format.txt. 166 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level 167 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then 168 * allow a "*" wildcard character in place of one of the name 169 * components. No leading or repeated slashes are accepted. If 170 * REFNAME_DOT_COMPONENT is set in flags, then allow refname 171 * components to start with "." (but not a whole component equal to 172 * "." or ".."). 173 */ 174externintcheck_refname_format(const char*refname,int flags); 175 176externconst char*prettify_refname(const char*refname); 177externchar*shorten_unambiguous_ref(const char*refname,int strict); 178 179/** rename ref, return 0 on success **/ 180externintrename_ref(const char*oldref,const char*newref,const char*logmsg); 181 182/** 183 * Resolve refname in the nested "gitlink" repository that is located 184 * at path. If the resolution is successful, return 0 and set sha1 to 185 * the name of the object; otherwise, return a non-zero value. 186 */ 187externintresolve_gitlink_ref(const char*path,const char*refname,unsigned char*sha1); 188 189/** lock a ref and then write its file */ 190enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR }; 191intupdate_ref(const char*action,const char*refname, 192const unsigned char*sha1,const unsigned char*oldval, 193int flags,enum action_on_err onerr); 194 195externintparse_hide_refs_config(const char*var,const char*value,const char*); 196externintref_is_hidden(const char*); 197 198#endif/* REFS_H */