Class FileJp

Represents a source file (.c, .cpp., .cl, etc)

Hierarchy (view full)

Joinpoint
- FileJp

Index

Constructors

constructor

Properties

_javaObject _defaultAttributeInfo

Constructors

constructor

new FileJp(obj): FileJp
Parameters
- obj: any
Returns FileJp
Inherited from Joinpoint.constructor
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:32

Properties

`Internal`_javaObject

_javaObject: any

`Static` `Readonly` `Internal`_defaultAttributeInfo

_defaultAttributeInfo: {
    jpMapper?: {
        accessSpecifier: typeof AccessSpecifier;
        adjustedType: typeof AdjustedType;
        arrayAccess: typeof ArrayAccess;
        arrayType: typeof ArrayType;
        attribute: typeof Attribute;
        binaryOp: typeof BinaryOp;
        body: typeof Body;
        boolLiteral: typeof BoolLiteral;
        break: typeof Break;
        builtinType: typeof BuiltinType;
        call: typeof Call;
        case: typeof Case;
        cast: typeof Cast;
        cilkFor: typeof CilkFor;
        cilkSpawn: typeof CilkSpawn;
        cilkSync: typeof CilkSync;
        class: typeof Class;
        clavaException: typeof ClavaException;
        comment: typeof Comment;
        continue: typeof Continue;
        cudaKernelCall: typeof CudaKernelCall;
        decl: typeof Decl;
        declarator: typeof Declarator;
        declStmt: typeof DeclStmt;
        deleteExpr: typeof DeleteExpr;
        elaboratedType: typeof ElaboratedType;
        empty: typeof Empty;
        emptyStmt: typeof EmptyStmt;
        enumDecl: typeof EnumDecl;
        enumeratorDecl: typeof EnumeratorDecl;
        enumType: typeof EnumType;
        expression: typeof Expression;
        exprStmt: typeof ExprStmt;
        field: typeof Field;
        file: typeof FileJp;
        floatLiteral: typeof FloatLiteral;
        function: typeof FunctionJp;
        functionType: typeof FunctionType;
        gotoStmt: typeof GotoStmt;
        if: typeof If;
        implicitValue: typeof ImplicitValue;
        include: typeof Include;
        initList: typeof InitList;
        intLiteral: typeof IntLiteral;
        joinpoint: typeof Joinpoint;
        labelDecl: typeof LabelDecl;
        labelStmt: typeof LabelStmt;
        literal: typeof Literal;
        loop: typeof Loop;
        marker: typeof Marker;
        memberAccess: typeof MemberAccess;
        memberCall: typeof MemberCall;
        method: typeof Method;
        namedDecl: typeof NamedDecl;
        newExpr: typeof NewExpr;
        omp: typeof Omp;
        op: typeof Op;
        param: typeof Param;
        parenExpr: typeof ParenExpr;
        parenType: typeof ParenType;
        pointerType: typeof PointerType;
        pragma: typeof Pragma;
        program: typeof Program;
        qualType: typeof QualType;
        record: typeof RecordJp;
        returnStmt: typeof ReturnStmt;
        scope: typeof Scope;
        statement: typeof Statement;
        struct: typeof Struct;
        switch: typeof Switch;
        tag: typeof Tag;
        tagType: typeof TagType;
        templateSpecializationType: typeof TemplateSpecializationType;
        ternaryOp: typeof TernaryOp;
        this: typeof This;
        type: typeof Type;
        typedefDecl: typeof TypedefDecl;
        typedefNameDecl: typeof TypedefNameDecl;
        typedefType: typeof TypedefType;
        unaryExprOrType: typeof UnaryExprOrType;
        unaryOp: typeof UnaryOp;
        undefinedType: typeof UndefinedType;
        vardecl: typeof Vardecl;
        variableArrayType: typeof VariableArrayType;
        varref: typeof Varref;
        wrapperStmt: typeof WrapperStmt;
    };
    map?: DefaultAttributeMap;
    name: null | string;
    type?: PrivateMapper;
} = ...

