src/refs.h

   1 /*
   2  * Copyright (C) the libgit2 contributors. All rights reserved.
   3  *
   4  * This file is part of libgit2, distributed under the GNU GPL v2 with
   5  * a Linking Exception. For full terms see the included COPYING file.
   6  */
   7 #ifndef INCLUDE_refs_h__
   8 #define INCLUDE_refs_h__
   9
  10 #include "common.h"
  11 #include "git2/oid.h"
  12 #include "git2/refs.h"
  13 #include "git2/refdb.h"
  14 #include "strmap.h"
  15 #include "buffer.h"
  16 #include "oid.h"
  17
  18 extern bool git_reference__enable_symbolic_ref_target_validation;
  19
  20 #define GIT_REFS_DIR "refs/"
  21 #define GIT_REFS_HEADS_DIR GIT_REFS_DIR "heads/"
  22 #define GIT_REFS_TAGS_DIR GIT_REFS_DIR "tags/"
  23 #define GIT_REFS_REMOTES_DIR GIT_REFS_DIR "remotes/"
  24 #define GIT_REFS_NOTES_DIR GIT_REFS_DIR "notes/"
  25 #define GIT_REFS_DIR_MODE 0777
  26 #define GIT_REFS_FILE_MODE 0666
  27
  28 #define GIT_RENAMED_REF_FILE GIT_REFS_DIR "RENAMED-REF"
  29
  30 #define GIT_SYMREF "ref: "
  31 #define GIT_PACKEDREFS_FILE "packed-refs"
  32 #define GIT_PACKEDREFS_HEADER "# pack-refs with: peeled fully-peeled "
  33 #define GIT_PACKEDREFS_FILE_MODE 0666
  34
  35 #define GIT_HEAD_FILE "HEAD"
  36 #define GIT_ORIG_HEAD_FILE "ORIG_HEAD"
  37 #define GIT_FETCH_HEAD_FILE "FETCH_HEAD"
  38 #define GIT_MERGE_HEAD_FILE "MERGE_HEAD"
  39 #define GIT_REVERT_HEAD_FILE "REVERT_HEAD"
  40 #define GIT_CHERRYPICK_HEAD_FILE "CHERRY_PICK_HEAD"
  41 #define GIT_BISECT_LOG_FILE "BISECT_LOG"
  42 #define GIT_REBASE_MERGE_DIR "rebase-merge/"
  43 #define GIT_REBASE_MERGE_INTERACTIVE_FILE GIT_REBASE_MERGE_DIR "interactive"
  44 #define GIT_REBASE_APPLY_DIR "rebase-apply/"
  45 #define GIT_REBASE_APPLY_REBASING_FILE GIT_REBASE_APPLY_DIR "rebasing"
  46 #define GIT_REBASE_APPLY_APPLYING_FILE GIT_REBASE_APPLY_DIR "applying"
  47 #define GIT_REFS_HEADS_MASTER_FILE GIT_REFS_HEADS_DIR "master"
  48
  49 #define GIT_SEQUENCER_DIR "sequencer/"
  50 #define GIT_SEQUENCER_HEAD_FILE GIT_SEQUENCER_DIR "head"
  51 #define GIT_SEQUENCER_OPTIONS_FILE GIT_SEQUENCER_DIR "options"
  52 #define GIT_SEQUENCER_TODO_FILE GIT_SEQUENCER_DIR "todo"
  53
  54 #define GIT_STASH_FILE "stash"
  55 #define GIT_REFS_STASH_FILE GIT_REFS_DIR GIT_STASH_FILE
  56
  57 #define GIT_REF_FORMAT__PRECOMPOSE_UNICODE      (1u << 16)
  58 #define GIT_REF_FORMAT__VALIDATION_DISABLE      (1u << 15)
  59
  60 #define GIT_REFNAME_MAX 1024
  61
  62 typedef char git_refname_t[GIT_REFNAME_MAX];
  63
  64 struct git_reference {
  65         git_refdb *db;
  66         git_ref_t type;
  67
  68         union {
  69                 git_oid oid;
  70                 char *symbolic;
  71         } target;
  72
  73         git_oid peel;
  74         char name[GIT_FLEX_ARRAY];
  75 };
  76
  77 git_reference *git_reference__set_name(git_reference *ref, const char *name);
  78
  79 int git_reference__normalize_name(git_buf *buf, const char *name, unsigned int flags);
  80 int git_reference__update_terminal(git_repository *repo, const char *ref_name, const git_oid *oid, const git_signature *sig, const char *log_message);
  81 int git_reference__is_valid_name(const char *refname, unsigned int flags);
  82 int git_reference__is_branch(const char *ref_name);
  83 int git_reference__is_remote(const char *ref_name);
  84 int git_reference__is_tag(const char *ref_name);
  85 const char *git_reference__shorthand(const char *name);
  86
  87 /**
  88  * Lookup a reference by name and try to resolve to an OID.
  89  *
  90  * You can control how many dereferences this will attempt to resolve the
  91  * reference with the `max_deref` parameter, or pass -1 to use a sane
  92  * default.  If you pass 0 for `max_deref`, this will not attempt to resolve
  93  * the reference.  For any value of `max_deref` other than 0, not
  94  * successfully resolving the reference will be reported as an error.
  95
  96  * The generated reference must be freed by the user.
  97  *
  98  * @param reference_out Pointer to the looked-up reference
  99  * @param repo The repository to look up the reference
 100  * @param name The long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)
 101  * @param max_deref Maximum number of dereferences to make of symbolic refs, 0 means simple lookup, < 0 means use default reasonable value
 102  * @return 0 on success or < 0 on error; not being able to resolve the reference is an error unless 0 was passed for max_deref
 103  */
 104 int git_reference_lookup_resolved(
 105         git_reference **reference_out,
 106         git_repository *repo,
 107         const char *name,
 108         int max_deref);
 109
 110 /**
 111  * Read reference from a file.
 112  *
 113  * This function will read in the file at `path`. If it is a
 114  * symref, it will return a new unresolved symbolic reference
 115  * with the given name pointing to the reference pointed to by
 116  * the file. If it is not a symbolic reference, it will return
 117  * the resolved reference.
 118  */
 119 int git_reference__read_head(
 120         git_reference **out,
 121         git_repository *repo,
 122         const char *path);
 123
 124 int git_reference__log_signature(git_signature **out, git_repository *repo);
 125
 126 /** Update a reference after a commit. */
 127 int git_reference__update_for_commit(
 128         git_repository *repo,
 129         git_reference *ref,
 130         const char *ref_name,
 131         const git_oid *id,
 132         const char *operation);
 133
 134 #endif