Andrew's git / gitweb.git / refs.h
?
refs.hon commit gpg-interface: provide access to the payload (71c214c)
   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
  13struct ref_transaction;
  14
  15/*
  16 * Bit values set in the flags argument passed to each_ref_fn():
  17 */
  18
  19/* Reference is a symbolic reference. */
  20#define REF_ISSYMREF 0x01
  21
  22/* Reference is a packed reference. */
  23#define REF_ISPACKED 0x02
  24
  25/*
  26 * Reference cannot be resolved to an object name: dangling symbolic
  27 * reference (directly or indirectly), corrupt reference file, or
  28 * symbolic reference refers to ill-formatted reference name.
  29 */
  30#define REF_ISBROKEN 0x04
  31
  32/*
  33 * The signature for the callback function for the for_each_*()
  34 * functions below.  The memory pointed to by the refname and sha1
  35 * arguments is only guaranteed to be valid for the duration of a
  36 * single callback invocation.
  37 */
  38typedef int each_ref_fn(const char *refname,
  39                        const unsigned char *sha1, int flags, void *cb_data);
  40
  41/*
  42 * The following functions invoke the specified callback function for
  43 * each reference indicated.  If the function ever returns a nonzero
  44 * value, stop the iteration and return that value.  Please note that
  45 * it is not safe to modify references while an iteration is in
  46 * progress, unless the same callback function invocation that
  47 * modifies the reference also returns a nonzero value to immediately
  48 * stop the iteration.
  49 */
  50extern int head_ref(each_ref_fn, void *);
  51extern int for_each_ref(each_ref_fn, void *);
  52extern int for_each_ref_in(const char *, each_ref_fn, void *);
  53extern int for_each_tag_ref(each_ref_fn, void *);
  54extern int for_each_branch_ref(each_ref_fn, void *);
  55extern int for_each_remote_ref(each_ref_fn, void *);
  56extern int for_each_replace_ref(each_ref_fn, void *);
  57extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
  58extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
  59
  60extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  61extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  62extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
  63                each_ref_fn fn, void *cb_data);
  64extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  65extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  66extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
  67
  68extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
  69extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
  70
  71static inline const char *has_glob_specials(const char *pattern)
  72{
  73        return strpbrk(pattern, "?*[");
  74}
  75
  76/* can be used to learn about broken ref and symref */
  77extern int for_each_rawref(each_ref_fn, void *);
  78
  79extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
  80
  81/*
  82 * Lock the packed-refs file for writing.  Flags is passed to
  83 * hold_lock_file_for_update().  Return 0 on success.
  84 */
  85extern int lock_packed_refs(int flags);
  86
  87/*
  88 * Add a reference to the in-memory packed reference cache.  This may
  89 * only be called while the packed-refs file is locked (see
  90 * lock_packed_refs()).  To actually write the packed-refs file, call
  91 * commit_packed_refs().
  92 */
  93extern void add_packed_ref(const char *refname, const unsigned char *sha1);
  94
  95/*
  96 * Write the current version of the packed refs cache from memory to
  97 * disk.  The packed-refs file must already be locked for writing (see
  98 * lock_packed_refs()).  Return zero on success.
  99 */
 100extern int commit_packed_refs(void);
 101
 102/*
 103 * Rollback the lockfile for the packed-refs file, and discard the
 104 * in-memory packed reference cache.  (The packed-refs file will be
 105 * read anew if it is needed again after this function is called.)
 106 */
 107extern void rollback_packed_refs(void);
 108
 109/*
 110 * Flags for controlling behaviour of pack_refs()
 111 * PACK_REFS_PRUNE: Prune loose refs after packing
 112 * PACK_REFS_ALL:   Pack _all_ refs, not just tags and already packed refs
 113 */
 114#define PACK_REFS_PRUNE 0x0001
 115#define PACK_REFS_ALL   0x0002
 116
 117/*
 118 * Write a packed-refs file for the current repository.
 119 * flags: Combination of the above PACK_REFS_* flags.
 120 */
 121int pack_refs(unsigned int flags);
 122
 123extern int ref_exists(const char *);
 124
 125/*
 126 * If refname is a non-symbolic reference that refers to a tag object,
 127 * and the tag can be (recursively) dereferenced to a non-tag object,
 128 * store the SHA1 of the referred-to object to sha1 and return 0.  If
 129 * any of these conditions are not met, return a non-zero value.
 130 * Symbolic references are considered unpeelable, even if they
 131 * ultimately resolve to a peelable tag.
 132 */
 133extern int peel_ref(const char *refname, unsigned char *sha1);
 134
 135/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
 136extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
 137
 138/** Locks any ref (for 'HEAD' type refs). */
 139#define REF_NODEREF     0x01
 140extern struct ref_lock *lock_any_ref_for_update(const char *refname,
 141                                                const unsigned char *old_sha1,
 142                                                int flags, int *type_p);
 143
 144/** Close the file descriptor owned by a lock and return the status */
 145extern int close_ref(struct ref_lock *lock);
 146
 147/** Close and commit the ref locked by the lock */
 148extern int commit_ref(struct ref_lock *lock);
 149
 150/** Release any lock taken but not written. **/
 151extern void unlock_ref(struct ref_lock *lock);
 152
 153/** Writes sha1 into the ref specified by the lock. **/
 154extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
 155
 156/** Setup reflog before using. **/
 157int log_ref_setup(const char *refname, char *logfile, int bufsize);
 158
 159/** Reads log for the value of ref during at_time. **/
 160extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
 161                       unsigned char *sha1, char **msg,
 162                       unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
 163
 164/** Check if a particular reflog exists */
 165extern int reflog_exists(const char *refname);
 166
 167/** Delete a reflog */
 168extern int delete_reflog(const char *refname);
 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
 211enum action_on_err {
 212        UPDATE_REFS_MSG_ON_ERR,
 213        UPDATE_REFS_DIE_ON_ERR,
 214        UPDATE_REFS_QUIET_ON_ERR
 215};
 216
 217/*
 218 * Begin a reference transaction.  The reference transaction must
 219 * eventually be commited using ref_transaction_commit() or rolled
 220 * back using ref_transaction_rollback().
 221 */
 222struct ref_transaction *ref_transaction_begin(void);
 223
 224/*
 225 * Roll back a ref_transaction and free all associated data.
 226 */
 227void ref_transaction_rollback(struct ref_transaction *transaction);
 228
 229
 230/*
 231 * The following functions add a reference check or update to a
 232 * ref_transaction.  In all of them, refname is the name of the
 233 * reference to be affected.  The functions make internal copies of
 234 * refname, so the caller retains ownership of the parameter.  flags
 235 * can be REF_NODEREF; it is passed to update_ref_lock().
 236 */
 237
 238
 239/*
 240 * Add a reference update to transaction.  new_sha1 is the value that
 241 * the reference should have after the update, or zeros if it should
 242 * be deleted.  If have_old is true, then old_sha1 holds the value
 243 * that the reference should have had before the update, or zeros if
 244 * it must not have existed beforehand.
 245 */
 246void ref_transaction_update(struct ref_transaction *transaction,
 247                            const char *refname,
 248                            unsigned char *new_sha1, unsigned char *old_sha1,
 249                            int flags, int have_old);
 250
 251/*
 252 * Add a reference creation to transaction.  new_sha1 is the value
 253 * that the reference should have after the update; it must not be the
 254 * null SHA-1.  It is verified that the reference does not exist
 255 * already.
 256 */
 257void ref_transaction_create(struct ref_transaction *transaction,
 258                            const char *refname,
 259                            unsigned char *new_sha1,
 260                            int flags);
 261
 262/*
 263 * Add a reference deletion to transaction.  If have_old is true, then
 264 * old_sha1 holds the value that the reference should have had before
 265 * the update (which must not be the null SHA-1).
 266 */
 267void ref_transaction_delete(struct ref_transaction *transaction,
 268                            const char *refname,
 269                            unsigned char *old_sha1,
 270                            int flags, int have_old);
 271
 272/*
 273 * Commit all of the changes that have been queued in transaction, as
 274 * atomically as possible.  Return a nonzero value if there is a
 275 * problem.  The ref_transaction is freed by this function.
 276 */
 277int ref_transaction_commit(struct ref_transaction *transaction,
 278                           const char *msg, enum action_on_err onerr);
 279
 280/** Lock a ref and then write its file */
 281int update_ref(const char *action, const char *refname,
 282                const unsigned char *sha1, const unsigned char *oldval,
 283                int flags, enum action_on_err onerr);
 284
 285extern int parse_hide_refs_config(const char *var, const char *value, const char *);
 286extern int ref_is_hidden(const char *);
 287
 288#endif /* REFS_H */