Accessors

actions

get actions(): string[]
Returns string[]
Inherited from Joinpoint.actions
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:35

ast

get ast(): string
String with a dump of the AST representation starting from this node. This representation corresponds to the internal Java representation of the ClavaAst, where the node names correspond to Java classes. To get an equivalent representation with join point names, use the attribute 'dump'

Returns string
Inherited from Joinpoint.ast
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:153

astChildren

get astChildren(): Joinpoint[]
Returns an array with the children of the node, considering null nodes

Returns Joinpoint[]
Inherited from Joinpoint.astChildren
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:157

astId

get astId(): string
String that uniquely identifies this node

Returns string
Inherited from Joinpoint.astId
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:161

astName

get astName(): string
The name of the Java class of this node, which is similar to the equivalent node in Clang AST

Returns string
Inherited from Joinpoint.astName
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:165

astNumChildren

get astNumChildren(): number
Returns the number of children of the node, considering null nodes

Returns number
Inherited from Joinpoint.astNumChildren
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:169

attributes

get attributes(): string[]
Returns string[]
Inherited from Joinpoint.attributes
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:33

baseSourcePath

get baseSourcePath(): string
The path to the source folder that was given as the base folder of this file

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:633

bitWidth

get bitWidth(): number
The bit width of the type returned by this join point, in relation to the definitions of its Translation Unit, or undefined if there is no type or bitwidth defined, or if the join point is not in a TranslationUnit

Returns number
Inherited from Joinpoint.bitWidth
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:173

chain

get chain(): string[]
String list of the names of the join points that form a path from the root to this node

Returns string[]
Inherited from Joinpoint.chain
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:177

children

get children(): Joinpoint[]
Returns an array with the children of the node, ignoring null nodes

Returns Joinpoint[]
Inherited from Joinpoint.children
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:181

code

get code(): string
String with the code represented by this node

Returns string
Inherited from Joinpoint.code
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:185

column

get column(): number
The starting column of the current node in the original code

Returns number
Inherited from Joinpoint.column
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:189

currentRegion

get currentRegion(): Joinpoint
Returns the node that declares the scope of this node

Returns Joinpoint
Inherited from Joinpoint.currentRegion
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:193

data

get data(): object
JS object associated with this node, containing parsed data of #pragma clava data when the node can be a target of pragmas. This is a special object, managed internally, and cannot be reassigned, to change its contents requires using key-value pairs. If the node can be the target of a pragma, the information stored in this object is persisted between rebuilds.

Returns object
Inherited from Joinpoint.data
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:197
set data(value): void
JS object associated with this node, containing parsed data of #pragma clava data when the node can be a target of pragmas. This is a special object, managed internally, and cannot be reassigned, to change its contents requires using key-value pairs. If the node can be the target of a pragma, the information stored in this object is persisted between rebuilds.
Parameters
- value: object
Returns void
Inherited from Joinpoint.data
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:201

depth

get depth(): number
The depth of this join point in the AST. If it is the root join point returns 0, if it is a child of the root node returns 1, etc.

Returns number
Inherited from Joinpoint.depth
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:205

descendants

get descendants(): Joinpoint[]
Retrieves all descendants of the join point

Returns Joinpoint[]
Inherited from Joinpoint.descendants
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:209

dump

get dump(): string
Returns string
Inherited from Joinpoint.dump
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:36

endColumn

get endColumn(): number
The ending column of the current node in the original code

Returns number
Inherited from Joinpoint.endColumn
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:213

endLine

get endLine(): number
The ending line of the current node in the original code

Returns number
Inherited from Joinpoint.endLine
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:217

errorOutput

get errorOutput(): string
The output of the parser if there were errors during parsing

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:637

file

get file(): object
A Java file to the file that originated this translation unit

Returns object
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:641

filename

get filename(): string
The name of the file where the code of this node is located, if available

Returns string
Inherited from Joinpoint.filename
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:221

filepath

get filepath(): string
The complete path to the file where the code of this node comes from

