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 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  */
  20 typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
  21 extern int head_ref(each_ref_fn, void *);
  22 extern int for_each_ref(each_ref_fn, void *);
  23 extern int for_each_ref_in(const char *, each_ref_fn, void *);
  24 extern int for_each_tag_ref(each_ref_fn, void *);
  25 extern int for_each_branch_ref(each_ref_fn, void *);
  26 extern int for_each_remote_ref(each_ref_fn, void *);
  27
  28 /* can be used to learn about broken ref and symref */
  29 extern int for_each_rawref(each_ref_fn, void *);
  30
  31 extern void warn_dangling_symref(const char *msg_fmt, const char *refname);
  32
  33 /*
  34  * Extra refs will be listed by for_each_ref() before any actual refs
  35  * for the duration of this process or until clear_extra_refs() is
  36  * called. Only extra refs added before for_each_ref() is called will
  37  * be listed on a given call of for_each_ref().
  38  */
  39 extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
  40 extern void clear_extra_refs(void);
  41
  42 extern int peel_ref(const char *, unsigned char *);
  43
  44 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
  45 extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
  46
  47 /** Locks any ref (for 'HEAD' type refs). */
  48 #define REF_NODEREF     0x01
  49 extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
  50
  51 /** Close the file descriptor owned by a lock and return the status */
  52 extern int close_ref(struct ref_lock *lock);
  53
  54 /** Close and commit the ref locked by the lock */
  55 extern int commit_ref(struct ref_lock *lock);
  56
  57 /** Release any lock taken but not written. **/
  58 extern void unlock_ref(struct ref_lock *lock);
  59
  60 /** Writes sha1 into the ref specified by the lock. **/
  61 extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
  62
  63 /** Reads log for the value of ref during at_time. **/
  64 extern int read_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);
  65
  66 /* iterate over reflog entries */
  67 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
  68 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
  69 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
  70
  71 /*
  72  * Calls the specified function for each reflog file until it returns nonzero,
  73  * and returns the value
  74  */
  75 extern int for_each_reflog(each_ref_fn, void *);
  76
  77 #define CHECK_REF_FORMAT_OK 0
  78 #define CHECK_REF_FORMAT_ERROR (-1)
  79 #define CHECK_REF_FORMAT_ONELEVEL (-2)
  80 #define CHECK_REF_FORMAT_WILDCARD (-3)
  81 extern int check_ref_format(const char *target);
  82
  83 extern const char *prettify_ref(const struct ref *ref);
  84 extern char *shorten_unambiguous_ref(const char *ref);
  85
  86 /** rename ref, return 0 on success **/
  87 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
  88
  89 /** resolve ref in nested "gitlink" repository */
  90 extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
  91
  92 /** lock a ref and then write its file */
  93 enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
  94 int update_ref(const char *action, const char *refname,
  95                 const unsigned char *sha1, const unsigned char *oldval,
  96                 int flags, enum action_on_err onerr);
  97
  98 #endif /* REFS_H */