feat(c): add support for single line macro declaration #24

Add support for single line macro declaration in the C grammar. This allows parsing and analyzing single line macros in C code.
phodal · Jan 31, 2024 · 56c876f · 56c876f
1 parent 8b20ca2
commit 56c876f
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 14 deletions.
diff --git a/chapi-ast-c/build.gradle.kts b/chapi-ast-c/build.gradle.kts
@@ -32,6 +32,9 @@ dependencies {
 
     implementation("org.antlr:antlr4:4.13.1")
     implementation("org.antlr:antlr4-runtime:4.13.1")
+
+    // coroutines
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0-RC2")
 }
 
 sourceSets.main {

diff --git a/chapi-ast-c/src/main/antlr/C.g4 b/chapi-ast-c/src/main/antlr/C.g4
@@ -38,10 +38,6 @@ compilationUnit
     : (externalDeclaration | statement)* EOF
     ;
 
-macroKeywords
-    :  'if' | 'undef' | 'else' | 'pragma' | 'endif' | 'ifdef' | 'ifndef' | 'elif' | 'define'
-    ;
-
 MultiLineMacro
     : '#' (~[\n]*? '\\' '\r'? '\n')+ ~ [\n]+ -> channel (HIDDEN)
     ;
@@ -268,6 +264,7 @@ structDeclarationList
 structDeclaration // The first two rules have priority order and cannot be simplified to one expression.
     : specifierQualifierList structDeclaratorList? ';'
     | staticAssertDeclaration
+    | singleLineMacroDeclaration
     ;
 
 specifierQualifierList
@@ -479,6 +476,10 @@ singleLineMacroDeclaration
     | '#' '#'? Identifier                                                                #macroCastDeclaration
     ;
 
+macroKeywords
+    :  'if' | 'undef' | 'else' | 'pragma' | 'endif' | 'ifdef' | 'ifndef' | 'elif' | 'define'
+    ;
+
 labeledStatement
     : Identifier ':' statement?
     | 'case' constantExpression ':' statement

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,5 +1,9 @@
 package chapi.ast.cast
 
+import kotlinx.coroutines.flow.asFlow
+import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.flow.mapNotNull
+import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.Test
 import java.io.File
 import kotlin.test.assertEquals
@@ -9,16 +13,20 @@ internal class CFullIdentListenerTest {
     @Test
     fun allGrammarUnderResources() {
         val content = this::class.java.getResource("/grammar")!!.toURI()
-//        val content = "/Users/phodal/Downloads/redis-unstable/deps/jemalloc/src"
-        File(content).walkTopDown().forEach {
-            if (it.isFile && (it.extension == "c" || it.extension == "h")) {
-                val start = System.currentTimeMillis()
-                println("Analyse ${it.path}")
-                CAnalyser().analysis(it.readText(), it.name)
-                val end = System.currentTimeMillis()
-                val seconds = (end - start) / 1000
-                println("cost ${end - start}ms")
-            }
+//        val content = "/Users/phodal/Downloads/redis-unstable"
+        runBlocking {
+            File(content).walkTopDown().asFlow().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 end = System.currentTimeMillis()
+                    println("cost ${end - start}ms")
+                    analysis
+                } else {
+                    null
+                }
+            }.collect()
         }
     }
 
@@ -550,4 +558,33 @@ typedef struct {
         val codeFile = CAnalyser().analysis(code, "helloworld.c")
         assertEquals(codeFile.DataStructures.size, 0)
     }
+
+    @Test
+    fun shouldHandleMacroIArrayDefine() {
+        val code = """
+            static char log_filename[
+            #ifdef JEMALLOC_PROF
+                PATH_MAX +
+            #endif
+                1];
+            """.trimIndent()
+
+        val codeFile = CAnalyser().analysis(code, "helloworld.c")
+        assertEquals(codeFile.DataStructures.size, 0)
+    }
+
+    @Test
+    fun shouldEnableMacroInTypedefStruct() {
+        val code = """
+            typedef struct {
+                uint64_t ns;
+            #ifdef JEMALLOC_DEBUG
+                uint32_t magic; /* Tracks if initialized. */
+            #endif
+            } nstime_t;
+            """.trimIndent()
+
+        val codeFile = CAnalyser().analysis(code, "helloworld.c")
+        assertEquals(codeFile.DataStructures.size, 1)
+    }
 }