rubysrc2cpg
API
Generated with
rubysrc2cpg/io.joern.rubysrc2cpg/io.joern.rubysrc2cpg.astcreation/AstCreator

AstCreator

io.joern.rubysrc2cpg.astcreation.AstCreator
class AstCreator(val fileName: String, val programCtx: ProgramContext, val projectRoot: Option[String], val programSummary: RubyProgramSummary)(implicit withSchemaValidation: ValidationMode) extends AstCreatorBase, AstCreatorHelper, AstForStatementsCreator, AstForExpressionsCreator, AstForFunctionsCreator, AstForTypesCreator, AstSummaryVisitor, AstNodeBuilder[RubyNode, AstCreator]

Attributes

Graph
Supertypes
trait AstNodeBuilder[RubyNode, AstCreator]
class AstCreatorBase
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def createAst(): DiffGraphBuilder

Attributes

Definition Classes
AstCreatorBase

Inherited methods

def absolutePath(filename: String): String

Absolute path for the given file name

Absolute path for the given file name

Attributes

Inherited from:
AstCreatorBase
def annotationAssignmentAst(assignmentValueName: String, code: String, assignmentAst: Ast): Ast

Creates an AST that represents an annotation assignment with a name for the assigned value, its overall code, and the respective assignment AST.

Creates an AST that represents an annotation assignment with a name for the assigned value, its overall code, and the respective assignment AST.

Attributes

Inherited from:
AstCreatorBase
def annotationAst(annotation: NewAnnotation, children: Seq[Ast]): Ast

Creates an AST that represents an annotation, including its content (annotation parameter assignments).

Creates an AST that represents an annotation, including its content (annotation parameter assignments).

Attributes

Inherited from:
AstCreatorBase
protected def annotationNode(node: RubyNode, code: String, name: String, fullName: String): NewAnnotation

Attributes

Inherited from:
AstNodeBuilder
protected def astForAnonymousTypeDeclaration(node: AnonymousTypeDeclaration): Ast

Attributes

Inherited from:
AstForFunctionsCreator
protected def astForArrayLiteral(node: ArrayLiteral): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForAssociation(node: Association): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForAssociationHash(node: Association, tmp: String): List[Ast]

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForAttributeAssignment(node: AttributeAssignment): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForBinary(node: BinaryExpression): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForClassDeclaration(node: RubyNode & TypeDeclaration): Ast

Attributes

Inherited from:
AstForTypesCreator
protected def astForDoBlock(block: Block & RubyNode): Seq[Ast]

Attributes

Inherited from:
AstForStatementsCreator
protected def astForDynamicLiteral(node: DynamicLiteral): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForExpression(node: RubyNode): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForFieldAccess(node: MemberAccess): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForHashLiteral(node: HashLiteral): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForHereDoc(node: HereDocNode): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForIfExpression(node: IfExpression): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForIncludeCall(node: IncludeCall): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForIndexAccess(node: IndexAccess): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForMandatoryParameter(node: RubyNode): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForMemberAccess(node: MemberAccess): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForMemberCall(node: MemberCall): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForMethodDeclaration(node: MethodDeclaration, isClosure: Boolean): Seq[Ast]

Creates method declaration related structures.

Creates method declaration related structures.

Value parameters

isClosure

if true, will generate a type decl, type ref, and method ref, as well as add the c modifier.

node

the node to create the AST structure from.

Attributes

Returns

a method declaration with additional refs and types if specified.

Inherited from:
AstForFunctionsCreator
protected def astForNilBlock: Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForNilLiteral: Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForObjectInstantiation(node: RubyNode & ObjectInstantiation): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForParameter(node: RubyNode, index: Int): Ast

Attributes

Inherited from:
AstForFunctionsCreator
protected def astForRange(node: RangeExpression): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForRequireCall(node: RequireCall): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForRescueExpression(node: RescueExpression): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForReturnStatement(node: ReturnExpression): Ast

