Merge branch 'ag/rebase-p'
[git.git] / repository.h
blobdba3ddbfdd2d48068d60100425d1a22025cd25b0
1 #ifndef REPOSITORY_H
2 #define REPOSITORY_H
4 struct config_set;
5 struct git_hash_algo;
6 struct index_state;
7 struct raw_object_store;
8 struct submodule_cache;
10 struct repository {
11 /* Environment */
13 * Path to the git directory.
14 * Cannot be NULL after initialization.
16 char *gitdir;
19 * Path to the common git directory.
20 * Cannot be NULL after initialization.
22 char *commondir;
25 * Holds any information related to accessing the raw object content.
27 struct raw_object_store *objects;
30 * All objects in this repository that have been parsed. This structure
31 * owns all objects it references, so users of "struct object *"
32 * generally do not need to free them; instead, when a repository is no
33 * longer used, call parsed_object_pool_clear() on this structure, which
34 * is called by the repositories repo_clear on its desconstruction.
36 struct parsed_object_pool *parsed_objects;
38 /* The store in which the refs are held. */
39 struct ref_store *refs;
42 * Path to the repository's graft file.
43 * Cannot be NULL after initialization.
45 char *graft_file;
48 * Path to the current worktree's index file.
49 * Cannot be NULL after initialization.
51 char *index_file;
54 * Path to the working directory.
55 * A NULL value indicates that there is no working directory.
57 char *worktree;
60 * Path from the root of the top-level superproject down to this
61 * repository. This is only non-NULL if the repository is initialized
62 * as a submodule of another repository.
64 char *submodule_prefix;
66 /* Subsystems */
68 * Repository's config which contains key-value pairs from the usual
69 * set of config files (i.e. repo specific .git/config, user wide
70 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
72 struct config_set *config;
74 /* Repository's submodule config as defined by '.gitmodules' */
75 struct submodule_cache *submodule_cache;
78 * Repository's in-memory index.
79 * 'repo_read_index()' can be used to populate 'index'.
81 struct index_state *index;
83 /* Repository's current hash algorithm, as serialized on disk. */
84 const struct git_hash_algo *hash_algo;
86 /* Configurations */
88 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
89 unsigned different_commondir:1;
92 extern struct repository *the_repository;
95 * Define a custom repository layout. Any field can be NULL, which
96 * will default back to the path according to the default layout.
98 struct set_gitdir_args {
99 const char *commondir;
100 const char *object_dir;
101 const char *graft_file;
102 const char *index_file;
103 const char *alternate_db;
106 extern void repo_set_gitdir(struct repository *repo,
107 const char *root,
108 const struct set_gitdir_args *extra_args);
109 extern void repo_set_worktree(struct repository *repo, const char *path);
110 extern void repo_set_hash_algo(struct repository *repo, int algo);
111 extern void initialize_the_repository(void);
112 extern int repo_init(struct repository *r,
113 const char *gitdir,
114 const char *worktree);
115 extern int repo_submodule_init(struct repository *submodule,
116 struct repository *superproject,
117 const char *path);
118 extern void repo_clear(struct repository *repo);
121 * Populates the repository's index from its index_file, an index struct will
122 * be allocated if needed.
124 * Return the number of index entries in the populated index or a value less
125 * than zero if an error occured. If the repository's index has already been
126 * populated then the number of entries will simply be returned.
128 extern int repo_read_index(struct repository *repo);
130 #endif /* REPOSITORY_H */