CAstNode

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.wala.cast.tree
Interface CAstNode

All Known Implementing Classes:: CAstImpl.CAstNodeImpl, CAstImpl.CAstValueImpl, CAstOperator, CAstValueImpl.CAstNodeValueImpl, CAstValueImpl.CAstValueValueImpl

public interface CAstNode

This interface represents nodes of CAPA Abstract Syntax Trees. It is a deliberately minimal interface, simply assuming that the nodes form a tree and have some minimal state at each node. In particular, a node has a kind---which should be one of the symbolic constants in this file---and potentially has child nodes, a constant values, or possibly both. Note that there is no support for mutating these trees. This is deliberate, and should not be changed. We do not want to force all clients of the capa ast to handle mutating programs. In particular, the DOMO infrastructure has many forms of caching and other operations that rely on the underlying program being immutable. If you need to mutate these trees for some reason---and think carefully if you really need to, since this is meant to be essentially a wire format between components---make specialized implementations that understand how to do that. Also note that this interface does not assume that you need some great big class hierarchy to structure types of nodes in an ast. Some people prefer such hierarchies as a matter of taste, but this interface is designed to not inflict this design choice on others. Finally note that the set of node types in this file is not meant to be exhaustive. As new languages are added, feel free to add new nodes types as needed.

Field Summary
`static int`	`ANDOR_EXPR`
`static int`	`ARRAY_LENGTH`
`static int`	`ARRAY_LITERAL`
`static int`	`ARRAY_REF`
`static int`	`ASSERT`
`static int`	`ASSIGN`
`static int`	`ASSIGN_POST_OP`
`static int`	`ASSIGN_PRE_OP`
`static int`	`BINARY_EXPR`
`static int`	`BLOCK_EXPR` Represents a block of sequentially-executed nodes, the last of which produces the value for the entire block (like progn from lisp).
`static int`	`BLOCK_STMT` Represents a block of sequential statements.
`static int`	`BREAK`
`static int`	`CALL`
`static int`	`CAST`
`static int`	`CATCH`
`static int`	`CHOICE_CASE`
`static int`	`CHOICE_EXPR`
`static int`	`CONSTANT`
`static int`	`CONTINUE`
`static int`	`DECL_STMT`
`static int`	`EACH_ELEMENT_GET`
`static int`	`EACH_ELEMENT_HAS_NEXT`
`static int`	`ECHO`
`static int`	`EMPTY`
`static int`	`EMPTY_LIST_EXPR`
`static int`	`ERROR`
`static int`	`EXPR_LIST`
`static int`	`EXPR_STMT` Represents an expression statement (e.g.
`static int`	`FUNCTION_EXPR`
`static int`	`FUNCTION_STMT`
`static int`	`GET_CAUGHT_EXCEPTION`
`static int`	`GOTO`
`static int`	`IF_EXPR`
`static int`	`IF_STMT`
`static int`	`IFGOTO`
`static int`	`INSTANCEOF`
`static int`	`IS_DEFINED_EXPR`
`static int`	`LABEL_STMT`
`static int`	`LIST_EXPR`
`static int`	`LOCAL_SCOPE`
`static int`	`LOOP` Represents a standard while loop.
`static int`	`MONITOR_ENTER`
`static int`	`MONITOR_EXIT`
`static int`	`NEW`
`static int`	`OBJECT_LITERAL`
`static int`	`OBJECT_REF`
`static int`	`OPERATOR`
`static int`	`PRIMITIVE`
`static int`	`RETURN`
`static int`	`RETURN_WITHOUT_BRANCH`
`static int`	`SUB_LANGUAGE_BASE`
`static int`	`SUPER`
`static int`	`SWITCH` Represents a standard case statement.
`static int`	`THIS`
`static int`	`THROW`
`static int`	`TRY` Represents a standard try/catch statement.
`static int`	`TYPE_LITERAL_EXPR`
`static int`	`TYPE_OF`
`static int`	`UNARY_EXPR`
`static int`	`UNWIND`
`static int`	`VAR`
`static int`	`VOID`

Method Summary
`CAstNode`	`getChild(int n)` Return the nth child of this node.
`int`	`getChildCount()` How many children does this node have?
`int`	`getKind()` What kind of node is this? Should return some constant from this file.
`java.lang.Object`	`getValue()` Returns the constant value represented by this node, if appropriate, and null otherwise.

Field Detail

SWITCH

static final int SWITCH

Represents a standard case statement. Children:

condition expression

BLOCK_STMT containing all the cases

See Also:: Constant Field Values

LOOP

static final int LOOP

Represents a standard while loop. Children:

expression denoting the loop condition
statement denoting the loop body

See Also:: Constant Field Values

BLOCK_STMT

static final int BLOCK_STMT

Represents a block of sequential statements. Children:

statement #1
statement #2
...

See Also:: Constant Field Values

TRY

static final int TRY

Represents a standard try/catch statement. Note that while some languages choose to bundle together the notion of try/catch and the notion of unwind-protect (aka 'finally'), the CAst does not. There is a separate UNWIND node type. Children: