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#define REF_ISSYMREF 01 14#define REF_ISPACKED 02 15 16/* 17 * Calls the specified function for each ref file until it returns nonzero, 18 * and returns the value 19 */ 20typedefinteach_ref_fn(const char*refname,const unsigned char*sha1,int flags,void*cb_data); 21externinthead_ref(each_ref_fn,void*); 22externintfor_each_ref(each_ref_fn,void*); 23externintfor_each_ref_in(const char*, each_ref_fn,void*); 24externintfor_each_tag_ref(each_ref_fn,void*); 25externintfor_each_branch_ref(each_ref_fn,void*); 26externintfor_each_remote_ref(each_ref_fn,void*); 27externintfor_each_replace_ref(each_ref_fn,void*); 28externintfor_each_glob_ref(each_ref_fn,const char*pattern,void*); 29externintfor_each_glob_ref_in(each_ref_fn,const char*pattern,const char* prefix,void*); 30 31externinthead_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 32externintfor_each_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 33externintfor_each_ref_in_submodule(const char*submodule,const char*prefix, 34 each_ref_fn fn,void*cb_data); 35externintfor_each_tag_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 36externintfor_each_branch_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 37externintfor_each_remote_ref_submodule(const char*submodule, each_ref_fn fn,void*cb_data); 38 39externinthead_ref_namespaced(each_ref_fn fn,void*cb_data); 40externintfor_each_namespaced_ref(each_ref_fn fn,void*cb_data); 41 42staticinlineconst char*has_glob_specials(const char*pattern) 43{ 44returnstrpbrk(pattern,"?*["); 45} 46 47/* can be used to learn about broken ref and symref */ 48externintfor_each_rawref(each_ref_fn,void*); 49 50externvoidwarn_dangling_symref(FILE*fp,const char*msg_fmt,const char*refname); 51 52/* 53 * Extra refs will be listed by for_each_ref() before any actual refs 54 * for the duration of this process or until clear_extra_refs() is 55 * called. Only extra refs added before for_each_ref() is called will 56 * be listed on a given call of for_each_ref(). 57 */ 58externvoidadd_extra_ref(const char*refname,const unsigned char*sha1,int flags); 59externvoidclear_extra_refs(void); 60externintref_exists(const char*); 61 62externintpeel_ref(const char*,unsigned char*); 63 64/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/ 65externstruct ref_lock *lock_ref_sha1(const char*ref,const unsigned char*old_sha1); 66 67/** Locks any ref (for 'HEAD' type refs). */ 68#define REF_NODEREF 0x01 69externstruct ref_lock *lock_any_ref_for_update(const char*ref,const unsigned char*old_sha1,int flags); 70 71/** Close the file descriptor owned by a lock and return the status */ 72externintclose_ref(struct ref_lock *lock); 73 74/** Close and commit the ref locked by the lock */ 75externintcommit_ref(struct ref_lock *lock); 76 77/** Release any lock taken but not written. **/ 78externvoidunlock_ref(struct ref_lock *lock); 79 80/** Writes sha1 into the ref specified by the lock. **/ 81externintwrite_ref_sha1(struct ref_lock *lock,const unsigned char*sha1,const char*msg); 82 83/* 84 * Invalidate the reference cache for the specified submodule. Use 85 * submodule=NULL to invalidate the cache for the main module. This 86 * function must be called if references are changed via a mechanism 87 * other than the refs API. 88 */ 89externvoidinvalidate_ref_cache(const char*submodule); 90 91/** Setup reflog before using. **/ 92intlog_ref_setup(const char*ref_name,char*logfile,int bufsize); 93 94/** Reads log for the value of ref during at_time. **/ 95externintread_ref_at(const char*ref,unsigned long at_time,int cnt,unsigned char*sha1,char**msg,unsigned long*cutoff_time,int*cutoff_tz,int*cutoff_cnt); 96 97/* iterate over reflog entries */ 98typedefinteach_reflog_ent_fn(unsigned char*osha1,unsigned char*nsha1,const char*,unsigned long,int,const char*,void*); 99intfor_each_reflog_ent(const char*ref, each_reflog_ent_fn fn,void*cb_data); 100intfor_each_recent_reflog_ent(const char*ref, each_reflog_ent_fn fn,long,void*cb_data); 101 102/* 103 * Calls the specified function for each reflog file until it returns nonzero, 104 * and returns the value 105 */ 106externintfor_each_reflog(each_ref_fn,void*); 107 108#define REFNAME_ALLOW_ONELEVEL 1 109#define REFNAME_REFSPEC_PATTERN 2 110#define REFNAME_DOT_COMPONENT 4 111 112/* 113 * Return 0 iff ref has the correct format for a refname according to 114 * the rules described in Documentation/git-check-ref-format.txt. If 115 * REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level 116 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then 117 * allow a "*" wildcard character in place of one of the name 118 * components. No leading or repeated slashes are accepted. If 119 * REFNAME_DOT_COMPONENT is set in flags, then allow refname 120 * components to start with "." (but not a whole component equal to 121 * "." or ".."). 122 */ 123externintcheck_refname_format(const char*ref,int flags); 124 125externconst char*prettify_refname(const char*refname); 126externchar*shorten_unambiguous_ref(const char*ref,int strict); 127 128/** rename ref, return 0 on success **/ 129externintrename_ref(const char*oldref,const char*newref,const char*logmsg); 130 131/** resolve ref in nested "gitlink" repository */ 132externintresolve_gitlink_ref(const char*name,const char*refname,unsigned char*result); 133 134/** lock a ref and then write its file */ 135enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR }; 136intupdate_ref(const char*action,const char*refname, 137const unsigned char*sha1,const unsigned char*oldval, 138int flags,enum action_on_err onerr); 139 140#endif/* REFS_H */