Using node builder functions for Go language frontend (#968)

* Using declaration builder * Using statement builder * Using expression builders * Added const for package and classes
Fraunhofer-AISEC · Nov 22, 2022 · f436359 · f436359
1 parent 3db2e54
commit f436359
Show file tree

Hide file tree

Showing 30 changed files with 347 additions and 581 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,4 @@ logs
 *.so
 *.log
 
+gradle.properties
diff --git a/configure_frontends.sh b/configure_frontends.sh
diff --git a/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/frontends/cpp/ExpressionHandler.kt b/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/frontends/cpp/ExpressionHandler.kt
@@ -343,9 +343,9 @@ class ExpressionHandler(lang: CXXLanguageFrontend) :
         }
 
         return newMemberExpression(
+            ctx.fieldName.toString(),
             base,
             UnknownType.getUnknownType(language),
-            ctx.fieldName.toString(),
             if (ctx.isPointerDereference) "->" else ".",
             ctx.rawSignature
         )

diff --git a/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/frontends/java/DeclarationHandler.java b/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/frontends/java/DeclarationHandler.java
@@ -354,6 +354,7 @@ public RecordDeclaration handleClassOrInterfaceDeclaration(
               null,
               null,
               null,
+              null,
               false);
       field.setImplicit(true);
 

diff --git a/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/frontends/java/ExpressionHandler.java b/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/frontends/java/ExpressionHandler.java
@@ -381,11 +381,11 @@ private DeclarationStatement handleVariableDeclarationExpr(Expression expr) {
       MemberExpression memberExpression =
           newMemberExpression(
               this,
+              fieldAccessExpr.getName().getIdentifier(),
               base,
               fieldType,
-              fieldAccessExpr.getName().getIdentifier(),
-              ".", // there is only "." in java
-              fieldAccessExpr.toString());
+              "." // there is only "." in java
+              );
       memberExpression.setStaticAccess(true);
       return memberExpression;
     }
