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