Returns string
Inherited from Joinpoint.filepath
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:225

firstChild

get firstChild(): Joinpoint
Returns the first child of this node, or undefined if it has no child

Returns Joinpoint
Inherited from Joinpoint.firstChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:229
set firstChild(value): void
Returns the first child of this node, or undefined if it has no child
Parameters
- value: Joinpoint
Returns void
Inherited from Joinpoint.firstChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:233

hasChildren

get hasChildren(): boolean
True if the node has children, false otherwise

Returns boolean
Inherited from Joinpoint.hasChildren
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:237

hasMain

get hasMain(): boolean
True if this file contains a 'main' method

Returns boolean
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:645

hasParent

get hasParent(): boolean
True if this node has a parent

Returns boolean
Inherited from Joinpoint.hasParent
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:241

hasParsingErrors

get hasParsingErrors(): boolean
True if there were errors during parsing

Returns boolean
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:649

hasType

get hasType(): boolean
True, if the join point has a type

Returns boolean
Inherited from Joinpoint.hasType
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:245

includes

get includes(): Include[]
The includes of this file

Returns Include[]
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:653

inlineComments

get inlineComments(): Comment[]
Returns comments that are not explicitly in the AST, but embedded in other nodes

Returns Comment[]
Inherited from Joinpoint.inlineComments
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:249
set inlineComments(value): void
Returns comments that are not explicitly in the AST, but embedded in other nodes
Parameters
- value: string | string[]
Returns void
Inherited from Joinpoint.inlineComments
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:253

isCilk

get isCilk(): boolean
True if this is a Cilk node (i.e., cilk_spawn, cilk_sync or cilk_for)

Returns boolean
Inherited from Joinpoint.isCilk
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:257

isCxx

get isCxx(): boolean
True if this file is considered a C++ file

Returns boolean
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:657

isHeader

get isHeader(): boolean
True if this file is considered a header file

Returns boolean
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:661

isInsideHeader

get isInsideHeader(): boolean
True, if the join point is inside a header (e.g., if condition, for, while)

Returns boolean
Inherited from Joinpoint.isInsideHeader
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:265

isInsideLoopHeader

get isInsideLoopHeader(): boolean
True, if the join point is inside a loop header (e.g., for, while)

Returns boolean
Inherited from Joinpoint.isInsideLoopHeader
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:269

isInSystemHeader

get isInSystemHeader(): boolean
True, if the join point is part of a system header file

Returns boolean
Inherited from Joinpoint.isInSystemHeader
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:261

isMacro

get isMacro(): boolean
True if any descendant or the node itself was defined as a macro

Returns boolean
Inherited from Joinpoint.isMacro
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:273

isOpenCL

get isOpenCL(): boolean
True if this file is an OpenCL filetype

Returns boolean
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:665

javaFields

get javaFields(): string[]
The names of the Java fields of this node. Can be used as key of the attribute 'javaValue'

Returns string[]
Deprecated
used attribute 'keys' instead, together with 'getValue'
Inherited from Joinpoint.javaFields
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:279

joinPointType

get joinPointType(): string
Returns string
Inherited from Joinpoint.joinPointType
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:37

jpId

get jpId(): string
Id that is based on the position of the node in the code, and should remain stable between compilations (warning: only a few nodes - file, function, loop - currently support it)

Returns string
Inherited from Joinpoint.jpId
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:283

keys

get keys(): string[]
A list of the properties currently supported by this node. Can be used as parameter of the attribute 'getValue'

Returns string[]
Inherited from Joinpoint.keys
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:287

lastChild

get lastChild(): Joinpoint
Returns the last child of this node, or undefined if it has no child

Returns Joinpoint
Inherited from Joinpoint.lastChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:291
set lastChild(value): void
Returns the last child of this node, or undefined if it has no child
Parameters
- value: Joinpoint
Returns void
Inherited from Joinpoint.lastChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:295

leftJp

get leftJp(): Joinpoint
Returns the node that came before this node, or undefined if there is none

