Merge branch 'zh/read-cache-copy-name-entry-fix'
[alt-git.git] / repository.h
blob6cc661e5a43b82022ca171a43c015db2f278116e
1 #ifndef REPOSITORY_H
2 #define REPOSITORY_H
4 #include "path.h"
6 struct config_set;
7 struct fsmonitor_settings;
8 struct git_hash_algo;
9 struct index_state;
10 struct lock_file;
11 struct pathspec;
12 struct raw_object_store;
13 struct submodule_cache;
14 struct promisor_remote_config;
15 struct remote_state;
17 enum untracked_cache_setting {
18 UNTRACKED_CACHE_KEEP,
19 UNTRACKED_CACHE_REMOVE,
20 UNTRACKED_CACHE_WRITE,
23 enum fetch_negotiation_setting {
24 FETCH_NEGOTIATION_CONSECUTIVE,
25 FETCH_NEGOTIATION_SKIPPING,
26 FETCH_NEGOTIATION_NOOP,
29 struct repo_settings {
30 int initialized;
32 int core_commit_graph;
33 int commit_graph_read_changed_paths;
34 int gc_write_commit_graph;
35 int fetch_write_commit_graph;
36 int command_requires_full_index;
37 int sparse_index;
39 struct fsmonitor_settings *fsmonitor; /* lazily loaded */
41 int index_version;
42 enum untracked_cache_setting core_untracked_cache;
44 int pack_use_sparse;
45 enum fetch_negotiation_setting fetch_negotiation_algorithm;
47 int core_multi_pack_index;
50 struct repo_path_cache {
51 char *squash_msg;
52 char *merge_msg;
53 char *merge_rr;
54 char *merge_mode;
55 char *merge_head;
56 char *merge_autostash;
57 char *auto_merge;
58 char *fetch_head;
59 char *shallow;
62 struct repository {
63 /* Environment */
65 * Path to the git directory.
66 * Cannot be NULL after initialization.
68 char *gitdir;
71 * Path to the common git directory.
72 * Cannot be NULL after initialization.
74 char *commondir;
77 * Holds any information related to accessing the raw object content.
79 struct raw_object_store *objects;
82 * All objects in this repository that have been parsed. This structure
83 * owns all objects it references, so users of "struct object *"
84 * generally do not need to free them; instead, when a repository is no
85 * longer used, call parsed_object_pool_clear() on this structure, which
86 * is called by the repositories repo_clear on its desconstruction.
88 struct parsed_object_pool *parsed_objects;
91 * The store in which the refs are held. This should generally only be
92 * accessed via get_main_ref_store(), as that will lazily initialize
93 * the ref object.
95 struct ref_store *refs_private;
98 * Contains path to often used file names.
100 struct repo_path_cache cached_paths;
103 * Path to the repository's graft file.
104 * Cannot be NULL after initialization.
106 char *graft_file;
109 * Path to the current worktree's index file.
110 * Cannot be NULL after initialization.
112 char *index_file;
115 * Path to the working directory.
116 * A NULL value indicates that there is no working directory.
118 char *worktree;
121 * Path from the root of the top-level superproject down to this
122 * repository. This is only non-NULL if the repository is initialized
123 * as a submodule of another repository.
125 char *submodule_prefix;
127 struct repo_settings settings;
129 /* Subsystems */
131 * Repository's config which contains key-value pairs from the usual
132 * set of config files (i.e. repo specific .git/config, user wide
133 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
135 struct config_set *config;
137 /* Repository's submodule config as defined by '.gitmodules' */
138 struct submodule_cache *submodule_cache;
141 * Repository's in-memory index.
142 * 'repo_read_index()' can be used to populate 'index'.
144 struct index_state *index;
146 /* Repository's remotes and associated structures. */
147 struct remote_state *remote_state;
149 /* Repository's current hash algorithm, as serialized on disk. */
150 const struct git_hash_algo *hash_algo;
152 /* A unique-id for tracing purposes. */
153 int trace2_repo_id;
155 /* True if commit-graph has been disabled within this process. */
156 int commit_graph_disabled;
158 /* Configurations related to promisor remotes. */
159 char *repository_format_partial_clone;
160 struct promisor_remote_config *promisor_remote_config;
162 /* Configurations */
164 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
165 unsigned different_commondir:1;
168 extern struct repository *the_repository;
171 * Define a custom repository layout. Any field can be NULL, which
172 * will default back to the path according to the default layout.
174 struct set_gitdir_args {
175 const char *commondir;
176 const char *object_dir;
177 const char *graft_file;
178 const char *index_file;
179 const char *alternate_db;
180 int disable_ref_updates;
183 void repo_set_gitdir(struct repository *repo, const char *root,
184 const struct set_gitdir_args *extra_args);
185 void repo_set_worktree(struct repository *repo, const char *path);
186 void repo_set_hash_algo(struct repository *repo, int algo);
187 void initialize_the_repository(void);
188 int repo_init(struct repository *r, const char *gitdir, const char *worktree);
191 * Initialize the repository 'subrepo' as the submodule at the given path. If
192 * the submodule's gitdir cannot be found at <path>/.git, this function calls
193 * submodule_from_path() to try to find it. treeish_name is only used if
194 * submodule_from_path() needs to be called; see its documentation for more
195 * information.
196 * Return 0 upon success and a non-zero value upon failure.
198 struct object_id;
199 int repo_submodule_init(struct repository *subrepo,
200 struct repository *superproject,
201 const char *path,
202 const struct object_id *treeish_name);
203 void repo_clear(struct repository *repo);
206 * Populates the repository's index from its index_file, an index struct will
207 * be allocated if needed.
209 * Return the number of index entries in the populated index or a value less
210 * than zero if an error occurred. If the repository's index has already been
211 * populated then the number of entries will simply be returned.
213 int repo_read_index(struct repository *repo);
214 int repo_hold_locked_index(struct repository *repo,
215 struct lock_file *lf,
216 int flags);
218 int repo_read_index_preload(struct repository *,
219 const struct pathspec *pathspec,
220 unsigned refresh_flags);
221 int repo_read_index_unmerged(struct repository *);
223 * Opportunistically update the index but do not complain if we can't.
224 * The lockfile is always committed or rolled back.
226 void repo_update_index_if_able(struct repository *, struct lock_file *);
228 void prepare_repo_settings(struct repository *r);
231 * Return 1 if upgrade repository format to target_version succeeded,
232 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
234 int upgrade_repository_format(int target_version);
236 #endif /* REPOSITORY_H */