Attributes

Inherited from:
AstForStatementsCreator
protected def astForSimpleCall(node: SimpleCall): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForSimpleIdentifier(node: RubyNode & RubyIdentifier): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForSingleAssignment(node: SingleAssignment): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForSingleKeyValue(keyNode: RubyNode, valueNode: RubyNode, tmp: String): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForSingletonMethodDeclaration(node: SingletonMethodDeclaration): Ast

Attributes

Inherited from:
AstForFunctionsCreator
protected def astForSplattingRubyNode(node: SplattingRubyNode): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForStatementList(node: StatementList): Ast

Attributes

Inherited from:
AstForStatementsCreator
protected def astForStatementListReturningLastExpression(node: StatementList): Ast

Attributes

Inherited from:
AstForStatementsCreator
protected def astForStaticLiteral(node: StaticLiteral): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForUnary(node: UnaryExpression): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForUnknown(node: RubyNode): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForUnlessExpression(node: UnlessExpression): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astForYield(node: YieldExpr): Ast

Attributes

Inherited from:
AstForExpressionsCreator
protected def astsForCallWithBlock[C <: RubyCall](node: RubyNode & RubyCallWithBlock[C]): Seq[Ast]

Attributes

Inherited from:
AstForStatementsCreator
protected def astsForCaseExpression(node: CaseExpression): Seq[Ast]

Attributes

Inherited from:
AstForStatementsCreator
protected def astsForFieldDeclarations(node: FieldsDeclaration): Seq[Ast]

Attributes

Inherited from:
AstForTypesCreator
protected def astsForStatement(node: RubyNode): Seq[Ast]

Attributes

Inherited from:
AstForStatementsCreator
def blockAst(blockNode: NewBlock, statements: List[Ast]): Ast

For a given block node and statement ASTs, create an AST that represents the block. The main purpose of this method is to increase the readability of the code which creates block asts.

For a given block node and statement ASTs, create an AST that represents the block. The main purpose of this method is to increase the readability of the code which creates block asts.

Attributes

Inherited from:
AstCreatorBase
protected def blockNode(node: RubyNode, code: String, typeFullName: String): NewBlock

Attributes

Inherited from:
AstNodeBuilder
protected def blockNode(node: RubyNode): NewBlock

Attributes

Inherited from:
AstNodeBuilder
def callAst(callNode: NewCall, arguments: Seq[Ast], base: Option[Ast], receiver: Option[Ast]): Ast

Create an abstract syntax tree for a call, including CPG-specific edges required for arguments and the receiver.

Create an abstract syntax tree for a call, including CPG-specific edges required for arguments and the receiver.

Our call representation is inspired by ECMAScript, that is, in addition to arguments, a call has a base and a receiver. For languages other than Javascript, leave receiver empty for now.

Value parameters

arguments

arguments (without the base argument (instance))

base

the value to use as this in the method call.

callNode

the node that represents the entire call

receiver

the object in which the property lookup is performed

Attributes

Inherited from:
AstCreatorBase
def callNode(node: RubyNode, code: String, name: String, methodFullName: String, dispatchType: String, signature: Option[String], typeFullName: Option[String]): NewCall

Attributes

Inherited from:
AstNodeBuilder
def callNode(node: RubyNode, code: String, name: String, methodFullName: String, dispatchType: String): NewCall

Attributes

Inherited from:
AstNodeBuilder
override def code(node: RubyNode): String

Attributes

Definition Classes
Inherited from:
AstCreatorHelper
override def column(node: RubyNode): Option[Integer]

Attributes

Definition Classes
Inherited from:
AstCreatorHelper
override def columnEnd(node: RubyNode): Option[Integer]

Attributes

Definition Classes
Inherited from:
AstCreatorHelper
protected def computeClassFullName(name: String): String

Attributes

