Andrew's git - gitweb.git/blob

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