fix: Improve reference handling a bit

libgdx · Jan 15, 2025 · 98df216 · 98df216
1 parent b76f1f9
commit 98df216
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 1 deletion.
diff --git a/compiling/gdx-jnigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/Manager.java b/compiling/gdx-jnigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/Manager.java
@@ -155,6 +155,10 @@ public boolean hasCTypeMapping(String name) {
         return getCTypeMapping(name) != null;
     }
 
+    public boolean hasFunctionWithName(String name) {
+        return globalType.getFunctions().stream().anyMatch(functionType -> functionType.getSignature().getName().equals(name));
+    }
+
     public void addClosure(ClosureType closureType) {
         globalType.addClosure(closureType);
     }

diff --git a/...nigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/parser/CommentParser.java b/...nigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/parser/CommentParser.java
@@ -1,5 +1,6 @@
 package com.badlogic.gdx.jnigen.generator.parser;
 
+import com.badlogic.gdx.jnigen.generator.Manager;
 import org.bytedeco.llvm.clang.CXCursor;
 import org.bytedeco.llvm.clang.CXString;
 
@@ -9,6 +10,7 @@
 
 public class CommentParser {
 
+    private static final String SEE_TAG = "@see";
     private final CXCursor cursor;
 
     public CommentParser (CXCursor cursor) {
@@ -19,6 +21,29 @@ public boolean isPresent() {
         return clang_Cursor_getRawCommentText(cursor).data() != null;
     }
 
+    public String normalizeSee(String comment) {
+        // This method assumes, that the targeted struct/function is already seen
+        int see = comment.indexOf(SEE_TAG);
+        if (see < 0)
+            return comment;
+
+        String ref = comment.substring(see + SEE_TAG.length()).trim();
+        String base = comment.substring(0, see + SEE_TAG.length());
+
+        if (ref.contains("."))
+            ref = ref.replace(".", "#");
+
+        if (Manager.getInstance().hasCTypeMapping(ref))
+            return base + " " + ref;
+
+        if (!Manager.getInstance().hasFunctionWithName(ref))
+            return base + " " + ref;
+
+        ref = Manager.getInstance().getGlobalType().abstractType() + "#" + ref;
+
+        return base + " " + ref;
+    }
+
     public String parse () {
         CXString string = clang_Cursor_getRawCommentText(cursor);
         if (string.data() == null)
@@ -35,11 +60,15 @@ public String parse () {
             comment = comment.replace("*/", "");
             comment = comment.lines()
                     .map(String::trim)
-                    .filter(s -> !s.isBlank())
+                    .filter(s -> !s.isEmpty())
                     .map(s -> s.startsWith("*") ? s.substring(1) : s)
                     .collect(Collectors.joining("\n"));
         }
 
+        comment = comment.lines()
+                .map(this::normalizeSee)
+                .collect(Collectors.joining("\n"));
+
         return comment;
     }
 }
diff --git a/...-jnigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/types/FunctionType.java b/...-jnigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/types/FunctionType.java
@@ -22,6 +22,10 @@ public FunctionType(FunctionSignature signature, String comment) {
         this.comment = comment;
     }
 
+    public FunctionSignature getSignature() {
+        return signature;
+    }
+
     public void write(CompilationUnit cu, ClassOrInterfaceDeclaration wrappingClass, HashMap<MethodDeclaration, String> patchNativeMethod) {
         String name = signature.getName();
         TypeDefinition returnType = signature.getReturnType();

diff --git a/...dx-jnigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/types/GlobalType.java b/...dx-jnigen-generator/src/main/java/com/badlogic/gdx/jnigen/generator/types/GlobalType.java
@@ -43,6 +43,9 @@ public void addFunction(FunctionType functionType) {
         functions.add(functionType);
     }
 
+    public List<FunctionType> getFunctions() {
+        return functions;
+    }
 
     public void write(CompilationUnit cuPublic, ClassOrInterfaceDeclaration global, CompilationUnit cuInternal, ClassOrInterfaceDeclaration globalInternal, HashMap<MethodDeclaration, String> patchNativeMethods) {
         cuPublic.addImport(ClassNameConstants.CXXEXCEPTION_CLASS);

diff --git a/gdx-jnigen-generator-test/src/test/java/com/badlogic/jnigen/generated/TestData.java b/gdx-jnigen-generator-test/src/test/java/com/badlogic/jnigen/generated/TestData.java
@@ -534,6 +534,10 @@ public static TestEnum returnTestEnum() {
     	return 0;
     */
 
+    /**
+     * Combined attempt
+     * @see TestData#returnTestEnum
+     */
     public static TestEnum passAndReturnTestEnum(TestEnum enumValue) {
         return TestEnum.getByIndex((int) passAndReturnTestEnum_internal(enumValue.getIndex()));
     }

diff --git a/gdx-jnigen-generator-test/src/test/resources/test_data.h b/gdx-jnigen-generator-test/src/test/resources/test_data.h
@@ -260,6 +260,8 @@ void call_methodWithCallbackTestStructPointerArg(methodWithCallbackTestStructPoi
 // TestEnum stuff
 int passTestEnum(TestEnum enumValue);
 TestEnum returnTestEnum(void);
+/// Combined attempt
+/// @see returnTestEnum
 TestEnum passAndReturnTestEnum(TestEnum enumValue);
 
 int passTestEnumPointer(TestEnum* enumValue);