Returns Joinpoint
Inherited from Joinpoint.leftJp
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:299

line

get line(): number
The starting line of the current node in the original code

Returns number
Inherited from Joinpoint.line
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:303

location

get location(): string
A string with information about the file and code position of this node, if available

Returns string
Inherited from Joinpoint.location
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:307

name

get name(): string
The name of the file

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:669
set name(value): void
The name of the file
Parameters
- value: string
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:673

node

get node(): object
Returns object
Inherited from Joinpoint.node
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:38

numChildren

get numChildren(): number
Returns the number of children of the node, ignoring null nodes

Returns number
Inherited from Joinpoint.numChildren
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:311

originNode

get originNode(): Joinpoint
If this join point was not originally from the parsed AST, returns the first join point of the original AST that contributed to its origin

Returns Joinpoint
Inherited from Joinpoint.originNode
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:315

parent

get parent(): Joinpoint
Returns the parent node in the AST, or undefined if it is the root node

Returns Joinpoint
Inherited from Joinpoint.parent
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:319

parentRegion

get parentRegion(): Joinpoint
Returns the node that declares the scope that is a parent of the scope of this node

Returns Joinpoint
Inherited from Joinpoint.parentRegion
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:323

path

get path(): string
The folder of the source file

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:677

pragmas

get pragmas(): Pragma[]
The pragmas associated with this node

Returns Pragma[]
Inherited from Joinpoint.pragmas
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:327

relativeFilepath

get relativeFilepath(): string
The path to the file relative to the base source path

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:681

relativeFolderpath

get relativeFolderpath(): string
The path to the folder of the source file relative to the base source path

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:685
set relativeFolderpath(value): void
The path to the folder of the source file relative to the base source path
Parameters
- value: string
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:689

rightJp

get rightJp(): Joinpoint
Returns the node that comes after this node, or undefined if there is none

Returns Joinpoint
Inherited from Joinpoint.rightJp
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:331

root

get root(): Program
Returns the 'program' joinpoint

Returns Program
Inherited from Joinpoint.root
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:335

scopeNodes

get scopeNodes(): Joinpoint[]
The nodes of the scope of the current join point. If this node has a body (e.g., loop, function) corresponds to the children of the body. Otherwise, returns an empty array

Returns Joinpoint[]
Inherited from Joinpoint.scopeNodes
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:339

selects

get selects(): string[]
Returns string[]
Inherited from Joinpoint.selects
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:34

self

get self(): LaraJoinPoint
Returns LaraJoinPoint
Inherited from Joinpoint.self
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:39

siblingsLeft

get siblingsLeft(): Joinpoint[]
Returns an array with the siblings that came before this node

Returns Joinpoint[]
Inherited from Joinpoint.siblingsLeft
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:343

siblingsRight

get siblingsRight(): Joinpoint[]
Returns an array with the siblings that come after this node

Returns Joinpoint[]
Inherited from Joinpoint.siblingsRight
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:347

sourceFoldername

get sourceFoldername(): string
The name of the source folder of this file, or undefined if it has none

Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:693

stmt

get stmt(): Statement
Converts this join point to a statement, or returns undefined if it was not possible

Returns Statement
Inherited from Joinpoint.stmt
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:351

super

get super(): LaraJoinPoint
Returns LaraJoinPoint
Inherited from Joinpoint.super
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:40

type

get type(): Type
Returns Type
Inherited from Joinpoint.type
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:352
set type(value): void
Parameters
- value: Type
Returns void
Inherited from Joinpoint.type
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:353

Methods

addCInclude

addCInclude(name, isAngled?): void
Adds a C include to the current file. If the file already has the include, it does nothing
Parameters
- name: string
- isAngled: boolean = false
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:701

addFunction

addFunction(name): Joinpoint
Adds a function to the file that returns void and has no parameters
Parameters
- name: string
Returns Joinpoint
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:705

addGlobal

addGlobal(name, type, initValue): Vardecl
Adds a global variable to this file
Parameters
- name: string
- type: Joinpoint
- initValue: string
Returns Vardecl
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:709

