Package com.pnfsoftware.jeb.core.units.code.asm.decompiler.ast

Class COutputSink

java.lang.Object

com.pnfsoftware.jeb.core.output.code.CodeDocumentPart

com.pnfsoftware.jeb.core.output.code.CppLikeDocumentPart

com.pnfsoftware.jeb.core.units.code.asm.decompiler.ast.COutputSink

All Implemented Interfaces:

ICodeDocument, ITextDocumentPart

public class COutputSink
extends CppLikeDocumentPart

This output sink is the recipient for the generation of a C-like Abstract Syntax Tree (AST). The sink also contains configuration elements that will guide and determine how certain AST elements are to be generated. A sink receives the output for a class, a field, or a method element.

Generating an AST yields a special type of elements, called items, that a UI client may want to track to achieve higher level functions such as syntax coloration.

Field Summary

Fields inherited from class com.pnfsoftware.jeb.core.output.code.CppLikeDocumentPart

commentBlockBegin, commentBlockEnd, commentInline

Constructor Summary

Constructors

Constructor	Description
COutputSink(long baseAnchorId)
COutputSink(long baseAnchorId, CDocument doc, INativeDecompilerUnit<?> decomp)

Method Summary

Modifier and Type	Method	Description
void	appendKeyword(CKeyword keyword)
int	astDepth()
ICElement	astPeekSafe(int n)
ICElement	astPop()
void	astPush(ICElement elt)
ICClass	getCurrentContainingClass()
ICMethod	getCurrentContainingMethod()
int	getCurrentMethodIndex()	Get the method index of the method being generated
INativeDecompilerUnit<?>	getDecompilerUnit()	May be null
CDocument	getDocument()	May be null
IDynamicContentManager	getDynamicContentManager()
boolean	getHideCasts()
boolean	getHideTLNS()
boolean	getMergeAdjacentDefinitions()
ISourceCustomizer	getSourceCustomizer()
boolean	getSpaceOutCompounds()
ICClass	getTopLevelClass()
boolean	omitTypeForNextDefinitionPrinting()
ICClass	popContainingClass()
ICMethod	popContainingMethod()
void	pushContainingClass(ICClass c)
void	pushContainingMethod(ICMethod m)
void	renderComment(ICodeCoordinates coord, int what, boolean appendEOL)
void	renderInlineComment(ICodeCoordinates coord, boolean appendEOL)
void	renderPreComment(ICodeCoordinates coord)	note: EOL always appended
int	setCurrentMethodIndex(int index)	Set the method index of the method being generated
void	setDynamicContentManager(IDynamicContentManager dcm)
void	setHideCasts(Boolean override)
void	setHideTLNS(Boolean override)
void	setMergeAdjacentDefinitions(Boolean override)
void	setOmitTypeForNextDefinitionPrinting(boolean omitTypeForNextDefinitionPrinting)	One shot deactivation of types printing in definition (i.e.
void	setSourceCustomizer(ISourceCustomizer sourceCustomizer)
void	setSpaceOutCompounds(Boolean override)
void	validate()

Methods inherited from class com.pnfsoftware.jeb.core.output.code.CppLikeDocumentPart

appendMultiLineComment, appendMultiLineCommentAuto, eol, eol, getEolComment, getEolCoordinates, onEolAddComment, setEolComment, setEolComment, setEolCoordinates

Methods inherited from class com.pnfsoftware.jeb.core.output.code.CodeDocumentPart

append, append, append, appendAndRecord, appendAndRecord, appendAndRecord, appendComment, appendComment, appendCommentAuto, appendKeyword, appendKeyword, appendKeyword, appendMulti, appendParameterSeparator, brace, braceClose, bracket, bracketClose, decrementIndentationLevel, disablePadding, enablePadding, enableTokenFlattening, format, getAnchor, getAnchors, getCountOfAnchors, getCountOfLines, getCurrentAnchor, getCurrentCoordinates, getCurrentLine, getCurrentLineCoordinates, getCurrentLineIndex, getCurrentLineLength, getCurrentMarginLength, getCurrentMostPreciseCodeCoordinates, getIndentationLevel, getIndentationString, getLastLineIndex, getLine, getLineCount, getLines, getObjectLocations, incrementIndentationLevel, indentReset, isCurrentLineEmpty, markCurrentPosition, moveLastLine, moveLine, paren, parenClose, prependCodePart, recordCurrentCoordinates, recordLineCoordinates, recordObjectLocation, registerAnchor, registerAnchor, registerKeyword, resetPaddingString, setIndentationLevel, setIndentationString, setPaddingString, setParameterSeparator, space, space, toString, unrecordCurrentCoordinates, unrecordLineCoordinates

Methods inherited from class java.lang.Object

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

Constructor Details

COutputSink

public COutputSink(long baseAnchorId)

COutputSink

public COutputSink(long baseAnchorId,
 CDocument doc,
 INativeDecompilerUnit<?> decomp)

Method Details

getDocument

public CDocument getDocument()

May be null

getDecompilerUnit

public INativeDecompilerUnit<?> getDecompilerUnit()

May be null

setSpaceOutCompounds

public void setSpaceOutCompounds(Boolean override)

getSpaceOutCompounds

public boolean getSpaceOutCompounds()

setMergeAdjacentDefinitions

public void setMergeAdjacentDefinitions(Boolean override)

getMergeAdjacentDefinitions

public boolean getMergeAdjacentDefinitions()

setHideCasts

public void setHideCasts(Boolean override)

getHideCasts

public boolean getHideCasts()

setHideTLNS

public void setHideTLNS(Boolean override)

getHideTLNS

public boolean getHideTLNS()

omitTypeForNextDefinitionPrinting

public boolean omitTypeForNextDefinitionPrinting()

setOmitTypeForNextDefinitionPrinting

public void setOmitTypeForNextDefinitionPrinting(boolean omitTypeForNextDefinitionPrinting)

One shot deactivation of types printing in definition (i.e. when set to true, it only works for the next printing)

pushContainingClass

public void pushContainingClass(ICClass c)

popContainingClass

public ICClass popContainingClass()

getCurrentContainingClass

public ICClass getCurrentContainingClass()

getTopLevelClass

public ICClass getTopLevelClass()

pushContainingMethod

public void pushContainingMethod(ICMethod m)

popContainingMethod

public ICMethod popContainingMethod()

getCurrentContainingMethod

public ICMethod getCurrentContainingMethod()

setDynamicContentManager

public void setDynamicContentManager(IDynamicContentManager dcm)

getDynamicContentManager

public IDynamicContentManager getDynamicContentManager()

setSourceCustomizer

public void setSourceCustomizer(ISourceCustomizer sourceCustomizer)

getSourceCustomizer

public ISourceCustomizer getSourceCustomizer()

setCurrentMethodIndex

public int setCurrentMethodIndex(int index)

Set the method index of the method being generated

Parameters:

index - the current method index

Returns:

the previous index

getCurrentMethodIndex

public int getCurrentMethodIndex()

Get the method index of the method being generated

Returns:

<0 if cannot be determined or invalid

appendKeyword

public void appendKeyword(CKeyword keyword)

astPush

public void astPush(ICElement elt)

astPop

public ICElement astPop()

astPeekSafe

public ICElement astPeekSafe(int n)

astDepth

public int astDepth()

renderPreComment

public void renderPreComment(ICodeCoordinates coord)

note: EOL always appended

renderInlineComment

public void renderInlineComment(ICodeCoordinates coord,
 boolean appendEOL)

renderComment

public void renderComment(ICodeCoordinates coord,
 int what,
 boolean appendEOL)

validate

public void validate()

Overrides:

validate in class CppLikeDocumentPart