feat(chapi-ast-c): add override to addSource method #24

This commit adds the `override` keyword to the `addSource` method in the `CAnalyser` class. This ensures that the method is properly overridden from the parent class.
phodal · Feb 1, 2024 · ce431e4 · ce431e4
1 parent 023fabe
commit ce431e4
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 11 deletions.
diff --git a/chapi-ast-c/.gitignore b/chapi-ast-c/.gitignore
@@ -0,0 +1 @@
+result.json
diff --git a/chapi-ast-c/src/main/kotlin/chapi/ast/cast/CAnalyser.kt b/chapi-ast-c/src/main/kotlin/chapi/ast/cast/CAnalyser.kt
@@ -23,10 +23,7 @@ open class CAnalyser : Analyser {
         pp.listener = DefaultPreprocessorListener()
     }
 
-    /**
-     * Adds a source code to the program, for example, C header files.
-     */
-    fun addSource(code: String) {
+    override fun addSource(code: String) {
         pp.addInput(LexerSource(InputStreamReader(code.byteInputStream()), true))
     }
 

diff --git a/chapi-ast-c/src/main/kotlin/chapi/ast/cast/CFullIdentListener.kt b/chapi-ast-c/src/main/kotlin/chapi/ast/cast/CFullIdentListener.kt
@@ -63,11 +63,18 @@ open class CFullIdentListener(fileName: String, includes: MutableList<String>) :
         ctx?.structDeclarationList()?.structDeclaration()?.forEach { structDeclCtx ->
             /// for forward struct declaration
             structDeclCtx.structDeclaratorList()?.let {
-                val type = structDeclCtx.specifierQualifierList()?.typeSpecifier()?.let {
-                    val specifier = it.structOrUnionSpecifier()
+                var type = structDeclCtx.specifierQualifierList()?.typeSpecifier()?.let { typeSpec ->
+                    val specifier = typeSpec.structOrUnionSpecifier()
                     specifier?.structOrUnion()?.text + " " + specifier?.Identifier()?.text
                 }
-                val value = structDeclCtx.specifierQualifierList()?.specifierQualifierList()?.text ?: ""
+                var value: String? = null
+
+                if (type == null || type == "null null") {
+                    type = structDeclCtx.specifierQualifierList()?.typeSpecifier()?.text ?: ""
+                    value = it.structDeclarator()?.firstOrNull()?.declarator()?.text ?: ""
+                } else {
+                    value = structDeclCtx.specifierQualifierList()?.specifierQualifierList()?.text ?: ""
+                }
 
                 val field = CodeField(
                     TypeType = type ?: "",

diff --git a/chapi-ast-c/src/test/kotlin/chapi/ast/cast/CFullIdentListenerTest.kt b/chapi-ast-c/src/test/kotlin/chapi/ast/cast/CFullIdentListenerTest.kt
@@ -1,9 +1,12 @@
 package chapi.ast.cast
 
+import chapi.domain.core.CodeContainer
 import kotlinx.coroutines.flow.asFlow
 import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.flow.mapNotNull
 import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
 import org.junit.jupiter.api.Test
 import java.io.File
 import kotlin.test.assertEquals
@@ -14,21 +17,33 @@ internal class CFullIdentListenerTest {
     @Test
     fun allGrammarUnderResources() {
         val content = this::class.java.getResource("/grammar")!!.toURI()
-//        val content = "/Users/phodal/Downloads/redis-unstable"
+//        val content = "/Users/phodal/Downloads/redis-unstable/deps/lua"
         val totalStart = System.currentTimeMillis()
         runBlocking {
-            File(content).walkTopDown().asFlow().mapNotNull {
+            val analyser = CAnalyser()
+            val fileFlow = File(content).walkTopDown().asFlow()
+            fileFlow.mapNotNull {
+                if (it.isFile && (it.extension == "c" || it.extension == "h")) {
+                    analyser.addSource(it.readText())
+                }
+            }
+
+            val result: MutableList<CodeContainer> = mutableListOf()
+            fileFlow.mapNotNull {
                 if (it.isFile && (it.extension == "c" || it.extension == "h")) {
                     val start = System.currentTimeMillis()
                     println("Analyse ${it.path}")
-                    val analysis = CAnalyser().analysis(it.readText(), it.name)
+                    val analysis = analyser.analysis(it.readText(), it.name)
                     val end = System.currentTimeMillis()
                     println("cost ${end - start}ms")
-                    analysis
+                    result += analysis
                 } else {
                     null
                 }
             }.collect()
+
+            // log to file
+            File("result.json").writeText(Json.encodeToString(result))
         }
 
         val totalEnd = System.currentTimeMillis()
@@ -78,6 +93,24 @@ struct list_el {
         assertEquals(codeFile.DataStructures[0].Fields[0].TypeValue, "val")
     }
 
+    @Test
+    internal fun shouldIdentifyStructWithPointer() {
+        val code = """
+typedef struct Mbuffer {
+  char *buffer;
+  size_t n;
+  size_t buffsize;
+} Mbuffer;
+
+"""
+        val codeFile = CAnalyser().analysis(code, "helloworld.c")
+
+        assertEquals(codeFile.DataStructures.size, 1)
+        assertEquals(codeFile.DataStructures[0].Fields.size, 3)
+        assertEquals(codeFile.DataStructures[0].Fields[0].TypeType, "char")
+        assertEquals(codeFile.DataStructures[0].Fields[0].TypeValue, "*buffer")
+    }
+
     @Test
     internal fun shouldIdentifyStructFunction() {
         val code = """

diff --git a/chapi-domain/src/main/kotlin/chapi/parser/Analyser.kt b/chapi-domain/src/main/kotlin/chapi/parser/Analyser.kt
@@ -1,13 +1,23 @@
 package chapi.parser
 
 import chapi.domain.core.CodeContainer
+import chapi.domain.core.Since
 
 enum class ParseMode {
     Basic, Full
 }
 
 // todo: add support for kotlin & java
 interface Analyser {
+
+    /**
+     * Adds a source code to the program, for example, C header files.
+     */
+    @Since("2.3.4")
+    fun addSource(code: String) {
+
+    }
+
     fun analysis(code: String, filePath: String): CodeContainer
 }