com.ibm.wala.cast.tree.rewrite

Class CAstRewriter<C extends CAstRewriter.RewriteContext<K>,K extends CAstRewriter.CopyKey<K>>

java.lang.Object

com.ibm.wala.cast.tree.rewrite.CAstRewriter<C,K>

Type Parameters:

C - type of the RewriteContext used when traversing the original CAst during the rewrite operation

K - a key used to ease cloning of partial ASTs. When rewriting an AST, sub-classes maintain a mapping from (original node, key) pairs (where key is of type K) to new nodes; see copyNodes(com.ibm.wala.cast.tree.CAstNode, com.ibm.wala.cast.tree.CAstControlFlowMap, C, java.util.Map<com.ibm.wala.util.collections.Pair<com.ibm.wala.cast.tree.CAstNode, K>, com.ibm.wala.cast.tree.CAstNode>)

Direct Known Subclasses:

AstLoopUnwinder, CAstBasicRewriter

public abstract class CAstRewriter<C extends CAstRewriter.RewriteContext<K>,K extends CAstRewriter.CopyKey<K>>
extends java.lang.Object

Abstract superclass for types performing a rewrite operation on a CAst. The CAst is not mutated; instead, a new CAst is created which delegates to the original CAst where no transformation was performed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CAstRewriter.CopyKey<Self extends CAstRewriter.CopyKey<Self>> interface to be implemented by keys used for cloning sub-trees during the rewrite
static interface	CAstRewriter.Rewrite represents a rewritten CAst
static interface	CAstRewriter.RewriteContext<K extends CAstRewriter.CopyKey<K>> interface to be implemented by contexts used while traversing the AST

Field Summary

Fields

Modifier and Type	Field and Description
protected CAst	Ast
protected static boolean	DEBUG
protected boolean	recursive for CAstEntity nodes r s.t.
protected C	rootContext

Constructor Summary

Constructors

Constructor and Description
CAstRewriter(CAst Ast, boolean recursive, C rootContext)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<CAstNode,java.util.Collection<CAstEntity>>	copyChildren(CAstNode root, java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap, java.util.Map<CAstNode,java.util.Collection<CAstEntity>> children)
protected java.util.List<CAstNode>	copyChildrenArray(CAstNode n, CAstControlFlowMap cfg, C context, java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)
protected java.util.List<CAstNode>	copyChildrenArrayAndTargets(CAstNode n, CAstControlFlowMap cfg, C context, java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)
protected CAstControlFlowMap	copyFlow(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap, CAstControlFlowMap orig, CAstSourcePositionMap newSrc) create a control-flow map for the rewritten tree, given the mapping from (original node, copy key) pairs ot new nodes and the original control-flow map.
protected abstract CAstNode	copyNodes(CAstNode root, CAstControlFlowMap cfg, C context, java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap) rewrite the CAst rooted at root under some context, returning the node at the root of the rewritten tree.
protected CAstSourcePositionMap	copySource(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap, CAstSourcePositionMap orig)
protected CAstNode	copySubtreesIntoNewNode(CAstNode n, CAstControlFlowMap cfg, C c, java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)
protected CAstNode	copySubtreesIntoNewNode(CAstNode n, CAstControlFlowMap cfg, C c, java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap, com.ibm.wala.util.collections.Pair<CAstNode,K> pairKey)
protected CAstNodeTypeMap	copyTypes(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap, CAstNodeTypeMap orig)
protected CAstNode	flowOutTo(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap, CAstNode oldSource, java.lang.Object label, CAstNode oldTarget, CAstControlFlowMap orig, CAstSourcePositionMap src) in copyFlow(Map, CAstControlFlowMap, CAstSourcePositionMap), if the source of some original CFG edge is replicated, but we find no replica for the target, what node should be the target of the CFG edge in the rewritten AST? By default, just uses the original target.
CAstEntity	rewrite(CAstEntity root) perform the rewrite on a CAstEntity, returning the new CAstEntity as the result
CAstRewriter.Rewrite	rewrite(CAstNode root, CAstControlFlowMap cfg, CAstSourcePositionMap pos, CAstNodeTypeMap types, java.util.Map<CAstNode,java.util.Collection<CAstEntity>> children, CAstNode[] defaults) rewrite the CAst sub-tree rooted at root

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

