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 10 /** 11 * The submodule config cache API allows to read submodule 12 * configurations/information from specified revisions. Internally 13 * information is lazily read into a cache that is used to avoid 14 * unnecessary parsing of the same .gitmodules files. Lookups can be done by 15 * submodule path or name. 16 * 17 * Usage 18 * ----- 19 * 20 * The caller can look up information about submodules by using the 21 * `submodule_from_path()` or `submodule_from_name()` functions. They return 22 * a `struct submodule` which contains the values. The API automatically 23 * initializes and allocates the needed infrastructure on-demand. If the 24 * caller does only want to lookup values from revisions the initialization 25 * can be skipped. 26 * 27 * If the internal cache might grow too big or when the caller is done with 28 * the API, all internally cached values can be freed with submodule_free(). 29 * 30 */ 31 32 /* 33 * Submodule entry containing the information about a certain submodule 34 * in a certain revision. It is returned by the lookup functions. 35 */ 36 struct submodule { 37 const char *path; 38 const char *name; 39 const char *url; 40 int fetch_recurse; 41 const char *ignore; 42 const char *branch; 43 struct submodule_update_strategy update_strategy; 44 /* the object id of the responsible .gitmodules file */ 45 struct object_id gitmodules_oid; 46 int recommend_shallow; 47 }; 48 49 #define SUBMODULE_INIT { NULL, NULL, NULL, RECURSE_SUBMODULES_NONE, \ 50 NULL, NULL, SUBMODULE_UPDATE_STRATEGY_INIT, { { 0 } }, -1 }; 51 52 struct submodule_cache; 53 struct repository; 54 55 void submodule_cache_free(struct submodule_cache *cache); 56 57 int parse_submodule_fetchjobs(const char *var, const char *value); 58 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg); 59 struct option; 60 int option_fetch_parse_recurse_submodules(const struct option *opt, 61 const char *arg, int unset); 62 int parse_update_recurse_submodules_arg(const char *opt, const char *arg); 63 int parse_push_recurse_submodules_arg(const char *opt, const char *arg); 64 void repo_read_gitmodules(struct repository *repo); 65 void gitmodules_config_oid(const struct object_id *commit_oid); 66 67 /** 68 * Same as submodule_from_path but lookup by name. 69 */ 70 const struct submodule *submodule_from_name(struct repository *r, 71 const struct object_id *commit_or_tree, 72 const char *name); 73 74 /** 75 * Given a tree-ish in the superproject and a path, return the submodule that 76 * is bound at the path in the named tree. 77 */ 78 const struct submodule *submodule_from_path(struct repository *r, 79 const struct object_id *commit_or_tree, 80 const char *path); 81 82 /** 83 * Use these to free the internally cached values. 84 */ 85 void submodule_free(struct repository *r); 86 87 int print_config_from_gitmodules(struct repository *repo, const char *key); 88 int config_set_in_gitmodules_file_gently(const char *key, const char *value); 89 90 /* 91 * Returns 0 if the name is syntactically acceptable as a submodule "name" 92 * (e.g., that may be found in the subsection of a .gitmodules file) and -1 93 * otherwise. 94 */ 95 int check_submodule_name(const char *name); 96 97 /* 98 * Note: these helper functions exist solely to maintain backward 99 * compatibility with 'fetch' and 'update_clone' storing configuration in 100 * '.gitmodules'. 101 * 102 * New helpers to retrieve arbitrary configuration from the '.gitmodules' file 103 * should NOT be added. 104 */ 105 void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules); 106 void update_clone_config_from_gitmodules(int *max_jobs); 107 108 #endif /* SUBMODULE_CONFIG_H */ 109