Ghidra Decompiler Analysis Engine
Public Types | Public Member Functions | Protected Attributes | List of all members
EmitXml Class Reference

Base class (and interface) for pretty printing and XML markup of tokens. More...

#include <prettyprint.hh>

Inheritance diagram for EmitXml:
Inheritance graph
[legend]

Public Types

enum  syntax_highlight {
  keyword_color = 0, comment_color = 1, type_color = 2, funcname_color = 3,
  var_color = 4, const_color = 5, param_color = 6, global_color = 7,
  no_color = 8
}
 Possible types of syntax highlighting. More...
 

Public Member Functions

virtual int4 beginDocument (void)
 Begin a whole document of output. More...
 
virtual void endDocument (int4 id)
 End a whole document of output. More...
 
virtual int4 beginFunction (const Funcdata *fd)
 Begin a whole declaration and body of a function. More...
 
virtual void endFunction (int4 id)
 End a whole declaration and body of a function. More...
 
virtual int4 beginBlock (const FlowBlock *bl)
 Begin a control-flow element. More...
 
virtual void endBlock (int4 id)
 End a control-flow element. More...
 
virtual void tagLine (void)
 Force a line break. More...
 
virtual void tagLine (int4 indent)
 Force a line break and indent level. More...
 
virtual int4 beginReturnType (const Varnode *vn)
 Begin a return type declaration. More...
 
virtual void endReturnType (int4 id)
 End a return type declaration. More...
 
virtual int4 beginVarDecl (const Symbol *sym)
 Begin a variable declaration. More...
 
virtual void endVarDecl (int4 id)
 End a variable declaration. More...
 
virtual int4 beginStatement (const PcodeOp *op)
 Begin a source code statement. More...
 
virtual void endStatement (int4 id)
 End a source code statement. More...
 
virtual int4 beginFuncProto (void)
 Begin a function prototype declaration. More...
 
virtual void endFuncProto (int4 id)
 End a function prototype declaration. More...
 
virtual void tagVariable (const char *ptr, syntax_highlight hl, const Varnode *vn, const PcodeOp *op)
 Emit a variable token. More...
 
virtual void tagOp (const char *ptr, syntax_highlight hl, const PcodeOp *op)
 Emit an operation token. More...
 
virtual void tagFuncName (const char *ptr, syntax_highlight hl, const Funcdata *fd, const PcodeOp *op)
 Emit a function identifier. More...
 
virtual void tagType (const char *ptr, syntax_highlight hl, const Datatype *ct)
 Emit a data-type identifier. More...
 
virtual void tagField (const char *ptr, syntax_highlight hl, const Datatype *ct, int4 off)
 Emit an identifier for a field within a structured data-type. More...
 
virtual void tagComment (const char *ptr, syntax_highlight hl, const AddrSpace *spc, uintb off)
 Emit a comment string as part of the generated source code. More...
 
virtual void tagLabel (const char *ptr, syntax_highlight hl, const AddrSpace *spc, uintb off)
 Emit a code label identifier. More...
 
virtual void print (const char *str, syntax_highlight hl=no_color)
 Emit other (more unusual) syntax as part of source code generation. More...
 
virtual int4 openParen (char o, int4 id=0)
 Emit an open parenthesis. More...
 
virtual void closeParen (char c, int4 id)
 Emit a close parenthesis. More...
 
virtual int4 openGroup (void)
 Start a group of things that are printed together. More...
 
virtual void closeGroup (int4 id)
 End a group of things that are printed together. More...
 
virtual void spaces (int4 num, int4 bump=0)
 Emit a sequence of space characters as part of source code. More...
 
virtual int4 startIndent (void)
 Start a new indent level. More...
 
virtual void stopIndent (int4 id)
 End an indent level. More...
 
virtual int4 startComment (void)
 Start a comment block within the emitted source code. More...
 
virtual void stopComment (int4 id)
 End a comment block. More...
 
virtual void flush (void)
 Flush any remaining character data. More...
 
virtual void setMaxLineSize (int4 mls)
 Provide a maximum line size to the pretty printer. More...
 
virtual int4 getMaxLineSize (void) const
 Get the current maximum line size. More...
 
virtual void setCommentFill (const string &fill)
 Set the comment fill characters for when line breaks are forced. More...
 
virtual bool emitsXml (void) const
 Determine if this is an XML markup emitter. More...
 
virtual void resetDefaults (void)
 (Re)set the default emitting options
 
int4 getParenLevel (void) const
 Get the current parentheses depth. More...
 
int4 getIndentIncrement (void) const
 Get the number of characters indented per level of nesting. More...
 
