semanticcpg apidocs
2.0.271
API
Generated with
semanticcpg apidocs/io.joern.swiftsrc2cpg/io.joern.swiftsrc2cpg.astcreation/AstCreator

AstCreator

io.joern.swiftsrc2cpg.astcreation.AstCreator
class AstCreator(val config: Config, val global: SwiftGlobal, val parserResult: ParseResult)(implicit withSchemaValidation: ValidationMode) extends AstCreatorBase, AstForSwiftTokenCreator, AstForSyntaxCreator, AstForExprSyntaxCreator, AstForTypeSyntaxCreator, AstForDeclSyntaxCreator, AstForPatternSyntaxCreator, AstForStmtSyntaxCreator, AstForSyntaxCollectionCreator, AstCreatorHelper, AstNodeBuilder, AstNodeBuilder[SwiftNode, AstCreator]

Attributes

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

Members list

Type members

Inherited classlikes

case class AstAndMethod(ast: Ast, method: NewMethod, methodBlock: Ast)

Attributes

Inherited from:
AstForDeclSyntaxCreator
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited types

Value members

Concrete methods

protected def astForNode(node: SwiftNode): Ast
protected def astForNodeWithFunctionReference(node: SwiftNode): Ast
override protected def code(node: SwiftNode): String

Attributes

Definition Classes
AstNodeBuilder
override protected def column(node: SwiftNode): Option[Integer]

Attributes

Definition Classes
AstNodeBuilder
override protected def columnEnd(node: SwiftNode): Option[Integer]

Attributes

Definition Classes
AstNodeBuilder
override def createAst(): DiffGraphBuilder

Attributes

Definition Classes
AstCreatorBase
override protected def line(node: SwiftNode): Option[Integer]

Attributes

Definition Classes
AstNodeBuilder
override protected def lineEnd(node: SwiftNode): Option[Integer]

Attributes

Definition Classes
AstNodeBuilder
override protected def offset(node: SwiftNode): Option[(Int, Int)]

Attributes

Definition Classes
AstNodeBuilder

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: SwiftNode, code: String, name: String, fullName: String): NewAnnotation

Attributes

Inherited from:
AstNodeBuilder
protected def astForDeclSyntax(declSyntax: DeclSyntax): Ast

Attributes

Inherited from:
AstForDeclSyntaxCreator
protected def astForExprSyntax(exprSyntax: ExprSyntax): Ast

Attributes

Inherited from:
AstForExprSyntaxCreator
protected def astForFunctionLike(node: FunctionDeclLike, shouldCreateFunctionReference: Boolean, shouldCreateAssignmentCall: Boolean, methodBlockContent: List[Ast]): AstAndMethod

Attributes

Inherited from:
AstForDeclSyntaxCreator
protected def astForIfConfigDeclSyntax(node: IfConfigDeclSyntax): Ast

Attributes

Inherited from:
AstForDeclSyntaxCreator
protected def astForIntegerLiteralToken(node: integerLiteral): Ast

Attributes

Inherited from:
AstForSwiftTokenCreator
protected def astForListSyntaxChildren(node: SwiftNode, children: Seq[SwiftNode]): Ast

Attributes

Inherited from:
AstForSyntaxCollectionCreator
protected def astForPatternSyntax(patternSyntax: PatternSyntax): Ast

Attributes

Inherited from:
AstForPatternSyntaxCreator
protected def astForStmtSyntax(stmtSyntax: StmtSyntax): Ast

Attributes

Inherited from:
AstForStmtSyntaxCreator
protected def astForSwiftToken(swiftToken: SwiftToken): Ast

Attributes

Inherited from:
AstForSwiftTokenCreator
protected def astForSyntax(syntax: Syntax): Ast

Attributes

Inherited from:
AstForSyntaxCreator
protected def astForSyntaxCollection(syntaxCollection: SyntaxCollection): Ast

Attributes

Inherited from:
AstForSyntaxCollectionCreator
protected def astForTypeSyntax(typeSyntax: TypeSyntax): Ast

Attributes

Inherited from:
AstForTypeSyntaxCreator
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: SwiftNode, code: String, typeFullName: String): NewBlock

Attributes

Inherited from:
AstNodeBuilder
protected def blockNode(node: SwiftNode): 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: SwiftNode, code: String, name: String, methodFullName: String, dispatchType: String, signature: Option[String], typeFullName: Option[String]): NewCall

Attributes

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

Attributes

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

Attributes

Inherited from:
AstNodeBuilder
protected def codeOf(node: NewNode): String

Attributes

Inherited from:
AstNodeBuilder
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: SwiftNode, controlStructureType: String, code: String): NewControlStructure

Attributes

Inherited from:
AstNodeBuilder
protected def createAssignmentCallAst(dest: Ast, source: Ast, code: String, line: Option[Integer], column: Option[Integer]): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createAssignmentCallAst(destId: NewNode, sourceId: NewNode, code: String, line: Option[Integer], column: Option[Integer]): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createFieldAccessCallAst(baseAst: Ast, partNode: NewNode, line: Option[Integer], column: Option[Integer]): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createFieldAccessCallAst(baseNode: NewNode, partNode: NewNode, line: Option[Integer], column: Option[Integer]): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createFieldIdentifierNode(name: String, line: Option[Integer], column: Option[Integer]): NewFieldIdentifier

