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