void setIndentIncrement (int4 val)
 Set the number of characters indented per level of nesting. More...
 

Protected Attributes

ostream * s
 Stream being emitted to.
 
int4 indentlevel
 Current indent level (in fixed width characters)
 
int4 parenlevel
 Current depth of parentheses.
 
int4 indentincrement
 Change in indentlevel per level of nesting.
 

Detailed Description

Base class (and interface) for pretty printing and XML markup of tokens.

There are two basic functions being implemented through this interface:

XML markup: allows recording of the natural grouping of the high-level tokens and directly links the nodes of the abstract syntax tree to the emitted tokens.

Pretty printing: Line breaks and additional white space characters are inserted within the emitted source code to enforce a maximum number of characters per line while minimizing breaks in important groups of syntax. Where extra line breaks are necessary, additional indenting is provided to reduce the impact on readability.

All printing must be surrounded by at least one begin and end tag pair:

Additional printing groups can be specified with tag pairs:

The tag* functions, emit the actual language tokens, supplying appropriate markup.

This base class does not actually do any pretty printing it only does the XML markup. For an implementation that actually does pretty printing, see EmitPrettyPrint. This class can be used as the low-level back-end to EmitPrettyPrint to provide a solution that does both pretty printing and XML markup.

Member Enumeration Documentation

◆ syntax_highlight

Possible types of syntax highlighting.

Enumerator
keyword_color 

Keyword in the high-level language.

comment_color 

Comments.

type_color 

Data-type identifiers.

funcname_color 

Function identifiers.

var_color 

Local variable identifiers.

const_color 

Constant values.

param_color 

Function parameters.

global_color 

Global variable identifiers.

no_color 

Un-highlighted.

Member Function Documentation

◆ beginBlock()

int4 EmitXml::beginBlock ( const FlowBlock bl)
virtual

Begin a control-flow element.

Inform the emitter that a new control-flow section is starting. This is a source code unit usually surrounded with curly braces '{' and '}'.

Parameters
blis the block structure object associated with the section
Returns
an id associated with the section

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ beginDocument()

int4 EmitXml::beginDocument ( void  )
virtual

Begin a whole document of output.

Inform the emitter that generation of the source code document has begun

Returns
an id associated with the document

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ beginFuncProto()

int4 EmitXml::beginFuncProto ( void  )
virtual

Begin a function prototype declaration.

Inform the emitter that a function prototype is starting.

Returns
an id associated with the prototype

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ beginFunction()

int4 EmitXml::beginFunction ( const Funcdata fd)
virtual

Begin a whole declaration and body of a function.

Inform the emitter that generation of a function body has begun

Returns
an id associated with the function body

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ beginReturnType()

int4 EmitXml::beginReturnType ( const Varnode vn)
virtual

Begin a return type declaration.

Inform the emitter that generation of a function's return type is starting.

Parameters
vn(if non-null) is the storage location for the return value
Returns
an id associated with the return type

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ beginStatement()

int4 EmitXml::beginStatement ( const PcodeOp op)
virtual

Begin a source code statement.

Inform the emitter that a source code statement is beginning.

Parameters
opis the root p-code operation of the statement
Returns
an id associated with the statement

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ beginVarDecl()

int4 EmitXml::beginVarDecl ( const Symbol sym)
virtual

Begin a variable declaration.

Inform the emitter that a variable declaration has started.

Parameters
symis the symbol being declared
Returns
an id associated with the declaration

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ closeGroup()

virtual void EmitXml::closeGroup ( int4  id)
inlinevirtual

End a group of things that are printed together.

Inform the emitter that a printing group is ending.

Parameters
idis the id associated with the group (as returned by openGroup)

Reimplemented in EmitPrettyPrint.

◆ closeParen()

void EmitXml::closeParen ( char  c,
int4  id 
)
virtual

Emit a close parenthesis.

This method emits the parenthesis character itself and ends the printing unit that was started by the matching open parenthesis.

Parameters
cis the close parenthesis character to emit
idis the id associated with the matching open parenthesis (as returned by openParen)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ emitsXml()

virtual bool EmitXml::emitsXml ( void  ) const
inlinevirtual

Determine if this is an XML markup emitter.

Returns
true if this produces an XML markup of its emitted source code

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endBlock()

void EmitXml::endBlock ( int4  id)
virtual

End a control-flow element.

Inform the emitter that a control-flow section is ending.

Parameters
idis the id associated with the section (as returned by beginBlock)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endDocument()

void EmitXml::endDocument ( int4  id)
virtual

End a whole document of output.

