submodule-config.h

   1 #ifndef SUBMODULE_CONFIG_CACHE_H
   2 #define SUBMODULE_CONFIG_CACHE_H
   3
   4 #include "cache.h"
   5 #include "config.h"
   6 #include "hashmap.h"
   7 #include "submodule.h"
   8 #include "strbuf.h"
   9 #include "tree-walk.h"
  10
  11 /**
  12  * The submodule config cache API allows to read submodule
  13  * configurations/information from specified revisions. Internally
  14  * information is lazily read into a cache that is used to avoid
  15  * unnecessary parsing of the same .gitmodules files. Lookups can be done by
  16  * submodule path or name.
  17  *
  18  * Usage
  19  * -----
  20  *
  21  * The caller can look up information about submodules by using the
  22  * `submodule_from_path()` or `submodule_from_name()` functions. They return
  23  * a `struct submodule` which contains the values. The API automatically
  24  * initializes and allocates the needed infrastructure on-demand. If the
  25  * caller does only want to lookup values from revisions the initialization
  26  * can be skipped.
  27  *
  28  * If the internal cache might grow too big or when the caller is done with
  29  * the API, all internally cached values can be freed with submodule_free().
  30  *
  31  */
  32
  33 /*
  34  * Submodule entry containing the information about a certain submodule
  35  * in a certain revision. It is returned by the lookup functions.
  36  */
  37 struct submodule {
  38         const char *path;
  39         const char *name;
  40         const char *url;
  41         enum submodule_recurse_mode fetch_recurse;
  42         const char *ignore;
  43         const char *branch;
  44         struct submodule_update_strategy update_strategy;
  45         /* the object id of the responsible .gitmodules file */
  46         struct object_id gitmodules_oid;
  47         int recommend_shallow;
  48 };
  49 struct submodule_cache;
  50 struct repository;
  51
  52 void submodule_cache_free(struct submodule_cache *cache);
  53
  54 int parse_submodule_fetchjobs(const char *var, const char *value);
  55 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
  56 struct option;
  57 int option_fetch_parse_recurse_submodules(const struct option *opt,
  58                                           const char *arg, int unset);
  59 int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
  60 int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
  61 void repo_read_gitmodules(struct repository *repo, int skip_if_read);
  62 void gitmodules_config_oid(const struct object_id *commit_oid);
  63
  64 /**
  65  * Same as submodule_from_path but lookup by name.
  66  */
  67 const struct submodule *submodule_from_name(struct repository *r,
  68                                             const struct object_id *commit_or_tree,
  69                                             const char *name);
  70
  71 /**
  72  * Given a tree-ish in the superproject and a path, return the submodule that
  73  * is bound at the path in the named tree.
  74  */
  75 const struct submodule *submodule_from_path(struct repository *r,
  76                                             const struct object_id *commit_or_tree,
  77                                             const char *path);
  78
  79 /**
  80  * Use these to free the internally cached values.
  81  */
  82 void submodule_free(struct repository *r);
  83
  84 int print_config_from_gitmodules(struct repository *repo, const char *key);
  85 int config_set_in_gitmodules_file_gently(const char *key, const char *value);
  86
  87 /*
  88  * Returns 0 if the name is syntactically acceptable as a submodule "name"
  89  * (e.g., that may be found in the subsection of a .gitmodules file) and -1
  90  * otherwise.
  91  */
  92 int check_submodule_name(const char *name);
  93
  94 /*
  95  * Note: these helper functions exist solely to maintain backward
  96  * compatibility with 'fetch' and 'update_clone' storing configuration in
  97  * '.gitmodules'.
  98  *
  99  * New helpers to retrieve arbitrary configuration from the '.gitmodules' file
 100  * should NOT be added.
 101  */
 102 void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules);
 103 void update_clone_config_from_gitmodules(int *max_jobs);
 104
 105 /*
 106  * Submodule entry that contains relevant information about a
 107  * submodule in a tree.
 108  */
 109 struct submodule_tree_entry {
 110         /* The submodule's tree entry. */
 111         struct name_entry *name_entry;
 112         /*
 113          * A struct repository corresponding to the submodule. May be
 114          * NULL if the submodule has not been updated.
 115          */
 116         struct repository *repo;
 117         /*
 118          * A struct submodule containing the submodule config in the
 119          * tree's .gitmodules.
 120          */
 121         const struct submodule *submodule;
 122 };
 123
 124 struct submodule_entry_list {
 125         struct submodule_tree_entry *entries;
 126         int entry_nr;
 127         int entry_alloc;
 128 };
 129
 130 /**
 131  * Given a treeish, return all submodules in the tree and its subtrees,
 132  * but excluding nested submodules. Callers that require nested
 133  * submodules are expected to recurse into the submodules themselves.
 134  */
 135 void submodules_of_tree(struct repository *r,
 136                         const struct object_id *treeish_name,
 137                         struct submodule_entry_list *ret);
 138 #endif /* SUBMODULE_CONFIG_H */