addInclude

addInclude(name, isAngled?): void
Adds an include to the current file. If the file already has the include, it does nothing
Parameters
- name: string
- isAngled: boolean = false
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:713

addIncludeJp

addIncludeJp(jp): void
Overload of addInclude which accepts a join point
Parameters
- jp: Joinpoint
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:717

astIsInstance

astIsInstance(className): boolean
True, if this node is a Java instance of the given name, which corresponds to a simple Java class name of an AST node. For an equivalent function for join point names, use 'instanceOf(joinPointName)'
Parameters
- className: string
Returns boolean
Inherited from Joinpoint.astIsInstance
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:357

contains

contains(jp): boolean
True if the given node is a descendant of this node
Parameters
- jp: Joinpoint
Returns boolean
Inherited from Joinpoint.contains
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:361

copy

copy(): Joinpoint
Performs a copy of the node and its children, but not of the nodes in its fields

Returns Joinpoint
Inherited from Joinpoint.copy
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:417

dataClear

dataClear(): void
Clears all properties from the .data object

Returns void
Inherited from Joinpoint.dataClear
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:421

deepCopy

deepCopy(): Joinpoint
Performs a copy of the node and its children, including the nodes in their fields (only the first level of field nodes, this function is not recursive)

Returns Joinpoint
Inherited from Joinpoint.deepCopy
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:425

def

def(attribute, value): void
Parameters
- attribute: string
- value: object
Returns void
Inherited from Joinpoint.def
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:46

detach

detach(): Joinpoint
Removes the node associated to this joinpoint from the AST

Returns Joinpoint
Inherited from Joinpoint.detach
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:429

equals

equals(jp): boolean
Parameters
- jp: LaraJoinPoint
Returns boolean
Inherited from Joinpoint.equals
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:48

getAncestor

getAncestor(type): Joinpoint
Looks for an ancestor joinpoint name, walking back on the AST
Parameters
- type: string
Returns Joinpoint
Inherited from Joinpoint.getAncestor
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:365

getAstAncestor

getAstAncestor(type): Joinpoint
Parameters
- type: string
Returns Joinpoint
Deprecated
Looks for an ancestor AST name, walking back on the AST
Inherited from Joinpoint.getAstAncestor
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:369

getAstChild

getAstChild(index): Joinpoint
Returns the child of the node at the given index, considering null nodes
Parameters
- index: number
Returns Joinpoint
Inherited from Joinpoint.getAstChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:373

getChainAncestor

getChainAncestor(type): Joinpoint
Looks for an ancestor joinpoint name, walking back on the joinpoint chain
Parameters
- type: string
Returns Joinpoint
Inherited from Joinpoint.getChainAncestor
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:377

getChild

getChild(index): Joinpoint
Returns the child of the node at the given index, ignoring null nodes
Parameters
- index: number
Returns Joinpoint
Inherited from Joinpoint.getChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:381

getDescendants

getDescendants(type): Joinpoint[]
Retrieves the descendants of the given type
Parameters
- type: string
Returns Joinpoint[]
Inherited from Joinpoint.getDescendants
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:385

getDescendantsAndSelf

getDescendantsAndSelf(type): Joinpoint[]
Retrieves the descendants of the given type, including the node itself
Parameters
- type: string
Returns Joinpoint[]
Inherited from Joinpoint.getDescendantsAndSelf
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:389

getDestinationFilepath

getDestinationFilepath(destinationFolderpath?): string
The complete path to the file that will be generated by the weaver, given a destination folder
Parameters
- OptionaldestinationFolderpath: string
Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:697

getFirstJp

getFirstJp(type): Joinpoint
Looks in the descendants for the first node of the given type
Parameters
- type: string
Returns Joinpoint
Inherited from Joinpoint.getFirstJp
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:393

getJavaFieldType

getJavaFieldType(fieldName): string
String with the full Java class name of the type of the Java field with the provided name
Parameters
- fieldName: string
Returns string
Inherited from Joinpoint.getJavaFieldType
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:397