protected static final boolean DEBUG

See Also:

Constant Field Values

Ast

protected final CAst Ast

recursive

protected final boolean recursive

for CAstEntity nodes r s.t. r.getAst() == null, should the scoped entities of r be rewritten?

rootContext

protected final C extends CAstRewriter.RewriteContext<K> rootContext

Constructor Detail

CAstRewriter

public CAstRewriter(CAst Ast,
                    boolean recursive,
                    C rootContext)

Method Detail

copyNodes

protected abstract CAstNode copyNodes(CAstNode root,
                                      CAstControlFlowMap cfg,
                                      C context,
                                      java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)

rewrite the CAst rooted at root under some context, returning the node at the root of the rewritten tree. mutate nodeMap in the process, indicating how (original node, copy key) pairs are mapped to nodes in the rewritten tree.

copySubtreesIntoNewNode

protected CAstNode copySubtreesIntoNewNode(CAstNode n,
                                           CAstControlFlowMap cfg,
                                           C c,
                                           java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)

copySubtreesIntoNewNode

protected CAstNode copySubtreesIntoNewNode(CAstNode n,
                                           CAstControlFlowMap cfg,
                                           C c,
                                           java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap,
                                           com.ibm.wala.util.collections.Pair<CAstNode,K> pairKey)

copyChildrenArray

protected java.util.List<CAstNode> copyChildrenArray(CAstNode n,
                                                     CAstControlFlowMap cfg,
                                                     C context,
                                                     java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)

copyChildrenArrayAndTargets

protected java.util.List<CAstNode> copyChildrenArrayAndTargets(CAstNode n,
                                                               CAstControlFlowMap cfg,
                                                               C context,
                                                               java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap)

flowOutTo

protected CAstNode flowOutTo(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap,
                             CAstNode oldSource,
                             java.lang.Object label,
                             CAstNode oldTarget,
                             CAstControlFlowMap orig,
                             CAstSourcePositionMap src)

in copyFlow(Map, CAstControlFlowMap, CAstSourcePositionMap), if the source of some original CFG edge is replicated, but we find no replica for the target, what node should be the target of the CFG edge in the rewritten AST? By default, just uses the original target.

copyFlow

protected CAstControlFlowMap copyFlow(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap,
                                      CAstControlFlowMap orig,
                                      CAstSourcePositionMap newSrc)

create a control-flow map for the rewritten tree, given the mapping from (original node, copy key) pairs ot new nodes and the original control-flow map.

copySource

protected CAstSourcePositionMap copySource(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap,
                                           CAstSourcePositionMap orig)

copyTypes

protected CAstNodeTypeMap copyTypes(java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap,
                                    CAstNodeTypeMap orig)

copyChildren

protected java.util.Map<CAstNode,java.util.Collection<CAstEntity>> copyChildren(CAstNode root,
                                                                                java.util.Map<com.ibm.wala.util.collections.Pair<CAstNode,K>,CAstNode> nodeMap,
                                                                                java.util.Map<CAstNode,java.util.Collection<CAstEntity>> children)

rewrite

public CAstRewriter.Rewrite rewrite(CAstNode root,
                                    CAstControlFlowMap cfg,
                                    CAstSourcePositionMap pos,
                                    CAstNodeTypeMap types,
                                    java.util.Map<CAstNode,java.util.Collection<CAstEntity>> children,
                                    CAstNode[] defaults)

rewrite the CAst sub-tree rooted at root

rewrite

public CAstEntity rewrite(CAstEntity root)

perform the rewrite on a CAstEntity, returning the new CAstEntity as the result