CpgPassBase

io.shiftleft.passes.CpgPassBase
trait CpgPassBase

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def createAndApply(): Unit
def runWithBuilder(builder: DiffGraphBuilder): Int

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Attributes

Concrete methods

protected def baseLogger: Logger
protected def generateOutFileName(prefix: String, outName: String, index: Int): String
def name: String

Name of the pass. By default it is inferred from the name of the class, override if needed.

Name of the pass. By default it is inferred from the name of the class, override if needed.

Attributes

def runWithBuilderLogged(builder: DiffGraphBuilder): Int

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Attributes

protected def withStartEndTimesLogged[A](fun: => A): A

Deprecated methods

def createApplySerializeAndStore(serializedCpg: SerializedCpg, prefix: String): Unit

Attributes

Deprecated
true
protected def store(overlay: GeneratedMessageV3, name: String, serializedCpg: SerializedCpg): Unit

Attributes

Deprecated
true