Inform the emitter that generation of the source code document is finished

Parameters
idis the id associated with the document (as returned by beginDocument)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endFuncProto()

void EmitXml::endFuncProto ( int4  id)
virtual

End a function prototype declaration.

Inform the emitter that a function prototype is ending.

Parameters
idis the id associated with the prototype (as returned by beginFuncProto)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endFunction()

void EmitXml::endFunction ( int4  id)
virtual

End a whole declaration and body of a function.

Inform the emitter that generation of a function body has ended

Parameters
idis the id associated with the function body (as returned by beginFunction)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endReturnType()

void EmitXml::endReturnType ( int4  id)
virtual

End a return type declaration.

Inform the emitter that generation of a function's return type is ending.

Parameters
idis the id associated with the return type (as returned by beginReturnType)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endStatement()

void EmitXml::endStatement ( int4  id)
virtual

End a source code statement.

Inform the emitter that a source code statement is ending.

Parameters
idis the id associated with the statement (as returned by beginStatement)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ endVarDecl()

void EmitXml::endVarDecl ( int4  id)
virtual

End a variable declaration.

Inform the emitter that a variable declaration has ended.

Parameters
idis the id associated with the declaration (as returned by beginVarDecl)

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ flush()

virtual void EmitXml::flush ( void  )
inlinevirtual

Flush any remaining character data.

Depending on the particular emitter, tokens and syntax that have been submitted to the emitter may be held internally for a time before getting output to the final stream. This routine makes sure submitted syntax is fully output.

Reimplemented in EmitPrettyPrint.

◆ getIndentIncrement()

int4 EmitXml::getIndentIncrement ( void  ) const
inline

Get the number of characters indented per level of nesting.

Returns
the number of characters

◆ getMaxLineSize()

virtual int4 EmitXml::getMaxLineSize ( void  ) const
inlinevirtual

Get the current maximum line size.

If the emitter respects a maximum line size, return that size.

Returns
the maximum line size or -1 if the emitter does not have a maximum

Reimplemented in EmitPrettyPrint.

◆ getParenLevel()

int4 EmitXml::getParenLevel ( void  ) const
inline

Get the current parentheses depth.

Returns
the current number of open parenthetical groups

◆ openGroup()

virtual int4 EmitXml::openGroup ( void  )
inlinevirtual

Start a group of things that are printed together.

Inform the emitter that a new printing group is starting.

Returns
an id associated with the group

Reimplemented in EmitPrettyPrint.

◆ openParen()

int4 EmitXml::openParen ( char  o,
int4  id = 0 
)
virtual

Emit an open parenthesis.

This method emits the parenthesis character itself and also starts a printing unit of the source code being surrounded by the parentheses.

Parameters
ois the open parenthesis character to emit
idis an id to associate with the parenthesis
Returns
an id associated with the parenthesis

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ print()

void EmitXml::print ( const char *  str,
syntax_highlight  hl = no_color 
)
virtual

Emit other (more unusual) syntax as part of source code generation.

This method is used to emit syntax not covered by the other methods, such as spaces, semi-colons, braces, and other punctuation.

Parameters
stris the character data of the syntax being emitted
hlindicates how the syntax should be highlighted

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ setCommentFill()

virtual void EmitXml::setCommentFill ( const string &  fill)
inlinevirtual

Set the comment fill characters for when line breaks are forced.

If the pretty printer forces a line break in the middle of a comment, this string is emitted to provide proper syntax and indenting to continue the comment.

Parameters
fillis the set of fill characters

Reimplemented in EmitPrettyPrint.

◆ setIndentIncrement()

void EmitXml::setIndentIncrement ( int4  val)
inline

Set the number of characters indented per level of nesting.

Parameters
valis the desired number of characters to indent

◆ setMaxLineSize()

virtual void EmitXml::setMaxLineSize ( int4  mls)
inlinevirtual

Provide a maximum line size to the pretty printer.

The emitter may insert line breaks to enforce this maximum.

Parameters
mlsis the number of characters to set for the maximum line size

Reimplemented in EmitPrettyPrint.

◆ spaces()

void EmitXml::spaces ( int4  num,
int4  bump = 0 
)
virtual

Emit a sequence of space characters as part of source code.

Parameters
numis the number of space characters to emit
bumpis the number of characters to indent if the spaces force a line break

Reimplemented in EmitPrettyPrint.

◆ startComment()

virtual int4 EmitXml::startComment ( void  )
inlinevirtual

Start a comment block within the emitted source code.

Inform the emitter that a set of comment tokens/lines is starting.

Returns
an id associated with the comment block

