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