commonMain.org.antlr.v4.kotlinruntime.tree.Tree.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of antlr-kotlin-runtime-jvm Show documentation

Kotlin multiplatform port of ANTLR

There is a newer version: 0.0.18

Show newest version

/*
 * Copyright (c) 2012-2017 The ANTLR Project. All rights reserved.
 * Use of this file is governed by the BSD 3-clause license that
 * can be found in the LICENSE.txt file in the project root.
 */

package org.antlr.v4.kotlinruntime.tree

import org.antlr.v4.kotlinruntime.RuleContext
import org.antlr.v4.kotlinruntime.Token

/** The basic notion of a tree has a parent, a payload, and a list of children.
 * It is the most abstract interface for all the trees used by ANTLR.
 */
interface Tree {
    /** The parent of this node. If the return value is null, then this
     * node is the root of the tree.
     */
    //var parent: Tree?

    //private var parent : Tree?

//    public fun assignParent(value: ParseTree?) {
//        this.parent = value
//    }

    fun readParent(): Tree?

    /**
     * This method returns whatever object represents the data at this note. For
     * example, for parse trees, the payload can be a [Token] representing
     * a leaf node or a [RuleContext] object representing a rule
     * invocation. For abstract syntax trees (ASTs), this is a [Token]
     * object.
     */
    val payload: Any?

    /** How many children are there? If there is none, then this
     * node represents a leaf node.
     */
    val childCount: Int

    /** If there are children, get the `i`th value indexed from 0.  */
    fun getChild(i: Int): Tree?

    /** Print out a whole tree, not just a node, in LISP format
     * `(root child1 .. childN)`. Print just a node if this is a leaf.
     */
    fun toStringTree(): String
}