Class Switch

Internal_javaObject

actions

• get actions(): string[]

• Returns string[]

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

astChildren

• get astChildren(): Joinpoint[]

• Returns an array with the children of the node, considering null nodes

  Returns Joinpoint[]

astId

• get astId(): string

• String that uniquely identifies this node

  Returns string

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

astNumChildren

• get astNumChildren(): number

• Returns the number of children of the node, considering null nodes

  Returns number

attributes

• get attributes(): string[]

• Returns string[]

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

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[]

children

• get children(): Joinpoint[]

• Returns an array with the children of the node, ignoring null nodes

  Returns Joinpoint[]

code

• get code(): string

• String with the code represented by this node

  Returns string

column

• get column(): number

• The starting column of the current node in the original code

  Returns number

currentRegion

• get currentRegion(): Joinpoint

• Returns the node that declares the scope of this node

  Returns Joinpoint

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
• 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

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

descendants

• get descendants(): Joinpoint[]

• Retrieves all descendants of the join point

  Returns Joinpoint[]

dump

• get dump(): string

• Returns string

endColumn

• get endColumn(): number

• The ending column of the current node in the original code

  Returns number

endLine

• get endLine(): number

• The ending line of the current node in the original code

  Returns number

filename

• get filename(): string

• The name of the file where the code of this node is located, if available

  Returns string

filepath

• get filepath(): string

• The complete path to the file where the code of this node comes from

  Returns string

firstChild

• get firstChild(): Joinpoint

• Returns the first child of this node, or undefined if it has no child

  Returns Joinpoint
• set firstChild(value): void

• Returns the first child of this node, or undefined if it has no child

  Parameters

  • value: Joinpoint

  Returns void

hasChildren

• get hasChildren(): boolean

• True if the node has children, false otherwise

  Returns boolean

hasParent

• get hasParent(): boolean

• True if this node has a parent

  Returns boolean

hasType

• get hasType(): boolean

• True, if the join point has a type

  Returns boolean

inlineComments

• get inlineComments(): Comment[]

• Returns comments that are not explicitly in the AST, but embedded in other nodes

  Returns Comment[]
• set inlineComments(value): void

• Returns comments that are not explicitly in the AST, but embedded in other nodes

  Parameters

  • value: string | string[]

  Returns void

isCilk

• get isCilk(): boolean

• True if this is a Cilk node (i.e., cilk_spawn, cilk_sync or cilk_for)

  Returns boolean

isFirst

• get isFirst(): boolean

• Returns boolean

isInsideHeader

• get isInsideHeader(): boolean

• True, if the join point is inside a header (e.g., if condition, for, while)

  Returns boolean

isInsideLoopHeader

• get isInsideLoopHeader(): boolean

• True, if the join point is inside a loop header (e.g., for, while)

  Returns boolean

isInSystemHeader

• get isInSystemHeader(): boolean

• True, if the join point is part of a system header file

  Returns boolean

isLast

• get isLast(): boolean

• Returns boolean

isMacro

• get isMacro(): boolean

• True if any descendant or the node itself was defined as a macro

  Returns boolean

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'

joinPointType

• get joinPointType(): string

• Returns string

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

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[]

lastChild

• get lastChild(): Joinpoint

• Returns the last child of this node, or undefined if it has no child

  Returns Joinpoint
• set lastChild(value): void

• Returns the last child of this node, or undefined if it has no child

  Parameters

  • value: Joinpoint

  Returns void

leftJp

• get leftJp(): Joinpoint

• Returns the node that came before this node, or undefined if there is none

  Returns Joinpoint

line

• get line(): number

• The starting line of the current node in the original code

  Returns number

location

• get location(): string

• A string with information about the file and code position of this node, if available

  Returns string

node

• get node(): object

• Returns object

numChildren

• get numChildren(): number

• Returns the number of children of the node, ignoring null nodes

  Returns number

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

parent

• get parent(): Joinpoint

• Returns the parent node in the AST, or undefined if it is the root node

  Returns Joinpoint

parentRegion

• get parentRegion(): Joinpoint

• Returns the node that declares the scope that is a parent of the scope of this node

  Returns Joinpoint

pragmas

• get pragmas(): Pragma[]

• The pragmas associated with this node

  Returns Pragma[]

rightJp

• get rightJp(): Joinpoint

• Returns the node that comes after this node, or undefined if there is none

  Returns Joinpoint

root

• get root(): Program

• Returns the 'program' joinpoint

  Returns Program

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[]

selects

• get selects(): string[]

• Returns string[]

self

• get self(): LaraJoinPoint

• Returns LaraJoinPoint

siblingsLeft

• get siblingsLeft(): Joinpoint[]

• Returns an array with the siblings that came before this node

  Returns Joinpoint[]

siblingsRight

• get siblingsRight(): Joinpoint[]

• Returns an array with the siblings that come after this node

  Returns Joinpoint[]

stmt

• get stmt(): Statement

• Converts this join point to a statement, or returns undefined if it was not possible

  Returns Statement

super

• get super(): LaraJoinPoint

• Returns LaraJoinPoint

type

• get type(): Type

• Returns Type

• set type(value): void

• Parameters

  • value: Type

  Returns void

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

contains

• contains(jp): boolean

