refs.h

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