codepropertygraph
API
Generated with
codepropertygraph/io.shiftleft.passes/CpgPass

CpgPass

io.shiftleft.passes.CpgPass
abstract class CpgPass(cpg: Cpg, outName: String, keyPool: Option[KeyPool]) extends ForkJoinParallelCpgPass[AnyRef]

Attributes

Graph
Supertypes
class NewStyleCpgPassBase[AnyRef]
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Type members

Inherited types

type DiffGraphBuilder = DiffGraphBuilder

Attributes

Inherited from:
NewStyleCpgPassBase

Value members

Abstract methods

def run(builder: DiffGraphBuilder): Unit

Concrete methods

final override def generateParts(): Array[_ <: AnyRef]

Attributes

Definition Classes
final override def runOnPart(builder: DiffGraphBuilder, part: AnyRef): Unit

Attributes

Definition Classes

Inherited methods

override def createAndApply(): Unit

Attributes

Definition Classes
Inherited from:
NewStyleCpgPassBase
override def createApplySerializeAndStore(serializedCpg: SerializedCpg, inverse: Boolean, prefix: String): Unit

Attributes

Definition Classes
Inherited from:
ForkJoinParallelCpgPass
def finish(): Unit

Attributes

Inherited from:
NewStyleCpgPassBase
def init(): Unit

Attributes

Inherited from:
NewStyleCpgPassBase
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

Inherited from:
CpgPassBase
override def runWithBuilder(externalBuilder: 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

Definition Classes
Inherited from:
NewStyleCpgPassBase
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

Inherited from:
CpgPassBase
Generated with