getKeyType

getKeyType(key): object
Java Class instance with the type of the given key
Parameters
- key: string
Returns object
Inherited from Joinpoint.getKeyType
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:401

getUserField

getUserField(fieldName): object
Retrives values that have been associated to nodes of the AST with 'setUserField'
Parameters
- fieldName: string
Returns object
Inherited from Joinpoint.getUserField
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:405

getValue

getValue(key): object
The value associated with the given property key
Parameters
- key: string
Returns object
Inherited from Joinpoint.getValue
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:409

hasNode

hasNode(nodeOrJp): boolean
True, if the given join point or AST node is the same (== test) as the current join point AST node
Parameters
- nodeOrJp: object
Returns boolean
Inherited from Joinpoint.hasNode
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:413

insert

insert(position, code): LaraJoinPoint
Parameters
- position: "replace" | "after" | "before"
- code: string
Returns LaraJoinPoint
Inherited from Joinpoint.insert
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:44
insert(position, joinpoint): LaraJoinPoint
Parameters
- position: "replace" | "after" | "before"
- joinpoint: LaraJoinPoint
Returns LaraJoinPoint
Inherited from Joinpoint.insert
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:45

insertAfter

insertAfter(node): Joinpoint
Inserts the given join point after this join point
Parameters
- node: Joinpoint
Returns Joinpoint
Inherited from Joinpoint.insertAfter
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:433
insertAfter(code): Joinpoint
Overload which accepts a string
Parameters
- code: string
Returns Joinpoint
Inherited from Joinpoint.insertAfter
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:437

insertBefore

insertBefore(node): Joinpoint
Inserts the given join point before this join point
Parameters
- node: Joinpoint
Returns Joinpoint
Inherited from Joinpoint.insertBefore
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:445
insertBefore(node): Joinpoint
Overload which accepts a string
Parameters
- node: string
Returns Joinpoint
Inherited from Joinpoint.insertBefore
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:449

insertBegin

insertBegin(node): void
Adds the node in the join point to the start of the file
Parameters
- node: Joinpoint
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:721
insertBegin(code): void
Adds the String as a Decl to the end of the file
Parameters
- code: string
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:725

insertEnd

insertEnd(node): void
Adds the node in the join point to the end of the file
Parameters
- node: Joinpoint
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:733
insertEnd(code): void
Adds the String as a Decl to the end of the file
Parameters
- code: string
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:737

instanceOf

instanceOf(name): boolean
Parameters
- name: string
Returns boolean
Inherited from Joinpoint.instanceOf
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:49
instanceOf(names): boolean
Parameters
- names: string[]
Returns boolean
Inherited from Joinpoint.instanceOf
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:50

messageToUser

messageToUser(message): void
Adds a message that will be printed to the user after weaving finishes. Identical messages are removed
Parameters
- message: string
Returns void
Inherited from Joinpoint.messageToUser
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:457

rebuild

rebuild(): FileJp
Recompiles only this file, returns a join point to the new recompiled file, or throws an exception if a problem happens

Returns FileJp
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:745

rebuildTry

rebuildTry(): Joinpoint
Recompiles only this file, returns a join point to the new recompiled file, or returns a clavaException join point if a problem happens

Returns Joinpoint
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:749

removeChildren

removeChildren(): void
Removes the children of this node

Returns void
Inherited from Joinpoint.removeChildren
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:461

replaceWith

replaceWith(node): Joinpoint
Replaces this node with the given node
Parameters
- node: Joinpoint
Returns Joinpoint
Inherited from Joinpoint.replaceWith
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:465
replaceWith(node): Joinpoint
Overload which accepts a string
Parameters
- node: string
Returns Joinpoint
Inherited from Joinpoint.replaceWith
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:469
replaceWith(node): Joinpoint
Overload which accepts a list of join points
Parameters
- node: Joinpoint[]
Returns Joinpoint
Inherited from Joinpoint.replaceWith
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:473

replaceWithStrings

