summaryrefslogtreecommitdiff
path: root/repository.h
diff options
context:
space:
mode:
Diffstat (limited to 'repository.h')
-rw-r--r--repository.h97
1 files changed, 97 insertions, 0 deletions
diff --git a/repository.h b/repository.h
new file mode 100644
index 0000000000..417787f3ef
--- /dev/null
+++ b/repository.h
@@ -0,0 +1,97 @@
+#ifndef REPOSITORY_H
+#define REPOSITORY_H
+
+struct config_set;
+struct index_state;
+struct submodule_cache;
+
+struct repository {
+ /* Environment */
+ /*
+ * Path to the git directory.
+ * Cannot be NULL after initialization.
+ */
+ char *gitdir;
+
+ /*
+ * Path to the common git directory.
+ * Cannot be NULL after initialization.
+ */
+ char *commondir;
+
+ /*
+ * Path to the repository's object store.
+ * Cannot be NULL after initialization.
+ */
+ char *objectdir;
+
+ /*
+ * Path to the repository's graft file.
+ * Cannot be NULL after initialization.
+ */
+ char *graft_file;
+
+ /*
+ * Path to the current worktree's index file.
+ * Cannot be NULL after initialization.
+ */
+ char *index_file;
+
+ /*
+ * Path to the working directory.
+ * A NULL value indicates that there is no working directory.
+ */
+ char *worktree;
+
+ /*
+ * Path from the root of the top-level superproject down to this
+ * repository. This is only non-NULL if the repository is initialized
+ * as a submodule of another repository.
+ */
+ char *submodule_prefix;
+
+ /* Subsystems */
+ /*
+ * Repository's config which contains key-value pairs from the usual
+ * set of config files (i.e. repo specific .git/config, user wide
+ * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
+ */
+ struct config_set *config;
+
+ /* Repository's submodule config as defined by '.gitmodules' */
+ struct submodule_cache *submodule_cache;
+
+ /*
+ * Repository's in-memory index.
+ * 'repo_read_index()' can be used to populate 'index'.
+ */
+ struct index_state *index;
+
+ /* Configurations */
+ /*
+ * Bit used during initialization to indicate if repository state (like
+ * the location of the 'objectdir') should be read from the
+ * environment. By default this bit will be set at the begining of
+ * 'repo_init()' so that all repositories will ignore the environment.
+ * The exception to this is 'the_repository', which doesn't go through
+ * the normal 'repo_init()' process.
+ */
+ unsigned ignore_env:1;
+
+ /* Indicate if a repository has a different 'commondir' from 'gitdir' */
+ unsigned different_commondir:1;
+};
+
+extern struct repository *the_repository;
+
+extern void repo_set_gitdir(struct repository *repo, const char *path);
+extern void repo_set_worktree(struct repository *repo, const char *path);
+extern int repo_init(struct repository *repo, const char *gitdir, const char *worktree);
+extern int repo_submodule_init(struct repository *submodule,
+ struct repository *superproject,
+ const char *path);
+extern void repo_clear(struct repository *repo);
+
+extern int repo_read_index(struct repository *repo);
+
+#endif /* REPOSITORY_H */