Inherited from:
AstCreatorHelper
protected def computeMethodFullName(name: String): String

Attributes

Inherited from:
AstCreatorHelper
def controlStructureAst(controlStructureNode: NewControlStructure, condition: Option[Ast], children: Seq[Ast], placeConditionLast: Boolean): Ast

For a given node, condition AST and children ASTs, create an AST that represents the control structure. The main purpose of this method is to automatically assign the correct condition edges.

For a given node, condition AST and children ASTs, create an AST that represents the control structure. The main purpose of this method is to automatically assign the correct condition edges.

Attributes

Inherited from:
AstCreatorBase
protected def controlStructureNode(node: RubyNode, controlStructureType: String, code: String): NewControlStructure

Attributes

Inherited from:
AstNodeBuilder
def doWhileAst(condition: Option[Ast], body: Seq[Ast], code: Option[String], lineNumber: Option[Integer], columnNumber: Option[Integer]): Ast

Attributes

Inherited from:
AstCreatorBase
protected def fieldIdentifierNode(node: RubyNode, name: String, code: String): NewFieldIdentifier

Attributes

Inherited from:
AstNodeBuilder
protected def foldIfExpression(builder: (IfExpression, Ast, Ast, List[Ast]) => Ast)(node: IfExpression): Ast

Attributes

Inherited from:
AstForStatementsCreator
def forAst(forNode: NewControlStructure, locals: Seq[Ast], initAsts: Seq[Ast], conditionAsts: Seq[Ast], updateAsts: Seq[Ast], bodyAsts: Seq[Ast]): Ast

Attributes

Inherited from:
AstCreatorBase
def forAst(forNode: NewControlStructure, locals: Seq[Ast], initAsts: Seq[Ast], conditionAsts: Seq[Ast], updateAsts: Seq[Ast], bodyAst: Ast): Ast

Attributes

Inherited from:
AstCreatorBase
protected def generateStaticLiteralsForRange(node: RangeExpression): List[StaticLiteral]

Attributes

Inherited from:
AstForExpressionsCreator
def globalNamespaceBlock(): NewNamespaceBlock

Create a global namespace block for the given filename

Create a global namespace block for the given filename

Attributes

Inherited from:
AstCreatorBase
protected def handleVariableOccurrence(node: RubyNode): Ast

Attributes

Inherited from:
AstCreatorHelper
protected def identifierNode(node: RubyNode, name: String, code: String, typeFullName: String, dynamicTypeHints: Seq[String]): NewIdentifier

Attributes

Inherited from:
AstNodeBuilder
protected def isBuiltin(x: String): Boolean

Attributes

Inherited from:
AstCreatorHelper
protected def jumpTargetNode(node: RubyNode, name: String, code: String, parserTypeName: Option[String]): NewJumpTarget

Attributes

Inherited from:
AstNodeBuilder
override def line(node: RubyNode): Option[Integer]

Attributes

Definition Classes
Inherited from:
AstCreatorHelper
override def lineEnd(node: RubyNode): Option[Integer]

Attributes

Definition Classes
Inherited from:
AstCreatorHelper
protected def literalNode(node: RubyNode, code: String, typeFullName: String, dynamicTypeHints: Seq[String]): NewLiteral

Attributes

Inherited from:
AstNodeBuilder
protected def localNode(node: RubyNode, name: String, code: String, typeFullName: String, closureBindingId: Option[String]): NewLocal

Attributes

Inherited from:
AstNodeBuilder
protected def memberNode(node: RubyNode, name: String, code: String, typeFullName: String, dynamicTypeHints: Seq[String]): NewMember

Attributes

Inherited from:
AstNodeBuilder
protected def memberNode(node: RubyNode, name: String, code: String, typeFullName: String): NewMember

Attributes

Inherited from:
AstNodeBuilder
def methodAst(method: NewMethod, parameters: Seq[Ast], body: Ast, methodReturn: NewMethodReturn, modifiers: Seq[NewModifier]): Ast