replaceWithStrings(node): Joinpoint
Overload which accepts a list of strings
Parameters
- node: string[]
Returns Joinpoint
Inherited from Joinpoint.replaceWithStrings
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:481

setData

setData(source): void
Setting data directly is not supported, this action just emits a warning and does nothing
Parameters
- source: object
Returns void
Inherited from Joinpoint.setData
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:485

setFirstChild

setFirstChild(node): Joinpoint
Replaces the first child, or inserts the join point if no child is present. Returns the replaced child, or undefined if there was no child present.
Parameters
- node: Joinpoint
Returns Joinpoint
Inherited from Joinpoint.setFirstChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:489

setInlineComments

setInlineComments(comments): void
Sets the commented that are embedded in a node
Parameters
- comments: string[]
Returns void
Inherited from Joinpoint.setInlineComments
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:493
setInlineComments(comments): void
Sets the commented that are embedded in a node
Parameters
- comments: string
Returns void
Inherited from Joinpoint.setInlineComments
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:497

setLastChild

setLastChild(node): Joinpoint
Replaces the last child, or inserts the join point if no child is present. Returns the replaced child, or undefined if there was no child present.
Parameters
- node: Joinpoint
Returns Joinpoint
Inherited from Joinpoint.setLastChild
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:505

setName

setName(filename): void
Changes the name of the file
Parameters
- filename: string
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:753

setRelativeFolderpath

setRelativeFolderpath(path): void
Sets the path to the folder of the source file relative to the base source path
Parameters
- path: string
Returns void
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:757

setType

setType(type): void
Sets the type of a node, if it has a type
Parameters
- type: Type
Returns void
Inherited from Joinpoint.setType
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:509

setUserField

setUserField(fieldName, value): object
Associates arbitrary values to nodes of the AST
Parameters
- fieldName: string
- value: object
Returns object
Inherited from Joinpoint.setUserField
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:513
setUserField(fieldNameAndValue): object
Overload which accepts a map
Parameters
- fieldNameAndValue: Record<string, any>
Returns object
Inherited from Joinpoint.setUserField
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:517

setValue

setValue(key, value): Joinpoint
Sets the value associated with the given property key
Parameters
- key: string
- value: object
Returns Joinpoint
Inherited from Joinpoint.setValue
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:525

toComment

toComment(prefix?, suffix?): Joinpoint
Replaces this join point with a comment with the same contents as .code
Parameters
- prefix: string = ""
- suffix: string = ""
Returns Joinpoint
Inherited from Joinpoint.toComment
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:529

toString

toString(): string
Returns string
Inherited from Joinpoint.toString
- Defined in lara-framework/Lara-JS/api/LaraJoinPoint.d.ts:47

write

write(destinationFoldername): string
Writes the code of this file to a given folder
Parameters
- destinationFoldername: string
Returns string
- Defined in clava/Clava-JS/src-api/Joinpoints.ts:761

Class FileJp

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FileJp

Properties

Internal_javaObject

Static Readonly Internal_defaultAttributeInfo

Accessors

actions

Returns string[]

ast

Returns string

astChildren

Returns Joinpoint[]

astId

Returns string

astName

Returns string

astNumChildren

Returns number

attributes

Returns string[]

baseSourcePath

Returns string

bitWidth

Returns number

chain

Returns string[]

children

Returns Joinpoint[]

code

Returns string

column

Returns number

currentRegion

Returns Joinpoint

data

Returns object

Parameters

Returns void

depth

Returns number

descendants

Returns Joinpoint[]

dump

Returns string

endColumn

Returns number

endLine

Returns number

errorOutput

Returns string

file

Returns object

filename

Returns string

filepath

Returns string

firstChild

Returns Joinpoint

Parameters

Returns void

hasChildren

Returns boolean

hasMain

Returns boolean

hasParent

Returns boolean

hasParsingErrors

Returns boolean

hasType

Returns boolean

includes

`Internal`_javaObject

`Static` `Readonly` `Internal`_defaultAttributeInfo