repository.h 7.3 KB
Newer Older
Vicent Marti committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8 9
#ifndef INCLUDE_repository_h__
#define INCLUDE_repository_h__

10 11
#include "common.h"

12 13 14 15
#include "git2/common.h"
#include "git2/oid.h"
#include "git2/odb.h"
#include "git2/repository.h"
16
#include "git2/object.h"
17
#include "git2/config.h"
18

19
#include "array.h"
Vicent Marti committed
20
#include "cache.h"
21
#include "refs.h"
22
#include "buffer.h"
23
#include "object.h"
24
#include "attrcache.h"
25
#include "submodule.h"
26
#include "diff_driver.h"
27

28 29
#define DOT_GIT ".git"
#define GIT_DIR DOT_GIT "/"
30 31
#define GIT_DIR_MODE 0755
#define GIT_BARE_DIR_MODE 0777
32

33 34 35
/* Default DOS-compatible 8.3 "short name" for a git repository, "GIT~1" */
#define GIT_DIR_SHORTNAME "GIT~1"

36 37
extern bool git_repository__fsync_gitdir;

38 39 40
/** Cvar cache identifiers */
typedef enum {
	GIT_CVAR_AUTO_CRLF = 0, /* core.autocrlf */
41 42 43 44 45 46 47
	GIT_CVAR_EOL,           /* core.eol */
	GIT_CVAR_SYMLINKS,      /* core.symlinks */
	GIT_CVAR_IGNORECASE,    /* core.ignorecase */
	GIT_CVAR_FILEMODE,      /* core.filemode */
	GIT_CVAR_IGNORESTAT,    /* core.ignorestat */
	GIT_CVAR_TRUSTCTIME,    /* core.trustctime */
	GIT_CVAR_ABBREV,        /* core.abbrev */
48
	GIT_CVAR_PRECOMPOSE,    /* core.precomposeunicode */
49
	GIT_CVAR_SAFE_CRLF,		/* core.safecrlf */
50
	GIT_CVAR_LOGALLREFUPDATES, /* core.logallrefupdates */
51 52
	GIT_CVAR_PROTECTHFS,    /* core.protectHFS */
	GIT_CVAR_PROTECTNTFS,   /* core.protectNTFS */
53
	GIT_CVAR_FSYNCOBJECTFILES, /* core.fsyncObjectFiles */
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
	GIT_CVAR_CACHE_MAX
} git_cvar_cached;

/**
 * CVAR value enumerations
 *
 * These are the values that are actually stored in the cvar cache, instead
 * of their string equivalents. These values are internal and symbolic;
 * make sure that none of them is set to `-1`, since that is the unique
 * identifier for "not cached"
 */
typedef enum {
	/* The value hasn't been loaded from the cache yet */
	GIT_CVAR_NOT_CACHED = -1,

	/* core.safecrlf: false, 'fail', 'warn' */
	GIT_SAFE_CRLF_FALSE = 0,
	GIT_SAFE_CRLF_FAIL = 1,
	GIT_SAFE_CRLF_WARN = 2,

	/* core.autocrlf: false, true, 'input; */
	GIT_AUTO_CRLF_FALSE = 0,
	GIT_AUTO_CRLF_TRUE = 1,
	GIT_AUTO_CRLF_INPUT = 2,
	GIT_AUTO_CRLF_DEFAULT = GIT_AUTO_CRLF_FALSE,

	/* core.eol: unset, 'crlf', 'lf', 'native' */
	GIT_EOL_UNSET = 0,
	GIT_EOL_CRLF = 1,
	GIT_EOL_LF = 2,
#ifdef GIT_WIN32
	GIT_EOL_NATIVE = GIT_EOL_CRLF,
#else
	GIT_EOL_NATIVE = GIT_EOL_LF,
#endif
89 90 91 92 93 94 95 96 97 98 99 100 101 102
	GIT_EOL_DEFAULT = GIT_EOL_NATIVE,

	/* core.symlinks: bool */
	GIT_SYMLINKS_DEFAULT = GIT_CVAR_TRUE,
	/* core.ignorecase */
	GIT_IGNORECASE_DEFAULT = GIT_CVAR_FALSE,
	/* core.filemode */
	GIT_FILEMODE_DEFAULT = GIT_CVAR_TRUE,
	/* core.ignorestat */
	GIT_IGNORESTAT_DEFAULT = GIT_CVAR_FALSE,
	/* core.trustctime */
	GIT_TRUSTCTIME_DEFAULT = GIT_CVAR_TRUE,
	/* core.abbrev */
	GIT_ABBREV_DEFAULT = 7,
103 104
	/* core.precomposeunicode */
	GIT_PRECOMPOSE_DEFAULT = GIT_CVAR_FALSE,
105 106
	/* core.safecrlf */
	GIT_SAFE_CRLF_DEFAULT = GIT_CVAR_FALSE,
107 108 109
	/* core.logallrefupdates */
	GIT_LOGALLREFUPDATES_UNSET = 2,
	GIT_LOGALLREFUPDATES_DEFAULT = GIT_LOGALLREFUPDATES_UNSET,
110 111 112 113
	/* core.protectHFS */
	GIT_PROTECTHFS_DEFAULT = GIT_CVAR_FALSE,
	/* core.protectNTFS */
	GIT_PROTECTNTFS_DEFAULT = GIT_CVAR_FALSE,
114 115
	/* core.fsyncObjectFiles */
	GIT_FSYNCOBJECTFILES_DEFAULT = GIT_CVAR_FALSE,
116 117
} git_cvar_value;

