repository.h

   1 #ifndef REPOSITORY_H
   2 #define REPOSITORY_H
   3
   4 struct config_set;
   5 struct git_hash_algo;
   6 struct index_state;
   7 struct raw_object_store;
   8 struct submodule_cache;
   9
  10 struct repository {
  11         /* Environment */
  12         /*
  13          * Path to the git directory.
  14          * Cannot be NULL after initialization.
  15          */
  16         char *gitdir;
  17
  18         /*
  19          * Path to the common git directory.
  20          * Cannot be NULL after initialization.
  21          */
  22         char *commondir;
  23
  24         /*
  25          * Holds any information related to accessing the raw object content.
  26          */
  27         struct raw_object_store *objects;
  28
  29         /*
  30          * All objects in this repository that have been parsed. This structure
  31          * owns all objects it references, so users of "struct object *"
  32          * generally do not need to free them; instead, when a repository is no
  33          * longer used, call parsed_object_pool_clear() on this structure, which
  34          * is called by the repositories repo_clear on its desconstruction.
  35          */
  36         struct parsed_object_pool *parsed_objects;
  37
  38         /* The store in which the refs are held. */
  39         struct ref_store *refs;
  40
  41         /*
  42          * Path to the repository's graft file.
  43          * Cannot be NULL after initialization.
  44          */
  45         char *graft_file;
  46
  47         /*
  48          * Path to the current worktree's index file.
  49          * Cannot be NULL after initialization.
  50          */
  51         char *index_file;
  52
  53         /*
  54          * Path to the working directory.
  55          * A NULL value indicates that there is no working directory.
  56          */
  57         char *worktree;
  58
  59         /*
  60          * Path from the root of the top-level superproject down to this
  61          * repository.  This is only non-NULL if the repository is initialized
  62          * as a submodule of another repository.
  63          */
  64         char *submodule_prefix;
  65
  66         /* Subsystems */
  67         /*
  68          * Repository's config which contains key-value pairs from the usual
  69          * set of config files (i.e. repo specific .git/config, user wide
  70          * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
  71          */
  72         struct config_set *config;
  73
  74         /* Repository's submodule config as defined by '.gitmodules' */
  75         struct submodule_cache *submodule_cache;
  76
  77         /*
  78          * Repository's in-memory index.
  79          * 'repo_read_index()' can be used to populate 'index'.
  80          */
  81         struct index_state *index;
  82
  83         /* Repository's current hash algorithm, as serialized on disk. */
  84         const struct git_hash_algo *hash_algo;
  85
  86         /* Configurations */
  87
  88         /* Indicate if a repository has a different 'commondir' from 'gitdir' */
  89         unsigned different_commondir:1;
  90 };
  91
  92 extern struct repository *the_repository;
  93
  94 /*
  95  * Define a custom repository layout. Any field can be NULL, which
  96  * will default back to the path according to the default layout.
  97  */
  98 struct set_gitdir_args {
  99         const char *commondir;
 100         const char *object_dir;
 101         const char *graft_file;
 102         const char *index_file;
 103         const char *alternate_db;
 104 };
 105
 106 extern void repo_set_gitdir(struct repository *repo,
 107                             const char *root,
 108                             const struct set_gitdir_args *extra_args);
 109 extern void repo_set_worktree(struct repository *repo, const char *path);
 110 extern void repo_set_hash_algo(struct repository *repo, int algo);
 111 extern void initialize_the_repository(void);
 112 extern int repo_submodule_init(struct repository *submodule,
 113                                struct repository *superproject,
 114                                const char *path);
 115 extern void repo_clear(struct repository *repo);
 116
 117 /*
 118  * Populates the repository's index from its index_file, an index struct will
 119  * be allocated if needed.
 120  *
 121  * Return the number of index entries in the populated index or a value less
 122  * than zero if an error occured.  If the repository's index has already been
 123  * populated then the number of entries will simply be returned.
 124  */
 125 extern int repo_read_index(struct repository *repo);
 126
 127 #endif /* REPOSITORY_H */