Creates an AST that represents an entire method, including its content.

Creates an AST that represents an entire method, including its content.

Attributes

Inherited from:
AstCreatorBase
def methodAstWithAnnotations(method: NewMethod, parameters: Seq[Ast], body: Ast, methodReturn: NewMethodReturn, modifiers: Seq[NewModifier], annotations: Seq[Ast]): Ast

Creates an AST that represents an entire method, including its content and with support for both method and parameter annotations.

Creates an AST that represents an entire method, including its content and with support for both method and parameter annotations.

Attributes

Inherited from:
AstCreatorBase
protected def methodNode(node: RubyNode, name: String, code: String, fullName: String, signature: Option[String], fileName: String, astParentType: Option[String], astParentFullName: Option[String]): NewMethod

Attributes

Inherited from:
AstNodeBuilder
def methodNode(node: RubyNode, name: String, fullName: String, signature: String, fileName: String): NewMethod

Attributes

Inherited from:
AstNodeBuilder
protected def methodRefNode(node: RubyNode, code: String, methodFullName: String, typeFullName: String): NewMethodRef

Attributes

Inherited from:
AstNodeBuilder
protected def methodReturnNode(node: RubyNode, typeFullName: String): NewMethodReturn

Attributes

Inherited from:
AstNodeBuilder
def methodStubAst(method: NewMethod, parameters: Seq[Ast], methodReturn: NewMethodReturn, modifiers: Seq[NewModifier]): Ast

Creates an AST that represents a method stub, containing information about the method, its parameters, and the return type.

Creates an AST that represents a method stub, containing information about the method, its parameters, and the return type.

Attributes

Inherited from:
AstCreatorBase
protected def newImportNode(code: String, importedEntity: String, importedAs: String, include: RubyNode): NewImport

Attributes

Inherited from:
AstNodeBuilder
def nextClosureName(): String

Attributes

Returns

the next available name for a closure in this context

Inherited from:
AstCreatorBase
protected def offset(node: RubyNode): Option[(Int, Int)]

Attributes

Inherited from:
AstNodeBuilder
protected def parameterInNode(node: RubyNode, name: String, code: String, index: Int, isVariadic: Boolean, evaluationStrategy: String, typeFullName: Option[String]): NewMethodParameterIn

Attributes

Inherited from:
AstNodeBuilder
protected def parameterInNode(node: RubyNode, name: String, code: String, index: Int, isVariadic: Boolean, evaluationStrategy: String, typeFullName: String): NewMethodParameterIn

Attributes

Inherited from:
AstNodeBuilder
protected def pathSep: String

Attributes

Inherited from:
AstCreatorHelper
protected def prefixAsBuiltin(x: String): String

Attributes

Inherited from:
AstCreatorHelper
def returnAst(returnNode: NewReturn, arguments: Seq[Ast]): Ast

For a given return node and arguments, create an AST that represents the return instruction. The main purpose of this method is to automatically assign the correct argument indices.

For a given return node and arguments, create an AST that represents the return instruction. The main purpose of this method is to automatically assign the correct argument indices.

Attributes

Inherited from:
AstCreatorBase
protected def returnNode(node: RubyNode, code: String): NewReturn

Attributes

Inherited from:
AstNodeBuilder
def setArgumentIndices(arguments: Seq[Ast]): Unit

Attributes

Inherited from:
AstCreatorBase
protected def shortenCode(code: String): String

Attributes

Inherited from:
AstNodeBuilder
protected def statementForOptionalParam(node: OptionalParameter): RubyNode

Attributes

Inherited from:
AstForFunctionsCreator
def staticInitMethodAst(initAsts: List[Ast], fullName: String, signature: Option[String], returnType: String, fileName: Option[String], lineNumber: Option[Integer], columnNumber: Option[Integer]): Ast

Attributes

