Use a typedef for the submodule_foreach callback.

joshaber · joshaber · commit eda726cfb5ea · 2015-12-08T11:34:00.000-05:00
This fits with the style for the rest of the project, but more
importantly, makes life easier for bindings authors who auto-generate
code.
diff --git a/include/git2/submodule.h b/include/git2/submodule.h
@@ -107,6 +107,18 @@ typedef enum {
 	GIT_SUBMODULE_STATUS_WD_WD_MODIFIED | \
 	GIT_SUBMODULE_STATUS_WD_UNTRACKED)) != 0)
 
+/**
+ * Function pointer to receive each submodule
+ *
+ * `sm` is the `git_submodule` currently being visited.
+ *
+ * `name` is the name of the submodule.
+ *
+ * `payload` is the value you passed to the foreach function as payload.
+ */
+typedef int (*git_submodule_cb)(
+	git_submodule *sm, const char *name, void *payload);
+
 /**
  * Submodule update options structure
  *
@@ -239,7 +251,7 @@ GIT_EXTERN(void) git_submodule_free(git_submodule *submodule);
  */
 GIT_EXTERN(int) git_submodule_foreach(
 	git_repository *repo,
-	int (*callback)(git_submodule *sm, const char *name, void *payload),
+	git_submodule_cb callback,
 	void *payload);
 
 /**
diff --git a/src/submodule.c b/src/submodule.c
@@ -495,7 +495,7 @@ static int all_submodules(git_repository *repo, git_strmap *map)
 
 int git_submodule_foreach(
 	git_repository *repo,
-	int (*callback)(git_submodule *sm, const char *name, void *payload),
+	git_submodule_cb callback,
 	void *payload)
 {
 	git_vector snapshot = GIT_VECTOR_INIT;

Original file line number	Diff line number	Diff line change
`@@ -495,7 +495,7 @@ static int all_submodules(git_repository repo, git_strmap map)`
`495`	`495`
`496`	`496`	`int git_submodule_foreach(`
`497`	`497`	`git_repository *repo,`
`498`		`- int (callback)(git_submodule sm, const char name, void payload),`
	`498`	`+ git_submodule_cb callback,`
`499`	`499`	`void *payload)`
`500`	`500`	`{`
`501`	`501`	`git_vector snapshot = GIT_VECTOR_INIT;`