add-patch: plug a leak handling the '/' command
[alt-git.git] / repository.h
blob268436779c8f315228aef0dde9039f9ebf4f723e
1 #ifndef REPOSITORY_H
2 #define REPOSITORY_H
4 struct config_set;
5 struct fsmonitor_settings;
6 struct git_hash_algo;
7 struct index_state;
8 struct lock_file;
9 struct pathspec;
10 struct raw_object_store;
11 struct submodule_cache;
12 struct promisor_remote_config;
13 struct remote_state;
15 enum untracked_cache_setting {
16 UNTRACKED_CACHE_KEEP,
17 UNTRACKED_CACHE_REMOVE,
18 UNTRACKED_CACHE_WRITE,
21 enum fetch_negotiation_setting {
22 FETCH_NEGOTIATION_CONSECUTIVE,
23 FETCH_NEGOTIATION_SKIPPING,
24 FETCH_NEGOTIATION_NOOP,
27 #define REF_STORAGE_FORMAT_UNKNOWN 0
28 #define REF_STORAGE_FORMAT_FILES 1
29 #define REF_STORAGE_FORMAT_REFTABLE 2
31 struct repo_settings {
32 int initialized;
34 int core_commit_graph;
35 int commit_graph_generation_version;
36 int commit_graph_read_changed_paths;
37 int gc_write_commit_graph;
38 int fetch_write_commit_graph;
39 int command_requires_full_index;
40 int sparse_index;
41 int pack_read_reverse_index;
42 int pack_use_bitmap_boundary_traversal;
43 int pack_use_multi_pack_reuse;
46 * Does this repository have core.useReplaceRefs=true (on by
47 * default)? This provides a repository-scoped version of this
48 * config, though it could be disabled process-wide via some Git
49 * builtins or the --no-replace-objects option. See
50 * replace_refs_enabled() for more details.
52 int read_replace_refs;
54 struct fsmonitor_settings *fsmonitor; /* lazily loaded */
56 int index_version;
57 int index_skip_hash;
58 enum untracked_cache_setting core_untracked_cache;
60 int pack_use_sparse;
61 enum fetch_negotiation_setting fetch_negotiation_algorithm;
63 int core_multi_pack_index;
66 struct repo_path_cache {
67 char *squash_msg;
68 char *merge_msg;
69 char *merge_rr;
70 char *merge_mode;
71 char *merge_head;
72 char *fetch_head;
73 char *shallow;
76 struct repository {
77 /* Environment */
79 * Path to the git directory.
80 * Cannot be NULL after initialization.
82 char *gitdir;
85 * Path to the common git directory.
86 * Cannot be NULL after initialization.
88 char *commondir;
91 * Holds any information related to accessing the raw object content.
93 struct raw_object_store *objects;
96 * All objects in this repository that have been parsed. This structure
97 * owns all objects it references, so users of "struct object *"
98 * generally do not need to free them; instead, when a repository is no
99 * longer used, call parsed_object_pool_clear() on this structure, which
100 * is called by the repositories repo_clear on its desconstruction.
102 struct parsed_object_pool *parsed_objects;
105 * The store in which the refs are held. This should generally only be
106 * accessed via get_main_ref_store(), as that will lazily initialize
107 * the ref object.
109 struct ref_store *refs_private;
112 * Contains path to often used file names.
114 struct repo_path_cache cached_paths;
117 * Path to the repository's graft file.
118 * Cannot be NULL after initialization.
120 char *graft_file;
123 * Path to the current worktree's index file.
124 * Cannot be NULL after initialization.
126 char *index_file;
129 * Path to the working directory.
130 * A NULL value indicates that there is no working directory.
132 char *worktree;
135 * Path from the root of the top-level superproject down to this
136 * repository. This is only non-NULL if the repository is initialized
137 * as a submodule of another repository.
139 char *submodule_prefix;
141 struct repo_settings settings;
143 /* Subsystems */
145 * Repository's config which contains key-value pairs from the usual
146 * set of config files (i.e. repo specific .git/config, user wide
147 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
149 struct config_set *config;
151 /* Repository's submodule config as defined by '.gitmodules' */
152 struct submodule_cache *submodule_cache;
155 * Repository's in-memory index.
156 * 'repo_read_index()' can be used to populate 'index'.
158 struct index_state *index;
160 /* Repository's remotes and associated structures. */
161 struct remote_state *remote_state;
163 /* Repository's current hash algorithm, as serialized on disk. */
164 const struct git_hash_algo *hash_algo;
166 /* Repository's compatibility hash algorithm. */
167 const struct git_hash_algo *compat_hash_algo;
169 /* Repository's reference storage format, as serialized on disk. */
170 unsigned int ref_storage_format;
172 /* A unique-id for tracing purposes. */
173 int trace2_repo_id;
175 /* True if commit-graph has been disabled within this process. */
176 int commit_graph_disabled;
178 /* Configurations related to promisor remotes. */
179 char *repository_format_partial_clone;
180 struct promisor_remote_config *promisor_remote_config;
182 /* Configurations */
183 int repository_format_worktree_config;
185 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
186 unsigned different_commondir:1;
189 extern struct repository *the_repository;
190 #ifdef USE_THE_INDEX_VARIABLE
191 extern struct index_state the_index;
192 #endif
195 * Define a custom repository layout. Any field can be NULL, which
196 * will default back to the path according to the default layout.
198 struct set_gitdir_args {
199 const char *commondir;
200 const char *object_dir;
201 const char *graft_file;
202 const char *index_file;
203 const char *alternate_db;
204 int disable_ref_updates;
207 void repo_set_gitdir(struct repository *repo, const char *root,
208 const struct set_gitdir_args *extra_args);
209 void repo_set_worktree(struct repository *repo, const char *path);
210 void repo_set_hash_algo(struct repository *repo, int algo);
211 void repo_set_compat_hash_algo(struct repository *repo, int compat_algo);
212 void repo_set_ref_storage_format(struct repository *repo, unsigned int format);
213 void initialize_the_repository(void);
214 RESULT_MUST_BE_USED
215 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
218 * Initialize the repository 'subrepo' as the submodule at the given path. If
219 * the submodule's gitdir cannot be found at <path>/.git, this function calls
220 * submodule_from_path() to try to find it. treeish_name is only used if
221 * submodule_from_path() needs to be called; see its documentation for more
222 * information.
223 * Return 0 upon success and a non-zero value upon failure.
225 struct object_id;
226 RESULT_MUST_BE_USED
227 int repo_submodule_init(struct repository *subrepo,
228 struct repository *superproject,
229 const char *path,
230 const struct object_id *treeish_name);
231 void repo_clear(struct repository *repo);
234 * Populates the repository's index from its index_file, an index struct will
235 * be allocated if needed.
237 * Return the number of index entries in the populated index or a value less
238 * than zero if an error occurred. If the repository's index has already been
239 * populated then the number of entries will simply be returned.
241 int repo_read_index(struct repository *repo);
242 int repo_hold_locked_index(struct repository *repo,
243 struct lock_file *lf,
244 int flags);
246 int repo_read_index_unmerged(struct repository *);
248 * Opportunistically update the index but do not complain if we can't.
249 * The lockfile is always committed or rolled back.
251 void repo_update_index_if_able(struct repository *, struct lock_file *);
253 void prepare_repo_settings(struct repository *r);
256 * Return 1 if upgrade repository format to target_version succeeded,
257 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
259 int upgrade_repository_format(int target_version);
261 #endif /* REPOSITORY_H */