]>
Commit | Line | Data |
---|---|---|
1 | #ifndef REPOSITORY_H | |
2 | #define REPOSITORY_H | |
3 | ||
4 | struct config_set; | |
5 | struct git_hash_algo; | |
6 | struct index_state; | |
7 | struct raw_object_store; | |
8 | struct submodule_cache; | |
9 | ||
10 | struct repository { | |
11 | /* Environment */ | |
12 | /* | |
13 | * Path to the git directory. | |
14 | * Cannot be NULL after initialization. | |
15 | */ | |
16 | char *gitdir; | |
17 | ||
18 | /* | |
19 | * Path to the common git directory. | |
20 | * Cannot be NULL after initialization. | |
21 | */ | |
22 | char *commondir; | |
23 | ||
24 | /* | |
25 | * Holds any information related to accessing the raw object content. | |
26 | */ | |
27 | struct raw_object_store *objects; | |
28 | ||
29 | /* | |
30 | * All objects in this repository that have been parsed. This structure | |
31 | * owns all objects it references, so users of "struct object *" | |
32 | * generally do not need to free them; instead, when a repository is no | |
33 | * longer used, call parsed_object_pool_clear() on this structure, which | |
34 | * is called by the repositories repo_clear on its desconstruction. | |
35 | */ | |
36 | struct parsed_object_pool *parsed_objects; | |
37 | ||
38 | /* The store in which the refs are held. */ | |
39 | struct ref_store *refs; | |
40 | ||
41 | /* | |
42 | * Contains path to often used file names. | |
43 | */ | |
44 | struct path_cache cached_paths; | |
45 | ||
46 | /* | |
47 | * Path to the repository's graft file. | |
48 | * Cannot be NULL after initialization. | |
49 | */ | |
50 | char *graft_file; | |
51 | ||
52 | /* | |
53 | * Path to the current worktree's index file. | |
54 | * Cannot be NULL after initialization. | |
55 | */ | |
56 | char *index_file; | |
57 | ||
58 | /* | |
59 | * Path to the working directory. | |
60 | * A NULL value indicates that there is no working directory. | |
61 | */ | |
62 | char *worktree; | |
63 | ||
64 | /* | |
65 | * Path from the root of the top-level superproject down to this | |
66 | * repository. This is only non-NULL if the repository is initialized | |
67 | * as a submodule of another repository. | |
68 | */ | |
69 | char *submodule_prefix; | |
70 | ||
71 | /* Subsystems */ | |
72 | /* | |
73 | * Repository's config which contains key-value pairs from the usual | |
74 | * set of config files (i.e. repo specific .git/config, user wide | |
75 | * ~/.gitconfig, XDG config file and the global /etc/gitconfig) | |
76 | */ | |
77 | struct config_set *config; | |
78 | ||
79 | /* Repository's submodule config as defined by '.gitmodules' */ | |
80 | struct submodule_cache *submodule_cache; | |
81 | ||
82 | /* | |
83 | * Repository's in-memory index. | |
84 | * 'repo_read_index()' can be used to populate 'index'. | |
85 | */ | |
86 | struct index_state *index; | |
87 | ||
88 | /* Repository's current hash algorithm, as serialized on disk. */ | |
89 | const struct git_hash_algo *hash_algo; | |
90 | ||
91 | /* Configurations */ | |
92 | ||
93 | /* Indicate if a repository has a different 'commondir' from 'gitdir' */ | |
94 | unsigned different_commondir:1; | |
95 | }; | |
96 | ||
97 | extern struct repository *the_repository; | |
98 | ||
99 | /* | |
100 | * Define a custom repository layout. Any field can be NULL, which | |
101 | * will default back to the path according to the default layout. | |
102 | */ | |
103 | struct set_gitdir_args { | |
104 | const char *commondir; | |
105 | const char *object_dir; | |
106 | const char *graft_file; | |
107 | const char *index_file; | |
108 | const char *alternate_db; | |
109 | }; | |
110 | ||
111 | extern void repo_set_gitdir(struct repository *repo, | |
112 | const char *root, | |
113 | const struct set_gitdir_args *extra_args); | |
114 | extern void repo_set_worktree(struct repository *repo, const char *path); | |
115 | extern void repo_set_hash_algo(struct repository *repo, int algo); | |
116 | extern void initialize_the_repository(void); | |
117 | extern int repo_init(struct repository *r, | |
118 | const char *gitdir, | |
119 | const char *worktree); | |
120 | extern int repo_submodule_init(struct repository *submodule, | |
121 | struct repository *superproject, | |
122 | const char *path); | |
123 | extern void repo_clear(struct repository *repo); | |
124 | ||
125 | /* | |
126 | * Populates the repository's index from its index_file, an index struct will | |
127 | * be allocated if needed. | |
128 | * | |
129 | * Return the number of index entries in the populated index or a value less | |
130 | * than zero if an error occured. If the repository's index has already been | |
131 | * populated then the number of entries will simply be returned. | |
132 | */ | |
133 | extern int repo_read_index(struct repository *repo); | |
134 | ||
135 | #endif /* REPOSITORY_H */ |