semanticcpg apidocs/io.shiftleft.semanticcpg.language/Steps

Steps

final
class Steps[A](val traversal: Traversal[A]) extends AnyVal

Base class for our DSL These are the base steps available in all steps of the query language. There are no constraints on the element types, unlike e.g. NodeSteps

Companion
object
class AnyVal
trait Matchable
class Any

Value members

Concrete methods

def b: Buffer[A]
Shorthand for `toBuffer`
def exec(): List[A]
Alias for `toList`
def help(implicit elementType: ClassTag[A]): String

Print help/documentation based on the current elementType A. Relies on all step extensions being annotated with @TraversalExt / @Doc Note that this works independently of tab completion and implicit conversions in scope - it will simply list all documented steps in the classpath

Print help/documentation based on the current elementType A. Relies on all step extensions being annotated with @TraversalExt / @Doc Note that this works independently of tab completion and implicit conversions in scope - it will simply list all documented steps in the classpath

def helpVerbose(implicit elementType: ClassTag[A]): String
def jl: List[A]
Execute the traversal and convert it into a Java list (as opposed
to the Scala list obtained via `toList`)
@Doc(info = "execute this traversal and pretty print the results")
def p(implicit show: Show[A]): List[String]

Execute this traversal and pretty print the results. This may mean that not all properties of the node are displayed or that some properties have undergone transformations to improve display. A good example is flow pretty-printing. This is the only three of the methods which we may modify on a per-node-type basis, typically via implicits of type Show[NodeType].

Execute this traversal and pretty print the results. This may mean that not all properties of the node are displayed or that some properties have undergone transformations to improve display. A good example is flow pretty-printing. This is the only three of the methods which we may modify on a per-node-type basis, typically via implicits of type Show[NodeType].

def s: LazyList[A]
Alias for `toStream`
def toBuffer(): Buffer[A]
Execute the traversal and convert it to a mutable buffer
@Doc(info = "execute traversal and convert the result to json")
def toJson: String

Execute traversal and convert the result to json. toJson (export) contains the exact same information as toList, only in json format. Typically, the user will call this method upon inspection of the results of toList in order to export the data for processing with other tools.

Execute traversal and convert the result to json. toJson (export) contains the exact same information as toList, only in json format. Typically, the user will call this method upon inspection of the results of toList in order to export the data for processing with other tools.

@Doc(info = "execute traversal and convert the result to pretty json")
def toJsonPretty: String

Execute traversal and convert the result to pretty json.

Execute traversal and convert the result to pretty json.

def toStream(): LazyList[A]
Execute the travel and convert it to a Java stream.

Concrete fields

val traversal: Traversal[A]