Merge branch 'mh/notes-duplicate-entries'
[git/git.git] / repository.h
1 #ifndef REPOSITORY_H
2 #define REPOSITORY_H
3
4 #include "path.h"
5
6 struct config_set;
7 struct git_hash_algo;
8 struct index_state;
9 struct lock_file;
10 struct pathspec;
11 struct raw_object_store;
12 struct submodule_cache;
13
14 enum untracked_cache_setting {
15 UNTRACKED_CACHE_UNSET = -1,
16 UNTRACKED_CACHE_REMOVE = 0,
17 UNTRACKED_CACHE_KEEP = 1,
18 UNTRACKED_CACHE_WRITE = 2
19 };
20
21 enum fetch_negotiation_setting {
22 FETCH_NEGOTIATION_UNSET = -1,
23 FETCH_NEGOTIATION_NONE = 0,
24 FETCH_NEGOTIATION_DEFAULT = 1,
25 FETCH_NEGOTIATION_SKIPPING = 2,
26 };
27
28 struct repo_settings {
29 int initialized;
30
31 int core_commit_graph;
32 int gc_write_commit_graph;
33
34 int index_version;
35 enum untracked_cache_setting core_untracked_cache;
36
37 int pack_use_sparse;
38 enum fetch_negotiation_setting fetch_negotiation_algorithm;
39 };
40
41 struct repository {
42 /* Environment */
43 /*
44 * Path to the git directory.
45 * Cannot be NULL after initialization.
46 */
47 char *gitdir;
48
49 /*
50 * Path to the common git directory.
51 * Cannot be NULL after initialization.
52 */
53 char *commondir;
54
55 /*
56 * Holds any information related to accessing the raw object content.
57 */
58 struct raw_object_store *objects;
59
60 /*
61 * All objects in this repository that have been parsed. This structure
62 * owns all objects it references, so users of "struct object *"
63 * generally do not need to free them; instead, when a repository is no
64 * longer used, call parsed_object_pool_clear() on this structure, which
65 * is called by the repositories repo_clear on its desconstruction.
66 */
67 struct parsed_object_pool *parsed_objects;
68
69 /* The store in which the refs are held. */
70 struct ref_store *refs;
71
72 /*
73 * Contains path to often used file names.
74 */
75 struct path_cache cached_paths;
76
77 /*
78 * Path to the repository's graft file.
79 * Cannot be NULL after initialization.
80 */
81 char *graft_file;
82
83 /*
84 * Path to the current worktree's index file.
85 * Cannot be NULL after initialization.
86 */
87 char *index_file;
88
89 /*
90 * Path to the working directory.
91 * A NULL value indicates that there is no working directory.
92 */
93 char *worktree;
94
95 /*
96 * Path from the root of the top-level superproject down to this
97 * repository. This is only non-NULL if the repository is initialized
98 * as a submodule of another repository.
99 */
100 char *submodule_prefix;
101
102 struct repo_settings settings;
103
104 /* Subsystems */
105 /*
106 * Repository's config which contains key-value pairs from the usual
107 * set of config files (i.e. repo specific .git/config, user wide
108 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
109 */
110 struct config_set *config;
111
112 /* Repository's submodule config as defined by '.gitmodules' */
113 struct submodule_cache *submodule_cache;
114
115 /*
116 * Repository's in-memory index.
117 * 'repo_read_index()' can be used to populate 'index'.
118 */
119 struct index_state *index;
120
121 /* Repository's current hash algorithm, as serialized on disk. */
122 const struct git_hash_algo *hash_algo;
123
124 /* A unique-id for tracing purposes. */
125 int trace2_repo_id;
126
127 /* Configurations */
128
129 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
130 unsigned different_commondir:1;
131 };
132
133 extern struct repository *the_repository;
134
135 /*
136 * Define a custom repository layout. Any field can be NULL, which
137 * will default back to the path according to the default layout.
138 */
139 struct set_gitdir_args {
140 const char *commondir;
141 const char *object_dir;
142 const char *graft_file;
143 const char *index_file;
144 const char *alternate_db;
145 };
146
147 void repo_set_gitdir(struct repository *repo, const char *root,
148 const struct set_gitdir_args *extra_args);
149 void repo_set_worktree(struct repository *repo, const char *path);
150 void repo_set_hash_algo(struct repository *repo, int algo);
151 void initialize_the_repository(void);
152 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
153
154 /*
155 * Initialize the repository 'subrepo' as the submodule given by the
156 * struct submodule 'sub' in parent repository 'superproject'.
157 * Return 0 upon success and a non-zero value upon failure, which may happen
158 * if the submodule is not found, or 'sub' is NULL.
159 */
160 struct submodule;
161 int repo_submodule_init(struct repository *subrepo,
162 struct repository *superproject,
163 const struct submodule *sub);
164 void repo_clear(struct repository *repo);
165
166 /*
167 * Populates the repository's index from its index_file, an index struct will
168 * be allocated if needed.
169 *
170 * Return the number of index entries in the populated index or a value less
171 * than zero if an error occured. If the repository's index has already been
172 * populated then the number of entries will simply be returned.
173 */
174 int repo_read_index(struct repository *repo);
175 int repo_hold_locked_index(struct repository *repo,
176 struct lock_file *lf,
177 int flags);
178
179 int repo_read_index_preload(struct repository *,
180 const struct pathspec *pathspec,
181 unsigned refresh_flags);
182 int repo_read_index_unmerged(struct repository *);
183 /*
184 * Opportunistically update the index but do not complain if we can't.
185 * The lockfile is always committed or rolled back.
186 */
187 void repo_update_index_if_able(struct repository *, struct lock_file *);
188
189 void prepare_repo_settings(struct repository *r);
190
191 #endif /* REPOSITORY_H */