Reimplemented in EmitPrettyPrint.

◆ startIndent()

virtual int4 EmitXml::startIndent ( void  )
inlinevirtual

Start a new indent level.

Inform the emitter that one level of nesting is being added.

Returns
an id associated with the nesting

Reimplemented in EmitPrettyPrint.

◆ stopComment()

virtual void EmitXml::stopComment ( int4  id)
inlinevirtual

End a comment block.

Inform the emitter that a set of comment tokens/lines is ending.

Parameters
idis the id associated with the block (as returned by startComment)

Reimplemented in EmitPrettyPrint.

◆ stopIndent()

virtual void EmitXml::stopIndent ( int4  id)
inlinevirtual

End an indent level.

Inform the emitter that the current nesting has ended, and we are returning to the previous level.

Parameters
idis the id associated with the nesting (as returned by startIndent)

Reimplemented in EmitPrettyPrint.

◆ tagComment()

void EmitXml::tagComment ( const char *  ptr,
syntax_highlight  hl,
const AddrSpace spc,
uintb  off 
)
virtual

Emit a comment string as part of the generated source code.

Individual comments can be broken up and emitted using multiple calls to this method, but ultimately the comment delimiters and the body of the comment are both emitted with this method, which may provide addition markup.

Parameters
ptris the character data for the comment
hlindicates how the comment should be highlighted
spcis the address space of the address where the comment is attached
offis the offset of the address where the comment is attached

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagField()

void EmitXml::tagField ( const char *  ptr,
syntax_highlight  hl,
const Datatype ct,
int4  o 
)
virtual

Emit an identifier for a field within a structured data-type.

A string representing an individual component of a structured data-type is emitted, possibly with additional markup.

Parameters
ptris the character data for the identifier
hlindicates how the identifier should be highlighted
ctis the data-type associated with the field
ois the (byte) offset of the field within its structured data-type

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagFuncName()

void EmitXml::tagFuncName ( const char *  ptr,
syntax_highlight  hl,
const Funcdata fd,
const PcodeOp op 
)
virtual

Emit a function identifier.

An identifier string representing the symbol name of the function is emitted, possible with additional markup.

Parameters
ptris the character data for the identifier
hlindicates how the identifier should be highlighted
fdis the function
opis the CALL operation associated within the syntax tree or null for a declaration

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagLabel()

void EmitXml::tagLabel ( const char *  ptr,
syntax_highlight  hl,
const AddrSpace spc,
uintb  off 
)
virtual

Emit a code label identifier.

A string describing a control-flow destination, as appropriate for the source language is output, possibly with additional markup.

Parameters
ptris the character data of the label
hlindicates how the label should be highlighted
spcis the address space of the code address being labeled
offis the offset of the code address being labeled

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagLine() [1/2]

void EmitXml::tagLine ( int4  indent)
virtual

Force a line break and indent level.

Tell the emitter that a new line is desired at a specific indent level. The indent level is overridden only for the line, then it returns to its previous value.

Parameters
indentis the desired indent level for the new line

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagLine() [2/2]

void EmitXml::tagLine ( void  )
virtual

Force a line break.

Tell the emitter that a new line is desired at the current indent level.

Reimplemented in EmitPrettyPrint.

◆ tagOp()

void EmitXml::tagOp ( const char *  ptr,
syntax_highlight  hl,
const PcodeOp op 
)
virtual

Emit an operation token.

The string representing the operation as appropriate for the source language is emitted, possibly with additional markup.

Parameters
ptris the character data for the emitted representation
hlindicates how the token should be highlighted
opis the PcodeOp object associated with the operation with the syntax tree

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagType()

void EmitXml::tagType ( const char *  ptr,
syntax_highlight  hl,
const Datatype ct 
)
virtual

Emit a data-type identifier.

A string representing the name of a data-type, as appropriate for the source language is emitted, possibly with additional markup.

Parameters
ptris the character data for the identifier
hlindicates how the identifier should be highlighted
ctis the data-type description object

Reimplemented in EmitPrettyPrint, and EmitNoXml.

◆ tagVariable()

void EmitXml::tagVariable ( const char *  ptr,
syntax_highlight  hl,
const Varnode vn,
const PcodeOp op 
)
virtual

Emit a variable token.

An identifier string representing the variable is output, possibly with additional markup.

Parameters
ptris the character data for the identifier
hlindicates how the identifier should be highlighted
vnis the Varnode representing the variable within the syntax tree
opis a p-code operation related to the use of the variable (may be null)

Reimplemented in EmitPrettyPrint, and EmitNoXml.


The documentation for this class was generated from the following files: