semanticcpg apidocs/io.joern.x2cpg/X2CpgFrontend

X2CpgFrontend

trait X2CpgFrontend[T <: X2CpgConfig[_]]

Trait that represents a CPG generator, where T is the frontend configuration class.

class Object
trait Matchable
class Any

Value members

Abstract methods

def createCpg(config: T): Try[Cpg]

Create a CPG according to given configuration. Returns CPG wrapped in a Try, making it possible to detect and inspect exceptions in CPG generation. To be provided by the frontend.

Create a CPG according to given configuration. Returns CPG wrapped in a Try, making it possible to detect and inspect exceptions in CPG generation. To be provided by the frontend.

Concrete methods

def createCpg(inputName: String, outputName: Option[String])(implicit defaultConfig: T): Try[Cpg]

Create a CPG for code at inputName (a single location) with default frontend configuration. If outputName exists, it is the file name of the resulting CPG. Otherwise, the CPG is held in memory.

Create a CPG for code at inputName (a single location) with default frontend configuration. If outputName exists, it is the file name of the resulting CPG. Otherwise, the CPG is held in memory.

def createCpg(inputName: String)(implicit defaultConfig: T): Try[Cpg]

Create a CPG in memory for file at inputName with default configuration.

Create a CPG in memory for file at inputName with default configuration.

def createCpgWithOverlays(config: T): Try[Cpg]

Create a CPG with default overlays according to given configuration

Create a CPG with default overlays according to given configuration

def createCpgWithOverlays(inputName: String)(implicit defaultConfig: T): Try[Cpg]

Create a CPG for code at inputPath and apply default overlays.

Create a CPG for code at inputPath and apply default overlays.

def run(config: T): Unit

Create CPG according to given configuration, printing errors to the console if they occur. The CPG is closed and not returned.

Create CPG according to given configuration, printing errors to the console if they occur. The CPG is closed and not returned.