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