Add mapping rules to fix automatic generated API

[xoofx]

The generated API requires mapping fixes (e.g change int to bool, use enums instead of integers...etc.)

Here is the list of API that needs to be verified and fix with mapping rules if necessary:

HELP much welcome (you can see how API can be fixed by looking at one of the commit below)

• annotated_commit.generated.cs
• apply.generated.cs
• attr.generated.cs
• blame.generated.cs
• blob.generated.cs
• branch.generated.cs
• buffer.generated.cs
• checkout.generated.cs
• cherrypick.generated.cs
• clone.generated.cs
• commit.generated.cs
• common.generated.cs
• config.generated.cs
• cppast.generated.cs
• deprecated.generated.cs
• describe.generated.cs
• diff.generated.cs
• errors.generated.cs
• filter.generated.cs
• global.generated.cs
• graph.generated.cs
• ignore.generated.cs
• index.generated.cs
• indexer.generated.cs
• libgit2.generated.cs
• mailmap.generated.cs
• merge.generated.cs
• message.generated.cs
• net.generated.cs
• notes.generated.cs
• object.generated.cs
• odb.generated.cs
• odb_backend.generated.cs
• oid.generated.cs
• oidarray.generated.cs
• pack.generated.cs
• patch.generated.cs
• pathspec.generated.cs
• proxy.generated.cs
• rebase.generated.cs
• refdb.generated.cs
• reflog.generated.cs
• refs.generated.cs
• refspec.generated.cs
• remote.generated.cs
• repository.generated.cs (fix 6da77e5)
• reset.generated.cs
• revert.generated.cs
• revparse.generated.cs
• revwalk.generated.cs
• signature.generated.cs
• stash.generated.cs
• status.generated.cs
• strarray.generated.cs
• submodule.generated.cs
• tag.generated.cs
• trace.generated.cs
• transaction.generated.cs
• transport.generated.cs
• tree.generated.cs
• types.generated.cs
• worktree.generated.cs

[StephenHodgson]

This is quite a manual task. Wondering if the CppAst.CodeGen lib can provide some basic mappings?

[xoofx]

This is quite a manual task. Wondering if the CppAst.CodeGen lib can provide some basic mappings?

Sorry to respond so late (and this is mostly in case someone else is wondering about your good question 😃). If you look at commit 6da77e5 CppAst.CodeGen is actually helping to change parameter types. The problem with libgit2 C API is that it does not describe what an int is (it can be an enum or a bool) and you can only infer this information from the comments.

                    e => e.MapMacroToConst("GIT_REPOSITORY_INIT_OPTIONS_VERSION", "unsigned int"),
                    e => e.Map<CppParameter>("git_repository_open_ext::flags").Type("git_repository_open_flag_t"),
                    e => e.Map<CppParameter>("git_repository_init::is_bare").Type("bool").MarshalAs(CSharpUnmanagedKind.I4),
                    e => e.Map<CppParameter>("git_repository_discover::across_fs").Type("bool").MarshalAs(CSharpUnmanagedKind.I4),
                    e => e.Map<CppParameter>("git_repository_init_init_options::version").InitValue("GIT_REPOSITORY_INIT_OPTIONS_VERSION"),
                    e => e.Map<CppParameter>("git_repository_set_workdir::update_gitlink").Type("bool").MarshalAs(CSharpUnmanagedKind.I4),
                    e => e.Map<CppField>("git_repository_init_options::flags").Type("git_repository_init_flag_t"),
                    e => e.Map<CppField>("git_repository_init_options::mode").Type("git_repository_init_mode_t"),
                    e => e.Map<CppFunction>("git_repository_state").Type("git_repository_state_t"),
                    e => e.Map<CppFunction>("git_repository_is_shallow").Type("bool").MarshalAs(CSharpUnmanagedKind.I4),
                    e => e.Map<CppFunction>("git_repository_ident").Type("git_result"),
                    e => e.Map<CppFunction>("git_repository_set_ident").Type("git_result"),

You see that I have to manually do this mapping and CppAst.CodeGen is helping (to change the mapping easily), but cannot be of any help to decide that this specific int is going to be a flag or a boolean or a git_result.

For example, I proposed years ago to libgit2 libgit2/libgit2#3385 (even before I made this project 😅 ) to correctly type method with a proper git_error_code or git_result but they refused, meaning that you have to infer this manually, which is super laborious.

I tried to overcome that by parsing the comment in the codegen, and If I see a pattern that says that it looks like the int returned is actually a git_result then I turn the type into a git_result:

GitLib.NET/src/GitLib.CodeGen/Program.cs

Lines 281 to 309 in 65b05d8

	// If the function is not registered as a git_result, we will try to detect if it is a potential one
	if (!_gitResultFunctions.Contains(cppFunction.Name) && !_gitResultFunctionsWithBoolReturned.Contains(cppFunction.Name))
	{
	if (cppFunction.Comment == null) return;
	// Start from the bottom of the comments to catch "return" more quickly
	for (int i = cppFunction.Comment.Children.Count - 1; i >= 0; i--)
	{
	var csComment = cppFunction.Comment.Children[i];
	if (csComment is CppCommentBlockCommand blockCommand && blockCommand.CommandName == "return")
	{
	var returnText = blockCommand.ChildrenToString().Trim().Replace("\r\n", " ")
	.Replace("\n", " ");
	if ((returnText.StartsWith("Zero") || returnText.StartsWith("0")) &&
	(returnText.Contains("failure") || returnText.Contains("error")))
	{
	var includeName = Path.GetFileName(cppFunction.Span.Start.File);
	if (!_gitResultFunctionsDetectedButNotRegistered.TryGetValue(includeName,
	out var functionList))
	{
	functionList = new List<string>();
	_gitResultFunctionsDetectedButNotRegistered.Add(includeName, functionList);
	}
	functionList.Add(cppFunction.Name);
	}
	}
	}

But there are many APIs that don't consistently have these comments, and so you have also to map these API types manually.

That's why basically I stopped this project. That was too much work! 😅