1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
4struct argv_array;
5struct cache_entry;
6struct diff_options;
7struct index_state;
8struct object_id;
9struct oid_array;
10struct pathspec;
11struct remote;
12struct repository;
13struct string_list;
14struct strbuf;
15
16enum {
17 RECURSE_SUBMODULES_ONLY = -5,
18 RECURSE_SUBMODULES_CHECK = -4,
19 RECURSE_SUBMODULES_ERROR = -3,
20 RECURSE_SUBMODULES_NONE = -2,
21 RECURSE_SUBMODULES_ON_DEMAND = -1,
22 RECURSE_SUBMODULES_OFF = 0,
23 RECURSE_SUBMODULES_DEFAULT = 1,
24 RECURSE_SUBMODULES_ON = 2
25};
26
27enum submodule_update_type {
28 SM_UPDATE_UNSPECIFIED = 0,
29 SM_UPDATE_CHECKOUT,
30 SM_UPDATE_REBASE,
31 SM_UPDATE_MERGE,
32 SM_UPDATE_NONE,
33 SM_UPDATE_COMMAND
34};
35
36struct submodule_update_strategy {
37 enum submodule_update_type type;
38 const char *command;
39};
40#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
41
42int is_gitmodules_unmerged(const struct index_state *istate);
43int is_staging_gitmodules_ok(struct index_state *istate);
44int update_path_in_gitmodules(const char *oldpath, const char *newpath);
45int remove_path_from_gitmodules(const char *path);
46void stage_updated_gitmodules(struct index_state *istate);
47void set_diffopt_flags_from_submodule_config(struct diff_options *,
48 const char *path);
49int git_default_submodule_config(const char *var, const char *value, void *cb);
50
51struct option;
52int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
53 const char *arg, int unset);
54int is_submodule_active(struct repository *repo, const char *path);
55/*
56 * Determine if a submodule has been populated at a given 'path' by checking if
57 * the <path>/.git resolves to a valid git repository.
58 * If return_error_code is NULL, die on error.
59 * Otherwise the return error code is the same as of resolve_gitdir_gently.
60 */
61int is_submodule_populated_gently(const char *path, int *return_error_code);
62void die_in_unpopulated_submodule(const struct index_state *istate,
63 const char *prefix);
64void die_path_inside_submodule(const struct index_state *istate,
65 const struct pathspec *ps);
66enum submodule_update_type parse_submodule_update_type(const char *value);
67int parse_submodule_update_strategy(const char *value,
68 struct submodule_update_strategy *dst);
69const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
70void handle_ignore_submodules_arg(struct diff_options *, const char *);
71void show_submodule_summary(struct diff_options *o, const char *path,
72 struct object_id *one, struct object_id *two,
73 unsigned dirty_submodule);
74void show_submodule_inline_diff(struct diff_options *o, const char *path,
75 struct object_id *one, struct object_id *two,
76 unsigned dirty_submodule);
77/* Check if we want to update any submodule.*/
78int should_update_submodules(void);
79/*
80 * Returns the submodule struct if the given ce entry is a submodule
81 * and it should be updated. Returns NULL otherwise.
82 */
83const struct submodule *submodule_from_ce(const struct cache_entry *ce);
84void check_for_new_submodule_commits(struct object_id *oid);
85int fetch_populated_submodules(struct repository *r,
86 const struct argv_array *options,
87 const char *prefix,
88 int command_line_option,
89 int default_option,
90 int quiet, int max_parallel_jobs);
91unsigned is_submodule_modified(const char *path, int ignore_untracked);
92int submodule_uses_gitfile(const char *path);
93
94#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
95#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
96#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
97int bad_to_remove_submodule(const char *path, unsigned flags);
98
99int add_submodule_odb(const char *path);
100
101/*
102 * Checks if there are submodule changes in a..b. If a is the null OID,
103 * checks b and all its ancestors instead.
104 */
105int submodule_touches_in_range(struct object_id *a,
106 struct object_id *b);
107int find_unpushed_submodules(struct oid_array *commits,
108 const char *remotes_name,
109 struct string_list *needs_pushing);
110struct refspec;
111int push_unpushed_submodules(struct oid_array *commits,
112 const struct remote *remote,
113 const struct refspec *rs,
114 const struct string_list *push_options,
115 int dry_run);
116/*
117 * Given a submodule path (as in the index), return the repository
118 * path of that submodule in 'buf'. Return -1 on error or when the
119 * submodule is not initialized.
120 */
121int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
122
123#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
124#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
125int submodule_move_head(const char *path,
126 const char *old,
127 const char *new_head,
128 unsigned flags);
129
130/*
131 * Prepare the "env_array" parameter of a "struct child_process" for executing
132 * a submodule by clearing any repo-specific environment variables, but
133 * retaining any config in the environment.
134 */
135void prepare_submodule_repo_env(struct argv_array *out);
136
137#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
138void absorb_git_dir_into_superproject(const char *prefix,
139 const char *path,
140 unsigned flags);
141
142/*
143 * Return the absolute path of the working tree of the superproject, which this
144 * project is a submodule of. If this repository is not a submodule of
145 * another repository, return NULL.
146 */
147const char *get_superproject_working_tree(void);
148
149#endif
150