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