Inherited from:
AstCreatorBase
def summarize(): RubyProgramSummary

Attributes

Inherited from:
AstSummaryVisitor
protected def transformLastRubyNodeInControlFlowExpressionBody(node: RubyNode & ControlFlowExpression, transform: RubyNode => RubyNode, defaultElseBranch: TextSpan => Option[ElseClause]): RubyNode

Value parameters

node

- Control Flow Expression RubyNode

transform

- RubyNode => RubyNode function for transformation on the clauses of the ControlFlowExpression

Attributes

Returns

RubyNode with transform function applied

Inherited from:
AstForStatementsCreator
def tryCatchAst(tryNode: NewControlStructure, tryBodyAst: Ast, catchAsts: Seq[Ast], finallyAst: Option[Ast]): Ast

For the given try body, catch ASTs and finally AST, create a try-catch-finally AST with orders set correctly for the ossdataflow engine.

For the given try body, catch ASTs and finally AST, create a try-catch-finally AST with orders set correctly for the ossdataflow engine.

Attributes

Inherited from:
AstCreatorBase
protected def typeDeclNode(node: RubyNode, name: String, fullName: String, filename: String, code: String, astParentType: String, astParentFullName: String, inherits: Seq[String], alias: Option[String]): NewTypeDecl

Attributes

Inherited from:
AstNodeBuilder
def typeDeclNode(node: RubyNode, name: String, fullName: String, fileName: String, inheritsFrom: Seq[String], alias: Option[String]): NewTypeDecl

Attributes

Inherited from:
AstNodeBuilder
protected def typeFromCallTarget(baseNode: RubyNode): Option[String]

Attempts to extract a type from the base of a member call.

Attempts to extract a type from the base of a member call.

Attributes

Inherited from:
AstForExpressionsCreator
protected def typeRefNode(node: RubyNode, code: String, typeFullName: String): NewTypeRef

Attributes

Inherited from:
AstNodeBuilder
protected def unknownNode(node: RubyNode, code: String): NewUnknown

Attributes

Inherited from:
AstNodeBuilder
def whileAst(condition: Option[Ast], body: Seq[Ast], code: Option[String], lineNumber: Option[Integer], columnNumber: Option[Integer]): Ast

Attributes

Inherited from:
AstCreatorBase
def withArgumentIndex[T <: ExpressionNew](node: T, argIdxOpt: Option[Int]): T

Attributes

Inherited from:
AstCreatorBase
def withArgumentName[T <: ExpressionNew](node: T, argNameOpt: Option[String]): T

Attributes

Inherited from:
AstCreatorBase
def withIndex[T, X](nodes: Array[T])(f: (T, Int) => X): Seq[X]

Attributes

Inherited from:
AstCreatorBase
def withIndex[T, X](nodes: Seq[T])(f: (T, Int) => X): Seq[X]

Attributes

Inherited from:
AstCreatorBase
def withSummary(newSummary: RubyProgramSummary): AstCreator

Attributes

Inherited from:
AstSummaryVisitor
def wrapMultipleInBlock(asts: Seq[Ast], lineNumber: Option[Integer]): Ast

Attributes

Inherited from:
AstCreatorBase

Concrete fields

val fileName: String

Inherited fields

protected val AssignmentOperatorNames: Map[String, String]

Attributes

Inherited from:
AstCreatorHelper
protected val BinaryOperatorNames: Map[String, String]

Attributes

Inherited from:
AstCreatorHelper
protected val UnaryOperatorNames: Map[String, String]

Attributes

Inherited from:
AstCreatorHelper
val diffGraph: DiffGraphBuilder

Attributes

Inherited from:
AstCreatorBase
val procParamGen: FreshNameGenerator[Left[String, Nothing]]

Attributes

Inherited from:
AstForFunctionsCreator
val tmpGen: FreshNameGenerator[String]

Attributes

Inherited from:
AstForExpressionsCreator
Generated with