ControlStructure

• NODE PROPERTIES:

▸ ArgumentIndex (Int); Cardinality one (mandatory with default value -1); AST-children of CALL nodes have an argument index, that is used to match call-site arguments with callee parameters. Explicit parameters are numbered from 1 to N, while index 0 is reserved for implicit self / this parameter. CALLs without implicit parameter therefore have arguments starting with index 1. AST-children of BLOCK nodes may have an argument index as well; in this case, the last argument index determines the return expression of a BLOCK expression. If the PARAMETER_NAME field is set, then the ARGUMENT_INDEX field is ignored. It is suggested to set it to -1.

▸ ArgumentName (String); Cardinality ZeroOrOne (optional); For calls involving named parameters, the ARGUMENT_NAME field holds the name of the parameter initialized by the expression. For all other calls, this field is unset.

▸ Code (String); Cardinality one (mandatory with default value <empty>); This field holds the code snippet that the node represents.

▸ ColumnNumber (Int); Cardinality ZeroOrOne (optional); This optional fields provides the column number of the program construct represented by the node.

▸ ControlStructureType (String); Cardinality one (mandatory with default value <empty>); The CONTROL_STRUCTURE_TYPE field indicates which kind of control structure a CONTROL_STRUCTURE node represents. The available types are the following: BREAK, CONTINUE, DO, WHILE, FOR, GOTO, IF, ELSE, TRY, THROW and SWITCH.

▸ LineNumber (Int); Cardinality ZeroOrOne (optional); This optional field provides the line number of the program construct represented by the node.

▸ Offset (Int); Cardinality ZeroOrOne (optional); Start offset into the CONTENT property of the corresponding FILE node. The offset is such that parts of the content can easily be accessed via content.substring(offset, offsetEnd). This means that the offset must be measured in utf16 encoding (i.e. neither in characters/codeunits nor in byte-offsets into a utf8 encoding). E.g. for METHOD nodes this start offset points to the start of the methods source code in the string holding the source code of the entire file.

▸ OffsetEnd (Int); Cardinality ZeroOrOne (optional); End offset (exclusive) into the CONTENT property of the corresponding FILE node. See OFFSET documentation for finer details. E.g. for METHOD nodes this end offset points to the first code position which is not part of the method.

▸ Order (Int); Cardinality one (mandatory with default value -1); This integer indicates the position of the node among its siblings in the AST. The left-most child has an order of 0.

▸ ParserTypeName (String); Cardinality one (mandatory with default value <empty>); AST node type name emitted by parser.