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