118 119 120 121 122 123 124 125
/* internal repository init flags */
enum {
	GIT_REPOSITORY_INIT__HAS_DOTGIT = (1u << 16),
	GIT_REPOSITORY_INIT__NATURAL_WD = (1u << 17),
	GIT_REPOSITORY_INIT__IS_REINIT  = (1u << 18),
};

/** Internal structure for repository object */
126
struct git_repository {
127
	git_odb *_odb;
128
	git_refdb *_refdb;
129 130
	git_config *_config;
	git_index *_index;
131

Vicent Marti committed
132
	git_cache objects;
133
	git_attr_cache *attrcache;
134
	git_diff_driver_registry *diff_drivers;
135

136 137
	char *gitlink;
	char *gitdir;
138
	char *commondir;
139
	char *workdir;
Vicent Marti committed
140
	char *namespace;
141

142 143 144
	char *ident_name;
	char *ident_email;

145 146 147
	git_array_t(git_buf) reserved_names;

	unsigned is_bare:1;
148
	unsigned is_worktree:1;
149

150
	unsigned int lru_counter;
151

152 153
	git_atomic attr_session_key;

154
	git_cvar_value cvar_cache[GIT_CVAR_CACHE_MAX];
155
	git_strmap *submodule_cache;
156 157
};

158 159
GIT_INLINE(git_attr_cache *) git_repository_attr_cache(git_repository *repo)
{
160
	return repo->attrcache;
161 162
}

163
int git_repository_head_tree(git_tree **tree, git_repository *repo);
164
int git_repository_create_head(const char *git_dir, const char *ref_name);
165

166
/*
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
 * Called for each HEAD.
 *
 * Can return either 0, causing the iteration over HEADs to
 * continue, or a non-0 value causing the iteration to abort. The
 * return value is passed back to the caller of
 * `git_repository_foreach_head`
 */
typedef int (*git_repository_foreach_head_cb)(git_repository *repo, const char *path, void *payload);

/*
 * Iterate over repository and all worktree HEADs.
 *
 * This function will be called for the repository HEAD and for
 * all HEADS of linked worktrees. For each HEAD, the callback is
 * executed with the given payload. The return value equals the
 * return value of the last executed callback function.
 */
int git_repository_foreach_head(git_repository *repo, git_repository_foreach_head_cb cb, void *payload);

/*
187 188 189 190 191 192
 * Weak pointers to repository internals.
 *
 * The returned pointers do not need to be freed. Do not keep
 * permanent references to these (i.e. between API calls), since they may
 * become invalidated if the user replaces a repository internal.
 */
193 194
int git_repository_config__weakptr(git_config **out, git_repository *repo);
int git_repository_odb__weakptr(git_odb **out, git_repository *repo);
195
int git_repository_refdb__weakptr(git_refdb **out, git_repository *repo);
196 197
int git_repository_index__weakptr(git_index **out, git_repository *repo);

198
/*
199
 * CVAR cache
200 201
 *
 * Efficient access to the most used config variables of a repository.
Will Stamper committed
202
 * The cache is cleared every time the config backend is replaced.
203 204 205 206
 */
int git_repository__cvar(int *out, git_repository *repo, git_cvar_cached cvar);
void git_repository__cvar_cache_clear(git_repository *repo);

207 208 209 210 211 212 213 214 215
GIT_INLINE(int) git_repository__ensure_not_bare(
	git_repository *repo,
	const char *operation_name)
{
	if (!git_repository_is_bare(repo))
		return 0;

	giterr_set(
		GITERR_REPOSITORY,
216
		"cannot %s. This operation is not allowed against bare repositories.",
217 218 219 220 221
		operation_name);

	return GIT_EBAREREPO;
}

222 223
int git_repository__set_orig_head(git_repository *repo, const git_oid *orig_head);

224 225
int git_repository__cleanup_files(git_repository *repo, const char *files[], size_t files_len);

226 227 228 229 230 231
/* The default "reserved names" for a repository */
extern git_buf git_repository__reserved_names_win32[];
extern size_t git_repository__reserved_names_win32_len;

extern git_buf git_repository__reserved_names_posix[];
extern size_t git_repository__reserved_names_posix_len;
232

233 234 235 236 237 238 239 240 241
/*
 * Gets any "reserved names" in the repository.  This will return paths
 * that should not be allowed in the repository (like ".git") to avoid
 * conflicting with the repository path, or with alternate mechanisms to
 * the repository path (eg, "GIT~1").  Every attempt will be made to look
 * up all possible reserved names - if there was a conflict for the shortname
 * GIT~1, for example, this function will try to look up the alternate
 * shortname.  If that fails, this function returns false, but out and outlen
 * will still be populated with good defaults.
242
 */
243 244
bool git_repository__reserved_names(
	git_buf **out, size_t *outlen, git_repository *repo, bool include_ntfs);
245

246
#endif