Attributes

Inherited from:
AstNodeBuilder
protected def createFunctionTypeAndTypeDeclAst(node: SwiftNode, methodNode: NewMethod, methodName: String, methodFullName: String): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createIndexAccessCallAst(baseAst: Ast, partAst: Ast, line: Option[Integer], column: Option[Integer], additionalArgsAst: Seq[Ast]): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createIndexAccessCallAst(baseNode: NewNode, partNode: NewNode, line: Option[Integer], column: Option[Integer]): Ast

Attributes

Inherited from:
AstNodeBuilder
protected def createJumpTarget(switchCase: SwitchCaseSyntax | IfConfigDeclSyntax): NewJumpTarget

Attributes

Inherited from:
AstNodeBuilder
protected def createStaticCallNode(code: String, callName: String, fullName: String, line: Option[Integer], column: Option[Integer]): NewCall

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: SwiftNode, name: String, code: String): NewFieldIdentifier

Attributes

Inherited from:
AstNodeBuilder
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
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 identifierNode(node: SwiftNode, name: String, code: String, typeFullName: String, dynamicTypeHints: Seq[String]): NewIdentifier

Attributes

Inherited from:
AstNodeBuilder
protected def identifierNode(node: SwiftNode, name: String, dynamicTypeHints: Seq[String]): NewIdentifier

Attributes

Inherited from:
AstNodeBuilder
protected def identifierNode(node: SwiftNode, name: String): NewIdentifier

Attributes

Inherited from:
AstNodeBuilder
protected def ifConfigDeclConditionIsSatisfied(node: IfConfigClauseSyntax): Boolean

Attributes

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

Attributes

Inherited from:
AstNodeBuilder
protected def literalNode(node: SwiftNode, code: String, typeFullName: String, dynamicTypeHints: Seq[String]): NewLiteral

Attributes

Inherited from:
AstNodeBuilder
protected def literalNode(node: SwiftNode, code: String, dynamicTypeOption: Option[String]): NewLiteral

Attributes

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

Attributes

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

Attributes

Inherited from:
AstNodeBuilder
protected def memberNode(node: SwiftNode, 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: SwiftNode, 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: SwiftNode, name: String, fullName: String, signature: String, fileName: String): NewMethod

Attributes

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

Attributes

Inherited from:
AstNodeBuilder
protected def methodReturnNode(node: SwiftNode, 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: SwiftNode): 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 parameterInNode(node: SwiftNode, name: String, code: String, index: Int, isVariadic: Boolean, evaluationStrategy: String, typeFullName: Option[String]): NewMethodParameterIn

Attributes

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

Attributes

Inherited from:
AstNodeBuilder
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: SwiftNode, code: String): NewReturn

Attributes

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

Attributes

Inherited from:
AstCreatorBase
protected def setOrderExplicitly(ast: Ast, order: Int): Unit

Attributes

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

Attributes

Inherited from:
AstNodeBuilder
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 staticInitMethodAstAndBlock(initAsts: List[Ast], fullName: String, signature: Option[String], returnType: String, fileName: Option[String], lineNumber: Option[Integer], columnNumber: Option[Integer]): AstAndMethod

Attributes

Inherited from:
AstNodeBuilder
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: SwiftNode, 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: SwiftNode, name: String, fullName: String, fileName: String, inheritsFrom: Seq[String], alias: Option[String]): NewTypeDecl

Attributes

Inherited from:
AstNodeBuilder
protected def typeHintForThisExpression(): Seq[String]

Attributes

Inherited from:
AstNodeBuilder
protected def typeRefNode(node: SwiftNode, code: String, typeFullName: String): NewTypeRef

Attributes

Inherited from:
AstNodeBuilder
protected def unknownNode(node: SwiftNode, 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 wrapMultipleInBlock(asts: Seq[Ast], lineNumber: Option[Integer]): Ast

Attributes

Inherited from:
AstCreatorBase

Concrete fields

val config: Config
lazy protected val definedSymbols: Map[String, String]
protected val dynamicInstanceTypeStack: ListBuffer[String]
protected val functionFullNames: HashSet[String]
protected val functionNodeToNameAndFullName: HashMap[SwiftNode, (String, String)]
protected val localAstParentStack: ListBuffer[NewBlock]
protected val logger: Logger
protected val methodAstParentStack: ListBuffer[NewNode]
protected val scope: Scope
protected val seenAliasTypes: HashSet[NewTypeDecl]
protected val typeFullNameToPostfix: HashMap[String, Int]
protected val typeRefIdStack: ListBuffer[NewTypeRef]
protected val usedVariableNames: HashMap[String, Int]

Inherited fields

val diffGraph: DiffGraphBuilder

Attributes

Inherited from:
AstCreatorBase
Generated with