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