Andrew's git / gitweb.git / refs.h
?
refs.hon commit t6050-replace: use some long option names (b1ecd8c)
   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/*
  14 * Bit values set in the flags argument passed to each_ref_fn():
  15 */
  16
  17/* Reference is a symbolic reference. */
  18#define REF_ISSYMREF 0x01
  19
  20/* Reference is a packed reference. */
  21#define REF_ISPACKED 0x02
  22
  23/*
  24 * Reference cannot be resolved to an object name: dangling symbolic
  25 * reference (directly or indirectly), corrupt reference file, or
  26 * symbolic reference refers to ill-formatted reference name.
  27 */
  28#define REF_ISBROKEN 0x04
  29
  30/*
  31 * The signature for the callback function for the for_each_*()
  32 * functions below.  The memory pointed to by the refname and sha1
  33 * arguments is only guaranteed to be valid for the duration of a
  34 * single callback invocation.
  35 */
  36typedef int each_ref_fn(const char *refname,
  37                        const unsigned char *sha1, int flags, void *cb_data);
  38
  39/*
  40 * The following functions invoke the specified callback function for
  41 * each reference indicated.  If the function ever returns a nonzero
  42 * value, stop the iteration and return that value.  Please note that
  43 * it is not safe to modify references while an iteration is in
  44 * progress, unless the same callback function invocation that
  45 * modifies the reference also returns a nonzero value to immediately
  46 * stop the iteration.
  47 */
  48extern int head_ref(each_ref_fn, void *);
  49extern int for_each_ref(each_ref_fn, void *);
  50extern int for_each_ref_in(const char *, each_ref_fn, void *);
  51extern int for_each_tag_ref(each_ref_fn, void *);
  52extern int for_each_branch_ref(each_ref_fn, void *);
  53extern int for_each_remote_ref(each_ref_fn, void *);
  54extern int for_each_replace_ref(each_ref_fn, void *);
  55extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
  56extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
  57
  58extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  59extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  60extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
  61                each_ref_fn fn, void *cb_data);
  62extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  63extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  64extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  65
  66extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
  67extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
  68
  69static inline const char *has_glob_specials(const char *pattern)
  70{
  71        return strpbrk(pattern, "?*[");
  72}
  73
  74/* can be used to learn about broken ref and symref */
  75extern int for_each_rawref(each_ref_fn, void *);
  76
  77extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
  78
  79/*
  80 * Lock the packed-refs file for writing.  Flags is passed to
  81 * hold_lock_file_for_update().  Return 0 on success.
  82 */
  83extern int lock_packed_refs(int flags);
  84
  85/*
  86 * Add a reference to the in-memory packed reference cache.  This may
  87 * only be called while the packed-refs file is locked (see
  88 * lock_packed_refs()).  To actually write the packed-refs file, call
  89 * commit_packed_refs().
  90 */
  91extern void add_packed_ref(const char *refname, const unsigned char *sha1);
  92
  93/*
  94 * Write the current version of the packed refs cache from memory to
  95 * disk.  The packed-refs file must already be locked for writing (see
  96 * lock_packed_refs()).  Return zero on success.
  97 */
  98extern int commit_packed_refs(void);
  99
 100/*
 101 * Rollback the lockfile for the packed-refs file, and discard the
 102 * in-memory packed reference cache.  (The packed-refs file will be
 103 * read anew if it is needed again after this function is called.)
 104 */
 105extern void rollback_packed_refs(void);
 106
 107/*
 108 * Flags for controlling behaviour of pack_refs()
 109 * PACK_REFS_PRUNE: Prune loose refs after packing
 110 * PACK_REFS_ALL:   Pack _all_ refs, not just tags and already packed refs
 111 */
 112#define PACK_REFS_PRUNE 0x0001
 113#define PACK_REFS_ALL   0x0002
 114
 115/*
 116 * Write a packed-refs file for the current repository.
 117 * flags: Combination of the above PACK_REFS_* flags.
 118 */
 119int pack_refs(unsigned int flags);
 120
 121extern int ref_exists(const char *);
 122
 123/*
 124 * If refname is a non-symbolic reference that refers to a tag object,
 125 * and the tag can be (recursively) dereferenced to a non-tag object,
 126 * store the SHA1 of the referred-to object to sha1 and return 0.  If
 127 * any of these conditions are not met, return a non-zero value.
 128 * Symbolic references are considered unpeelable, even if they
 129 * ultimately resolve to a peelable tag.
 130 */
 131extern int peel_ref(const char *refname, unsigned char *sha1);
 132
 133/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
 134extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
 135
 136/** Locks any ref (for 'HEAD' type refs). */
 137#define REF_NODEREF     0x01
 138extern struct ref_lock *lock_any_ref_for_update(const char *refname,
 139                                                const unsigned char *old_sha1,
 140                                                int flags);
 141
 142/** Close the file descriptor owned by a lock and return the status */
 143extern int close_ref(struct ref_lock *lock);
 144
 145/** Close and commit the ref locked by the lock */
 146extern int commit_ref(struct ref_lock *lock);
 147
 148/** Release any lock taken but not written. **/
 149extern void unlock_ref(struct ref_lock *lock);
 150
 151/** Writes sha1 into the ref specified by the lock. **/
 152extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
 153
 154/*
 155 * Invalidate the reference cache for the specified submodule.  Use
 156 * submodule=NULL to invalidate the cache for the main module.  This
 157 * function must be called if references are changed via a mechanism
 158 * other than the refs API.
 159 */
 160extern void invalidate_ref_cache(const char *submodule);
 161
 162/** Setup reflog before using. **/
 163int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
 164
 165/** Reads log for the value of ref during at_time. **/
 166extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
 167                       unsigned char *sha1, char **msg,
 168                       unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
 169
 170/* iterate over reflog entries */
 171typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
 172int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 173int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
 174
 175/*
 176 * Calls the specified function for each reflog file until it returns nonzero,
 177 * and returns the value
 178 */
 179extern int for_each_reflog(each_ref_fn, void *);
 180
 181#define REFNAME_ALLOW_ONELEVEL 1
 182#define REFNAME_REFSPEC_PATTERN 2
 183#define REFNAME_DOT_COMPONENT 4
 184
 185/*
 186 * Return 0 iff refname has the correct format for a refname according
 187 * to the rules described in Documentation/git-check-ref-format.txt.
 188 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
 189 * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
 190 * allow a "*" wildcard character in place of one of the name
 191 * components.  No leading or repeated slashes are accepted.  If
 192 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
 193 * components to start with "." (but not a whole component equal to
 194 * "." or "..").
 195 */
 196extern int check_refname_format(const char *refname, int flags);
 197
 198extern const char *prettify_refname(const char *refname);
 199extern char *shorten_unambiguous_ref(const char *refname, int strict);
 200
 201/** rename ref, return 0 on success **/
 202extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
 203
 204/**
 205 * Resolve refname in the nested "gitlink" repository that is located
 206 * at path.  If the resolution is successful, return 0 and set sha1 to
 207 * the name of the object; otherwise, return a non-zero value.
 208 */
 209extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
 210
 211/** lock a ref and then write its file */
 212enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
 213int update_ref(const char *action, const char *refname,
 214                const unsigned char *sha1, const unsigned char *oldval,
 215                int flags, enum action_on_err onerr);
 216
 217extern int parse_hide_refs_config(const char *var, const char *value, const char *);
 218extern int ref_is_hidden(const char *);
 219
 220#endif /* REFS_H */