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