1#ifndef REFS_H 2#define REFS_H 3 4struct 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 * 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 * Calls the specified function for each ref file until it returns 32 * nonzero, and returns the value. Please note that it is not safe to 33 * modify references while an iteration is in progress, unless the 34 * same callback function invocation that modifies the reference also 35 * returns a nonzero value to immediately stop the iteration. 36 */ 37typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data); 38extern int head_ref(each_ref_fn, void *); 39extern int for_each_ref(each_ref_fn, void *); 40extern int for_each_ref_in(const char *, each_ref_fn, void *); 41extern int for_each_tag_ref(each_ref_fn, void *); 42extern int for_each_branch_ref(each_ref_fn, void *); 43extern int for_each_remote_ref(each_ref_fn, void *); 44extern int for_each_replace_ref(each_ref_fn, void *); 45extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *); 46extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *); 47 48extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 49extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 50extern int for_each_ref_in_submodule(const char *submodule, const char *prefix, 51 each_ref_fn fn, void *cb_data); 52extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 53extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 54extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); 55 56extern int head_ref_namespaced(each_ref_fn fn, void *cb_data); 57extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); 58 59static inline const char *has_glob_specials(const char *pattern) 60{ 61 return strpbrk(pattern, "?*["); 62} 63 64/* can be used to learn about broken ref and symref */ 65extern int for_each_rawref(each_ref_fn, void *); 66 67extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); 68 69/* 70 * Add a reference to the in-memory packed reference cache. To actually 71 * write the reference to the packed-refs file, call pack_refs(). 72 */ 73extern void add_packed_ref(const char *refname, const unsigned char *sha1); 74 75extern int ref_exists(const char *); 76 77/* 78 * If refname is a non-symbolic reference that refers to a tag object, 79 * and the tag can be (recursively) dereferenced to a non-tag object, 80 * store the SHA1 of the referred-to object to sha1 and return 0. If 81 * any of these conditions are not met, return a non-zero value. 82 * Symbolic references are considered unpeelable, even if they 83 * ultimately resolve to a peelable tag. 84 */ 85extern int peel_ref(const char *refname, unsigned char *sha1); 86 87/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/ 88extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1); 89 90/** Locks any ref (for 'HEAD' type refs). */ 91#define REF_NODEREF 0x01 92extern struct ref_lock *lock_any_ref_for_update(const char *refname, 93 const unsigned char *old_sha1, 94 int flags); 95 96/** Close the file descriptor owned by a lock and return the status */ 97extern int close_ref(struct ref_lock *lock); 98 99/** Close and commit the ref locked by the lock */ 100extern int commit_ref(struct ref_lock *lock); 101 102/** Release any lock taken but not written. **/ 103extern void unlock_ref(struct ref_lock *lock); 104 105/** Writes sha1 into the ref specified by the lock. **/ 106extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg); 107 108/* 109 * Invalidate the reference cache for the specified submodule. Use 110 * submodule=NULL to invalidate the cache for the main module. This 111 * function must be called if references are changed via a mechanism 112 * other than the refs API. 113 */ 114extern void invalidate_ref_cache(const char *submodule); 115 116/** Setup reflog before using. **/ 117int log_ref_setup(const char *ref_name, char *logfile, int bufsize); 118 119/** Reads log for the value of ref during at_time. **/ 120extern int read_ref_at(const char *refname, unsigned long at_time, int cnt, 121 unsigned char *sha1, char **msg, 122 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt); 123 124/* iterate over reflog entries */ 125typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *); 126int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); 127int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long, void *cb_data); 128 129/* 130 * Calls the specified function for each reflog file until it returns nonzero, 131 * and returns the value 132 */ 133extern int for_each_reflog(each_ref_fn, void *); 134 135#define REFNAME_ALLOW_ONELEVEL 1 136#define REFNAME_REFSPEC_PATTERN 2 137#define REFNAME_DOT_COMPONENT 4 138 139/* 140 * Return 0 iff refname has the correct format for a refname according 141 * to the rules described in Documentation/git-check-ref-format.txt. 142 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level 143 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then 144 * allow a "*" wildcard character in place of one of the name 145 * components. No leading or repeated slashes are accepted. If 146 * REFNAME_DOT_COMPONENT is set in flags, then allow refname 147 * components to start with "." (but not a whole component equal to 148 * "." or ".."). 149 */ 150extern int check_refname_format(const char *refname, int flags); 151 152extern const char *prettify_refname(const char *refname); 153extern char *shorten_unambiguous_ref(const char *refname, int strict); 154 155/** rename ref, return 0 on success **/ 156extern int rename_ref(const char *oldref, const char *newref, const char *logmsg); 157 158/** 159 * Resolve refname in the nested "gitlink" repository that is located 160 * at path. If the resolution is successful, return 0 and set sha1 to 161 * the name of the object; otherwise, return a non-zero value. 162 */ 163extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1); 164 165/** lock a ref and then write its file */ 166enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR }; 167int update_ref(const char *action, const char *refname, 168 const unsigned char *sha1, const unsigned char *oldval, 169 int flags, enum action_on_err onerr); 170 171#endif /* REFS_H */