cpg-analysis/de.fraunhofer.aisec.cpg.query/QueryTree

QueryTree

open class QueryTree<T>(var value: T, val children: MutableList<QueryTree<*>> = mutableListOf(), var stringRepresentation: String = "") : Comparable<QueryTree<T>>

Holds the value to which the statements have been evaluated. The children define previous steps of the evaluation, thus building a tree of all steps of the evaluation recursively until we reach the nodes of the CPG. This is necessary if we want to store all steps which are performed when evaluating a query. It helps to make the reasoning of the query more understandable to the user and gives an analyst the maximum of information available.

Numerous methods allow to evaluate the queries while keeping track of all the steps. Currently, the following operations are supported:

eq: Equality of two values.
ne: Inequality of two values.
IN: Checks if a value is contained in a Collection
IS: Checks if a value implements a type (Class).

Additionally, some functions are available only for certain types of values.

For boolean values:

and: Logical and operation (&&)
or: Logical or operation (||)
xor: Logical exclusive or operation (xor)
implies: Logical implication

For numeric values:

gt: Grater than (>)
ge: Grater than or equal (>=)
lt: Less than (<)
le: Less than or equal (<=)

Constructors

QueryTree

constructor(value: T, children: MutableList<QueryTree<*>> = mutableListOf(), stringRepresentation: String = "")

Properties

children

open val children: MutableList<QueryTree<*>>

stringRepresentation

open var stringRepresentation: String

value

open var value: T

Functions

and

infix fun QueryTree<Boolean>.and(other: QueryTree<Boolean>): QueryTree<Boolean>

Performs a logical and (&&) operation between the values of two QueryTrees.

compareTo

open operator override fun compareTo(other: QueryTree<T>): Int

operator fun compareTo(other: Number): Int

infix fun eq(other: T): QueryTree<Boolean>

Checks for equality of a QueryTree with a value of the same type (e.g. useful to check for constants).

infix fun eq(other: QueryTree<T>): QueryTree<Boolean>

Checks for equality of two QueryTrees.

equals

open operator override fun equals(other: Any?): Boolean

infix fun <T : Number, S : Number> QueryTree<T>.ge(other: S): QueryTree<Boolean>

Compares the numeric values of a QueryTree and another number for this being "greater than or equal" (>=) other.

infix fun <T : Number, S : Number> QueryTree<T>.ge(other: QueryTree<S>): QueryTree<Boolean>

Compares the numeric values of two QueryTrees for this being "greater than or equal" (>=) other.

infix fun <T : Number, S : Number> QueryTree<T>.gt(other: S): QueryTree<Boolean>

Compares the numeric values of a QueryTree and another number for this being "greater than" (>) other.

infix fun <T : Number, S : Number> QueryTree<T>.gt(other: QueryTree<S>): QueryTree<Boolean>

Compares the numeric values of two QueryTrees for this being "greater than" (>) other.

hashCode

open override fun hashCode(): Int

implies

infix fun QueryTree<Boolean>.implies(other: QueryTree<Boolean>): QueryTree<Boolean>

infix fun QueryTree<Boolean>.implies(other: Lazy<QueryTree<Boolean>>): QueryTree<Boolean>

Evaluates a logical implication (->) operation between the values of two QueryTrees.

infix fun IN(other: QueryTree<Collection<*>>): QueryTree<Boolean>

Checks if the value is contained in the collection of the other QueryTree.

infix fun IN(other: Collection<*>): QueryTree<Boolean>

Checks if the value is contained in the collection other.

infix fun IS(other: QueryTree<Class<*>>): QueryTree<Boolean>

Checks if the value is a member of the type of the other QueryTree.

infix fun IS(other: Class<*>): QueryTree<Boolean>

Checks if the value is a member of the type of other.

infix fun <T : Number, S : Number> QueryTree<T>.le(other: S): QueryTree<Boolean>

Compares the numeric values of a QueryTree and another number for this being "less than or equal" (<=) other.

infix fun <T : Number, S : Number> QueryTree<T>.le(other: QueryTree<S>): QueryTree<Boolean>

Compares the numeric values of two QueryTrees for this being "less than or equal" (=) other.

infix fun <T : Number, S : Number> QueryTree<T>.lt(other: S): QueryTree<Boolean>

Compares the numeric values of a QueryTree and another number for this being "less than" (<) other.

infix fun <T : Number, S : Number> QueryTree<T>.lt(other: QueryTree<S>): QueryTree<Boolean>

Compares the numeric values of two QueryTrees for this being "less than" (<) other.

infix fun ne(other: T): QueryTree<Boolean>

Checks for inequality of a QueryTree with a value of the same type (e.g. useful to check for constants).

infix fun ne(other: QueryTree<T>): QueryTree<Boolean>

Checks for inequality of two QueryTrees.

infix fun QueryTree<Boolean>.or(other: QueryTree<Boolean>): QueryTree<Boolean>

Performs a logical or (||) operation between the values of two QueryTrees.

printNicely

fun printNicely(depth: Int = 0): String

xor

infix fun QueryTree<Boolean>.xor(other: QueryTree<Boolean>): QueryTree<Boolean>

Performs a logical xor operation between the values of two QueryTrees.