Blame src/refs.h

Packit Service 20376f
/*
Packit Service 20376f
 * Copyright (C) the libgit2 contributors. All rights reserved.
Packit Service 20376f
 *
Packit Service 20376f
 * This file is part of libgit2, distributed under the GNU GPL v2 with
Packit Service 20376f
 * a Linking Exception. For full terms see the included COPYING file.
Packit Service 20376f
 */
Packit Service 20376f
#ifndef INCLUDE_refs_h__
Packit Service 20376f
#define INCLUDE_refs_h__
Packit Service 20376f
Packit Service 20376f
#include "common.h"
Packit Service 20376f
#include "git2/oid.h"
Packit Service 20376f
#include "git2/refs.h"
Packit Service 20376f
#include "git2/refdb.h"
Packit Service 20376f
#include "strmap.h"
Packit Service 20376f
#include "buffer.h"
Packit Service 20376f
#include "oid.h"
Packit Service 20376f
Packit Service 20376f
extern bool git_reference__enable_symbolic_ref_target_validation;
Packit Service 20376f
Packit Service 20376f
#define GIT_REFS_DIR "refs/"
Packit Service 20376f
#define GIT_REFS_HEADS_DIR GIT_REFS_DIR "heads/"
Packit Service 20376f
#define GIT_REFS_TAGS_DIR GIT_REFS_DIR "tags/"
Packit Service 20376f
#define GIT_REFS_REMOTES_DIR GIT_REFS_DIR "remotes/"
Packit Service 20376f
#define GIT_REFS_NOTES_DIR GIT_REFS_DIR "notes/"
Packit Service 20376f
#define GIT_REFS_DIR_MODE 0777
Packit Service 20376f
#define GIT_REFS_FILE_MODE 0666
Packit Service 20376f
Packit Service 20376f
#define GIT_RENAMED_REF_FILE GIT_REFS_DIR "RENAMED-REF"
Packit Service 20376f
Packit Service 20376f
#define GIT_SYMREF "ref: "
Packit Service 20376f
#define GIT_PACKEDREFS_FILE "packed-refs"
Packit Service 20376f
#define GIT_PACKEDREFS_HEADER "# pack-refs with: peeled fully-peeled "
Packit Service 20376f
#define GIT_PACKEDREFS_FILE_MODE 0666
Packit Service 20376f
Packit Service 20376f
#define GIT_HEAD_FILE "HEAD"
Packit Service 20376f
#define GIT_ORIG_HEAD_FILE "ORIG_HEAD"
Packit Service 20376f
#define GIT_FETCH_HEAD_FILE "FETCH_HEAD"
Packit Service 20376f
#define GIT_MERGE_HEAD_FILE "MERGE_HEAD"
Packit Service 20376f
#define GIT_REVERT_HEAD_FILE "REVERT_HEAD"
Packit Service 20376f
#define GIT_CHERRYPICK_HEAD_FILE "CHERRY_PICK_HEAD"
Packit Service 20376f
#define GIT_BISECT_LOG_FILE "BISECT_LOG"
Packit Service 20376f
#define GIT_REBASE_MERGE_DIR "rebase-merge/"
Packit Service 20376f
#define GIT_REBASE_MERGE_INTERACTIVE_FILE GIT_REBASE_MERGE_DIR "interactive"
Packit Service 20376f
#define GIT_REBASE_APPLY_DIR "rebase-apply/"
Packit Service 20376f
#define GIT_REBASE_APPLY_REBASING_FILE GIT_REBASE_APPLY_DIR "rebasing"
Packit Service 20376f
#define GIT_REBASE_APPLY_APPLYING_FILE GIT_REBASE_APPLY_DIR "applying"
Packit Service 20376f
#define GIT_REFS_HEADS_MASTER_FILE GIT_REFS_HEADS_DIR "master"
Packit Service 20376f
Packit Service 20376f
#define GIT_SEQUENCER_DIR "sequencer/"
Packit Service 20376f
#define GIT_SEQUENCER_HEAD_FILE GIT_SEQUENCER_DIR "head"
Packit Service 20376f
#define GIT_SEQUENCER_OPTIONS_FILE GIT_SEQUENCER_DIR "options"
Packit Service 20376f
#define GIT_SEQUENCER_TODO_FILE GIT_SEQUENCER_DIR "todo"
Packit Service 20376f
Packit Service 20376f
#define GIT_STASH_FILE "stash"
Packit Service 20376f
#define GIT_REFS_STASH_FILE GIT_REFS_DIR GIT_STASH_FILE
Packit Service 20376f
Packit Service 20376f
#define GIT_REF_FORMAT__PRECOMPOSE_UNICODE	(1u << 16)
Packit Service 20376f
#define GIT_REF_FORMAT__VALIDATION_DISABLE	(1u << 15)
Packit Service 20376f
Packit Service 20376f
#define GIT_REFNAME_MAX 1024
Packit Service 20376f
Packit Service 20376f
typedef char git_refname_t[GIT_REFNAME_MAX];
Packit Service 20376f
Packit Service 20376f
struct git_reference {
Packit Service 20376f
	git_refdb *db;
Packit Service 20376f
	git_ref_t type;
Packit Service 20376f
Packit Service 20376f
	union {
Packit Service 20376f
		git_oid oid;
Packit Service 20376f
		char *symbolic;
Packit Service 20376f
	} target;
Packit Service 20376f
Packit Service 20376f
	git_oid peel;
Packit Service 20376f
	char name[GIT_FLEX_ARRAY];
Packit Service 20376f
};
Packit Service 20376f
Packit Service 20376f
git_reference *git_reference__set_name(git_reference *ref, const char *name);
Packit Service 20376f
Packit Service 20376f
int git_reference__normalize_name(git_buf *buf, const char *name, unsigned int flags);
Packit Service 20376f
int git_reference__update_terminal(git_repository *repo, const char *ref_name, const git_oid *oid, const git_signature *sig, const char *log_message);
Packit Service 20376f
int git_reference__is_valid_name(const char *refname, unsigned int flags);
Packit Service 20376f
int git_reference__is_branch(const char *ref_name);
Packit Service 20376f
int git_reference__is_remote(const char *ref_name);
Packit Service 20376f
int git_reference__is_tag(const char *ref_name);
Packit Service 20376f
const char *git_reference__shorthand(const char *name);
Packit Service 20376f
Packit Service 20376f
/**
Packit Service 20376f
 * Lookup a reference by name and try to resolve to an OID.
Packit Service 20376f
 *
Packit Service 20376f
 * You can control how many dereferences this will attempt to resolve the
Packit Service 20376f
 * reference with the `max_deref` parameter, or pass -1 to use a sane
Packit Service 20376f
 * default.  If you pass 0 for `max_deref`, this will not attempt to resolve
Packit Service 20376f
 * the reference.  For any value of `max_deref` other than 0, not
Packit Service 20376f
 * successfully resolving the reference will be reported as an error.
Packit Service 20376f
Packit Service 20376f
 * The generated reference must be freed by the user.
Packit Service 20376f
 *
Packit Service 20376f
 * @param reference_out Pointer to the looked-up reference
Packit Service 20376f
 * @param repo The repository to look up the reference
Packit Service 20376f
 * @param name The long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)
Packit Service 20376f
 * @param max_deref Maximum number of dereferences to make of symbolic refs, 0 means simple lookup, < 0 means use default reasonable value
Packit Service 20376f
 * @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
Packit Service 20376f
 */
