git.oblomov.eu Git - git/blob - repository.h

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