@@ -395,12 +395,7 @@ private DeclarationStatement handleVariableDeclarationExpr(Expression expr) {
     }
 
     return newMemberExpression(
-        this,
-        base,
-        fieldType,
-        fieldAccessExpr.getName().getIdentifier(),
-        ".",
-        fieldAccessExpr.toString());
+        this, fieldAccessExpr.getName().getIdentifier(), base, fieldType, ".");
   }
 
   private Literal handleLiteralExpression(Expression expr) {

diff --git a/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/graph/DeclarationBuilder.kt b/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/graph/DeclarationBuilder.kt
@@ -32,6 +32,7 @@ import de.fraunhofer.aisec.cpg.graph.declarations.*
 import de.fraunhofer.aisec.cpg.graph.statements.expressions.ArrayCreationExpression
 import de.fraunhofer.aisec.cpg.graph.statements.expressions.Expression
 import de.fraunhofer.aisec.cpg.graph.types.Type
+import de.fraunhofer.aisec.cpg.graph.types.UnknownType
 import de.fraunhofer.aisec.cpg.sarif.PhysicalLocation
 
 /**
@@ -87,8 +88,8 @@ fun MetadataProvider.newFunctionDeclaration(
 fun MetadataProvider.newMethodDeclaration(
     name: String?,
     code: String? = null,
-    isStatic: Boolean,
-    recordDeclaration: RecordDeclaration?,
+    isStatic: Boolean = false,
+    recordDeclaration: RecordDeclaration? = null,
     rawNode: Any? = null
 ): MethodDeclaration {
     val node = MethodDeclaration()
@@ -134,8 +135,8 @@ fun MetadataProvider.newConstructorDeclaration(
 @JvmOverloads
 fun MetadataProvider.newParamVariableDeclaration(
     name: String?,
-    type: Type?,
-    variadic: Boolean,
+    type: Type? = UnknownType.getUnknownType(),
+    variadic: Boolean = false,
     code: String? = null,
     rawNode: Any? = null
 ): ParamVariableDeclaration {
@@ -159,9 +160,9 @@ fun MetadataProvider.newParamVariableDeclaration(
 @JvmOverloads
 fun MetadataProvider.newVariableDeclaration(
     name: String?,
-    type: Type?,
+    type: Type? = UnknownType.getUnknownType(),
     code: String? = null,
-    implicitInitializerAllowed: Boolean,
+    implicitInitializerAllowed: Boolean = false,
     rawNode: Any? = null
 ): VariableDeclaration {
     val node = VariableDeclaration()
@@ -340,12 +341,12 @@ fun MetadataProvider.newEnumConstantDeclaration(
 @JvmOverloads
 fun MetadataProvider.newFieldDeclaration(
     name: String?,
-    type: Type?,
-    modifiers: List<String?>?,
+    type: Type? = UnknownType.getUnknownType(),
+    modifiers: List<String?>? = listOf(),
     code: String? = null,
-    location: PhysicalLocation?,
-    initializer: Expression?,
-    implicitInitializerAllowed: Boolean,
+    location: PhysicalLocation? = null,
+    initializer: Expression? = null,
+    implicitInitializerAllowed: Boolean = false,
     rawNode: Any? = null
 ): FieldDeclaration {
     val node = FieldDeclaration()

diff --git a/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/graph/ExpressionBuilder.kt b/cpg-core/src/main/java/de/fraunhofer/aisec/cpg/graph/ExpressionBuilder.kt
@@ -41,7 +41,7 @@ import de.fraunhofer.aisec.cpg.graph.types.UnknownType
 @JvmOverloads
 fun <T> MetadataProvider.newLiteral(
     value: T,
-    type: Type?,
+    type: Type? = UnknownType.getUnknownType(),
     code: String? = null,
     rawNode: Any? = null,
 ): Literal<T> {
@@ -114,7 +114,7 @@ fun MetadataProvider.newUnaryOperator(
 @JvmOverloads
 fun MetadataProvider.newNewExpression(
     code: String? = null,
-    type: Type?,
+    type: Type? = UnknownType.getUnknownType(),
     rawNode: Any? = null
 ): NewExpression {
     val node = NewExpression()
@@ -179,8 +179,8 @@ fun MetadataProvider.newConditionalExpression(
  */
 @JvmOverloads
 fun MetadataProvider.newKeyValueExpression(
-    key: Expression?,
-    value: Expression?,
+    key: Expression? = null,
+    value: Expression? = null,
     code: String? = null,
     rawNode: Any? = null
 ): KeyValueExpression {
@@ -238,10 +238,10 @@ fun MetadataProvider.newCompoundStatementExpression(
  */
 @JvmOverloads
 fun MetadataProvider.newCallExpression(
-    callee: Expression?,
-    fqn: String?,
+    callee: Expression? = null,
+    fqn: String? = null,
     code: String? = null,
-    template: Boolean,
+    template: Boolean = false,
     rawNode: Any? = null
 ): CallExpression {
     val node = CallExpression()
@@ -288,10 +288,10 @@ fun MetadataProvider.newMemberCallExpression(
     fqn: String?,
     base: Expression?,
     member: Node?,
-    operatorCode: String?,
+    operatorCode: String? = ".",
     code: String? = null,
     rawNode: Any? = null
-): CallExpression {
+): MemberCallExpression {
     val node = MemberCallExpression()
     node.applyMetadata(this, rawNode, code)
 
@@ -313,10 +313,10 @@ fun MetadataProvider.newMemberCallExpression(
  */
 @JvmOverloads
 fun MetadataProvider.newMemberExpression(
-    base: Expression,
-    memberType: Type?,
     name: String?,
-    operatorCode: String?,
+    base: Expression,
+    memberType: Type? = UnknownType.getUnknownType(),
+    operatorCode: String? = ".",
     code: String? = null,
     rawNode: Any? = null
 ): MemberExpression {

diff --git a/cpg-language-go/src/main/golang/basic_types.go b/cpg-language-go/src/main/golang/basic_types.go
@@ -41,12 +41,21 @@ func NewString(s string) *jnigi.ObjectRef {
 	return o
 }
 
+func NewBoolean(b bool) *jnigi.ObjectRef {
+	// TODO: Use Boolean.valueOf
+	o, err := env.NewObject("java/lang/Boolean", b)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	return o
+}
+
 func NewInteger(i int) *jnigi.ObjectRef {
 	// TODO: Use Integer.valueOf
 	o, err := env.NewObject("java/lang/Integer", i)
 	if err != nil {
 		log.Fatal(err)
-
 	}
 
 	return o
@@ -57,7 +66,6 @@ func NewDouble(d float64) *jnigi.ObjectRef {
 	o, err := env.NewObject("java/lang/Double", d)
 	if err != nil {
 		log.Fatal(err)
-
 	}
 
 	return o

diff --git a/cpg-language-go/src/main/golang/declarations.go b/cpg-language-go/src/main/golang/declarations.go
@@ -32,7 +32,7 @@ import (
 	"tekao.net/jnigi"
 )
 
-type Declaration jnigi.ObjectRef
+type Declaration Node
 type IncludeDeclaration jnigi.ObjectRef
 type TranslationUnitDeclaration Declaration
 type FunctionDeclaration Declaration
@@ -43,6 +43,14 @@ type VariableDeclaration Declaration
 type ParamVariableDeclaration Declaration
 type NamespaceDeclaration Declaration
 
+const DeclarationsPackage = GraphPackage + "/declarations"
+const DeclarationClass = DeclarationsPackage + "/Declaration"
+const RecordDeclarationClass = DeclarationsPackage + "/RecordDeclaration"
+const FunctionDeclarationClass = DeclarationsPackage + "/FunctionDeclaration"
+const VariableDeclarationClass = DeclarationsPackage + "/VariableDeclaration"
+const IncludeDeclarationClass = DeclarationsPackage + "/IncludeDeclaration"
+const TranslationUnitDeclarationClass = DeclarationsPackage + "/TranslationUnitDeclaration"
+
 func (n *NamespaceDeclaration) SetName(s string) error {
 	return (*Node)(n).SetName(s)
 }
@@ -71,9 +79,7 @@ func (f *FunctionDeclaration) SetReturnTypes(types []*Type) (err error) {
 		return err
 	}
 
-	// Stupid workaround, since casting does not work. See
-	// https://github.com/timob/jnigi/issues/60
-	var funcDecl = jnigi.WrapJObject(uintptr((*jnigi.ObjectRef)(f).JObject()), "de/fraunhofer/aisec/cpg/graph/declarations/FunctionDeclaration", false)
+	var funcDecl = (*jnigi.ObjectRef)(f).Cast(FunctionDeclarationClass)
 
 	err = (*jnigi.ObjectRef)(funcDecl).CallMethod(env, "setReturnTypes", nil, list.Cast("java/util/List"))
 
@@ -85,7 +91,7 @@ func (f *FunctionDeclaration) AddParameter(p *ParamVariableDeclaration) {
 }
 
 func (f *FunctionDeclaration) SetBody(s *Statement) (err error) {
-	err = (*jnigi.ObjectRef)(f).CallMethod(env, "setBody", nil, (*jnigi.ObjectRef)(s).Cast("de/fraunhofer/aisec/cpg/graph/statements/Statement"))
+	err = (*jnigi.ObjectRef)(f).CallMethod(env, "setBody", nil, (*jnigi.ObjectRef)(s).Cast(StatementClass))
 
 	return
 }
@@ -103,7 +109,7 @@ func (m *MethodDeclaration) SetReceiver(v *VariableDeclaration) error {
 }
 
 func (m *MethodDeclaration) GetReceiver() *VariableDeclaration {
-	o := jnigi.NewObjectRef("de/fraunhofer/aisec/cpg/graph/declarations/VariableDeclaration")
+	o := jnigi.NewObjectRef(VariableDeclarationClass)
 	err := (*jnigi.ObjectRef)(m).GetField(env, "receiver", o)
 
 	if err != nil {
@@ -143,7 +149,7 @@ func (v *VariableDeclaration) IsNil() bool {
 }
 
 func (v *VariableDeclaration) SetInitializer(e *Expression) (err error) {
-	err = (*jnigi.ObjectRef)(v).CallMethod(env, "setInitializer", nil, (*jnigi.ObjectRef)(e).Cast("de/fraunhofer/aisec/cpg/graph/statements/expressions/Expression"))
+	err = (*jnigi.ObjectRef)(v).CallMethod(env, "setInitializer", nil, (*jnigi.ObjectRef)(e).Cast(ExpressionClass))
 
 	return
 }
@@ -153,7 +159,7 @@ func (v *VariableDeclaration) Declaration() *Declaration {
 }
 
 func (t *TranslationUnitDeclaration) GetIncludeByName(s string) *IncludeDeclaration {
-	var i = jnigi.NewObjectRef("de/fraunhofer/aisec/cpg/graph/declarations/IncludeDeclaration")
+	var i = jnigi.NewObjectRef(IncludeDeclarationClass)
 	err := (*jnigi.ObjectRef)(t).CallMethod(env, "getIncludeByName", i, NewString(s))
 	if err != nil {
 		log.Fatal(err)
@@ -196,5 +202,5 @@ func (r *CompoundStatement) IsNil() bool {
 }
 
 func (c *CaseStatement) SetCaseExpression(e *Expression) error {
-	return (*jnigi.ObjectRef)(c).SetField(env, "caseExpression", (*jnigi.ObjectRef)(e).Cast("de/fraunhofer/aisec/cpg/graph/statements/expressions/Expression"))
+	return (*jnigi.ObjectRef)(c).SetField(env, "caseExpression", (*jnigi.ObjectRef)(e).Cast(ExpressionClass))
 }