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