• True if the given node is a descendant of this node

  Parameters

  • jp: Joinpoint

  Returns boolean

copy

• copy(): Joinpoint

• Performs a copy of the node and its children, but not of the nodes in its fields

  Returns Joinpoint

dataClear

• dataClear(): void

• Clears all properties from the .data object

  Returns void

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

def

• def(attribute, value): void

• Parameters

  • attribute: string
  • value: object

  Returns void

detach

• detach(): Joinpoint

• Removes the node associated to this joinpoint from the AST

  Returns Joinpoint

equals

• equals(jp): boolean

• Parameters

  • jp: LaraJoinPoint

  Returns boolean

getAncestor

• getAncestor(type): Joinpoint

• Looks for an ancestor joinpoint name, walking back on the AST

  Parameters

  • type: string

  Returns Joinpoint

getAstAncestor

• getAstAncestor(type): Joinpoint

• Parameters

  • type: string

  Returns Joinpoint

  Deprecated

  Looks for an ancestor AST name, walking back on the AST

getAstChild

• getAstChild(index): Joinpoint

• Returns the child of the node at the given index, considering null nodes

  Parameters

  • index: number

  Returns Joinpoint

getChainAncestor

• getChainAncestor(type): Joinpoint

• Looks for an ancestor joinpoint name, walking back on the joinpoint chain

  Parameters

  • type: string

  Returns Joinpoint

getChild

• getChild(index): Joinpoint

• Returns the child of the node at the given index, ignoring null nodes

  Parameters

  • index: number

  Returns Joinpoint

getDescendants

• getDescendants(type): Joinpoint[]

• Retrieves the descendants of the given type

  Parameters

  • type: string

  Returns Joinpoint[]

getDescendantsAndSelf

• getDescendantsAndSelf(type): Joinpoint[]

• Retrieves the descendants of the given type, including the node itself

  Parameters

  • type: string

  Returns Joinpoint[]

getFirstJp

• getFirstJp(type): Joinpoint

• Looks in the descendants for the first node of the given type

  Parameters

  • type: string

  Returns Joinpoint

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

getKeyType

• getKeyType(key): object

• Java Class instance with the type of the given key

  Parameters

  • key: string

  Returns object

getUserField

• getUserField(fieldName): object

• Retrives values that have been associated to nodes of the AST with 'setUserField'

  Parameters

  • fieldName: string

  Returns object

getValue

• getValue(key): object

• The value associated with the given property key

  Parameters

  • key: string

  Returns object

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

insert

• insert(position, code): LaraJoinPoint

• Parameters

  • position: "replace" | "after" | "before"
  • code: string

  Returns LaraJoinPoint

• insert(position, joinpoint): LaraJoinPoint

• Parameters

  • position: "replace" | "after" | "before"
  • joinpoint: LaraJoinPoint

  Returns LaraJoinPoint

insertAfter

• insertAfter(node): Joinpoint

• Inserts the given join point after this join point

  Parameters

  • node: Joinpoint

  Returns Joinpoint
• insertAfter(code): Joinpoint

• Overload which accepts a string

  Parameters

  • code: string

  Returns Joinpoint

insertBefore

• insertBefore(node): Joinpoint

• Inserts the given join point before this join point

  Parameters

  • node: Joinpoint

  Returns Joinpoint
• insertBefore(node): Joinpoint

• Overload which accepts a string

  Parameters

  • node: string

  Returns Joinpoint

instanceOf

• instanceOf(name): boolean

• Parameters

  • name: string

  Returns boolean

• instanceOf(names): boolean

• Parameters

  • names: string[]

  Returns boolean

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

removeChildren

• removeChildren(): void

• Removes the children of this node

  Returns void

replaceWith

• replaceWith(node): Joinpoint

• Replaces this node with the given node

  Parameters

  • node: Joinpoint

  Returns Joinpoint
• replaceWith(node): Joinpoint

• Overload which accepts a string

  Parameters

  • node: string

  Returns Joinpoint
• replaceWith(node): Joinpoint

• Overload which accepts a list of join points

  Parameters

  • node: Joinpoint[]

  Returns Joinpoint

replaceWithStrings

• replaceWithStrings(node): Joinpoint

• Overload which accepts a list of strings

  Parameters

  • node: string[]

  Returns Joinpoint

setData

• setData(source): void

• Setting data directly is not supported, this action just emits a warning and does nothing

  Parameters

  • source: object

  Returns void

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

setInlineComments

• setInlineComments(comments): void

• Sets the commented that are embedded in a node

  Parameters

  • comments: string[]

  Returns void
• setInlineComments(comments): void

• Sets the commented that are embedded in a node

  Parameters

  • comments: string

  Returns void

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

setType

• setType(type): void

• Sets the type of a node, if it has a type

  Parameters

  • type: Type

  Returns void

setUserField

• setUserField(fieldName, value): object

• Associates arbitrary values to nodes of the AST

  Parameters

  • fieldName: string
  • value: object

  Returns object
• setUserField(fieldNameAndValue): object

• Overload which accepts a map

  Parameters

  • fieldNameAndValue: Record<string, any>

  Returns object

setValue

• setValue(key, value): Joinpoint

• Sets the value associated with the given property key

  Parameters

  • key: string
  • value: object

  Returns Joinpoint

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

toString

• toString(): string

• Returns string