Packit Service 20376f
int git_reference_lookup_resolved(
Packit Service 20376f
	git_reference **reference_out,
Packit Service 20376f
	git_repository *repo,
Packit Service 20376f
	const char *name,
Packit Service 20376f
	int max_deref);
Packit Service 20376f
Packit Service 20376f
/**
Packit Service 20376f
 * Read reference from a file.
Packit Service 20376f
 *
Packit Service 20376f
 * This function will read in the file at `path`. If it is a
Packit Service 20376f
 * symref, it will return a new unresolved symbolic reference
Packit Service 20376f
 * with the given name pointing to the reference pointed to by
Packit Service 20376f
 * the file. If it is not a symbolic reference, it will return
Packit Service 20376f
 * the resolved reference.
Packit Service 20376f
 */
Packit Service 20376f
int git_reference__read_head(
Packit Service 20376f
	git_reference **out,
Packit Service 20376f
	git_repository *repo,
Packit Service 20376f
	const char *path);
Packit Service 20376f
Packit Service 20376f
int git_reference__log_signature(git_signature **out, git_repository *repo);
Packit Service 20376f
Packit Service 20376f
/** Update a reference after a commit. */
Packit Service 20376f
int git_reference__update_for_commit(
Packit Service 20376f
	git_repository *repo,
Packit Service 20376f
	git_reference *ref,
Packit Service 20376f
	const char *ref_name,
Packit Service 20376f
	const git_oid *id,
Packit Service 20376f
	const char *operation);
Packit Service 20376f
Packit Service 20376f
#endif