generate traversal filter steps for 'property does not equal' (#158)

joernio · Mar 11, 2024 · 7cbc49b · 7cbc49b
1 parent bc38b02
commit 7cbc49b
Show file tree

Hide file tree

Showing 10 changed files with 630 additions and 43 deletions.
diff --git a/build.sbt b/build.sbt
@@ -100,6 +100,21 @@ lazy val odbConvert = project
     )
   )
 
+/** temporarily we still want to keep the generated files for the cpg domain in here,
+  * in order to be able to quickly see the differences in the generated files if we
+  * change the codegen
+  * n.b. relies on a manually published version of cpg-schema from https://github.com/ShiftLeftSecurity/codepropertygraph/tree/michael/flatgraph
+  */
+lazy val domainClassesGeneratorJoern = project
+  .in(file("domain-classes-generator-joern"))
+  .dependsOn(domainClassesGenerator_3)
+  .settings(
+    name := "domain-classes-generator-joern",
+    scalaVersion := scala3,
+    publish / skip := true,
+    libraryDependencies += "io.shiftleft" %% "codepropertygraph-schema" % "1.6.6+21-c6774ab5"
+  )
+
 lazy val joernGenerated = project
   .in(file("joern-generated"))
   .dependsOn(core)

diff --git a/domain-classes-generator/src/main/scala/flatgraph/codegen/CodeSnippets.scala b/domain-classes-generator/src/main/scala/flatgraph/codegen/CodeSnippets.scala
@@ -161,6 +161,20 @@ object CodeSnippets {
          |}
          |
          |/**
+         |  * Traverse to nodes where the $nameCamelCase is not equal to the given `value`
+         |  * */
+         |def ${nameCamelCase}Not(value: $baseType): Iterator[NodeType] =
+         |  traversal.filter{_.$nameCamelCase != value}
+         |
+         |/**
+         |  * Traverse to nodes where the $nameCamelCase is not equal to any of the given `values`
+         |  * */
+         |def ${nameCamelCase}Not(values: $baseType*): Iterator[NodeType] = {
+         |  val vset = values.toSet
+         |  traversal.filter{node => !vset.contains(node.$nameCamelCase)}
+         |}
+         |
+         |/**
          |  * Traverse to nodes where the $nameCamelCase is greater than the given `value`
          |  * */
          |def ${nameCamelCase}Gt(value: $baseType): Iterator[NodeType] =
@@ -203,6 +217,20 @@ object CodeSnippets {
          |}
          |
          |/**
+         |  * Traverse to nodes where the $nameCamelCase is not equal to the given `value`
+         |  * */
+         |def ${nameCamelCase}Not(value: $baseType): Iterator[NodeType] =
+         |  traversal.filter{node => val tmp = node.$nameCamelCase; tmp.isEmpty || tmp.get != value}
+         |
+         |/**
+         |  * Traverse to nodes where the $nameCamelCase does not equal any one of the given `values`
+         |  * */
+         |def ${nameCamelCase}Not(values: $baseType*): Iterator[NodeType] = {
+         |  val vset = values.toSet
+         |  traversal.filter{node => val tmp = node.$nameCamelCase; tmp.isEmpty || !vset.contains(tmp.get)}
+         |}
+         |
+         |/**
          |  * Traverse to nodes where the $nameCamelCase is greater than the given `value`
          |  * */
          |def ${nameCamelCase}Gt(value: $baseType): Iterator[NodeType] =
@@ -241,9 +269,22 @@ object CodeSnippets {
          |  * */
          |def $nameCamelCase(values: $baseType*): Iterator[NodeType] = {
          |  val vset = values.toSet
-         |  traversal.filter{node => !vset.contains(node.$nameCamelCase)}
+         |  traversal.filter{node => vset.contains(node.$nameCamelCase)}
          |}
          |
+         |/**
+         |  * Traverse to nodes where the $nameCamelCase does not equal the given `value`
+         |  * */
+         |def ${nameCamelCase}Not(value: $baseType): Iterator[NodeType] =
+         |  traversal.filter{_.$nameCamelCase != value}
+         |
+         |/**
+         |  * Traverse to nodes where the $nameCamelCase does not equal any one of the given `values`
+         |  * */
+         |def ${nameCamelCase}Not(values: $baseType*): Iterator[NodeType] = {
+         |  val vset = values.toSet
+         |  traversal.filter{node => !vset.contains(node.$nameCamelCase)}
+         |}
          |""".stripMargin
     }
 
@@ -259,7 +300,21 @@ object CodeSnippets {
          |  * */
          |def $nameCamelCase(values: $baseType*): Iterator[NodeType] = {
          |  val vset = values.toSet
-         |  traversal.filter{node => node.$nameCamelCase.isDefined && !vset.contains(node.$nameCamelCase.get)}
+         |  traversal.filter{node => node.$nameCamelCase.isDefined && vset.contains(node.$nameCamelCase.get)}
+         |}
+         |
+         |/**
+         |  * Traverse to nodes where the $nameCamelCase does not equal the given `value`
+         |  * */
+         |def ${nameCamelCase}Not(value: $baseType): Iterator[NodeType] =
+         |  traversal.filter{node => node.$nameCamelCase.empty || node.$nameCamelCase.get != value}
+         |
+         |/**
+         |  * Traverse to nodes where the $nameCamelCase does not equal any one of the given `values`
+         |  * */
+         |def ${nameCamelCase}Not(values: $baseType*): Iterator[NodeType] = {
+         |  val vset = values.toSet
+         |  traversal.filter{node => node.$nameCamelCase.empty || !vset.contains(node.$nameCamelCase.get)}
          |}
          |""".stripMargin
     }

diff --git a/joern-generated/src/main/scala/io/shiftleft/codepropertygraph/generated/Accessors.scala b/joern-generated/src/main/scala/io/shiftleft/codepropertygraph/generated/Accessors.scala
@@ -778,6 +778,14 @@ object Accessors {
       case stored: nodes.StoredNode   => new Access_Property_NAME(stored).name
       case newNode: nodes.NewTypeDecl => newNode.name
     }
+    def offset: Option[Int] = node match {
+      case stored: nodes.StoredNode   => new Access_Property_OFFSET(stored).offset
+      case newNode: nodes.NewTypeDecl => newNode.offset
+    }
+    def offsetEnd: Option[Int] = node match {
+      case stored: nodes.StoredNode   => new Access_Property_OFFSET_END(stored).offsetEnd
+      case newNode: nodes.NewTypeDecl => newNode.offsetEnd
+    }
   }
   final class Access_TypeParameterBase(val node: nodes.TypeParameterBase) extends AnyVal {
     def name: String = node match {