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