]>
Commit | Line | Data |
---|---|---|
359efeff BW |
1 | #ifndef REPOSITORY_H |
2 | #define REPOSITORY_H | |
3 | ||
ef3ca954 EN |
4 | #include "path.h" |
5 | ||
3b256228 | 6 | struct config_set; |
90c62155 | 7 | struct git_hash_algo; |
639e30b5 | 8 | struct index_state; |
3a95f31d | 9 | struct lock_file; |
e1ff0a32 | 10 | struct pathspec; |
90c62155 | 11 | struct raw_object_store; |
bf12fcdf | 12 | struct submodule_cache; |
ef7dc2e9 | 13 | struct promisor_remote_config; |
fd3cb050 | 14 | struct remote_state; |
3b256228 | 15 | |
ad0fb659 | 16 | enum untracked_cache_setting { |
3050b6df ÆAB |
17 | UNTRACKED_CACHE_KEEP, |
18 | UNTRACKED_CACHE_REMOVE, | |
19 | UNTRACKED_CACHE_WRITE, | |
ad0fb659 DS |
20 | }; |
21 | ||
aaf633c2 | 22 | enum fetch_negotiation_setting { |
714edc62 | 23 | FETCH_NEGOTIATION_CONSECUTIVE, |
3050b6df ÆAB |
24 | FETCH_NEGOTIATION_SKIPPING, |
25 | FETCH_NEGOTIATION_NOOP, | |
aaf633c2 DS |
26 | }; |
27 | ||
7211b9e7 DS |
28 | struct repo_settings { |
29 | int initialized; | |
30 | ||
31 | int core_commit_graph; | |
b66d8475 | 32 | int commit_graph_read_changed_paths; |
7211b9e7 | 33 | int gc_write_commit_graph; |
50f26bd0 | 34 | int fetch_write_commit_graph; |
c21919f1 ÆAB |
35 | int command_requires_full_index; |
36 | int sparse_index; | |
7211b9e7 DS |
37 | |
38 | int index_version; | |
ad0fb659 | 39 | enum untracked_cache_setting core_untracked_cache; |
7211b9e7 DS |
40 | |
41 | int pack_use_sparse; | |
aaf633c2 | 42 | enum fetch_negotiation_setting fetch_negotiation_algorithm; |
18e449f8 DS |
43 | |
44 | int core_multi_pack_index; | |
7211b9e7 DS |
45 | }; |
46 | ||
759f3407 ÆAB |
47 | struct repo_path_cache { |
48 | char *squash_msg; | |
49 | char *merge_msg; | |
50 | char *merge_rr; | |
51 | char *merge_mode; | |
52 | char *merge_head; | |
53 | char *merge_autostash; | |
54 | char *auto_merge; | |
55 | char *fetch_head; | |
56 | char *shallow; | |
57 | }; | |
58 | ||
359efeff BW |
59 | struct repository { |
60 | /* Environment */ | |
61 | /* | |
62 | * Path to the git directory. | |
63 | * Cannot be NULL after initialization. | |
64 | */ | |
65 | char *gitdir; | |
66 | ||
67 | /* | |
68 | * Path to the common git directory. | |
69 | * Cannot be NULL after initialization. | |
70 | */ | |
71 | char *commondir; | |
72 | ||
73 | /* | |
90c62155 | 74 | * Holds any information related to accessing the raw object content. |
359efeff | 75 | */ |
90c62155 | 76 | struct raw_object_store *objects; |
7bc0dcaa | 77 | |
99bf115c SB |
78 | /* |
79 | * All objects in this repository that have been parsed. This structure | |
80 | * owns all objects it references, so users of "struct object *" | |
81 | * generally do not need to free them; instead, when a repository is no | |
82 | * longer used, call parsed_object_pool_clear() on this structure, which | |
83 | * is called by the repositories repo_clear on its desconstruction. | |
84 | */ | |
85 | struct parsed_object_pool *parsed_objects; | |
86 | ||
02204610 JK |
87 | /* |
88 | * The store in which the refs are held. This should generally only be | |
89 | * accessed via get_main_ref_store(), as that will lazily initialize | |
90 | * the ref object. | |
91 | */ | |
92 | struct ref_store *refs_private; | |
64a74161 | 93 | |
102de880 SB |
94 | /* |
95 | * Contains path to often used file names. | |
96 | */ | |
759f3407 | 97 | struct repo_path_cache cached_paths; |
102de880 | 98 | |
359efeff BW |
99 | /* |
100 | * Path to the repository's graft file. | |
101 | * Cannot be NULL after initialization. | |
102 | */ | |
103 | char *graft_file; | |
104 | ||
105 | /* | |
106 | * Path to the current worktree's index file. | |
107 | * Cannot be NULL after initialization. | |
108 | */ | |
109 | char *index_file; | |
110 | ||
111 | /* | |
112 | * Path to the working directory. | |
113 | * A NULL value indicates that there is no working directory. | |
114 | */ | |
115 | char *worktree; | |
116 | ||
96dc883b BW |
117 | /* |
118 | * Path from the root of the top-level superproject down to this | |
119 | * repository. This is only non-NULL if the repository is initialized | |
120 | * as a submodule of another repository. | |
121 | */ | |
122 | char *submodule_prefix; | |
123 | ||
7211b9e7 DS |
124 | struct repo_settings settings; |
125 | ||
3b256228 BW |
126 | /* Subsystems */ |
127 | /* | |
128 | * Repository's config which contains key-value pairs from the usual | |
129 | * set of config files (i.e. repo specific .git/config, user wide | |
130 | * ~/.gitconfig, XDG config file and the global /etc/gitconfig) | |
131 | */ | |
132 | struct config_set *config; | |
133 | ||
bf12fcdf BW |
134 | /* Repository's submodule config as defined by '.gitmodules' */ |
135 | struct submodule_cache *submodule_cache; | |
136 | ||
639e30b5 BW |
137 | /* |
138 | * Repository's in-memory index. | |
139 | * 'repo_read_index()' can be used to populate 'index'. | |
140 | */ | |
141 | struct index_state *index; | |
142 | ||
fd3cb050 GC |
143 | /* Repository's remotes and associated structures. */ |
144 | struct remote_state *remote_state; | |
145 | ||
78a67668 | 146 | /* Repository's current hash algorithm, as serialized on disk. */ |
147 | const struct git_hash_algo *hash_algo; | |
148 | ||
ee4512ed JH |
149 | /* A unique-id for tracing purposes. */ |
150 | int trace2_repo_id; | |
151 | ||
6abada18 JK |
152 | /* True if commit-graph has been disabled within this process. */ |
153 | int commit_graph_disabled; | |
154 | ||
ebaf3bcf JT |
155 | /* Configurations related to promisor remotes. */ |
156 | char *repository_format_partial_clone; | |
ef7dc2e9 | 157 | struct promisor_remote_config *promisor_remote_config; |
ebaf3bcf | 158 | |
359efeff | 159 | /* Configurations */ |
359efeff BW |
160 | |
161 | /* Indicate if a repository has a different 'commondir' from 'gitdir' */ | |
162 | unsigned different_commondir:1; | |
163 | }; | |
164 | ||
165 | extern struct repository *the_repository; | |
166 | ||
00a3da2a NTND |
167 | /* |
168 | * Define a custom repository layout. Any field can be NULL, which | |
169 | * will default back to the path according to the default layout. | |
170 | */ | |
357a03eb NTND |
171 | struct set_gitdir_args { |
172 | const char *commondir; | |
173 | const char *object_dir; | |
174 | const char *graft_file; | |
175 | const char *index_file; | |
7bc0dcaa | 176 | const char *alternate_db; |
ecd81dfc | 177 | int disable_ref_updates; |
357a03eb NTND |
178 | }; |
179 | ||
c2ec4175 NTND |
180 | void repo_set_gitdir(struct repository *repo, const char *root, |
181 | const struct set_gitdir_args *extra_args); | |
182 | void repo_set_worktree(struct repository *repo, const char *path); | |
183 | void repo_set_hash_algo(struct repository *repo, int algo); | |
184 | void initialize_the_repository(void); | |
185 | int repo_init(struct repository *r, const char *gitdir, const char *worktree); | |
d5498e08 SB |
186 | |
187 | /* | |
8eb8dcf9 JT |
188 | * Initialize the repository 'subrepo' as the submodule at the given path. If |
189 | * the submodule's gitdir cannot be found at <path>/.git, this function calls | |
190 | * submodule_from_path() to try to find it. treeish_name is only used if | |
191 | * submodule_from_path() needs to be called; see its documentation for more | |
192 | * information. | |
193 | * Return 0 upon success and a non-zero value upon failure. | |
d5498e08 | 194 | */ |
8eb8dcf9 | 195 | struct object_id; |
d5498e08 | 196 | int repo_submodule_init(struct repository *subrepo, |
c2ec4175 | 197 | struct repository *superproject, |
8eb8dcf9 JT |
198 | const char *path, |
199 | const struct object_id *treeish_name); | |
c2ec4175 | 200 | void repo_clear(struct repository *repo); |
359efeff | 201 | |
3f138775 BW |
202 | /* |
203 | * Populates the repository's index from its index_file, an index struct will | |
204 | * be allocated if needed. | |
205 | * | |
206 | * Return the number of index entries in the populated index or a value less | |
15beaaa3 | 207 | * than zero if an error occurred. If the repository's index has already been |
3f138775 BW |
208 | * populated then the number of entries will simply be returned. |
209 | */ | |
c2ec4175 | 210 | int repo_read_index(struct repository *repo); |
3a95f31d NTND |
211 | int repo_hold_locked_index(struct repository *repo, |
212 | struct lock_file *lf, | |
213 | int flags); | |
639e30b5 | 214 | |
e1ff0a32 NTND |
215 | int repo_read_index_preload(struct repository *, |
216 | const struct pathspec *pathspec, | |
217 | unsigned refresh_flags); | |
218 | int repo_read_index_unmerged(struct repository *); | |
1b0d968b NTND |
219 | /* |
220 | * Opportunistically update the index but do not complain if we can't. | |
221 | * The lockfile is always committed or rolled back. | |
222 | */ | |
223 | void repo_update_index_if_able(struct repository *, struct lock_file *); | |
224 | ||
7211b9e7 | 225 | void prepare_repo_settings(struct repository *r); |
639e30b5 | 226 | |
16af5f1a XL |
227 | /* |
228 | * Return 1 if upgrade repository format to target_version succeeded, | |
229 | * 0 if no upgrade is necessary, and -1 when upgrade is not possible. | |
230 | */ | |
231 | int upgrade_repository_format(int target_version); | |
232 | ||
359efeff | 233 | #endif /* REPOSITORY_H */ |